mocha 10.6.0 → 10.7.0

package/README.md

@@ -7,7 +7,6 @@
 <p align="center">
 <a href="https://github.com/mochajs/mocha/actions?query=workflow%3ATests+branch%3Amain"><img src="https://github.com/mochajs/mocha/workflows/Tests/badge.svg?branch=main" alt="GitHub Actions Build Status"></a>
 <a href="https://coveralls.io/github/mochajs/mocha"><img src="https://coveralls.io/repos/github/mochajs/mocha/badge.svg" alt="Coverage Status"></a>
-<a href="https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fmochajs%2Fmocha?ref=badge_shield"><img src="https://app.fossa.io/api/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fmochajs%2Fmocha.svg?type=shield" alt="FOSSA Status"></a>
 <a href="https://discord.gg/KeDn2uXhER"><img alt="Chat - Discord" src="https://img.shields.io/badge/chat-Discord-5765F2.svg" /></a>
 <a href="https://github.com/mochajs/mocha#sponsors"><img src="https://opencollective.com/mochajs/tiers/sponsors/badge.svg" alt="OpenCollective Sponsors"></a>
 <a href="https://github.com/mochajs/mocha#backers"><img src="https://opencollective.com/mochajs/tiers/backers/badge.svg" alt="OpenCollective Backers"></a>

package/lib/cli/run-helpers.js

@@ -21,25 +21,24 @@ const {UnmatchedFile} = require('./collect-files');
 
 /**
  * Exits Mocha when tests + code under test has finished execution (default)
- * @param {number} code - Exit code; typically # of failures
+ * @param {number} clampedCode - Exit code; typically # of failures
  * @ignore
  * @private
  */
