Referencia de Allure Jasmine

Estas son las funciones que puedes utilizar para integrar tus pruebas de Jasmine con Allure.

En la mayoría de los casos, Allure Jasmine ofrece dos formas diferentes de usar una función: la API en tiempo de ejecución y la API de metadatos.

API en tiempo de ejecución: utiliza las funciones de Allure para agregar ciertos datos al resultado de la prueba durante su ejecución. Este enfoque permite construir los datos de manera dinámica.
Ten en cuenta que se recomienda llamar a las funciones de Allure lo más cerca posible al comienzo de la prueba. De esta manera, los datos se agregarán incluso si la prueba falla temprano.
API de metadatos: agrega una etiqueta de metadatos (que comienza con @) al nombre de la prueba. Allure Jasmine la extraerá y actualizará los datos del resultado de la prueba en consecuencia. Al usar este enfoque, los datos se agregarán independientemente de cómo se ejecute la prueba.

Metadatos

Asigna la descripción, enlaces y otros metadatos de una prueba.

Description

allure.description(markdown: string): PromiseLike<void>

Establece la descripción de la prueba. Se permite el formato Markdown. Cualquier formato HTML, si está presente, será eliminado por razones de seguridad.

import * as allure from "allure-js-commons";

describe("Test My Website", function () {
  it("Test Authentication", async () => {
    await allure.description("This test attempts to log into the website.");
    // ...
  });
});

Owner

allure.owner(name: string): PromiseLike<void>
@allure.label.owner:⟨VALUE⟩

Establece el propietario de la prueba.

Runtime APIMetadata API

import * as allure from "allure-js-commons";

describe("Test My Website", function () {
  it("Test Authentication", async () => {
    await allure.owner("John Doe");
    // ...
  });
});

describe("Test My Website", function () {
  it("Test Authentication @allure.label.owner:JohnDoe", async () => {
    // ...
  });
});

Tag

allure.tag(name: string): PromiseLike<void>
allure.tags(...tagsList: string[]): PromiseLike<void>
@allure.label.tag:⟨VALUE⟩

Establece los tags de la prueba.

Runtime APIMetadata API

import * as allure from "allure-js-commons";

describe("Test My Website", function () {
  it("Test Authentication", async () => {
    await allure.tag("New UI");
    await allure.tag("Essentials");
    await allure.tag("Authentication");
    // ...
  });
});

describe("Test My Website", function () {
  it(
    "Test Authentication" +
      " @allure.label.tag:NewUI" +
      " @allure.label.tag:Essentials" +
      " @allure.label.tag:Authentication",
    async () => {
      // ...
    },
  );
});

Severity

allure.severity(name: string): PromiseLike<void>
@allure.label.severity:⟨VALUE⟩

Establece la severidad de la prueba.

Los valores permitidos son: “trivial”, “minor”, “normal”, “critical”, y “blocker”.

Runtime APIMetadata API

import * as allure from "allure-js-commons";
import { Severity } from "allure-js-commons";

describe("Test My Website", function () {
  it("Test Authentication", async () => {
    await allure.severity(Severity.CRITICAL);
    // ...
  });
});

describe("Test My Website", function () {
  it("Test Authentication @allure.label.severity:critical", async () => {
    // ...
  });
});

Label

allure.label(name: LabelName | string, value: string): PromiseLike<void>
allure.labels(...labelsList: Label[]): PromiseLike<void>
@allure.label.⟨NAME⟩:⟨VALUE⟩

Establece una etiqueta arbitraria para la prueba. Esta es la implementación subyacente de muchas de las otras funciones de Allure.

Puedes llamar a label() varias veces para crear un arreglo de valores bajo el nombre dado.

Runtime APIMetadata API

import * as allure from "allure-js-commons";

describe("Test My Website", function () {
  it("Test Authentication", async () => {
    await allure.label("microservice", "UI");
    // ...
  });
});

describe("Test My Website", function () {
  it("Test Authentication @allure.label.microservice:UI", async () => {
    // ...
  });
});

ID

@allure.id:⟨VALUE⟩

Establece el ID de la prueba.

import * as allure from "allure-js-commons";

describe("Test My Website", function () {
  it("Test Authentication @allure.id:123", async () => {
    // ...
  });
});

Link

allure.link(url: string, name?: string, type?: LinkType | string): PromiseLike<void>
allure.links(...linksList: Link[]): PromiseLike<void>
allure.issue(url: string, name?: string): PromiseLike<void>
allure.tms(url: string, name?: string): PromiseLike<void>

