cypress 5.4.0 → 5.5.0

package/index.js

@@ -1,12 +1,12 @@
 "use strict";
 
-var minimist = require('minimist');
+const minimist = require('minimist');
 
-var debug = require('debug')('cypress:cli');
+const debug = require('debug')('cypress:cli');
 
-var args = minimist(process.argv.slice(2));
+const args = minimist(process.argv.slice(2));
 
-var util = require('./lib/util'); // we're being used from the command line
+const util = require('./lib/util'); // we're being used from the command line
 
 
 switch (args.exec) {
@@ -15,7 +15,7 @@ switch (args.exec) {
 
     require('./lib/tasks/install').start({
       force: args.force
-    })["catch"](util.logErrorExit1);
+    }).catch(util.logErrorExit1);
 
     break;
 
@@ -26,7 +26,7 @@ switch (args.exec) {
     require('./lib/tasks/verify').start({
       force: true
     }) // always force verification
-    ["catch"](util.logErrorExit1);
+    .catch(util.logErrorExit1);
 
     break;
 

package/lib/cli.js

@@ -1,53 +1,33 @@
 "use strict";
 
-function _toConsumableArray(arr) { return _arrayWithoutHoles(arr) || _iterableToArray(arr) || _unsupportedIterableToArray(arr) || _nonIterableSpread(); }
+const _ = require('lodash');
 
-function _nonIterableSpread() { throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+const R = require('ramda');
 
-function _iterableToArray(iter) { if (typeof Symbol !== "undefined" && Symbol.iterator in Object(iter)) return Array.from(iter); }
+const commander = require('commander');
 
-function _arrayWithoutHoles(arr) { if (Array.isArray(arr)) return _arrayLikeToArray(arr); }
+const {
+  stripIndent
+} = require('common-tags');
 
-function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
+const logSymbols = require('log-symbols');
 
-function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+const debug = require('debug')('cypress:cli:cli');
 
-function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+const util = require('./util');
 
-function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
+const logger = require('./logger');
 
-function _iterableToArrayLimit(arr, i) { if (typeof Symbol === "undefined" || !(Symbol.iterator in Object(arr))) return; var _arr = []; var _n = true; var _d = false; var _e = undefined; try { for (var _i = arr[Symbol.iterator](), _s; !(_n = (_s = _i.next()).done); _n = true) { _arr.push(_s.value); if (i && _arr.length === i) break; } } catch (err) { _d = true; _e = err; } finally { try { if (!_n && _i["return"] != null) _i["return"](); } finally { if (_d) throw _e; } } return _arr; }
+const errors = require('./errors');
 
-function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
-
-var _ = require('lodash');
-
-var R = require('ramda');
-
-var commander = require('commander');
-
-var _require = require('common-tags'),
-    stripIndent = _require.stripIndent;
-
-var logSymbols = require('log-symbols');
-
-var debug = require('debug')('cypress:cli:cli');
-
-var util = require('./util');
-
-var logger = require('./logger');
-
-var errors = require('./errors');
-
-var cache = require('./tasks/cache'); // patch "commander" method called when a user passed an unknown option
+const cache = require('./tasks/cache'); // patch "commander" method called when a user passed an unknown option
 // we want to print help for the current command and exit with an error
 
 
-function unknownOption(flag) {
-  var type = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 'option';
+function unknownOption(flag, type = 'option') {
   if (this._allowUnknownOption) return;
   logger.error();
-  logger.error("  error: unknown ".concat(type, ":"), flag);
+  logger.error(`  error: unknown ${type}:`, flag);
   logger.error();
   this.outputHelp();
   util.exit(1);
@@ -55,23 +35,36 @@ function unknownOption(flag) {
 
 commander.Command.prototype.unknownOption = unknownOption;
 
-var coerceFalseOrString = function coerceFalseOrString(arg) {
+const coerceFalseOrString = arg => {
   return arg !== 'false' ? arg : false;
 };
 
-var coerceFalse = function coerceFalse(arg) {
+const coerceFalse = arg => {
   return arg !== 'false';
 };
 
-var coerceAnyStringToInt = function coerceAnyStringToInt(arg) {
+const coerceAnyStringToInt = arg => {
   return typeof arg === 'string' ? parseInt(arg) : arg;
 };
 
-var spaceDelimitedArgsMsg = function spaceDelimitedArgsMsg(flag, args) {
-  var msg = "\n    ".concat(logSymbols.warning, " Warning: It looks like you're passing --").concat(flag, " a space-separated list of arguments:\n\n    \"").concat(args.join(' '), "\"\n\n    This will work, but it's not recommended.\n\n    If you are trying to pass multiple arguments, separate them with commas instead:\n      cypress run --").concat(flag, " arg1,arg2,arg3\n  ");
+const spaceDelimitedArgsMsg = (flag, args) => {
+  let msg = `
+    ${logSymbols.warning} Warning: It looks like you're passing --${flag} a space-separated list of arguments:
+
+    "${args.join(' ')}"
+
+    This will work, but it's not recommended.
+
+    If you are trying to pass multiple arguments, separate them with commas instead:
+      cypress run --${flag} arg1,arg2,arg3
+  `;
 
   if (flag === 'spec') {
-    msg += "\n    The most common cause of this warning is using an unescaped glob pattern. If you are\n    trying to pass a glob pattern, escape it using quotes:\n      cypress run --spec \"**/*.spec.js\"\n    ";
+    msg += `
+    The most common cause of this warning is using an unescaped glob pattern. If you are
+    trying to pass a glob pattern, escape it using quotes:
+      cypress run --spec "**/*.spec.js"
+    `;
   }
 
   logger.log();
@@ -79,30 +72,28 @@ var spaceDelimitedArgsMsg = function spaceDelimitedArgsMsg(flag, args) {
   logger.log();
 };
 
-var parseVariableOpts = function parseVariableOpts(fnArgs, args) {
-  var _fnArgs = _slicedToArray(fnArgs, 2),
-      opts = _fnArgs[0],
-      unknownArgs = _fnArgs[1];
+const parseVariableOpts = (fnArgs, args) => {
+  const [opts, unknownArgs] = fnArgs;
 
   if (unknownArgs && unknownArgs.length && (opts.spec || opts.tag)) {
     // this will capture space-delimited args after
     // flags that could have possible multiple args
     // but before the next option
     // --spec spec1 spec2 or --tag foo bar
-    var multiArgFlags = _.compact([opts.spec ? 'spec' : opts.spec, opts.tag ? 'tag' : opts.tag]);
+    const multiArgFlags = _.compact([opts.spec ? 'spec' : opts.spec, opts.tag ? 'tag' : opts.tag]);
 
-    _.forEach(multiArgFlags, function (flag) {
-      var argIndex = _.indexOf(args, "--".concat(flag)) + 2;
+    _.forEach(multiArgFlags, flag => {
+      const argIndex = _.indexOf(args, `--${flag}`) + 2;
 
-      var nextOptOffset = _.findIndex(_.slice(args, argIndex), function (arg) {
+      const nextOptOffset = _.findIndex(_.slice(args, argIndex), arg => {
         return _.startsWith(arg, '--');
       });
 
-      var endIndex = nextOptOffset !== -1 ? argIndex + nextOptOffset : args.length;
+      const endIndex = nextOptOffset !== -1 ? argIndex + nextOptOffset : args.length;
 
-      var maybeArgs = _.slice(args, argIndex, endIndex);
+      const maybeArgs = _.slice(args, argIndex, endIndex);
 
-      var extraArgs = _.intersection(maybeArgs, unknownArgs);
+      const extraArgs = _.intersection(maybeArgs, unknownArgs);
 
       if (extraArgs.length) {
         opts[flag] = [opts[flag]].concat(extraArgs);
@@ -113,13 +104,13 @@ var parseVariableOpts = function parseVariableOpts(fnArgs, args) {
   }
 
   debug('variable-length opts parsed %o', {
-    args: args,
-    opts: opts
+    args,
+    opts
   });
   return util.parseOpts(opts);
 };
 
-var descriptions = {
+const descriptions = {
   browserOpenMode: 'path to a custom browser to be added to the list of available browsers in Cypress',
   browserRunMode: 'runs Cypress in the browser with the given name. if a filesystem path is supplied, Cypress will attempt to use the browser at that path.',
   cacheClear: 'delete all cached binaries',
@@ -151,11 +142,11 @@ var descriptions = {
   tag: 'named tag(s) for recorded runs in the Cypress Dashboard',
   version: 'prints Cypress version'
 };
-var knownCommands = ['cache', 'help', '-h', '--help', 'install', 'open', 'run', 'verify', '-v', '--version', 'version', 'info'];
+const knownCommands = ['cache', 'help', '-h', '--help', 'install', 'open', 'run', 'verify', '-v', '--version', 'version', 'info'];
 
-var text = function text(description) {
+const text = description => {
   if (!descriptions[description]) {
-    throw new Error("Could not find description for: ".concat(description));
+    throw new Error(`Could not find description for: ${description}`);
   }
 
   return descriptions[description];
@@ -167,16 +158,15 @@ function includesVersion(args) {
 
 function showVersions() {
   debug('printing Cypress version');
-  return require('./exec/versions').getVersions().then(function () {
-    var versions = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-    logger.always('Cypress package version:', versions["package"]);
+  return require('./exec/versions').getVersions().then((versions = {}) => {
+    logger.always('Cypress package version:', versions.package);
     logger.always('Cypress binary version:', versions.binary);
     process.exit(0);
-  })["catch"](util.logErrorExit1);
+  }).catch(util.logErrorExit1);
 }
 
-var createProgram = function createProgram() {
-  var program = new commander.Command(); // bug in commander not printing name
+const createProgram = () => {
+  const program = new commander.Command(); // bug in commander not printing name
   // in usage help docs
 
   program._name = 'cypress';
@@ -184,7 +174,7 @@ var createProgram = function createProgram() {
   return program;
 };
 
-var addCypressRunCommand = function addCypressRunCommand(program) {
+const addCypressRunCommand = program => {
   return program.command('run').usage('[options]').description('Runs Cypress tests from the CLI without the GUI').option('-b, --browser <browser-name-or-path>', text('browserRunMode')).option('--ci-build-id <id>', text('ciBuildId')).option('-c, --config <config>', text('config')).option('-C, --config-file <config-file>', text('configFile')).option('-e, --env <env>', text('env')).option('--group <name>', text('group')).option('-k, --key <record-key>', text('key')).option('--headed', text('headed')).option('--headless', text('headless')).option('--no-exit', text('exit')).option('--parallel', text('parallel')).option('-p, --port <port>', text('port')).option('-P, --project <project-path>', text('project')).option('-q, --quiet', text('quiet')).option('--record [bool]', text('record'), coerceFalse).option('-r, --reporter <reporter>', text('reporter')).option('-o, --reporter-options <reporter-options>', text('reporterOptions')).option('-s, --spec <spec>', text('spec')).option('-t, --tag <tag>', text('tag')).option('--dev', text('dev'), coerceFalse);
 };
 /**
@@ -196,11 +186,11 @@ var addCypressRunCommand = function addCypressRunCommand(program) {
  */
 
 
-var castCypressRunOptions = function castCypressRunOptions(opts) {
+const castCypressRunOptions = opts => {
   // only properties that have type "string | false" in our TS definition
   // require special handling, because CLI parsing takes care of purely
   // boolean arguments
-  var result = R.evolve({
+  const result = R.evolve({
     port: coerceAnyStringToInt,
     configFile: coerceFalseOrString
   })(opts);
@@ -215,8 +205,8 @@ module.exports = {
    *  const options = parseRunCommand(['cypress', 'run', '--browser', 'chrome'])
    *  // options is {browser: 'chrome'}
    */
-  parseRunCommand: function parseRunCommand(args) {
-    return new Promise(function (resolve, reject) {
+  parseRunCommand(args) {
+    return new Promise((resolve, reject) => {
       if (!Array.isArray(args)) {
         return reject(new Error('Expected array of arguments'));
       } // make a copy of the input arguments array
@@ -224,19 +214,15 @@ module.exports = {
       // also remove "cypress" keyword at the start if present
 
 
-      var cliArgs = args[0] === 'cypress' ? _toConsumableArray(args.slice(1)) : _toConsumableArray(args);
+      const cliArgs = args[0] === 'cypress' ? [...args.slice(1)] : [...args];
       cliArgs.unshift(null, null);
       debug('creating program parser');
-      var program = createProgram();
-      addCypressRunCommand(program).action(function () {
-        for (var _len = arguments.length, fnArgs = new Array(_len), _key = 0; _key < _len; _key++) {
-          fnArgs[_key] = arguments[_key];
-        }
-
+      const program = createProgram();
+      addCypressRunCommand(program).action((...fnArgs) => {
         debug('parsed Cypress run %o', fnArgs);
-        var options = parseVariableOpts(fnArgs, cliArgs);
+        const options = parseVariableOpts(fnArgs, cliArgs);
         debug('parsed options %o', options);
-        var casted = castCypressRunOptions(options);
+        const casted = castCypressRunOptions(options);
         debug('casted options %o', casted);
         resolve(casted);
       });
@@ -248,58 +234,62 @@ module.exports = {
   /**
    * Parses the command line and kicks off Cypress process.
    */
-  init: function init(args) {
+  init(args) {
     if (!args) {
       args = process.argv;
     }
 
-    var CYPRESS_INTERNAL_ENV = process.env.CYPRESS_INTERNAL_ENV;
+    const {
+      CYPRESS_INTERNAL_ENV
+    } = process.env;
 
     if (!util.isValidCypressInternalEnvValue(CYPRESS_INTERNAL_ENV)) {
       debug('invalid CYPRESS_INTERNAL_ENV value', CYPRESS_INTERNAL_ENV);
-      return errors.exitWithError(errors.errors.invalidCypressEnv)("CYPRESS_INTERNAL_ENV=".concat(CYPRESS_INTERNAL_ENV));
+      return errors.exitWithError(errors.errors.invalidCypressEnv)(`CYPRESS_INTERNAL_ENV=${CYPRESS_INTERNAL_ENV}`);
     }
 
     if (util.isNonProductionCypressInternalEnvValue(CYPRESS_INTERNAL_ENV)) {
       debug('non-production CYPRESS_INTERNAL_ENV value', CYPRESS_INTERNAL_ENV);
-      var msg = "\n        ".concat(logSymbols.warning, " Warning: It looks like you're passing CYPRESS_INTERNAL_ENV=").concat(CYPRESS_INTERNAL_ENV, "\n\n        The environment variable \"CYPRESS_INTERNAL_ENV\" is reserved and should only be used internally.\n\n        Unset the \"CYPRESS_INTERNAL_ENV\" environment variable and run Cypress again.\n      ");
+      let msg = `
+        ${logSymbols.warning} Warning: It looks like you're passing CYPRESS_INTERNAL_ENV=${CYPRESS_INTERNAL_ENV}
+
+        The environment variable "CYPRESS_INTERNAL_ENV" is reserved and should only be used internally.
+
+        Unset the "CYPRESS_INTERNAL_ENV" environment variable and run Cypress again.
+      `;
       logger.log();
       logger.warn(stripIndent(msg));
       logger.log();
     }
 
-    var program = createProgram();
-    program.command('help').description('Shows CLI help and exits').action(function () {
+    const program = createProgram();
+    program.command('help').description('Shows CLI help and exits').action(() => {
       program.help();
     });
     program.option('-v, --version', text('version')).command('version').description(text('version')).action(showVersions);
-    addCypressRunCommand(program).action(function () {
-      for (var _len2 = arguments.length, fnArgs = new Array(_len2), _key2 = 0; _key2 < _len2; _key2++) {
-        fnArgs[_key2] = arguments[_key2];
-      }
-
+    addCypressRunCommand(program).action((...fnArgs) => {
       debug('running Cypress with args %o', fnArgs);
 
-      require('./exec/run').start(parseVariableOpts(fnArgs, args)).then(util.exit)["catch"](util.logErrorExit1);
+      require('./exec/run').start(parseVariableOpts(fnArgs, args)).then(util.exit).catch(util.logErrorExit1);
     });
-    program.command('open').usage('[options]').description('Opens Cypress in the interactive GUI.').option('-b, --browser <browser-path>', text('browserOpenMode')).option('-c, --config <config>', text('config')).option('-C, --config-file <config-file>', text('configFile')).option('-d, --detached [bool]', text('detached'), coerceFalse).option('-e, --env <env>', text('env')).option('--global', text('global')).option('-p, --port <port>', text('port')).option('-P, --project <project-path>', text('project')).option('--dev', text('dev'), coerceFalse).action(function (opts) {
+    program.command('open').usage('[options]').description('Opens Cypress in the interactive GUI.').option('-b, --browser <browser-path>', text('browserOpenMode')).option('-c, --config <config>', text('config')).option('-C, --config-file <config-file>', text('configFile')).option('-d, --detached [bool]', text('detached'), coerceFalse).option('-e, --env <env>', text('env')).option('--global', text('global')).option('-p, --port <port>', text('port')).option('-P, --project <project-path>', text('project')).option('--dev', text('dev'), coerceFalse).action(opts => {
       debug('opening Cypress');
 
-      require('./exec/open').start(util.parseOpts(opts))["catch"](util.logErrorExit1);
+      require('./exec/open').start(util.parseOpts(opts)).catch(util.logErrorExit1);
     });
-    program.command('install').usage('[options]').description('Installs the Cypress executable matching this package\'s version').option('-f, --force', text('forceInstall')).action(function (opts) {
-      require('./tasks/install').start(util.parseOpts(opts))["catch"](util.logErrorExit1);
+    program.command('install').usage('[options]').description('Installs the Cypress executable matching this package\'s version').option('-f, --force', text('forceInstall')).action(opts => {
+      require('./tasks/install').start(util.parseOpts(opts)).catch(util.logErrorExit1);
     });
-    program.command('verify').usage('[options]').description('Verifies that Cypress is installed correctly and executable').option('--dev', text('dev'), coerceFalse).action(function (opts) {
-      var defaultOpts = {
+    program.command('verify').usage('[options]').description('Verifies that Cypress is installed correctly and executable').option('--dev', text('dev'), coerceFalse).action(opts => {
+      const defaultOpts = {
         force: true,
         welcomeMessage: false
       };
-      var parsedOpts = util.parseOpts(opts);
+      const parsedOpts = util.parseOpts(opts);
 
-      var options = _.extend(parsedOpts, defaultOpts);
+      const options = _.extend(parsedOpts, defaultOpts);
 
-      require('./tasks/verify').start(options)["catch"](util.logErrorExit1);
+      require('./tasks/verify').start(options).catch(util.logErrorExit1);
     });
     program.command('cache').usage('[command]').description('Manages the Cypress binary cache').option('list', text('cacheList')).option('path', text('cachePath')).option('clear', text('cacheClear')).option('prune', text('cachePrune')).option('--size', text('cacheSize')).action(function (opts, args) {
       if (!args || !args.length) {
@@ -307,22 +297,27 @@ module.exports = {
         util.exit(1);
       }
 
-      var _args = _slicedToArray(args, 1),
-          command = _args[0];
+      const [command] = args;
 
       if (!_.includes(['list', 'path', 'clear', 'prune'], command)) {
-        unknownOption.call(this, "cache ".concat(command), 'command');
+        unknownOption.call(this, `cache ${command}`, 'command');
       }
 
       if (command === 'list') {
-        cache.list(opts.size);
-        return;
+        debug('cache command %o', {
+          command,
+          size: opts.size
+        });
+        return cache.list(opts.size).catch(e => {
+          debug('cache list command failed with "%s"', e.message);
+          util.logErrorExit1(e);
+        });
       }
 
       cache[command]();
     });
-    program.command('info').usage('[command]').description('Prints Cypress and system information').option('--dev', text('dev'), coerceFalse).action(function (opts) {
-      require('./exec/info').start(opts).then(util.exit)["catch"](util.logErrorExit1);
+    program.command('info').usage('[command]').description('Prints Cypress and system information').option('--dev', text('dev'), coerceFalse).action(opts => {
+      require('./exec/info').start(opts).then(util.exit).catch(util.logErrorExit1);
     });
     debug('cli starts with arguments %j', args);
     util.printNodeOptions(); // if there are no arguments
@@ -332,11 +327,11 @@ module.exports = {
       program.help(); // exits
     }
 
-    var firstCommand = args[2];
+    const firstCommand = args[2];
 
     if (!_.includes(knownCommands, firstCommand)) {
       debug('unknown command %s', firstCommand);
-      logger.error('Unknown command', "\"".concat(firstCommand, "\""));
+      logger.error('Unknown command', `"${firstCommand}"`);
       program.outputHelp();
       return util.exit(1);
     }
@@ -352,6 +347,7 @@ module.exports = {
     debug('program parsing arguments');
     return program.parse(args);
   }
+
 };
 
 if (!module.parent) {

package/lib/cypress.js

@@ -1,51 +1,49 @@
 "use strict";
 
 // https://github.com/cypress-io/cypress/issues/316
-var Promise = require('bluebird');
+const Promise = require('bluebird');
 
-var tmp = Promise.promisifyAll(require('tmp'));
+const tmp = Promise.promisifyAll(require('tmp'));
 
-var fs = require('./fs');
+const fs = require('./fs');
 
-var _open = require('./exec/open');
+const open = require('./exec/open');
 
-var _run = require('./exec/run');
+const run = require('./exec/run');
 
-var util = require('./util');
+const util = require('./util');
 
-var cli = require('./cli');
+const cli = require('./cli');
 
-var cypressModuleApi = {
+const cypressModuleApi = {
   /**
    * Opens Cypress GUI
    * @see https://on.cypress.io/module-api#cypress-open
    */
-  open: function open() {
-    var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  open(options = {}) {
     options = util.normalizeModuleOptions(options);
-    return _open.start(options);
+    return open.start(options);
   },
 
   /**
    * Runs Cypress tests in the current project
    * @see https://on.cypress.io/module-api#cypress-run
    */
-  run: function run() {
-    var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-
-    if (!_run.isValidProject(options.project)) {
-      return Promise.reject(new Error("Invalid project path parameter: ".concat(options.project)));
+  run(options = {}) {
+    if (!run.isValidProject(options.project)) {
+      return Promise.reject(new Error(`Invalid project path parameter: ${options.project}`));
     }
 
     options = util.normalizeModuleOptions(options);
-    return tmp.fileAsync().then(function (outputPath) {
+    return tmp.fileAsync().then(outputPath => {
       options.outputPath = outputPath;
-      return _run.start(options).then(function (failedTests) {
+      return run.start(options).then(failedTests => {
         return fs.readJsonAsync(outputPath, {
-          "throws": false
-        }).then(function (output) {
+          throws: false
+        }).then(output => {
           if (!output) {
             return {
+              status: 'failed',
               failures: failedTests,
               message: 'Could not find Cypress test run results'
             };
@@ -56,6 +54,7 @@ var cypressModuleApi = {
       });
     });
   },
+
   cli: {
     /**
      * Parses CLI arguments into an object that you can pass to "cypress.run"
@@ -67,9 +66,10 @@ var cypressModuleApi = {
      *  await cypress.run(options)
      * @see https://on.cypress.io/module-api
      */
-    parseRunArguments: function parseRunArguments(args) {
+    parseRunArguments(args) {
       return cli.parseRunCommand(args);
     }
+
   }
 };
 module.exports = cypressModuleApi;