cypress 12.1.0 → 12.3.0

package/lib/tasks/install.js

@@ -1,58 +1,39 @@
 "use strict";
 
 const _ = require('lodash');
-
 const os = require('os');
-
 const path = require('path');
-
 const chalk = require('chalk');
-
 const debug = require('debug')('cypress:cli');
-
 const {
   Listr
 } = require('listr2');
-
 const Promise = require('bluebird');
-
 const logSymbols = require('log-symbols');
-
 const {
   stripIndent
 } = require('common-tags');
-
 const fs = require('../fs');
-
 const download = require('./download');
-
 const util = require('../util');
-
 const state = require('./state');
-
 const unzip = require('./unzip');
-
 const logger = require('../logger');
-
 const {
   throwFormErrorText,
   errors
 } = require('../errors');
-
 const verbose = require('../VerboseRenderer');
-
 const {
   buildInfo,
   version
 } = require('../../package.json');
-
 function _getBinaryUrlFromBuildInfo(arch, {
   commitSha,
   commitBranch
 }) {
   return `https://cdn.cypress.io/beta/binary/${version}/${os.platform()}-${arch}/${commitBranch}-${commitSha}/cypress.zip`;
 }
-
 const alreadyInstalledMsg = () => {
   if (!util.isPostInstall()) {
     logger.log(stripIndent`
@@ -62,7 +43,6 @@ const alreadyInstalledMsg = () => {
     `);
   }
 };