Agrega un enlace relacionado con la prueba.

Según el tipo (que puede ser cualquier cadena, por defecto es “link”), Allure intentará cargar una plantilla de enlace correspondiente para procesar la URL, tal como se define en la opción de configuración links. Si no se encuentra una plantilla para el tipo dado o si el enlace ya representa una URL adecuada, se dejará sin modificar.

El nombre se usará como el texto del enlace. Si se omite, se usará la URL en su lugar.

Para mayor comodidad, Allure proporciona dos funciones abreviadas con tipos de enlace preseleccionados: issue y tms.

import * as allure from "allure-js-commons";

describe("Test My Website", function () {
  it("Test Authentication", async () => {
    await allure.issue("AUTH-123", "Related issue");
    await allure.tms("TMS-456", "Related TMS issue");
    await allure.link("JIRA-777", "Related Jira issue", "jira");
    await allure.link("https://example.com/", "Project website");
    // ...
  });
});

Jerarquía basada en el comportamiento

allure.epic(name: string): PromiseLike<void>
allure.feature(name: string): PromiseLike<void>
allure.story(name: string): PromiseLike<void>
@allure.label.epic:⟨VALUE⟩
@allure.label.feature:⟨VALUE⟩
@allure.label.story:⟨VALUE⟩

Asigna nombres de epics, características o historias de usuario para una prueba, como parte de la jerarquía basada en comportamiento de Allure.

import * as allure from "allure-js-commons";

describe("Test My Website", function () {
  it("Test Authentication", async () => {
    await allure.epic("Web interface");
    await allure.feature("Essential features");
    await allure.story("Authentication");
    // ...
  });
});

describe("Test My Website", function () {
  it(
    "Test Authentication" +
      " @allure.label.epic:WebInterface" +
      " @allure.label.feature:EssentialFeatures" +
      " @allure.label.story:Authentication",
    async () => {
      // ...
    },
  );
});

:::

Jerarquía basada en suites

allure.parentSuite(name: string): PromiseLike<void>
allure.suite(name: string): PromiseLike<void>
allure.subSuite(name: string): PromiseLike<void>
@allure.label.parentSuite:⟨VALUE⟩
@allure.label.suite:⟨VALUE⟩
@allure.label.subSuite:⟨VALUE⟩

Asigna los nombres de suite principal, suite o sub-suite para una prueba, como parte de la jerarquía basada en suites de Allure.

Runtime APIMetadata API

import * as allure from "allure-js-commons";

describe("Test My Website", function () {
  it("Test Authentication", async () => {
    await allure.parentSuite("Tests for web interface");
    await allure.suite("Tests for essential features");
    await allure.subSuite("Tests for authentication");
    // ...
  });
});

describe("Test My Website", function () {
  it(
    "Test Authentication" +
      " @allure.label.parentSuite:TestsForWebInterface" +
      " @allure.label.suite:TestsForEssentialFeatures" +
      " @allure.label.subSuite:TestsForAuthentication",
    async () => {
      // ...
    },
  );
});

Pasos de prueba

allure.step<T = void>(name: string, body: (context: StepContext) => T | PromiseLike<T>): PromiseLike<T>
allure.logStep(name: string, status?: Status, error?: Error): PromiseLike<void>

Define un paso de prueba con el nombre dado.

Existen dos formas de definir un paso.

Pasos Lambda
Escribe un paso de prueba en una función y pásalo a allure.step(). Si la función devuelve un valor, allure.step() lo devolverá sin modificaciones, y no afectará el informe. Si devuelve una promesa, se esperará y se resolverá.
La función puede aceptar sin argumentos o un solo objeto de tipo StepContext. Este objeto proporciona los siguientes métodos:
- displayName() — sobrescribir el nombre del paso durante su ejecución.
- parameter() — indicar parámetros arbitrarios utilizados para el paso. Las firmas disponibles de este método son similares a la implementación a nivel de prueba, consulta Pruebas parametrizadas.
Pasos No-op
Si llamas a allure.logStep(), Allure añadirá al informe un paso no-op. Esto permite un estilo de informe tipo log dentro de una prueba o dentro de un paso más grande. Un paso no-op termina inmediatamente después de comenzar y no puede tener sub-pasos ni parámetros.
El segundo argumento opcional indica el estado que se mostrará para el paso en el informe. Los valores permitidos son: Status.PASSED (el valor por defecto), Status.FAILED, Status.BROKEN y Status.SKIPPED.
El tercer argumento opcional es un objeto Error. Cuando se proporciona, los datos de este objeto se mostrarán en un mensaje dentro del paso.

