cypress 4.4.1 → 4.5.0

package/lib/tasks/install.js

@@ -1,33 +1,108 @@
-'use strict';
+"use strict";
 
-var _templateObject = _taggedTemplateLiteral(['\n      Skipping installation:\n\n        Pass the ', ' option if you\'d like to reinstall anyway.\n    '], ['\n      Skipping installation:\n\n        Pass the ', ' option if you\'d like to reinstall anyway.\n    ']),
-    _templateObject2 = _taggedTemplateLiteral(['\n      ', ' Warning: It looks like you\'ve installed Cypress globally.\n\n        This will work, but it\'s not recommended.\n\n        The recommended way to install Cypress is as a devDependency per project.\n\n        You should probably run these commands:\n\n        - ', '\n        - ', '\n    '], ['\n      ', ' Warning: It looks like you\\\'ve installed Cypress globally.\n\n        This will work, but it\'\\s not recommended.\n\n        The recommended way to install Cypress is as a devDependency per project.\n\n        You should probably run these commands:\n\n        - ', '\n        - ', '\n    ']),
-    _templateObject3 = _taggedTemplateLiteral(['\n        ', ' Skipping binary installation: Environment variable CYPRESS_INSTALL_BINARY = 0.'], ['\n        ', ' Skipping binary installation: Environment variable CYPRESS_INSTALL_BINARY = 0.']),
-    _templateObject4 = _taggedTemplateLiteral(['\n        ', ' Overriding Cypress cache directory to: ', '\n\n              Previous installs of Cypress may not be found.\n      '], ['\n        ', ' Overriding Cypress cache directory to: ', '\n\n              Previous installs of Cypress may not be found.\n      ']),
-    _templateObject5 = _taggedTemplateLiteral(['\n    Failed to access ', ':\n\n    ', '\n    '], ['\n    Failed to access ', ':\n\n    ', '\n    ']),
-    _templateObject6 = _taggedTemplateLiteral(['\n      Cypress ', ' is installed in ', '\n      '], ['\n      Cypress ', ' is installed in ', '\n      ']),
-    _templateObject7 = _taggedTemplateLiteral(['\n          ', ' Warning: Forcing a binary version different than the default.\n\n            The CLI expected to install version: ', '\n\n            Instead we will install version: ', '\n\n            These versions may not work properly together.\n        '], ['\n          ', ' Warning: Forcing a binary version different than the default.\n\n            The CLI expected to install version: ', '\n\n            Instead we will install version: ', '\n\n            These versions may not work properly together.\n        ']);
+function _templateObject7() {
+  var data = _taggedTemplateLiteral(["\n          ", " Warning: Forcing a binary version different than the default.\n\n            The CLI expected to install version: ", "\n\n            Instead we will install 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) } })); }
+  _templateObject7 = function _templateObject7() {
+    return data;
+  };
+
+  return data;
+}
+
+function _templateObject6() {
+  var data = _taggedTemplateLiteral(["\n      Cypress ", " is installed in ", "\n      "]);
+
+  _templateObject6 = function _templateObject6() {
+    return data;
+  };
+
+  return data;
+}
+
+function _templateObject5() {
+  var data = _taggedTemplateLiteral(["\n    Failed to access ", ":\n\n    ", "\n    "]);
+
+  _templateObject5 = function _templateObject5() {
+    return data;
+  };
+
+  return data;
+}
+
+function _templateObject4() {
+  var data = _taggedTemplateLiteral(["\n        ", " Overriding Cypress cache directory to: ", "\n\n              Previous installs of Cypress may not be found.\n      "]);
+
+  _templateObject4 = function _templateObject4() {
+    return data;
+  };
+
+  return data;
+}
+
+function _templateObject3() {
+  var data = _taggedTemplateLiteral(["\n        ", " Skipping binary installation: Environment variable CYPRESS_INSTALL_BINARY = 0."]);
+
+  _templateObject3 = function _templateObject3() {
+    return data;
+  };
+
+  return data;
+}
+
+function _templateObject2() {
+  var data = _taggedTemplateLiteral(["\n      ", " Warning: It looks like you've installed Cypress globally.\n\n        This will work, but it's not recommended.\n\n        The recommended way to install Cypress is as a devDependency per project.\n\n        You should probably run these commands:\n\n        - ", "\n        - ", "\n    "], ["\n      ", " Warning: It looks like you\\'ve installed Cypress globally.\n\n        This will work, but it'\\s not recommended.\n\n        The recommended way to install Cypress is as a devDependency per project.\n\n        You should probably run these commands:\n\n        - ", "\n        - ", "\n    "]);
+
+  _templateObject2 = function _templateObject2() {
+    return data;
+  };
+
+  return data;
+}
+
+function _templateObject() {
+  var data = _taggedTemplateLiteral(["\n      Skipping installation:\n\n        Pass the ", " option if you'd like to reinstall anyway.\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 os = require('os');
+
 var path = require('path');
+
 var chalk = require('chalk');
+
 var debug = require('debug')('cypress:cli');
+
 var Listr = require('listr');
+
 var verbose = require('@cypress/listr-verbose-renderer');
+
 var Promise = require('bluebird');
+
 var logSymbols = require('log-symbols');
 
 var _require = require('common-tags'),
     stripIndent = _require.stripIndent;
 
 var fs = require('../fs');
+
 var download = require('./download');
+
 var util = require('../util');
+
 var state = require('./state');
+
 var unzip = require('./unzip');
+
 var logger = require('../logger');
 
 var _require2 = require('../errors'),
@@ -36,7 +111,7 @@ var _require2 = require('../errors'),
 
 var alreadyInstalledMsg = function alreadyInstalledMsg() {
   if (!util.isPostInstall()) {
-    logger.log(stripIndent(_templateObject, chalk.yellow('--force')));
+    logger.log(stripIndent(_templateObject(), chalk.yellow('--force')));
   }
 };
 
@@ -45,14 +120,12 @@ var displayCompletionMsg = function displayCompletionMsg() {
   if (util.isInstalledGlobally()) {
     // if we are display a warning
     logger.log();
-    logger.warn(stripIndent(_templateObject2, logSymbols.warning, chalk.cyan('npm uninstall -g cypress'), chalk.cyan('npm install --save-dev cypress')));
-
+    logger.warn(stripIndent(_templateObject2(), logSymbols.warning, chalk.cyan('npm uninstall -g cypress'), chalk.cyan('npm install --save-dev cypress')));
     return;
   }
 
   logger.log();
   logger.log('You can now open Cypress by running:', chalk.cyan(path.join('node_modules', '.bin', 'cypress'), 'open'));
-
   logger.log();
   logger.log(chalk.grey('https://on.cypress.io/installing-cypress'));
   logger.log();
@@ -62,28 +135,27 @@ var downloadAndUnzip = function downloadAndUnzip(_ref) {
   var version = _ref.version,
       installDir = _ref.installDir,
       downloadDir = _ref.downloadDir;
-
   var progress = {
     throttle: 100,
     onProgress: null
   };
   var downloadDestination = path.join(downloadDir, 'cypress.zip');
-  var rendererOptions = getRendererOptions();
+  var rendererOptions = getRendererOptions(); // let the user know what version of cypress we're downloading!
 
-  // let the user know what version of cypress we're downloading!
-  logger.log('Installing Cypress ' + chalk.gray('(version: ' + version + ')'));
+  logger.log("Installing Cypress ".concat(chalk.gray("(version: ".concat(version, ")"))));
   logger.log();
-
   var tasks = new Listr([{
     title: util.titleize('Downloading Cypress'),
     task: function task(ctx, _task) {
       // as our download progresses indicate the status
       progress.onProgress = progessify(_task, 'Downloading Cypress');
-
-      return download.start({ version: version, downloadDestination: downloadDestination, progress: progress }).then(function (redirectVersion) {
+      return download.start({
+        version: version,
+        downloadDestination: downloadDestination,
+        progress: progress
+      }).then(function (redirectVersion) {
         if (redirectVersion) version = redirectVersion;
-
-        debug('finished downloading file: ' + downloadDestination);
+        debug("finished downloading file: ".concat(downloadDestination));
       }).then(function () {
         // save the download destination for unzipping
         util.setTaskTitle(_task, util.titleize(chalk.green('Downloaded Cypress')), rendererOptions.renderer);
@@ -99,19 +171,16 @@ var downloadAndUnzip = function downloadAndUnzip(_ref) {
     task: function task(ctx, _task2) {
       var cleanup = function cleanup() {
         debug('removing zip file %s', downloadDestination);
-
         return fs.removeAsync(downloadDestination);
       };
 
       return cleanup().then(function () {
         debug('finished installation in', installDir);
-
         util.setTaskTitle(_task2, util.titleize(chalk.green('Finished Installation'), chalk.gray(installDir)), rendererOptions.renderer);
       });
     }
-  }], rendererOptions);
+  }], rendererOptions); // start the tasks!
 
-  // start the tasks!
   return Promise.resolve(tasks.run());
 };
 
@@ -135,29 +204,24 @@ var start = function start() {
 
   var pkgVersion = util.pkgVersion();
   var needVersion = pkgVersion;
+  debug('version in package.json is', needVersion); // let this environment variable reset the binary version we need
 
-  debug('version in package.json is', needVersion);
-
-  // let this environment variable reset the binary version we need
   if (util.getEnv('CYPRESS_INSTALL_BINARY')) {
     // because passed file paths are often double quoted
     // and might have extra whitespace around, be robust and trim the string
     var trimAndRemoveDoubleQuotes = true;
     var envVarVersion = util.getEnv('CYPRESS_INSTALL_BINARY', trimAndRemoveDoubleQuotes);
-
     debug('using environment variable CYPRESS_INSTALL_BINARY "%s"', envVarVersion);
 
     if (envVarVersion === '0') {
       debug('environment variable CYPRESS_INSTALL_BINARY = 0, skipping install');
-      logger.log(stripIndent(_templateObject3, chalk.yellow('Note:')));
-
+      logger.log(stripIndent(_templateObject3(), chalk.yellow('Note:')));
       logger.log();
-
       return Promise.resolve();
-    }
-
-    // if this doesn't match the expected version
+    } // if this doesn't match the expected version
     // then print warning to the user
+
+
     if (envVarVersion !== needVersion) {
       // reset the version to the env var version
       needVersion = envVarVersion;
@@ -166,44 +230,38 @@ var start = function start() {
 
   if (util.getEnv('CYPRESS_CACHE_FOLDER')) {
     var envCache = util.getEnv('CYPRESS_CACHE_FOLDER');
-
-    logger.log(stripIndent(_templateObject4, chalk.yellow('Note:'), chalk.cyan(envCache)));
-
+    logger.log(stripIndent(_templateObject4(), chalk.yellow('Note:'), chalk.cyan(envCache)));
     logger.log();
   }
 
   var installDir = state.getVersionDir(pkgVersion);
   var cacheDir = state.getCacheDir();
   var binaryDir = state.getBinaryDir(pkgVersion);
-
-  return fs.ensureDirAsync(cacheDir).catch({ code: 'EACCES' }, function (err) {
-    return throwFormErrorText(errors.invalidCacheDirectory)(stripIndent(_templateObject5, chalk.cyan(cacheDir), err.message));
+  return fs.ensureDirAsync(cacheDir)["catch"]({
+    code: 'EACCES'
+  }, function (err) {
+    return throwFormErrorText(errors.invalidCacheDirectory)(stripIndent(_templateObject5(), chalk.cyan(cacheDir), err.message));
   }).then(function () {
     return state.getBinaryPkgVersionAsync(binaryDir);
   }).then(function (binaryVersion) {
     if (!binaryVersion) {
       debug('no binary installed under cli version');
-
       return true;
     }
 
     debug('installed version is', binaryVersion, 'version needed is', needVersion);
-
     logger.log();
-    logger.log(stripIndent(_templateObject6, chalk.green(binaryVersion), chalk.cyan(installDir)));
-
+    logger.log(stripIndent(_templateObject6(), chalk.green(binaryVersion), chalk.cyan(installDir)));
     logger.log();
 
     if (options.force) {
       debug('performing force install over existing binary');
-
       return true;
     }
 
     if (binaryVersion === needVersion || !util.isSemver(needVersion)) {
       // our version matches, tell the user this is a noop
       alreadyInstalledMsg();
-
       return false;
     }
 
@@ -212,26 +270,22 @@ var start = function start() {
     // noop if we've been told not to download
     if (!shouldInstall) {
       debug('Not downloading or installing binary');
-
       return;
     }
 
     if (needVersion !== pkgVersion) {
-      logger.log(chalk.yellow(stripIndent(_templateObject7, logSymbols.warning, chalk.green(pkgVersion), chalk.green(needVersion))));
-
+      logger.log(chalk.yellow(stripIndent(_templateObject7(), logSymbols.warning, chalk.green(pkgVersion), chalk.green(needVersion))));
       logger.log();
-    }
+    } // see if version supplied is a path to a binary
+
 
-    // see if version supplied is a path to a binary
     return fs.pathExistsAsync(needVersion).then(function (exists) {
       if (exists) {
         return path.extname(needVersion) === '.zip' ? needVersion : false;
       }
 
       var possibleFile = util.formAbsolutePath(needVersion);
-
       debug('checking local file', possibleFile, 'cwd', process.cwd());
-
       return fs.pathExistsAsync(possibleFile).then(function (exists) {
         // if this exists return the path to it
         // else false
@@ -244,12 +298,9 @@ var start = function start() {
     }).then(function (pathToLocalFile) {
       if (pathToLocalFile) {
         var absolutePath = path.resolve(needVersion);
-
         debug('found local file at', absolutePath);
         debug('skipping download');
-
         var rendererOptions = getRendererOptions();
-
         return new Listr([unzipTask({
           progress: {
             throttle: 100,
@@ -267,12 +318,13 @@ var start = function start() {
       }
 
       debug('preparing to download and unzip version ', needVersion, 'to path', installDir);
-
       var downloadDir = os.tmpdir();
-
-      return downloadAndUnzip({ version: needVersion, installDir: installDir, downloadDir: downloadDir });
-    })
-    // delay 1 sec for UX, unless we are testing
+      return downloadAndUnzip({
+        version: needVersion,
+        installDir: installDir,
+        downloadDir: downloadDir
+      });
+    }) // delay 1 sec for UX, unless we are testing
     .then(function () {
       return Promise.delay(1000);
     }).then(displayCompletionMsg);
@@ -288,14 +340,16 @@ var unzipTask = function unzipTask(_ref2) {
       installDir = _ref2.installDir,
       progress = _ref2.progress,
       rendererOptions = _ref2.rendererOptions;
-
   return {
     title: util.titleize('Unzipping Cypress'),
     task: function task(ctx, _task3) {
       // as our unzip progresses indicate the status
       progress.onProgress = progessify(_task3, 'Unzipping Cypress');
-
-      return unzip.start({ zipFilePath: zipFilePath, installDir: installDir, progress: progress }).then(function () {
+      return unzip.start({
+        zipFilePath: zipFilePath,
+        installDir: installDir,
+        progress: progress
+      }).then(function () {
         util.setTaskTitle(_task3, util.titleize(chalk.green('Unzipped Cypress')), rendererOptions.renderer);
       });
     }
@@ -305,18 +359,16 @@ var unzipTask = function unzipTask(_ref2) {
 var progessify = function progessify(task, title) {
   // return higher order function
   return function (percentComplete, remaining) {
-    percentComplete = chalk.white(' ' + percentComplete + '%');
-
-    // pluralize seconds remaining
-    remaining = chalk.gray(remaining + 's');
+    percentComplete = chalk.white(" ".concat(percentComplete, "%")); // pluralize seconds remaining
 
+    remaining = chalk.gray("".concat(remaining, "s"));
     util.setTaskTitle(task, util.titleize(title, percentComplete, remaining), getRendererOptions().renderer);
   };
-};
-
-// if we are running in CI then use
+}; // if we are running in CI then use
 // the verbose renderer else use
 // the default
+
+
 var getRendererOptions = function getRendererOptions() {
   var renderer = util.isCi() ? verbose : 'default';
 

package/lib/tasks/state.js

@@ -1,12 +1,17 @@
-'use strict';
+"use strict";
 
 var _ = require('lodash');
+
 var os = require('os');
+
 var path = require('path');
+
 var untildify = require('untildify');
+
 var debug = require('debug')('cypress:cli');
 
 var fs = require('../fs');
+
 var util = require('../util');
 
 var getPlatformExecutable = function getPlatformExecutable() {
@@ -15,13 +20,16 @@ var getPlatformExecutable = function getPlatformExecutable() {
   switch (platform) {
     case 'darwin':
       return 'Contents/MacOS/Cypress';
+
     case 'linux':
       return 'Cypress';
+
     case 'win32':
       return 'Cypress.exe';
     // TODO handle this error using our standard
+
     default:
-      throw new Error('Platform: "' + platform + '" is not supported.');
+      throw new Error("Platform: \"".concat(platform, "\" is not supported."));
   }
 };
 
@@ -31,13 +39,16 @@ var getPlatFormBinaryFolder = function getPlatFormBinaryFolder() {
   switch (platform) {
     case 'darwin':
       return 'Cypress.app';
+
     case 'linux':
       return 'Cypress';
+
     case 'win32':
       return 'Cypress';
     // TODO handle this error using our standard
+
     default:
-      throw new Error('Platform: "' + platform + '" is not supported.');
+      throw new Error("Platform: \"".concat(platform, "\" is not supported."));
   }
 };
 
@@ -47,40 +58,42 @@ var getBinaryPkgPath = function getBinaryPkgPath(binaryDir) {
   switch (platform) {
     case 'darwin':
       return path.join(binaryDir, 'Contents', 'Resources', 'app', 'package.json');
+
     case 'linux':
       return path.join(binaryDir, 'resources', 'app', 'package.json');
+
     case 'win32':
       return path.join(binaryDir, 'resources', 'app', 'package.json');
     // TODO handle this error using our standard
+
     default:
-      throw new Error('Platform: "' + platform + '" is not supported.');
+      throw new Error("Platform: \"".concat(platform, "\" is not supported."));
   }
 };
-
 /**
  * Get path to binary directory
 */
+
+
 var getBinaryDir = function getBinaryDir() {
   var version = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : util.pkgVersion();
-
   return path.join(getVersionDir(version), getPlatFormBinaryFolder());
 };
 
 var getVersionDir = function getVersionDir() {
   var version = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : util.pkgVersion();
-
   return path.join(getCacheDir(), version);
 };
-
 /**
  * When executing "npm postinstall" hook, the working directory is set to
  * "<current folder>/node_modules/cypress", which can be surprising when using relative paths.
  */
+
+
 var isInstallingFromPostinstallHook = function isInstallingFromPostinstallHook() {
   // individual folders
   var cwdFolders = process.cwd().split(path.sep);
   var length = cwdFolders.length;
-
   return cwdFolders[length - 2] === 'node_modules' && cwdFolders[length - 1] === 'cypress';
 };
 
@@ -89,12 +102,10 @@ var getCacheDir = function getCacheDir() {
 
   if (util.getEnv('CYPRESS_CACHE_FOLDER')) {
     var envVarCacheDir = untildify(util.getEnv('CYPRESS_CACHE_FOLDER'));
-
     debug('using environment variable CYPRESS_CACHE_FOLDER %s', envVarCacheDir);
 
     if (!path.isAbsolute(envVarCacheDir) && isInstallingFromPostinstallHook()) {
       var packageRootFolder = path.join('..', '..', envVarCacheDir);
-
       cache_directory = path.resolve(packageRootFolder);
       debug('installing from postinstall hook, original root folder is %s', packageRootFolder);
       debug('and resolved cache directory is %s', cache_directory);
@@ -109,6 +120,7 @@ var getCacheDir = function getCacheDir() {
 var parseRealPlatformBinaryFolderAsync = function parseRealPlatformBinaryFolderAsync(binaryPath) {
   return fs.realpathAsync(binaryPath).then(function (realPath) {
     debug('CYPRESS_RUN_BINARY has realpath:', realPath);
+
     if (!realPath.toString().endsWith(getPlatformExecutable())) {
       return false;
     }
@@ -124,22 +136,23 @@ var parseRealPlatformBinaryFolderAsync = function parseRealPlatformBinaryFolderA
 var getDistDir = function getDistDir() {
   return path.join(__dirname, '..', '..', 'dist');
 };
-
 /**
  * Returns full filename to the file that keeps the Test Runner verification state as JSON text.
  * Note: the binary state file will be stored one level up from the given binary folder.
  * @param {string} binaryDir - full path to the folder holding the binary.
  */
+
+
 var getBinaryStatePath = function getBinaryStatePath(binaryDir) {
   return path.join(binaryDir, '..', 'binary_state.json');
 };
 
 var getBinaryStateContentsAsync = function getBinaryStateContentsAsync(binaryDir) {
   var fullPath = getBinaryStatePath(binaryDir);
-
-  return fs.readJsonAsync(fullPath).catch({ code: 'ENOENT' }, SyntaxError, function () {
+  return fs.readJsonAsync(fullPath)["catch"]({
+    code: 'ENOENT'
+  }, SyntaxError, function () {
     debug('could not read binary_state.json file at "%s"', fullPath);
-
     return {};
   });
 };
@@ -151,16 +164,21 @@ var getBinaryVerifiedAsync = function getBinaryVerifiedAsync(binaryDir) {
 var clearBinaryStateAsync = function clearBinaryStateAsync(binaryDir) {
   return fs.removeAsync(getBinaryStatePath(binaryDir));
 };
-
 /**
  * Writes the new binary status.
  * @param {boolean} verified The new test runner state after smoke test
  * @param {string} binaryDir Folder holding the binary
  * @returns {Promise<void>} returns a promise
  */
+
+
 var writeBinaryVerifiedAsync = function writeBinaryVerifiedAsync(verified, binaryDir) {
   return getBinaryStateContentsAsync(binaryDir).then(function (contents) {
-    return fs.outputJsonAsync(getBinaryStatePath(binaryDir), _.extend(contents, { verified: verified }), { spaces: 2 });
+    return fs.outputJsonAsync(getBinaryStatePath(binaryDir), _.extend(contents, {
+      verified: verified
+    }), {
+      spaces: 2
+    });
   });
 };
 
@@ -170,9 +188,7 @@ var getPathToExecutable = function getPathToExecutable(binaryDir) {
 
 var getBinaryPkgVersionAsync = function getBinaryPkgVersionAsync(binaryDir) {
   var pathToPackageJson = getBinaryPkgPath(binaryDir);
-
   debug('Reading binary package.json from:', pathToPackageJson);
-
   return fs.pathExistsAsync(pathToPackageJson).then(function (exists) {
     if (!exists) {
       return null;