---

Projeto de Testes Funcionais Automatizados de API REST | Postman | Javascript | JSON Schema | Newman | GitHub Actions | GitHub Pages 🧪

---

ℹ️ Introdução

Esse projeto "blacklist-academy12.2-api-postman" é executado no ambiente da squad "Black List" de "API REST" do "ERP do Qa.Coders Academy", com o objetivo de praticarmos ainda mais testes funcionais automatizados de API REST (Ex.: JSON Schema, geração de massa de dados dinâmicos, etc) em Postman, Javascript, Newman, GitHub Actions e GitHub Pages.

---

🎯 Executar com Newman testes automatizados de API REST da collection e environment do Postman, Gerar e armazenar report html no GitHub Actions

• Nesse repositório, acessar a aba "Actions"
• Na seção "Actions", clicar em "Pipeline Testes Automatizados API REST ERP Qa.Coders Academy Postman"
• Em "This workflow has a workflow_dispatch event trigger.", clicar em "Run workflow" > "Run workflow" para executar com Newman testes automatizados de API REST da collection e environment do Postman com um tempo de espera de 2 ms entre as requisições, gerar e armazenar report html no GitHub Actions
• Após o término da execução, clicar na run "Pipeline Testes Automatizados API REST ERP Qa.Coders Academy Postman"
• Na seção "Artifacts", clicar em "postman-api-rest-report-html-newman"
• Na janela aberta, escolher um diretório para baixar a pasta compactada "postman-api-rest-report-html-newman.zip"

🔎 Verificar no navegador padrão o report html gerado e armazenado anteriormente no GitHub Actions e descompactado no computador

• No Windows 11, abrir uma janela do "Explorador de Arquivos"
• Acessar o diretório onde foi baixada a pasta compactada "postman-api-rest-report-html-newman.zip" anteriormente
• Descompactar a pasta
• Acessar a pasta descompactada "postman-api-rest-report-html-newman"
• Clicar 2 vezes sob o report "postman-api-rest-report-htmlextra-newman.html" gerado e armazenado anteriormente no GitHub Actions e descompactado para ser aberto e verificado no navegador padrão no computador

---

Antes de clonar ou executar esse projeto localmente no computador, é necessário seguir as instruções abaixo 👇

🛠️ Janela do "Explorador de Arquivos" > opção "Visualizar" > "Mostrar" e marcar algumas opções

• No Windows 11, abrir uma janela do "Explorador de Arquivos"
• Clicar na opção "Visualizar" > "Mostrar"
• Clicar na opção "Itens ocultos"

🛠️ Baixar e instalar o git e gitbash; configurar o git

• Caso ainda não tenha o git e gitbash baixado e instalado, acessar o link do git e gitbash, baixar e instalar
• Caso ainda não tenha configurado o git, seguir os passos apresentados nesse link Configure a ferramenta e configurar

🛠️ Instalar as dependências necessárias

Desinstalar completamente Node.js e npm que já foram instalados em algum outro momento

• Seguir os passos apresentados nesse link "COMO REMOVER COMPLETAMENTE O NODE.JS DO WINDOWS?"

Node versão 18.12.1

• Baixar e instalar o node v18.12.1 > node-v18.12.1-x64.msi
• Abrir um novo gitbash ou outro terminal de preferência
• Informar o comando abaixo para confirmar se o node realmente foi instalado

node --version

• Verificar se foi retornada a mesma versão do node instalada anteriormente:

v18.12.1

• Informar o comando abaixo para confirmar se o npm realmente foi instalado

npm --version

• E verificar se foi retornada essa mesma versão do npm:

8.19.2

newman

• No gitbash ou terminal aberto anteriormente, informar o comando abaixo para instalar o newman

npm install -g newman

• Informar o comando abaixo para verificar se foi retornada alguma versão e confirmar se o newman realmente foi instalado

newman --version

newman-reporter-htmlextra

• No gitbash ou terminal aberto anteriormente, informar o comando abaixo para instalar o newman-reporter-htmlextra

npm install -g newman-reporter-htmlextra

• Informar o comando abaixo para verificar se foi retornada alguma versão e confirmar se o newman-reporter-htmlextra realmente foi instalado

newman-reporter-htmlextra --version

• Fechar esse gitbash ou terminal

---

🛠️ Clonar o projeto

• No Windows 11, abrir uma janela do "Explorador de Arquivos"
• Acessar o diretório onde será clonado o projeto "blacklist-academy12.2-api-postman"
• Copiar esse diretório
• Abrir um novo gitbash
• Informar o comando abaixo para acessar onde será clonado o projeto

