mocha 5.1.1 → 6.0.0

package/lib/cli/run-helpers.js

@@ -0,0 +1,337 @@
+'use strict';
+
+/**
+ * Helper scripts for the `run` command
+ * @see module:lib/cli/run
+ * @module
+ * @private
+ */
+
+const fs = require('fs');
+const path = require('path');
+const ansi = require('ansi-colors');
+const debug = require('debug')('mocha:cli:run:helpers');
+const minimatch = require('minimatch');
+const Context = require('../context');
+const Mocha = require('../mocha');
+const utils = require('../utils');
+
+const cwd = (exports.cwd = process.cwd());
+
+/**
+ * Exits Mocha when tests + code under test has finished execution (default)
+ * @param {number} code - Exit code; typically # of failures
+ * @ignore
+ * @private
+ */
+const exitMochaLater = code => {
+  process.on('exit', () => {
+    process.exitCode = Math.min(code, 255);
+  });
+};
+
+/**
+ * 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
+ * @ignore
+ * @private
+ */
+const exitMocha = code => {
+  const clampedCode = Math.min(code, 255);
+  let draining = 0;
+
+  // Eagerly set the process's exit code in case stream.write doesn't
+  // execute its callback before the process terminates.
+  process.exitCode = clampedCode;
+
+  // flush output for Node.js Windows pipe bug
+  // https://github.com/joyent/node/issues/6247 is just one bug example
+  // https://github.com/visionmedia/mocha/issues/333 has a good discussion
+  const done = () => {
+    if (!draining--) {
+      process.exit(clampedCode);
+    }
+  };
+
+  const streams = [process.stdout, process.stderr];
+
+  streams.forEach(stream => {
+    // submit empty write request and wait for completion
+    draining += 1;
+    stream.write('', done);
+  });
+
+  done();
+};
+
+/**
+ * Hide the cursor.
+ * @ignore
+ * @private
+ */
+const hideCursor = () => {
+  process.stdout.write('\u001b[?25l');
+};
+
+/**
+ * Show the cursor.
+ * @ignore
+ * @private
+ */
+const showCursor = () => {
+  process.stdout.write('\u001b[?25h');
+};
+
+/**
+ * Stop cursor business
+ * @private
+ */
+const stop = () => {
+  process.stdout.write('\u001b[2K');
+};
+
+/**
+ * Coerce a comma-delimited string (or array thereof) into a flattened array of
+ * strings
+ * @param {string|string[]} str - Value to coerce
+ * @returns {string[]} Array of strings
+ * @private
+ */
+exports.list = str =>
+  Array.isArray(str) ? exports.list(str.join(',')) : str.split(/ *, */);
+
+/**
+ * `require()` the modules as required by `--require <require>`
+ * @param {string[]} requires - Modules to require
+ * @private
+ */
+exports.handleRequires = (requires = []) => {
+  requires.forEach(mod => {
+    let modpath = mod;
+    if (fs.existsSync(mod, {cwd}) || fs.existsSync(`${mod}.js`, {cwd})) {
+      modpath = path.resolve(mod);
+      debug(`resolved ${mod} to ${modpath}`);
+    }
+    require(modpath);
+    debug(`loaded require "${mod}"`);
+  });
+};
+
+/**
+ * Smash together an array of test files in the correct order
+ * @param {Object} [opts] - Options
+ * @param {string[]} [opts.extension] - File extensions to use
+ * @param {string[]} [opts.spec] - Files, dirs, globs to run
+ * @param {string[]} [opts.exclude] - Files, dirs, globs to exclude
+ * @param {boolean} [opts.recursive=false] - Find files recursively
+ * @param {boolean} [opts.sort=false] - Sort test files
+ * @returns {string[]} List of files to test
+ * @private
+ */
+exports.handleFiles = ({
+  exclude = [],
+  extension = [],
+  file = [],
+  recursive = false,
+  sort = false,
+  spec = []
+} = {}) => {
+  let files = [];
+  const unmatched = [];
+  spec.forEach(arg => {
+    let newFiles;
+    try {
+      newFiles = utils.lookupFiles(arg, extension, recursive);
+    } catch (err) {
+      if (err.code === 'ERR_MOCHA_NO_FILES_MATCH_PATTERN') {
+        unmatched.push({message: err.message, pattern: err.pattern});
+        return;
+      }
+
+      throw err;
+    }
+
+    if (typeof newFiles !== 'undefined') {
+      if (typeof newFiles === 'string') {
+        newFiles = [newFiles];
+      }
+      newFiles = newFiles.filter(fileName =>
+        exclude.every(pattern => !minimatch(fileName, pattern))
+      );
+    }
+
+    files = files.concat(newFiles);
+  });
+
+  if (!files.length) {
+    // give full message details when only 1 file is missing
+    const noneFoundMsg =
+      unmatched.length === 1
+        ? `Error: No test files found: ${JSON.stringify(unmatched[0].pattern)}` // stringify to print escaped characters raw
+        : 'Error: No test files found';
+    console.error(ansi.red(noneFoundMsg));
+    process.exit(1);
+  } else {
+    // print messages as an warning
+    unmatched.forEach(warning => {
+      console.warn(ansi.yellow(`Warning: ${warning.message}`));
+    });
+  }
+
+  const fileArgs = file.map(filepath => path.resolve(filepath));
+  files = files.map(filepath => path.resolve(filepath));
+
+  // ensure we don't sort the stuff from fileArgs; order is important!
+  if (sort) {
+    files.sort();
+  }
+
+  // add files given through --file to be ran first
+  files = fileArgs.concat(files);
+  debug('files (in order): ', files);
+  return files;
+};
+
+/**
+ * Give Mocha files and tell it to run
+ * @param {Mocha} mocha - Mocha instance
+ * @param {Options} [opts] - Options
+ * @param {string[]} [opts.files] - List of test files
+ * @param {boolean} [opts.exit] - Whether or not to force-exit after tests are complete
+ * @returns {Runner}
+ * @private
+ */
+exports.singleRun = (mocha, {files = [], exit = false} = {}) => {
+  mocha.files = files;
+  return mocha.run(exit ? exitMocha : exitMochaLater);
+};
+
+/**
+ * Run Mocha in "watch" mode
+ * @param {Mocha} mocha - Mocha instance
+ * @param {Object} [opts] - Options
+ * @param {string[]} [opts.extension] - List of extensions to watch
+ * @param {string|RegExp} [opts.grep] - Grep for test titles
+ * @param {string} [opts.ui=bdd] - User interface
+ * @param {string[]} [files] - Array of test files
+ * @private
+ */
+exports.watchRun = (
+  mocha,
+  {extension = ['js'], grep = '', ui = 'bdd', files = []} = {}
+) => {
+  let runner;
+
+  console.log();
+  hideCursor();
+  process.on('SIGINT', () => {
+    showCursor();
+    console.log('\n');
+    process.exit(130);
+  });
+
+  const watchFiles = utils.files(cwd, extension);
+  let runAgain = false;
+
+  const loadAndRun = () => {
+    try {
+      mocha.files = files;
+      runAgain = false;
+      runner = mocha.run(() => {
+        runner = null;
+        if (runAgain) {
+          rerun();
+        }
+      });
+    } catch (e) {
+      console.log(e.stack);
+    }
+  };
+
+  const purge = () => {
+    watchFiles.forEach(Mocha.unloadFile);
+  };
+
+  loadAndRun();
+
+  const rerun = () => {
+    purge();
+    stop();
+    if (!grep) {
+      mocha.grep(null);
+    }
+    mocha.suite = mocha.suite.clone();
+    mocha.suite.ctx = new Context();
+    mocha.ui(ui);
+    loadAndRun();
+  };
+
+  utils.watch(watchFiles, () => {
+    runAgain = true;
+    if (runner) {
+      runner.abort();
+    } else {
+      rerun();
+    }
+  });
+};
+
+/**
+ * Actually run tests
+ * @param {Mocha} mocha - Mocha instance
+ * @param {Object} [opts] - Options
+ * @param {boolean} [opts.watch=false] - Enable watch mode
+ * @param {string[]} [opts.extension] - List of extensions to watch
+ * @param {string|RegExp} [opts.grep] - Grep for test titles
+ * @param {string} [opts.ui=bdd] - User interface
+ * @param {boolean} [opts.exit=false] - Force-exit Mocha when tests done
+ * @param {string[]} [files] - Array of test files
+ * @private
+ */
+exports.runMocha = (
+  mocha,
+  {watch = false, extension = ['js'], grep = '', ui = 'bdd', exit = false} = {},
+  files = []
+) => {
+  if (watch) {
+    exports.watchRun(mocha, {extension, grep, ui});
+  } else {
+    exports.singleRun(mocha, {files, exit});
+  }
+};
+
+/**
+ * Used for `--reporter` and `--ui`.  Ensures there's only one, and asserts
+ * that it actually exists.
+ * @todo XXX This must get run after requires are processed, as it'll prevent
+ * interfaces from loading.
+ * @param {Object} opts - Options object
+ * @param {string} key - Resolvable module name or path
+ * @param {Object} [map] - An object perhaps having key `key`
+ * @private
+ */
+exports.validatePlugin = (opts, key, map = {}) => {
+  if (Array.isArray(opts[key])) {
+    throw new TypeError(`"--${key} <${key}>" can only be specified once`);
+  }
+
+  const unknownError = () => new Error(`Unknown "${key}": ${opts[key]}`);
+
+  if (!map[opts[key]]) {
+    try {
+      opts[key] = require(opts[key]);
+    } catch (err) {
+      if (err.code === 'MODULE_NOT_FOUND') {
+        // Try to load reporters from a path (absolute or relative)
+        try {
+          opts[key] = require(path.resolve(process.cwd(), opts[key]));
+        } catch (err) {
+          throw unknownError();
+        }
+      } else {
+        throw unknownError();
+      }
+    }
+  }
+};

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

