dredd/lib/configureReporters.js

HTTP API Testing Framework

const ApiaryReporter = require('./reporters/ApiaryReporter');
const BaseReporter = require('./reporters/BaseReporter');
const CLIReporter = require('./reporters/CLIReporter');
const DotReporter = require('./reporters/DotReporter');
const HTMLReporter = require('./reporters/HTMLReporter');
const MarkdownReporter = require('./reporters/MarkdownReporter');
const NyanCatReporter = require('./reporters/NyanReporter');
const XUnitReporter = require('./reporters/XUnitReporter');

const logger = require('./logger');

const fileReporters = [
  'xunit',
  'html',
  'markdown',
  'apiary',
];

const cliReporters = ['dot', 'nyan'];

function intersection(a, b) {
  if (a.length > b.length) { [a, b] = Array.from([b, a]); }
  return Array.from(a).filter(value => Array.from(b).includes(value));
}

function configureReporters(config, stats, tests, runner) {
  addReporter('base', config.emitter, stats, tests);

  const reporters = config.options.reporter;
  const outputs = config.options.output;

  logger.debug('Configuring reporters:', reporters, outputs);

  function addCli(reportersArr) {
    if (reportersArr.length > 0) {
      const usedCliReporters = intersection(reportersArr, cliReporters);
      if (usedCliReporters.length === 0) {
        return new CLIReporter(
          config.emitter, stats, tests, config.options['inline-errors'], config.options.details
        );
      }
      return addReporter(usedCliReporters[0], config.emitter, stats, tests);
    }
    return new CLIReporter(
      config.emitter, stats, tests, config.options['inline-errors'], config.options.details
    );
  }

  function addReporter(reporter, emitter, statistics, testsArg, path) {
    switch (reporter) {
      case 'xunit':
        return new XUnitReporter(emitter, statistics, testsArg, path, config.options.details);
      case 'dot':
        return new DotReporter(emitter, statistics, testsArg);
      case 'nyan':
        return new NyanCatReporter(emitter, statistics, testsArg);
      case 'html':
        return new HTMLReporter(emitter, statistics, testsArg, path, config.options.details);
      case 'markdown':
        return new MarkdownReporter(emitter, statistics, testsArg, path, config.options.details);
      case 'apiary':
        return new ApiaryReporter(emitter, statistics, testsArg, config, runner);
      default:
        // I don't even know where to begin...
        // TODO: DESIGN / REFACTOR WHOLE REPORTER(S) API FROM SCRATCH, THIS IS MADNESS!!1
        (new BaseReporter(emitter, stats, tests));
    }
  }

  addCli(reporters);

  const usedFileReporters = intersection(reporters, fileReporters);

  stats.fileBasedReporters = usedFileReporters.length;

  if (usedFileReporters.length > 0) {
    let usedFileReportersLength = usedFileReporters.length;
    if (reporters.indexOf('apiary') > -1) {
      usedFileReportersLength -= 1;
    }

    if (usedFileReportersLength > outputs.length) {
      logger.warn(`
There are more reporters requiring output paths than there are output paths
provided. Using default paths for additional file-based reporters.
`);
    }

    return usedFileReporters.map((usedFileReporter, index) => {
      const path = outputs[index] ? outputs[index] : undefined;
      return addReporter(usedFileReporter, config.emitter, stats, tests, path);
    });
  }
}

module.exports = configureReporters;