Pré-requisitos#
Jenkins instalado e em execução (v2.0 ou posterior recomendado)
Node.js v16 ou posterior instalado no host 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 os programadores a automatizar o processo de build, os testes e a implementação de aplicações durante o processo de desenvolvimento de software. Veja como instalá-lo num 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 Jenkins:
http://localhost:8080 ou http://{your_public_IP}:8080 para aceder ao painel do Jenkins. A consola fornece uma API web para gerir e configurar os serviços Jenkins.Configurar o ambiente Node.js para o Jenkins#
Antes de executar a Apidog CLI, deve garantir que a versão do Node.js é v16 ou posterior. Por isso, primeiro tem de configurar as dependências do NodeJS no ambiente Jenkins.
1.
Abra a gestão de plugins do Jenkins, localize 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 numa pipeline visual (Freestyle Project)
2.
Integrar o código incorporado na pipeline (Pipeline)
Executar comandos da CLI#
Configurar a pipeline visualmente#
Abra o Apidog e obtenha o comando da CLI na página de detalhes da integração contínua. Se o seu ambiente Jenkins tiver acesso à Internet, pode optar por utilizar o comando "Run online data in real time". Se o acesso à Internet não estiver disponível, tem primeiro de exportar o ficheiro de dados JSON da CLI para o ambiente e, em seguida, executá-lo através da CLI.Na página de configuração do projeto, localize a secção Build Environment, selecione a opção "Provide Node & npm bin/ folder to PATH" e escolha a versão do NodeJS (por exemplo, nodejs18) que configurou na secção Global Tool Configuration (Tools).Depois de configurar o ambiente de build, aceda à secção Build Steps, clique em Add build step e selecione Execute Shell (escolha Execute Windows Batch Command se estiver a utilizar um sistema Windows).Cole o comando da Apidog CLI na caixa de entrada Command e guarde a configuração.Clique em Build Now no projeto para iniciar a execução.Pode verificar o progresso e os resultados da build no "Build History".Integrar código incorporado na pipeline#
Navegue até ao separador CI/CD e copie o fragmento de código incorporado; em seguida, cole-o no ficheiro de configuração do Jenkins.Basta colar o código diretamente na configuração da pipeline do Jenkins para o incorporar no seu fluxo de trabalho CI/CD existente.O nodejs18 mencionado aqui refere-se ao alias do NodeJS definido anteriormente — substitua-o pelo seu alias real. Além disso, certifique-se de que substitui a variável $APIDOG_ACCESS_TOKEN no código pelo seu token de acesso real. Em alternativa, pode adicionar uma variável de ambiente denominada APIDOG_ACCESS_TOKEN no Jenkins em Dashboard → Manage Jenkins → System e definir o respetivo valor como o seu token de acesso. Isto permite que a pipeline leia o seu token de acesso durante a execução.Pode simplificar o código acima removendo o script para instalar a Apidog CLI. Desta forma, não é necessário reinstalar o apidog-cli sempre que uma build é executada, o que reduz tanto o tempo de build como o consumo de recursos. Isto é 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 estão 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 incorporada do Jenkins) no comando. Utilize o plugin HTML Publisher para visualizar o relatório.