@@ -0,0 +1,76 @@
+'use strict';
+
+/**
+ * Metadata about various options of the `run` command
+ * @see module:lib/cli/run
+ * @module
+ * @private
+ */
+
+/**
+ * Dictionary of yargs option types to list of options having said type
+ * @type {{string:string[]}}
+ * @private
+ */
+exports.types = {
+  array: [
+    'exclude',
+    'extension',
+    'file',
+    'global',
+    'require',
+    'reporter-option',
+    'spec'
+  ],
+  boolean: [
+    'allow-uncaught',
+    'async-only',
+    'bail',
+    'check-leaks',
+    'color',
+    'delay',
+    'diff',
+    'exit',
+    'forbid-only',
+    'forbid-pending',
+    'full-trace',
+    'growl',
+    'inline-diffs',
+    'interfaces',
+    'invert',
+    'no-colors',
+    'recursive',
+    'reporters',
+    'sort',
+    'watch'
+  ],
+  number: ['retries', 'slow', 'timeout'],
+  string: ['fgrep', 'grep', 'package', 'reporter', 'ui']
+};
+
+/**
+ * Option aliases keyed by canonical option name.
+ * Arrays used to reduce
+ * @type {{string:string[]}}
+ * @private
+ */
+exports.aliases = {
+  'async-only': ['A'],
+  bail: ['b'],
+  color: ['c', 'colors'],
+  extension: ['watch-extensions'],
+  fgrep: ['f'],
+  global: ['globals'],
+  grep: ['g'],
+  growl: ['G'],
+  invert: ['i'],
+  'no-colors': ['C'],
+  reporter: ['R'],
+  'reporter-option': ['reporter-options', 'O'],
+  require: ['r'],
+  slow: ['s'],
+  sort: ['S'],
+  timeout: ['t', 'timeouts'],
+  ui: ['u'],
+  watch: ['w']
+};

