mocha 3.5.1 → 4.0.1

package/CHANGELOG.md

@@ -1,3 +1,93 @@
+# 4.0.1 / 2017-10-05
+
+## :bug: Fixes
+
+- [#3051]: Upgrade Growl to v1.10.3 to fix its [peer dep problems](https://github.com/tj/node-growl/pull/68) ([@dpogue])
+
+[#3051]: https://github.com/mochajs/mocha/pull/3051
+[@dpogue]: https://github.com/dpogue
+
+# 4.0.0 / 2017-10-02
+
+You might want to read this before filing a new bug!  :stuck_out_tongue_closed_eyes:
+
+## :boom: Breaking Changes
+
+For more info, please [read this article](https://boneskull.com/mocha-v4-nears-release/).
+
+### Compatibility
+
+- [#3016]: Drop support for unmaintained versions of Node.js ([@boneskull]):
+  - 0.10.x
+  - 0.11.x
+  - 0.12.x
+  - iojs (any)
+  - 5.x.x
+- [#2979]: Drop support for non-ES5-compliant browsers ([@boneskull]):
+  - IE7
+  - IE8
+  - PhantomJS 1.x
+- [#2615]: Drop Bower support; old versions (3.x, etc.) will remain available ([@ScottFreeCode], [@boneskull])
+
+### Default Behavior
+
+- [#2879]: By default, Mocha will no longer force the process to exit once all tests complete.  This means any test code (or code under test) which would normally prevent `node` from exiting will do so when run in Mocha.  Supply the `--exit` flag to revert to pre-v4.0.0 behavior ([@ScottFreeCode], [@boneskull])
+
+### Reporter Output
+
+- [#2095]: Remove `stdout:` prefix from browser reporter logs ([@skeggse])
+- [#2295]: Add separator in "unified diff" output ([@olsonpm])
+- [#2686]: Print failure message when `--forbid-pending` or `--forbid-only` is specified ([@ScottFreeCode])
+- [#2814]: Indent contexts for better readability when reporting failures ([@charlierudolph])
+
+## :-1: Deprecations
+
+- [#2493]: The `--compilers` command-line option is now soft-deprecated and will emit a warning on `STDERR`.  Read [this](https://github.com/mochajs/mocha/wiki/compilers-deprecation) for more info and workarounds ([@ScottFreeCode], [@boneskull])
+
+## :tada: Enhancements
+
+- [#2628]: Allow override of default test suite name in XUnit reporter ([@ngeor])
+
+## :book: Documentation
+
+- [#3020]: Link to CLA in `README.md` and `CONTRIBUTING.md` ([@skeggse])
+
+## :nut_and_bolt: Other
+
+- [#2890]: Speed up build by (re-)consolidating SauceLabs tests ([@boneskull])
+
+[#3016]: https://github.com/mochajs/mocha/issues/3016
+[#2979]: https://github.com/mochajs/mocha/issues/2979
+[#2615]: https://github.com/mochajs/mocha/issues/2615
+[#2879]: https://github.com/mochajs/mocha/issues/2879
+[#2095]: https://github.com/mochajs/mocha/issues/2095
+[#2295]: https://github.com/mochajs/mocha/issues/2295
+[#2686]: https://github.com/mochajs/mocha/issues/2686
+[#2814]: https://github.com/mochajs/mocha/pull/2814
+[#2493]: https://github.com/mochajs/mocha/issues/2493
+[#2628]: https://github.com/mochajs/mocha/issues/2628
+[#3020]: https://github.com/mochajs/mocha/pull/3020
+[#2890]: https://github.com/mochajs/mocha/issues/2890
+[@skeggse]: https://github.com/skeggse
+[@olsonpm]: https://github.com/olsonpm
+[@ngeor]: https://github.com/ngeor
+
+# 3.5.3 / 2017-09-11
+
+## :bug: Fixes
+
+- [#3003]: Fix invalid entities in xUnit reporter first appearing in v3.5.1 ([@jkrems])
+
+[#3003]: https://github.com/mochajs/mocha/pull/3003
+
+# 3.5.2 / 2017-09-10
+
+## :bug: Fixes
+
+- [#3001]: Fix AMD-related failures first appearing in v3.5.1 ([@boneskull])
+
+[#3001]: https://github.com/mochajs/mocha/pull/3001
+
 # 3.5.1 / 2017-09-09
 
 ## :newspaper: News
@@ -18,12 +108,14 @@
  
 [#2997]: https://github.com/mochajs/mocha/pull/2997
 [#2957]: https://github.com/mochajs/mocha/pull/2957
+[#2918]: https://github.com/mochajs/mocha/pull/2918
 [#2986]: https://github.com/mochajs/mocha/pull/2986
-[#2992]: https://github.com/mochajs/mocha/pull/2922
+[#2922]: https://github.com/mochajs/mocha/pull/2922
 [#2981]: https://github.com/mochajs/mocha/pull/2981
 [@solodynamo]: https://github.com/solodynamo
 [@jkrems]: https://github.com/jkrems
 [@jsoref]: https://github.com/jsoref
+
 # 3.5.0 / 2017-07-31
 
 ## :newspaper: News

package/README.md

@@ -19,7 +19,7 @@
 2.  Review current open pull requests
   - We need individuals familiar with Mocha's codebase. Got questions?  Ask them in [our chat room](https://gitter.im/mochajs/mocha).
   - Pull requests **must** have supporting tests.  The only exceptions are pure cosmetic or non-functional changes.
-  - Pull request contributors must sign the CLA.
+  - Pull request contributors must sign [the CLA](https://cla.js.foundation/mochajs/mocha).
 3. Close old, inactive issues and pull requests
   - ~~A bot should do this.  We need a bot. Got a bot?~~ We now use GitHub's own [probot-stale](https://www.npmjs.com/package/probot-stale).
 4. Triage issues

package/bin/_mocha

@@ -94,7 +94,7 @@ program
   .option('--inspect-brk', 'activate devtools in chrome and break on the first line')
   .option('--interfaces', 'display available interfaces')
   .option('--no-deprecation', 'silence deprecation warnings')
-  .option('--no-exit', 'require a clean shutdown of the event loop: mocha will not call process.exit')
+  .option('--exit', 'force shutdown of the event loop after test run: mocha will call process.exit')
   .option('--no-timeouts', 'disables timeouts, given implicitly with --debug')
   .option('--no-warnings', 'silence all node process warnings')
   .option('--opts <path>', 'specify opts path', 'test/mocha.opts')
@@ -138,13 +138,13 @@ program
 
 // --globals
 
-program.on('globals', function (val) {
+program.on('option:globals', function (val) {
   globals = globals.concat(list(val));
 });
 
 // --reporters
 
-program.on('reporters', function () {
+program.on('option:reporters', function () {
   console.log();
   console.log('    dot - dot matrix');
   console.log('    doc - html documentation');
@@ -165,7 +165,7 @@ program.on('reporters', function () {
 
 // --interfaces
 
-program.on('interfaces', function () {
+program.on('option:interfaces', function () {
   console.log('');
   interfaceNames.forEach(function (interfaceName) {
     console.log('    ' + interfaceName);
@@ -178,7 +178,7 @@ program.on('interfaces', function () {
 
 module.paths.push(cwd, join(cwd, 'node_modules'));
 
-program.on('require', function (mod) {
+program.on('option:require', function (mod) {
   var abs = exists(mod) || exists(mod + '.js');
   if (abs) {
     mod = resolve(mod);
@@ -346,6 +346,10 @@ if (program.forbidPending) mocha.forbidPending();
 
 // custom compiler support
 
+if (program.compilers.length > 0) {
+  require('util').deprecate(function () {},
+    '"--compilers" will be removed in a future version of Mocha; see https://git.io/vdcSr for more info')();
+}
 var extensions = ['js'];
 program.compilers.forEach(function (c) {
   var idx = c.indexOf(':');

package/browser-entry.js

@@ -7,7 +7,7 @@
  * Shim process.stdout.
  */
 
-process.stdout = require('browser-stdout')();
+process.stdout = require('browser-stdout')({level: false});
 
 var Mocha = require('./lib/mocha');
 
@@ -45,7 +45,7 @@ process.removeListener = function (e, fn) {
     } else {
       global.onerror = function () {};
     }
-    var i = Mocha.utils.indexOf(uncaughtExceptionHandlers, fn);
+    var i = uncaughtExceptionHandlers.indexOf(fn);
     if (i !== -1) {
       uncaughtExceptionHandlers.splice(i, 1);
     }
@@ -103,7 +103,7 @@ Mocha.Runner.immediately = function (callback) {
  * only receive the 'message' attribute of the Error.
  */
 mocha.throwError = function (err) {
-  Mocha.utils.forEach(uncaughtExceptionHandlers, function (fn) {
+  uncaughtExceptionHandlers.forEach(function (fn) {
     fn(err);
   });
   throw err;

package/lib/browser/growl.js

@@ -0,0 +1,5 @@
+'use strict';
+
+// just stub out growl
+
+module.exports = require('../utils').noop;

package/lib/context.js

@@ -1,11 +1,5 @@
 'use strict';
 
-/**
- * Module dependencies.
- */
-
-var JSON = require('json3');
-
 /**
  * Expose `Context`.
  */
@@ -77,11 +71,10 @@ Context.prototype.slow = function (ms) {
  * Mark a test as skipped.
  *
  * @api private
- * @return {Context} self
+ * @throws Pending
  */
 Context.prototype.skip = function () {
   this.runnable().skip();
-  return this;
 };
 
 /**

package/lib/interfaces/common.js

@@ -74,7 +74,6 @@ module.exports = function (suites, context, mocha) {
        * @returns {Suite}
        */
       only: function only (opts) {
-        mocha.options.hasOnly = true;
         opts.isOnly = true;
         return this.create(opts);
       },
@@ -108,7 +107,6 @@ module.exports = function (suites, context, mocha) {
         suites.unshift(suite);
         if (opts.isOnly) {
           suite.parent._onlySuites = suite.parent._onlySuites.concat(suite);
-          mocha.options.hasOnly = true;
         }
         if (typeof opts.fn === 'function') {
           opts.fn.call(suite);
@@ -132,7 +130,6 @@ module.exports = function (suites, context, mocha) {
        */
       only: function (mocha, test) {
         test.parent._onlyTests = test.parent._onlyTests.concat(test);
-        mocha.options.hasOnly = true;
         return test;
       },
 

package/lib/mocha.js

@@ -520,7 +520,6 @@ Mocha.prototype.run = function (fn) {
   var reporter = new this._reporter(runner, options);
   runner.ignoreLeaks = options.ignoreLeaks !== false;
   runner.fullStackTrace = options.fullStackTrace;
-  runner.hasOnly = options.hasOnly;
   runner.asyncOnly = options.asyncOnly;
   runner.allowUncaught = options.allowUncaught;
   runner.forbidOnly = options.forbidOnly;

package/lib/reporters/base.js

@@ -120,8 +120,8 @@ exports.window = {
 
 if (isatty) {
   exports.window.width = process.stdout.getWindowSize
-      ? process.stdout.getWindowSize(1)[0]
-      : tty.getWindowSize()[1];
+    ? process.stdout.getWindowSize(1)[0]
+    : tty.getWindowSize()[1];
 }
 
 /**
@@ -222,7 +222,19 @@ exports.list = function (failures) {
     // indent stack trace
     stack = stack.replace(/^/gm, '  ');
 
-    console.log(fmt, (i + 1), test.fullTitle(), msg, stack);
+    // indented test title
+    var testTitle = '';
+    test.titlePath().forEach(function (str, index) {
+      if (index !== 0) {
+        testTitle += '\n     ';
+      }
+      for (var i = 0; i < index; i++) {
+        testTitle += '  ';
+      }
+      testTitle += str;
+    });
+
+    console.log(fmt, (i + 1), testTitle, msg, stack);
   });
 };
 
@@ -404,7 +416,7 @@ function unifiedDiff (err, escape) {
       return indent + colorLines('diff removed', line);
     }
     if (line.match(/@@/)) {
-      return null;
+      return '--';
     }
     if (line.match(/\\ No newline/)) {
       return null;
@@ -415,7 +427,7 @@ function unifiedDiff (err, escape) {
     return typeof line !== 'undefined' && line !== null;
   }
   var msg = diff.createPatch('string', err.actual, err.expected);
-  var lines = msg.split('\n').splice(4);
+  var lines = msg.split('\n').splice(5);
   return '\n      ' +
     colorLines('diff added', '+ expected') + ' ' +
     colorLines('diff removed', '- actual') +

package/lib/reporters/json-stream.js

@@ -5,7 +5,6 @@
  */
 
 var Base = require('./base');
-var JSON = require('json3');
 
 /**
  * Expose `List`.

package/lib/reporters/xunit.js

@@ -43,14 +43,29 @@ function XUnit (runner, options) {
   var tests = [];
   var self = this;
 
-  if (options && options.reporterOptions && options.reporterOptions.output) {
-    if (!fs.createWriteStream) {
-      throw new Error('file output not supported in browser');
+  // the name of the test suite, as it will appear in the resulting XML file
+  var suiteName;
+
+  // the default name of the test suite if none is provided
+  var DEFAULT_SUITE_NAME = 'Mocha Tests';
+
+  if (options && options.reporterOptions) {
+    if (options.reporterOptions.output) {
+      if (!fs.createWriteStream) {
+        throw new Error('file output not supported in browser');
+      }
+
+      mkdirp.sync(path.dirname(options.reporterOptions.output));
+      self.fileStream = fs.createWriteStream(options.reporterOptions.output);
     }
-    mkdirp.sync(path.dirname(options.reporterOptions.output));
-    self.fileStream = fs.createWriteStream(options.reporterOptions.output);
+
+    // get the suite name from the reporter options (if provided)
+    suiteName = options.reporterOptions.suiteName;
   }
 
+  // fall back to the default suite name
+  suiteName = suiteName || DEFAULT_SUITE_NAME;
+
   runner.on('pending', function (test) {
     tests.push(test);
   });
@@ -65,7 +80,7 @@ function XUnit (runner, options) {
 
   runner.on('end', function () {
     self.write(tag('testsuite', {
-      name: 'Mocha Tests',
+      name: suiteName,
       tests: stats.tests,
       failures: stats.failures,
       errors: stats.failures,

package/lib/runnable.js

@@ -5,12 +5,10 @@
  */
 
 var EventEmitter = require('events').EventEmitter;
-var JSON = require('json3');
 var Pending = require('./pending');
 var debug = require('debug')('mocha:runnable');
 var milliseconds = require('./ms');
 var utils = require('./utils');
-var create = require('lodash.create');
 
 /**
  * Save timer references to avoid Sinon interfering (see GH-237).
@@ -64,9 +62,7 @@ function Runnable (title, fn) {
 /**
  * Inherit from `EventEmitter.prototype`.
  */
-Runnable.prototype = create(EventEmitter.prototype, {
-  constructor: Runnable
-});
+utils.inherits(Runnable, EventEmitter);
 
 /**
  * Set & get timeout `ms`.
@@ -179,7 +175,17 @@ Runnable.prototype.currentRetry = function (n) {
  * @return {string}
  */
 Runnable.prototype.fullTitle = function () {
-  return this.parent.fullTitle() + ' ' + this.title;
+  return this.titlePath().join(' ');
+};
+
+/**
+ * Return the title path generated by concatenating the parent's title path with the title.
+ *
+ * @api public
+ * @return {string}
+ */
+Runnable.prototype.titlePath = function () {
+  return this.parent.titlePath().concat([this.title]);
 };
 
 /**

package/lib/runner.js

@@ -10,15 +10,10 @@ var utils = require('./utils');
 var inherits = utils.inherits;
 var debug = require('debug')('mocha:runner');
 var Runnable = require('./runnable');
-var filter = utils.filter;
-var indexOf = utils.indexOf;
-var some = utils.some;
-var keys = utils.keys;
 var stackFilter = utils.stackTraceFilter();
 var stringify = utils.stringify;
 var type = utils.type;
 var undefinedError = utils.undefinedError;
-var isArray = utils.isArray;
 
 /**
  * Non-enumerable globals.
@@ -150,11 +145,11 @@ Runner.prototype.grepTotal = function (suite) {
  * @api private
  */
 Runner.prototype.globalProps = function () {
-  var props = keys(global);
+  var props = Object.keys(global);
 
   // non-enumerables
   for (var i = 0; i < globals.length; ++i) {
-    if (~indexOf(props, globals[i])) {
+    if (~props.indexOf(globals[i])) {
       continue;
     }
     props.push(globals[i]);
@@ -229,7 +224,7 @@ Runner.prototype.fail = function (test, err) {
   ++this.failures;
   test.state = 'failed';
 
-  if (!(err instanceof Error || err && typeof err.message === 'string')) {
+  if (!(err instanceof Error || (err && typeof err.message === 'string'))) {
     err = new Error('the ' + type(err) + ' ' + stringify(err) + ' was thrown, throw an Error :)');
   }
 
@@ -316,7 +311,7 @@ Runner.prototype.hook = function (name, fn) {
           if (name === 'beforeEach' || name === 'afterEach') {
             self.test.pending = true;
           } else {
-            utils.forEach(suite.tests, function (test) {
+            suite.tests.forEach(function (test) {
               test.pending = true;
             });
             // a pending hook won't be executed twice.
@@ -429,6 +424,10 @@ Runner.prototype.runTest = function (fn) {
   if (!test) {
     return;
   }
+  if (this.forbidOnly && hasOnly(this.parents().reverse()[0] || this.suite)) {
+    fn(new Error('`.only` forbidden'));
+    return;
+  }
   if (this.asyncOnly) {
     test.asyncOnly = true;
   }
@@ -529,7 +528,13 @@ Runner.prototype.runTests = function (suite, fn) {
     }
 
     if (test.isPending()) {
-      self.emit('pending', test);
+      if (self.forbidPending) {
+        test.isPending = alwaysFalse;
+        self.fail(test, new Error('Pending test forbidden'));
+        delete test.isPending;
+      } else {
+        self.emit('pending', test);
+      }
       self.emit('test end', test);
       return next();
     }
@@ -538,7 +543,13 @@ Runner.prototype.runTests = function (suite, fn) {
     self.emit('test', self.test = test);
     self.hookDown('beforeEach', function (err, errSuite) {
       if (test.isPending()) {
-        self.emit('pending', test);
+        if (self.forbidPending) {
+          test.isPending = alwaysFalse;
+          self.fail(test, new Error('Pending test forbidden'));
+          delete test.isPending;
+        } else {
+          self.emit('pending', test);
+        }
         self.emit('test end', test);
         return next();
       }
@@ -550,7 +561,9 @@ Runner.prototype.runTests = function (suite, fn) {
         test = self.test;
         if (err) {
           var retry = test.currentRetry();
-          if (err instanceof Pending) {
+          if (err instanceof Pending && self.forbidPending) {
+            self.fail(test, new Error('Pending test forbidden'));
+          } else if (err instanceof Pending) {
             test.pending = true;
             self.emit('pending', test);
           } else if (retry < test.retries()) {
@@ -586,6 +599,10 @@ Runner.prototype.runTests = function (suite, fn) {
   next();
 };
 
+function alwaysFalse () {
+  return false;
+}
+
 /**
  * Run the given `suite` and invoke the callback `fn()` when complete.
  *
@@ -722,7 +739,7 @@ Runner.prototype.uncaught = function (err) {
     return;
   }
 
- // recover from hooks
+  // recover from hooks
   if (runnable.type === 'hook') {
     var errSuite = this.suite;
     // if hook failure is in afterEach block
@@ -758,19 +775,19 @@ function cleanSuiteReferences (suite) {
     }
   }
 
-  if (isArray(suite._beforeAll)) {
+  if (Array.isArray(suite._beforeAll)) {
     cleanArrReferences(suite._beforeAll);
   }
 
-  if (isArray(suite._beforeEach)) {
+  if (Array.isArray(suite._beforeEach)) {
     cleanArrReferences(suite._beforeEach);
   }
 
-  if (isArray(suite._afterAll)) {
+  if (Array.isArray(suite._afterAll)) {
     cleanArrReferences(suite._afterAll);
   }
 
-  if (isArray(suite._afterEach)) {
+  if (Array.isArray(suite._afterEach)) {
     cleanArrReferences(suite._afterEach);
   }
 
@@ -794,7 +811,7 @@ Runner.prototype.run = function (fn) {
   var rootSuite = this.suite;
 
   // If there is an `only` filter
-  if (this.hasOnly) {
+  if (hasOnly(rootSuite)) {
     filterOnly(rootSuite);
   }
 
@@ -820,12 +837,6 @@ Runner.prototype.run = function (fn) {
 
   // callback
   this.on('end', function () {
-    if (self.forbidOnly && self.hasOnly) {
-      self.failures += self.stats.tests;
-    }
-    if (self.forbidPending) {
-      self.failures += self.stats.pending;
-    }
     debug('end');
     process.removeListener('uncaughtException', uncaught);
     fn(self.failures);
@@ -874,7 +885,7 @@ function filterOnly (suite) {
   } else {
     // Otherwise, do not run any of the tests in this suite.
     suite.tests = [];
-    utils.forEach(suite._onlySuites, function (onlySuite) {
+    suite._onlySuites.forEach(function (onlySuite) {
       // If there are other `only` tests/suites nested in the current `only` suite, then filter that `only` suite.
       // Otherwise, all of the tests on this `only` suite should be run, so don't filter it.
       if (hasOnly(onlySuite)) {
@@ -882,8 +893,8 @@ function filterOnly (suite) {
       }
     });
     // Run the `only` suites, as well as any other suites that have `only` tests/suites as descendants.
-    suite.suites = filter(suite.suites, function (childSuite) {
-      return indexOf(suite._onlySuites, childSuite) !== -1 || filterOnly(childSuite);
+    suite.suites = suite.suites.filter(function (childSuite) {
+      return suite._onlySuites.indexOf(childSuite) !== -1 || filterOnly(childSuite);
     });
   }
   // Keep the suite only if there is something to run
@@ -898,7 +909,7 @@ function filterOnly (suite) {
  * @api private
  */
 function hasOnly (suite) {
-  return suite._onlyTests.length || suite._onlySuites.length || some(suite.suites, hasOnly);
+  return suite._onlyTests.length || suite._onlySuites.length || suite.suites.some(hasOnly);
 }
 
 /**
@@ -910,7 +921,7 @@ function hasOnly (suite) {
  * @return {Array}
  */
 function filterLeaks (ok, globals) {
-  return filter(globals, function (key) {
+  return globals.filter(function (key) {
     // Firefox and Chrome exposes iframes as index inside the window object
     if (/^\d+/.test(key)) {
       return false;
@@ -934,7 +945,7 @@ function filterLeaks (ok, globals) {
       return false;
     }
 
-    var matched = filter(ok, function (ok) {
+    var matched = ok.filter(function (ok) {
       if (~ok.indexOf('*')) {
         return key.indexOf(ok.split('*')[0]) === 0;
       }
@@ -953,7 +964,7 @@ function filterLeaks (ok, globals) {
 function extraGlobals () {
   if (typeof process === 'object' && typeof process.version === 'string') {
     var parts = process.version.split('.');
-    var nodeVersion = utils.reduce(parts, function (a, v) {
+    var nodeVersion = parts.reduce(function (a, v) {
       return a << 8 | v;
     });
 

package/lib/suite.js

@@ -355,13 +355,25 @@ Suite.prototype.addTest = function (test) {
  * @return {string}
  */
 Suite.prototype.fullTitle = function () {
+  return this.titlePath().join(' ');
+};
+
+/**
+ * Return the title path generated by recursively concatenating the parent's
+ * title path.
+ *
+ * @api public
+ * @return {string}
+ */
+Suite.prototype.titlePath = function () {
+  var result = [];
   if (this.parent) {
-    var full = this.parent.fullTitle();
-    if (full) {
-      return full + ' ' + this.title;
-    }
+    result = result.concat(this.parent.titlePath());
+  }
+  if (!this.root) {
+    result.push(this.title);
   }
-  return this.title;
+  return result;
 };
 
 /**
@@ -371,7 +383,7 @@ Suite.prototype.fullTitle = function () {
  * @return {number}
  */
 Suite.prototype.total = function () {
-  return utils.reduce(this.suites, function (sum, suite) {
+  return this.suites.reduce(function (sum, suite) {
     return sum + suite.total();
   }, 0) + this.tests.length;
 };
@@ -385,8 +397,8 @@ Suite.prototype.total = function () {
  * @return {Suite}
  */
 Suite.prototype.eachTest = function (fn) {
-  utils.forEach(this.tests, fn);
-  utils.forEach(this.suites, function (suite) {
+  this.tests.forEach(fn);
+  this.suites.forEach(function (suite) {
     suite.eachTest(fn);
   });
   return this;