-const exitMochaLater = code => {
+const exitMochaLater = clampedCode => {
   process.on('exit', () => {
-    process.exitCode = Math.min(code, 255);
+    process.exitCode = clampedCode;
   });
 };
 
 /**
  * Exits Mocha when Mocha itself has finished execution, regardless of
  * what the tests or code under test is doing.
- * @param {number} code - Exit code; typically # of failures
+ * @param {number} clampedCode - Exit code; typically # of failures
  * @ignore
  * @private
  */
-const exitMocha = code => {
-  const clampedCode = Math.min(code, 255);
+const exitMocha = clampedCode => {
   let draining = 0;
 
   // Eagerly set the process's exit code in case stream.write doesn't
@@ -139,12 +138,17 @@ const handleUnmatchedFiles = (mocha, unmatchedFiles) => {
  * @param {Mocha} mocha - Mocha instance
  * @param {Options} [opts] - Command line options
  * @param {boolean} [opts.exit] - Whether or not to force-exit after tests are complete
+ * @param {boolean} [opts.passOnFailingTestSuite] - Whether or not to fail test run if tests were failed
  * @param {Object} fileCollectParams - Parameters that control test
  *   file collection. See `lib/cli/collect-files.js`.
  * @returns {Promise<Runner>}
  * @private
  */
-const singleRun = async (mocha, {exit}, fileCollectParams) => {
+const singleRun = async (
+  mocha,
+  {exit, passOnFailingTestSuite},
+  fileCollectParams
+) => {
   const fileCollectionObj = collectFiles(fileCollectParams);
 
   if (fileCollectionObj.unmatchedFiles.length > 0) {
@@ -156,7 +160,9 @@ const singleRun = async (mocha, {exit}, fileCollectParams) => {
 
   // handles ESM modules
   await mocha.loadFilesAsync();
-  return mocha.run(exit ? exitMocha : exitMochaLater);
+  return mocha.run(
+    createExitHandler({exit, passOnFailingTestSuite})
+  );
 };
 
 /**
@@ -186,7 +192,9 @@ const parallelRun = async (mocha, options, fileCollectParams) => {
   mocha.files = fileCollectionObj.files;
 
   // note that we DO NOT load any files here; this is handled by the worker
-  return mocha.run(options.exit ? exitMocha : exitMochaLater);
+  return mocha.run(
+    createExitHandler(options)
+  );
 };
 
 /**
@@ -282,3 +290,15 @@ exports.validateLegacyPlugin = (opts, pluginType, map = {}) => {
     }
   }
 };
+
+const createExitHandler = ({ exit, passOnFailingTestSuite }) => {
+  return code => {
+    const clampedCode = passOnFailingTestSuite
+      ? 0
+      : Math.min(code, 255);
+
+    return exit
+      ? exitMocha(clampedCode)
+      : exitMochaLater(clampedCode);
+  };
+};

package/lib/cli/run-option-metadata.js

@@ -35,6 +35,7 @@ const TYPES = (exports.types = {
     'diff',
     'dry-run',
     'exit',
+    'pass-on-failing-test-suite',
     'fail-zero',
     'forbid-only',
     'forbid-pending',

package/lib/cli/run.js

@@ -98,6 +98,11 @@ exports.builder = yargs =>
         requiresArg: true,
         coerce: list
       },
+      'pass-on-failing-test-suite': {
+        default: false,
+        description: 'Not fail test run if tests were failed',
+        group: GROUPS.RULES
+      },
       'fail-zero': {
         description: 'Fail test run if no test(s) encountered',
         group: GROUPS.RULES

package/lib/mocha.js

@@ -157,6 +157,7 @@ exports.run = function (...args) {
  * @param {boolean} [options.delay] - Delay root suite execution?
  * @param {boolean} [options.diff] - Show diff on failure?
  * @param {boolean} [options.dryRun] - Report tests without running them?
+ * @param {boolean} [options.passOnFailingTestSuite] - Fail test run if tests were failed?
  * @param {boolean} [options.failZero] - Fail test run if zero tests?
  * @param {string} [options.fgrep] - Test filter given string.
  * @param {boolean} [options.forbidOnly] - Tests marked `only` fail the suite?
@@ -216,6 +217,7 @@ function Mocha(options = {}) {
     'delay',
     'diff',
     'dryRun',
+    'passOnFailingTestSuite',
     'failZero',
     'forbidOnly',
     'forbidPending',
@@ -870,6 +872,20 @@ Mocha.prototype.failZero = function (failZero) {
   return this;
 };
 
+/**
+ * Fail test run if tests were failed.
+ *
+ * @public
+ * @see [CLI option](../#-pass-on-failing-test-suite)
+ * @param {boolean} [passOnFailingTestSuite=false] - Whether to fail test run.
+ * @return {Mocha} this
+ * @chainable
+ */
+Mocha.prototype.passOnFailingTestSuite = function(passOnFailingTestSuite) {
+  this.options.passOnFailingTestSuite = passOnFailingTestSuite === true;
+  return this;
+};
+
 /**
  * Causes tests marked `only` to fail the suite.
  *

package/lib/runnable.js

@@ -20,6 +20,8 @@ var setTimeout = global.setTimeout;
 var clearTimeout = global.clearTimeout;
 var toString = Object.prototype.toString;
 
+var MAX_TIMEOUT = Math.pow(2, 31) - 1;
+
 module.exports = Runnable;
 
 /**
@@ -95,8 +97,7 @@ Runnable.prototype.timeout = function (ms) {
   }
 
   // Clamp to range
-  var INT_MAX = Math.pow(2, 31) - 1;
-  var range = [0, INT_MAX];
+  var range = [0, MAX_TIMEOUT];
   ms = utils.clamp(ms, range);
 
   // see #1652 for reasoning
@@ -233,11 +234,8 @@ Runnable.prototype.clearTimeout = function () {
  */
 Runnable.prototype.resetTimeout = function () {
   var self = this;
-  var ms = this.timeout();
+  var ms = this.timeout() || MAX_TIMEOUT;
 
-  if (ms === 0) {
-    return;
-  }
   this.clearTimeout();
   this.timer = setTimeout(function () {
     if (self.timeout() === 0) {

package/lib/utils.js

@@ -138,7 +138,7 @@ function emptyRepresentation(value, typeHint) {
  * canonicalType(global) // 'global'
  * canonicalType(new String('foo') // 'object'
  * canonicalType(async function() {}) // 'asyncfunction'
- * canonicalType(await import(name)) // 'module'
+ * canonicalType(Object.create(null)) // 'null-prototype'
  */
 var canonicalType = (exports.canonicalType = function canonicalType(value) {
   if (value === undefined) {
@@ -147,7 +147,10 @@ var canonicalType = (exports.canonicalType = function canonicalType(value) {
     return 'null';
   } else if (Buffer.isBuffer(value)) {
     return 'buffer';
+  } else if (Object.getPrototypeOf(value) === null) {
+    return 'null-prototype';
   }
+
   return Object.prototype.toString
     .call(value)
     .replace(/^\[.+\s(.+?)]$/, '$1')
@@ -213,7 +216,7 @@ exports.type = function type(value) {
 exports.stringify = function (value) {
   var typeHint = canonicalType(value);
 
-  if (!~['object', 'array', 'function'].indexOf(typeHint)) {
+  if (!~['object', 'array', 'function', 'null-prototype'].indexOf(typeHint)) {
     if (typeHint === 'buffer') {
       var json = Buffer.prototype.toJSON.call(value);
       // Based on the toJSON result
@@ -399,8 +402,12 @@ exports.canonicalize = function canonicalize(value, stack, typeHint) {
         break;
       }
     /* falls through */
+    case 'null-prototype':
     case 'object':
       canonicalizedObj = canonicalizedObj || {};
+      if (typeHint === 'null-prototype' && Symbol.toStringTag in value) {
+        canonicalizedObj['[Symbol.toStringTag]'] = value[Symbol.toStringTag];
+      }
       withStack(value, function () {
         Object.keys(value)
           .sort()

package/mocha.js

@@ -1,4 +1,4 @@
-// mocha@10.6.0 in javascript ES2018
+// mocha@10.7.0 in javascript ES2018
 (function (global, factory) {
   typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() :
   typeof define === 'function' && define.amd ? define(factory) :
@@ -11101,7 +11101,7 @@
    * canonicalType(global) // 'global'
    * canonicalType(new String('foo') // 'object'
    * canonicalType(async function() {}) // 'asyncfunction'
-   * canonicalType(await import(name)) // 'module'
+   * canonicalType(Object.create(null)) // 'null-prototype'
    */
   var canonicalType = (exports.canonicalType = function canonicalType(value) {
     if (value === undefined) {
@@ -11110,7 +11110,10 @@
       return 'null';
     } else if (isBuffer(value)) {
       return 'buffer';
+    } else if (Object.getPrototypeOf(value) === null) {
+      return 'null-prototype';
     }
+
     return Object.prototype.toString
       .call(value)
       .replace(/^\[.+\s(.+?)]$/, '$1')
@@ -11176,7 +11179,7 @@
   exports.stringify = function (value) {
     var typeHint = canonicalType(value);
 
-    if (!~['object', 'array', 'function'].indexOf(typeHint)) {
+    if (!~['object', 'array', 'function', 'null-prototype'].indexOf(typeHint)) {
       if (typeHint === 'buffer') {
         var json = Buffer.prototype.toJSON.call(value);
         // Based on the toJSON result
@@ -11362,8 +11365,12 @@
           break;
         }
       /* falls through */
+      case 'null-prototype':
       case 'object':
         canonicalizedObj = canonicalizedObj || {};
+        if (typeHint === 'null-prototype' && Symbol.toStringTag in value) {
+          canonicalizedObj['[Symbol.toStringTag]'] = value[Symbol.toStringTag];
+        }
         withStack(value, function () {
           Object.keys(value)
             .sort()
@@ -12960,6 +12967,8 @@
   var clearTimeout$1 = commonjsGlobal.clearTimeout;
   var toString = Object.prototype.toString;
 
+  var MAX_TIMEOUT = Math.pow(2, 31) - 1;
+
   var runnable = Runnable$3;
 
   /**
@@ -13035,8 +13044,7 @@
     }
 
     // Clamp to range
-    var INT_MAX = Math.pow(2, 31) - 1;
-    var range = [0, INT_MAX];
+    var range = [0, MAX_TIMEOUT];
     ms = utils$2.clamp(ms, range);
 
     // see #1652 for reasoning
@@ -13173,11 +13181,8 @@
    */
   Runnable$3.prototype.resetTimeout = function () {
     var self = this;
-    var ms = this.timeout();
+    var ms = this.timeout() || MAX_TIMEOUT;
 
-    if (ms === 0) {
-      return;
-    }
     this.clearTimeout();
     this.timer = setTimeout$2(function () {
       if (self.timeout() === 0) {
@@ -19169,7 +19174,7 @@
   };
 
   var name = "mocha";
-  var version = "10.6.0";
+  var version = "10.7.0";
   var homepage = "https://mochajs.org/";
   var notifyLogo = "https://ibin.co/4QuRuGjXvl36.png";
   var require$$17 = {
@@ -19338,6 +19343,7 @@
    * @param {boolean} [options.delay] - Delay root suite execution?
    * @param {boolean} [options.diff] - Show diff on failure?
    * @param {boolean} [options.dryRun] - Report tests without running them?
+   * @param {boolean} [options.passOnFailingTestSuite] - Fail test run if tests were failed?
    * @param {boolean} [options.failZero] - Fail test run if zero tests?
    * @param {string} [options.fgrep] - Test filter given string.
    * @param {boolean} [options.forbidOnly] - Tests marked `only` fail the suite?
@@ -19397,6 +19403,7 @@
       'delay',
       'diff',
       'dryRun',
+      'passOnFailingTestSuite',
       'failZero',
       'forbidOnly',
       'forbidPending',
@@ -20051,6 +20058,20 @@
     return this;
   };
 
+  /**
+   * Fail test run if tests were failed.
+   *
+   * @public
+   * @see [CLI option](../#-pass-on-failing-test-suite)
+   * @param {boolean} [passOnFailingTestSuite=false] - Whether to fail test run.
+   * @return {Mocha} this
+   * @chainable
+   */
+  Mocha.prototype.passOnFailingTestSuite = function(passOnFailingTestSuite) {
+    this.options.passOnFailingTestSuite = passOnFailingTestSuite === true;
+    return this;
+  };
+
   /**
    * Causes tests marked `only` to fail the suite.
    *