Jest: Cách tốt hơn để tắt bảng điều khiển bên trong các bài kiểm tra đơn vị

Tôi tự hỏi liệu có cách nào tốt hơn để vô hiệu hóa lỗi bảng điều khiển bên trong một bài kiểm tra Jest cụ thể (tức là, khôi phục bảng điều khiển ban đầu trước / sau mỗi lần kiểm tra) hay không.

Đây là cách tiếp cận hiện tại của tôi:

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

Có cách nào tốt hơn để hoàn thành điều tương tự không? Tôi muốn tránh spyOn, nhưng mockRestoredường như chỉ làm việc với nó .

Cảm ơn!

Đối với tệp thông số kỹ thuật cụ thể, của Andreas là đủ tốt. Thiết lập bên dưới sẽ loại bỏ các console.logcâu lệnh cho tất cả các bộ thử nghiệm,

jest --silent

(hoặc là)

Để tùy chỉnh, warn, info and debugbạn có thể sử dụng thiết lập bên dưới

__tests __ / setup.js hoặc jest-preload.js được định cấu hình trongsetupFilesAfterEnv

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 Lưu ý: setupTestFrameworkScriptFile không được dùng nữa thay vì setupFilesAfterEnv.

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

Vì mọi tệp kiểm tra chạy trong chuỗi riêng của nó nên không cần khôi phục nếu bạn muốn vô hiệu hóa nó cho tất cả kiểm tra trong một tệp. Vì lý do tương tự, bạn cũng có thể viết

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

Nếu bạn chỉ muốn làm điều đó cho một bài kiểm tra cụ thể:

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

Tôi phát hiện ra rằng câu trả lời ở trên lại: đàn áp console.logtrên tất cả các dãy phòng thử nghiệm ném lỗi khi bất kỳ khác consolephương pháp (ví dụ warn, error) được gọi là vì nó đã được thay thế toàn bộ toàn cầu consoleđối tượng.

Cách tiếp cận hơi tương tự này đã làm việc cho tôi với Jest 22+:

package.json

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

jest / setup.js

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

Sử dụng phương pháp này, chỉ console.logbị chế nhạo và các consolephương pháp khác không bị ảnh hưởng.

Đối với tôi, một cách rõ ràng / rõ ràng hơn (người đọc cần ít kiến ​​thức về API jest để hiểu điều gì đang xảy ra), là chỉ làm thủ công những gì mockRestore làm:

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

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

Một cách tiếp cận khác là sử dụng process.env.NODE_ENV. Bằng cách này, người ta có thể chọn những gì sẽ hiển thị (hoặc không) trong khi chạy thử nghiệm:

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

hoặc là

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

Điều này sẽ yêu cầu cấu hình này được đặt trên package.json:

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

Lưu ý rằng cách tiếp cận này không phải là giải pháp trực tiếp cho câu hỏi ban đầu, nhưng mang lại kết quả mong đợi miễn là người ta có khả năng kết hợp câu hỏi console.logvới điều kiện đã đề cập.