All files mochawesome.js

99.32% Statements 146/147
93.65% Branches 59/63
100% Functions 23/23
99.3% Lines 141/142
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 3871x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x     1x                           6x 6x 6x 2x   6x                     18x 9x 9x 1x   8x                           18x 666x 225x                         35x 35x                 33x         33x 33x 33x   33x 33x 33x                         35x 35x 35x   35x 33x                 35x   6x       6x         36x 6x   30x 6x   24x   36x       35x                                 35x   35x                       18x   18x 18x 18x 18x 18x 18x   18x 12x     18x   18x 18x 18x 18x 18x 18x 18x 18x 18x 18x 18x 18x 18x 18x 18x 18x 18x 18x 18x   18x 9x     18x                                                                           9x 9x 9x 18x 9x   18x 9x 9x 9x     18x                           9x 3x 3x 3x 1x 1x   2x 2x 1x 1x   1x 1x               9x     9x 9x     9x     9x   9x 9x 9x 9x 9x     11x     12x     9x     9x     9x     9x 9x   9x     9x   9x   9x   9x                       9x   9x 9x   9x 9x 9x 9x 9x 9x 9x 9x 9x     9x               1x  
const fs = require('fs');
const mocha = require('mocha');
const mochaUtils = require('mocha/lib/utils');
const _ = require('lodash');
const uuid = require('node-uuid');
const chalk = require('chalk');
const hljs = require('highlight.js');
const stringify = require('json-stringify-safe');
const conf = require('./config');
const mkdirp = require('mkdirp');
const diff = require('diff');
 
// Configure options for highlight.js
hljs.configure({
  useBR: true,
  languages: [ 'javascript' ]
});
 
// Track the total number of tests registered
let totalTestsRegistered;
 
 
/**
 * HELPER FUNCTIONS
 */
 
function log(msg, level) {
  const logMethod = console[level] || console.log;
  let out = msg;
  if (typeof msg === 'object') {
    out = stringify(msg, null, 2);
  }
  logMethod(`[${chalk.gray('mochawesome')}] ${out}\n`);
}
 
/**
 * Return a classname based on percentage
 *
 * @param {Integer} pct
 * @api private
 */
 
function _getPercentClass(pct) {
  if (pct <= 50) {
    return 'danger';
  } else if (pct > 50 && pct < 80) {
    return 'warning';
  } else {
    return 'success';
  }
}
 
/**
 * Remove all properties from an object except
 * those that are in the propsToKeep array.
 *
 * @param {Object} obj
 * @param {Array} propsToKeep
 * @api private
 */
 
function removeAllPropsFromObjExcept(obj, propsToKeep) {
  _.forOwn(obj, (val, prop) => {
    if (propsToKeep.indexOf(prop) === -1) {
      delete obj[prop];
    }
  });
}
 
/**
 * Check that a / b have the same type.
 *
 * @param {Object} a
 * @param {Object} b
 * @return {boolean}
 */
function sameType(a, b) {
  const objToString = Object.prototype.toString;
  return objToString.call(a) === objToString.call(b);
}
 
/**
 * Strip the function definition from `str`,
 * and re-indent for pre whitespace.
 */
 
