Configuración de Allure Playwright

El comportamiento del adaptador Allure Playwright puede verse afectado por algunas opciones de configuración establecidas en el archivo playwright.config.ts de tu proyecto.

INFO

Esta sección describe los parámetros de configuración para Allure Playwright 3.0 y versiones posteriores. Para una versión más antigua, puedes consultar este readme.

Para establecer las opciones, define un objeto después de la cadena "allure-playwright" en la sección de configuración reporter. Por ejemplo:

import type { PlaywrightTestConfig } from "@playwright/test";
import { Status } from "allure-js-commons";
import * as os from "node:os";

const config: PlaywrightTestConfig = {
  reporter: [
    ["line"],
    [
      "allure-playwright",
      {
        resultsDir: "allure-results",
        detail: true,
        suiteTitle: true,
        links: {
          issue: {
            nameTemplate: "Issue #%s",
            urlTemplate: "https://issues.example.com/%s",
          },
          tms: {
            nameTemplate: "TMS #%s",
            urlTemplate: "https://tms.example.com/%s",
          },
          jira: {
            urlTemplate: (v) => `https://jira.example.com/browse/${v}`,
          },
        },
        categories: [
          {
            name: "foo",
            messageRegex: "bar",
            traceRegex: "baz",
            matchedStatuses: [Status.FAILED, Status.BROKEN],
          },
        ],
        environmentInfo: {
          os_platform: os.platform(),
          os_release: os.release(),
          os_version: os.version(),
          node_version: process.version,
        },
      },
    ],
  ],
};

export default config;

resultsDir

Ruta al directorio donde Allure Playwright guardará los resultados de las pruebas, consulta Cómo funciona. Si el directorio no existe, se creará. El valor predeterminado es allure-results.

detail

Si es verdadero (el valor predeterminado), Allure creará automáticamente pasos para:

• Llamadas a la API de Playwright, como browser.newPage(), page.goto().
• Ganchos de prueba de Playwright, como beforeEach().
• Aserciones realizadas con except.

suiteTitle

Si es verdadero (el valor predeterminado), agrega implícitamente cada prueba en una suite de pruebas nombrada según su nombre de archivo.

links

Un mapeo de plantillas que pueden usarse para construir URL completas a partir de identificadores cortos.

Para cada tipo de enlace (consulta allure.link()), puedes especificar lo siguiente:

• nameTemplate — una plantilla o función para generar el nombre del enlace cuando no se proporcione.
• urlTemplate — una plantilla o función para generar la dirección del enlace cuando no se proporcione.

Las plantillas pueden ser cadenas (con %s donde debe colocarse el identificador) o funciones (que aceptan el identificador y devuelven la URL).

Por ejemplo, con la configuración anterior, await allure.issue("123") generará un enlace con el nombre Issue #123 y la dirección https://issues.example.com/. Allure mostrará el enlace con el ícono apropiado para el tipo issue.

categories

Define categorías personalizadas que se usarán para distinguir los resultados de las pruebas por sus errores; consulta Categorías de defectos.

Esta configuración es un arreglo, donde cada elemento es un objeto que representa una categoría personalizada. Los objetos pueden tener las siguientes propiedades:

• name — el nombre de la categoría.
• messageRegex — una expresión regular con la que el mensaje del resultado de la prueba debe coincidir.
• traceRegex — una expresión regular con la que el rastreo del resultado de la prueba debe coincidir.
• matchedStatuses — un arreglo de estados que el resultado de la prueba debe coincidir.
• flaky — si el resultado de la prueba debe marcarse como flaky.

environmentInfo

Parejas clave-valor que se mostrarán en la página principal del informe, consulta Información del entorno.