mocha 5.0.1 → 5.0.5

package/CHANGELOG.md

@@ -1,18 +1,115 @@
+# 5.0.5 / 2018-03-22
+
+Welcome [@outsideris] to the team!
+
+## :bug: Fixes
+
+- [#3096]: Fix `--bail` failing to bail within hooks ([@outsideris])
+- [#3184]: Don't skip too many suites (using `describe.skip()`) ([@outsideris])
+
+## :book: Documentation
+
+- [#3133]: Improve docs regarding "pending" behavior ([@ematicipo])
+- [#3276], [#3274]: Fix broken stuff in `CHANGELOG.md` ([@tagoro9], [@honzajavorek])
+
+## :nut_and_bolt: Other
+
+- [#3208]: Improve test coverage for AMD users ([@outsideris])
+- [#3267]: Remove vestiges of PhantomJS from CI ([@anishkny])
+- [#2952]: Fix a debug message ([@boneskull])
+
+[#3096]: https://github.com/mochajs/mocha/issues/3096
+[#3184]: https://github.com/mochajs/mocha/issues/3184
+[#3133]: https://github.com/mochajs/mocha/issues/3133
+[#3276]: https://github.com/mochajs/mocha/pull/3276
+[#3274]: https://github.com/mochajs/mocha/pull/3274
+[#3208]: https://github.com/mochajs/mocha/issues/3208
+[#2952]: https://github.com/mochajs/mocha/issues/2952
+[#3267]: https://github.com/mochajs/mocha/pull/3267
+
+[@ematicipo]: https://github.com/ematicipo
+[@tagoro9]: https://github.com/tagoro9
+[@honzajavorek]: https://github.com/honajavorek
+[@anishkny]: https://github.com/anishkny
+
+# 5.0.4 / 2018-03-07
+
+## :bug: Fixes
+
+- [#3265]: Fixes regression in "watch" functionality introduced in v5.0.2 ([@outsideris])
+
+[#3265]: https://github.com/mochajs/mocha/issues/3265
+
+# 5.0.3 / 2018-03-06
+
+This patch features a fix to address a potential "low severity" [ReDoS vulnerability](https://snyk.io/vuln/npm:diff:20180305) in the [diff](https://npm.im/diff) package (a dependency of Mocha).
+
+## :lock: Security Fixes
+
+- [#3266]: Bump `diff` to v3.5.0 ([@anishkny])
+
+## :nut_and_bolt: Other
+
+- [#3011]: Expose `generateDiff()` in `Base` reporter ([@harrysarson])
+
+[#3266]: https://github.com/mochajs/mocha/pull/3266
+[#3011]: https://github.com/mochajs/mocha/issues/3011
+
+[@anishkny]: https://github.com/anishkny
+[@harrysarson]: https://github.com/harrysarson
+
+# 5.0.2 / 2018-03-05
+
+This release fixes a class of tests which report as *false positives*.  **Certain tests will now break**, though they would have previously been reported as passing.  Details below.  Sorry for the inconvenience!
+
+## :bug: Fixes
+
+- [#3226]: Do not swallow errors that are thrown asynchronously from passing tests ([@boneskull]).  Example:
+
+  ```js
+  it('should actually fail, sorry!', function (done) {
+    // passing assertion
+    assert(true === true);
+
+    // test complete & is marked as passing
+    done();
+
+    // ...but something evil lurks within
+    setTimeout(() => {
+      throw new Error('chaos!');
+    }, 100);
+  });
+  ```
+
+  Previously to this version, Mocha would have *silently swallowed* the `chaos!` exception, and you wouldn't know.  Well, *now you know*.  Mocha cannot recover from this gracefully, so it will exit with a nonzero code.
+
+  **Maintainers of external reporters**: *If* a test of this class is encountered, the `Runner` instance will emit the `end` event *twice*; you *may* need to change your reporter to use `runner.once('end')` intead of `runner.on('end')`.
+- [#3093]: Fix stack trace reformatting problem ([@outsideris])
+
+## :nut_and_bolt: Other
+
+- [#3248]: Update `browser-stdout` to v1.3.1 ([@honzajavorek])
+
+[#3248]: https://github.com/mochajs/mocha/issues/3248
+[#3226]: https://github.com/mochajs/mocha/issues/3226
+[#3093]: https://github.com/mochajs/mocha/issues/3093
+[@honzajavorek]: https://github.com/honzajavorek
+
 # 5.0.1 / 2018-02-07
 
 ...your garden-variety patch release.
 
-:heart: Special thanks to [Wallaby.js](https://wallabyjs.com) for their continued support!
+Special thanks to [Wallaby.js](https://wallabyjs.com) for their continued support! :heart:
 
 ## :bug: Fixes
- 
+
 - [#1838]: `--delay` now works with `.only()` ([@silviom])
 - [#3119]: Plug memory leak present in v8 ([@boneskull])
 
 ## :book: Documentation
 
 - [#3132], [#3098]: Update `--glob` docs ([@outsideris])
-- [#3212]: Update [Wallaby.,js](https://wallabyjs.com)-related docs ([@ArtemGovorov])
+- [#3212]: Update [Wallaby.js](https://wallabyjs.com)-related docs ([@ArtemGovorov])
 - [#3205]: Remove outdated cruft ([@boneskull])
 
 ## :nut_and_bolt: Other
@@ -24,10 +121,10 @@
 [#3119]: https://github.com/mochajs/mocha/issues/3119
 [#3132]: https://github.com/mochajs/mocha/issues/3132
 [#3098]: https://github.com/mochajs/mocha/issues/3098
-[#3212]: https://github.com/mochajs/mocha/pulls/3212
-[#3205]: https://github.com/mochajs/mocha/pulls/3205
-[#3224]: https://github.com/mochajs/mocha/pulls/3224
-[#3230]: https://github.com/mochajs/mocha/pulls/3230
+[#3212]: https://github.com/mochajs/mocha/pull/3212
+[#3205]: https://github.com/mochajs/mocha/pull/3205
+[#3224]: https://github.com/mochajs/mocha/pull/3224
+[#3230]: https://github.com/mochajs/mocha/pull/3230
 [@silviom]: https://github.com/silviom
 [@outsideris]: https://github.com/outsideris
 [@ArtemGovorov]: https://github.com/ArtemGovorov
@@ -76,7 +173,7 @@ Welcome [@vkarpov15] to the team!
 [#3148]: https://github.com/mochajs/mocha/issues/3148
 [#3181]: https://github.com/mochajs/mocha/issues/3181
 [#3187]: https://github.com/mochajs/mocha/issues/3187
-[#3202]: https://github.com/mochajs/mocha/pull/3148
+[#3202]: https://github.com/mochajs/mocha/pull/3202
 [#2352]: https://github.com/mochajs/mocha/issues/2352
 [#3137]: https://github.com/mochajs/mocha/issues/3137
 [#3134]: https://github.com/mochajs/mocha/issues/3134
@@ -287,9 +384,9 @@ For more info, please [read this article](https://boneskull.com/mocha-v4-nears-r
 - Various CI-and-test-related fixes and improvements ([@boneskull], [@dasilvacontin], [@PopradiArpad], [@Munter], [@ScottFreeCode])
 - "Officially" support Node.js 8 ([@elergy])
 
-[#2860]: https://github.com/mochajs/mocha/pulls/2860
-[#2696]: https://github.com/mochajs/mocha/pulls/2696
-[#2813]: https://github.com/mochajs/mocha/pulls/2813
+[#2860]: https://github.com/mochajs/mocha/pull/2860
+[#2696]: https://github.com/mochajs/mocha/pull/2696
+[#2813]: https://github.com/mochajs/mocha/pull/2813
 [@charlierudolph]: https://github.com/charlierudolph
 [@PopradiArpad]: https://github.com/PopradiArpad
 [@kungapal]: https://github.com/kungapal
@@ -311,7 +408,7 @@ For more info, please [read this article](https://boneskull.com/mocha-v4-nears-r
 [@makepanic]: https://github.com/makepanic
 [@Munter]: https://github.com/Munter
 
-[#2778]: https://github.com/mochajs/mocha/pulls/2778
+[#2778]: https://github.com/mochajs/mocha/pull/2778
 [#2802]: https://github.com/mochajs/mocha/issues/2802
 [#2820]: https://github.com/mochajs/mocha/pull/2820
 

package/README.md

@@ -1,39 +1,3 @@
-# Mocha needs YOU!
-
-*Did you know* Mocha [is a dependency of over 100,000 projects](https://libraries.io/npm/mocha) published to npm alone?
-
-**Despite this, we're currently unable to merge most pull requests due to lack of maintenance resources.**
-
-**Are you interested in triaging issues or reviewing open PRs?  Have some time to hack on its codebase?**  If you would like to help maintain Mocha, please contact `@boneskull` on [Gitter](https://gitter.im/mochajs/mocha).
-
-*Thank you* :kissing_heart: to all of you interested in helping.  These are Mocha's immediate needs:
-
-1. Increase test coverage on Node.js and browser
-   - Increase integration coverage for all reporters
-     - `html` reporter must be tested in browser
-     - ~~Basic console reporters (*not* `nyan`, `landing`, etc.) must be tested in **both** browser and Node.js contexts~~
-     - ~~Filesystem-based reporters must be tested in Node.js context~~
-     - **UPDATE - May 24 2017**: Thanks to [community contributions](https://github.com/mochajs/mocha/blob/master/CHANGELOG.md#mag-coverage), the coverage on most reporters has increased dramatically!  The `html` reporter is still in [dire need of coverage](https://coveralls.io/builds/11674428/source?filename=lib%2Freporters%2Fhtml.js).
-   - Increase coverage against all interfaces (`exports` in particular).  Ideally this becomes a "matrix" where we repeat sets of integration tests across all interfaces.
-   - Refactor non-Node.js-specific tests to allow them to run in a browser context.  Node.js-specific tests include those which *require* the CLI or filesystem.  Most everything else is fair game.
-1. 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](https://cla.js.foundation/mochajs/mocha).
-1. 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).
-1. Triage issues
-   - If we run into "critical" bugs, they need fixing.
-   - "Critical" means Mocha is broken w/o workarounds for a *large percentage* of users
-   - Otherwise: respond to issues, close new dupe issues, confirm bugs, ask for more info, etc.
-
-Once we gain ground on the above items, we can work together formalize our contribution guidelines and governance.  For further info & ideas, please see our [projects](https://github.com/mochajs/mocha/projects/).
-
-*You needn't be a maintainer to submit a pull request for test coverage!*
-
--- @boneskull, *Jan 17 2016*
-
-<br><br>
 <p align="center">
   <img src="https://cldup.com/xFVFxOioAU.svg" alt="Mocha test framework"/>
 </p>
@@ -47,11 +11,12 @@ Once we gain ground on the above items, we can work together formalize our contr
 
 ## Links
 
-- [Documentation](http://mochajs.org)
-- [Changelog](https://github.com/mochajs/mocha/blob/master/CHANGELOG.md)
-- [Google Group](http://groups.google.com/group/mochajs)
-- [Wiki](https://github.com/mochajs/mocha/wiki)
-- Mocha [Extensions and reporters](https://github.com/mochajs/mocha/wiki)
+- **[Documentation](https://mochajs.org)**
+- **[Release Notes / History / Changes](https://github.com/mochajs/mocha/blob/master/CHANGELOG.md)**
+- [Code of Conduct](https://github.com/mochajs/mocha/blob/master/.github/CODE_OF_CONDUCT.md)
+- [Gitter Chatroom](https://gitter.im/mochajs/mocha) (ask questions here!)
+- [Google Group](https://groups.google.com/group/mochajs)
+- [Issue Tracker](https://github.com/mochajs/mocha/issues)
 
 ## Backers
 
@@ -113,6 +78,25 @@ Does your company use Mocha?  Ask your manager or marketing team if your company
 [![MochaJS Backer](https://opencollective.com/mochajs/sponsor/18/avatar)](https://opencollective.com/mochajs/sponsor/18/website)
 [![MochaJS Backer](https://opencollective.com/mochajs/sponsor/19/avatar)](https://opencollective.com/mochajs/sponsor/19/website)
 
+## Development
+
+You might want to know that:
+
+- Mocha is the *most-depended-upon* module on npm (source: [libraries.io](https://libraries.io/search?order=desc&platforms=NPM&sort=dependents_count)), and
+- Mocha is an *independent* open-source project, maintained exclusively by volunteers.
+
+You might want to help:
+
+- New to contributing to Mocha?  Check out this list of [good first issues](https://github.com/mochajs/mocha/issues?q=is%3Aissue+is%3Aopen+label%3Agood-first-issue)
+- Mocha could use a hand with [these issues](https://github.com/mochajs/mocha/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)
+- The [maintainer's handbook](https://github.com/mochajs/mocha/blob/master/MAINTAINERS.md) explains how things get done
+
+Finally, come [chat with the maintainers](https://gitter.im/mochajs/contributors) on Gitter if you want to help with:
+
+- Triaging issues, answering questions
+- Review, merging, and closing pull requests
+- Other project-maintenance-y things
+
 ## License
 
 [MIT](LICENSE)

package/lib/interfaces/common.js

@@ -113,6 +113,8 @@ module.exports = function (suites, context, mocha) {
           suites.shift();
         } else if (typeof opts.fn === 'undefined' && !suite.pending) {
           throw new Error('Suite "' + suite.fullTitle() + '" was defined but no callback was supplied. Supply a callback or explicitly skip the suite.');
+        } else if (!opts.fn && suite.pending) {
+          suites.shift();
         }
 
         return suite;

package/lib/reporters/base.js

@@ -166,6 +166,22 @@ function stringifyDiffObjs (err) {
   }
 }
 
+/**
+ * Returns a diff between 2 strings with coloured ANSI output.
+ *
+ * The diff will be either inline or unified dependant on the value
+ * of `Base.inlineDiff`.
+ *
+ * @param {string} actual
+ * @param {string} expected
+ * @return {string} Diff
+ */
+var generateDiff = exports.generateDiff = function (actual, expected) {
+  return exports.inlineDiffs
+    ? inlineDiff(actual, expected)
+    : unifiedDiff(actual, expected);
+};
+
 /**
  * Output the given `failures` as a list.
  *
@@ -215,11 +231,7 @@ exports.list = function (failures) {
       var match = message.match(/^([^:]+): expected/);
       msg = '\n      ' + color('error message', match ? match[1] : msg);
 
-      if (exports.inlineDiffs) {
-        msg += inlineDiff(err);
-      } else {
-        msg += unifiedDiff(err);
-      }
+      msg += generateDiff(err.actual, err.expected);
     }
 
     // indent stack trace
@@ -302,7 +314,7 @@ function Base (runner) {
     failures.push(test);
   });
 
-  runner.on('end', function () {
+  runner.once('end', function () {
     stats.end = new Date();
     stats.duration = stats.end - stats.start;
   });
@@ -368,14 +380,15 @@ function pad (str, len) {
 }
 
 /**
- * Returns an inline diff between 2 strings with coloured ANSI output
+ * Returns an inline diff between 2 strings with coloured ANSI output.
  *
  * @api private
- * @param {Error} err with actual/expected
+ * @param {String} actual
+ * @param {String} expected
  * @return {string} Diff
  */
-function inlineDiff (err) {
-  var msg = errorDiff(err);
+function inlineDiff (actual, expected) {
+  var msg = errorDiff(actual, expected);
 
   // linenos
   var lines = msg.split('\n');
@@ -401,13 +414,14 @@ function inlineDiff (err) {
 }
 
 /**
- * Returns a unified diff between two strings.
+ * Returns a unified diff between two strings with coloured ANSI output.
  *
  * @api private
- * @param {Error} err with actual/expected
+ * @param {String} actual
+ * @param {String} expected
  * @return {string} The diff.
  */
-function unifiedDiff (err) {
+function unifiedDiff (actual, expected) {
   var indent = '      ';
   function cleanUp (line) {
     if (line[0] === '+') {
@@ -427,7 +441,7 @@ function unifiedDiff (err) {
   function notBlank (line) {
     return typeof line !== 'undefined' && line !== null;
   }
-  var msg = diff.createPatch('string', err.actual, err.expected);
+  var msg = diff.createPatch('string', actual, expected);
   var lines = msg.split('\n').splice(5);
   return '\n      ' +
     colorLines('diff added', '+ expected') + ' ' +
@@ -440,11 +454,12 @@ function unifiedDiff (err) {
  * Return a character diff for `err`.
  *
  * @api private
- * @param {Error} err
- * @return {string}
+ * @param {String} actual
+ * @param {String} expected
+ * @return {string} the diff
  */
-function errorDiff (err) {
-  return diff.diffWordsWithSpace(err.actual, err.expected).map(function (str) {
+function errorDiff (actual, expected) {
+  return diff.diffWordsWithSpace(actual, expected).map(function (str) {
     if (str.added) {
       return colorLines('diff added', str.value);
     }

package/lib/reporters/dot.js

@@ -56,7 +56,7 @@ function Dot (runner) {
     process.stdout.write(color('fail', Base.symbols.bang));
   });
 
-  runner.on('end', function () {
+  runner.once('end', function () {
     console.log();
     self.epilogue();
   });

package/lib/reporters/json-stream.js

@@ -39,7 +39,7 @@ function List (runner) {
     console.log(JSON.stringify(['fail', test]));
   });
 
-  runner.on('end', function () {
+  runner.once('end', function () {
     process.stdout.write(JSON.stringify(['end', self.stats]));
   });
 }

package/lib/reporters/json.js

@@ -43,7 +43,7 @@ function JSONReporter (runner) {
     pending.push(test);
   });
 
-  runner.on('end', function () {
+  runner.once('end', function () {
     var obj = {
       stats: self.stats,
       tests: tests.map(clean),

package/lib/reporters/landing.js

@@ -81,7 +81,7 @@ function Landing (runner) {
     stream.write('\u001b[0m');
   });
 
-  runner.on('end', function () {
+  runner.once('end', function () {
     cursor.show();
     console.log();
     self.epilogue();

package/lib/reporters/list.js

@@ -54,7 +54,7 @@ function List (runner) {
     console.log(color('fail', '  %d) %s'), ++n, test.fullTitle());
   });
 
-  runner.on('end', self.epilogue.bind(self));
+  runner.once('end', self.epilogue.bind(self));
 }
 
 /**

package/lib/reporters/markdown.js

@@ -91,7 +91,7 @@ function Markdown (runner) {
     buf += '```\n\n';
   });
 
-  runner.on('end', function () {
+  runner.once('end', function () {
     process.stdout.write('# TOC\n');
     process.stdout.write(generateTOC(runner.suite));
     process.stdout.write(buf);

package/lib/reporters/min.js

@@ -29,7 +29,7 @@ function Min (runner) {
     process.stdout.write('\u001b[1;3H');
   });
 
-  runner.on('end', this.epilogue.bind(this));
+  runner.once('end', this.epilogue.bind(this));
 }
 
 /**

package/lib/reporters/nyan.js

@@ -52,7 +52,7 @@ function NyanCat (runner) {
     self.draw();
   });
 
-  runner.on('end', function () {
+  runner.once('end', function () {
     Base.cursor.show();
     for (var i = 0; i < self.numberOfLines; i++) {
       write('\n');

package/lib/reporters/progress.js

@@ -80,7 +80,7 @@ function Progress (runner, options) {
 
   // tests are complete, output some stats
   // and the failures if any
-  runner.on('end', function () {
+  runner.once('end', function () {
     cursor.show();
     console.log();
     self.epilogue();

package/lib/reporters/spec.js

@@ -72,7 +72,7 @@ function Spec (runner) {
     console.log(indent() + color('fail', '  %d) %s'), ++n, test.title);
   });
 
-  runner.on('end', self.epilogue.bind(self));
+  runner.once('end', self.epilogue.bind(self));
 }
 
 /**

package/lib/reporters/tap.js

@@ -51,7 +51,7 @@ function TAP (runner) {
     }
   });
 
-  runner.on('end', function () {
+  runner.once('end', function () {
     console.log('# tests ' + (passes + failures));
     console.log('# pass ' + passes);
     console.log('# fail ' + failures);

package/lib/reporters/xunit.js

@@ -78,7 +78,7 @@ function XUnit (runner, options) {
     tests.push(test);
   });
 
-  runner.on('end', function () {
+  runner.once('end', function () {
     self.write(tag('testsuite', {
       name: suiteName,
       tests: stats.tests,

package/lib/runnable.js

@@ -103,7 +103,7 @@ Runnable.prototype.slow = function (ms) {
   if (typeof ms === 'string') {
     ms = milliseconds(ms);
   }
-  debug('timeout %d', ms);
+  debug('slow %d', ms);
   this._slow = ms;
   return this;
 };
@@ -142,6 +142,24 @@ Runnable.prototype.isPending = function () {
   return this.pending || (this.parent && this.parent.isPending());
 };
 
+/**
+ * Return `true` if this Runnable has failed.
+ * @return {boolean}
+ * @private
+ */
+Runnable.prototype.isFailed = function () {
+  return !this.isPending() && this.state === 'failed';
+};
+
+/**
+ * Return `true` if this Runnable has passed.
+ * @return {boolean}
+ * @private
+ */
+Runnable.prototype.isPassed = function () {
+  return !this.isPending() && this.state === 'passed';
+};
+
 /**
  * Set or get number of retries.
  *

package/lib/runner.js

@@ -265,10 +265,10 @@ Runner.prototype.failHook = function (hook, err) {
     hook.title = hook.originalTitle + ' for "' + hook.ctx.currentTest.title + '"';
   }
 
-  this.fail(hook, err);
   if (this.suite.bail()) {
     this.emit('end');
   }
+  this.fail(hook, err);
 };
 
 /**
@@ -726,21 +726,25 @@ Runner.prototype.uncaught = function (err) {
 
   runnable.clearTimeout();
 
-  // Ignore errors if complete or pending
-  if (runnable.state || runnable.isPending()) {
+  // Ignore errors if already failed or pending
+  // See #3226
+  if (runnable.isFailed() || runnable.isPending()) {
     return;
   }
+  // we cannot recover gracefully if a Runnable has already passed
+  // then fails asynchronously
+  var alreadyPassed = runnable.isPassed();
+  // this will change the state to "failed" regardless of the current value
   this.fail(runnable, err);
+  if (!alreadyPassed) {
+    // recover from test
+    if (runnable.type === 'test') {
+      this.emit('test end', runnable);
+      this.hookUp('afterEach', this.next);
+      return;
+    }
 
-  // recover from test
-  if (runnable.type === 'test') {
-    this.emit('test end', runnable);
-    this.hookUp('afterEach', this.next);
-    return;
-  }
-
-  // recover from hooks
-  if (runnable.type === 'hook') {
+    // recover from hooks
     var errSuite = this.suite;
     // if hook failure is in afterEach block
     if (runnable.fullTitle().indexOf('after each') > -1) {