-
 const displayCompletionMsg = () => {
   // check here to see if we are globally installed
   if (util.isInstalledGlobally()) {
@@ -82,14 +62,12 @@ const displayCompletionMsg = () => {
     `);
     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();
 };
-
 const downloadAndUnzip = ({
   version,
   installDir,
@@ -100,8 +78,9 @@ const downloadAndUnzip = ({
     onProgress: null
   };
   const downloadDestination = path.join(downloadDir, `cypress-${process.pid}.zip`);
-  const rendererOptions = getRendererOptions(); // let the user know what version of cypress we're downloading!
+  const rendererOptions = getRendererOptions();
 
+  // let the user know what version of cypress we're downloading!
   logger.log(`Installing Cypress ${chalk.gray(`(version: ${version})`)}`);
   logger.log();
   const tasks = new Listr([{
@@ -137,7 +116,6 @@ const downloadAndUnzip = ({
         debug('removing zip file %s', downloadDestination);
         return fs.removeAsync(downloadDestination);
       };
-
       return cleanup().then(() => {
         debug('finished installation in', installDir);
         util.setTaskTitle(task, util.titleize(chalk.green('Finished Installation'), chalk.gray(installDir)), rendererOptions.renderer);
@@ -145,22 +123,21 @@ const downloadAndUnzip = ({
     }
   }], {
     rendererOptions
-  }); // start the tasks!
+  });
 
+  // start the tasks!
   return Promise.resolve(tasks.run());
 };
-
 const validateOS = () => {
   return util.getPlatformInfo().then(platformInfo => {
     return platformInfo.match(/(win32-x64|linux-x64|linux-arm64|darwin-x64|darwin-arm64)/);
   });
 };
+
 /**
  * Returns the version to install - either a string like `1.2.3` to be fetched
  * from the download server or a file path or HTTP URL.
  */
-
-
 function getVersionOverride({
   arch,
   envVarVersion,
@@ -170,7 +147,6 @@ function getVersionOverride({
   if (envVarVersion) {
     return envVarVersion;
   }
-
   if (buildInfo && !buildInfo.stable) {
     logger.log(chalk.yellow(stripIndent`
         ${logSymbols.warning} Warning: You are installing a pre-release build of Cypress.
@@ -186,21 +162,19 @@ function getVersionOverride({
     return _getBinaryUrlFromBuildInfo(arch, buildInfo);
   }
 }
-
 function getEnvVarVersion() {
-  if (!util.getEnv('CYPRESS_INSTALL_BINARY')) return; // because passed file paths are often double quoted
-  // and might have extra whitespace around, be robust and trim the string
+  if (!util.getEnv('CYPRESS_INSTALL_BINARY')) return;
 
+  // because passed file paths are often double quoted
+  // and might have extra whitespace around, be robust and trim the string
   const trimAndRemoveDoubleQuotes = true;
   const envVarVersion = util.getEnv('CYPRESS_INSTALL_BINARY', trimAndRemoveDoubleQuotes);
   debug('using environment variable CYPRESS_INSTALL_BINARY "%s"', envVarVersion);
   return envVarVersion;
 }
-
 const start = async (options = {}) => {
   debug('installing with options %j', options);
   const envVarVersion = getEnvVarVersion();
-
   if (envVarVersion === '0') {
     debug('environment variable CYPRESS_INSTALL_BINARY = 0, skipping install');
     logger.log(stripIndent`
@@ -208,12 +182,10 @@ const start = async (options = {}) => {
     logger.log();
     return;
   }
-
   _.defaults(options, {
     force: false,
     buildInfo
   });
-
   if (util.getEnv('CYPRESS_CACHE_FOLDER')) {
     const envCache = util.getEnv('CYPRESS_CACHE_FOLDER');
     logger.log(stripIndent`
@@ -223,7 +195,6 @@ const start = async (options = {}) => {
       `);
     logger.log();
   }
-
   const pkgVersion = util.pkgVersion();
   const arch = await util.getRealArch();
   const versionOverride = getVersionOverride({
@@ -236,11 +207,9 @@ const start = async (options = {}) => {
   const installDir = state.getVersionDir(pkgVersion, options.buildInfo);
   const cacheDir = state.getCacheDir();
   const binaryDir = state.getBinaryDir(pkgVersion);
-
   if (!(await validateOS())) {
     return throwFormErrorText(errors.invalidOS)();
   }
-
   await fs.ensureDirAsync(cacheDir).catch({
     code: 'EACCES'
   }, err => {
@@ -252,38 +221,32 @@ const start = async (options = {}) => {
   });
   const binaryPkg = await state.getBinaryPkgAsync(binaryDir);
   const binaryVersion = await state.getBinaryPkgVersion(binaryPkg);
-
   const shouldInstall = () => {
     if (!binaryVersion) {
       debug('no binary installed under cli version');
       return true;
     }
-
     logger.log();
     logger.log(stripIndent`
       Cypress ${chalk.green(binaryVersion)} is installed in ${chalk.cyan(installDir)}
       `);
     logger.log();
-
     if (options.force) {
       debug('performing force install over existing binary');
       return true;
     }
-
     if (binaryVersion === versionToInstall || !util.isSemver(versionToInstall)) {
       // our version matches, tell the user this is a noop
       alreadyInstalledMsg();
       return false;
     }
-
     return true;
-  }; // noop if we've been told not to download
-
+  };
 
+  // noop if we've been told not to download
   if (!shouldInstall()) {
     return debug('Not downloading or installing binary');
   }
-
   if (envVarVersion) {
     logger.log(chalk.yellow(stripIndent`
         ${logSymbols.warning} Warning: Forcing a binary version different than the default.
@@ -296,26 +259,22 @@ const start = async (options = {}) => {
       `));
     logger.log();
   }
-
   const getLocalFilePath = async () => {
     // see if version supplied is a path to a binary
     if (await fs.pathExistsAsync(versionToInstall)) {
       return path.extname(versionToInstall) === '.zip' ? versionToInstall : false;
     }
-
     const possibleFile = util.formAbsolutePath(versionToInstall);
-    debug('checking local file', possibleFile, 'cwd', process.cwd()); // if this exists return the path to it
-    // else false
+    debug('checking local file', possibleFile, 'cwd', process.cwd());
 
+    // if this exists return the path to it
+    // else false
     if ((await fs.pathExistsAsync(possibleFile)) && path.extname(possibleFile) === '.zip') {
       return possibleFile;
     }
-
     return false;
   };
-
   const pathToLocalFile = await getLocalFilePath();
-
   if (pathToLocalFile) {
     const absolutePath = path.resolve(versionToInstall);
     debug('found local file at', absolutePath);
@@ -333,29 +292,26 @@ const start = async (options = {}) => {
       rendererOptions
     }).run();
   }
-
   if (options.force) {
     debug('Cypress already installed at', installDir);
     debug('but the installation was forced');
   }
-
   debug('preparing to download and unzip version ', versionToInstall, 'to path', installDir);
   const downloadDir = os.tmpdir();
   await downloadAndUnzip({
     version: versionToInstall,
     installDir,
     downloadDir
-  }); // delay 1 sec for UX, unless we are testing
+  });
 
+  // delay 1 sec for UX, unless we are testing
   await Promise.delay(1000);
   displayCompletionMsg();
 };
-
 module.exports = {
   start,
   _getBinaryUrlFromBuildInfo
 };
-
 const unzipTask = ({
   zipFilePath,
   installDir,
@@ -379,27 +335,25 @@ const unzipTask = ({
     }
   };
 };
-
 const progessify = (task, title) => {
   // return higher order function
   return (percentComplete, remaining) => {
-    percentComplete = chalk.white(` ${percentComplete}%`); // pluralize seconds remaining
+    percentComplete = chalk.white(` ${percentComplete}%`);
 
+    // pluralize seconds remaining
     remaining = chalk.gray(`${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
-
-
 const getRendererOptions = () => {
   let renderer = util.isCi() ? verbose : 'default';
-
   if (logger.logLevel() === 'silent') {
     renderer = 'silent';
   }
-
   return {
     renderer
   };

package/lib/tasks/state.js

@@ -1,111 +1,83 @@
 "use strict";
 
 const _ = require('lodash');
-
 const os = require('os');
-
 const path = require('path');
-
 const untildify = require('untildify');
-
 const debug = require('debug')('cypress:cli');
-
 const fs = require('../fs');
-
 const util = require('../util');
-
 const getPlatformExecutable = () => {
   const platform = os.platform();
-
   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.`);
   }
 };
-
 const getPlatFormBinaryFolder = () => {
   const platform = os.platform();
-
   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.`);
   }
 };
-
 const getBinaryPkgPath = binaryDir => {
   const platform = os.platform();
-
   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.`);
   }
 };
+
 /**
  * Get path to binary directory
 */
-
-
 const getBinaryDir = (version = util.pkgVersion()) => {
   return path.join(getVersionDir(version), getPlatFormBinaryFolder());
 };
-
 const getVersionDir = (version = util.pkgVersion(), buildInfo = util.pkgBuildInfo()) => {
   if (buildInfo && !buildInfo.stable) {
     version = ['beta', version, buildInfo.commitBranch, buildInfo.commitSha.slice(0, 8)].join('-');
   }
-
   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.
  */
-
-
 const isInstallingFromPostinstallHook = () => {
   // individual folders
   const cwdFolders = process.cwd().split(path.sep);
   const length = cwdFolders.length;
   return cwdFolders[length - 2] === 'node_modules' && cwdFolders[length - 1] === 'cypress';
 };
-
 const getCacheDir = () => {
   let cache_directory = util.getCacheDir();
-
   if (util.getEnv('CYPRESS_CACHE_FOLDER')) {
     const envVarCacheDir = untildify(util.getEnv('CYPRESS_CACHE_FOLDER'));
     debug('using environment variable CYPRESS_CACHE_FOLDER %s', envVarCacheDir);
-
     if (!path.isAbsolute(envVarCacheDir) && isInstallingFromPostinstallHook()) {
       const packageRootFolder = path.join('..', '..', envVarCacheDir);
       cache_directory = path.resolve(packageRootFolder);
@@ -115,40 +87,32 @@ const getCacheDir = () => {
       cache_directory = path.resolve(envVarCacheDir);
     }
   }
-
   return cache_directory;
 };
-
 const parseRealPlatformBinaryFolderAsync = binaryPath => {
   return fs.realpathAsync(binaryPath).then(realPath => {
     debug('CYPRESS_RUN_BINARY has realpath:', realPath);
-
     if (!realPath.toString().endsWith(getPlatformExecutable())) {
       return false;
     }
-
     if (os.platform() === 'darwin') {
       return path.resolve(realPath, '..', '..', '..');
     }
-
     return path.resolve(realPath, '..');
   });
 };
-
 const 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.
  */
-
-
 const getBinaryStatePath = binaryDir => {
   return path.join(binaryDir, '..', 'binary_state.json');
 };
-
 const getBinaryStateContentsAsync = binaryDir => {
   const fullPath = getBinaryStatePath(binaryDir);
   return fs.readJsonAsync(fullPath).catch({
@@ -158,22 +122,19 @@ const getBinaryStateContentsAsync = binaryDir => {
     return {};
   });
 };
-
 const getBinaryVerifiedAsync = binaryDir => {
   return getBinaryStateContentsAsync(binaryDir).tap(debug).get('verified');
 };
-
 const 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
  */
-
-
 const writeBinaryVerifiedAsync = (verified, binaryDir) => {
   return getBinaryStateContentsAsync(binaryDir).then(contents => {
     return fs.outputJsonAsync(getBinaryStatePath(binaryDir), _.extend(contents, {
@@ -183,16 +144,14 @@ const writeBinaryVerifiedAsync = (verified, binaryDir) => {
     });
   });
 };
-
 const getPathToExecutable = binaryDir => {
   return path.join(binaryDir, getPlatformExecutable());
 };
+
 /**
  * Resolves with an object read from the binary app package.json file.
  * If the file does not exist resolves with null
  */
-
-
 const getBinaryPkgAsync = binaryDir => {
   const pathToPackageJson = getBinaryPkgPath(binaryDir);
   debug('Reading binary package.json from:', pathToPackageJson);
@@ -200,17 +159,12 @@ const getBinaryPkgAsync = binaryDir => {
     if (!exists) {
       return null;
     }
-
     return fs.readJsonAsync(pathToPackageJson);
   });
 };
-
 const getBinaryPkgVersion = o => _.get(o, 'version', null);
-
 const getBinaryElectronVersion = o => _.get(o, 'electronVersion', null);
-
 const getBinaryElectronNodeVersion = o => _.get(o, 'electronNodeVersion', null);
-
 module.exports = {
   getPathToExecutable,
   getPlatformExecutable,