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ดูเหมือนจะใช้ได้กับมันเท่านั้น

ขอบคุณ!

สำหรับไฟล์ข้อมูลจำเพาะโดยเฉพาะ Andreas นั้นดีพอ การตั้งค่าด้านล่างนี้จะระงับ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",
  ...
}

jest / setup.js

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

ใช้วิธีนี้เท่านั้นconsole.logถูกล้อเลียนและconsoleวิธีอื่น ๆจะไม่ได้รับผลกระทบ

สำหรับฉันวิธีที่ชัดเจน / สะอาดมากขึ้น (ผู้อ่านต้องการความรู้เล็กน้อยเกี่ยวกับ jest 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กับเงื่อนไขที่กล่าวถึง