Pré-requisitos#
Jenkins instalado e em execução (v2.0 ou posterior recomendado)
Node.js v16 ou posterior instalado no host do Jenkins
Uma conta Apidog com cenários de teste criados
Acesso para gerar tokens de acesso do Apidog
Instalar o Jenkins#
O Jenkins é uma ferramenta de build automatizada que ajuda desenvolvedores a automatizar o processo de build, teste e implantação de aplicações durante o processo de desenvolvimento de software. Veja como instalá-lo em um sistema Linux:1.
Adicione a chave pública GPG do Jenkins:
2.
Adicione a origem do Jenkins à lista de origens de software APT:
3.
Atualize a lista de pacotes APT:
5.
Inicie o serviço do Jenkins:
http://localhost:8080 ou http://{your_public_IP}:8080 para acessar o painel do Jenkins. O console fornece uma API web para você gerenciar e configurar os serviços do Jenkins.Configurar o ambiente Node.js para o Jenkins#
Antes de executar a Apidog CLI, você precisa garantir que o número da versão do Node.js seja v16 ou posterior; portanto, primeiro é necessário configurar as dependências do NodeJS no ambiente do Jenkins.
1.
Abra o gerenciamento de plugins do Jenkins, encontre o plugin NodeJS, instale-o e reinicie.
2.
Crie um novo NodeJS na configuração global de ferramentas, configure o número da versão (requer v16 ou posterior) e o nome do pacote apidog-cli.
1.
Adicionar a configuração em um pipeline visual (Freestyle Project)
2.
Integrar o código incorporado ao pipeline (Pipeline)
Executar comandos da CLI#
Configurar o pipeline visualmente#
Abra o Apidog e obtenha o comando da CLI na página de detalhes de Integração Contínua. Se o seu ambiente Jenkins tiver acesso à internet, você poderá optar por usar o comando "Run online data in real time". Se o acesso à internet não estiver disponível, primeiro será necessário exportar o arquivo de dados JSON da CLI para o ambiente e, em seguida, executá-lo por meio da CLI.Na página de configuração do projeto, localize a seção Build Environment, marque a opção "Provide Node & npm bin/ folder to PATH" e selecione a versão do NodeJS (por exemplo, nodejs18) que você configurou na seção Global Tool Configuration (Tools).Depois de configurar o ambiente de build, vá para a seção Build Steps, clique em Add build step e selecione Execute Shell (escolha Execute Windows Batch Command se estiver usando um sistema Windows).Cole o comando da Apidog CLI na caixa de entrada Command e salve a configuração.Clique em Build Now no projeto para iniciar a execução.Você pode verificar o progresso e os resultados do build em "Build History".Integrar código incorporado ao pipeline#
Navegue até a aba CI/CD e copie o trecho de código incorporado; em seguida, cole-o no arquivo de configuração do Jenkins.Basta colar o código diretamente na configuração do pipeline do Jenkins para incorporá-lo ao seu fluxo de trabalho de CI/CD existente.O nodejs18 mencionado aqui se refere ao alias do NodeJS definido anteriormente — substitua-o pelo seu alias real. Além disso, certifique-se de substituir a variável $APIDOG_ACCESS_TOKEN no código pelo seu Access Token real. Como alternativa, você pode adicionar uma variável de ambiente chamada APIDOG_ACCESS_TOKEN no Jenkins em Dashboard → Manage Jenkins → System e definir seu valor como seu Access Token. Isso permite que o pipeline leia seu Access Token durante a execução.Você pode simplificar o código acima removendo o script de instalação da Apidog CLI. Dessa forma, não há necessidade de reinstalar apidog-cli toda vez que um build é executado, o que reduz tanto o tempo de build quanto o consumo de recursos. Isso é possível porque o NodeJS e os pacotes npm globais (ou seja, apidog-cli) já foram configurados antecipadamente em Global Tool Configuration (Tools), garantindo que as ferramentas necessárias estejam prontamente disponíveis durante o processo de build.Clique em Build Now no projeto para iniciar a execução.Especifique o nome do relatório gerado ${JOB_NAME}_${BUILD_NUMBER} (variável integrada do Jenkins) no comando. Use o plugin HTML Publisher para visualizar o relatório.