Instalar e Executar o Apidog CLI

O Apidog CLI foi concebido para executar cenários de teste do Apidog na linha de comandos. Para começar a utilizar o Apidog CLI, instale o Node.js e, em seguida, o Apidog CLI. Depois, poderá executar os seus cenários de teste.

Pré-requisitos

Node.js v16 ou posterior instalado no seu sistema

npm (Node Package Manager) instalado

Uma conta Apidog com cenários de teste criados

Instalar o Apidog CLI

O Apidog CLI é desenvolvido com base em Node.js. Para executar o Apidog CLI, por favor instale o Node.js antes de o utilizar.

O Apidog CLI requer Node.js versão v16 ou posterior.

Instale o Apidog CLI a partir do npm globalmente no seu sistema, permitindo-lhe executá-lo a partir de qualquer localização:

Seguem-se alguns comandos para verificar se o Apidog CLI foi instalado com êxito.

Se for instalado com êxito, 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 que mostra a instalação bem-sucedida do Apidog CLI com números de versão e caminhos

Atualizar o Apidog CLI

Utilize o comando abaixo para atualizar o Apidog CLI.

Executar o Apidog CLI

Para executar cenários de teste utilizando o Apidog CLI, primeiro tem de criar e orquestrar um cenário de teste. Em seguida, pode executar o cenário de teste a partir da linha de comandos utilizando o Apidog CLI, tal como o executaria na interface visual, e obter um relatório de teste.

O Apidog CLI suporta duas formas de execução:

Execução com dados online: adequada para cenários em tempo real.

Execução com cenários de teste exportados: adequada para cenários offline.

Executar Dados Online em Tempo Real

Num cenário de teste, mude para o separador CI/CD.

Separador 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 secção do fornecedor 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 o copiar.

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

No passo 2, as configurações que 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, encontrará uma opção de exportação abaixo para exportar os valores atuais das variáveis de ambiente/globais do seu projeto para um ficheiro. Isto afeta--variables <path>. Terá de importar este ficheiro para a máquina que executa o CLI e especificar o respetivo caminho através 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 utilizar configurações de ligação à base de dados armazenadas localmente, a interface do produto irá orientá-lo para exportar estas configurações para um ficheiro local, o que afeta --database-connection <path>. Em seguida, terá de importar este ficheiro exportado para a máquina que executa o CLI e especificar o respetivo caminho em--database-connection <path>.

Executar Dados Exportados

Esta opção permite-lhe executar testes offline localmente utilizando ficheiros exportados.

Num cenário de teste, mude para o separador CI/CD.

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

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

Opção Run exported data na configuração de CI/CD

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

Copie o comando apresentado abaixo.

Cole e execute o comando na linha de comandos. Receberá um relatório de teste na linha de comandos.

As definições no passo 2 (como "Run Online Data") afetarão automaticamente as opções e os valores utilizados no CLI abaixo. Tenha em atenção que, ao executar desta forma, as variáveis de ambiente/globais utilizam os valores do ficheiro exportado juntamente com o cenário de teste. Saiba mais aqui.

Relatório de Teste do CLI

Após executar o CLI, receberá um relatório de teste na linha de comandos que inclui estatísticas de execução dos cenários de teste e validação e asserções para pedidos falhados.

Também pode encontrar o diretório /apidog-reports/ na pasta onde executou o CLI. Este diretório contém o relatório de teste do CLI em formato HTML.

Opções

O Apidog CLI fornece um conjunto abrangente de opções para personalizar uma execução de coleção. Saiba mais em Apidog CLI Options.

Utilizar o Apidog CLI com CI/CD

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

Instalar e Executar o Apidog CLI

Pré-requisitos#

Instalar o Apidog CLI#

Atualizar o Apidog CLI#

Executar o Apidog CLI#

Executar Dados Online em Tempo Real#

Executar Dados Exportados#

Relatório de Teste do CLI#

Opções#

Utilizar o Apidog CLI com CI/CD#

Pré-requisitos

Instalar o Apidog CLI

Atualizar o Apidog CLI

Executar o Apidog CLI

Executar Dados Online em Tempo Real

Executar Dados Exportados

Relatório de Teste do CLI

Opções

Utilizar o Apidog CLI com CI/CD