mocha 6.0.0-1 → 6.0.0

package/lib/interfaces/qunit.js

@@ -1,6 +1,8 @@
 'use strict';
 
 var Test = require('../test');
+var EVENT_FILE_PRE_REQUIRE = require('../suite').constants
+  .EVENT_FILE_PRE_REQUIRE;
 
 /**
  * QUnit-style interface:
@@ -30,7 +32,7 @@ var Test = require('../test');
 module.exports = function qUnitInterface(suite) {
   var suites = [suite];
 
-  suite.on('pre-require', function(context, file, mocha) {
+  suite.on(EVENT_FILE_PRE_REQUIRE, function(context, file, mocha) {
     var common = require('./common')(suites, context, mocha);
 
     context.before = common.before;

package/lib/interfaces/tdd.js

@@ -1,6 +1,8 @@
 'use strict';
 
 var Test = require('../test');
+var EVENT_FILE_PRE_REQUIRE = require('../suite').constants
+  .EVENT_FILE_PRE_REQUIRE;
 
 /**
  * TDD-style interface:
@@ -30,7 +32,7 @@ var Test = require('../test');
 module.exports = function(suite) {
   var suites = [suite];
 
-  suite.on('pre-require', function(context, file, mocha) {
+  suite.on(EVENT_FILE_PRE_REQUIRE, function(context, file, mocha) {
     var common = require('./common')(suites, context, mocha);
 
     context.setup = common.beforeEach;

package/lib/mocha.js

@@ -12,10 +12,15 @@ var builtinReporters = require('./reporters');
 var growl = require('./growl');
 var utils = require('./utils');
 var mocharc = require('./mocharc.json');
-var assign = require('object.assign').getPolyfill();
 var errors = require('./errors');
+var Suite = require('./suite');
+var createStatsCollector = require('./stats-collector');
 var createInvalidReporterError = errors.createInvalidReporterError;
 var createInvalidInterfaceError = errors.createInvalidInterfaceError;
+var EVENT_FILE_PRE_REQUIRE = Suite.constants.EVENT_FILE_PRE_REQUIRE;
+var EVENT_FILE_POST_REQUIRE = Suite.constants.EVENT_FILE_POST_REQUIRE;
+var EVENT_FILE_REQUIRE = Suite.constants.EVENT_FILE_REQUIRE;
+var sQuote = utils.sQuote;
 
 exports = module.exports = Mocha;
 
@@ -51,7 +56,7 @@ exports.Context = require('./context');
  * @memberof Mocha
  */
 exports.Runner = require('./runner');
-exports.Suite = require('./suite');
+exports.Suite = Suite;
 exports.Hook = require('./hook');
 exports.Test = require('./test');
 
@@ -88,11 +93,11 @@ exports.Test = require('./test');
  * @param {boolean} [options.useInlineDiffs] - Use inline diffs?
  */
 function Mocha(options) {
-  options = assign({}, mocharc, options || {});
+  options = utils.assign({}, mocharc, options || {});
   this.files = [];
   this.options = options;
   // root suite
-  this.suite = new exports.Suite('', new exports.Context());
+  this.suite = new exports.Suite('', new exports.Context(), true);
 
   if ('useColors' in options) {
     utils.deprecate(
@@ -223,31 +228,23 @@ Mocha.prototype.reporter = function(reporter, reporterOptions) {
           } catch (_err) {
             _err.code !== 'MODULE_NOT_FOUND' ||
             _err.message.indexOf('Cannot find module') !== -1
-              ? console.warn('"' + reporter + '" reporter not found')
+              ? console.warn(sQuote(reporter) + ' reporter not found')
               : console.warn(
-                  '"' +
-                    reporter +
-                    '" reporter blew up with error:\n' +
+                  sQuote(reporter) +
+                    ' reporter blew up with error:\n' +
                     err.stack
                 );
           }
         } else {
           console.warn(
-            '"' + reporter + '" reporter blew up with error:\n' + err.stack
+            sQuote(reporter) + ' reporter blew up with error:\n' + err.stack
           );
         }
       }
     }
