web-dev-qa-db-ja.com

jestを使用したfs関数のモック

まず、_es6_とjestは初めてです。

Loggerをインスタンス化するためのwinstonクラスがあり、それをテストしたいと思います。

ここに私のコード：

_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.existsSyncの状態をテストすることをお勧めします。 _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)
_

関数のデバッグとテストを手伝っていただけますか？

よろしく。

node.jsunit-testingjestjsfswinston
7
Oyabi

存在しない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();
});
_

注：CommonJSとes6モジュールの構文が混在しているようです（_export default_はes6）-どちらか一方に固執しようとします

16
Billy Reilly