Saltar al contenido
Volver a Artículos Publicados
Cypress

Pon el log de comandos de Cypress en la salida de tu CI

Una ejecución headless con fallo te da un stack trace y un vídeo. cypress-terminal-report imprime los comandos y peticiones alrededor del fallo justo debajo del error.

Pon el log de comandos de Cypress en la salida de tu CI
Contenido 100% autoral: Todos los artículos, desafíos técnicos y código fueron escritos por Marcelo Costa sin el uso de IA en la redacción. La inteligencia artificial se utilizó exclusivamente para ayudar con la traducción a múltiples idiomas.

Imagina la escena: un test se pone en rojo en CI. Abres el log del job y te encuentras una línea de error, un stack trace apuntando a las tripas de Cypress y un vídeo que ahora te toca descargar y recorrer buscando el segundo exacto. El log de comandos que te habría dicho qué se rompió en cinco segundos vivía dentro del navegador, y el navegador ya no está.

cypress-terminal-report arregla eso. Captura el log de comandos en el navegador y lo imprime debajo del test que falla en el terminal de tu CI: cada comando cy, cada XHR con su código de estado y cada error de consola de la aplicación.

Dos líneas para conectarlo

Una mitad corre en el navegador. Añade esto en cypress/support/e2e.ts:

require('cypress-terminal-report/src/installLogsCollector')();

La otra mitad corre en Node, dentro de setupNodeEvents en cypress.config.ts:

import { defineConfig } from 'cypress';

export default defineConfig({
  e2e: {
    setupNodeEvents(on, config) {
      require('cypress-terminal-report/src/installLogsPrinter')(on, { compactLogs: 3 });
      return config;
    },
  },
});

Esa es toda la configuración. Por defecto solo imprime cuando falla un test (printLogsToConsole: 'onFail'), así que un pipeline en verde sigue igual de silencioso que antes.

Dos mitades: el recolector en el archivo de soporte captura comandos y peticiones en el navegador; la impresora en la configuración los imprime en el terminal cuando falla un test

¿Por qué compactLogs: 3?

Un test largo de UI dispara cientos de comandos. Imprimirlos todos convierte el log de CI en un muro de texto que nadie lee. Con compactLogs: 3 obtienes las tres líneas anteriores y posteriores a cada error, y todo lo demás se pliega en una sola línea [ ... 41 omitted logs ... ].

Test en verde      → no imprime nada extra
Test de UI en rojo → 3 líneas alrededor del error (el clic, la petición, el timeout)
Specs solo de API  → pasa {} en su lugar: los tests son cortos y las peticiones son la historia

Si tus specs solo de API corren desde su propio archivo de configuración, dale {} a la impresora en esa config y mantén compactLogs: 3 para la de UI.

Un test fallando en el terminal: la petición de guardado devolvió 500 dos líneas por encima del comando que dio timeout

Mira lo que te da esa salida. El get dio timeout esperando una confirmación, y dos líneas por encima la petición de guardado volvió con un 500. Eso es un error de servidor, no un selector inestable, y lo sabes en diez segundos sin abrir ningún vídeo.

Cómo compruebo que funciona

  1. Rompe una aserción a propósito (cambia un texto esperado por un disparate).
  2. Lanza el spec en headless: npx cypress run --spec cypress/e2e/orders.cy.ts.
  3. Debajo del test fallido, busca filas indentadas de cy:command marcadas con ✔, la rota marcada con ✘, y líneas cy:xhr con un Status: debajo.
  4. Lanza un spec que pase. No debería aparecer nada extra.

Si un test que falla no imprime nada adicional, el recolector no se cargó. Comprueba que el archivo de soporte al que apunta tu configuración realmente lo requiere. La impresora sola no tiene nada que imprimir, y esa me tocó aprenderla por las malas.

Una manía de Windows antes de que entres en pánico

En un terminal local en Windows puede que veas +, x y ~ en lugar de ✔, ✘ y ➟. El plugin recurre a símbolos ASCII en Windows salvo que detecte CI o un terminal xterm-256color. Mismos logs, iconos más sobrios. No pierdas diez minutos reinstalándolo.

Resumen: qué tienes que hacer

  • Instala cypress-terminal-report como dependencia de desarrollo.
  • Carga el recolector en cypress/support/e2e.ts.
  • Registra la impresora en setupNodeEvents con { compactLogs: 3 } para specs de UI y {} para specs cortos solo de API.
  • Rompe una aserción y lanza una ejecución headless una vez: los tests que fallan imprimen líneas cy:command y cy:xhr debajo del error; los que pasan siguen en silencio.

El vídeo sigue ahí para los casos raros. Casi todos los días, las pocas líneas por encima del error son todo lo que necesitas. ¡Felices pruebas!