cypress 3.3.2 → 3.6.0

package/lib/tasks/download.js

@@ -1,9 +1,10 @@
 'use strict';
 
-var _arguments = arguments;
-
 var _templateObject = _taggedTemplateLiteral(['\n    URL: ', '\n    ', '\n  '], ['\n    URL: ', '\n    ', '\n  ']),
-    _templateObject2 = _taggedTemplateLiteral(['\n          Failed downloading the Cypress binary.\n          Response code: ', '\n          Response message: ', '\n        '], ['\n          Failed downloading the Cypress binary.\n          Response code: ', '\n          Response message: ', '\n        ']);
+    _templateObject2 = _taggedTemplateLiteral(['\n          Corrupted download\n\n          Expected downloaded file to have checksum: ', '\n          Computed checksum: ', '\n\n          Expected downloaded file to have size: ', '\n          Computed size: ', '\n        '], ['\n          Corrupted download\n\n          Expected downloaded file to have checksum: ', '\n          Computed checksum: ', '\n\n          Expected downloaded file to have size: ', '\n          Computed size: ', '\n        ']),
+    _templateObject3 = _taggedTemplateLiteral(['\n        Corrupted download\n\n        Expected downloaded file to have checksum: ', '\n        Computed checksum: ', '\n      '], ['\n        Corrupted download\n\n        Expected downloaded file to have checksum: ', '\n        Computed checksum: ', '\n      ']),
+    _templateObject4 = _taggedTemplateLiteral(['\n          Corrupted download\n\n          Expected downloaded file to have size: ', '\n          Computed size: ', '\n        '], ['\n          Corrupted download\n\n          Expected downloaded file to have size: ', '\n          Computed size: ', '\n        ']),
+    _templateObject5 = _taggedTemplateLiteral(['\n          Failed downloading the Cypress binary.\n          Response code: ', '\n          Response message: ', '\n        '], ['\n          Failed downloading the Cypress binary.\n          Response code: ', '\n          Response message: ', '\n        ']);
 
 function _taggedTemplateLiteral(strings, raw) { return Object.freeze(Object.defineProperties(strings, { raw: { value: Object.freeze(raw) } })); }
 
@@ -30,6 +31,10 @@ var util = require('../util');
 
 var defaultBaseUrl = 'https://download.cypress.io/';
 
