Cómo funciona

Allure Report consta de un adaptador de marco de trabajo y la utilidad de línea de comandos allure. Después de una configuración inicial sencilla (descrita a continuación), crear un informe de pruebas para tu proyecto no lleva más de tres pasos.

1. Ejecuta tus pruebas como lo harías normalmente: desde la línea de comandos, desde tu IDE, etc.

   Además de imprimir o guardar los resultados de las pruebas en su propio formato (Resultados de prueba en la imagen anterior), el adaptador de Allure Report recibe los datos de un marco de pruebas. La API utilizada para esta comunicación depende del marco de trabajo; por ejemplo, el adaptador de Allure puede registrarse como un reportero de Playwright, un formateador de Cucumber.js, etc.

   El adaptador guarda los datos en formatos de archivo de Allure en un directorio separado (allure-results en la imagen anterior). La ruta del directorio puede cambiarse en la configuración del adaptador.

   Los archivos generados incluyen:

   • archivos de resultados de pruebas para describir la ejecución de las pruebas,
   • archivos de contenedores para describir las configuraciones de pruebas.

   TIP

   Puedes ejecutar este paso varias veces, acumulando datos en el mismo directorio de resultados. Esto es útil, por ejemplo, si diferentes pruebas requieren diferentes parámetros de ejecución o diferentes entornos. Como grupo, estas ejecuciones se denominan lanzamiento.

   Cuando un lanzamiento contiene múltiples ejecuciones de la misma prueba, se les llama reintentos.

2. Si es necesario, coloca archivos con datos adicionales para este lanzamiento en el directorio de resultados.

   Los archivos adicionales pueden incluir:

   • archivo de entorno para almacenar datos globales para todas las pruebas del informe,
   • archivo del ejecutor para describir el trabajo de CI y la URL donde se ubicará el informe,
   • archivos de historial para habilitar gráficos de tendencias y otras funciones relacionadas con el historial,
   • archivo de categorías para agrupar los resultados de las pruebas en categorías personalizadas.

   Omite este paso si no necesitas habilitar ninguna de estas funciones o si tu adaptador de Allure genera los archivos automáticamente. Consulta la documentación de tu adaptador.

3. Genera el informe HTML usando uno de los dos comandos de línea de comandos de Allure.

   • allure generate procesa los resultados de las pruebas y guarda un informe HTML en el directorio especificado (allure-report en la imagen anterior). Para ver el informe, utiliza el comando allure open.

     Usa este comando si necesitas guardar el informe para referencia futura o para compartirlo con colegas.

   • allure serve crea el mismo informe que allure generate pero lo coloca en un directorio temporal y comienza un servidor web local configurado para mostrar los contenidos de este directorio. Luego, el comando abre automáticamente la página principal del informe en un navegador web.

     Usa este comando si necesitas ver el informe por tu cuenta y no necesitas guardarlo.

4. Para compartir el informe, puedes utilizar los siguientes enfoques:

   • Puedes descargar y archivar tu informe, luego enviarlo mediante hosting de archivos, correo electrónico, Slack u otro método disponible.
   • Si has integrado el informe con una herramienta de CI, puedes compartir un enlace a la página de resultados del trabajo que incrusta el informe.
   • Puedes alojar el informe en un servidor web y compartir el enlace al mismo.
   • En los siguientes casos, recomendamos considerar Allure TestOps:
     • Si el informe necesita estar disponible 24/7 de forma centralizada y segura,
     • Si el informe debe ser proporcionado a miembros del equipo no técnicos o a la gerencia que no tienen acceso a la herramienta de CI,
     • Si el archivo es demasiado grande y difícil de enviar.

Configuración inicial

La configuración inicial depende del marco de pruebas que estés utilizando. En general, se requieren los siguientes pasos:

1. Instala el adaptador de Allure para tu marco de pruebas.

2. Instala la utilidad de línea de comandos de Allure, consulta Instalación.

   INFO

   Dependiendo del marco de trabajo que estés utilizando, el adaptador de Allure puede incluir la utilidad de línea de comandos de Allure. En tal caso, puedes omitir este paso.

3. En la configuración de tu proyecto, habilita el adaptador de Allure y configura sus parámetros.

Consulta la documentación específica del adaptador para más detalles.