Pular para o conteúdo
Voltar aos Artigos Publicados
Cypress

Coloque o log de comandos do Cypress direto na saída do CI

Uma execução headless com falha te devolve um stack trace e um vídeo. O cypress-terminal-report imprime os comandos e requisições em volta da falha logo abaixo do erro.

Coloque o log de comandos do Cypress direto na saída do CI
Conteúdo 100% autoral: Todos os artigos, desafios práticos e soluções em código foram escritos por Marcelo Costa sem qualquer uso de IA na redação. A inteligência artificial foi utilizada exclusivamente no auxílio à tradução para múltiplos idiomas.

Imagina a cena: um teste fica vermelho no CI. Você abre o log do job e recebe uma linha de erro, um stack trace apontando para as entranhas do Cypress e um vídeo que agora você precisa baixar e ficar arrastando na linha do tempo. O log de comandos que teria te contado o que quebrou em cinco segundos vivia dentro do navegador, e o navegador já foi embora.

O cypress-terminal-report resolve isso. Ele captura o log de comandos no navegador e imprime tudo debaixo do teste que falhou no terminal do seu CI: cada comando cy, cada XHR com seu código de status, cada erro de console da aplicação.

Duas linhas para plugar

Metade roda no navegador. Adicione isto em cypress/support/e2e.ts:

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

A outra metade roda no Node, dentro de setupNodeEvents no 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;
    },
  },
});

A configuração inteira é só isso. Por padrão, ele só imprime para testes que falham (printLogsToConsole: 'onFail'), então um pipeline verde continua silencioso como antes.

Duas metades: o coletor no arquivo de suporte captura comandos e requisições no navegador; a impressora na config imprime tudo no terminal quando um teste falha

Por que compactLogs: 3?

Um teste longo de UI dispara centenas de comandos. Imprimir todos transforma o log do CI em um paredão de texto que ninguém lê. Com compactLogs: 3, você recebe as três linhas antes e depois de cada erro, e todo o resto vira uma única linha [ ... 41 omitted logs ... ].

Teste verde        → nada extra impresso
Teste de UI falho  → 3 linhas em volta do erro (o clique, a requisição, o timeout)
Specs só de API    → passe {} no lugar: os testes são curtos e as requisições são a história

Se as suas specs só de API rodam a partir de um arquivo de configuração próprio, passe {} para a impressora nessa config e mantenha compactLogs: 3 na de UI.

Um teste falhando no terminal: a requisição de salvar retornou 500 duas linhas acima do comando que deu timeout

Olha o que essa saída te entrega. O get deu timeout esperando uma confirmação, e duas linhas acima a requisição de salvar voltou com 500. Isso é erro de servidor, não seletor instável, e você descobre em dez segundos sem abrir vídeo nenhum.

Como eu confiro que está funcionando

  1. Quebre uma asserção de propósito (troque um texto esperado por qualquer coisa sem sentido).
  2. Rode a spec em headless: npx cypress run --spec cypress/e2e/orders.cy.ts.
  3. Abaixo do teste que falhou, procure linhas indentadas de cy:command marcadas com ✔, a quebrada marcada com ✘ e linhas cy:xhr com um Status: embaixo.
  4. Rode uma spec que passa. Nada extra deve aparecer.

Se um teste falhando não imprime nada a mais, o coletor não carregou. Confira se o arquivo de suporte para o qual a sua config aponta realmente faz o require dele. A impressora sozinha não tem nada para imprimir — e eu aprendi essa do jeito chato.

Um detalhe no Windows antes de você entrar em pânico

Em um terminal local no Windows, pode ser que você veja +, x e ~ em vez de ✔, ✘ e ➟. O plugin cai para símbolos ASCII no Windows a menos que detecte CI ou um terminal xterm-256color. Mesmos logs, ícones mais simples. Não perca dez minutos reinstalando tudo.

Resumo: o que você precisa fazer

  • Instale cypress-terminal-report como devDependency.
  • Carregue o coletor em cypress/support/e2e.ts.
  • Registre a impressora em setupNodeEvents com { compactLogs: 3 } para specs de UI e {} para specs curtas só de API.
  • Quebre uma asserção e rode em headless uma vez: testes com falha imprimem linhas cy:command e cy:xhr abaixo do erro; testes verdes continuam silenciosos.

O vídeo continua lá para os casos bizarros. Na maioria dos dias, as poucas linhas acima do erro são tudo de que você precisa. Bons testes!