Макет фс функция с шуткой - PullRequest
Новая
       44

Макет фс функция с шуткой

0 голосов
/ 27 апреля 2018

Прежде всего, я новичок в 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 return 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)

Можете ли вы помочь мне отладить и проверить мою функцию, пожалуйста?

Привет.

1 Ответ

0 голосов
/ 28 апреля 2018

Ошибка в том, что он ищет метод с именем fs.mkdirSync в вашем logger объекте, который не существует. Если у вас был доступ к модулю 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) - я бы попробовал придерживаться одного или другого

...