mocha 3.5.2 → 4.1.0

package/bin/mocha

@@ -7,17 +7,17 @@
  * when found, before invoking the "real" _mocha(1) executable.
  */
 
-var spawn = require('child_process').spawn;
-var path = require('path');
-var getOptions = require('./options');
-var args = [path.join(__dirname, '_mocha')];
+const spawn = require('child_process').spawn;
+const path = require('path');
+const getOptions = require('./options');
+const args = [path.join(__dirname, '_mocha')];
 
 // Load mocha.opts into process.argv
 // Must be loaded here to handle node-specific options
 getOptions();
 
-process.argv.slice(2).forEach(function (arg) {
-  var flag = arg.split('=')[0];
+process.argv.slice(2).forEach(arg => {
+  const flag = arg.split('=')[0];
 
   switch (flag) {
     case '-d':
@@ -69,9 +69,11 @@ process.argv.slice(2).forEach(function (arg) {
   }
 });
 
-var proc = spawn(process.execPath, args, { stdio: 'inherit' });
-proc.on('exit', function (code, signal) {
-  process.on('exit', function () {
+const proc = spawn(process.execPath, args, {
+  stdio: 'inherit'
+});
+proc.on('exit', (code, signal) => {
+  process.on('exit', () => {
     if (signal) {
       process.kill(process.pid, signal);
     } else {
@@ -81,7 +83,7 @@ proc.on('exit', function (code, signal) {
 });
 
 // terminate children.
-process.on('SIGINT', function () {
+process.on('SIGINT', () => {
   proc.kill('SIGINT'); // calls runner.abort()
   proc.kill('SIGTERM'); // if that didn't work, we're probably in an infinite loop, so make it die.
 });

package/bin/options.js

@@ -4,7 +4,7 @@
  * Dependencies.
  */
 
-var fs = require('fs');
+const fs = require('fs');
 
 /**
  * Export `getOptions`.
@@ -17,18 +17,20 @@ module.exports = getOptions;
  */
 
 function getOptions () {
-  var optsPath = process.argv.indexOf('--opts') === -1
+  if (process.argv.length === 3 && (process.argv[2] === '-h' || process.argv[2] === '--help')) {
+    return;
+  }
+
+  const optsPath = process.argv.indexOf('--opts') === -1
     ? 'test/mocha.opts'
     : process.argv[process.argv.indexOf('--opts') + 1];
 
   try {
-    var opts = fs.readFileSync(optsPath, 'utf8')
+    const opts = fs.readFileSync(optsPath, 'utf8')
       .replace(/\\\s/g, '%20')
       .split(/\s/)
       .filter(Boolean)
-      .map(function (value) {
-        return value.replace(/%20/g, ' ');
-      });
+      .map(value => value.replace(/%20/g, ' '));
 
     process.argv = process.argv
       .slice(0, 2)

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`.
  */
@@ -35,7 +29,7 @@ Context.prototype.runnable = function (runnable) {
 };
 
 /**
- * Set test timeout `ms`.
+ * Set or get test timeout `ms`.
  *
  * @api private
  * @param {number} ms
@@ -57,18 +51,24 @@ Context.prototype.timeout = function (ms) {
  * @return {Context} self
  */
 Context.prototype.enableTimeouts = function (enabled) {
+  if (!arguments.length) {
+    return this.runnable().enableTimeouts();
+  }
   this.runnable().enableTimeouts(enabled);
   return this;
 };
 
 /**
- * Set test slowness threshold `ms`.
+ * Set or get test slowness threshold `ms`.
  *
  * @api private
  * @param {number} ms
  * @return {Context} self
  */
 Context.prototype.slow = function (ms) {
+  if (!arguments.length) {
+    return this.runnable().slow();
+  }
   this.runnable().slow(ms);
   return this;
 };
@@ -77,15 +77,14 @@ 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;
 };
 
 /**
- * Allow a number of retries on failed tests
+ * Set or get a number of allowed retries on failed tests
  *
  * @api private
  * @param {number} n
@@ -98,15 +97,3 @@ Context.prototype.retries = function (n) {
   this.runnable().retries(n);
   return this;
 };
-
-/**
- * Inspect the context void of `._runnable`.
- *
- * @api private
- * @return {string}
- */
-Context.prototype.inspect = function () {
-  return JSON.stringify(this, function (key, val) {
-    return key === 'runnable' || key === 'test' ? undefined : val;
-  }, 2);
-};

package/lib/interfaces/bdd.js

@@ -102,7 +102,7 @@ module.exports = function (suite) {
      */
 
     context.xit = context.xspecify = context.it.skip = function (title) {
-      context.it(title);
+      return context.it(title);
     };
 
     /**

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

@@ -389,6 +389,20 @@ Mocha.prototype.useInlineDiffs = function (inlineDiffs) {
   return this;
 };
 
+/**
+ * Do not show diffs at all.
+ *
+ * @param {Boolean} hideDiff
+ * @return {Mocha}
+ * @api public
+ * @param {boolean} hideDiff
+ * @return {Mocha}
+ */
+Mocha.prototype.hideDiff = function (hideDiff) {
+  this.options.hideDiff = hideDiff !== undefined && hideDiff;
+  return this;
+};
+
 /**
  * Set the timeout in milliseconds.
  *
@@ -505,6 +519,14 @@ Mocha.prototype.forbidPending = function () {
 /**
  * Run tests and invoke `fn()` when complete.
  *
+ * Note that `loadFiles` relies on Node's `require` to execute
+ * the test interface functions and will be subject to the
+ * cache - if the files are already in the `require` cache,
+ * they will effectively be skipped. Therefore, to run tests
+ * multiple times or to run tests in files that are already
+ * in the `require` cache, make sure to clear them from the
+ * cache first in whichever manner best suits your needs.
+ *
  * @api public
  * @param {Function} fn
  * @return {Runner}
@@ -520,7 +542,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;
@@ -538,6 +559,7 @@ Mocha.prototype.run = function (fn) {
     exports.reporters.Base.useColors = options.useColors;
   }
   exports.reporters.Base.inlineDiffs = options.useInlineDiffs;
+  exports.reporters.Base.hideDiff = options.hideDiff;
 
   function done (failures) {
     if (reporter.done) {

package/lib/ms.js

@@ -13,22 +13,15 @@ var y = d * 365.25;
 /**
  * Parse or format the given `val`.
  *
- * Options:
- *
- *  - `long` verbose formatting [false]
- *
  * @api public
  * @param {string|number} val
- * @param {Object} options
  * @return {string|number}
  */
-module.exports = function (val, options) {
-  options = options || {};
+module.exports = function (val) {
   if (typeof val === 'string') {
     return parse(val);
   }
-  // https://github.com/mochajs/mocha/pull/1035
-  return options['long'] ? longFormat(val) : shortFormat(val);
+  return format(val);
 };
 
 /**
@@ -74,13 +67,13 @@ function parse (str) {
 }
 
 /**
- * Short format for `ms`.
+ * Format for `ms`.
  *
  * @api private
  * @param {number} ms
  * @return {string}
  */
-function shortFormat (ms) {
+function format (ms) {
   if (ms >= d) {
     return Math.round(ms / d) + 'd';
   }
@@ -95,36 +88,3 @@ function shortFormat (ms) {
   }
   return ms + 'ms';
 }
-
-/**
- * Long format for `ms`.
- *
- * @api private
- * @param {number} ms
- * @return {string}
- */
-function longFormat (ms) {
-  return plural(ms, d, 'day') ||
-    plural(ms, h, 'hour') ||
-    plural(ms, m, 'minute') ||
-    plural(ms, s, 'second') ||
-    ms + ' ms';
-}
-
-/**
- * Pluralization helper.
- *
- * @api private
- * @param {number} ms
- * @param {number} n
- * @param {string} name
- */
-function plural (ms, n, name) {
-  if (ms < n) {
-    return;
-  }
-  if (ms < n * 1.5) {
-    return Math.floor(ms / n) + ' ' + name;
-  }
-  return Math.ceil(ms / n) + ' ' + name + 's';
-}

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];
 }
 
 /**
@@ -155,6 +155,17 @@ exports.cursor = {
   }
 };
 
+function showDiff (err) {
+  return err && err.showDiff !== false && sameType(err.actual, err.expected) && err.expected !== undefined;
+}
+
+function stringifyDiffObjs (err) {
+  if (!utils.isString(err.actual) || !utils.isString(err.expected)) {
+    err.actual = utils.stringify(err.actual);
+    err.expected = utils.stringify(err.expected);
+  }
+}
+
 /**
  * Output the given `failures` as a list.
  *
@@ -183,9 +194,6 @@ exports.list = function (failures) {
     }
     var stack = err.stack || message;
     var index = message ? stack.indexOf(message) : -1;
-    var actual = err.actual;
-    var expected = err.expected;
-    var escape = true;
 
     if (index === -1) {
       msg = message;
@@ -201,28 +209,35 @@ exports.list = function (failures) {
       msg = 'Uncaught ' + msg;
     }
     // explicitly show diff
-    if (err.showDiff !== false && sameType(actual, expected) && expected !== undefined) {
-      escape = false;
-      if (!(utils.isString(actual) && utils.isString(expected))) {
-        err.actual = actual = utils.stringify(actual);
-        err.expected = expected = utils.stringify(expected);
-      }
-
+    if (!exports.hideDiff && showDiff(err)) {
+      stringifyDiffObjs(err);
       fmt = color('error title', '  %s) %s:\n%s') + color('error stack', '\n%s\n');
       var match = message.match(/^([^:]+): expected/);
       msg = '\n      ' + color('error message', match ? match[1] : msg);
 
       if (exports.inlineDiffs) {
-        msg += inlineDiff(err, escape);
+        msg += inlineDiff(err);
       } else {
-        msg += unifiedDiff(err, escape);
+        msg += unifiedDiff(err);
       }
     }
 
     // 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);
   });
 };
 
@@ -280,6 +295,9 @@ function Base (runner) {
   runner.on('fail', function (test, err) {
     stats.failures = stats.failures || 0;
     stats.failures++;
+    if (showDiff(err)) {
+      stringifyDiffObjs(err);
+    }
     test.err = err;
     failures.push(test);
   });
@@ -354,11 +372,10 @@ function pad (str, len) {
  *
  * @api private
  * @param {Error} err with actual/expected
- * @param {boolean} escape
  * @return {string} Diff
  */
-function inlineDiff (err, escape) {
-  var msg = errorDiff(err, 'WordsWithSpace', escape);
+function inlineDiff (err) {
+  var msg = errorDiff(err);
 
   // linenos
   var lines = msg.split('\n');
@@ -388,15 +405,11 @@ function inlineDiff (err, escape) {
  *
  * @api private
  * @param {Error} err with actual/expected
- * @param {boolean} escape
  * @return {string} The diff.
  */
-function unifiedDiff (err, escape) {
+function unifiedDiff (err) {
   var indent = '      ';
   function cleanUp (line) {
-    if (escape) {
-      line = escapeInvisibles(line);
-    }
     if (line[0] === '+') {
       return indent + colorLines('diff added', line);
     }
@@ -404,7 +417,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 +428,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') +
@@ -428,14 +441,10 @@ function unifiedDiff (err, escape) {
  *
  * @api private
  * @param {Error} err
- * @param {string} type
- * @param {boolean} escape
  * @return {string}
  */
-function errorDiff (err, type, escape) {
-  var actual = escape ? escapeInvisibles(err.actual) : err.actual;
-  var expected = escape ? escapeInvisibles(err.expected) : err.expected;
-  return diff['diff' + type](actual, expected).map(function (str) {
+function errorDiff (err) {
+  return diff.diffWordsWithSpace(err.actual, err.expected).map(function (str) {
     if (str.added) {
       return colorLines('diff added', str.value);
     }
@@ -446,19 +455,6 @@ function errorDiff (err, type, escape) {
   }).join('');
 }
 
-/**
- * Returns a string with all invisible characters in plain text
- *
- * @api private
- * @param {string} line
- * @return {string}
- */
-function escapeInvisibles (line) {
-  return line.replace(/\t/g, '<tab>')
-    .replace(/\r/g, '<CR>')
-    .replace(/\n/g, '<LF>\n');
-}
-
 /**
  * Color lines for `str`, using the color `name`.
  *