macaca-reporter/lib/macaca-reporter.js

Reporter for mocha and other frameworks.

'use strict';

const mocha = require('mocha');

const render = require('./render');
const _ = require('./common/helper');
const outputJson = require('./output-json');
const renderCoverage = require('./coverage');
const CircularJson = require('macaca-circular-json');

const {
  Base,
  Spec,
} = mocha.reporters;

const {
  stringify,
  getSuite,
} = _;

const totalTests = {
  total: 0,
};

let extraData = {};

function done(output, options, config, failures, mochaExit) {
  try {
    const { reporterOptions = {} } = options;
    options.distDir = process.env.MACACA_REPORTER_DIR || options.distDir;

    render(output, options);
    outputJson(output, options);

    const exit = (code) => {
      process.on('exit', function onExit() {
        process.exit(Math.min(code, 255));
      });
    };

    const firstArg = process.argv[0];
    const otherArgs = process.argv.join('');
    const isDriveByTorch = firstArg.endsWith('electron') && otherArgs.includes('torchjs');
    // support torchjs exit
    if (isDriveByTorch) {
      if (reporterOptions.processAlwaysExitWithZero) {
        mochaExit(0);
      } else {
        mochaExit(failures ? 1 : 0);
      }
    } else {
      renderCoverage(() => {
        // exit finally
        if (reporterOptions.processAlwaysExitWithZero) {
          exit(0);
        } else {
          process.exit(failures ? 1 : 0);
        }
      });
    }
  } catch (e) {
    console.log(e);
  }
}

function MacacaReporter(runner, options) {

  const getSuiteData = (isEnd) => {
    let suite = '{}';
    try {
      suite = stringify(this._originSuiteData);
    } catch (e) {
      console.log('[json stringify error]:\n', e);
    }

    const result = getSuite(suite, totalTests);
    const obj = {
      stats: this.stats,
      suites: CircularJson.parse(result),
    };

    const {
      passes,
      failures,
      pending,
      tests,
    } = obj.stats;

    const passPercentage = Math.round((passes / (totalTests.total - pending)) * 1000) / 10;
    const pendingPercentage = Math.round((pending / totalTests.total) * 1000) / 10;

    if (!isEnd) {
      obj.stats.passPercent = passPercentage;
      obj.stats.pendingPercent = pendingPercentage;
      obj.stats.other = passes + failures + pending - tests;
      obj.stats.hasOther = obj.stats.other > 0;
      obj.stats.skipped = totalTests.total - tests;
      obj.stats.hasSkipped = obj.stats.skipped > 0;
      obj.stats.failures -= obj.stats.other;
    }
    return obj;
  };

  this.done = (failures, exit) => done(this.output, options, this.config, failures, exit);
  totalTests.total = 0;

  this.config = {
    reportFilename: 'report',
    saveJson: true,
  };
  Base.call(this, runner);

  new Spec(runner);

  const handleTestEnd = (isEnd) => {
    const obj = getSuiteData(isEnd);
    obj.stats.duration = (new Date(obj.stats.end).getTime() - new Date(obj.stats.start).getTime()) || 0;
    obj.stats.title = process.env.MACACA_REPORTER_XMIND_TITLE || 'Macaca Mind';
    obj.extraData = extraData;
    this.output = obj;

    if (typeof window !== 'undefined' &&
      window._macaca_reportor &&
      window._macaca_reportor._update) {
      window._macaca_reportor._update(encodeURI(stringify(obj)));
    }
  };

  runner.on('start', () => {
    this._originSuiteData = runner.suite;
  });

  runner.on('test end', test => {
    test.uuid = _.uuid();
    if (test.err) test.err = _.pick(test.err, [ 'name', 'stack', 'message' ]);
    handleTestEnd();
  });

  runner.on('end', () => {
    handleTestEnd(true);
  });

  runner.on('pending', test => {
    test.uuid = _.uuid();
  });
}

MacacaReporter.appendToContext = function(mocha, content) {
  try {
    const test = mocha.currentTest || mocha.test;
    if (!test.context) {
      test.context = [ content ];
    } else if (Array.isArray(test.context)) {
      test.context.push(content);
    } else {
      test.context = [ test.context ];
      test.context.push(content);
    }
  } catch (e) {
    console.log('error', e);
  }
};

MacacaReporter.appendExtraData = (data) => {
  extraData = {
    ...extraData,
    ...data,
  };
};

module.exports = MacacaReporter;