Pruebas de IU

La prueba de IU personalizada es una característica opcional que le permite crear y ejecutar automáticamente pruebas de IU para sus aplicaciones.

Información general

AEM ofrece un conjunto integrado de Puertas de calidad de Cloud Manager para garantizar actualizaciones sin problemas en las aplicaciones personalizadas. En concreto, las puertas de pruebas de TI ya admiten la creación y automatización de pruebas personalizadas mediante las API de AEM.

Las pruebas de interfaz de usuario se empaquetan en una imagen Docker para permitir una amplia variedad de lenguajes y marcos de trabajo (como Cypress, Selenium, Java y Maven, y JavaScript). Además, se puede generar fácilmente un proyecto de pruebas de IU mediante el uso del arquetipo del proyecto de AEM.

El Adobe fomenta el uso de Cypress, ya que ofrece recarga en tiempo real y espera automática, lo que ayuda a ahorrar tiempo y mejora la productividad durante las pruebas. Cypress también proporciona una sintaxis sencilla e intuitiva, lo que facilita el aprendizaje y el uso, incluso para aquellos que son nuevos en las pruebas.

Las pruebas de la IU se ejecutan como parte de una puerta de calidad específica para cada canalización de Cloud Manager con una fase de Pruebas de IU personalizadas en canalizaciones de producción u opcionalmente canalizaciones que no sean de producción. Cualquier prueba de la interfaz de usuario, incluidas la regresión y las nuevas funcionalidades, permite detectar y notificar errores.

A diferencia de las pruebas funcionales personalizadas, que son pruebas HTTP escritas en Java, las pruebas de interfaz de usuario pueden ser una imagen de Docker con pruebas escritas en cualquier lenguaje, siempre y cuando sigan las convenciones definidas en la sección Generar pruebas de IU.

Introducción a las pruebas de IU

En esta sección se describen los pasos necesarios para configurar las pruebas de IU para la ejecución en Cloud Manager.

1. Decida el lenguaje de programación que desea utilizar.

   • Para Cypress, utilice el código de muestra del AEM Repositorio de ejemplos de prueba.

   • Para JavaScript y WDIO, utilice el código de muestra que se genera automáticamente en la carpeta ui.tests de su repositorio de Cloud Manager.

     NOTA

     Si el repositorio se creó antes de que Cloud Manager creara automáticamente carpetas ui.tests, también puede generar la última versión utilizando el Arquetipo de proyecto de AEM.

   • Para Java y WebDriver, utilice el código de muestra del Repositorio de ejemplos de pruebas de AEM.

   • Para otros lenguajes de programación, consulte la sección Generación de pruebas de IU en este documento para configurar el proyecto de prueba.

2. Asegúrese de que las pruebas de IU estén activadas según la sección Inclusión del cliente de este documento.

3. Desarrolle sus casos de prueba y ejecutar las pruebas localmente.

4. Confirme su código en el repositorio de Cloud Manager y ejecute una canalización de Cloud Manager.

Generar pruebas de interfaz de usuario

Un proyecto de Maven genera un contexto de generación de Docker. Este contexto de generación de Docker describe cómo crear una imagen de Docker que contenga las pruebas de IU, que Cloud Manager usa para generar una imagen de Docker que contenga las pruebas de IU reales.

En esta sección se describen los pasos necesarios para agregar un proyecto de pruebas de interfaz de usuario al repositorio.

Generar un contexto de generación de Docker

Para generar un contexto de generación de Docker, necesita un módulo de Maven que:

• Produzca un archivo que contenga un Dockerfile y todos los demás archivos necesarios para generar la imagen Docker con sus pruebas.
• Etiqueta el archivo con el clasificador ui-test-docker-context.

La forma más sencilla de hacerlo es configurar el Complemento de Maven Assembly para crear el archivo de contexto de generación de Docker y asignarle el clasificador adecuado.

Puede crear pruebas de interfaz de usuario con diferentes tecnologías y marcos de trabajo, pero en esta sección se da por hecho que el diseño del proyecto es similar al siguiente.

