cypress 4.4.1 → 4.5.0

package/lib/tasks/unzip.js

@@ -1,14 +1,23 @@
-'use strict';
+"use strict";
 
 var _ = require('lodash');
+
 var la = require('lazy-ass');
+
 var is = require('check-more-types');
+
 var cp = require('child_process');
+
 var os = require('os');
+
 var yauzl = require('yauzl');
+
 var debug = require('debug')('cypress:cli:unzip');
+
 var extract = require('extract-zip');
+
 var Promise = require('bluebird');
+
 var readline = require('readline');
 
 var _require = require('../errors'),
@@ -16,17 +25,17 @@ var _require = require('../errors'),
     errors = _require.errors;
 
 var fs = require('../fs');
+
 var util = require('../util');
 
 var unzipTools = {
   extract: extract
+}; // expose this function for simple testing
 
-  // expose this function for simple testing
-};var unzip = function unzip(_ref) {
+var unzip = function unzip(_ref) {
   var zipFilePath = _ref.zipFilePath,
       installDir = _ref.installDir,
       progress = _ref.progress;
-
   debug('unzipping from %s', zipFilePath);
   debug('into', installDir);
 
@@ -36,7 +45,6 @@ var unzipTools = {
 
   var startTime = Date.now();
   var yauzlDoneTime = 0;
-
   return fs.ensureDirAsync(installDir).then(function () {
     return new Promise(function (resolve, reject) {
       return yauzl.open(zipFilePath, function (err, zipFile) {
@@ -44,33 +52,25 @@ var unzipTools = {
 
         if (err) {
           debug('error using yauzl %s', err.message);
-
           return reject(err);
         }
 
         var total = zipFile.entryCount;
-
         debug('zipFile entries count', total);
-
         var started = new Date();
-
         var percent = 0;
         var count = 0;
 
         var notify = function notify(percent) {
           var elapsed = +new Date() - +started;
-
           var eta = util.calculateEta(percent, elapsed);
-
           progress.onProgress(percent, util.secsRemaining(eta));
         };
 
         var tick = function tick() {
           count += 1;
-
           percent = count / total * 100;
           var displayPercent = percent.toFixed(0);
-
           return notify(displayPercent);
         };
 
@@ -80,12 +80,10 @@ var unzipTools = {
           var endFn = function endFn(err) {
             if (err) {
               debug('error %s', err.message);
-
               return reject(err);
             }
 
             debug('node unzip finished');
-
             return resolve();
           };
 
@@ -93,9 +91,7 @@ var unzipTools = {
             dir: installDir,
             onEntry: tick
           };
-
           debug('calling Node extract tool %s %o', zipFilePath, opts);
-
           return unzipTools.extract(zipFilePath, opts, endFn);
         };
 
@@ -103,74 +99,64 @@ var unzipTools = {
 
         var unzipWithUnzipTool = function unzipWithUnzipTool() {
           debug('unzipping via `unzip`');
-
           var inflatingRe = /inflating:/;
-
           var sp = cp.spawn('unzip', ['-o', zipFilePath, '-d', installDir]);
-
           sp.on('error', function (err) {
             debug('unzip tool error: %s', err.message);
             unzipFallback();
           });
-
           sp.on('close', function (code) {
             debug('unzip tool close with code %d', code);
+
             if (code === 0) {
               percent = 100;
               notify(percent);
-
               return resolve();
             }
 
-            debug('`unzip` failed %o', { code: code });
-
+            debug('`unzip` failed %o', {
+              code: code
+            });
             return unzipFallback();
           });
-
           sp.stdout.on('data', function (data) {
             if (inflatingRe.test(data)) {
               return tick();
             }
           });
-
           sp.stderr.on('data', function (data) {
             debug('`unzip` stderr %s', data);
           });
-        };
-
-        // we attempt to first unzip with the native osx
+        }; // we attempt to first unzip with the native osx
         // ditto because its less likely to have problems
         // with corruption, symlinks, or icons causing failures
         // and can handle resource forks
         // http://automatica.com.au/2011/02/unzip-mac-os-x-zip-in-terminal/
+
+
         var unzipWithOsx = function unzipWithOsx() {
           debug('unzipping via `ditto`');
-
           var copyingFileRe = /^copying file/;
+          var sp = cp.spawn('ditto', ['-xkV', zipFilePath, installDir]); // f-it just unzip with node
 
-          var sp = cp.spawn('ditto', ['-xkV', zipFilePath, installDir]);
-
-          // f-it just unzip with node
           sp.on('error', function (err) {
             debug(err.message);
             unzipFallback();
           });
-
           sp.on('close', function (code) {
             if (code === 0) {
               // make sure we get to 100% on the progress bar
               // because reading in lines is not really accurate
               percent = 100;
               notify(percent);
-
               return resolve();
             }
 
-            debug('`ditto` failed %o', { code: code });
-
+            debug('`ditto` failed %o', {
+              code: code
+            });
             return unzipFallback();
           });
-
           return readline.createInterface({
             input: sp.stderr
           }).on('line', function (line) {
@@ -183,10 +169,13 @@ var unzipTools = {
         switch (os.platform()) {
           case 'darwin':
             return unzipWithOsx();
+
           case 'linux':
             return unzipWithUnzipTool();
+
           case 'win32':
             return unzipWithNode();
+
           default:
             return;
         }
@@ -204,23 +193,28 @@ var start = function start(_ref2) {
   var zipFilePath = _ref2.zipFilePath,
       installDir = _ref2.installDir,
       progress = _ref2.progress;
-
   la(is.unemptyString(installDir), 'missing installDir');
+
   if (!progress) {
-    progress = { onProgress: function onProgress() {
+    progress = {
+      onProgress: function onProgress() {
         return {};
-      } };
+      }
+    };
   }
 
   return fs.pathExists(installDir).then(function (exists) {
     if (exists) {
       debug('removing existing unzipped binary', installDir);
-
       return fs.removeAsync(installDir);
     }
   }).then(function () {
-    return unzip({ zipFilePath: zipFilePath, installDir: installDir, progress: progress });
-  }).catch(throwFormErrorText(errors.failedUnzip));
+    return unzip({
+      zipFilePath: zipFilePath,
+      installDir: installDir,
+      progress: progress
+    });
+  })["catch"](throwFormErrorText(errors.failedUnzip));
 };
 
 module.exports = {

package/lib/tasks/verify.js

@@ -1,25 +1,76 @@
-'use strict';
+"use strict";
 
-var _templateObject = _taggedTemplateLiteral(['\n      Cypress executable not found at: ', '\n    '], ['\n      Cypress executable not found at: ', '\n    ']),
-    _templateObject2 = _taggedTemplateLiteral(['\n    It looks like this is your first time using Cypress: ', '\n    '], ['\n    It looks like this is your first time using Cypress: ', '\n    ']),
-    _templateObject3 = _taggedTemplateLiteral(['\n      ', ' You have set the environment variable:\n\n      ', '', '\n\n      This overrides the default Cypress binary path used.\n    '], ['\n      ', ' You have set the environment variable:\n\n      ', '', '\n\n      This overrides the default Cypress binary path used.\n    ']),
-    _templateObject4 = _taggedTemplateLiteral(['\n          The supplied binary path is not executable\n          '], ['\n          The supplied binary path is not executable\n          ']),
-    _templateObject5 = _taggedTemplateLiteral(['\n\n\n      ', ' Warning: Binary version ', ' does not match the expected package version ', '\n\n        These versions may not work properly together.\n      '], ['\n\n\n      ', ' Warning: Binary version ', ' does not match the expected package version ', '\n\n        These versions may not work properly together.\n      ']);
+function _templateObject5() {
+  var data = _taggedTemplateLiteral(["\n\n\n      ", " Warning: Binary version ", " does not match the expected package version ", "\n\n        These versions may not work properly together.\n      "]);
 
-function _taggedTemplateLiteral(strings, raw) { return Object.freeze(Object.defineProperties(strings, { raw: { value: Object.freeze(raw) } })); }
+  _templateObject5 = function _templateObject5() {
+    return data;
+  };
+
+  return data;
+}
+
+function _templateObject4() {
+  var data = _taggedTemplateLiteral(["\n          The supplied binary path is not executable\n          "]);
+
+  _templateObject4 = function _templateObject4() {
+    return data;
+  };
+
+  return data;
+}
+
+function _templateObject3() {
+  var data = _taggedTemplateLiteral(["\n      ", " You have set the environment variable:\n\n      ", "", "\n\n      This overrides the default Cypress binary path used.\n    "]);
+
+  _templateObject3 = function _templateObject3() {
+    return data;
+  };
+
+  return data;
+}
+
+function _templateObject2() {
+  var data = _taggedTemplateLiteral(["\n    It looks like this is your first time using Cypress: ", "\n    "]);
+
+  _templateObject2 = function _templateObject2() {
+    return data;
+  };
+
+  return data;
+}
+
+function _templateObject() {
+  var data = _taggedTemplateLiteral(["\n      Cypress executable not found at: ", "\n    "]);
+
+  _templateObject = function _templateObject() {
+    return data;
+  };
+
+  return data;
+}
+
+function _taggedTemplateLiteral(strings, raw) { if (!raw) { raw = strings.slice(0); } return Object.freeze(Object.defineProperties(strings, { raw: { value: Object.freeze(raw) } })); }
 
 var _ = require('lodash');
+
 var chalk = require('chalk');
+
 var Listr = require('listr');
+
 var debug = require('debug')('cypress:cli');
+
 var verbose = require('@cypress/listr-verbose-renderer');
 
 var _require = require('common-tags'),
     stripIndent = _require.stripIndent;
 
 var Promise = require('bluebird');
+
 var logSymbols = require('log-symbols');
+
 var path = require('path');
+
 var os = require('os');
 
 var _require2 = require('../errors'),
@@ -27,28 +78,32 @@ var _require2 = require('../errors'),
     errors = _require2.errors;
 
 var util = require('../util');
+
 var logger = require('../logger');
+
 var xvfb = require('../exec/xvfb');
+
 var state = require('./state');
 
 var VERIFY_TEST_RUNNER_TIMEOUT_MS = 30000;
 
 var checkExecutable = function checkExecutable(binaryDir) {
   var executable = state.getPathToExecutable(binaryDir);
-
   debug('checking if executable exists', executable);
-
   return util.isExecutableAsync(executable).then(function (isExecutable) {
     debug('Binary is executable? :', isExecutable);
+
     if (!isExecutable) {
       return throwFormErrorText(errors.binaryNotExecutable(executable))();
     }
-  }).catch({ code: 'ENOENT' }, function () {
+  })["catch"]({
+    code: 'ENOENT'
+  }, function () {
     if (util.isCi()) {
       return throwFormErrorText(errors.notInstalledCI(executable))();
     }
 
-    return throwFormErrorText(errors.missingApp(binaryDir))(stripIndent(_templateObject, chalk.cyan(executable)));
+    return throwFormErrorText(errors.missingApp(binaryDir))(stripIndent(_templateObject(), chalk.cyan(executable)));
   });
 };
 
@@ -58,20 +113,16 @@ var runSmokeTest = function runSmokeTest(binaryDir, options) {
   var onSmokeTestError = function onSmokeTestError(smokeTestCommand, linuxWithDisplayEnv) {
     return function (err) {
       debug('Smoke test failed:', err);
-
       var errMessage = err.stderr || err.message;
-
       debug('error message:', errMessage);
 
       if (err.timedOut) {
         debug('error timedOut is true');
-
         return throwFormErrorText(errors.smokeTestFailure(smokeTestCommand, true))(errMessage);
       }
 
       if (linuxWithDisplayEnv && util.isBrokenGtkDisplay(errMessage)) {
         util.logBrokenGtkDisplayWarning();
-
         return throwFormErrorText(errors.invalidSmokeTestDisplayError)(errMessage);
       }
 
@@ -80,16 +131,16 @@ var runSmokeTest = function runSmokeTest(binaryDir, options) {
   };
 
   var needsXvfb = xvfb.isNeeded();
-
   debug('needs Xvfb?', needsXvfb);
-
   /**
    * Spawn Cypress running smoke test to check if all operating system
    * dependencies are good.
    */
+
   var spawn = function spawn(linuxWithDisplayEnv) {
     var random = _.random(0, 1000);
-    var args = ['--smoke-test', '--ping=' + random];
+
+    var args = ['--smoke-test', "--ping=".concat(random)];
 
     if (needsSandbox()) {
       // electron requires --no-sandbox to run as root
@@ -102,8 +153,7 @@ var runSmokeTest = function runSmokeTest(binaryDir, options) {
       args.unshift(path.resolve(__dirname, '..', '..', '..', 'scripts', 'start.js'));
     }
 
-    var smokeTestCommand = executable + ' ' + args.join(' ');
-
+    var smokeTestCommand = "".concat(executable, " ").concat(args.join(' '));
     debug('running smoke test');
     debug('using Cypress executable %s', executable);
     debug('smoke test command:', smokeTestCommand);
@@ -118,7 +168,7 @@ var runSmokeTest = function runSmokeTest(binaryDir, options) {
       timeout: options.smokeTestTimeout
     });
 
-    return Promise.resolve(util.exec(executable, args, stdioOptions)).catch(onSmokeTestError(smokeTestCommand, linuxWithDisplayEnv)).then(function (result) {
+    return Promise.resolve(util.exec(executable, args, stdioOptions))["catch"](onSmokeTestError(smokeTestCommand, linuxWithDisplayEnv)).then(function (result) {
       // TODO: when execa > 1.1 is released
       // change this to `result.all` for both stderr and stdout
       // use lodash to be robust during tests against null result or missing stdout
@@ -130,8 +180,8 @@ var runSmokeTest = function runSmokeTest(binaryDir, options) {
         debug('Smoke test failed because could not find %d in:', random, result);
 
         var smokeTestStderr = _.get(result, 'stderr', '');
-        var errorText = smokeTestStderr || smokeTestStdout;
 
+        var errorText = smokeTestStderr || smokeTestStdout;
         return throwFormErrorText(errors.smokeTestFailure(smokeTestCommand, false))(errorText);
       }
     });
@@ -140,78 +190,68 @@ var runSmokeTest = function runSmokeTest(binaryDir, options) {
   var spawnInXvfb = function spawnInXvfb(linuxWithDisplayEnv) {
     return xvfb.start().then(function () {
       return spawn(linuxWithDisplayEnv);
-    }).finally(xvfb.stop);
+    })["finally"](xvfb.stop);
   };
 
   var userFriendlySpawn = function userFriendlySpawn(linuxWithDisplayEnv) {
     debug('spawning, should retry on display problem?', Boolean(linuxWithDisplayEnv));
-
-    return spawn(linuxWithDisplayEnv).catch({ code: 'INVALID_SMOKE_TEST_DISPLAY_ERROR' }, function () {
+    return spawn(linuxWithDisplayEnv)["catch"]({
+      code: 'INVALID_SMOKE_TEST_DISPLAY_ERROR'
+    }, function () {
       return spawnInXvfb(linuxWithDisplayEnv);
     });
   };
 
   if (needsXvfb) {
     return spawnInXvfb();
-  }
-
-  // if we are on linux and there's already a DISPLAY
+  } // if we are on linux and there's already a DISPLAY
   // set, then we may need to rerun cypress after
   // spawning our own Xvfb server
-  var linuxWithDisplayEnv = util.isPossibleLinuxWithIncorrectDisplay();
 
+
+  var linuxWithDisplayEnv = util.isPossibleLinuxWithIncorrectDisplay();
   return userFriendlySpawn(linuxWithDisplayEnv);
 };
 
 function testBinary(version, binaryDir, options) {
-  debug('running binary verification check', version);
+  debug('running binary verification check', version); // if running from 'cypress verify', don't print this message
 
-  // if running from 'cypress verify', don't print this message
   if (!options.force) {
-    logger.log(stripIndent(_templateObject2, chalk.cyan(version)));
+    logger.log(stripIndent(_templateObject2(), chalk.cyan(version)));
   }
 
-  logger.log();
-
-  // if we are running in CI then use
+  logger.log(); // if we are running in CI then use
   // the verbose renderer else use
   // the default
-  var renderer = util.isCi() ? verbose : 'default';
 
+  var renderer = util.isCi() ? verbose : 'default';
   if (logger.logLevel() === 'silent') renderer = 'silent';
-
   var rendererOptions = {
     renderer: renderer
   };
-
   var tasks = new Listr([{
     title: util.titleize('Verifying Cypress can run', chalk.gray(binaryDir)),
     task: function task(ctx, _task) {
       debug('clearing out the verified version');
-
       return state.clearBinaryStateAsync(binaryDir).then(function () {
-        return Promise.all([runSmokeTest(binaryDir, options), Promise.resolve().delay(1500)] // good user experience
-        );
+        return Promise.all([runSmokeTest(binaryDir, options), Promise.resolve().delay(1500) // good user experience
+        ]);
       }).then(function () {
         debug('write verified: true');
-
         return state.writeBinaryVerifiedAsync(true, binaryDir);
       }).then(function () {
         util.setTaskTitle(_task, util.titleize(chalk.green('Verified Cypress!'), chalk.gray(binaryDir)), rendererOptions.renderer);
       });
     }
   }], rendererOptions);
-
   return tasks.run();
 }
 
 var maybeVerify = function maybeVerify(installedVersion, binaryDir, options) {
   return state.getBinaryVerifiedAsync(binaryDir).then(function (isVerified) {
     debug('is Verified ?', isVerified);
+    var shouldVerify = !isVerified; // force verify if options.force
 
-    var shouldVerify = !isVerified;
-
-    // force verify if options.force
     if (options.force) {
       debug('force verify');
       shouldVerify = true;
@@ -230,9 +270,7 @@ var maybeVerify = function maybeVerify(installedVersion, binaryDir, options) {
 
 var start = function start() {
   var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-
   debug('verifying Cypress app');
-
   var packageVersion = util.pkgVersion();
   var binaryDir = state.getBinaryDir(packageVersion);
 
@@ -249,16 +287,14 @@ var start = function start() {
 
   var parseBinaryEnvVar = function parseBinaryEnvVar() {
     var envBinaryPath = util.getEnv('CYPRESS_RUN_BINARY');
-
     debug('CYPRESS_RUN_BINARY exists, =', envBinaryPath);
-    logger.log(stripIndent(_templateObject3, chalk.yellow('Note:'), chalk.white('CYPRESS_RUN_BINARY='), chalk.cyan(envBinaryPath)));
-
+    logger.log(stripIndent(_templateObject3(), chalk.yellow('Note:'), chalk.white('CYPRESS_RUN_BINARY='), chalk.cyan(envBinaryPath)));
     logger.log();
-
     return util.isExecutableAsync(envBinaryPath).then(function (isExecutable) {
       debug('CYPRESS_RUN_BINARY is executable? :', isExecutable);
+
       if (!isExecutable) {
-        return throwFormErrorText(errors.CYPRESS_RUN_BINARY.notValid(envBinaryPath))(stripIndent(_templateObject4));
+        return throwFormErrorText(errors.CYPRESS_RUN_BINARY.notValid(envBinaryPath))(stripIndent(_templateObject4()));
       }
     }).then(function () {
       return state.parseRealPlatformBinaryFolderAsync(envBinaryPath);
@@ -268,15 +304,17 @@ var start = function start() {
       }
 
       debug('CYPRESS_RUN_BINARY has binaryDir:', envBinaryDir);
-
       binaryDir = envBinaryDir;
-    }).catch({ code: 'ENOENT' }, function (err) {
+    })["catch"]({
+      code: 'ENOENT'
+    }, function (err) {
       return throwFormErrorText(errors.CYPRESS_RUN_BINARY.notValid(envBinaryPath))(err.message);
     });
   };
 
-  return Promise.try(function () {
+  return Promise["try"](function () {
     debug('checking environment variables');
+
     if (util.getEnv('CYPRESS_RUN_BINARY')) {
       return parseBinaryEnvVar();
     }
@@ -289,24 +327,22 @@ var start = function start() {
   }).then(function (binaryVersion) {
     if (!binaryVersion) {
       debug('no Cypress binary found for cli version ', packageVersion);
-
-      return throwFormErrorText(errors.missingApp(binaryDir))('\n      Cannot read binary version from: ' + chalk.cyan(state.getBinaryPkgPath(binaryDir)) + '\n    ');
+      return throwFormErrorText(errors.missingApp(binaryDir))("\n      Cannot read binary version from: ".concat(chalk.cyan(state.getBinaryPkgPath(binaryDir)), "\n    "));
     }
 
-    debug('Found binary version ' + chalk.green(binaryVersion) + ' installed in: ' + chalk.cyan(binaryDir));
+    debug("Found binary version ".concat(chalk.green(binaryVersion), " installed in: ").concat(chalk.cyan(binaryDir)));
 
     if (binaryVersion !== packageVersion) {
       // warn if we installed with CYPRESS_INSTALL_BINARY or changed version
       // in the package.json
-      logger.log('Found binary version ' + chalk.green(binaryVersion) + ' installed in: ' + chalk.cyan(binaryDir));
+      logger.log("Found binary version ".concat(chalk.green(binaryVersion), " installed in: ").concat(chalk.cyan(binaryDir)));
       logger.log();
-      logger.warn(stripIndent(_templateObject5, logSymbols.warning, chalk.green(binaryVersion), chalk.green(packageVersion)));
-
+      logger.warn(stripIndent(_templateObject5(), logSymbols.warning, chalk.green(binaryVersion), chalk.green(packageVersion)));
       logger.log();
     }
 
     return maybeVerify(binaryVersion, binaryDir, options);
-  }).catch(function (err) {
+  })["catch"](function (err) {
     if (err.known) {
       throw err;
     }
@@ -318,7 +354,6 @@ var start = function start() {
 var isLinuxLike = function isLinuxLike() {
   return os.platform() !== 'win32';
 };
-
 /**
  * Returns true if running on a system where Electron needs "--no-sandbox" flag.
  * @see https://crbug.com/638180
@@ -328,6 +363,8 @@ var isLinuxLike = function isLinuxLike() {
  * Seems there is a lot of discussion around this issue among Electron users
  * @see https://github.com/electron/electron/issues/17972
 */
+
+
 var needsSandbox = function needsSandbox() {
   return isLinuxLike();
 };