Primeros pasos con Allure Axios

Captura solicitudes y respuestas HTTP de Axios como adjuntos en tus reportes de prueba de Allure Report.

Allure Axios es compatible con cualquier integración de Allure JS para frameworks, incluyendo Allure Vitest, Allure Jest, Allure Playwright, Allure Mocha y otros.

Para habilitar la integración en tu proyecto:

1. Asegúrate de tener una integración de Allure configurada para el framework de pruebas que utilizas.

   Consulta las instrucciones en la documentación de la integración en Frameworks.

2. Instala allure-axios.

   npm

   npm install --save-dev allure-axios

   yarn

   yarn add --dev allure-axios

   pnpm

   pnpm install --dev allure-axios

3. Para cada instancia de Axios utilizada en tus pruebas, llama a instrumentAxios() para comenzar a capturar solicitudes.

   instrumentAxios() instala interceptores en la instancia y devuelve una función de limpieza. Llama a la función de limpieza cuando ya no quieras capturar solicitudes — normalmente en afterEach o afterAll.

   El siguiente ejemplo muestra el uso en una suite de pruebas de Vitest.

   import { instrumentAxios } from "allure-axios";
   import axios, { type AxiosInstance } from "axios";
   import { afterEach, beforeEach, describe, expect, it } from "vitest";
   
   describe("Orders API", () => {
     let client: AxiosInstance;
     let restore: () => void;
   
     beforeEach(() => {
       client = axios.create({ baseURL: "https://api.example.com" });
       restore = instrumentAxios(client);
     });
   
     afterEach(() => {
       restore();
     });
   
     it("creates an order", async () => {
       const response = await client.post("/orders", { item: "book", qty: 1 });
       expect(response.status).toBe(201);
     });
   });

   Cada solicitud HTTP realizada a través de client se añadirá al resultado de prueba como un adjunto, envuelto en un paso con el mismo nombre. El adjunto captura todo el intercambio en un solo lugar: el método de la solicitud, URL, encabezados, parámetros de consulta, cookies y cuerpo; el estado de la respuesta, encabezados, cookies (incluyendo atributos como Path, Domain, Expires, Secure, HttpOnly y SameSite), y cuerpo; las marcas de tiempo de inicio y fin del intercambio; y, cuando la solicitud falla, el nombre y mensaje del error.

   INFO

   Para evitar que secretos se filtren en los reportes, ciertos valores se redactan por defecto — todas las cookies, cualquier encabezado o parámetro de consulta cuyo nombre sugiera que contiene una credencial, y cualquier campo de formulario codificado en URL cuyo nombre haga lo mismo. Consulta Configuración de Allure Axios para ver la lista completa de valores por defecto y cómo personalizar las reglas de redacción.

4. Ejecuta tus pruebas y genera un reporte de prueba como lo harías normalmente.