+var getProxyUrl = function getProxyUrl() {
+  return process.env.HTTPS_PROXY || process.env.https_proxy || process.env.npm_config_https_proxy || process.env.HTTP_PROXY || process.env.http_proxy || process.env.npm_config_proxy || null;
+};
+
 var getRealOsArch = function getRealOsArch() {
   // os.arch() returns the arch for which this node was compiled
   // we want the operating system's arch instead: x64 or x86
@@ -88,6 +93,71 @@ var prettyDownloadErr = function prettyDownloadErr(err, version) {
   return throwFormErrorText(errors.failedDownload)(msg);
 };
 
+/**
+ * Checks checksum and file size for the given file. Allows both
+ * values or just one of them to be checked.
+ */
+var verifyDownloadedFile = function verifyDownloadedFile(filename, expectedSize, expectedChecksum) {
+  if (expectedSize && expectedChecksum) {
+    debug('verifying checksum and file size');
+
+    return Promise.join(util.getFileChecksum(filename), util.getFileSize(filename), function (checksum, filesize) {
+      if (checksum === expectedChecksum && filesize === expectedSize) {
+        debug('downloaded file has the expected checksum and size ✅');
+
+        return;
+      }
+
+      debug('raising error: checksum or file size mismatch');
+      var text = stripIndent(_templateObject2, expectedChecksum, checksum, expectedSize, filesize);
+
+      debug(text);
+
+      throw new Error(text);
+    });
+  }
+
+  if (expectedChecksum) {
+    debug('only checking expected file checksum %d', expectedChecksum);
+
+    return util.getFileChecksum(filename).then(function (checksum) {
+      if (checksum === expectedChecksum) {
+        debug('downloaded file has the expected checksum ✅');
+
+        return;
+      }
+
+      debug('raising error: file checksum mismatch');
+      var text = stripIndent(_templateObject3, expectedChecksum, checksum);
+
+      throw new Error(text);
+    });
+  }
+
+  if (expectedSize) {
+    // maybe we don't have a checksum, but at least CDN returns content length
+    // which we can check against the file size
+    debug('only checking expected file size %d', expectedSize);
+
+    return util.getFileSize(filename).then(function (filesize) {
+      if (filesize === expectedSize) {
+        debug('downloaded file has the expected size ✅');
+
+        return;
+      }
+
+      debug('raising error: file size mismatch');
+      var text = stripIndent(_templateObject4, expectedSize, filesize);
+
+      throw new Error(text);
+    });
+  }
+
+  debug('downloaded file lacks checksum or size to verify');
+
+  return Promise.resolve();
+};
+
 // downloads from given url
 // return an object with
 // {filename: ..., downloaded: true}
@@ -97,13 +167,19 @@ var downloadFromUrl = function downloadFromUrl(_ref) {
       progress = _ref.progress;
 
   return new Promise(function (resolve, reject) {
-    debug('Downloading from', url);
-    debug('Saving file to', downloadDestination);
+    var proxy = getProxyUrl();
+
+    debug('Downloading package', {
+      url: url,
+      proxy: proxy,
+      downloadDestination: downloadDestination
+    });
 
     var redirectVersion = void 0;
 
     var req = request({
       url: url,
+      proxy: proxy,
       followRedirect: function followRedirect(response) {
         var version = response.headers['x-version'];
 
@@ -122,10 +198,30 @@ var downloadFromUrl = function downloadFromUrl(_ref) {
 
     // closure
     var started = null;
+    var expectedSize = void 0;
+    var expectedChecksum = void 0;
 
     requestProgress(req, {
       throttle: progress.throttle
     }).on('response', function (response) {
+      // we have computed checksum and filesize during test runner binary build
+      // and have set it on the S3 object as user meta data, available via
+      // these custom headers "x-amz-meta-..."
+      // see https://github.com/cypress-io/cypress/pull/4092
+      expectedSize = response.headers['x-amz-meta-size'] || response.headers['content-length'];
+
+      expectedChecksum = response.headers['x-amz-meta-checksum'];
+
+      if (expectedChecksum) {
+        debug('expected checksum %s', expectedChecksum);
+      }
+
+      if (expectedSize) {
+        // convert from string (all Amazon custom headers are strings)
+        expectedSize = Number(expectedSize);
+        debug('expected file size %d', expectedSize);
+      }
+
       // start counting now once we've gotten
       // response headers
       started = new Date();
@@ -134,7 +230,7 @@ var downloadFromUrl = function downloadFromUrl(_ref) {
       if (!/^2/.test(response.statusCode)) {
         debug('response code %d', response.statusCode);
 
-        var err = new Error(stripIndent(_templateObject2, response.statusCode, response.statusMessage));
+        var err = new Error(stripIndent(_templateObject5, response.statusCode, response.statusMessage));
 
         reject(err);
       }
@@ -143,27 +239,38 @@ var downloadFromUrl = function downloadFromUrl(_ref) {
       // starting on our first progress notification
       var elapsed = new Date() - started;
 
-      var eta = util.calculateEta(state.percent, elapsed);
+      // request-progress sends a value between 0 and 1
+      var percentage = util.convertPercentToPercentage(state.percent);
+
+      var eta = util.calculateEta(percentage, elapsed);
 
       // send up our percent and seconds remaining
-      progress.onProgress(state.percent, util.secsRemaining(eta));
+      progress.onProgress(percentage, util.secsRemaining(eta));
     })
     // save this download here
     .pipe(fs.createWriteStream(downloadDestination)).on('finish', function () {
       debug('downloading finished');
 
-      resolve(redirectVersion);
+      verifyDownloadedFile(downloadDestination, expectedSize, expectedChecksum).then(function () {
+        return resolve(redirectVersion);
+      }, reject);
     });
   });
 };
 
-var start = function start(_ref2) {
-  var version = _ref2.version,
-      downloadDestination = _ref2.downloadDestination,
-      progress = _ref2.progress;
+/**
+ * Download Cypress.zip from external url to local file.
+ * @param [string] version Could be "3.3.0" or full URL
+ * @param [string] downloadDestination Local filename to save as
+ */
+var start = function start(opts) {
+  var version = opts.version,
+      downloadDestination = opts.downloadDestination,
+      progress = opts.progress;
+
 
   if (!downloadDestination) {
-    la(is.unemptyString(downloadDestination), 'missing download dir', _arguments);
+    la(is.unemptyString(downloadDestination), 'missing download dir', opts);
   }
 
   if (!progress) {
@@ -177,6 +284,7 @@ var start = function start(_ref2) {
   progress.throttle = 100;
 
   debug('needed Cypress version: %s', version);
+  debug('source url %s', url);
   debug('downloading cypress.zip to "' + downloadDestination + '"');
 
   // ensure download dir exists
@@ -189,5 +297,6 @@ var start = function start(_ref2) {
 
 module.exports = {
   start: start,
-  getUrl: getUrl
+  getUrl: getUrl,
+  getProxyUrl: getProxyUrl
 };

package/lib/tasks/install.js

@@ -1,6 +1,6 @@
 '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    ']),
+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      ']),
@@ -41,7 +41,6 @@ var alreadyInstalledMsg = function alreadyInstalledMsg() {
 };
 
 var displayCompletionMsg = function displayCompletionMsg() {
-
   // check here to see if we are globally installed
   if (util.isInstalledGlobally()) {
     // if we are display a warning
@@ -98,7 +97,6 @@ var downloadAndUnzip = function downloadAndUnzip(_ref) {
   }), {
     title: util.titleize('Finishing Installation'),
     task: function task(ctx, _task2) {
-
       var cleanup = function cleanup() {
         debug('removing zip file %s', downloadDestination);
 
@@ -120,7 +118,6 @@ var downloadAndUnzip = function downloadAndUnzip(_ref) {
 var start = function start() {
   var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
 
-
   // handle deprecated / removed
   if (util.getEnv('CYPRESS_BINARY_VERSION')) {
     return throwFormErrorText(errors.removed.CYPRESS_BINARY_VERSION)();
@@ -143,14 +140,17 @@ var start = function start() {
 
   // 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);
 
-    var envVarVersion = util.getEnv('CYPRESS_INSTALL_BINARY');
-
-    debug('using environment variable CYPRESS_INSTALL_BINARY %s', envVarVersion);
+    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();
 
       return Promise.resolve();
@@ -159,7 +159,6 @@ var start = function start() {
     // 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;
     }
@@ -169,6 +168,7 @@ var start = function start() {
     var envCache = util.getEnv('CYPRESS_CACHE_FOLDER');
 
     logger.log(stripIndent(_templateObject4, chalk.yellow('Note:'), chalk.cyan(envCache)));
+
     logger.log();
   }
 
@@ -181,7 +181,6 @@ var start = function start() {
   }).then(function () {
     return state.getBinaryPkgVersionAsync(binaryDir);
   }).then(function (binaryVersion) {
-
     if (!binaryVersion) {
       debug('no binary installed under cli version');
 
@@ -192,6 +191,7 @@ var start = function start() {
 
     logger.log();
     logger.log(stripIndent(_templateObject6, chalk.green(binaryVersion), chalk.cyan(installDir)));
+
     logger.log();
 
     if (options.force) {
@@ -218,6 +218,7 @@ var start = function start() {
 
     if (needVersion !== pkgVersion) {
       logger.log(chalk.yellow(stripIndent(_templateObject7, logSymbols.warning, chalk.green(pkgVersion), chalk.green(needVersion))));
+
       logger.log();
     }
 

package/lib/tasks/state.js

@@ -3,6 +3,7 @@
 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');
@@ -71,14 +72,35 @@ var getVersionDir = function getVersionDir() {
   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';
+};
+
 var getCacheDir = function getCacheDir() {
   var cache_directory = util.getCacheDir();
 
   if (util.getEnv('CYPRESS_CACHE_FOLDER')) {
-    var envVarCacheDir = util.getEnv('CYPRESS_CACHE_FOLDER');
+    var envVarCacheDir = untildify(util.getEnv('CYPRESS_CACHE_FOLDER'));
 
     debug('using environment variable CYPRESS_CACHE_FOLDER %s', envVarCacheDir);
-    cache_directory = path.resolve(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);
+    } else {
+      cache_directory = path.resolve(envVarCacheDir);
+    }
   }
 
   return cache_directory;

package/lib/tasks/unzip.js

@@ -23,7 +23,6 @@ var unzip = function unzip(_ref) {
       installDir = _ref.installDir,
       progress = _ref.progress;
 
-
   debug('unzipping from %s', zipFilePath);
   debug('into', installDir);
 

package/lib/tasks/verify.js

@@ -20,6 +20,7 @@ var _require = require('common-tags'),
 var Promise = require('bluebird');
 var logSymbols = require('log-symbols');
 var path = require('path');
+var os = require('os');
 
 var _require2 = require('../errors'),
     throwFormErrorText = _require2.throwFormErrorText,
@@ -30,6 +31,8 @@ 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);
 
@@ -88,6 +91,12 @@ var runSmokeTest = function runSmokeTest(binaryDir, options) {
     var random = _.random(0, 1000);
     var 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'));
@@ -98,6 +107,7 @@ var runSmokeTest = function runSmokeTest(binaryDir, options) {
     debug('running smoke test');
     debug('using Cypress executable %s', executable);
     debug('smoke test command:', smokeTestCommand);
+    debug('smoke test timeout %d ms', options.smokeTestTimeout);
 
     var env = _.extend({}, process.env, {
       ELECTRON_ENABLE_LOGGING: true
@@ -111,14 +121,18 @@ var runSmokeTest = function runSmokeTest(binaryDir, options) {
     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
-      var smokeTestReturned = result.stdout;
+      // use lodash to be robust during tests against null result or missing stdout
+      var smokeTestStdout = _.get(result, 'stdout', '');
 
-      debug('smoke test stdout "%s"', smokeTestReturned);
+      debug('smoke test stdout "%s"', smokeTestStdout);
 
-      if (!util.stdoutLineMatches(String(random), smokeTestReturned)) {
+      if (!util.stdoutLineMatches(String(random), smokeTestStdout)) {
         debug('Smoke test failed because could not find %d in:', random, result);
 
-        return throwFormErrorText(errors.smokeTestFailure(smokeTestCommand, false))(result.stderr || result.stdout);
+        var smokeTestStderr = _.get(result, 'stderr', '');
+        var errorText = smokeTestStderr || smokeTestStdout;
+
+        return throwFormErrorText(errors.smokeTestFailure(smokeTestCommand, false))(errorText);
       }
     });
   };
@@ -190,7 +204,6 @@ function testBinary(version, binaryDir, options) {
 
 var maybeVerify = function maybeVerify(installedVersion, binaryDir, options) {
   return state.getBinaryVerifiedAsync(binaryDir).then(function (isVerified) {
-
     debug('is Verified ?', isVerified);
 
     var shouldVerify = !isVerified;
@@ -224,7 +237,7 @@ var start = function start() {
     dev: false,
     force: false,
     welcomeMessage: true,
-    smokeTestTimeout: 10000
+    smokeTestTimeout: VERIFY_TEST_RUNNER_TIMEOUT_MS
   });
 
   if (options.dev) {
@@ -236,6 +249,7 @@ var start = function start() {
 
     debug('CYPRESS_RUN_BINARY exists, =', 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) {
@@ -270,7 +284,6 @@ var start = function start() {
   }).then(function () {
     return state.getBinaryPkgVersionAsync(binaryDir);
   }).then(function (binaryVersion) {
-
     if (!binaryVersion) {
       debug('no Cypress binary found for cli version ', packageVersion);
 
@@ -299,6 +312,25 @@ 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
+ *
+ * On Debian we had problems running in sandbox even for non-root users.
+ * @see https://github.com/cypress-io/cypress/issues/5434
+ * 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();
+};
+
 module.exports = {
-  start: start
+  start: start,
+  VERIFY_TEST_RUNNER_TIMEOUT_MS: VERIFY_TEST_RUNNER_TIMEOUT_MS,
+  needsSandbox: needsSandbox
 };