package/lib/cli/run.js

@@ -0,0 +1,297 @@
+'use strict';
+
+/**
+ * Definition for Mocha's default ("run tests") command
+ *
+ * @module
+ * @private
+ */
+
+const Mocha = require('../mocha');
+const {
+  createUnsupportedError,
+  createInvalidArgumentValueError,
+  createMissingArgumentError
+} = require('../errors');
+
+const {
+  list,
+  handleFiles,
+  handleRequires,
+  validatePlugin,
+  runMocha
+} = 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 {types, aliases} = require('./run-option-metadata');
+
+/**
+ * Logical option groups
+ * @constant
+ */
+const GROUPS = {
+  FILES: 'File Handling',
+  FILTERS: 'Test Filters',
+  NODEJS: 'Node.js & V8',
+  OUTPUT: 'Reporting & Output',
+  RULES: 'Rules & Behavior',
+  CONFIG: 'Configuration'
+};
+
+exports.command = ['$0 [spec..]', 'debug [spec..]'];
+
+exports.describe = 'Run tests with Mocha';
+
+exports.builder = yargs =>
+  yargs
+    .options({
+      'allow-uncaught': {
+        description: 'Allow uncaught errors to propagate',
+        group: GROUPS.RULES
+      },
+      'async-only': {
+        description:
+          'Require all tests to use a callback (async) or return a Promise',
+        group: GROUPS.RULES
+      },
+      bail: {
+        description: 'Abort ("bail") after first test failure',
+        group: GROUPS.RULES
+      },
+      'check-leaks': {
+        description: 'Check for global variable leaks',
+        group: GROUPS.RULES
+      },
+      color: {
+        description: 'Force-enable color output',
+        group: GROUPS.OUTPUT
+      },
+      config: {
+        config: true,
+        defaultDescription: '(nearest rc file)',
+        description: 'Path to config file',
+        group: GROUPS.CONFIG
+      },
+      delay: {
+        description: 'Delay initial execution of root suite',
+        group: GROUPS.RULES
+      },
+      diff: {
+        default: true,
+        description: 'Show diff on failure',
+        group: GROUPS.OUTPUT
+      },
+      exclude: {
+        defaultDescription: '(none)',
+        description: 'Ignore file(s) or glob pattern(s)',
+        group: GROUPS.FILES,
+        requiresArg: true
+      },
+      exit: {
+        description: 'Force Mocha to quit after tests complete',
+        group: GROUPS.RULES
+      },
+      extension: {
+        default: defaults.extension,
+        defaultDescription: 'js',
+        description: 'File extension(s) to load and/or watch',
+        group: GROUPS.FILES,
+        requiresArg: true,
+        coerce: list
+      },
+      fgrep: {
+        conflicts: 'grep',
+        description: 'Only run tests containing this string',
+        group: GROUPS.FILTERS,
+        requiresArg: true
+      },
+      file: {
+        defaultDescription: '(none)',
+        description:
+          'Specify file(s) to be loaded prior to root suite execution',
+        group: GROUPS.FILES,
+        normalize: true,
+        requiresArg: true
+      },
+      'forbid-only': {
+        description: 'Fail if exclusive test(s) encountered',
+        group: GROUPS.RULES
+      },
+      'forbid-pending': {
+        description: 'Fail if pending test(s) encountered',
+        group: GROUPS.RULES
+      },
+      'full-trace': {
+        description: 'Display full stack traces',
+        group: GROUPS.OUTPUT
+      },
+      global: {
+        coerce: list,
+        description: 'List of allowed global variables',
+        group: GROUPS.RULES,
+        requiresArg: true
+      },
+      grep: {
+        coerce: value => (!value ? null : value),
+        conflicts: 'fgrep',
+        description: 'Only run tests matching this string or regexp',
+        group: GROUPS.FILTERS,
+        requiresArg: true
+      },
+      growl: {
+        description: 'Enable Growl notifications',
+        group: GROUPS.OUTPUT
+      },
+      'inline-diffs': {
+        description:
+          'Display actual/expected differences inline within each string',
+        group: GROUPS.OUTPUT
+      },
+      interfaces: {
+        conflicts: Array.from(ONE_AND_DONE_ARGS),
+        description: 'List built-in user interfaces & exit'
+      },
+      invert: {
+        description: 'Inverts --grep and --fgrep matches',
+        group: GROUPS.FILTERS
+      },
+      'no-colors': {
+        description: 'Force-disable color output',
+        group: GROUPS.OUTPUT,
+        hidden: true
+      },
+      opts: {
+        default: defaults.opts,
+        description: 'Path to `mocha.opts`',
+        group: GROUPS.CONFIG,
+        normalize: true,
+        requiresArg: true
+      },
+      package: {
+        description: 'Path to package.json for config',
+        group: GROUPS.CONFIG,
+        normalize: true,
+        requiresArg: true
+      },
+      recursive: {
+        description: 'Look for tests in subdirectories',
+        group: GROUPS.FILES
+      },
+      reporter: {
+        default: defaults.reporter,
+        description: 'Specify reporter to use',
+        group: GROUPS.OUTPUT,
+        requiresArg: true
+      },
+      reporters: {
+        conflicts: Array.from(ONE_AND_DONE_ARGS),
+        description: 'List built-in reporters & exit'
+      },
+      'reporter-option': {
+        coerce: opts =>
+          list(opts).reduce((acc, opt) => {
+            const pair = opt.split('=');
+
+            if (pair.length > 2 || !pair.length) {
+              throw createInvalidArgumentValueError(
+                `invalid reporter option '${opt}'`,
+                '--reporter-option',
+                opt,
+                'expected "key=value" format'
+              );
+            }
+
+            acc[pair[0]] = pair.length === 2 ? pair[1] : true;
+            return acc;
+          }, {}),
+        description: 'Reporter-specific options (<k=v,[k1=v1,..]>)',
+        group: GROUPS.OUTPUT,
+        requiresArg: true
+      },
+      require: {
+        defaultDescription: '(none)',
+        description: 'Require module',
+        group: GROUPS.FILES,
+        requiresArg: true
+      },
+      retries: {
+        description: 'Retry failed tests this many times',
+        group: GROUPS.RULES
+      },
+      slow: {
+        default: defaults.slow,
+        description: 'Specify "slow" test threshold (in milliseconds)',
+        group: GROUPS.RULES
+      },
+      sort: {
+        description: 'Sort test files',
+        group: GROUPS.FILES
+      },
+      timeout: {
+        default: defaults.timeout,
+        description: 'Specify test timeout threshold (in milliseconds)',
+        group: GROUPS.RULES
+      },
+      ui: {
+        default: defaults.ui,
+        description: 'Specify user interface',
+        group: GROUPS.RULES,
+        requiresArg: true
+      },
+      watch: {
+        description: 'Watch files in the current working directory for changes',
+        group: GROUPS.FILES
+      }
+    })
+    .positional('spec', {
+      default: ['test/'],
+      description: 'One or more files, directories, or globs to test',
+      type: 'array'
+    })
+    .check(argv => {
+      // "one-and-dones"; let yargs handle help and version
+      Object.keys(ONE_AND_DONES).forEach(opt => {
+        if (argv[opt]) {
+          ONE_AND_DONES[opt].call(null, yargs);
+          process.exit();
+        }
+      });
+
+      // yargs.implies() isn't flexible enough to handle this
+      if (argv.invert && !('fgrep' in argv || 'grep' in argv)) {
+        throw createMissingArgumentError(
+          '"--invert" requires one of "--fgrep <str>" or "--grep <regexp>"',
+          '--fgrep|--grep',
+          'string|regexp'
+        );
+      }
+
+      if (argv.compilers) {
+        throw createUnsupportedError(
+          `--compilers is DEPRECATED and no longer supported.
+          See https://git.io/vdcSr for migration information.`
+        );
+      }
+
+      // load requires first, because it can impact "plugin" validation
+      handleRequires(argv.require);
+      validatePlugin(argv, 'reporter', Mocha.reporters);
+      validatePlugin(argv, 'ui', Mocha.interfaces);
+
+      return true;
+    })
+    .array(types.array)
+    .boolean(types.boolean)
+    .string(types.string)
+    .number(types.number)
+    .alias(aliases);
+
+exports.handler = argv => {
+  debug('post-yargs config', argv);
+  const mocha = new Mocha(argv);
+  const files = handleFiles(argv);
+
+  debug('running tests with files', files);
+  runMocha(mocha, argv, files);
+};