Desenvolvido pela equipe Guardiões do Qa.Coders Academy, o objetivo deste projeto é desenvolver as habilidades práticas em automação dos testes de API com diferentes conjuntos de dados, validação dos resultados e a criação de um pipeline de CI/CD utilizando o Git Actions para executar e validar as Collections no Postman de forma automatizada.
Este repositório tem uma página de publicação do "report" do teste que utiliza o Github Pages para servir páginas estáticas. Esse relatório será renovado todas as vezes que o teste for realizado.
https://postman-treinamento.qacoders-academy.com.br/
- É necessário ter o Node JS com a versão mais recente instalada em sua máquina. Recomendamos que utilize a versão LTS (Long-term support) por ser estável.
Acesse a ** página de download do Node.js.**
Ao clicar na opção Windows Installer da versão LTS, iniciará o download automático do pacote instalador;
Prossiga com a instalação clicando em "Next” para instalar as configurações padrão e clique em "Install”. Pode ser que algumas janelas do terminal se abram, que é justamente a responsável pela instalação das ferramentas para módulos nativos. Basta clicar em qualquer tecla para continuar e esperar até que seja finalizada:
Para instalar a versão LTS no Linux Ubuntu, digite os comandos abaixo no terminal bash ou outro de sua preferência:
curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash -
sudo apt-get install -y nodejs
Após rodar o comando o terminal exibirá a tela de execução como mostrada na figura abaixo:
A instalação no macOS é similar com a instalação do Windows, pois também pode acessar página de download do Node.js e iniciar o processo por lá.
Caso queira instalar pelo terminal, é necessário que tenha instalado o gerenciador de pacotes **homebrew .**
Para instalar, basta digitar o comando sudo brew install node js
no terminal e será instalada a versão mais recente.
Verifique se a instalação ocorreu corretamente e digite os comandos abaixo em seu terminal.
node --version
Após a exibição da versão instalada, verifique também a versão do gerenciador de pacotes para o Node( NPM) com o comando npm --version
.
Certifique-se que a versão mais recente do "NPM” esteja instalada. Saiba mais em: https://docs.npmjs.com/
Nos respectivos terminais de comando de cada sistema operacional, digite o comando:
npm install -g newman
Verifique a versão instalada:
newman --version
Instalação do newman-reporter-htmlextra
npm install -g newman-reporter-htmlextra
Verifique a versão instalada:
newman-reporter-htmlextra --version
No Git e GitHub, realize as seguintes etapas:
- Instale e Configure uma conta do Git. Para saber mais, acesse o git
- Abra o terminal e clone o repositório no GitHub com os comandos abaixo:
git clone https://github.com/Qa-Coders/guardioes-automation-newman-nodeexpress-erp.git
2.1 Após clonar e entrar na pasta local do repositório com o comando:
cd guardioes-automation-newman-nodeexpress-erp
2.2 Para gerar o relatório do Newman execute o comando abaixo:
newman run ./AutomacaoSignup.postman_collection.json -e ./Signup.postman_environment.json --reporters cli, -r htmlextra --reporter-htmlextra-browserTitle "Report Test Signup - ERP" --reporter-htmlextra-title "Report Test Signup - ERP" --reporter-htmlextra-export ./docs/index.html
2.3 Caso no relatório apareça um erro de Certificado SSL execute o comando abaixo (acrescentando “-k” para ignorar o certificado):
newman run ./AutomacaoSignup.postman_collection.json -e ./Signup.postman_environment.json -k --reporters cli, -r htmlextra --reporter-htmlextra-browserTitle "Report Test Signup - ERP" --reporter-htmlextra-title "Report Test Signup - ERP" --reporter-htmlextra-export ./docs/index.html
2.4 Para visualizar o relatório gerado navegue até a pasta "docs" criada dentro do repositório e dê dois (2) cliques no arquivo index.html para ser aberto no navegador padrão.
- A configuração do pipeline de CI/CD no Git Actions será a responsável por automatizar a execução dos testes no Postman sempre que houver alterações no repositório.
Para verificar como é um script acesse o caminho abaixo:
- Crie um Workspace no Postman caso não tenha. Para mais informações, acesse o site.
- Importe os dois arquivos JSON. Para mais informações, acesse o site.