Testes de Integração

Este documento fornece informações sobre o framework de testes de integração usado neste projeto.

Visão Geral

Os testes de integração são projetados para validar a funcionalidade end-to-end do Qwen Code. Eles executam o binário compilado em um ambiente controlado e verificam se ele se comporta conforme esperado ao interagir com o sistema de arquivos.

Esses testes estão localizados no diretório integration-tests e são executados usando um test runner customizado.

Executando os testes

Os testes de integração não são executados como parte do comando padrão npm run test. Eles devem ser executados explicitamente usando o script npm run test:integration:all.

Os testes de integração também podem ser executados usando o seguinte atalho:

npm run test:e2e

Executando um conjunto específico de testes

Para executar um subconjunto de arquivos de teste, você pode usar npm run <integration test command> <file_name1> .... onde <integration test command> é test:e2e ou test:integration* e <file_name> é qualquer um dos arquivos .test.js no diretório integration-tests/. Por exemplo, o comando a seguir executa list_directory.test.js e write_file.test.js:

npm run test:e2e list_directory write_file

Executando um único teste por nome

Para executar um único teste pelo seu nome, use a flag --test-name-pattern:

npm run test:e2e -- --test-name-pattern "reads a file"

Executando todos os testes

Para executar toda a suite de testes de integração, use o seguinte comando:

npm run test:integration:all

Matriz de sandbox

O comando all irá executar os testes para no sandboxing, docker e podman.
Cada tipo individual pode ser executado usando os seguintes comandos:

npm run test:integration:sandbox:none

npm run test:integration:sandbox:docker

npm run test:integration:sandbox:podman

Diagnósticos

O test runner de integração oferece várias opções de diagnóstico para ajudar a rastrear falhas nos testes.

Mantendo o output dos testes

Você pode preservar os arquivos temporários criados durante a execução dos testes para inspeção. Isso é útil para debugar problemas com operações no sistema de arquivos.

Para manter o output dos testes, defina a variável de ambiente KEEP_OUTPUT como true.

KEEP_OUTPUT=true npm run test:integration:sandbox:none

Quando o output é mantido, o test runner irá imprimir o caminho para o diretório único da execução do teste.

Saída detalhada (Verbose)

Para depuração mais detalhada, defina a variável de ambiente VERBOSE como true.

VERBOSE=true npm run test:integration:sandbox:none

Ao usar VERBOSE=true e KEEP_OUTPUT=true no mesmo comando, a saída é exibida no console e também salva em um arquivo de log dentro do diretório temporário do teste.

A saída detalhada é formatada para identificar claramente a origem dos logs:

--- TEST: <log dir>:<test-name> ---
... output from the qwen command ...
--- END TEST: <log dir>:<test-name> ---

Linting e formatação

Para garantir qualidade e consistência do código, os arquivos de teste de integração passam pelo processo de linting como parte do build principal. Você também pode executar o linter e o corretor automático manualmente.

Executando o linter

Para verificar erros de linting, execute o seguinte comando:

npm run lint

Você pode incluir a flag :fix no comando para corrigir automaticamente quaisquer erros que possam ser ajustados:

npm run lint:fix

Estrutura de diretórios

Os testes de integração criam um diretório único para cada execução de teste dentro do diretório .integration-tests. Dentro deste diretório, é criado um subdiretório para cada arquivo de teste, e dentro desse subdiretório, é criado outro subdiretório para cada caso de teste individual.

Essa estrutura facilita a localização dos artefatos de uma execução de teste, arquivo ou caso específico.

.integration-tests/
└── <run-id>/
    └── <test-file-name>.test.js/
        └── <test-case-name>/
            ├── output.log
            └── ...outros artefatos do teste...

Integração contínua

Para garantir que os testes de integração sejam sempre executados, um workflow do GitHub Actions está definido em .github/workflows/e2e.yml. Esse workflow executa automaticamente os testes de integração para pull requests direcionados à branch main, ou quando um pull request é adicionado a uma merge queue.

O workflow executa os testes em diferentes ambientes de sandboxing para garantir que o Qwen Code seja testado em cada um deles:

• sandbox:none: Executa os testes sem nenhum tipo de sandboxing.
• sandbox:docker: Executa os testes dentro de um container Docker.
• sandbox:podman: Executa os testes dentro de um container Podman.