Executar conjuntos de testes via CLI

Selecionar um método de execução adequado

O Apidog fornece várias formas de executar conjuntos de testes, adequadas a diferentes requisitos de teste.

Execução visual local:

Este método é iniciado a partir de uma máquina local e é adequado para testes rápidos e de pequena escala.

É particularmente eficaz quando o desenvolvimento e os testes ocorrem em simultâneo, permitindo monitorização em tempo real e ajustes imediatos.

Execução local com Apidog CLI:

Ideal para lidar com dados em grande escala ou cenários iterativos, este método oferece maior velocidade de execução.

É capaz de executar offline, o que é adequado para ambientes com recursos restritos ou que não necessitam de uma interface gráfica de utilizador.

Execução CI/CD:

Este estilo de execução é integrado no pipeline CI/CD, tornando-o uma excelente opção para processos de integração automatizada e implementação contínua.

É especialmente útil em contextos onde os testes são executados frequentemente para confirmar a estabilidade das APIs após cada atualização de código.

Execução com runner autoalojado:

As equipas podem configurar o Apidog Runner nos seus próprios servidores, tirando partido de recursos computacionais mais robustos para testes.

Este método inclui suporte para tarefas agendadas, tornando-o ideal para cenários que necessitam de testes regulares ou que têm exigências de teste significativas.

TIP

Em conjuntos de testes, se forem utilizadas variáveis de ambiente/globais, os valores reais destas variáveis podem diferir dependendo do método de execução escolhido, o que poderá levar a resultados de teste inconsistentes. Saiba mais.

Executar o Apidog CLI

Para executar conjuntos de testes utilizando o Apidog CLI, primeiro precisa de criar e orquestrar um conjunto de testes. Em seguida, pode executar o conjunto de testes a partir da linha de comandos utilizando o Apidog CLI e obter os resultados dos testes e o relatório de teste.

Num conjunto de testes, mude para o separador CI/CD.

Configure parâmetros como o ambiente de execução e o método de notificação. Cada configuração na interface será refletida em tempo real no comando CLI gerado abaixo.

Na secção do fornecedor CI/CD, selecione linha de comandos CLI ou outras plataformas.

Clique no botão "Add access token" e depois em "Generate token" para autenticação de chamada CLI. Saiba mais.

Clique para copiar o comando, cole-o na linha de comandos e execute-o para ver o processo de execução do teste e o relatório de teste.

Nota: Para que o comando seja executado com êxito, precisa primeiro de instalar o Apidog CLI. Se já estiver instalado, precisa de o atualizar para a versão mais recente.

Sobre variáveis e ficheiros de configuração locais (opcional)

Em alguns cenários, a execução CLI requer ficheiros de configuração locais:

Variáveis de ambiente / globais

Se escolher "Export current values for use", precisa de colocar o ficheiro de variáveis exportado na máquina de execução CLI e especificar o caminho do ficheiro através de --variables <path>.

Para saber a diferença entre "Use initial Values" e "Export current values for use", consulte: Regras para utilizar variáveis de ambiente/globais em diferentes métodos de execução.

Ligação à base de dados

Se o teste utilizar "ligações à base de dados" guardadas localmente, a interface irá orientá-lo para exportar o ficheiro de configuração e utilizá-lo na CLI através de --database-connection <path>.

Recomenda-se guardar os detalhes da "ligação à base de dados" em forma de variável, para que não seja necessário nenhum --database-connection <path> adicional ao executar a CLI, sendo também mais conveniente para colaboração e manutenção. Saiba mais.

Relatório de teste CLI

Após executar a CLI, obterá um relatório de teste na linha de comandos que contém as estatísticas de execução do conjunto de testes, bem como informações de validação e asserção para pedidos com falha.

Na pasta onde a CLI é executada, também pode encontrar a pasta /apidog-reports/, que contém relatórios de teste CLI em formato HTML.

Opções de comando

O Apidog CLI fornece opções de configuração abrangentes para personalizar a execução de conjuntos de testes. Para obter detalhes, consulte Opções de comando CLI.

Utilizar o Apidog CLI em CI/CD

O Apidog CLI suporta integração com várias ferramentas de pipeline, como Jenkins, GitLab, GitHub Actions, etc. Para saber mais, consulte Integração CI/CD.

Executar conjuntos de testes via CLI

Selecionar um método de execução adequado#

Executar o Apidog CLI#

Sobre variáveis e ficheiros de configuração locais (opcional)#

Relatório de teste CLI#

Opções de comando#

Utilizar o Apidog CLI em CI/CD#

Selecionar um método de execução adequado

Executar o Apidog CLI

Sobre variáveis e ficheiros de configuração locais (opcional)

Relatório de teste CLI

Opções de comando

Utilizar o Apidog CLI em CI/CD