import * as allure from "allure-js-commons";
import { Status } from "allure-js-commons";

describe("Test My Website", function () {
  it("Test Authentication", async () => {
    await allure.step("Step 1", async () => {
      await allure.step("Sub-step 1", async (ctx) => {
        await ctx.parameter("foo", "1");
        // ...
      });
      await allure.step("Sub-step 2", async (ctx) => {
        await ctx.parameter("foo", "2");
        // ...
      });
    });
    await allure.logStep("Step 2", Status.SKIPPED);
  });
});

Pruebas parametrizadas

allure.parameter(name: string, value: string, options?: ParameterOptions): PromiseLike<void>

Especifica un nombre y un valor de un parámetro que se utilizó durante esta prueba. Consulta Pruebas parametrizadas para más detalles.

El argumento options, si se proporciona, debe ser un objeto con dos propiedades opcionales: excluded y mode.

Si excluded está establecido en verdadero, Allure no utilizará el parámetro al comparar el resultado actual de la prueba con uno previo en el historial. Consulta Error común: los reintentos de una prueba se muestran como pruebas separadas.
El mode afecta la forma en que se mostrará el parámetro en el informe. Las opciones disponibles son:
- "default" (igual que no especificar ningún modo) — el parámetro y su valor se mostrarán en una tabla junto con otros parámetros.
- "masked" — el parámetro se mostrará en la tabla, pero su valor estará oculto. Usa este modo para contraseñas, tokens y otros parámetros sensibles.
- "hidden" — el parámetro y su valor no se mostrarán en el informe de la prueba.
Nota: incluso cuando uses el modo "masked" o "hidden", aún es posible extraer el valor del directorio allure_results si lo publicas.

import * as allure from "allure-js-commons";

describe("Test My Website", function () {
  for (const login of ["johndoe", "[email protected]"]) {
    it(`Test Authentication as ${login}`, async () => {
      allure.parameter("login", login);
      allure.parameter("time", new Date().toUTCString(), { excluded: true });
      // ...
    });
  }
});

Archivos adjuntos

allure.attachment(name: string, content: Buffer | string, options: ContentType | string | AttachmentOptions): PromiseLike<void>
allure.attachmentPath(name: string, path: string, options: ContentType | string | Omit<AttachmentOptions, "encoding">): PromiseLike<void>

Añade un archivo adjunto al resultado de la prueba bajo el nombre dado. Pasa ya sea el content o la path desde donde se leerán los datos.

El argumento options controla el tipo de medio del contenido y la extensión del nombre del archivo que se utilizará si un usuario descarga el archivo adjunto desde el informe de la prueba. Puedes especificar ambas opciones en un objeto (como se muestra para el archivo adjunto de imagen abajo) o solo especificar el tipo de medio y dejar que Allure deduzca automáticamente la extensión adecuada del nombre del archivo (como se muestra para el archivo adjunto de texto abajo). En cualquier caso, el tipo de medio puede ser un valor de la enumeración ContentType o cualquier cadena.

import * as allure from "allure-js-commons";
import { ContentType } from "allure-js-commons";

describe("Test My Website", function () {
  it("Test Authentication", async () => {
    // ...

    await allure.attachment("Text file", "This is the file content.", ContentType.TEXT);

    await allure.attachmentPath("Screenshot", "/path/to/image.png", {
      contentType: ContentType.PNG,
      fileExtension: "png",
    });
  });
});

Referencia de Allure Jasmine

Metadatos

Description

Owner

Tag

Severity

Label

ID

Link

Jerarquía basada en el comportamiento

Jerarquía basada en suites

Pasos de prueba

Pruebas parametrizadas

Archivos adjuntos

Powered by

Únete a nuestro boletín

Allure TestOps

Compañía

Referencia de Allure Jasmine ​

Metadatos ​

Description ​

Owner ​

Tag ​

Severity ​

Label ​

ID ​

Link ​

Jerarquía basada en el comportamiento ​

Jerarquía basada en suites ​

Pasos de prueba ​

Pruebas parametrizadas ​

Archivos adjuntos ​

Powered by

Únete a nuestro boletín

Allure TestOps

Compañía

Referencia de Allure Jasmine

Metadatos

Description

Owner

Tag

Severity

Label

ID

Link

Jerarquía basada en el comportamiento

Jerarquía basada en suites

Pasos de prueba

Pruebas parametrizadas

Archivos adjuntos