Add Cypress tests for UI interactions and form validations

README.md

@@ -11,7 +11,7 @@ Read the following [doc](./docs/Requirements.md) to understand all the EngageSph
 To run this project, you will need:
 
 - [git](https://git-scm.com/downloads) (I've used version `2.42.1` while writing this doc)
-- [Node.js](https://nodejs.org/en/) (I've used version `v2#.13.1` while writing this doc)
+- [Node.js](https://nodejs.org/en/) (I've used version `v22.13.1` while writing this doc)
 - npm (I've used version `10.9.2` while writing this doc)
 
 **Note:** When installing Node.js, npm is automatically installed too.
@@ -24,6 +24,104 @@ Read the following [doc](./docs/TestEnvironment.md) to install and start the bac
 
 Read the following [doc](./docs/TestCases.md) to get a list of test cases.
 
-___
+## Running Cypress Tests
 
-Made with ❤️ by [Walmyr](https://walmyr.dev).
+This project includes end-to-end tests using Cypress, separated into API and GUI test categories. Follow the instructions below to install and run these tests:
+
+### Installing Cypress
+
+1. Install Cypress as a development dependency by running:
+```bash
+npm install 
+```
+
+
+### Folder Structure for Tests
+
+The test files are organized as follows:
+
+- **API Tests**: Located in `cypress/e2e/api/engageSphere.cy.js`.
+- **GUI Tests**: Located in `cypress/e2e/gui/engageSphere.cy.js`.
+
+
+### Running Tests
+
+You can run API and GUI tests separately or together using Cypress commands:
+
+#### Running All Tests
+
+To run all tests (both API and GUI):
+
+- **Interactive Mode**: Launch Cypress Test Runner with:
+
+```bash
+npm run cy:open
+```
+
+Select either individual test files or all available tests from the runner interface.
+
+- **Headless Mode**: Run all tests without opening the graphical interface using:
+
+```bash
+npm test
+```
+
+
+#### Running API Tests Only
+
+To run only the API tests:
+
+- **Interactive Mode**: Open Cypress Test Runner:
+
+```bash
+npm run cy:open
+```
+
+Then select `cypress/e2e/api/engageAPI.cy.js`.
+
+- **Headless Mode**: Run only this specific test file:
+
+```bash
+npm run test:api
+```
+
+
+#### Running GUI Tests Only
+
+To run only the GUI tests:
+
+- **Interactive Mode**: Open Cypress Test Runner:
+
+```bash
+npm run cy:open
+```
+
+Then select `cypress/e2e/e2e/engageGUI.cy.js`.
+
+- **Headless Mode**: Run only this specific test file:
+
+```bash
+npm run test:gui
+```
+
+
+### Additional Commands
+
+- Run tests in a specific browser (e.g., Chrome):
+
+```bash
+npm test --browser chrome
+```
+
+- Run tests in headed mode (with browser UI visible):
+
+```bash
+npm test --headed
+```
+
+For more details on writing and running Cypress tests, refer to the official [Cypress documentation](https://docs.cypress.io).
+
+---
+
+Made with ❤️ by [Walmyr](https://walmyr.dev). \
+Tests by Bruno Figueiredo

cypress.config.js

@@ -0,0 +1,12 @@
+const { defineConfig } = require("cypress");
+
+module.exports = defineConfig({
+  e2e: {
+    baseUrl: "http://localhost:3000",
+    supportFile: false,
+    fixturesFolder: false,
+    env: {
+      apiUrl: "http://localhost:3001"
+    },
+  },
+})

cypress/e2e/api/engageSphere.cy.js

@@ -0,0 +1,135 @@
+describe('EngageSphere API - Customers', () => {
+  it('Recupera clientes com sucesso (por exemplo, verifica o código de status 200)', () => {
+    cy.request(`${Cypress.env("apiUrl")}/customers`).as('getCustomers');
+
+    cy.get('@getCustomers').should((response) => {
+      expect(response).to.have.property('status', 200);
+    });
+  });
+
+  it('Realiza a paginação de clientes corretamente', () => {
+    cy.request({
+      method: 'GET',
+      url: `${Cypress.env("apiUrl")}/customers`,
+      qs: {
+        page: 2,
+        limit: 1,
+        size: 'All',
+        industry: 'All'
+      }
+    }).then((response) => {
+      expect(response.status).to.eq(200);
+      expect(response.body).to.have.property('pageInfo');
+      expect(response.body.pageInfo).to.deep.include({
+        currentPage: 2,
+      });
+    });
+  });
+
+  it('Filtra corretamente o limite de clientes', () => {
+    const limit = 2;
+
+    cy.request({
+      method: 'GET',
+      url: `${Cypress.env("apiUrl")}/customers`,
+      qs: {
+        page: 2,
+        limit: limit,
+        size: 'All',
+        industry: 'All'
+      }
+    }).then((response) => {
+      const totalCustomers = response.body.pageInfo.totalCustomers;
+      const expectedTotalPages = Math.ceil(totalCustomers / limit);
+
+      expect(response.body.pageInfo).to.deep.include({
+        totalPages: expectedTotalPages,
+        totalCustomers: totalCustomers
+      });
+    });
+  });
+
+  it('Trata requisições inválidas (por exemplo, página negativa)', () => {
+    cy.request({
+      method: 'GET',
+      url: `${Cypress.env("apiUrl")}/customers`,
+      qs: { page: -1, limit: 5, size: 'All', industry: 'All' },
+      failOnStatusCode: false
+    }).then((response) => {
+      expect(response.status).to.eq(400);
+      expect(response.body).to.have.property('error', 'Invalid page or limit. Both must be positive numbers.');
+    });
+  });
+
+  it('Trata requisições inválidas (por exemplo, limite negativo)', () => {
+    cy.request({
+      method: 'GET',
+      url: `${Cypress.env("apiUrl")}/customers`,
+      qs: { page: 1, limit: -5, size: 'All', industry: 'All' },
+      failOnStatusCode: false
+    }).then((response) => {
+      expect(response.status).to.eq(400);
+      expect(response.body).to.have.property('error', 'Invalid page or limit. Both must be positive numbers.');
+    });
+  });
+
+  it('Trata requisições inválidas (por exemplo, página como string)', () => {
+    cy.request({
+      method: 'GET',
+      url: `${Cypress.env("apiUrl")}/customers`,
+      qs: { page: 'abc', limit: 5, size: 'All', industry: 'All' },
+      failOnStatusCode: false
+    }).then((response) => {
+      expect(response.status).to.eq(400);
+      expect(response.body).to.have.property('error', 'Invalid page or limit. Both must be positive numbers.');
+    });
+  });
+
+  it('Trata requisições inválidas (por exemplo, limite como booleano)', () => {
+    cy.request({
+      method: 'GET',
+      url: `${Cypress.env("apiUrl")}/customers`,
+      qs: { page: 1, limit: false, size: 'All', industry: 'All' },
+      failOnStatusCode: false
+    }).then((response) => {
+      expect(response.status).to.eq(400);
+      expect(response.body).to.have.property('error', 'Invalid page or limit. Both must be positive numbers.');
+    });
+  });
+
+  it('Trata requisições inválidas (por exemplo, tamanho não suportado)', () => {
+    cy.request({
+      method: 'GET',
+      url: `${Cypress.env("apiUrl")}/customers`,
+      qs: {
+        page: 1,
+        limit: 5,
+        size: 'InvalidSize', // Valor não suportado
+        industry: 'All'
+      },
+      failOnStatusCode: false
+    }).then((response) => {
+      expect(response.status).to.eq(400);
+      expect(response.body).to.have.property('error', 'Unsupported size value. Supported values are All, Small, Medium, Enterprise, Large Enterprise, and Very Large Enterprise.');
+    });
+  });
+
+  it('Trata requisições inválidas (por exemplo, indústria não suportada)', () => {
+    cy.request({
+      method: 'GET',
+      url: `${Cypress.env("apiUrl")}/customers`,
+      qs: {
+        page: 1,
+        limit: 5,
+        size: 'All',
+        industry: 'InvalidIndustry' // Valor não suportado
+      },
+      failOnStatusCode: false
+    }).then((response) => {
+      expect(response.status).to.eq(400);
+      expect(response.body).to.have.property('error', 'Unsupported industry value. Supported values are All, Logistics, Retail, Technology, HR, and Finance.');
+    });
+  });
+
+
+});