在单元测试中禁用控制台的更好方法

我想知道是否有更好的方法在特定的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似乎只与它一起工作。

当前回答

另一种方法是使用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，就会给出预期的结果。

2018-09-26 11:05:42

其他回答

如果你只是想做一个特定的测试:

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

2019-11-05 18:26:06

另一种方法是使用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，就会给出预期的结果。

2018-09-26 11:05:42

我发现上面的答案re:在所有测试套件中抑制console.log在调用任何其他控制台方法(例如warn, error)时抛出错误，因为它正在替换整个全局控制台对象。

这种有点类似的方法适用于我的Jest 22+:

package.json

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

是/设置.js

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

使用此方法，只有console.log被模拟，其他控制台方法不受影响。

2018-05-02 20:11:59

对我来说，一个更清晰/干净的方式(读者需要很少的笑话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;

2019-06-05 16:40:56

这里是你可能会用到的所有台词。你可以把它们放在测试中:

jest.spyOn(console, 'warn').mockImplementation(() => {});
console.warn("You won't see me!")
expect(console.warn).toHaveBeenCalled();
console.warn.mockRestore();

2022-04-16 20:11:24

在单元测试中禁用控制台的更好方法

推荐文章

最新文章

标签