Criar testes de unidade usando modos de exibição de chat

Concluído

A Exibição de chat no Visual Studio Code fornece três modos que podem ser usados para criar testes de unidade: Perguntar, Editar e Agente. Cada modo tem seus próprios pontos fortes e fracos, e o melhor modo a ser usado depende da tarefa específica em questão.

  • O modo de pergunta é otimizado para fazer perguntas sobre seus projetos de código, tópicos de codificação e conceitos gerais de tecnologia.
  • O modo de edição é otimizado para fazer edições em vários arquivos em sua base de código.
  • O modo de agente é otimizado para iniciar um fluxo de trabalho de codificação por agentes.

Importante

Quando você usa a exibição chat no modo de agente, o GitHub Copilot pode fazer várias solicitações premium para concluir uma única tarefa. Solicitações Premium podem ser usadas por prompts iniciados pelo usuário e ações de acompanhamento que o Copilot realiza em seu nome. O total de solicitações premium usadas depende da complexidade da tarefa, do número de etapas envolvidas e do modelo selecionado.

Usar o modo Perguntar para criar testes de unidade

O modo perguntar pode ser usado para analisar um workspace e, em seguida, criar testes de unidade. O modo Perguntar é útil quando você deseja criar testes para várias funções ou métodos em um arquivo ou quando você deseja criar testes para um arquivo inteiro.

Para criar testes de unidade usando o modo perguntar, siga estas etapas:

  1. Abra o arquivo que contém o código que você deseja testar.

  2. Abra o modo de exibição chat e inicie uma nova sessão de chat usando o modo de solicitação.

  3. Adicione contexto à sessão de chat.

    • Você pode adicionar contexto à sessão de chat arrastando e soltando arquivos da exibição EXPLORER do Visual Studio Code na exibição Chat. Você também pode usar o botão Adicionar Contexto .
    • Você pode abrir arquivos externos no editor de código para incluir recursos que não fazem parte do workspace e usá-los para fornecer contexto específico. Por exemplo, você pode abrir arquivos markdown que contêm diretrizes de colaborador ou informações de contato e, em seguida, usar o botão Adicionar Contexto para adicioná-los ao contexto de exibição de Chat.
    • Você pode usar a variável de chat @workspace para especificar o workspace como parte do prompt. O contexto do workspace é útil quando você deseja criar testes para várias funções ou métodos em um arquivo ou quando você deseja criar testes para um arquivo inteiro.
  4. Insira um prompt que solicita testes de unidade para o código no arquivo.

    • Por exemplo: "@workspace /explain I need to create unit tests for the code in this file. The tests should be written in Python and use the unittest framework."
  5. Examine os testes de unidade sugeridos e refine os resultados usando prompts atualizados, se necessário.

  6. Mova os testes de unidade sugeridos para um arquivo de teste.

    • Por exemplo, crie um arquivo de teste no mesmo diretório que o arquivo de código e insira os testes de unidade sugeridos no arquivo.
    • Você pode usar o modo perguntar para sugerir atualizações para testes específicos depois de criar o arquivo de teste ou usar outras ferramentas do GitHub Copilot para ajudar nas atualizações.
    • Você também pode usar o botão Aplicar no Editor para aplicar os testes de unidade sugeridos diretamente ao arquivo de código.
  7. Salve o arquivo de teste.

    • Normalmente, os arquivos de teste são salvos em um diretório separado de "testes" em um projeto configurado para testes de unidade. Suas opções dependem da estrutura e da estrutura de teste do projeto.
    • Você pode usar o modo perguntar para sugerir atualizações para testes específicos depois de criar o arquivo de teste ou usar outras ferramentas do GitHub Copilot para ajudar nas atualizações.
  8. Execute os testes para garantir que eles passem e verifiquem a funcionalidade do código.

  9. Se necessário, refina os testes adicionando mais casos de teste ou modificando os existentes.

  10. Salve o arquivo novamente depois de fazer alterações nos testes.

Usar o modo de edição para criar testes de unidade

O modo de edição pode ser usado para criar testes de unidade adicionando arquivos de contexto ao chat e, em seguida, criando ou atualizando arquivos de teste. O modo de edição é útil quando você deseja criar testes para funções ou métodos específicos em um arquivo ou quando você deseja criar testes para um arquivo inteiro.

