Power Query estrutura de teste do SDK parte 5a – Testando seu conector de extensão com Visual Studio Code

Essa referência de várias partes aborda a instalação e a execução de um conjunto padrão de testes para desenvolvedores do conector do Power Query. Essa referência deve ser feita sequencialmente para garantir que seu ambiente esteja configurado para testar seu conector personalizado.

Até agora, você concluiu as seguintes etapas:

• Configurar o ambiente
• Carregaram os dados de teste
• Baixou o pacote de testes
• Aprendeu vários formatos de arquivo e suas funcionalidades

Finalmente, você está pronto para começar a verificar o conector de extensão com o conjunto de testes. Esta seção se concentra no uso do Test Explorer no Visual Studio Code, que fornece uma interface do usuário avançada para descobrir, executar e depurar testes. No capô, essa integração usa a API de Teste Visual Studio Code e executa testes usando o comando run-compare do utilitário PQTest (consulte PQTest run-compare documentation).

Nesta seção, você:

Pré-requisitos

Para usar a integração do Gerenciador de Testes, verifique se você tem os seguintes pré-requisitos:

• Visual Studio Code: versão 1.100 ou posterior.

• Power Query Extensão do SDK: verifique se a extensão do SDK Power Query está instalada e atualizada para a versão 0.7.0 ou posterior. Seu projeto de conector é reconhecido pelo SDK do Power Query, conforme indicado pela seção Power Query SDK no painel Explorer exibindo as tarefas do projeto.

  

Configuração

Para permitir que o Gerenciador de Testes localize e execute seus testes, você precisa definir um ou mais arquivos de configurações de teste específicos e suas configurações de workspace Visual Studio Code.

1. Arquivo de Configurações de Teste (.testsettings.json)

O .testsettings.json arquivo conduz a descoberta de teste. Esse arquivo é funcionalmente idêntico ao arquivo de configurações (.settings) introduzido na especificação de formato de teste, mas usa a .testsettings.json extensão para identificação explícita pelo Gerenciador de Testes.

Você pode criar um novo .testsettings.json arquivo ou migrar um arquivo de configurações existente renomeando-o para usar a .testsettings.json extensão. Coloque o arquivo em seu projeto (por exemplo, em sua Settings pasta) com a configuração necessária.

Importante: Espera-se que os caminhos especificados no .testsettings.json arquivo (como QueryFilePath, DiagnosticsPathetc.) sejam relativos ao local do próprio arquivo de configurações.

Exemplo .testsettings.json:

{
  "QueryFilePath": "../TestSuites/contoso.query.pq",
  "ParameterQueryFilePath": "../ParameterQueries/contoso.parameterquery.pq",
  "DiagnosticsPath": "../Diagnostics",
  "FailOnMissingOutputFile": true
}

2. Configurar a extensão

Você precisa configurar o SDK do Power Query com o local das configurações de teste, o arquivo de extensão do conector e o utilitário PQTest.

1. Abra suas configurações em Visual Studio Code.

   • Configurações do workspace (para caminhos específicos do projeto): Abra a Paleta de Comandos (Ctrl+Shift+P ou Cmd+Shift+P), digite Preferências: Abrir Configurações do Workspace (JSON) e selecione-a.
   • Configurações do usuário (para caminhos globais): Abra a Paleta de Comandos, digite Preferências: Abrir Configurações do Usuário (JSON) e selecione-a.

2. Adicione as seguintes configurações:

   • powerquery.sdk.tools.location: o caminho absoluto para a pasta de instalação PQTest (que PQTest.execontém). Essa configuração pode ser definida nas configurações de usuário ou workspace .
     • Exemplo: "C:\\Users\\<username>\\.vscode\\extensions\\powerquery.vscode-powerquery-sdk-<version>\\.nuget\\Microsoft.PowerQuery.SdkTools.<version>\\tools"
   • powerquery.sdk.test.settingsFiles: a lista de arquivos de configurações de teste a serem descobertos. Aceita um único caminho de arquivo, um caminho de diretório (para descobrir todos os .testsettings.json arquivos dentro) ou uma matriz de caminhos de arquivo/diretório. (Configuração do workspace )
   • powerquery.sdk.test.ExtensionPaths: a lista de arquivos de extensão do conector (.mez) a serem testados. Aceita um único caminho de arquivo ou uma matriz de caminhos. Se não for fornecido, o SDK usará powerquery.sdk.defaultExtension (que dá suporte a um único caminho). (Configuração do workspace )

Exemplo .vscode/settings.json:

{
  "powerquery.sdk.tools.location": "C:\\Users\\<username>\\.vscode\\extensions\\powerquery.vscode-powerquery-sdk-0.7.0-win32-x64\\.nuget\\Microsoft.PowerQuery.SdkTools.2.150.3\\tools",
  "powerquery.sdk.test.settingsFiles": [
    "${workspaceFolder}/Tests/Settings/MyConnector.testsettings.json"
  ],
  "powerquery.sdk.test.ExtensionPaths": [
    "${workspaceFolder}/bin/AnyCPU/Debug/MyConnector.mez"
  ]
}

