Agregue pruebas de end-to-end Cypress a su aplicación Amplify

Puedes ejecutar pruebas end-to-end (E2E) en la fase de prueba de tu aplicación Amplify para detectar las regresiones antes de pasar el código a producción. La fase de pruebas se puede configurar en la especificación de compilación YAML. Actualmente, solo es posible ejecutar el marco de pruebas de Cypress durante una compilación.

Tutorial: Configure las pruebas con Cypress end-to-end

Cypress es un marco de pruebas JavaScript basado en el que puede ejecutar pruebas E2E en un navegador. Para ver un tutorial que demuestra cómo configurar las pruebas E2E, consulte la entrada del blog Ejecución de pruebas de end-to-end Cypress para una implementación completa de CI/CD con Amplify.

Agregue pruebas a su aplicación de Amplify existente

Puede añadir pruebas de Cypress a una aplicación existente actualizando la configuración de compilación de la aplicación en la consola de Amplify. El archivo YAML de especificación de compilación contiene un conjunto de comandos de compilación y ajustes relacionados que Amplify utiliza para ejecutar la compilación. Lleve a cabo el paso test para ejecutar cualquier comando de prueba en el momento de la compilación. En el caso de las pruebas E2E, Amplify Hosting ofrece una integración más profunda con Cypress que le permite generar un informe de interfaz de usuario para sus pruebas.

La siguiente lista describe la configuración de pruebas y su utilización.

preTest

Instala las dependencias necesarias para ejecutar las pruebas de Cypress. Amplify Hosting usa mochawesome para generar un informe con los resultados de las pruebas, y wait-on para configurar el servidor localhost durante la compilación.

prueba

Ejecuta los comandos de Cypress para realizar pruebas con mochawesome.

postTest

Se genera un informe de mochawesome a partir del JSON de salida. Tenga en cuenta que, si usa Yarn, debe ejecutar este comando en modo silencioso para generar el informe de mochawesome. Con Yarn puede usar el comando siguiente:

yarn run --silent mochawesome-merge cypress/report/mochawesome-report/mochawesome*.json > cypress/report/mochawesome.json
                  

artifacts>baseDirectory

Directorio desde el que se ejecutan las pruebas.

artefactos> configFilePath

Datos del informe de prueba generado.

artifacts>files

Los artefactos generados (capturas de pantalla y vídeos) están disponibles para descargar.

El siguiente extracto de ejemplo de un archivo amplify.yml de especificaciones de compilación muestra cómo agregar pruebas de Cypress a su aplicación.

test:
  phases:
    preTest:
      commands:
        - npm ci
        - npm install -g pm2
        - npm install -g wait-on
        - npm install mocha mochawesome mochawesome-merge mochawesome-report-generator
        - pm2 start npm -- start
        - wait-on http://localhost:3000
    test:
      commands:
        - 'npx cypress run --reporter mochawesome --reporter-options "reportDir=cypress/report/mochawesome-report,overwrite=false,html=false,json=true,timestamp=mmddyyyy_HHMMss"'
    postTest:
      commands:
        - npx mochawesome-merge cypress/report/mochawesome-report/mochawesome*.json > cypress/report/mochawesome.json
        - pm2 kill
  artifacts:
    baseDirectory: cypress
    configFilePath: '**/mochawesome.json'
    files:
      - '**/*.png'
      - '**/*.mp4'

Desactivar las pruebas

Una vez añadida la configuración de pruebas a los ajustes de compilación de amplify.yml, el paso test se ejecutará en cada compilación y ramificación. Si desea deshabilitar globalmente la ejecución de las pruebas o ejecutarlas solo en ramificaciones específicas, puede usar la variable de entorno USER_DISABLE_TESTS sin tener que modificar la configuración de compilación.

Para deshabilitar globalmente las pruebas en todas las ramificaciones, agregue la variable de entorno USER_DISABLE_TESTS con un valor de true para todas las ramificaciones. La siguiente captura de pantalla muestra la sección de Variables de entorno de la consola Amplify con las pruebas deshabilitadas en todas las ramificaciones.

Para deshabilitar las pruebas en una ramificación específica, añada la variable de entorno USER_DISABLE_TESTS con un valor de false para todas las ramificaciones y, a continuación, añada una anulación para cada ramificación que desee deshabilitar con un valor de true. En la siguiente captura de pantalla, las pruebas se desactivan en la ramificación principal y se activan en todas las demás ramificaciones.

Al deshabilitar las pruebas con esta variable, se omitirá por completo el paso de pruebas durante la compilación. Para volver a habilitar las pruebas, defina este valor como false o elimine la variable de entorno.