Jest: Кращий спосіб вимкнути консоль при модульних тестах

Цікаво, чи є кращий спосіб вимкнути консольні помилки в межах певного тесту Jest (тобто відновити початкову консоль до / після кожного тесту).

Ось мій поточний підхід:

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");
  });
});

Чи є більш чистий спосіб зробити те саме? Я хотів би уникати spyOn, але, mockRestoreздається, лише працюю з цим .

Дякую!

Для конкретного специфікаційного файлу файл Андреаса досить хороший. Нижче налаштування подавить console.logтвердження для всіх тестових наборів,

jest --silent

(або)

Для налаштування warn, info and debugви можете скористатися налаштуваннями нижче

__tests __ / setup.js або jest-preload.js, налаштовані вsetupFilesAfterEnv

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 Примітка: setupTestFrameworkScriptFile застарілий на користь setupFilesAfterEnv.

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

Оскільки кожен тестовий файл працює у власному потоці, немає необхідності його відновлювати, якщо ви хочете відключити його для всіх тестів в одному файлі. З тієї ж причини ви також можете просто писати

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

Якщо ви хочете зробити це лише для певного тесту:

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

Я виявив, що відповідь вище re: придушення console.logу всіх тестових наборах викликало помилки при виклику будь-яких інших consoleметодів (наприклад warn, error), оскільки воно замінювало весь глобальний consoleоб'єкт.

Цей дещо подібний підхід спрацював у мене з Jest 22+:

package.json

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

жарт / setup.js

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

За допомогою цього методу console.logзнущаються лише над іншими consoleметодами.

Для мене більш зрозумілим / чистим способом (читачеві потрібно мало знати API жарту, щоб зрозуміти, що відбувається), це просто зробити те, що робить mockRestore вручну:

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

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

Інший підхід - використання process.env.NODE_ENV. Таким чином можна вибірково вибрати, що показувати (чи ні) під час запуску тестів:

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');
}

або

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

Для цього потрібно буде розмістити цю конфігурацію на package.json:

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

Зауважте, що такий підхід не є прямим вирішенням вихідного питання, але дає очікуваний результат, якщо є можливість обгортати console.logце згаданою умовою.