mocha 6.0.0-1 → 6.0.0

package/lib/reporters/nyan.js

@@ -7,7 +7,13 @@
  */
 
 var Base = require('./base');
+var constants = require('../runner').constants;
 var inherits = require('../utils').inherits;
+var EVENT_RUN_BEGIN = constants.EVENT_RUN_BEGIN;
+var EVENT_TEST_PENDING = constants.EVENT_TEST_PENDING;
+var EVENT_TEST_PASS = constants.EVENT_TEST_PASS;
+var EVENT_RUN_END = constants.EVENT_RUN_END;
+var EVENT_TEST_FAIL = constants.EVENT_TEST_FAIL;
 
 /**
  * Expose `Dot`.
@@ -40,24 +46,24 @@ function NyanCat(runner) {
   this.trajectories = [[], [], [], []];
   this.trajectoryWidthMax = width - nyanCatWidth;
 
-  runner.on('start', function() {
+  runner.on(EVENT_RUN_BEGIN, function() {
     Base.cursor.hide();
     self.draw();
   });
 
-  runner.on('pending', function() {
+  runner.on(EVENT_TEST_PENDING, function() {
     self.draw();
   });
 
-  runner.on('pass', function() {
+  runner.on(EVENT_TEST_PASS, function() {
     self.draw();
   });
 
-  runner.on('fail', function() {
+  runner.on(EVENT_TEST_FAIL, function() {
     self.draw();
   });
 
-  runner.once('end', function() {
+  runner.once(EVENT_RUN_END, function() {
     Base.cursor.show();
     for (var i = 0; i < self.numberOfLines; i++) {
       write('\n');

package/lib/reporters/progress.js

@@ -7,6 +7,10 @@
  */
 
 var Base = require('./base');
+var constants = require('../runner').constants;
+var EVENT_RUN_BEGIN = constants.EVENT_RUN_BEGIN;
+var EVENT_TEST_END = constants.EVENT_TEST_END;
+var EVENT_RUN_END = constants.EVENT_RUN_END;
 var inherits = require('../utils').inherits;
 var color = Base.color;
 var cursor = Base.cursor;
