如何在控制台中测试Winston记录器消息的内容

时间:2019-12-31 01:31:14

标签: javascript jest winston

我将Winston用作应用程序的记录器,并且尝试为记录器消息编写单元测试(使用Jest)。我正在特别尝试确保没有密码传递到我的日志中。

由于记录器将输出输出到stdout,因此我无法找到一种方法来访问winston.error函数的输出并在日志对象上运行断言。

我尝试了几种不同的方法来访问记录器的结果,并用谷歌搜索解决方案,但没有成功。这是我的最后一次迭代:

我的logger.js(将content参数传递给logger之前先对其进行清理):

export const error = (content) => {
  return winston.error(content);
};

和我的logger.spec.js:

const exampleLogs = { "email":"email", "password":"password" };

describe('Passwords are filtered out of Winston logger messages', () => {
  it('Should filter out password data from "error" level errors', () => {
    logger.error(exampleLogs);
    const result = jest.fn();
    expect(result).not.toHaveProperty('password');
  });
});

即使密码密钥就在此位置,测试仍通过。当我console.log(result)时,我得到了一个模拟构造器对象:

{ [Function: mockConstructor]
      _isMockFunction: true,
      getMockImplementation: [Function],
      mock: [Getter/Setter],
      mockClear: [Function],
      mockReset: [Function],
      mockRestore: [Function],
      mockReturnValueOnce: [Function],
      mockResolvedValueOnce: [Function],
      mockRejectedValueOnce: [Function],
      mockReturnValue: [Function],
      mockResolvedValue: [Function],
      mockRejectedValue: [Function],
      mockImplementationOnce: [Function],
      mockImplementation: [Function],
      mockReturnThis: [Function],
      mockName: [Function],
      getMockName: [Function] }

但是我希望看到我的exampleLogs对象……如何访问记录器发送给stdout的对象?任何帮助将不胜感激!

2 个答案:

答案 0 :(得分:0)

要模拟logger.error函数,必须先将jest.fn()属性赋予它,然后再用对象调用它。但是我想那不是您想要的,对吗?您不想更改记录器的行为,只想检查它的调用。如果真是这样,您想要一个间谍而不是一个模拟人。

但是还有另一种方法可以检查记录器的输出。考虑将文件传输添加到Winston配置(https://github.com/winstonjs/winston/blob/master/docs/transports.md)。然后读取文件,检查是否存在预期的输出,然后删除文件。

答案 1 :(得分:0)

Pedro 的解决方案很棒。但是,我使用 stream 作为传输将输出保存在内存中。然后,它更容易阅读,我不需要删除任何文件。

您可以在此处找到示例:https://github.com/winstonjs/winston/issues/809#issuecomment-598966499