Configuración de Allure CodeceptJS

El comportamiento del adaptador Allure CodeceptJS puede verse afectado por algunas opciones de configuración establecidas en tu archivo de configuración de CodeceptJS, por ejemplo, codecept.conf.js. Por ejemplo:

const { setCommonPlugins } = require("@codeceptjs/configure");
const { Status } = require("allure-js-commons");
const os = require("node:os");

setCommonPlugins();

/** @type {CodeceptJS.MainConfig} */
exports.config = {
  tests: "tests/**/*.js",
  plugins: {
    allure: {
      enabled: true,
      require: "allure-codeceptjs",
      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,
      },
    },
  },
};

resultsDir

Ruta al directorio donde Allure CodeceptJS 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 se pueden usar para construir URLs 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") 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 usará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 — un nombre para la categoría.
• messageRegex — una expresión regular que el mensaje del resultado de la prueba debe cumplir.
• traceRegex — una expresión regular que el rastreo del resultado de la prueba debe cumplir.
• matchedStatuses — un array de estados que debe tener el resultado de la prueba.
• flaky — 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.