3. Configurar credenciais

Se o conector exigir autenticação, você deverá armazenar credenciais válidas antes de executar testes. O SDK do Power Query fornece uma tarefa para gerenciar credenciais diretamente da interface do usuário do Visual Studio Code.

Para obter instruções detalhadas, consulte a seção Set credential na visão geral do SDK Power Query.

Descoberta de teste

Depois de configurado, você pode descobrir seus testes no modo de exibição do Gerenciador de Testes.

1. Abra a exibição Testing no Visual Studio Code (Selecione o ícone de béquer na Barra de Atividades).

2. Você deve ver os arquivos de configurações de teste listados.

3. Expanda os nós para ver os testes descobertos. A hierarquia espelha sua estrutura de pastas.

   

Atualizando testes

Se você adicionar novos testes, alterar as configurações ou a descoberta de teste falhar por algum motivo, você poderá atualizar a descoberta:

• Atualizar Todos os Testes: selecione o botão Atualizar Todos os Testes (ícone de seta circular) na parte superior do painel do Gerenciador de Testes para redescobrir testes para todos os arquivos de configurações.

• Atualizar testes referenciados por um arquivo de Configurações de Teste: passe o mouse sobre um arquivo de configurações de teste específico e selecione o botão Atualizar Testes (ícone de seta circular) para redescobrir testes apenas para esse arquivo.

  

Executando testes

Você pode executar testes em vários níveis de granularidade diretamente da interface do usuário:

• Executar Tudo: selecione os Testes de Execução (ícone de reprodução) na parte superior do painel.

  

• Executar Grupo/Pasta: focalize uma pasta ou item de configurações e selecione o botão Executar Teste .

  

• Executar Teste Individual: focalize um item de teste específico e selecione o botão Executar Teste .

À medida que os testes são executados, os ícones de status são atualizados em tempo real para mostrar o progresso (em execução, aprovado ou com falha).

Exibindo resultados e depuração

O painel Resultados do Teste (localizado no painel inferior por padrão) exibe os resultados brutos do teste do PQTest ou de qualquer mensagem de erro. Ele também lista o histórico da última execução, mostrando testes aprovados e com falha.

Exibição de difusão para falhas

Se um teste falhar porque a saída não correspondeu ao resultado esperado, o Gerenciador de Testes fornecerá uma exibição de diferenciação interna. Selecione a falha no painel Resultados do Teste para ver uma comparação lado a lado da saída real versus esperada .

Diagnóstico de dobragem de consulta

Se a configuração de teste habilitar a validação de dobra de consulta (especificando um DiagnosticsPath), a extensão também comparará o diagnóstico gerado com a linha de base esperada.

Se um teste falhar devido a uma incompatibilidade de diagnóstico, você poderá exibir a diferença entre os arquivos de diagnóstico real e esperado selecionando a falha no painel Resultados do Teste.

Exibir a saída esperada

Você pode exibir rapidamente o arquivo de saída esperado (.pqout) para qualquer teste. Selecione o ícone Exibir Saída de Teste Esperado (área de transferência) que aparece ao passar o mouse sobre um teste ou clique com o botão direito do mouse no item de teste e selecione Exibir Saída de Teste Esperada no menu de contexto. Essa ação abre o arquivo correspondente .pqout no editor.

Resolução de problemas

Se você encontrar problemas, verifique o canal de saída Power Query SDK para logs. Ele pode ajudá-lo a verificar o PQTest run-compare comando que está sendo executado e identificar qualquer comportamento inesperado.

Problemas comuns

• PQTest.exe não encontrado: verifique se a powerquery.sdk.tools.location configuração aponta para o caminho absoluto correto da pasta de instalação do PQTest.
• QueryFilePath ou Nenhum teste descoberto: verifique se os caminhos no arquivo de configurações de teste estão corretos. QueryFilePath deve apontar para um arquivo válido .query.pq ou um diretório que os contenha. Lembre-se de que os caminhos relativos são .testsettings.json relativos ao próprio arquivo de configurações.
• Expandir um arquivo de configurações não fará nada: se expandir um nó no Gerenciador de Testes não mostrar nenhum teste, tente usar o comando Atualizar Testes (ícone de atualização embutido com o item de configurações) para disparar a descoberta novamente.

Conclusion

Esta seção mostrou como usar o Gerenciador de Testes do Visual Studio Code para descobrir, executar e depurar com eficiência os testes do conector. Essa abordagem orientada pela interface do usuário oferece uma alternativa simplificada às ferramentas de linha de comando.

Na próxima seção, você aprenderá a adicionar seus próprios testes personalizados à estrutura.

Próximas Etapas 

Power Query estrutura de teste do SDK parte 6 – Adicionando seus testes