cd "<diretório copiado anteriormente>"

Ex.:

cd "C:\PROJETOS\Automação\Postman"

• Informar o comando abaixo para clonar este repositório via "HTTPS"

git clone https://github.com/AndressaKarla/blacklist-academy12.2-api-postman.git

• Ou informar o comando abaixo para clonar este repositório via "SSH"

git clone git@github.com:AndressaKarla/blacklist-academy12.2-api-postman.git

---

🎯 Executar com Newman testes automatizados de API REST da collection e environment do Postman e Gerar report diretamente no terminal no computador

• Informar o comando abaixo para acessar o projeto “blacklist-academy12.2-api-postman” clonado anteriormente

cd blacklist-academy12.2-api-postman

Ex.:

C:\PROJETOS\Automação\Postman\blacklist-academy12.2-api-postman

• Informar o comando abaixo para executar com Newman testes automatizados de API REST da collection e environment do Postman com um tempo de espera de 2 ms entre as requisições e Gerar report diretamente no terminal

newman run ./nome-collection.json -e ./nome-environment.json --delay-request 2

Ex.:

newman run ./blacklist-collection-sprints11,12,14.json -e ./blacklist-environment-sprints11,12,14.json --delay-request 2

🎯 Executar com Newman testes automatizados de API REST da collection e environment do Postman e Gerar report html na pasta "reports" no computador

• No gitbash aberto anteriormente, informar o comando abaixo para executar com Newman testes automatizados de API REST da collection e environment do Postman com um tempo de espera de 2 ms entre as requisições e gerar report html na pasta "reports" no computador (mesmo comando que é utilizado no "Passo 4" da "Pipeline Testes Automatizados API REST ERP Qa.Coders Academy Postman" em ".github > workflows > workflow-blacklist-academy-api-postman-newman.yml" no GitHub Actions)

newman run ./nome-collection.json -e ./nome-environment.json --delay-request 2 --reporters cli, -r htmlextra --reporter-htmlextra-export ./reports/nome-report.html

Ex.:

newman run ./blacklist-collection-sprints11,12,14.json -e ./blacklist-environment-sprints11,12,14.json --delay-request 2 --reporters cli, -r htmlextra --reporter-htmlextra-export ./reports/postman-api-rest-report-htmlextra-newman.html

---

🛠️ Instalar as extensões no Visual Studio Code (VS Code)

• Caso ainda não tenha o VS Code baixado e instalado, acessar o site do Visual Studio Code, baixar e instalar com a opção "System Installer"
• Com o Visual Studio Code aberto, caso seja apresentado alguma mensagem de "Instalar pacote de idiomas ...", clicar no ícone de configurações > "Don't Show Again"
• Clicar na opção "Manage > Profiles > Create Profile"
• Em "Profile name", informar "Postman"
• Clicar na opção "Create"
• Clicar na opção "Extensions", informar e instalar as extensões abaixo:
  • Hyper Term Theme
    • HasseNasse
      • Clicar na opção "Hyper Term Black" apresentada para habilitar a extensão
  • Material Icon Theme
    • Philipp Kief
      • Clicar na opção "Material Icon Theme" apresentada para habilitar a extensão
• Fechar o VS Code

📑 Abrir o VS Code diretamente na pasta do projeto "blacklist-academy12.2-api-postman"

• No gitbash aberto anteriormente, informar o comando abaixo para abrir o VS Code diretamente na pasta do projeto "blacklist-academy12.2-api-postman"

code .

• Aguardar o VS Code ser aberto
• No VS Code aberto, caso seja apresentado "Do you trust the authors on the files in this folder?", marcar a opção "Trust the authors of all files in the parent folder ...."
  • Clicar no botão "Yes, I trust the authors ...."

---

🔎 Verificar no navegador padrão o report html gerado e armazenado na pasta "reports" anteriormente no computador

📑 Report html no computador

• No VS Code aberto anteriormente, acessar "reports > postman-api-rest-report-htmlextra-newman.html"
• Clicar com botão direito do mouse sob o arquivo "postman-api-rest-report-htmlextra-newman.html" > "Reveal in File Explorer"
• Na janela do "Explorador de Arquivos" aberta automaticamente, clicar 2 vezes sob o arquivo "postman-api-rest-report-htmlextra-newman.html" gerado e armazenado anteriormente no computador para ser aberto e verificado no navegador padrão

---

Feito com ❤️ por Andressa Karla, Cassiano Pereira, Cristian Fabiano, Ewerton Luiz e Isabela Vidal 👋

---