Executar Suítes de Teste Via CLI

Selecionar Um Método de Execução Adequado

O Apidog fornece várias maneiras de executar suítes de teste, adequadas para 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.

Ele é particularmente eficaz quando o desenvolvimento e os testes ocorrem simultaneamente, permitindo monitoramento em tempo real e ajustes imediatos.

Execução Local do Apidog CLI:

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

Ele é capaz de ser executado offline, o que é adequado para ambientes com recursos restritos ou que não exigem uma interface gráfica de usuário.

Execução de CI/CD:

Este estilo de execução é integrado ao pipeline de CI/CD, tornando-o uma ótima opção para processos de integração automatizada e implantação contínua.

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

Execução do Runner Auto-hospedado:

As equipes podem configurar o Apidog Runner em seus próprios servidores, aproveitando recursos computacionais mais robustos para testes.

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

TIP

Em suítes de teste, se variáveis de ambiente/globais forem usadas, os valores reais dessas variáveis podem diferir dependendo do método de execução escolhido, o que pode levar a resultados de teste inconsistentes. Saiba mais.

Executar o Apidog CLI

Para executar suítes de teste usando o Apidog CLI, primeiro você precisa criar e orquestrar uma suíte de teste. Em seguida, você pode executar a suíte de teste pela linha de comando usando o Apidog CLI e obter os resultados do teste e o relatório de teste.

Em uma suíte de teste, alterne para a aba CI/CD.

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

Na seção do provedor de CI/CD, selecione linha de comando CLI ou outras plataformas.

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

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

Observação: para que o comando seja executado com sucesso, você precisa primeiro instalar o Apidog CLI. Se ele já estiver instalado, você precisa atualizá-lo para a versão mais recente.

Sobre Variáveis e Arquivos de Configuração Locais (Opcional)

Em alguns cenários, a execução da CLI exige arquivos de configuração locais:

Variáveis de Ambiente / Globais

Se você escolher "Export current values for use", precisará colocar o arquivo de variáveis exportado na máquina de execução da CLI e especificar o caminho do arquivo por meio de --variables <path>.

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

Conexão com Banco de Dados

Se o teste usar "conexões de banco de dados" salvas localmente, a interface orientará você a exportar o arquivo de configuração e usá-lo na CLI por meio de --database-connection <path>.

Recomenda-se salvar os detalhes de "conexão com banco de dados" em forma de variável, para que nenhum --database-connection <path> adicional seja necessário ao executar a CLI, e isso também seja mais conveniente para colaboração e manutenção. Saiba mais.

Relatório de Teste da CLI

Depois de executar a CLI, você receberá um relatório de teste na linha de comando contendo as estatísticas de execução da suíte de teste, bem como informações de validação e assertivas para requisições com falha.

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

Opções de Comando

O Apidog CLI fornece opções de configuração avançadas para personalizar a execução de suítes de teste. Para obter detalhes, consulte Opções de Comando da CLI.

Usar o Apidog CLI em CI/CD

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

Executar Suítes de Teste Via CLI

Selecionar Um Método de Execução Adequado#

Executar o Apidog CLI#

Sobre Variáveis e Arquivos de Configuração Locais (Opcional)#

Relatório de Teste da CLI#

Opções de Comando#

Usar o Apidog CLI em CI/CD#

Selecionar Um Método de Execução Adequado

Executar o Apidog CLI

Sobre Variáveis e Arquivos de Configuração Locais (Opcional)

Relatório de Teste da CLI

Opções de Comando

Usar o Apidog CLI em CI/CD