cypress 12.1.0 → 12.2.0

package/lib/tasks/unzip.js

@@ -1,38 +1,26 @@
 "use strict";
 
 const _ = require('lodash');
-
 const la = require('lazy-ass');
-
 const is = require('check-more-types');
-
 const cp = require('child_process');
-
 const os = require('os');
-
 const yauzl = require('yauzl');
-
 const debug = require('debug')('cypress:cli:unzip');
-
 const extract = require('extract-zip');
-
 const Promise = require('bluebird');
-
 const readline = require('readline');
-
 const {
   throwFormErrorText,
   errors
 } = require('../errors');
-
 const fs = require('../fs');
-
 const util = require('../util');
-
 const unzipTools = {
   extract
-}; // expose this function for simple testing
+};
 
+// expose this function for simple testing
 const unzip = ({
   zipFilePath,
   installDir,
@@ -40,42 +28,35 @@ const unzip = ({
 }) => {
   debug('unzipping from %s', zipFilePath);
   debug('into', installDir);
-
   if (!zipFilePath) {
     throw new Error('Missing zip filename');
   }
-
   const startTime = Date.now();
   let yauzlDoneTime = 0;
   return fs.ensureDirAsync(installDir).then(() => {
     return new Promise((resolve, reject) => {
       return yauzl.open(zipFilePath, (err, zipFile) => {
         yauzlDoneTime = Date.now();
-
         if (err) {
           debug('error using yauzl %s', err.message);
           return reject(err);
         }
-
         const total = zipFile.entryCount;
         debug('zipFile entries count', total);
         const started = new Date();
         let percent = 0;
         let count = 0;
-
         const notify = percent => {
           const elapsed = +new Date() - +started;
           const eta = util.calculateEta(percent, elapsed);
           progress.onProgress(percent, util.secsRemaining(eta));
         };
-
         const tick = () => {
           count += 1;
           percent = count / total * 100;
           const displayPercent = percent.toFixed(0);
           return notify(displayPercent);
         };
-
         const unzipWithNode = () => {
           debug('unzipping with node.js (slow)');
           const opts = {
@@ -93,9 +74,7 @@ const unzip = ({
             }
           });
         };
-
         const unzipFallback = _.once(unzipWithNode);
-
         const unzipWithUnzipTool = () => {
           debug('unzipping via `unzip`');
           const inflatingRe = /inflating:/;
@@ -106,13 +85,11 @@ const unzip = ({
           });
           sp.on('close', code => {
             debug('unzip tool close with code %d', code);
-
             if (code === 0) {
               percent = 100;
               notify(percent);
               return resolve();
             }
-
             debug('`unzip` failed %o', {
               code
             });
@@ -126,18 +103,19 @@ const unzip = ({
           sp.stderr.on('data', 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/
-
-
         const unzipWithOsx = () => {
           debug('unzipping via `ditto`');
           const copyingFileRe = /^copying file/;
-          const sp = cp.spawn('ditto', ['-xkV', zipFilePath, installDir]); // f-it just unzip with node
+          const sp = cp.spawn('ditto', ['-xkV', zipFilePath, installDir]);
 
+          // f-it just unzip with node
           sp.on('error', err => {
             debug(err.message);
             unzipFallback();
@@ -150,7 +128,6 @@ const unzip = ({
               notify(percent);
               return resolve();
             }
-
             debug('`ditto` failed %o', {
               code
             });
@@ -164,17 +141,13 @@ const unzip = ({
             }
           });
         };
-
         switch (os.platform()) {
           case 'darwin':
             return unzipWithOsx();
-
           case 'linux':
             return unzipWithUnzipTool();
-
           case 'win32':
             return unzipWithNode();
-
           default:
             return;
         }
@@ -187,18 +160,15 @@ const unzip = ({
     });
   });
 };
-
 function isMaybeWindowsMaxPathLengthError(err) {
   return os.platform() === 'win32' && err.code === 'ENOENT' && err.syscall === 'realpath';
 }
-
 const start = async ({
   zipFilePath,
   installDir,
   progress
 }) => {
   la(is.unemptyString(installDir), 'missing installDir');
-
   if (!progress) {
     progress = {
       onProgress: () => {
@@ -206,15 +176,12 @@ const start = async ({
       }
     };
   }
-
   try {
     const installDirExists = await fs.pathExists(installDir);
-
     if (installDirExists) {
       debug('removing existing unzipped binary', installDir);
       await fs.removeAsync(installDir);
     }
-
     await unzip({
       zipFilePath,
       installDir,
@@ -225,7 +192,6 @@ const start = async ({
     await throwFormErrorText(errorTemplate)(err);
   }
 };
-
 module.exports = {
   start,
   utils: {

package/lib/tasks/verify.js

@@ -1,50 +1,33 @@
 "use strict";
 
 const _ = require('lodash');
-
 const chalk = require('chalk');
-
 const {
   Listr
 } = require('listr2');
-
 const debug = require('debug')('cypress:cli');
-
 const {
   stripIndent
 } = require('common-tags');
-
 const Promise = require('bluebird');
-
 const logSymbols = require('log-symbols');
-
 const path = require('path');
-
 const os = require('os');
-
 const verbose = require('../VerboseRenderer');
-
 const {
   throwFormErrorText,
   errors
 } = require('../errors');
-
 const util = require('../util');
-
 const logger = require('../logger');
-
 const xvfb = require('../exec/xvfb');
-
 const state = require('./state');
-
 const VERIFY_TEST_RUNNER_TIMEOUT_MS = +util.getEnv('CYPRESS_VERIFY_TIMEOUT') || 30000;
-
 const checkExecutable = binaryDir => {
   const executable = state.getPathToExecutable(binaryDir);
   debug('checking if executable exists', executable);
   return util.isExecutableAsync(executable).then(isExecutable => {
     debug('Binary is executable? :', isExecutable);
-
     if (!isExecutable) {
       return throwFormErrorText(errors.binaryNotExecutable(executable))();
     }
@@ -54,99 +37,79 @@ const checkExecutable = binaryDir => {
     if (util.isCi()) {
       return throwFormErrorText(errors.notInstalledCI(executable))();
     }
-
     return throwFormErrorText(errors.missingApp(binaryDir))(stripIndent`
       Cypress executable not found at: ${chalk.cyan(executable)}
     `);
   });
 };
-
 const runSmokeTest = (binaryDir, options) => {
   let executable = state.getPathToExecutable(binaryDir);
-
   const onSmokeTestError = (smokeTestCommand, linuxWithDisplayEnv) => {
     return err => {
       debug('Smoke test failed:', err);
       let 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);
       }
-
       return throwFormErrorText(errors.missingDependency)(errMessage);
     };
   };
-
   const needsXvfb = xvfb.isNeeded();
   debug('needs Xvfb?', needsXvfb);
+
   /**
    * Spawn Cypress running smoke test to check if all operating system
    * dependencies are good.
    */
-
   const spawn = linuxWithDisplayEnv => {
     const random = _.random(0, 1000);
-
     const args = ['--smoke-test', `--ping=${random}`];
-
     if (needsSandbox()) {
       // electron requires --no-sandbox to run as root
       debug('disabling Electron sandbox');
       args.unshift('--no-sandbox');
     }
-
     if (options.dev) {
       executable = 'node';
       args.unshift(path.resolve(__dirname, '..', '..', '..', 'scripts', 'start.js'));
     }
-
     const smokeTestCommand = `${executable} ${args.join(' ')}`;
     debug('running smoke test');
     debug('using Cypress executable %s', executable);
     debug('smoke test command:', smokeTestCommand);
     debug('smoke test timeout %d ms', options.smokeTestTimeout);
-
     const env = _.extend({}, process.env, {
       ELECTRON_ENABLE_LOGGING: true
     });
-
     const stdioOptions = _.extend({}, {
       env,
       timeout: options.smokeTestTimeout
     });
-
     return Promise.resolve(util.exec(executable, args, stdioOptions)).catch(onSmokeTestError(smokeTestCommand, linuxWithDisplayEnv)).then(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
       const smokeTestStdout = _.get(result, 'stdout', '');
-
       debug('smoke test stdout "%s"', smokeTestStdout);
-
       if (!util.stdoutLineMatches(String(random), smokeTestStdout)) {
         debug('Smoke test failed because could not find %d in:', random, result);
-
         const smokeTestStderr = _.get(result, 'stderr', '');
-
         const errorText = smokeTestStderr || smokeTestStdout;
         return throwFormErrorText(errors.smokeTestFailure(smokeTestCommand, false))(errorText);
       }
     });
   };
-
   const spawnInXvfb = linuxWithDisplayEnv => {
     return xvfb.start().then(() => {
       return spawn(linuxWithDisplayEnv);
     }).finally(xvfb.stop);
   };
-
   const userFriendlySpawn = linuxWithDisplayEnv => {
     debug('spawning, should retry on display problem?', Boolean(linuxWithDisplayEnv));
     return spawn(linuxWithDisplayEnv).catch({
@@ -155,31 +118,30 @@ const runSmokeTest = (binaryDir, options) => {
       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
-
-
   const linuxWithDisplayEnv = util.isPossibleLinuxWithIncorrectDisplay();
   return userFriendlySpawn(linuxWithDisplayEnv);
 };
-
 function testBinary(version, binaryDir, options) {
-  debug('running binary verification check', version); // if running from 'cypress verify', don't print this message
+  debug('running binary verification check', version);
 
+  // if running from 'cypress verify', don't print this message
   if (!options.force) {
     logger.log(stripIndent`
     It looks like this is your first time using Cypress: ${chalk.cyan(version)}
     `);
   }
+  logger.log();
 
-  logger.log(); // if we are running in CI then use
+  // if we are running in CI then use
   // the verbose renderer else use
   // the default
-
   let renderer = util.isCi() ? verbose : 'default';
   if (logger.logLevel() === 'silent') renderer = 'silent';
   const rendererOptions = {
@@ -206,17 +168,16 @@ function testBinary(version, binaryDir, options) {
   });
   return tasks.run();
 }
-
 const maybeVerify = (installedVersion, binaryDir, options) => {
   return state.getBinaryVerifiedAsync(binaryDir).then(isVerified => {
     debug('is Verified ?', isVerified);
-    let shouldVerify = !isVerified; // force verify if options.force
+    let shouldVerify = !isVerified;
 
+    // force verify if options.force
     if (options.force) {
       debug('force verify');
       shouldVerify = true;
     }
-
     if (shouldVerify) {
       return testBinary(installedVersion, binaryDir, options).then(() => {
         if (options.welcomeMessage) {
@@ -227,23 +188,19 @@ const maybeVerify = (installedVersion, binaryDir, options) => {
     }
   });
 };
-
 const start = (options = {}) => {
   debug('verifying Cypress app');
   const packageVersion = util.pkgVersion();
   let binaryDir = state.getBinaryDir(packageVersion);
-
   _.defaults(options, {
     dev: false,
     force: false,
     welcomeMessage: true,
     smokeTestTimeout: VERIFY_TEST_RUNNER_TIMEOUT_MS
   });
-
   if (options.dev) {
     return runSmokeTest('', options);
   }
-
   const parseBinaryEnvVar = () => {
     const envBinaryPath = util.getEnv('CYPRESS_RUN_BINARY');
     debug('CYPRESS_RUN_BINARY exists, =', envBinaryPath);
@@ -257,7 +214,6 @@ const start = (options = {}) => {
     logger.log();
     return util.isExecutableAsync(envBinaryPath).then(isExecutable => {
       debug('CYPRESS_RUN_BINARY is executable? :', isExecutable);
-
       if (!isExecutable) {
         return throwFormErrorText(errors.CYPRESS_RUN_BINARY.notValid(envBinaryPath))(stripIndent`
           The supplied binary path is not executable
@@ -269,7 +225,6 @@ const start = (options = {}) => {
       if (!envBinaryDir) {
         return throwFormErrorText(errors.CYPRESS_RUN_BINARY.notValid(envBinaryPath))();
       }
-
       debug('CYPRESS_RUN_BINARY has binaryDir:', envBinaryDir);
       binaryDir = envBinaryDir;
     }).catch({
@@ -278,10 +233,8 @@ const start = (options = {}) => {
       return throwFormErrorText(errors.CYPRESS_RUN_BINARY.notValid(envBinaryPath))(err.message);
     });
   };
-
   return Promise.try(() => {
     debug('checking environment variables');
-
     if (util.getEnv('CYPRESS_RUN_BINARY')) {
       return parseBinaryEnvVar();
     }
@@ -300,9 +253,7 @@ const start = (options = {}) => {
       Cannot read binary version from: ${chalk.cyan(state.getBinaryPkgPath(binaryDir))}
     `);
     }
-
     debug(`Found binary version ${chalk.green(binaryVersion)} installed in: ${chalk.cyan(binaryDir)}`);
-
     if (binaryVersion !== packageVersion) {
       // warn if we installed with CYPRESS_INSTALL_BINARY or changed version
       // in the package.json
@@ -317,18 +268,16 @@ const start = (options = {}) => {
       `);
       logger.log();
     }
-
     return maybeVerify(binaryVersion, binaryDir, options);
   }).catch(err => {
     if (err.known) {
       throw err;
     }
-
     return throwFormErrorText(errors.unexpected)(err.stack);
   });
 };
-
 const isLinuxLike = () => os.platform() !== 'win32';
+
 /**
  * Returns true if running on a system where Electron needs "--no-sandbox" flag.
  * @see https://crbug.com/638180
@@ -338,10 +287,7 @@ const isLinuxLike = () => os.platform() !== 'win32';
  * Seems there is a lot of discussion around this issue among Electron users
  * @see https://github.com/electron/electron/issues/17972
 */
-
-
 const needsSandbox = () => isLinuxLike();
-
 module.exports = {
   start,
   VERIFY_TEST_RUNNER_TIMEOUT_MS,