First delivery

.github/workflows/actionTests.yaml

@@ -0,0 +1,44 @@
+name: EngageSphere tests 🧪
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  build-and-test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Install and run backend
+        run: |
+          cd backend
+          npm install
+          npm start &
+        env:
+          CI: true
+
+      - name: Install and run frontend
+        run: |
+          cd frontend
+          npm install
+          npm start &
+        env:
+          CI: true
+
+      - name: Install and run tests
+        run: |
+          npm install
+          npm test
+        continue-on-error: true # Action should continue in failure situations
+
+      - name: Upload Cypress screenshots
+        if: failure()
+        uses: actions/upload-artifact@v3
+        with:
+          name: cypress-screenshots
+          path: cypress/screenshots

README.md

@@ -24,6 +24,68 @@ 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.
 
+To execute the tests on the first time you need install the dev dependencies:
+
+```bash
+npm install
+```
+
+When the installation was completed you can execute the tests using the following commands:
+
+```bash
+npm run test
+```
+
+### Custom Commands
+
+This repository includes custom commands to facilitate running tests in different scenarios:
+
+### Open Cypress Launchpad Command
+
+To open Cypress Launchpad with the default configuration:
+
+``` bash
+npm run cy:open
+```
+
+### Open Cypress Launchpad in Mobile Size
+
+To simulate a mobile environment when opening Cypress Launchpad:
+
+``` bash
+npm run cy:open:mobile
+```
+
+### Run Tests in Specific Browsers
+
+To run tests in specific browsers, use the commands below. Ensure that the desired browser is installed on your machine.
+
+**Chrome**:
+
+``` bash
+npm run test:chrome
+```
+
+**Electron**:
+
+``` bash
+npm run test:electron
+```
+
+**Firefox**:
+
+``` bash
+npm run test:firefox
+```
+
+### Run Tests Simulating Mobile Screens
+
+To run tests simulating a mobile environment:
+
+``` bash
+npm run test:mobile
+```
+
 ___
 
 Made with ❤️ by [Walmyr](https://walmyr.dev).

cypress.config.js

@@ -0,0 +1,11 @@
+const { defineConfig } = require('cypress');
+
+module.exports = defineConfig({
+  env: {
+    API_URL: 'http://localhost:3001'
+  },
+  e2e: {
+    viewportWidth: 1100,
+    baseUrl: 'http://localhost:3000'
+  }
+});

cypress/e2e/api/testsApi.cy.js

@@ -0,0 +1,135 @@
+describe('Validate the API requests', () => {
+  const CUSTOMERS_API_URL = `${Cypress.env('API_URL')}/customers`;
+
+  context('Pagination and limits', () => {
+    it('Get customers successfully', () => {
+      cy.request({
+        method: 'GET',
+        url: CUSTOMERS_API_URL,
+      }).then(({ status }) => {
+        expect(status).to.equal(200);
+      });
+    });
+
+    it('Get the second page', () => {
+      cy.request({
+        method: 'GET',
+        url: `${CUSTOMERS_API_URL}?page=2`,
+      }).then(({ status }) => {
+        expect(status).to.equal(200);
+      });
+    });
+
+    it('Change the limits of customers per page', () => {
+      cy.request({
+        method: 'GET',
+        url: `${CUSTOMERS_API_URL}?page=1&limit=20`,
+      }).then(({ status, body }) => {
+        expect(status).to.equal(200);
+        expect(body.pageInfo.totalPages).to.equal(3);
+      });
+    });
+  });
+  context('Filters', () => {
+    const sizes = ['Small', 'Medium', 'Enterprise', 'Large Enterprise', 'Very Large Enterprise'];
+    const industries = ['Logistics', 'Retail', 'Technology', 'HR', 'Finance'];
+    Cypress._.each(sizes, (size) => {
+      it(`Filter company by the size ${size}`, () => {
+        cy.request({
+          method: 'GET',
+          url: `${CUSTOMERS_API_URL}?size=${size}`,
+        }).then(({ status, body }) => {
+          expect(status).to.equal(200);
+          // Check if all returned companies have less than 100 employees
+          const allCompaniesHaveSameSize = body.customers.every(customer => customer.size == `${size}`);
+          expect(allCompaniesHaveSameSize).to.be.true;
+        });
+      });
+    });
+
+    Cypress._.each(industries, (industry) => {
+      it(`Filter company by the industry ${industry}`, () => {
+        cy.request({
+          method: 'GET',
+          url: `${CUSTOMERS_API_URL}?industry=${industry}`,
+        }).then(({ status, body }) => {
+          expect(status).to.equal(200);
+          // Check if all returned companies have less than 100 employees
+          const allCompaniesHaveSameIndustry = body.customers.every(customer => customer.industry == industry);
+          expect(allCompaniesHaveSameIndustry).to.be.true;
+        });
+      });
+    });
+  });
+
+  context('Negative scenarios', () => {
+    context('Pagination and limits', () => {
+      it('Request a negative page', () => {
+        cy.request({
+          method: 'GET',
+          url: `${CUSTOMERS_API_URL}?page=-1`,
+          failOnStatusCode: false
+        }).then(({ status, body }) => {
+          expect(status).to.equal(400);
+          expect(body).to.have.property('error', 'Invalid page or limit. Both must be positive numbers.');
+        });
+      });
+
+      it('Request a negative limit', () => {
+        cy.request({
+          method: 'GET',
+          url: `${CUSTOMERS_API_URL}?limit=-10`,
+          failOnStatusCode: false
+        }).then(({ status, body }) => {
+          expect(status).to.equal(400);
+          expect(body).to.have.property('error', 'Invalid page or limit. Both must be positive numbers.');
+        });
+      });
+
+      it('Request text page', () => {
+        cy.request({
+          method: 'GET',
+          url: `${CUSTOMERS_API_URL}?page=cicero&limit=-10`,
+          failOnStatusCode: false
+        }).then(({ status, body }) => {
+          expect(status).to.equal(400);
+          expect(body).to.have.property('error', 'Invalid page or limit. Both must be positive numbers.');
+        });
+      });
+
+      it('Request bool limit', () => {
+        cy.request({
+          method: 'GET',
+          url: `${CUSTOMERS_API_URL}?page=cicero&limit=` + true,
+          failOnStatusCode: false
+        }).then(({ status, body }) => {
+          expect(status).to.equal(400);
+          expect(body).to.have.property('error', 'Invalid page or limit. Both must be positive numbers.');
+        });
+      });
+    });
+    context('Filters', () => {
+      it('Request an invalid company size', () => {
+        cy.request({
+          method: 'GET',
+          url: `${CUSTOMERS_API_URL}?size=Cicero`,
+          failOnStatusCode: false
+        }).then(({ status, body }) => {
+          expect(status).to.equal(400);
+          expect(body).to.have.property('error', 'Unsupported size value. Supported values are All, Small, Medium, Enterprise, Large Enterprise, and Very Large Enterprise.');
+        });
+      });
+
+      it('Request an invalid company industry', () => {
+        cy.request({
+          method: 'GET',
+          url: `${CUSTOMERS_API_URL}?industry=Cicero`,
+          failOnStatusCode: false
+        }).then(({ status, body }) => {
+          expect(status).to.equal(400);
+          expect(body).to.have.property('error', 'Unsupported industry value. Supported values are All, Logistics, Retail, Technology, HR, and Finance.');
+        });
+      });
+    });
+  });
+});