@@ -53,13 +57,13 @@ function Progress(runner, options) {
   options.verbose = reporterOptions.verbose || false;
 
   // tests started
-  runner.on('start', function() {
+  runner.on(EVENT_RUN_BEGIN, function() {
     console.log();
     cursor.hide();
   });
 
   // tests complete
-  runner.on('test end', function() {
+  runner.on(EVENT_TEST_END, function() {
     complete++;
 
     var percent = complete / total;
@@ -85,7 +89,7 @@ function Progress(runner, options) {
 
   // tests are complete, output some stats
   // and the failures if any
-  runner.once('end', function() {
+  runner.once(EVENT_RUN_END, function() {
     cursor.show();
     console.log();
     self.epilogue();

package/lib/reporters/spec.js

@@ -7,6 +7,14 @@
  */
 
 var Base = require('./base');
+var constants = require('../runner').constants;
+var EVENT_RUN_BEGIN = constants.EVENT_RUN_BEGIN;
+var EVENT_RUN_END = constants.EVENT_RUN_END;
+var EVENT_SUITE_BEGIN = constants.EVENT_SUITE_BEGIN;
+var EVENT_SUITE_END = constants.EVENT_SUITE_END;
+var EVENT_TEST_FAIL = constants.EVENT_TEST_FAIL;
+var EVENT_TEST_PASS = constants.EVENT_TEST_PASS;
+var EVENT_TEST_PENDING = constants.EVENT_TEST_PENDING;
 var inherits = require('../utils').inherits;
 var color = Base.color;
 
@@ -36,28 +44,28 @@ function Spec(runner) {
     return Array(indents).join('  ');
   }
 
-  runner.on('start', function() {
+  runner.on(EVENT_RUN_BEGIN, function() {
     console.log();
   });
 
-  runner.on('suite', function(suite) {
+  runner.on(EVENT_SUITE_BEGIN, function(suite) {
     ++indents;
     console.log(color('suite', '%s%s'), indent(), suite.title);
   });
 
-  runner.on('suite end', function() {
+  runner.on(EVENT_SUITE_END, function() {
     --indents;
     if (indents === 1) {
       console.log();
     }
   });
 
-  runner.on('pending', function(test) {
+  runner.on(EVENT_TEST_PENDING, function(test) {
     var fmt = indent() + color('pending', '  - %s');
     console.log(fmt, test.title);
   });
 
-  runner.on('pass', function(test) {
+  runner.on(EVENT_TEST_PASS, function(test) {
     var fmt;
     if (test.speed === 'fast') {
       fmt =
@@ -75,11 +83,11 @@ function Spec(runner) {
     }
   });
 
-  runner.on('fail', function(test) {
+  runner.on(EVENT_TEST_FAIL, function(test) {
     console.log(indent() + color('fail', '  %d) %s'), ++n, test.title);
   });
 
-  runner.once('end', self.epilogue.bind(self));
+  runner.once(EVENT_RUN_END, self.epilogue.bind(self));
 }
 
 /**

package/lib/reporters/tap.js

@@ -8,6 +8,13 @@
 
 var util = require('util');
 var Base = require('./base');
+var constants = require('../runner').constants;
+var EVENT_TEST_PASS = constants.EVENT_TEST_PASS;
+var EVENT_TEST_FAIL = constants.EVENT_TEST_FAIL;
+var EVENT_RUN_BEGIN = constants.EVENT_RUN_BEGIN;
+var EVENT_RUN_END = constants.EVENT_RUN_END;
+var EVENT_TEST_PENDING = constants.EVENT_TEST_PENDING;
+var EVENT_TEST_END = constants.EVENT_TEST_END;
 var inherits = require('../utils').inherits;
 var sprintf = util.format;
 
@@ -42,29 +49,29 @@ function TAP(runner, options) {
 
   this._producer = createProducer(tapVersion);
 
-  runner.once('start', function() {
+  runner.once(EVENT_RUN_BEGIN, function() {
     var ntests = runner.grepTotal(runner.suite);
     self._producer.writeVersion();
     self._producer.writePlan(ntests);
   });
 
-  runner.on('test end', function() {
+  runner.on(EVENT_TEST_END, function() {
     ++n;
   });
 
-  runner.on('pending', function(test) {
+  runner.on(EVENT_TEST_PENDING, function(test) {
     self._producer.writePending(n, test);
   });
 
-  runner.on('pass', function(test) {
+  runner.on(EVENT_TEST_PASS, function(test) {
     self._producer.writePass(n, test);
   });
 
-  runner.on('fail', function(test, err) {
+  runner.on(EVENT_TEST_FAIL, function(test, err) {
     self._producer.writeFail(n, test, err);
   });
 
-  runner.once('end', function() {
+  runner.once(EVENT_RUN_END, function() {
     self._producer.writeEpilogue(runner.stats);
   });
 }

package/lib/reporters/xunit.js

@@ -8,13 +8,20 @@
 
 var Base = require('./base');
 var utils = require('../utils');
-var inherits = utils.inherits;
 var fs = require('fs');
-var escape = utils.escape;
 var mkdirp = require('mkdirp');
 var path = require('path');
 var errors = require('../errors');
-var createNotSupportedError = errors.createNotSupportedError;
+var createUnsupportedError = errors.createUnsupportedError;
+var constants = require('../runner').constants;
+var EVENT_TEST_PASS = constants.EVENT_TEST_PASS;
+var EVENT_TEST_FAIL = constants.EVENT_TEST_FAIL;
+var EVENT_RUN_END = constants.EVENT_RUN_END;
+var EVENT_TEST_PENDING = constants.EVENT_TEST_PENDING;
+var STATE_FAILED = require('../runnable').constants.STATE_FAILED;
+var inherits = utils.inherits;
+var escape = utils.escape;
+
 /**
  * Save timer references to avoid Sinon interfering (see GH-237).
  */
@@ -51,7 +58,7 @@ function XUnit(runner, options) {
   if (options && options.reporterOptions) {
     if (options.reporterOptions.output) {
       if (!fs.createWriteStream) {
-        throw createNotSupportedError('file output not supported in browser');
+        throw createUnsupportedError('file output not supported in browser');
       }
 
       mkdirp.sync(path.dirname(options.reporterOptions.output));
@@ -65,19 +72,19 @@ function XUnit(runner, options) {
   // fall back to the default suite name
   suiteName = suiteName || DEFAULT_SUITE_NAME;
 
-  runner.on('pending', function(test) {
+  runner.on(EVENT_TEST_PENDING, function(test) {
     tests.push(test);
   });
 
-  runner.on('pass', function(test) {
+  runner.on(EVENT_TEST_PASS, function(test) {
     tests.push(test);
   });
 
-  runner.on('fail', function(test) {
+  runner.on(EVENT_TEST_FAIL, function(test) {
     tests.push(test);
   });
 
-  runner.once('end', function() {
+  runner.once(EVENT_RUN_END, function() {
     self.write(
       tag(
         'testsuite',
@@ -152,7 +159,7 @@ XUnit.prototype.test = function(test) {
     time: test.duration / 1000 || 0
   };
 
-  if (test.state === 'failed') {
+  if (test.state === STATE_FAILED) {
     var err = test.err;
     var diff =
       Base.hideDiff || !err.actual || !err.expected

package/lib/runnable.js

@@ -1,9 +1,12 @@
 'use strict';
+
 var EventEmitter = require('events').EventEmitter;
 var Pending = require('./pending');
 var debug = require('debug')('mocha:runnable');
 var milliseconds = require('ms');
 var utils = require('./utils');
+var createInvalidExceptionError = require('./errors')
+  .createInvalidExceptionError;
 
 /**
  * Save timer references to avoid Sinon interfering (see GH-237).
@@ -16,10 +19,11 @@ var toString = Object.prototype.toString;
 module.exports = Runnable;
 
 /**
- * Initialize a new `Runnable` with the given `title` and callback `fn`.  Derived from [EventEmitter](https://nodejs.org/api/events.html#events_class_eventemitter)
+ * Initialize a new `Runnable` with the given `title` and callback `fn`.
  *
  * @class
- * @extends EventEmitter
+ * @extends external:EventEmitter
+ * @public
  * @param {String} title
  * @param {Function} fn
  */
@@ -149,7 +153,7 @@ Runnable.prototype.isPending = function() {
  * @private
  */
 Runnable.prototype.isFailed = function() {
-  return !this.isPending() && this.state === 'failed';
+  return !this.isPending() && this.state === constants.STATE_FAILED;
 };
 
 /**
@@ -158,7 +162,7 @@ Runnable.prototype.isFailed = function() {
  * @private
  */
 Runnable.prototype.isPassed = function() {
-  return !this.isPending() && this.state === 'passed';
+  return !this.isPending() && this.state === constants.STATE_PASSED;
 };
 
 /**
@@ -353,7 +357,7 @@ Runnable.prototype.run = function(fn) {
       callFnAsync(this.fn);
     } catch (err) {
       emitted = true;
-      done(utils.getError(err));
+      done(Runnable.toValueOrError(err));
     }
     return;
   }
@@ -376,7 +380,7 @@ Runnable.prototype.run = function(fn) {
     }
   } catch (err) {
     emitted = true;
-    done(utils.getError(err));
+    done(Runnable.toValueOrError(err));
   }
 
   function callFn(fn) {
@@ -450,3 +454,43 @@ Runnable.prototype._timeoutError = function(ms) {
   }
   return new Error(msg);
 };
+
+var constants = utils.defineConstants(
+  /**
+   * {@link Runnable}-related constants.
+   * @public
+   * @memberof Runnable
+   * @readonly
+   * @static
+   * @alias constants
+   * @enum {string}
+   */
+  {
+    /**
+     * Value of `state` prop when a `Runnable` has failed
+     */
+    STATE_FAILED: 'failed',
+    /**
+     * Value of `state` prop when a `Runnable` has passed
+     */
+    STATE_PASSED: 'passed'
+  }
+);
+
+/**
+ * Given `value`, return identity if truthy, otherwise create an "invalid exception" error and return that.
+ * @param {*} [value] - Value to return, if present
+ * @returns {*|Error} `value`, otherwise an `Error`
+ * @private
+ */
+Runnable.toValueOrError = function(value) {
+  return (
+    value ||
+    createInvalidExceptionError(
+      'Runnable failed with falsy or undefined exception. Please throw an Error instead.',
+      value
+    )
+  );
+};
+
+Runnable.constants = constants;