function cleanCode(str) {
  str = str
    .replace(/\r\n?|[\n\u2028\u2029]/g, '\n').replace(/^\uFEFF/, '')
    .replace(/^function *\(.*\) *{|\(.*\) *=> *{?/, '')
    .replace(/\s+\}$/, '');
 
  const spaces = str.match(/^\n?( *)/)[1].length;
  const tabs = str.match(/^\n?(\t*)/)[1].length;
  const re = new RegExp(`^\n?${tabs ? '\t' : ' '}{${tabs || spaces}}`, 'gm');
 
  str = str.replace(re, '');
  str = str.replace(/^\s+|\s+$/g, '');
  return str;
}
 
/**
 * Return a plain-object representation of `test`
 * free of cyclic properties etc.
 *
 * @param {Object} test
 * @return {Object}
 * @api private
 */
 
function cleanTest(test) {
  let code = test.fn ? test.fn.toString() : test.body;
  const err = test.err || {};
  const { actual, expected, showDiff } = err;
 
  if (code) {
    code = cleanCode(code);
    // code = hljs.fixMarkup(hljs.highlightAuto(code).value);
  }
 
  // if (stack) {
  //   err.stack = hljs.fixMarkup(hljs.highlightAuto(err.stack).value);
  // }
 
  // Create diff for the error
  if (showDiff !== false && sameType(actual, expected) && expected !== undefined) {
    /* istanbul ignore if */
    if (!(_.isString(actual) && _.isString(expected))) {
      err.actual = mochaUtils.stringify(actual);
      err.expected = mochaUtils.stringify(expected);
    }
    err.diff = diff
      .createPatch('string', err.actual, err.expected)
      .split('\n')
      .splice(4)
      .map(line => {
        if (line.match(/@@/)) {
          return null;
        }
        if (line.match(/\\ No newline/)) {
          return null;
        }
        return line;
      })
      .filter(line => typeof line !== 'undefined' && line !== null)
      .join('\n');
  }
 
  const cleaned = {
    title: test.title,
    fullTitle: test.fullTitle(),
    timedOut: test.timedOut,
    duration: test.duration || 0,
    state: test.state,
    speed: test.speed,
    pass: test.state === 'passed',
    fail: test.state === 'failed',
    pending: test.pending,
    code,
    err,
    isRoot: test.parent.root,
    uuid: test.uuid,
    parentUUID: test.parent.uuid
  };
 
  cleaned.skipped = (!cleaned.pass && !cleaned.fail && !cleaned.pending);
 
  return cleaned;
}
 
/**
 * Modify the suite object to add properties needed to render
 * the template and remove properties we do not need.
 *
 * @param {Object} suite
 * @api private
 */
 
function cleanSuite(suite) {
  suite.uuid = uuid.v4();
 
  const cleanTests = _.map(suite.tests, cleanTest);
  const passingTests = _.filter(cleanTests, { state: 'passed' });
  const failingTests = _.filter(cleanTests, { state: 'failed' });
  const pendingTests = _.filter(cleanTests, { pending: true });
  const skippedTests = _.filter(cleanTests, { skipped: true });
  let duration = 0;
 
  _.each(cleanTests, test => {
    duration += test.duration;
  });
 
  totalTestsRegistered += (suite.tests ? suite.tests.length : 0);
 
  suite.tests = cleanTests;
  suite.fullFile = suite.file || '';
  suite.file = suite.file ? suite.file.replace(process.cwd(), '') : '';
  suite.passes = passingTests;
  suite.failures = failingTests;
  suite.pending = pendingTests;
  suite.skipped = skippedTests;
  suite.hasTests = suite.tests.length > 0;
  suite.hasSuites = suite.suites.length > 0;
  suite.totalTests = suite.tests.length;
  suite.totalPasses = passingTests.length;
  suite.totalFailures = failingTests.length;
  suite.totalPending = pendingTests.length;
  suite.totalSkipped = skippedTests.length;
  suite.hasPasses = passingTests.length > 0;
  suite.hasFailures = failingTests.length > 0;
  suite.hasPending = pendingTests.length > 0;
  suite.hasSkipped = suite.skipped.length > 0;
  suite.duration = duration;
 
  if (suite.root) {
    suite.rootEmpty = suite.totalTests === 0;
  }
 
  removeAllPropsFromObjExcept(suite, [
    'title',
    'fullFile',
    'file',
    'tests',
    'suites',
    'passes',
    'failures',
    'pending',
    'skipped',
    'hasTests',
    'hasSuites',
    'totalTests',
    'totalPasses',
    'totalFailures',
    'totalPending',
    'totalSkipped',
    'hasPasses',
    'hasFailures',
    'hasPending',
    'hasSkipped',
    'root',
    'uuid',
    'duration',
    'rootEmpty',
    '_timeout'
  ]);
}
 
/**
 * Do a breadth-first search to find
 * and format all nested 'suite' objects.
 *
 * @param {Object} suite
 * @api private
 */
 
function traverseSuites(suite) {
  const queue = [];
  let next = suite;
  while (next) {
    if (next.root) {
      cleanSuite(next);
    }
    if (next.suites.length) {
      _.each(next.suites, (nextSuite, i) => {
        cleanSuite(nextSuite);
        queue.push(nextSuite);
      });
    }
    next = queue.shift();
  }
}
 
/**
 * Initialize a new reporter.
 *
 * @param {Runner} runner
 * @api public
 */
 
function Mochawesome(runner, options) {
  // Done function will be called before mocha exits
  // This is where we will save JSON and generate the report
  this.done = (failures, exit) => {
    log(options);
    mkdirp(this.config.reportDir, err => {
      if (err) {
        log(err, 'error');
        exit();
      } else {
        fs.writeFile(this.config.reportJsonFile, this.output, writeErr => {
          if (writeErr) {
            log(writeErr, 'error');
            exit();
          } else {
            log(`Report JSON saved to ${this.config.reportJsonFile}`);
            exit();
          }
        });
      }
    });
  };
 
  // Reset total tests counter
  totalTestsRegistered = 0;
 
  // Create/Save necessary report dirs/files
  const reporterOpts = (options && options.reporterOptions) || {};
  this.config = conf(reporterOpts);
 
  // Call the Base mocha reporter
  mocha.reporters.Base.call(this, runner);
 
  // Show the Spec Reporter in the console
  new mocha.reporters.Spec(runner); // eslint-disable-line
 
  const allTests = [];
  const allPending = [];
  const allFailures = [];
  const allPasses = [];
  let endCalled = false;
 
  // Add a unique identifier to each test
  runner.on('test', test => (test.uuid = uuid.v4()));
 
  // Add test to array of all tests
  runner.on('test end', test => allTests.push(test));
 
  // Add pending test to array of pending tests
  runner.on('pending', test => allPending.push(test));
 
  // Add passing test to array of passing tests
  runner.on('pass', test => allPasses.push(test));
 
  // Add failed test to array of failed tests
  runner.on('fail', test => allFailures.push(test));
 
  // Process the full suite
  runner.on('end', () => {
    try {
      /* istanbul ignore else */
      if (!endCalled) {
        // end gets called more than once for some reason
        // so we ensure the suite is processed only once
        endCalled = true;
 
        const allSuites = this.runner.suite;
 
        traverseSuites(allSuites);
 
        const obj = {
          reportTitle: this.config.reportTitle || process.cwd().split(this.config.splitChar).pop(),
          inlineAssets: this.config.inlineAssets,
          stats: this.stats,
          suites: allSuites,
          allTests: allTests.map(cleanTest),
          allPending,
          allPasses: allPasses.map(cleanTest),
          allFailures: allFailures.map(cleanTest),
          copyrightYear: new Date().getFullYear()
        };
 
        obj.stats.testsRegistered = totalTestsRegistered;
 
        const passPercentage = Math.round((obj.stats.passes / (obj.stats.testsRegistered - obj.stats.pending))*1000)/10;
        const pendingPercentage = Math.round((obj.stats.pending / obj.stats.testsRegistered)*1000)/10;
 
        obj.stats.passPercent = passPercentage;
        obj.stats.pendingPercent = pendingPercentage;
        obj.stats.other = (obj.stats.passes + obj.stats.failures + obj.stats.pending) - obj.stats.tests;
        obj.stats.hasOther = obj.stats.other > 0;
        obj.stats.skipped = obj.stats.testsRegistered - obj.stats.tests;
        obj.stats.hasSkipped = obj.stats.skipped > 0;
        obj.stats.failures -= obj.stats.other;
        obj.stats.passPercentClass = _getPercentClass(passPercentage);
        obj.stats.pendingPercentClass = _getPercentClass(pendingPercentage);
 
        // Save the final output to be used in the done function
        this.output = stringify(obj, null, 2);
      }
    } catch (e) { // required because thrown errors are not handled directly in the event emitter pattern and mocha does not have an "on error"
      console.error(`Problem with mochawesome: ${e.stack}`);
    }
  });
}
 
module.exports = Mochawesome;