Как бы я написал тест для чего-то, что использует стандартный вывод?

Question

Я пытаюсь улучшить тестовое покрытие этого файла

'use strict'

/**
 * Returns the logging options we're using
 *
 * @param   {String} name Name of the logger. Should be service name. e.g. ciitizen-file-service
 * @returns {Object}      The logging options we're using
 * @private
 */
function getLoggerOptions(name) {
  return {
    name: name,
    streams: [
      {
        level: 'info',
        stream: stdOutStream()
      }, {
        level: 'error',
        stream: stdErrStream()
      }
      , {
        level: 'debug',
        stream: stdOutStream()
      },
      {
        level: 'warn',
        stream: stdOutStream()
      },
      {
        level: 'fatal',
        stream: stdErrStream()
      }
    ]
  }
}

/**
 * Creates a stream that writes to stdout
 *
 * @param   {Object} info The log info
 * @returns {Object}      An object which logs to stdout
 * @private
 */
function stdOutStream() {
  return {
    write: log => {
      // Change log level number to name and write it out
      log.level = bunyan.nameFromLevel[log.level]
      process.stdout.write(JSON.stringify(log) + '\n')
    }
  }
}

/**
 * Creates a stream that writes to stderr
 *
 * @param   {Object} info The log info
 * @returns {Object}      An object which logs to stderr
 * @private
 */
function stdErrStream() {
  return {
    write: log => {
      // Change log level number to name and write it out
      log.level = bunyan.nameFromLevel[log.level]
      process.stderr.write(JSON.stringify(log) + '\n')
    }
  }
}

module.exports = { getLoggerOptions }

У меня в настоящее время есть этот тест

'use strict'

const expect = require('chai').expect
const { getLoggerOptions } = require('../src/helpers')

describe.only('#getLoggerOptions', () => {
  it('should return the logger options', () => {
    expect(getLoggerOptions('test')).to.be.an('object')
  })
})

Что создает этот разрыв в охвате модульных испытаний

Как я могу написать тест, чтобы покрыть этот код?

Answer 1

Вы только утверждаете, что getLoggerOptions(...) должен вернуть объект, но вы не обращаетесь к объекту.

Например, помимо опубликованного теста, попробуйте добавить тест вроде:

describe.only('#probeLoggerOptions', () => {
  it('should do expected logging stuff', () => {
    const {name, streams} = getLoggerOptions('test');
    for (let stream of streams) {
      console.log(`getting logopt for level ${stream.level}`);
      expect(stream.stream.write(log), /* ... what to expect */);
    }
  });
});

Теперь тест вызывает write функция в каждом объекте.

ДОПОЛНИТЕЛЬНО: Если у вас есть код, лучший способ сделать его более тестируемым. Например, вместо того, чтобы писать на высоком уровне process потоки напрямую, вы можете создать WritableStream, напиши ей, потом трубу к нужному process поток.

function configureStream(writable = process.stdout, data = null, msg = 'done') {
  const stream = fs.createReadStream('/tmp/log');
  stream.read(data);
  stream.pipe(writable);

}

function stdOutStream() {
  return {
    write: log => {
      // Change log level number to name and write it out
      log.level = bunyan.nameFromLevel[log.level];
      configureStream(data = JSON.stringify(log) + '\n');
    }
  }
}

Помимо возможности проверить configureStream отдельно вы также можете абстрагировать содержание каждого процесса регистрации в одну функцию, которая сокращает тестовую поверхность. Теперь вы также можете подключиться к событиям потока, таким как "pipe" или "finish", чтобы проверить содержимое, которое регистрируется.