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

我想知道是否有更好的方法在特定的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

其他回答

由于每个测试文件都在自己的线程中运行，因此如果您想在一个文件中禁用所有测试，则不需要恢复它。出于同样的原因，你也可以只写

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

2017-06-12 06:53:10

因为笑话。我开玩笑地说:“间谍在这方面行不通(过去可能有用)。”fn使用Jest文档中指出的手动模拟恢复。这样，您就不会错过任何在特定测试中没有被经验忽略的日志。

const consoleError = console.error beforeEach(() => { 控制台。error = consoleError }) Test('错误'，()=> { 控制台。Error = jest.fn() Console.error ('error') //无法看到我 }) 测试('有错误和日志'，()=> { Console.error ('error') //现在可以 })

2021-05-08 14:53:03

另一种方法是使用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

beforeAll(() => {
    jest.spyOn(console, 'log').mockImplementation(() => {});
    jest.spyOn(console, 'error').mockImplementation(() => {});
    jest.spyOn(console, 'warn').mockImplementation(() => {});
    jest.spyOn(console, 'info').mockImplementation(() => {});
    jest.spyOn(console, 'debug').mockImplementation(() => {});
});

2021-03-19 08:34:05

奇怪的是，上面的答案(除了Raja的精彩答案，但我想分享其他失败的奇怪方式，以及如何清除mock，这样其他人就不会浪费我的时间)似乎成功地创建了mock，但没有抑制到控制台的日志记录。

Both

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

and

global console = {
   warn: jest.fn().mockImplementation(() => {});
}

成功安装模拟(我可以使用expect(console.warn). tobecalledtimes(1)并且它通过)，但它仍然输出警告，即使模拟实现似乎应该替换默认值(这是在jsdom环境中)。

最终，我找到了一个解决问题的黑客，并将以下内容放在配置中SetupFiles加载的文件中(注意，我发现有时是全局的。$不为我工作时，把jquery到全局上下文中，所以我只是设置我所有的全局在我的设置)。

const consoleWarn = jest.spyOn(console, 'warn').mockImplementation(() => {});
const consoleLog = jest.spyOn(console, 'log').mockImplementation(() => {});
const consoleDebug = jest.spyOn(console, 'debug').mockImplementation(() => {});
const consoleError = jest.spyOn(console, 'error').mockImplementation(() => {});


Object.defineProperty(global, 'console', {value: {
                                            warn: consoleWarn,
                                            log: consoleLog,
                                            debug: consoleDebug,
                                            error: consoleError}});

它感觉很难看，然后我不得不把如下代码放在每个测试文件中，因为beforeEach没有在SetupFiles引用的文件中定义(也许你可以把两者都放在SetupFilesAfterEnv中，但我没有尝试过)。

beforeEach(() => {
  console.warn.mockClear();
});

2021-06-22 16:51:31

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

推荐文章

最新文章

标签