是否有一个jest配置将导致console.warn上的测试失败？

Question

如何配置jest测试以使警告失败？

console.warn('stuff');
// fail test

Answer 1

您可以使用以下简单覆盖：

let error = console.error

console.error = function (message) {
  error.apply(console, arguments) // keep default behaviour
  throw (message instanceof Error ? message : new Error(message))
}

您可以使用Jest setupFiles使它在所有测试中都可用。

在package.json：

"jest": {
    "setupFiles": [
      "./tests/jest.overrides.js"
    ]
}

然后将代码段放入 jest.overrides.js

Answer 2

对于那些使用create-react-app，不想运行的人npm run eject，可以将以下代码添加到./src/setupTests.js：

global.console.warn = (message) => {
  throw message
}

global.console.error = (message) => {
  throw message
}

现在，当消息传递到console.warnor时，jest 将失败console.error。

create-react-app 文档 - 初始化测试环境

Answer 3

有一个有用的 npm 包可以帮助您实现这一目标：jest-fail-on-console

它很容易配置。

安装：

npm i -D jest-fail-on-console

配置：

在 Jest 的setupFilesAfterEnv选项中使用的文件中，添加以下代码：

import failOnConsole from 'jest-fail-on-console'

failOnConsole()

// or with options:
failOnConsole({ shouldFailOnWarn: false })

Answer 4

jest.spyOn我最近使用引入来v19.0.0模拟warn方法console（通过上下文/对象访问）来实现这一点global。

那么可以expect认为被嘲笑的对象warn没有被调用，如下所示。

describe('A function that does something', () => {
  it('Should not trigger a warning', () => {
    var warn = jest.spyOn(global.console, 'warn');

    // Do something that may trigger warning via `console.warn`
    doSomething();

    // ... i.e.
    console.warn('stuff');

    // Check that warn was not called (fail on warning)
    expect(warn).not.toHaveBeenCalled();

    // Cleanup
    warn.mockReset();
    warn.mockRestore();
  });
});