Merge pull request #2 from f2x-flypass/feature/abolanos_refactorizacion_mitte

Feature/abolanos refactorizacion mitte

Author: alberto-bolanos-quind

.github/workflows/main.yml

@@ -0,0 +1,90 @@
+# Workflow para ejecutar pruebas E2E de API con Cypress y generar reportes Allure
+name: E2E API Testing execution
+
+# Define cuándo se ejecuta este workflow
+on:
+  push:
+    branches:
+      - main          # Se ejecuta en push a la rama main
+      - feature/**    # Se ejecuta en push a cualquier rama que empiece con feature/
+  workflow_dispatch:
+# Permisos necesarios para el workflow
+permissions:
+  contents: write
+  pages: write
+  id-token: write
+
+jobs:
+  cypress-test-install:
+    runs-on: ubuntu-latest
+    steps:
+      # Paso 1: Descarga el código del repositorio
+      - name: Checkout
+        uses: actions/checkout@v4
+      
+      # Paso 2:Instala y configura la VPN FortiClient
+      # Necesario para acceder a recursos internos durante las pruebas
+      - name: Forticlient Installation        
+        run: |
+          sudo apt update && sudo apt install -y openconnect
+          echo "${{ secrets.VPN_PWD }}" | sudo openconnect -u ${{ secrets.VPN_USER }} --passwd-on-stdin --protocol=fortinet ${{ secrets.VPN_HOST }}:${{ secrets.VPN_PORT }} --servercert ${{ secrets.VPN_CERT }} &   
+  
+      # Paso 3: Ejecuta las pruebas de Cypress
+      - name: Cypress tests run
+        id: cypress-tests
+        continue-on-error: true
+        uses: cypress-io/github-action@v6
+        with:
+          working-directory: ./
+        env:
+            # Variables de entorno necesarias para las pruebas
+            DB_USER: ${{secrets.DB_USER }}
+            DB_PASSWORD: ${{secrets.DB_PASSWORD }}
+            DB_CONNECT_STRING: ${{secrets.DB_CONNECT_STRING }}
+            COGNITO_USERNAME: ${{secrets.COGNITO_USERNAME }}
+            COGNITO_PASSWORD: ${{secrets.COGNITO_PASSWORD }}
+            COGNITO_CLIENT_ID: ${{secrets.COGNITO_CLIENT_ID }}
+
+      # Paso 4: Genera el reporte HTML de Allure
+      # Se ejecuta siempre, incluso si las pruebas fallan
+      - name: Generate Allure Report
+        if: always()
+        run: npm run allure:report
+
+      # Paso 5: Sube el reporte HTML como artifact descargable
+      # Permite descargar el reporte desde la pestaña Actions de GitHub
+      - name: Upload Allure Report as Artifact
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: allure-report
+          path: allure-report/
+          retention-days: 30    # Mantiene el artifact por 30 días
+
+      # Paso 6: Sube los resultados raw de Allure como artifact
+      # Útil para regenerar reportes o análisis posterior
+      - name: Upload Allure Results
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: allure-results
+          path: allure-results/
+          retention-days: 30
+
+      # Paso 7: Despliega el reporte a GitHub Pages
+      # Publica el reporte en una URL pública accesible desde el navegador
+      # Nota: Requiere configuración inicial de GitHub Pages por un administrador
+      - name: Deploy Allure Report to GitHub Pages
+        if: always()
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./allure-report    # Directorio a publicar
+          publish_branch: gh-pages        # Rama donde se publica el contenido
+          keep_files: false               # Sobrescribe archivos anteriores
+
+      # Paso 8: Marca el job como fallido si las pruebas fallaron
+      # Esto asegura que el workflow muestre el estado correcto en GitHub
+      - name: Fail job if tests failed
+        if: steps.cypress-tests.outcome == 'failure'
+        run: exit 1

.gitignore

@@ -2,8 +2,16 @@
 *.env
 ## librerías del proyecto
 node_modules/
+/jsonlogs
+/reports
 ## archivos autogenerados
 .DS_Store
 cypress/videos
 cypress/screenshots
-cypress/reports
+cypress/reports
+cypress/downloads/
+cypress/sessions/
+## Allure reports
+allure-results/
+allure-report/
+screenshots

.idea/.gitignore

@@ -0,0 +1,44 @@
+## Documentación de pruebas automatizadas parqueadero Mite
+
+## Introducción
+En estas pruebas se está validando el correcto funcionamiento del parqueadero Mite. Se están creando diferentes escenarios como entradas, salidas con entrada, salidas sin entrada y salidas con cobro cero del parqueadero.
+
+
+## Escenarios de prueba
+###  Crear Entrada
+*  Validar la entrada exitosa de un vehículo a un parqueadero mite con el servicio de Flypass
+```
+Dado que un vehículo se encuentra en la talanquera
+Cuando desea ingresar a un parqueadero de mite
+Entonces el vehículo ingresa correctamente al parqueadero con el servicio de Flypass
+```
+
+* Validar la entrada no exitosa de un vehículo a un parqueadero MITE con el servicio de Flypass, cuando ya existe una entrada con datos exactamente iguales registrada en el sistema.
+```
+Dado que un vehículo se encuentra en la talanquera
+Cuando desea ingresar a un parqueadero de mite
+Entonces el vehículo no puede ingresar al parqueadero con el servicio de Flypass
+```
+
+### Salida sin entrada
+* Validar la salida exitosa de un vehículo de un parqueadero MITE con el servicio de Flypass sin haber registrado una entrada
+```
+Dado que un vehículo no realizó una entrada con el servicio de flypass a un parqueadero de mite
+Cuando desea realizar una salida de un parqueadero de mite con el servicio de Flypass
+Entonces el vehículo sale correctamente de parqueadero con el servicio de Flypass sin entrada
+```
+
+### Salida con entrada
+* Validar la salida exitosa de un vehículo que tuvo una entrada exitosa a un parqueadero MITE con el servicio de Flypass
+```
+Dado que un vehículo realizó un entrada exitosamente a un parqueadero de mite
+Cuando  desea realizar una salida de un parqueadero de mite
+Entonces el vehículo sale correctamente de parqueadero con el servicio de Flypass
+```
+### Salida con cobro cero
+* Validar la salida sin entrada de un vehículo con cobro igual a 0 de un parqueadero mite con el servicio de Flypass
+```
+Dado que un vehículo realizó una entrada con el servicio de flypass a un parqueadero de mite
+Cuando  desea realizar una salida de un parqueadero de mite y el cobro es 0
+Entonces el vehículo sale correctamente de parqueadero
+```

.idea/misc.xml

@@ -35,6 +35,11 @@ O alternativamente puedes usar el comando personalizado.
 ```
    Esto ejecutará las pruebas automáticamente y mostrará el resultado en la terminal.
 
+3. Para ejecutar las pruebas con Allure habilitado:
+```bash
+    npm npm run test:report
+```
+
 ## Cambio de Variables de Entorno
 
 El archivo `.env` contiene las variables de entorno necesarias para la conexión a la base de datos Oracle. Para cambiar estas variables, sigue estos pasos:
@@ -91,4 +96,5 @@ Queremos validar la obligatoriedad del cumplimiento de su esquema, donde id, y t
 
 Allí es donde entra en juego la validación que nos permite realizar la librería `ajv` respecto al tipo de datos y el cumplimiento del contrato (o esquema) de la respuesta obtenida.
 
-Puedes hacer uso de herramientas que nos permitan crear los esquemas de forma automática como por ejemplo: https://www.liquid-technologies.com/online-json-to-schema-converter
+Puedes hacer uso de herramientas que nos permitan crear los esquemas de forma automática como por ejemplo: https://www.liquid-technologies.com/online-json-to-schema-converter
+

.idea/modules.xml

@@ -2,7 +2,6 @@ const { defineConfig } = require("cypress");
 const oracledb = require("oracledb");
 //const mssql = require('mssql');
 require("dotenv").config();
-const { beforeRunHook, afterRunHook } = require('cypress-mochawesome-reporter/lib');
 const { getTemporaryCredentials } = require('./cypress/support/utils/AWSConnection.js');
 
 
@@ -15,19 +14,18 @@ const connection = {
 
 
 // Establece la función para realizar consultas a la base de datos Oracle
-function queryDB(query) {
+function queryDB(query, values = []) {
   return new Promise((resolve, reject) => {
     oracledb.getConnection(connection, (error, connection) => {
       if (error) {
         reject(error);
       } else {
-        connection.execute(query, (error, result) => {
+        connection.execute(query, values, (error, result) => { 
           connection.close(() => {
             if (error) {
               reject(error);
             } else {
               if (result.rows) {
-                // Procesa el resultado para devolverlo como clave-valor (para consultas SELECT)
                 const metaData = result.metaData || [];
                 const processedResult = result.rows.map((row) => {
                   const obj = {};
@@ -38,10 +36,7 @@ function queryDB(query) {
                 });
                 resolve(processedResult);
               } else {
-                // Devuelve información sobre la cantidad de filas afectadas (para UPDATE y DELETE)
-                resolve({
-                  rowsAffected: result.rowsAffected,
-                });
+                resolve({ rowsAffected: result.rowsAffected });
               }
             }
           });
@@ -51,28 +46,28 @@ function queryDB(query) {
   });
 }
 
-
-
 module.exports = defineConfig({
   // Ajusta el tiempo de espera predeterminado en milisegundos
   defaultCommandTimeout: 5000,
   pageLoadTimeout: 10000,
-  reporter: 'cypress-mochawesome-reporter',
-  reporterOptions: {
-    charts: true,
-    reportPageTitle: 'custom-title',
-    embeddedScreenshots: true,
-    inlineAssets: true,
-    saveAllAttempts: false,
-  },
   e2e: {
     // Al iniciar la prueba esta será la url base
-    baseUrl: "https://test.security.flypass.co/flypass",
+    baseUrl: "https://cert-providers.flypass.com.co/",
+    env:{
+      allure: true,
+      allureReuseAfterSpec: true,
+    },
     setupNodeEvents(on, config) {
-      require('cypress-mochawesome-reporter/plugin')(on);
+      const allureWriter = require('@shelex/cypress-allure-plugin/writer');
+      allureWriter(on, config)
+
+      config.env.COGNITO_USERNAME = process.env.COGNITO_USERNAME;
+      config.env.COGNITO_PASSWORD = process.env.COGNITO_PASSWORD;
+      config.env.COGNITO_CLIENT_ID = process.env.COGNITO_CLIENT_ID;
+
       on("task", {
-        queryDatabase({ query }) {
-          return queryDB(query);
+        queryDatabase({ query,values }) {
+          return queryDB(query, values);
         },
         async awsSetTemporaryCredentials() {
           const awsCredentials = {
@@ -84,14 +79,7 @@ module.exports = defineConfig({
           return credentials;
         }
       });
-      on('before:run', async (details) => {
-        console.log('override before:run');
-        await beforeRunHook(details);
-      });
-      on('after:run', async () => {
-        console.log('override after:run');
-        await afterRunHook();
-      });
+       return config;
     },
   },
 });