带有开玩笑的模拟FS功能

Question

首先，我是es6和jest。

的新手

我有一个用于实例化winston的Logger类，我想对其进行测试。

在这里我的代码：

const winston = require('winston');
const fs = require('fs');
const path = require('path');
const config = require('../config.json');
class Logger {
  constructor() {
    Logger.createLogDir(Logger.logDir);
    this.logger = winston.createLogger({
      level: 'info',
      format: winston.format.json(),
      transports: [
        new (winston.transports.Console)({
          format: winston.format.combine(
            winston.format.colorize({ all: true }),
            winston.format.simple(),
          ),
        }),
        new (winston.transports.File)({
          filename: path.join(Logger.logDir, '/error.log'),
          level: 'error',
        }),
        new (winston.transports.File)({
          filename: path.join(Logger.logDir, '/info.log'),
          level: 'info',
        }),
        new (winston.transports.File)({
          filename: path.join(Logger.logDir, '/combined.log'),
        }),
      ],
    });
  }
  static get logDir() {
    return (config.logDir == null) ? 'log' : config.logDir;
  }
  static createLogDir(logDir) {
    if (!fs.existsSync(logDir)) {
      // Create the directory if it does not exist
      fs.mkdirSync(logDir);
    }
  }
}
exports.logger = new Logger().logger;
export default new Logger();

我想测试我的功能createLogDir()。我的头，我认为测试fs.existsync的状态是个好主意。如果fs.existsSync返回false，则必须调用fs.mkdirSync。因此，我尝试编写一些jest测试：

describe('logDir configuration', () => {
  test('default path must be used', () => {
    const logger = require('./logger');
    jest.mock('fs');
    fs.existsSync = jest.fn();
    fs.existsSync.mockReturnValue(false);
    const mkdirSync = jest.spyOn(logger, 'fs.mkdirSync');
    expect(mkdirSync).toHaveBeenCalled();
  });
});

但是，我有一个错误：

  ● logDir configuration › default path must be used
    Cannot spy the fs.mkdirSync property because it is not a function; undefined given instead
      18 |     fs.existsSync = jest.fn();
      19 |     fs.existsSync.mockReturnValue(true);
    > 20 |     const mkdirSync = jest.spyOn(logger, 'fs.mkdirSync');
      21 |     expect(mkdirSync).toHaveBeenCalled();
      22 |   });
      23 | });
      at ModuleMockerClass.spyOn (node_modules/jest-mock/build/index.js:590:15)
      at Object.test (src/logger.test.js:20:28)

您能帮我调试和测试我的功能吗？

问候。

Answer 1

发生错误是因为它在您的logger对象上寻找一种称为fs.mkdirSync的方法，该方法不存在。如果您可以在测试中访问fs模块，那么您将在此类似的mkdirSync方法上进行监视：

jest.spyOn(fs, 'mkdirSync');

但是，我认为您需要采取不同的方法。

您的createLogDir函数是一种静态方法 - 意味着它只能在类上调用，而不是在该类的实例上调用(new Logger()是类Logger的实例(。因此，为了测试该功能，您需要导出类，而不是其实例，即：

module.exports = Logger;

然后您可以进行以下测试：

const Logger = require('./logger');
const fs = require('fs');
jest.mock('fs') // this auto mocks all methods on fs - so you can treat fs.existsSync and fs.mkdirSync like you would jest.fn()
it('should create a new log directory if one doesn't already exist', () => {
    // set up existsSync to meet the `if` condition
    fs.existsSync.mockReturnValue(false);
    // call the function that you want to test
    Logger.createLogDir('test-path');
    // make your assertion
    expect(fs.mkdirSync).toHaveBeenCalled();
});
it('should NOT create a new log directory if one already exists', () => {
    // set up existsSync to FAIL the `if` condition
    fs.existsSync.mockReturnValue(true);
    Logger.createLogDir('test-path');
    expect(fs.mkdirSync).not.toHaveBeenCalled();
});

注意：看起来您正在混合CONCORJS和ES6模块语法(export default是ES6( - 我会尝试坚持一个或另一个

Answer 2

我认为您可以使用

来解决此问题

import * as fs from 'fs'

然后

jest.doMock('fs', () => fs) 

这应该解决您的问题。