├── Dockerfile
├── assembly-ui-test-docker-context.xml
├── pom.xml
├── test-module
│   ├── package.json
│   ├── index.js
│   └── wdio.conf.js
└── wait-for-grid.sh

El archivo pom.xml se encarga de la generación de Maven. Agregue una ejecución al complemento de Maven Assembly similar a la siguiente.

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-assembly-plugin</artifactId>
    <configuration>
        <descriptors>
            <descriptor>${project.basedir}/assembly-ui-test-docker-context.xml</descriptor>
        </descriptors>
        <tarLongFileMode>gnu</tarLongFileMode>
    </configuration>
    <executions>
        <execution>
            <id>make-assembly</id>
            <phase>package</phase>
            <goals>
                <goal>single</goal>
            </goals>
        </execution>
    </executions>
</plugin>

Esta ejecución ordena al complemento de Maven Assembly que cree un archivo basado en las instrucciones contenidas en assembly-ui-test-docker-context.xml, se denomina descriptor de ensamblado en la jerga del complemento. El descriptor de ensamblado enumera todos los archivos que deben formar parte del archivo.

<assembly>
    <id>ui-test-docker-context</id>
    <includeBaseDirectory>false</includeBaseDirectory>
    <formats>
        <format>tar.gz</format>
    </formats>
    <fileSets>
        <fileSet>
            <directory>${basedir}</directory>
            <includes>
                <include>Dockerfile</include>
                <include>wait-for-grid.sh</include>
            </includes>
        </fileSet>
        <fileSet>
            <directory>${basedir}/test-module</directory>
            <excludes>
                <exclude>node/**</exclude>
                <exclude>node_modules/**</exclude>
                <exclude>reports/**</exclude>
            </excludes>
        </fileSet>
    </fileSets>
</assembly>

El descriptor de ensamblado indica al complemento que cree un archivo de tipo .tar.gz y asigna el clasificador ui-test-docker-context para él. Además, enumera los archivos que deben incluirse en el archivo, incluidos los siguientes.

• Un Dockerfile, obligatorio para crear la imagen Docker
• El script wait-for-grid.sh, cuyos propósitos se describen a continuación
• Las pruebas de interfaz de usuario reales, implementadas por un proyecto Node.js en la carpeta test-module

El descriptor de ensamblado también excluye algunos archivos que podrían generarse al ejecutar las pruebas de IU localmente. Esto garantiza un archivo más pequeño y generaciones más rápidas.

El archivo que contiene el contexto de generación de Docker se recoge automáticamente en Cloud Manager, que creará la imagen de Docker que contiene las pruebas durante sus canalizaciones de implementación. Al final, Cloud Manager ejecutará la imagen de Docker para ejecutar las pruebas de interfaz de usuario contra la aplicación.

La generación debe producir ningún o un archivo. Si no genera ningún archivo, el paso de prueba se aprobará de forma predeterminada. Si la generación produce más de un archivo, qué archivo se seleccione no es determinista.

Inclusión del cliente

Para que Cloud Manager cree y ejecute sus pruebas de interfaz de usuario, debe incluirse en esta función al agregar un archivo al repositorio.

• El nombre del archivo debe ser testing.properties.
• El contenido del archivo debe ser ui-tests.version=1.
• El archivo debe estar en el módulo secundario de Maven para pruebas de IU junto al archivo pom.xml del módulo secundario de pruebas de IU.
• El archivo debe estar en la raíz del archivo de generación tar.gz.

La generación de pruebas de interfaz de usuario y las ejecuciones se omitirán si este archivo no está presente.

Para incluir un archivo testing.properties en el artefacto de generación, agregue un enunciado include en el assembly-ui-test-docker-context.xml archivo.

[...]
<includes>
    <include>Dockerfile</include>
    <include>wait-for-grid.sh</include>
    <include>testing.properties</include> <!-- opt-in test module in Cloud Manager -->
</includes>
[...]

Si está utilizando las muestras proporcionadas por Adobe:

• Para la carpeta basada en JavaScript ui.tests generada a partir del Arquetipo de proyecto de AEM, puede ejecutar el siguiente comando y añadir la configuración necesaria.

  echo "ui-tests.version=1" > testing.properties
  
  if ! grep -q "testing.properties" "assembly-ui-test-docker-context.xml"; then
    awk -v line='                <include>testing.properties</include>' '/<include>wait-for-grid.sh<\/include>/ { printf "%s\n%s\n", $0, line; next }; 1' assembly-ui-test-docker-context.xml > assembly-ui-test-docker-context.xml.new && mv assembly-ui-test-docker-context.xml.new assembly-ui-test-docker-context.xml
  fi
  

• Las muestras de prueba de Cypress y Java Selenium proporcionadas por Adobe ya tienen el indicador de inclusión establecido.

Escribir pruebas de interfaz de usuario

En esta sección se describen las convenciones que debe seguir la imagen de Docker que contiene las pruebas de IU. La imagen Docker se crea a partir del contexto de generación de Docker descrito en la sección anterior.

Variables de entorno

Las siguientes variables de entorno se pasarán a la imagen de Docker en tiempo de ejecución, según el marco de trabajo.

Las muestras de prueba de Adobe proporcionan funciones de ayuda para acceder a los parámetros de configuración:

• Cypress: utilizar la función estándar Cypress.env('VARIABLE_NAME')
• JavaScript: consulte el módulo lib/config.js
• Java: consulte la clase Config

Generar informes de prueba

La imagen Docker debe generar informes de prueba en formato XML JUnit y guardarlos en la ruta especificada por la variable de entorno REPORTS_PATH. El formato JUnit XML es un formato ampliamente utilizado para informar sobre los resultados de las pruebas. Si la imagen Docker utiliza Java y Maven, los módulos de prueba estándar como el complemento de Maven Surefire y el complemento de Maven Failesafe pueden generar estos informes de forma predeterminada.

Si la imagen Docker está implementada con otros lenguajes de programación o ejecutores de prueba, compruebe la documentación de las herramientas seleccionadas para generar informes XML de JUnit.

Requisitos previos

• Las pruebas en Cloud Manager se ejecutarán con un usuario administrador técnico.

• La infraestructura contenerizada que se contempla para las pruebas funcionales está limitada por los siguientes límites:

Detalles específicos de Selenium

Esperando a que Selenium esté listo

Antes de que comiencen las pruebas, es responsabilidad de la imagen Docker asegurarse de que el servidor Selenium funcione. Esperar por el servicio de Selenium es un proceso de dos pasos.

1. Lea la URL del servicio de Selenium desde la SELENIUM_BASE_URL variable de entorno.
2. Encuesta a intervalos regulares al extremo de estado expuesto por la API de Selenium.

Una vez que el extremo de estado de Selenium dé una respuesta positiva, las pruebas podrán comenzar.

Las muestras de prueba de la IU de Adobe lo gestionan con el script wait-for-grid.sh, que se ejecuta al abrir Docker e inicia la ejecución de prueba real solo cuando la cuadrícula está lista.

Captura de pantallas y vídeos

La imagen Docker puede generar resultados de prueba adicionales (por ejemplo, capturas de pantalla o vídeos) y guardarlos en la ruta especificada por la variable de entorno REPORTS_PATH. Cualquier archivo que se encuentre debajo de REPORTS_PATH se incluirá en el archivo de resultados de la prueba.

Las muestras de prueba proporcionadas por Adobe de forma predeterminada crean capturas de pantalla para cualquier prueba fallida.

Puede utilizar las funciones de ayuda para crear capturas de pantalla a través de las pruebas.

• JavaScript: comando takeScreenshot
• Java: comandos

Si se crea un archivo de resultados durante la ejecución de una prueba de IU, puede descargarlo desde Cloud Manager mediante el botón Download Details, debajo del paso Pruebas de IU personalizadas.

Cargar archivos

Las pruebas a veces deben cargar archivos en la aplicación que se está probando. Para que la implementación de Selenium sea flexible con respecto a sus pruebas, no es posible cargar directamente un recurso a Selenium. En su lugar, la carga de un archivo requiere los siguientes pasos.

1. Cargue el archivo en la dirección URL especificada por la UPLOAD_URL variable de entorno.
   • La carga debe realizarse en una solicitud de POST con un formulario de varias partes.
   • El formulario de varias partes debe tener un único campo de archivo.
   • Esto equivale a curl -X POST ${UPLOAD_URL} -F "data=@file.txt".
   • Consulte la documentación y las bibliotecas del lenguaje de programación utilizado en la imagen Docker para saber cómo realizar una solicitud HTTP de este tipo.
   • Las muestras de prueba de Adobe proporcionan funciones de ayuda para la carga de archivos:
     • JavaScript: consulte el comando getFileHandleForUpload.
     • Java: consulte la clase FileHandler.
2. Si la carga se realiza correctamente, la solicitud devolverá una 200 OK respuesta del tipo text/plain.
   • El contenido de la respuesta es un controlador de archivo opaco.
   • Puede utilizar este identificador en lugar de una ruta de archivo en un elemento <input> para probar la carga de archivos en la aplicación.

Ejecución de pruebas de IU locales

Antes de activar pruebas de IU en una canalización de Cloud Manager, se recomienda ejecutar las pruebas de IU localmente en
el SDK de AEM as a Cloud Service
o en una instancia de AEM as a Cloud Service real.

Ejemplo Cypress Test

1. Abra un elemento shell y vaya a la carpeta ui.tests/test-module de su repositorio

2. Instalar Cypress y otros requisitos previos

   npm install
   

3. Establecer las variables de entorno necesarias para la ejecución de pruebas

   export AEM_AUTHOR_URL=https://author-<program-id>-<environment-id>.adobeaemcloud.com
   export AEM_AUTHOR_USERNAME=<user>
   export AEM_AUTHOR_PASSWORD=<password>
   export AEM_PUBLISH_URL=https://publish-<program-id>-<environment-id>.adobeaemcloud.com
   export AEM_PUBLISH_USERNAME=<user>
   export AEM_PUBLISH_PASSWORD=<password>
   export REPORTS_PATH=target/
   

4. Ejecute las pruebas con uno de los siguientes comandos

   npm test              # Using default Cypress browser
   npm run test-chrome   # Using Google Chrome browser
   npm run test-firefox  # Using Firefox browser
   

Ejemplo JavaScript WebdriverIO Test

1. Abra un elemento shell y vaya a la carpeta ui.tests de su repositorio

2. Ejecute el siguiente comando para iniciar las pruebas con Maven

   mvn verify -Pui-tests-local-execution \
    -DAEM_AUTHOR_URL=https://author-<program-id>-<environment-id>.adobeaemcloud.com \
    -DAEM_AUTHOR_USERNAME=<user> \
    -DAEM_AUTHOR_PASSWORD=<password> \
    -DAEM_PUBLISH_URL=https://publish-<program-id>-<environment-id>.adobeaemcloud.com \
    -DAEM_PUBLISH_USERNAME=<user> \
    -DAEM_PUBLISH_PASSWORD=<password>
   

Ejemplo Java Selenium WebDriver Test

1. Abra un elemento shell y vaya a la carpeta ui.tests/test-module de su repositorio

2. Ejecute los siguientes comandos para iniciar las pruebas con Maven

   # Start selenium docker image (for x64 CPUs)
   docker run --platform linux/amd64 -d -p 4444:4444 selenium/standalone-chrome-debug:latest
   
   # Start selenium docker image (for ARM CPUs)
   docker run -d -p 4444:4444 seleniarm/standalone-chromium
   
   # Run the tests using the previously started Selenium instance
   mvn verify -Pui-tests-local-execution -DSELENIUM_BASE_URL=http://<server>:4444
   

Recursos de Business.Adobe.com