Instalando e executando o Apidog CLI

O Apidog CLI foi projetado para executar cenários de teste do Apidog na linha de comando. Para começar a usar o Apidog CLI, instale o Node.js e, em seguida, o Apidog CLI. Depois disso, você poderá executar seus cenários de teste.

Pré-requisitos

Node.js v16 ou posterior instalado em seu sistema

npm (Node Package Manager) instalado

Uma conta do Apidog com cenários de teste criados

Instalando o Apidog CLI

O Apidog CLI é desenvolvido com base no Node.js. Para executar o Apidog CLI, instale o Node.js antes de usá-lo.

O Apidog CLI depende da versão v16 ou posterior do Node.js.

Instale o Apidog CLI a partir do npm globalmente em seu sistema, permitindo que você o execute de qualquer lugar:

Aqui estão alguns comandos para verificar se o Apidog CLI foi instalado com sucesso.

Se instalado com sucesso, ele imprimirá diretamente o número da versão e o caminho de instalação após a execução dos comandos acima.

Saída do terminal mostrando a instalação bem-sucedida do Apidog CLI com números de versão e caminhos

Atualizando o Apidog CLI

Use o comando abaixo para atualizar o Apidog CLI.

Executando o Apidog CLI

Para executar cenários de teste usando o Apidog CLI, primeiro você precisa criar e orquestrar um cenário de teste. Em seguida, você pode executar o cenário de teste pela linha de comando usando o Apidog CLI, assim como faria na interface visual, e obter um relatório de teste.

O Apidog CLI oferece suporte a duas formas de execução:

Executar com dados online: Isso é adequado para cenários em tempo real.

Executar com cenários de teste exportados: Isso é adequado para cenários offline.

Executar dados online em tempo real

Em um cenário de teste, alterne para a aba CI/CD.

Aba CI/CD na interface de cenário de teste do Apidog

Configure o ambiente, os dados de teste, as iterações, o atraso etc.

Na seção de provedor de CI/CD, selecione "Command line".

Clique no botão "Add access token" e, em seguida, em "Generate token".

Saiba mais sobre access token.

Clique no comando para copiá-lo.

Cole e execute o comando na linha de comando. Você obterá um relatório de teste na linha de comando.

Na etapa 2, as configurações que você definir determinarão automaticamente as opções e os valores utilizados no CLI:

Ambiente: Mapeia para -e <environmentId>.

Dados de teste: Mapeia para -d <testDataId>.

Iterações: Mapeia para -n <n>.

Atraso: Mapeia para --delay-request <n>.

Variáveis de ambiente/globais: Se selecionarExport current value and use it, você poderá encontrar uma opção de exportação abaixo para exportar os valores atuais das variáveis de ambiente/globais do seu projeto para um arquivo. Isso afeta--variables <path>. Você precisará importar esse arquivo para a máquina que executa o CLI e especificar o caminho dele por meio de--variables <path>. Saiba mais sobre as diferenças entre "Use initial value" e "Export current value and use it" aqui.

Se o seu cenário de teste também usar configurações de conexão de banco de dados armazenadas localmente, a interface do produto orientará você a exportar essas configurações para um arquivo local, o que afeta --database-connection <path>. Em seguida, você precisará importar esse arquivo exportado para a máquina que executa o CLI e especificar o caminho dele em--database-connection <path>.

Executar dados exportados

Esta opção permite que você execute testes offline localmente usando arquivos exportados.

Em um cenário de teste, alterne para a aba CI/CD.

Configure o ambiente, os dados de teste, as iterações, o atraso etc.

No provedor de CI/CD, selecione "Command line" e, em seguida, alterne para "Run exported data".

Opção Executar dados exportados na configuração de CI/CD

Exporte o cenário de teste como um arquivo JSON.

Copie o comando exibido abaixo.

Cole e execute o comando na linha de comando. Você obterá um relatório de teste na linha de comando.

As configurações na etapa 2 (como "Run Online Data") afetarão automaticamente as opções e os valores usados no CLI abaixo. Observe que, ao executar dessa forma, as variáveis de ambiente/globais usam os valores do arquivo exportado junto com o cenário de teste. Saiba mais aqui.

Relatório de teste do CLI

Após executar o CLI, você receberá um relatório de teste na linha de comando que inclui estatísticas de execução dos cenários de teste, bem como validações e assertivas para requisições com falha.

Você também pode encontrar o diretório /apidog-reports/ na pasta em que executou o CLI. Esse diretório contém o relatório de teste do CLI em formato HTML.

Opções

O Apidog CLI fornece um conjunto avançado de opções para personalizar uma execução de coleção. Saiba mais em Opções do Apidog CLI.

Usando o Apidog CLI com CI/CD

O Apidog CLI oferece suporte à integração com várias ferramentas de pipeline, como Jenkins, GitLab, GitHub Actions e outras. Saiba mais sobre integração de CI/CD.

Instalando e executando o Apidog CLI

Pré-requisitos#

Instalando o Apidog CLI#

Atualizando o Apidog CLI#

Executando o Apidog CLI#

Executar dados online em tempo real#

Executar dados exportados#

Relatório de teste do CLI#

Opções#

Usando o Apidog CLI com CI/CD#

Pré-requisitos

Instalando o Apidog CLI

Atualizando o Apidog CLI

Executando o Apidog CLI

Executar dados online em tempo real

Executar dados exportados

Relatório de teste do CLI

Opções

Usando o Apidog CLI com CI/CD