Broma: mejor manera de deshabilitar la consola dentro de las pruebas unitarias

Me pregunto si hay una mejor manera de deshabilitar los errores de la consola dentro de una prueba Jest específica (es decir, restaurar la consola original antes / después de cada prueba).

Aquí está mi enfoque actual:

describe("Some description", () => {
  let consoleSpy;

  beforeEach(() => {
    if (typeof consoleSpy === "function") {
      consoleSpy.mockRestore();
    }
  });

  test("Some test that should not output errors to jest console", () => {
    expect.assertions(2);

    consoleSpy = jest.spyOn(console, "error").mockImplementation();

    // some function that uses console error
    expect(someFunction).toBe("X");
    expect(consoleSpy).toHaveBeenCalled();
  });

  test("Test that has console available", () => {
    // shows up during jest watch test, just as intended
    console.error("test");
  });
});

¿Existe una forma más limpia de lograr lo mismo? Me gustaría evitarlo spyOn, pero mockRestoresolo parece funcionar con él .

¡Gracias!

Para un archivo de especificaciones en particular, Andreas es suficientemente bueno. La siguiente configuración suprimirá las console.logdeclaraciones para todos los conjuntos de pruebas,

jest --silent

(o)

Para personalizar warn, info and debug, puede utilizar la siguiente configuración

__tests __ / setup.js o jest-preload.js configurados ensetupFilesAfterEnv

global.console = {
  log: jest.fn(), // console.log are ignored in tests

  // Keep native behaviour for other methods, use those to print out things in your own tests, not `console.log`
  error: console.error,
  warn: console.warn,
  info: console.info,
  debug: console.debug,
};

jest.config.js

module.exports = {
    verbose: true,
    setupTestFrameworkScriptFile: "<rootDir>/__tests__/setup.js",
};

Jest v24.x Nota: setupTestFrameworkScriptFile está en desuso en favor de setupFilesAfterEnv.

module.exports = {
    verbose: true,
    setupFilesAfterEnv: ["<rootDir>/__tests__/setup.js"],
};

Como cada archivo de prueba se ejecuta en su propio hilo, no es necesario restaurarlo si desea desactivarlo para todas las pruebas en un archivo. Por la misma razón, también puedes escribir

console.log = jest.fn()
expect(console.log).toHaveBeenCalled();

Si quieres hacerlo solo para una prueba específica:

beforeEach(() => {
  jest.spyOn(console, 'warn').mockImplementation(() => {});
});

Descubrí que la respuesta anterior re: suprimir console.logen todas las suites de prueba arrojaba errores cuando se llamaba a cualquier otro consolemétodo (por ejemplo warn, error) ya que reemplazaba todo el consoleobjeto global .

Este enfoque algo similar funcionó para mí con Jest 22+:

package.json

"jest": {
  "setupFiles": [...],
  "setupTestFrameworkScriptFile": "<rootDir>/jest/setup.js",
  ...
}

jest / setup.js

jest.spyOn(global.console, 'log').mockImplementation(() => jest.fn());

Con este método, solo console.logse burla y los demás consolemétodos no se ven afectados.

Para mí, una forma más clara / limpia (el lector necesita poco conocimiento de la API de broma para comprender lo que está sucediendo) es hacer manualmente lo que hace mockRestore:

// at start of test you want to suppress
const consoleLog = console.log;
console.log = jest.fn();

// at end of test
console.log = consoleLog;

Otro enfoque es utilizar process.env.NODE_ENV. De esta manera, uno puede elegir selectivamente qué mostrar (o no) mientras se realizan las pruebas:

if (process.env.NODE_ENV === 'development') {
  console.log('Show output only while in "development" mode');
} else if (process.env.NODE_ENV === 'test') {
  console.log('Show output only while in "test" mode');
}

o

const logDev = msg => {
  if (process.env.NODE_ENV === 'development') {
    console.log(msg);
  }
}
logDev('Show output only while in "development" mode');

Esto requerirá que esta configuración se coloque en package.json:

"jest": {
  "globals": {
    "NODE_ENV": "test"
  }
}

Tenga en cuenta que este enfoque no es una solución directa a la pregunta original, pero da el resultado esperado siempre que se tenga la posibilidad de ajustarlo console.logcon la condición mencionada.