Skip to content

Commit b660638

Browse files
AndressaKarlaAndressaKarla
committed
Atualizando o README.md com mais algumas informações
1 parent f7d9cff commit b660638

File tree

1 file changed

+151
-0
lines changed

1 file changed

+151
-0
lines changed

‎README.md‎

Lines changed: 151 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,155 @@ Esse projeto "blacklist-academy12.2-api-postman" é executado no ambiente da squ
66

77

88
---
9+
# :dart: Executar com Newman testes automatizados de API REST da collection e environment do Postman, Gerar e armazenar report html no GitHub Actions
10+
- Nesse repositório, acessar a aba "Actions"
11+
- Na seção "Actions", clicar em "Pipeline Testes Automatizados API REST ERP Qa.Coders Academy Postman"
12+
- 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
13+
- Após o término da execução, clicar na run "Pipeline Testes Automatizados API REST ERP Qa.Coders Academy Postman"
14+
- Na seção "Artifacts", clicar em "postman-api-rest-report-html-newman"
15+
- Na janela aberta, escolher um diretório para baixar a pasta compactada "postman-api-rest-report-html-newman.zip"
916

17+
# Verificar no navegador padrão o report html gerado e armazenado anteriormente no GitHub Actions e descompactado no computador :female_detective:
18+
- No Windows 11, abrir uma janela do "Explorador de Arquivos"
19+
- Acessar o diretório onde foi baixada a pasta compactada "postman-api-rest-report-html-newman.zip" anteriormente
20+
- Descompactar a pasta
21+
- Acessar a pasta descompactada "postman-api-rest-report-html-newman"
22+
- 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
23+
24+
# Antes de clonar ou executar esse projeto localmente no computador, é necessário seguir as instruções abaixo :point_down:
25+
## :hammer_and_wrench: Janela do "Explorador de Arquivos" > opção "Visualizar" > "Mostrar" e marcar algumas opções
26+
- No Windows 11, abrir uma janela do "Explorador de Arquivos"
27+
- Clicar na opção "Visualizar" > "Mostrar"
28+
- Clicar na opção "Itens ocultos"
29+
30+
## :hammer_and_wrench: Baixar e instalar o git e gitbash; configurar o git
31+
- Caso ainda não tenha o git e gitbash baixado e instalado, acessar o link do [git e gitbash](https://git-scm.com/download/win), baixar e instalar
32+
- Caso ainda não tenha configurado o git, seguir os passos apresentados nesse link [Configure a ferramenta](https://training.github.com/downloads/pt_BR/github-git-cheat-sheet/#:~:text=Configure%20a%20ferramenta) e configurar
33+
34+
## :hammer_and_wrench: Instalar as dependências necessárias
35+
### Desinstalar completamente Node.js e npm que já foram instalados em algum outro momento
36+
- Seguir os passos apresentados nesse link ["COMO REMOVER COMPLETAMENTE O NODE.JS DO WINDOWS?"](https://acervolima.com/como-remover-completamente-o-node-js-do-windows/#:~:text=Pesquise%20por%20programa%20e%20recursos,js%20e%20desinstale-o.)
37+
38+
### Node versão 18.12.1
39+
- Baixar e instalar o [node v18.12.1](https://nodejs.org/dist/v18.12.1/) > node-v18.12.1-x64.msi
40+
- Abrir um novo gitbash ou outro terminal de preferência
41+
- Informar o comando abaixo para confirmar se o node realmente foi instalado
42+
```
43+
node --version
44+
```
45+
- Verificar se foi retornada a mesma versão do node instalada anteriormente:
46+
```
47+
v18.12.1
48+
```
49+
- Informar o comando abaixo para confirmar se o npm realmente foi instalado
50+
```
51+
npm --version
52+
```
53+
- E verificar se foi retornada essa mesma versão do npm:
54+
```
55+
8.19.2
56+
```
57+
58+
### newman
59+
- No gitbash ou terminal aberto anteriormente, informar o comando abaixo para instalar o newman
60+
```
61+
npm install -g newman
62+
```
63+
- Informar o comando abaixo para verificar se foi retornada alguma versão e confirmar se o newman realmente foi instalado
64+
```
65+
newman --version
66+
```
67+
68+
### newman-reporter-htmlextra
69+
- No gitbash ou terminal aberto anteriormente, informar o comando abaixo para instalar o newman-reporter-htmlextra
70+
```
71+
npm install -g newman-reporter-htmlextra
72+
```
73+
- Informar o comando abaixo para verificar se foi retornada alguma versão e confirmar se o newman-reporter-htmlextra realmente foi instalado
74+
```
75+
newman-reporter-htmlextra --version
76+
```
77+
- Fechar esse gitbash ou terminal
78+
79+
## :hammer_and_wrench: Clonar o projeto
80+
- No Windows 11, abrir uma janela do "Explorador de Arquivos"
81+
- Acessar o diretório onde será clonado o projeto "blacklist-academy12.2-api-postman"
82+
- Copiar esse diretório
83+
- Abrir um novo gitbash
84+
- Informar o comando abaixo para acessar onde será clonado o projeto
85+
```
86+
cd "<diretório copiado anteriormente>"
87+
```
88+
Ex.:
89+
```
90+
cd "C:\PROJETOS\Automação\Postman"
91+
```
92+
- Informar o comando abaixo para clonar este repositório via "HTTPS"
93+
```
94+
git clone https://github.com/AndressaKarla/blacklist-academy12.2-api-postman.git
95+
```
96+
- Ou informar o comando abaixo para clonar este repositório via "SSH"
97+
```
98+
git clone git@github.com:AndressaKarla/blacklist-academy12.2-api-postman.git
99+
```
100+
101+
## :hammer_and_wrench: Instalar as extensões no Visual Studio Code (VS Code)
102+
- Caso ainda não tenha o VS Code baixado e instalado, acessar o site do [Visual Studio Code](https://code.visualstudio.com/download), baixar e instalar com a opção "System Installer"
103+
- 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"
104+
- Clicar na opção "Manage > Profiles > Create Profile"
105+
- Em "Profile name", informar "Postman"
106+
- Clicar na opção "Create"
107+
- Clicar na opção "Extensions", informar e instalar as extensões abaixo:
108+
- Hyper Term Theme
109+
- HasseNasse
110+
- Clicar na opção "Hyper Term Black" apresentada para habilitar a extensão
111+
- Material Icon Theme
112+
- Philipp Kief
113+
- Clicar na opção "Material Icon Theme" apresentada para habilitar a extensão
114+
- Fechar o VS Code
115+
116+
## :bookmark_tabs: Abrir o VS Code diretamente na pasta do projeto "blacklist-academy12.2-api-postman"
117+
- No gitbash aberto anteriormente, informar o comando abaixo para abrir o VS Code diretamente na pasta do projeto "blacklist-academy12.2-api-postman"
118+
```
119+
code .
120+
```
121+
- Aguardar o VS Code ser aberto
122+
- Fechar esse gitbash
123+
- 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 ...."
124+
- Clicar no botão "Yes, I trust the authors ...."
125+
126+
# :dart: Executar com Newman testes automatizados de API REST da collection e environment do Postman e Gerar report diretamente no terminal no computador
127+
- No gitbash aberto anteriormente, informar o comando abaixo para acessar o projeto “blacklist-academy12.2-api-postman”
128+
```
129+
cd blacklist-academy12.2-api-postman
130+
```
131+
Ex.:
132+
```
133+
C:\PROJETOS\Automação\Postman\blacklist-academy12.2-api-postman
134+
```
135+
- 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
136+
```
137+
newman run ./nome-collection.json -e ./nome-environment.json --delay-request 2
138+
```
139+
Ex.:
140+
```
141+
newman run ./blacklist-collection-sprints11,12,14.json -e ./blacklist-environment-sprints11,12,14.json --delay-request 2
142+
```
143+
144+
# :dart: Executar com Newman testes automatizados de API REST da collection e environment do Postman e Gerar report html na pasta "reports" no computador
145+
- 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](https://github.com/AndressaKarla/blacklist-academy12.2-api-postman/blob/main/.github/workflows/workflow-blacklist-academy-api-postman-newman.yml)" no GitHub Actions)
146+
```
147+
newman run ./nome-collection.json -e ./nome-environment.json --delay-request 2 --reporters cli, -r htmlextra --reporter-htmlextra-export ./reports/nome-report.html
148+
```
149+
Ex.:
150+
```
151+
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
152+
```
153+
- Fechar esse gitbash
154+
155+
---
156+
# Verificar no navegador padrão o report html gerado na pasta "reports" anteriormente no computador :female_detective:
157+
## :bookmark_tabs: Relatório html no computador
158+
- No VS Code aberto anteriormente, acessar "reports > postman-api-rest-report-htmlextra-newman.html"
159+
- Clicar com botão direito do mouse sob o arquivo "postman-api-rest-report-htmlextra-newman.html" > "Reveal in File Explorer"
160+
- Na janela do "Explorador de Arquivos" aberta automaticamente, clicar 2 vezes sob o arquivo "postman-api-rest-report-htmlextra-newman.html" gerado anteriormente no computador para ser aberto e verificado no navegador padrão

0 commit comments

Comments
 (0)