mocha 10.6.1 → 10.7.3

package/lib/cli/commands.js

@@ -7,7 +7,8 @@
  * @module
  */
 
-exports.init = require('./init');
-
-// default command
-exports.run = require('./run');
+module.exports = {
+  init: require('./init'),
+  // default command
+  run: require('./run'),
+}

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

@@ -24,7 +24,7 @@ const {
 } = require('./run-helpers');
 const {ONE_AND_DONES, ONE_AND_DONE_ARGS} = require('./one-and-dones');
 const debug = require('debug')('mocha:cli:run');
-const defaults = require('../mocharc');
+const defaults = require('../mocharc.json');
 const {types, aliases} = require('./run-option-metadata');
 
 /**
@@ -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/nodejs/serializer.js

@@ -259,7 +259,7 @@ class SerializableEvent {
     });
 
     // mutates the object
-    breakCircularDeps(result);
+    breakCircularDeps(result.error);
 
     const pairs = Object.keys(result).map(key => [result, key]);
 

package/mocha.js

@@ -1,4 +1,4 @@
-// mocha@10.6.1 in javascript ES2018
+// mocha@10.7.3 in javascript ES2018
 (function (global, factory) {
   typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() :
   typeof define === 'function' && define.amd ? define(factory) :
@@ -19174,7 +19174,7 @@
   };
 
   var name = "mocha";
-  var version = "10.6.1";
+  var version = "10.7.3";
   var homepage = "https://mochajs.org/";
   var notifyLogo = "https://ibin.co/4QuRuGjXvl36.png";
   var require$$17 = {
@@ -19343,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?
@@ -19402,6 +19403,7 @@
       'delay',
       'diff',
       'dryRun',
+      'passOnFailingTestSuite',
       'failZero',
       'forbidOnly',
       'forbidPending',
@@ -20056,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.
    *