-    if (!_reporter && reporter === 'teamcity') {
-      console.warn(
-        'The Teamcity reporter was moved to a package named ' +
-          'mocha-teamcity-reporter ' +
-          '(https://npmjs.org/package/mocha-teamcity-reporter).'
-      );
-    }
     if (!_reporter) {
       throw createInvalidReporterError(
-        'invalid reporter "' + reporter + '"',
+        'invalid reporter ' + sQuote(reporter),
         reporter
       );
     }
@@ -276,14 +273,14 @@ Mocha.prototype.ui = function(name) {
       this._ui = require(name);
     } catch (err) {
       throw createInvalidInterfaceError(
-        'invalid interface "' + name + '"',
+        'invalid interface ' + sQuote(name),
         name
       );
     }
   }
   this._ui = this._ui(this.suite);
 
-  this.suite.on('pre-require', function(context) {
+  this.suite.on(EVENT_FILE_PRE_REQUIRE, function(context) {
     exports.afterEach = context.afterEach || context.teardown;
     exports.after = context.after || context.suiteTeardown;
     exports.beforeEach = context.beforeEach || context.setup;
@@ -304,7 +301,6 @@ Mocha.prototype.ui = function(name) {
 };
 
 /**
- * @summary
  * Loads `files` prior to execution.
  *
  * @description
@@ -313,6 +309,8 @@ Mocha.prototype.ui = function(name) {
  *
  * @private
  * @see {@link Mocha#addFile}
+ * @see {@link Mocha#run}
+ * @see {@link Mocha#unloadFiles}
  * @param {Function} [fn] - Callback invoked upon completion.
  */
 Mocha.prototype.loadFiles = function(fn) {
@@ -320,13 +318,46 @@ Mocha.prototype.loadFiles = function(fn) {
   var suite = this.suite;
   this.files.forEach(function(file) {
     file = path.resolve(file);
-    suite.emit('pre-require', global, file, self);
-    suite.emit('require', require(file), file, self);
-    suite.emit('post-require', global, file, self);
+    suite.emit(EVENT_FILE_PRE_REQUIRE, global, file, self);
+    suite.emit(EVENT_FILE_REQUIRE, require(file), file, self);
+    suite.emit(EVENT_FILE_POST_REQUIRE, global, file, self);
   });
   fn && fn();
 };
 
+/**
+ * Removes a previously loaded file from Node's `require` cache.
+ *
+ * @private
+ * @static
+ * @see {@link Mocha#unloadFiles}
+ * @param {string} file - Pathname of file to be unloaded.
+ */
+Mocha.unloadFile = function(file) {
+  delete require.cache[require.resolve(file)];
+};
+
+/**
+ * Unloads `files` from Node's `require` cache.
+ *
+ * @description
+ * This allows files to be "freshly" reloaded, providing the ability
+ * to reuse a Mocha instance programmatically.
+ *
+ * <strong>Intended for consumers &mdash; not used internally</strong>
+ *
+ * @public
+ * @see {@link Mocha.unloadFile}
+ * @see {@link Mocha#loadFiles}
+ * @see {@link Mocha#run}
+ * @returns {Mocha} this
+ * @chainable
+ */
+Mocha.prototype.unloadFiles = function() {
+  this.files.forEach(Mocha.unloadFile);
+  return this;
+};
+
 /**
  * Sets `grep` filter after escaping RegExp special characters.
  *
@@ -512,7 +543,9 @@ Mocha.prototype._growl = growl.notify;
  * mocha.globals(['jQuery', 'MyLib']);
  */
 Mocha.prototype.globals = function(globals) {
-  this.options.globals = (this.options.globals || []).concat(globals);
+  this.options.globals = (this.options.globals || [])
+    .concat(globals)
+    .filter(Boolean);
   return this;
 };
 
@@ -744,8 +777,7 @@ Object.defineProperty(Mocha.prototype, 'version', {
  */
 
 /**
- * @summary
- * Runs tests and invokes `fn()` when complete.
+ * Runs root suite and invokes `fn()` when complete.
  *
  * @description
  * To run tests multiple times (or to run tests in files that are
@@ -754,6 +786,7 @@ Object.defineProperty(Mocha.prototype, 'version', {
  *
  * @public
  * @see {@link Mocha#loadFiles}
+ * @see {@link Mocha#unloadFiles}
  * @see {@link Runner#run}
  * @param {DoneCB} [fn] - Callback invoked when test execution completed.
  * @return {Runner} runner instance
@@ -766,6 +799,7 @@ Mocha.prototype.run = function(fn) {
   var options = this.options;
   options.files = this.files;
   var runner = new exports.Runner(suite, options.delay);
+  createStatsCollector(runner);
   var reporter = new this._reporter(runner, options);
   runner.ignoreLeaks = options.ignoreLeaks !== false;
   runner.fullStackTrace = options.fullStackTrace;
@@ -789,7 +823,7 @@ Mocha.prototype.run = function(fn) {
   exports.reporters.Base.hideDiff = options.hideDiff;
 
   function done(failures) {
-    fn = fn || function fn() {};
+    fn = fn || utils.noop;
     if (reporter.done) {
       reporter.done(failures, fn);
     } else {

package/lib/reporters/base.js

@@ -11,6 +11,9 @@ var diff = require('diff');
 var milliseconds = require('ms');
 var utils = require('../utils');
 var supportsColor = process.browser ? null : require('supports-color');
+var constants = require('../runner').constants;
+var EVENT_TEST_PASS = constants.EVENT_TEST_PASS;
+var EVENT_TEST_FAIL = constants.EVENT_TEST_FAIL;
 
 /**
  * Expose `Base`.
@@ -274,7 +277,7 @@ function Base(runner) {
   this.stats = runner.stats; // assigned so Reporters keep a closer reference
   this.runner = runner;
 
-  runner.on('pass', function(test) {
+  runner.on(EVENT_TEST_PASS, function(test) {
     if (test.duration > test.slow()) {
       test.speed = 'slow';
     } else if (test.duration > test.slow() / 2) {
@@ -284,7 +287,7 @@ function Base(runner) {
     }
   });
 
-  runner.on('fail', function(test, err) {
+  runner.on(EVENT_TEST_FAIL, function(test, err) {
     if (showDiff(err)) {
       stringifyDiffObjs(err);
     }

package/lib/reporters/doc.js

@@ -8,6 +8,11 @@
 
 var Base = require('./base');
 var utils = require('../utils');
+var constants = require('../runner').constants;
+var EVENT_TEST_PASS = constants.EVENT_TEST_PASS;
+var EVENT_TEST_FAIL = constants.EVENT_TEST_FAIL;
+var EVENT_SUITE_BEGIN = constants.EVENT_SUITE_BEGIN;
+var EVENT_SUITE_END = constants.EVENT_SUITE_END;
 
 /**
  * Expose `Doc`.
@@ -33,7 +38,7 @@ function Doc(runner) {
     return Array(indents).join('  ');
   }
 
-  runner.on('suite', function(suite) {
+  runner.on(EVENT_SUITE_BEGIN, function(suite) {
     if (suite.root) {
       return;
     }
@@ -44,7 +49,7 @@ function Doc(runner) {
     console.log('%s<dl>', indent());
   });
 
-  runner.on('suite end', function(suite) {
+  runner.on(EVENT_SUITE_END, function(suite) {
     if (suite.root) {
       return;
     }
@@ -54,13 +59,13 @@ function Doc(runner) {
     --indents;
   });
 
-  runner.on('pass', function(test) {
+  runner.on(EVENT_TEST_PASS, function(test) {
     console.log('%s  <dt>%s</dt>', indent(), utils.escape(test.title));
     var code = utils.escape(utils.clean(test.body));
     console.log('%s  <dd><pre><code>%s</code></pre></dd>', indent(), code);
   });
 
-  runner.on('fail', function(test, err) {
+  runner.on(EVENT_TEST_FAIL, function(test, err) {
     console.log(
       '%s  <dt class="error">%s</dt>',
       indent(),

package/lib/reporters/dot.js

@@ -8,6 +8,12 @@
 
 var Base = require('./base');
 var inherits = require('../utils').inherits;
+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_TEST_PENDING = constants.EVENT_TEST_PENDING;
+var EVENT_RUN_END = constants.EVENT_RUN_END;
 
 /**
  * Expose `Dot`.
@@ -31,18 +37,18 @@ function Dot(runner) {
   var width = (Base.window.width * 0.75) | 0;
   var n = -1;
 
-  runner.on('start', function() {
+  runner.on(EVENT_RUN_BEGIN, function() {
     process.stdout.write('\n');
   });
 
-  runner.on('pending', function() {
+  runner.on(EVENT_TEST_PENDING, function() {
     if (++n % width === 0) {
       process.stdout.write('\n  ');
     }
     process.stdout.write(Base.color('pending', Base.symbols.comma));
   });
 
-  runner.on('pass', function(test) {
+  runner.on(EVENT_TEST_PASS, function(test) {
     if (++n % width === 0) {
       process.stdout.write('\n  ');
     }
@@ -53,14 +59,14 @@ function Dot(runner) {
     }
   });
 
-  runner.on('fail', function() {
+  runner.on(EVENT_TEST_FAIL, function() {
     if (++n % width === 0) {
       process.stdout.write('\n  ');
     }
     process.stdout.write(Base.color('fail', Base.symbols.bang));
   });
 
-  runner.once('end', function() {
+  runner.once(EVENT_RUN_END, function() {
     console.log();
     self.epilogue();
   });

package/lib/reporters/html.js

@@ -12,6 +12,12 @@ var Base = require('./base');
 var utils = require('../utils');
 var Progress = require('../browser/progress');
 var escapeRe = require('escape-string-regexp');
+var constants = require('../runner').constants;
+var EVENT_TEST_PASS = constants.EVENT_TEST_PASS;
+var EVENT_TEST_FAIL = constants.EVENT_TEST_FAIL;
+var EVENT_SUITE_BEGIN = constants.EVENT_SUITE_BEGIN;
+var EVENT_SUITE_END = constants.EVENT_SUITE_END;
+var EVENT_TEST_PENDING = constants.EVENT_TEST_PENDING;
 var escape = utils.escape;
 
 /**
@@ -112,7 +118,7 @@ function HTML(runner) {
     progress.size(40);
   }
 
-  runner.on('suite', function(suite) {
+  runner.on(EVENT_SUITE_BEGIN, function(suite) {
     if (suite.root) {
       return;
     }
@@ -131,7 +137,7 @@ function HTML(runner) {
     el.appendChild(stack[0]);
   });
 
-  runner.on('suite end', function(suite) {
+  runner.on(EVENT_SUITE_END, function(suite) {
     if (suite.root) {
       updateStats();
       return;
@@ -139,7 +145,7 @@ function HTML(runner) {
     stack.shift();
   });
 
-  runner.on('pass', function(test) {
+  runner.on(EVENT_TEST_PASS, function(test) {
     var url = self.testURL(test);
     var markup =
       '<li class="test pass %e"><h2>%e<span class="duration">%ems</span> ' +
@@ -152,7 +158,7 @@ function HTML(runner) {
     updateStats();
   });
 
-  runner.on('fail', function(test) {
+  runner.on(EVENT_TEST_FAIL, function(test) {
     var el = fragment(
       '<li class="test fail"><h2>%e <a href="%e" class="replay">' +
         playIcon +
@@ -208,7 +214,7 @@ function HTML(runner) {
     updateStats();
   });
 
-  runner.on('pending', function(test) {
+  runner.on(EVENT_TEST_PENDING, function(test) {
     var el = fragment(
       '<li class="test pass pending"><h2>%e</h2></li>',
       test.title

package/lib/reporters/json-stream.js

@@ -7,6 +7,11 @@
  */
 
 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;
 
 /**
  * Expose `JSONStream`.
@@ -29,22 +34,22 @@ function JSONStream(runner) {
   var self = this;
   var total = runner.total;
 
-  runner.once('start', function() {
+  runner.once(EVENT_RUN_BEGIN, function() {
     writeEvent(['start', {total: total}]);
   });
 
-  runner.on('pass', function(test) {
+  runner.on(EVENT_TEST_PASS, function(test) {
     writeEvent(['pass', clean(test)]);
   });
 
-  runner.on('fail', function(test, err) {
+  runner.on(EVENT_TEST_FAIL, function(test, err) {
     test = clean(test);
     test.err = err.message;
     test.stack = err.stack || null;
     writeEvent(['fail', test]);
   });
 
-  runner.once('end', function() {
+  runner.once(EVENT_RUN_END, function() {
     writeEvent(['end', self.stats]);
   });
 }

package/lib/reporters/json.js

@@ -7,6 +7,12 @@
  */
 
 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_TEST_END = constants.EVENT_TEST_END;
+var EVENT_RUN_END = constants.EVENT_RUN_END;
+var EVENT_TEST_PENDING = constants.EVENT_TEST_PENDING;
 
 /**
  * Expose `JSON`.
@@ -32,23 +38,23 @@ function JSONReporter(runner) {
   var failures = [];
   var passes = [];
 
-  runner.on('test end', function(test) {
+  runner.on(EVENT_TEST_END, function(test) {
     tests.push(test);
   });
 
-  runner.on('pass', function(test) {
+  runner.on(EVENT_TEST_PASS, function(test) {
     passes.push(test);
   });
 
-  runner.on('fail', function(test) {
+  runner.on(EVENT_TEST_FAIL, function(test) {
     failures.push(test);
   });
 
-  runner.on('pending', function(test) {
+  runner.on(EVENT_TEST_PENDING, function(test) {
     pending.push(test);
   });
 
-  runner.once('end', function() {
+  runner.once(EVENT_RUN_END, function() {
     var obj = {
       stats: self.stats,
       tests: tests.map(clean),

package/lib/reporters/landing.js

@@ -8,6 +8,12 @@
 
 var Base = require('./base');
 var inherits = require('../utils').inherits;
+var constants = require('../runner').constants;
+var EVENT_RUN_BEGIN = constants.EVENT_RUN_BEGIN;
+var EVENT_RUN_END = constants.EVENT_RUN_END;
+var EVENT_TEST_END = constants.EVENT_TEST_END;
+var STATE_FAILED = require('../runnable').constants.STATE_FAILED;
+
 var cursor = Base.cursor;
 var color = Base.color;
 
@@ -60,17 +66,17 @@ function Landing(runner) {
     return '  ' + color('runway', buf);
   }
 
-  runner.on('start', function() {
+  runner.on(EVENT_RUN_BEGIN, function() {
     stream.write('\n\n\n  ');
     cursor.hide();
   });
 
-  runner.on('test end', function(test) {
+  runner.on(EVENT_TEST_END, function(test) {
     // check if the plane crashed
     var col = crashed === -1 ? ((width * ++n) / total) | 0 : crashed;
 
     // show the crash
-    if (test.state === 'failed') {
+    if (test.state === STATE_FAILED) {
       plane = color('plane crash', '✈');
       crashed = col;
     }
@@ -86,7 +92,7 @@ function Landing(runner) {
     stream.write('\u001b[0m');
   });
 
-  runner.once('end', function() {
+  runner.once(EVENT_RUN_END, function() {
     cursor.show();
     console.log();
     self.epilogue();

package/lib/reporters/list.js

@@ -8,6 +8,13 @@
 
 var Base = require('./base');
 var inherits = require('../utils').inherits;
+var constants = require('../runner').constants;
+var EVENT_RUN_BEGIN = constants.EVENT_RUN_BEGIN;
+var EVENT_RUN_END = constants.EVENT_RUN_END;
+var EVENT_TEST_BEGIN = constants.EVENT_TEST_BEGIN;
+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 color = Base.color;
 var cursor = Base.cursor;
 
@@ -32,20 +39,20 @@ function List(runner) {
   var self = this;
   var n = 0;
 
-  runner.on('start', function() {
+  runner.on(EVENT_RUN_BEGIN, function() {
     console.log();
   });
 
-  runner.on('test', function(test) {
+  runner.on(EVENT_TEST_BEGIN, function(test) {
     process.stdout.write(color('pass', '    ' + test.fullTitle() + ': '));
   });
 
-  runner.on('pending', function(test) {
+  runner.on(EVENT_TEST_PENDING, function(test) {
     var fmt = color('checkmark', '  -') + color('pending', ' %s');
     console.log(fmt, test.fullTitle());
   });
 
-  runner.on('pass', function(test) {
+  runner.on(EVENT_TEST_PASS, function(test) {
     var fmt =
       color('checkmark', '  ' + Base.symbols.ok) +
       color('pass', ' %s: ') +
@@ -54,12 +61,12 @@ function List(runner) {
     console.log(fmt, test.fullTitle(), test.duration);
   });
 
-  runner.on('fail', function(test) {
+  runner.on(EVENT_TEST_FAIL, function(test) {
     cursor.CR();
     console.log(color('fail', '  %d) %s'), ++n, test.fullTitle());
   });
 
-  runner.once('end', self.epilogue.bind(self));
+  runner.once(EVENT_RUN_END, self.epilogue.bind(self));
 }
 
 /**

package/lib/reporters/markdown.js

@@ -8,6 +8,11 @@
 
 var Base = require('./base');
 var utils = require('../utils');
+var constants = require('../runner').constants;
+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_PASS = constants.EVENT_TEST_PASS;
 
 /**
  * Constants
@@ -77,18 +82,18 @@ function Markdown(runner) {
 
   generateTOC(runner.suite);
 
-  runner.on('suite', function(suite) {
+  runner.on(EVENT_SUITE_BEGIN, function(suite) {
     ++level;
     var slug = utils.slug(suite.fullTitle());
     buf += '<a name="' + slug + '"></a>' + '\n';
     buf += title(suite.title) + '\n';
   });
 
-  runner.on('suite end', function() {
+  runner.on(EVENT_SUITE_END, function() {
     --level;
   });
 
-  runner.on('pass', function(test) {
+  runner.on(EVENT_TEST_PASS, function(test) {
     var code = utils.clean(test.body);
     buf += test.title + '.\n';
     buf += '\n```js\n';
@@ -96,7 +101,7 @@ function Markdown(runner) {
     buf += '```\n\n';
   });
 
-  runner.once('end', function() {
+  runner.once(EVENT_RUN_END, function() {
     process.stdout.write('# TOC\n');
     process.stdout.write(generateTOC(runner.suite));
     process.stdout.write(buf);

package/lib/reporters/min.js

@@ -8,6 +8,9 @@
 
 var Base = require('./base');
 var inherits = require('../utils').inherits;
+var constants = require('../runner').constants;
+var EVENT_RUN_END = constants.EVENT_RUN_END;
+var EVENT_RUN_BEGIN = constants.EVENT_RUN_BEGIN;
 
 /**
  * Expose `Min`.
@@ -27,14 +30,14 @@ exports = module.exports = Min;
 function Min(runner) {
   Base.call(this, runner);
 
-  runner.on('start', function() {
+  runner.on(EVENT_RUN_BEGIN, function() {
     // clear screen
     process.stdout.write('\u001b[2J');
     // set cursor position
     process.stdout.write('\u001b[1;3H');
   });
 
-  runner.once('end', this.epilogue.bind(this));
+  runner.once(EVENT_RUN_END, this.epilogue.bind(this));
 }
 
 /**