mocha-compat 3.6.4 → 10.8.2

package/lib/interfaces/bdd.js

@@ -1,10 +1,8 @@
 'use strict';
 
-/**
- * Module dependencies.
- */
-
 var Test = require('../test');
+var EVENT_FILE_PRE_REQUIRE =
+  require('../suite').constants.EVENT_FILE_PRE_REQUIRE;
 
 /**
  * BDD-style interface:
@@ -23,10 +21,10 @@ var Test = require('../test');
  *
  * @param {Suite} suite Root suite.
  */
-module.exports = function (suite) {
+module.exports = function bddInterface(suite) {
   var suites = [suite];
 
-  suite.on('pre-require', function (context, file, mocha) {
+  suite.on(EVENT_FILE_PRE_REQUIRE, function (context, file, mocha) {
     var common = require('./common')(suites, context, mocha);
 
     context.before = common.before;
@@ -42,9 +40,9 @@ module.exports = function (suite) {
 
     context.describe = context.context = function (title, fn) {
       return common.suite.create({
-        title: title,
-        file: file,
-        fn: fn
+        title,
+        file,
+        fn
       });
     };
 
@@ -52,13 +50,16 @@ module.exports = function (suite) {
      * Pending describe.
      */
 
-    context.xdescribe = context.xcontext = context.describe.skip = function (title, fn) {
-      return common.suite.skip({
-        title: title,
-        file: file,
-        fn: fn
-      });
-    };
+    context.xdescribe =
+      context.xcontext =
+      context.describe.skip =
+        function (title, fn) {
+          return common.suite.skip({
+            title,
+            file,
+            fn
+          });
+        };
 
     /**
      * Exclusive suite.
@@ -66,9 +67,9 @@ module.exports = function (suite) {
 
     context.describe.only = function (title, fn) {
       return common.suite.only({
-        title: title,
-        file: file,
-        fn: fn
+        title,
+        file,
+        fn
       });
     };
 
@@ -101,15 +102,13 @@ module.exports = function (suite) {
      * Pending test case.
      */
 
-    context.xit = context.xspecify = context.it.skip = function (title) {
-      context.it(title);
-    };
-
-    /**
-     * Number of attempts to retry.
-     */
-    context.it.retries = function (n) {
-      context.retries(n);
-    };
+    context.xit =
+      context.xspecify =
+      context.it.skip =
+        function (title) {
+          return context.it(title);
+        };
   });
 };
+
+module.exports.description = 'BDD or RSpec style [default]';

package/lib/interfaces/common.js

@@ -1,16 +1,41 @@
 'use strict';
 
+/**
+ @module interfaces/common
+*/
+
 var Suite = require('../suite');
+var errors = require('../errors');
+var createMissingArgumentError = errors.createMissingArgumentError;
+var createUnsupportedError = errors.createUnsupportedError;
+var createForbiddenExclusivityError = errors.createForbiddenExclusivityError;
 
 /**
  * Functions common to more than one interface.
  *
+ * @private
  * @param {Suite[]} suites
  * @param {Context} context
  * @param {Mocha} mocha
  * @return {Object} An object containing common functions.
  */
 module.exports = function (suites, context, mocha) {
+  /**
+   * Check if the suite should be tested.
+   *
+   * @private
+   * @param {Suite} suite - suite to check
+   * @returns {boolean}
+   */
+  function shouldBeTested(suite) {
+    return (
+      !mocha.options.grep ||
+      (mocha.options.grep &&
+        mocha.options.grep.test(suite.fullTitle()) &&
+        !mocha.options.invert)
+    );
+  }
+
   return {
     /**
      * This is only present if flag --delay is passed into Mocha. It triggers
@@ -19,8 +44,8 @@ module.exports = function (suites, context, mocha) {
      * @param {Suite} suite The root suite.
      * @return {Function} A function which runs the root suite
      */
-    runWithSuite: function runWithSuite (suite) {
-      return function run () {
+    runWithSuite: function runWithSuite(suite) {
+      return function run() {
         suite.run();
       };
     },
@@ -73,8 +98,10 @@ module.exports = function (suites, context, mocha) {
        * @param {Object} opts
        * @returns {Suite}
        */
-      only: function only (opts) {
-        mocha.options.hasOnly = true;
+      only: function only(opts) {
+        if (mocha.options.forbidOnly) {
+          throw createForbiddenExclusivityError(mocha);
+        }
         opts.isOnly = true;
         return this.create(opts);
       },
@@ -86,13 +113,14 @@ module.exports = function (suites, context, mocha) {
        * @param {Object} opts
        * @returns {Suite}
        */
-      skip: function skip (opts) {
+      skip: function skip(opts) {
         opts.pending = true;
         return this.create(opts);
       },
 
       /**
        * Creates a suite.
+       *
        * @param {Object} opts Options
        * @param {string} opts.title Title of Suite
        * @param {Function} [opts.fn] Suite Function (not always applicable)
@@ -101,20 +129,35 @@ module.exports = function (suites, context, mocha) {
        * @param {boolean} [opts.isOnly] Is Suite exclusive?
        * @returns {Suite}
        */
-      create: function create (opts) {
+      create: function create(opts) {
         var suite = Suite.create(suites[0], opts.title);
         suite.pending = Boolean(opts.pending);
         suite.file = opts.file;
         suites.unshift(suite);
         if (opts.isOnly) {
-          suite.parent._onlySuites = suite.parent._onlySuites.concat(suite);
-          mocha.options.hasOnly = true;
+          suite.markOnly();
+        }
+        if (
+          suite.pending &&
+          mocha.options.forbidPending &&
+          shouldBeTested(suite)
+        ) {
+          throw createUnsupportedError('Pending test forbidden');
         }
         if (typeof opts.fn === 'function') {
           opts.fn.call(suite);
           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.');
+          throw createMissingArgumentError(
+            'Suite "' +
+              suite.fullTitle() +
+              '" was defined but no callback was supplied. ' +
+              'Supply a callback or explicitly skip the suite.',
+            'callback',
+            'function'
+          );
+        } else if (!opts.fn && suite.pending) {
+          suites.shift();
         }
 
         return suite;
@@ -122,7 +165,6 @@ module.exports = function (suites, context, mocha) {
     },
 
     test: {
-
       /**
        * Exclusive test-case.
        *
@@ -131,8 +173,10 @@ module.exports = function (suites, context, mocha) {
        * @returns {*}
        */
       only: function (mocha, test) {
-        test.parent._onlyTests = test.parent._onlyTests.concat(test);
-        mocha.options.hasOnly = true;
+        if (mocha.options.forbidOnly) {
+          throw createForbiddenExclusivityError(mocha);
+        }
+        test.markOnly();
         return test;
       },
 
@@ -143,15 +187,6 @@ module.exports = function (suites, context, mocha) {
        */
       skip: function (title) {
         context.test(title);
-      },
-
-      /**
-       * Number of retry attempts
-       *
-       * @param {number} n
-       */
-      retries: function (n) {
-        context.retries(n);
       }
     }
   };

package/lib/interfaces/exports.js

@@ -1,9 +1,4 @@
 'use strict';
-
-/**
- * Module dependencies.
- */
-
 var Suite = require('../suite');
 var Test = require('../test');
 
@@ -27,9 +22,9 @@ var Test = require('../test');
 module.exports = function (suite) {
   var suites = [suite];
 
-  suite.on('require', visit);
+  suite.on(Suite.constants.EVENT_FILE_REQUIRE, visit);
 
-  function visit (obj, file) {
+  function visit(obj, file) {
     var suite;
     for (var key in obj) {
       if (typeof obj[key] === 'function') {
@@ -61,3 +56,5 @@ module.exports = function (suite) {
     }
   }
 };
+
+module.exports.description = 'Node.js module ("exports") style';

package/lib/interfaces/qunit.js

@@ -1,10 +1,8 @@
 'use strict';
 
-/**
- * Module dependencies.
- */
-
 var Test = require('../test');
+var EVENT_FILE_PRE_REQUIRE =
+  require('../suite').constants.EVENT_FILE_PRE_REQUIRE;
 
 /**
  * QUnit-style interface:
@@ -31,10 +29,10 @@ var Test = require('../test');
  *
  * @param {Suite} suite Root suite.
  */
-module.exports = function (suite) {
+module.exports = function qUnitInterface(suite) {
   var suites = [suite];
 
-  suite.on('pre-require', function (context, file, mocha) {
+  suite.on(EVENT_FILE_PRE_REQUIRE, function (context, file, mocha) {
     var common = require('./common')(suites, context, mocha);
 
     context.before = common.before;
@@ -51,8 +49,8 @@ module.exports = function (suite) {
         suites.shift();
       }
       return common.suite.create({
-        title: title,
-        file: file,
+        title,
+        file,
         fn: false
       });
     };
@@ -66,8 +64,8 @@ module.exports = function (suite) {
         suites.shift();
       }
       return common.suite.only({
-        title: title,
-        file: file,
+        title,
+        file,
         fn: false
       });
     };
@@ -94,6 +92,7 @@ module.exports = function (suite) {
     };
 
     context.test.skip = common.test.skip;
-    context.test.retries = common.test.retries;
   });
 };
+
+module.exports.description = 'QUnit style';

package/lib/interfaces/tdd.js

@@ -1,10 +1,8 @@
 'use strict';
 
-/**
- * Module dependencies.
- */
-
 var Test = require('../test');
+var EVENT_FILE_PRE_REQUIRE =
+  require('../suite').constants.EVENT_FILE_PRE_REQUIRE;
 
 /**
  * TDD-style interface:
@@ -34,7 +32,7 @@ var Test = require('../test');
 module.exports = function (suite) {
   var suites = [suite];
 
-  suite.on('pre-require', function (context, file, mocha) {
+  suite.on(EVENT_FILE_PRE_REQUIRE, function (context, file, mocha) {
     var common = require('./common')(suites, context, mocha);
 
     context.setup = common.beforeEach;
@@ -49,9 +47,9 @@ module.exports = function (suite) {
      */
     context.suite = function (title, fn) {
       return common.suite.create({
-        title: title,
-        file: file,
-        fn: fn
+        title,
+        file,
+        fn
       });
     };
 
@@ -60,9 +58,9 @@ module.exports = function (suite) {
      */
     context.suite.skip = function (title, fn) {
       return common.suite.skip({
-        title: title,
-        file: file,
-        fn: fn
+        title,
+        file,
+        fn
       });
     };
 
@@ -71,9 +69,9 @@ module.exports = function (suite) {
      */
     context.suite.only = function (title, fn) {
       return common.suite.only({
-        title: title,
-        file: file,
-        fn: fn
+        title,
+        file,
+        fn
       });
     };
 
@@ -101,6 +99,8 @@ module.exports = function (suite) {
     };
 
     context.test.skip = common.test.skip;
-    context.test.retries = common.test.retries;
   });
 };
+
+module.exports.description =
+  'traditional "suite"/"test" instead of BDD\'s "describe"/"it"';