1. module mochawesome
   1. function mochawesome (runner, options)

module mochawesome

function mochawesome (runner, options)

• description and source-code

  function Mochawesome(runner, options) {
    var _this = this;
  
    // Done function will be called before mocha exits
    // This is where we will save JSON and generate the report
    this.done = function (failures, exit) {
      return done(_this.output, _this.config, failures, exit);
    };
  
    // Reset total tests counter
    totalTestsRegistered.total = 0;
  
    // Create/Save necessary report dirs/files
    var 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
  
    var allTests = [];
    var allPending = [];
    var allFailures = [];
    var allPasses = [];
    var endCalled = false;
  
    // Add a unique identifier to each test
    runner.on('test', function (test) {
      return test.uuid = uuid.v4();
    });
  
    // Add test to array of all tests
    runner.on('test end', function (test) {
      return allTests.push(test);
    });
  
    // Add pending test to array of pending tests
    runner.on('pending', function (test) {
      test.uuid = uuid.v4();
      allPending.push(test);
    });
  
    // Add passing test to array of passing tests
    runner.on('pass', function (test) {
      return allPasses.push(test);
    });
  
    // Add failed test to array of failed tests
    runner.on('fail', function (test) {
      return allFailures.push(test);
    });
  
    // Process the full suite
    runner.on('end', function () {
      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;
  
          var allSuites = _this.runner.suite;
  
          traverseSuites(allSuites, totalTestsRegistered);
  
          var obj = {
            stats: _this.stats,
            suites: allSuites,
            allTests: allTests.map(cleanTest),
            allPending: allPending.map(cleanTest),
            allPasses: allPasses.map(cleanTest),
            allFailures: allFailures.map(cleanTest),
            copyrightYear: new Date().getFullYear()
          };
  
          obj.stats.testsRegistered = totalTestsRegistered.total;
  
          var _obj$stats = obj.stats,
              passes = _obj$stats.passes,
              failures = _obj$stats.failures,
              pending = _obj$stats.pending,
              tests = _obj$stats.tests,
              testsRegistered = _obj$stats.testsRegistered;
  
          var passPercentage = Math.round(passes / (testsRegistered - pending) * 1000) / 10;
          var pendingPercentage = Math.round(pending / testsRegistered * 1000) / 10;
  
          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 = testsRegistered - 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"
        /* istanbul ignore next */
        log('Problem with mochawesome: ' + e.stack, 'error');
      }
    });
  }

• example usage

  n/a