Para criar testes de unidade usando o modo de edição, siga estas etapas:

  1. Abra o arquivo que contém o código que você deseja testar.

  2. Abra o modo de exibição chat e inicie uma nova sessão de chat usando o modo de edição.

  3. Adicione contexto à sessão de chat.

    • Os participantes do chat não estão disponíveis no modo de edição, portanto, você não pode especificar @workspace como parte do prompt. No entanto, você pode adicionar contexto à sessão de chat usando #codebase e arrastando e soltando arquivos ou pastas da exibição EXPLORER do Visual Studio Code para o modo de exibição chat. Use o Visual Studio Code para abrir arquivos externos, como arquivos markdown que contêm diretrizes de colaborador e, em seguida, use o botão Adicionar Contexto para adicioná-los ao contexto de chat.
  4. Insira um prompt para criar os testes de unidade pretendidos.

    • Por exemplo: "I need to create unit tests for the code in this file. The tests should be written in Python and use the unittest framework. Create a test file in the same directory as the code file."
  5. Examine o arquivo de teste criado usando o modo de edição e salve ou descarte o arquivo.

    • Você pode atualizar o arquivo usando novos prompts para corrigir ou aprimorar testes específicos, se necessário.
  6. Salve o arquivo de teste.

    • Normalmente, os arquivos de teste são salvos em um diretório separado de "testes" em um projeto configurado para testes de unidade. Suas opções dependem da estrutura e da estrutura de teste do projeto.
  7. Execute os testes para garantir que eles passem e verifiquem a funcionalidade do código.

  8. Se necessário, refina os testes adicionando mais casos de teste ou modificando os existentes.

  9. Salve o arquivo novamente depois de fazer alterações nos testes.

Usar o modo de agente para criar testes de unidade

O modo de agente pode ser usado para automatizar tarefas em seu processo de teste de unidade. Por exemplo, você pode usar o modo de agente para estruturar um projeto de teste, criar arquivos de teste, executar testes, gerar relatórios de teste ou executar outras tarefas relacionadas ao teste de unidade. O modo de agente é o que funciona melhor para criar testes de unidade que exigem uma compreensão mais detalhada do projeto.

Para criar testes de unidade usando o modo de agente, siga estas etapas:

  1. Abra o arquivo que contém o código que você deseja testar.

  2. Abra o modo de exibição de chat e inicie uma nova sessão de chat usando o modo Agente.

  3. Deixe o modo de agente determinar o contexto.

    No modo de agente, você não precisa especificar o contexto. O Copilot determinará automaticamente o contexto e os arquivos relevantes a serem editados.

  4. Opcionalmente, selecione o ícone Ferramentas para configurar quais ferramentas podem ser usadas para responder à sua solicitação.

    • Você pode selecionar as ferramentas que deseja usar para responder à sua solicitação. Por exemplo, você pode selecionar a ferramenta Gerenciador de Testes para executar testes ou a ferramenta Terminal para executar comandos.
    • Você também pode selecionar a ferramenta GitHub Copilot para usar os recursos de geração de código do Copilot.
  5. Insira um prompt que defina as tarefas pretendidas.

    • Por exemplo: "Ensure that a suitable unit tests project is prepared for the selected code file. Create a test file in the unit test project that includes unit tests for all methods in the selected file. Unit tests should be written in C# and use the xUnit framework. Run the tests to ensure expected results."
  6. Monitore o progresso do modo de agente enquanto ele executa as tarefas.

    • Confirme invocações de ferramenta e comandos de terminal. Você pode confirmar ou rejeitar as invocações de ferramenta e os comandos de terminal que o modo de agente sugere. Por exemplo, você pode confirmar o comando para executar os testes ou o comando para gerar um relatório de teste.
    • Interrompa o modo do agente, se necessário. Você pode interromper o modo de agente se quiser interromper as tarefas que ele está executando. Por exemplo, você pode interromper o modo do agente se quiser alterar o contexto ou se quiser alterar as ferramentas que estão sendo usadas.
  7. Examine os arquivos que o modo de agente criou ou atualizou durante as tarefas especificadas e, em seguida, mantenha ou descarte atualizações.

    • Você pode usar novos prompts para corrigir ou aprimorar testes específicos, se necessário.

Resumo

A Exibição de Chat do GitHub Copilot fornece três modos que podem ser usados para criar testes de unidade: Perguntar, Editar e Agente. Cada modo tem seus próprios pontos fortes e fracos, e o melhor modo a ser usado depende da tarefa específica em questão. O modo de pergunta é otimizado para fazer perguntas sobre seus projetos de código, tópicos de codificação e conceitos gerais de tecnologia. O modo de edição é otimizado para fazer edições em vários arquivos em sua base de código. O modo de agente é otimizado para iniciar um fluxo de trabalho de codificação por agentes.