Merge pull request #5 from MarCassMari/feat/api-tests

feat/testes-apizod

Author: MarCassMari

.env.example

@@ -0,0 +1,2 @@
+GOREST_BASE_URL=https://gorest.co.in/public/v2
+GOREST_TOKEN=insira_seu_token_sem_aspas

.github/workflows/playwright.yml

@@ -26,6 +26,10 @@ jobs:
       run: npx playwright install --with-deps
 
     - name: Run Playwright tests
+    env:
+        GOREST_BASE_URL: ${{ secrets.GOREST_BASE_URL }}
+        GOREST_TOKEN: ${{ secrets.GOREST_TOKEN }}
+        
       run: npx playwright test
 
     - name: Upload Test Report

.gitignore

@@ -6,3 +6,4 @@ node_modules/
 /blob-report/
 /playwright/.cache/
 /playwright/.auth/
+.env

README.md

@@ -9,6 +9,8 @@
 | **TypeScript** | Linguagem principal para tipagem e segurança. | 📘 | [Acessar Doc](https://www.typescriptlang.org/) |
 | **Node.js** | Ambiente de execução do projeto. | 🟢 | [Acessar Doc](https://nodejs.org/) |
 | **GitHub Actions** | Orquestração de CI/CD e execução em nuvem. | 🚀 | [Acessar Doc](https://github.com/features/actions) |
+| **Postman** | Documentação e testes manuais de API. | 🟠 | [Acessar Doc](https://learning.postman.com/) |
+| **Zod** | Validação de schemas e contratos de API. | 🛡️ | [Acessar Doc](https://zod.dev/) |
 
 
 
@@ -26,18 +28,32 @@ cd onlyfly
 npm install
 ```
 
-### 3. Instalar os Browsers do Playwright
+### 3. 🔑 Configuração de Variáveis de Ambiente
+
+Para rodar os testes de API localmente, é necessário configurar as credenciais de acesso. O projeto já conta com um arquivo de base para facilitar esse processo:
+  Localize o arquivo **.env.example** na raiz do projeto.
+
+  Duplique-o e renomeie a cópia para apenas **.env**
+
+  Preencha as chaves com seus dados da API GoRest:
+
+```bash
+GOREST_BASE_URL=https://gorest.co.in/public/v2
+GOREST_TOKEN=insira_seu_token_aqui_sem_aspas
+```
+
+Instalando as dependências do projeto:
 
 ```bash
 npx playwright install
 ```
 
-### 4. Executando os Testes E2E:
+### 4.1. Executando os Testes E2E:
 
 ```bash
 npx playwright test
 ```
-4.1. Modo UI(Interface Visual):
+4.2. Modo UI(Interface Visual):
 ```bash
 npx playwright test --ui
 ```
@@ -60,3 +76,4 @@ Este projeto entrega um **framework de automação E2E robusto e escalável**, d
 * **Programação Orientada a Objetos (POO)**: Utilização de classes e métodos para encapsular comportamentos, facilitando a reutilização de código e a legibilidade dos cenários.
 * **Isolamento e Independência**: Testes desenhados para serem independentes, com setups e cleanups que garantem a confiabilidade da execução (evitando estados compartilhados).
 * **Qualidade Contínua (CI/CD)**: Pipeline totalmente integrada via GitHub Actions, validando o projeto em múltiplos motores de renderização (Chromium e Firefox) a cada nova alteração.
+* **Testes de API com Validação de Contrato**: Além da UI, o projeto integra validações de camada de serviço utilizando **Zod**, garantindo que a comunicação com o backend siga rigorosamente os schemas definidos.

package-lock.json

@@ -32,5 +32,9 @@
     "husky": "^8.0.0",
     "lint-staged": "^16.2.7",
     "prettier": "^3.8.1"
+  },
+  "dependencies": {
+    "dotenv": "^17.2.3",
+    "zod": "^4.3.6"
   }
 }

package.json

@@ -1,4 +1,8 @@
 import { defineConfig, devices } from '@playwright/test';
+import dotenv from 'dotenv';
+import path from 'path';
+
+dotenv.config({ path: path.resolve(__dirname, '.env') });
 
 /**
  * Read environment variables from file.

playwright.config.ts

@@ -0,0 +1,11 @@
+import { z } from 'zod';
+
+export const userSchema = z.object({
+  id: z.number(),
+  name: z.string(),
+  email: z.string().email(),
+  gender: z.enum(['male', 'female']),
+  status: z.enum(['active', 'inactive']),
+});
+
+export const userListSchema = z.array(userSchema);

tests/api/schemas/schemas.ts

@@ -0,0 +1,40 @@
+import { test, expect } from '@playwright/test';
+import { userSchema, userListSchema } from './schemas/schemas';
+
+test('Buscar Lista de Usuários com Auth via .env', async ({ request }) => {
+  const response = await request.get(`${process.env.GOREST_BASE_URL}/users`, {
+    headers: {
+      Authorization: `Bearer ${process.env.GOREST_TOKEN}`,
+      'Content-Type': 'application/json',
+    },
+  });
+
+  expect(response.status()).toBe(200);
+
+  const responseBody = await response.json();
+
+  const users = userListSchema.parse(responseBody);
+
+  expect(users.length).toBeGreaterThan(0);
+});
+
+test('POST - Deve criar um usuário e validar a integridade do payload', async ({ request }) => {
+  const response = await request.post(`${process.env.GOREST_BASE_URL}/users`, {
+    headers: { Authorization: `Bearer ${process.env.GOREST_TOKEN}` },
+    data: {
+      name: 'Marcus Machado',
+      email: `marcus.${Date.now()}@onfly.com.br`,
+      gender: 'male',
+      status: 'active',
+    },
+  });
+
+  expect(response.status()).toBe(201);
+
+  const responseBody = await response.json();
+
+  const userValidado = userSchema.parse(responseBody);
+
+  expect(userValidado.name).toBe('Marcus Machado');
+  expect(userValidado.status).toBe('active');
+});