Configuración de Allure Jest

El comportamiento del adaptador de Allure Jest puede ajustarse mediante algunas opciones de configuración definidas en el archivo jest.config.js de tu proyecto.

Para configurar las opciones, define un objeto bajo la clave testEnvironmentOptions en config. Por ejemplo:

import { Status } from "allure-js-commons";
import os from "node:os";

export default {
  testEnvironment: "allure-jest/node",
  testEnvironmentOptions: {
    resultsDir: "allure-results",
    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,
    },
  },
};

WARNING

Esta sección describe las opciones de configuración para Allure Jest 3.0 y versiones posteriores. Para versiones anteriores, puedes consultar este readme.

resultsDir

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

links

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

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

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

Las plantillas pueden ser cadenas (con %s donde debería colocarse el identificador) o funciones (que acepten el identificador y devuelvan la URL).

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

categories

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

Esta configuración es un array, 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 que debe coincidir con el mensaje del resultado de la prueba.
• traceRegex — una expresión regular que debe coincidir con la traza del resultado de la prueba.
• matchedStatuses — un array de estados en los que el resultado de la prueba debe estar.
• flaky — indica si el resultado de la prueba debe marcarse como flaky.

environmentInfo

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