cypress 3.3.2 → 3.6.0

package/index.js

@@ -22,6 +22,6 @@ switch (args.exec) {
 
     break;
   default:
-    // export our node module interface
+    debug('exporting Cypress module interface');
     module.exports = require('./lib/cypress');
 }

package/lib/cli.js

@@ -14,6 +14,7 @@ var logSymbols = require('log-symbols');
 var debug = require('debug')('cypress:cli');
 var util = require('./util');
 var logger = require('./logger');
+var errors = require('./errors');
 var cache = require('./tasks/cache');
 
 // patch "commander" method called when a user passed an unknown option
@@ -38,6 +39,7 @@ var coerceFalse = function coerceFalse(arg) {
 var spaceDelimitedSpecsMsg = function spaceDelimitedSpecsMsg(files) {
   logger.log();
   logger.warn(stripIndent(_templateObject, logSymbols.warning, files.join(' ')));
+
   logger.log();
 };
 
@@ -67,7 +69,7 @@ var parseVariableOpts = function parseVariableOpts(fnArgs, args) {
 };
 
 var parseOpts = function parseOpts(opts) {
-  opts = _.pick(opts, 'project', 'spec', 'reporter', 'reporterOptions', 'path', 'destination', 'port', 'env', 'cypressVersion', 'config', 'record', 'key', 'browser', 'detached', 'headed', 'global', 'dev', 'force', 'exit', 'cachePath', 'cacheList', 'cacheClear', 'parallel', 'group', 'ciBuildId');
+  opts = _.pick(opts, 'project', 'spec', 'reporter', 'reporterOptions', 'path', 'destination', 'port', 'env', 'cypressVersion', 'config', 'record', 'key', 'configFile', 'browser', 'detached', 'headed', 'global', 'dev', 'force', 'exit', 'cachePath', 'cacheList', 'cacheClear', 'parallel', 'group', 'ciBuildId');
 
   if (opts.exit) {
     opts = _.omit(opts, 'exit');
@@ -84,14 +86,15 @@ var descriptions = {
   spec: 'runs a specific spec file. defaults to "all"',
   reporter: 'runs a specific mocha reporter. pass a path to use a custom reporter. defaults to "spec"',
   reporterOptions: 'options for the mocha reporter. defaults to "null"',
-  port: 'runs Cypress on a specific port. overrides any value in cypress.json.',
-  env: 'sets environment variables. separate multiple values with a comma. overrides any value in cypress.json or cypress.env.json',
-  config: 'sets configuration values. separate multiple values with a comma. overrides any value in cypress.json.',
+  port: 'runs Cypress on a specific port. overrides any value in the configuration file.',
+  env: 'sets environment variables. separate multiple values with a comma. overrides any value in the configuration file or cypress.env.json',
+  config: 'sets configuration values. separate multiple values with a comma. overrides any value in the configuration file.',
   browserRunMode: 'runs Cypress in the browser with the given name. if a filesystem path is supplied, Cypress will attempt to use the browser at that path.',
   browserOpenMode: 'path to a custom browser to be added to the list of available browsers in Cypress',
   detached: 'runs Cypress application in detached mode',
   project: 'path to the project',
   global: 'force Cypress into global mode as if its globally installed',
+  configFile: 'path to JSON file where configuration values are set. defaults to "cypress.json". pass "false" to disable.',
   version: 'prints Cypress version',
   headed: 'displays the Electron browser instead of running headlessly',
   dev: 'runs cypress in development and bypasses binary check',
@@ -137,6 +140,12 @@ module.exports = {
       args = process.argv;
     }
 
+    if (!util.isValidCypressEnvValue(process.env.CYPRESS_ENV)) {
+      debug('invalid CYPRESS_ENV value', process.env.CYPRESS_ENV);
+
+      return errors.exitWithError(errors.errors.invalidCypressEnv)('CYPRESS_ENV=' + process.env.CYPRESS_ENV);
+    }
+
     var program = new commander.Command();
 
     // bug in commaner not printing name
@@ -151,7 +160,7 @@ module.exports = {
 
     program.option('-v, --version', text('version')).command('version').description(text('version')).action(showVersions);
 
-    program.command('run').usage('[options]').description('Runs Cypress tests from the CLI without the GUI').option('--record [bool]', text('record'), coerceFalse).option('--headed', text('headed')).option('-k, --key <record-key>', text('key')).option('-s, --spec <spec>', text('spec')).option('-r, --reporter <reporter>', text('reporter')).option('-o, --reporter-options <reporter-options>', text('reporterOptions')).option('-p, --port <port>', text('port')).option('-e, --env <env>', text('env')).option('-c, --config <config>', text('config')).option('-b, --browser <browser-name-or-path>', text('browserRunMode')).option('-P, --project <project-path>', text('project')).option('--parallel', text('parallel')).option('--group <name>', text('group')).option('--ci-build-id <id>', text('ciBuildId')).option('--no-exit', text('exit')).option('--dev', text('dev'), coerceFalse).action(function () {
+    program.command('run').usage('[options]').description('Runs Cypress tests from the CLI without the GUI').option('--record [bool]', text('record'), coerceFalse).option('--headed', text('headed')).option('-k, --key <record-key>', text('key')).option('-s, --spec <spec>', text('spec')).option('-r, --reporter <reporter>', text('reporter')).option('-o, --reporter-options <reporter-options>', text('reporterOptions')).option('-p, --port <port>', text('port')).option('-e, --env <env>', text('env')).option('-c, --config <config>', text('config')).option('-C, --config-file <config-file>', text('configFile')).option('-b, --browser <browser-name-or-path>', text('browserRunMode')).option('-P, --project <project-path>', text('project')).option('--parallel', text('parallel')).option('--group <name>', text('group')).option('--ci-build-id <id>', text('ciBuildId')).option('--no-exit', text('exit')).option('--dev', text('dev'), coerceFalse).action(function () {
       for (var _len = arguments.length, fnArgs = Array(_len), _key = 0; _key < _len; _key++) {
         fnArgs[_key] = arguments[_key];
       }
@@ -160,7 +169,7 @@ module.exports = {
       require('./exec/run').start(parseVariableOpts(fnArgs, args)).then(util.exit).catch(util.logErrorExit1);
     });
 
-    program.command('open').usage('[options]').description('Opens Cypress in the interactive GUI.').option('-p, --port <port>', text('port')).option('-e, --env <env>', text('env')).option('-c, --config <config>', text('config')).option('-d, --detached [bool]', text('detached'), coerceFalse).option('-b, --browser <browser-path>', text('browserOpenMode')).option('-P, --project <project-path>', text('project')).option('--global', text('global')).option('--dev', text('dev'), coerceFalse).action(function (opts) {
+    program.command('open').usage('[options]').description('Opens Cypress in the interactive GUI.').option('-p, --port <port>', text('port')).option('-e, --env <env>', text('env')).option('-c, --config <config>', text('config')).option('-C, --config-file <config-file>', text('configFile')).option('-d, --detached [bool]', text('detached'), coerceFalse).option('-b, --browser <browser-path>', text('browserOpenMode')).option('-P, --project <project-path>', text('project')).option('--global', text('global')).option('--dev', text('dev'), coerceFalse).action(function (opts) {
       debug('opening Cypress');
       require('./exec/open').start(parseOpts(opts)).catch(util.logErrorExit1);
     });

package/lib/errors.js

@@ -1,21 +1,22 @@
 'use strict';
 
-var _templateObject = _taggedTemplateLiteral(['\n    Search for an existing issue or open a GitHub issue at\n\n      ', '\n  '], ['\n    Search for an existing issue or open a GitHub issue at\n\n      ', '\n  ']),
-    _templateObject2 = _taggedTemplateLiteral(['\n    \nPlease reinstall Cypress by running: ', '\n  '], ['\n    \\nPlease reinstall Cypress by running: ', '\n  ']),
-    _templateObject3 = _taggedTemplateLiteral(['\n\n    Reasons this may happen:\n\n    - node was installed as \'root\' or with \'sudo\'\n    - the cypress npm package as \'root\' or with \'sudo\'\n\n    Please check that you have the appropriate user permissions.\n  '], ['\\n\n    Reasons this may happen:\n\n    - node was installed as \'root\' or with \'sudo\'\n    - the cypress npm package as \'root\' or with \'sudo\'\n\n    Please check that you have the appropriate user permissions.\n  ']),
-    _templateObject4 = _taggedTemplateLiteral(['\n\n    We expected the binary to be installed here: ', '\n\n    Reasons it may be missing:\n\n    - You\'re caching \'node_modules\' but are not caching this path: ', '\n    - You ran \'npm install\' at an earlier build step but did not persist: ', '\n\n    Properly caching the binary will fix this error and avoid downloading and unzipping Cypress.\n\n    Alternatively, you can run \'cypress install\' to download the binary again.\n\n    ', '\n  '], ['\\n\n    We expected the binary to be installed here: ', '\n\n    Reasons it may be missing:\n\n    - You\'re caching \'node_modules\' but are not caching this path: ', '\n    - You ran \'npm install\' at an earlier build step but did not persist: ', '\n\n    Properly caching the binary will fix this error and avoid downloading and unzipping Cypress.\n\n    Alternatively, you can run \'cypress install\' to download the binary again.\n\n    ', '\n  ']),
-    _templateObject5 = _taggedTemplateLiteral(['\n    There was a problem spawning Xvfb.\n\n    This is likely a problem with your system, permissions, or installation of Xvfb.\n    '], ['\n    There was a problem spawning Xvfb.\n\n    This is likely a problem with your system, permissions, or installation of Xvfb.\n    ']),
-    _templateObject6 = _taggedTemplateLiteral(['\n    Install Xvfb and run Cypress again.\n\n    Read our documentation on dependencies for more information:\n\n      ', '\n\n    If you are using Docker, we provide containers with all required dependencies installed.\n    '], ['\n    Install Xvfb and run Cypress again.\n\n    Read our documentation on dependencies for more information:\n\n      ', '\n\n    If you are using Docker, we provide containers with all required dependencies installed.\n    ']),
-    _templateObject7 = _taggedTemplateLiteral(['\n    This command failed with the following output:\n\n    ', '\n\n    '], ['\n    This command failed with the following output:\n\n    ', '\n\n    ']),
-    _templateObject8 = _taggedTemplateLiteral(['\n      Cypress failed to start after spawning a new Xvfb server.\n\n      The error logs we received were:\n\n      ', '\n\n      ', '\n\n      ', '\n\n      This is usually caused by a missing library or dependency.\n\n      The error above should indicate which dependency is missing.\n\n        ', '\n\n      If you are using Docker, we provide containers with all required dependencies installed.\n    '], ['\n      Cypress failed to start after spawning a new Xvfb server.\n\n      The error logs we received were:\n\n      ', '\n\n      ', '\n\n      ', '\n\n      This is usually caused by a missing library or dependency.\n\n      The error above should indicate which dependency is missing.\n\n        ', '\n\n      If you are using Docker, we provide containers with all required dependencies installed.\n    ']),
-    _templateObject9 = _taggedTemplateLiteral(['\n    This is usually caused by a missing library or dependency.\n\n    The error below should indicate which dependency is missing.\n\n      ', '\n\n    If you are using Docker, we provide containers with all required dependencies installed.\n  '], ['\n    This is usually caused by a missing library or dependency.\n\n    The error below should indicate which dependency is missing.\n\n      ', '\n\n    If you are using Docker, we provide containers with all required dependencies installed.\n  ']),
-    _templateObject10 = _taggedTemplateLiteral(['\n    See discussion and possible solutions at\n    ', '\n  '], ['\n    See discussion and possible solutions at\n    ', '\n  ']),
-    _templateObject11 = _taggedTemplateLiteral(['\n    Please search Cypress documentation for possible solutions:\n\n      ', '\n\n    Check if there is a GitHub issue describing this crash:\n\n      ', '\n\n    Consider opening a new issue.\n  '], ['\n    Please search Cypress documentation for possible solutions:\n\n      ', '\n\n    Check if there is a GitHub issue describing this crash:\n\n      ', '\n\n    Consider opening a new issue.\n  ']),
-    _templateObject12 = _taggedTemplateLiteral(['\n    The environment variable CYPRESS_BINARY_VERSION has been renamed to CYPRESS_INSTALL_BINARY as of version ', '\n    '], ['\n    The environment variable CYPRESS_BINARY_VERSION has been renamed to CYPRESS_INSTALL_BINARY as of version ', '\n    ']),
-    _templateObject13 = _taggedTemplateLiteral(['\n    You should set CYPRESS_INSTALL_BINARY instead.\n    '], ['\n    You should set CYPRESS_INSTALL_BINARY instead.\n    ']),
-    _templateObject14 = _taggedTemplateLiteral(['\n    The environment variable CYPRESS_SKIP_BINARY_INSTALL has been removed as of version ', '\n    '], ['\n    The environment variable CYPRESS_SKIP_BINARY_INSTALL has been removed as of version ', '\n    ']),
-    _templateObject15 = _taggedTemplateLiteral(['\n      To skip the binary install, set CYPRESS_INSTALL_BINARY=0\n    '], ['\n      To skip the binary install, set CYPRESS_INSTALL_BINARY=0\n    ']),
-    _templateObject16 = _taggedTemplateLiteral(['\n    Platform: ', ' (', ')\n    Cypress Version: ', '\n  '], ['\n    Platform: ', ' (', ')\n    Cypress Version: ', '\n  ']);
+var _templateObject = _taggedTemplateLiteral(['\n  Does your workplace require a proxy to be used to access the Internet? If so, you must configure the HTTP_PROXY environment variable before downloading Cypress. Read more: https://on.cypress.io/proxy-configuration\n\n  Otherwise, please check network connectivity and try again:'], ['\n  Does your workplace require a proxy to be used to access the Internet? If so, you must configure the HTTP_PROXY environment variable before downloading Cypress. Read more: https://on.cypress.io/proxy-configuration\n\n  Otherwise, please check network connectivity and try again:']),
+    _templateObject2 = _taggedTemplateLiteral(['\n    Search for an existing issue or open a GitHub issue at\n\n      ', '\n  '], ['\n    Search for an existing issue or open a GitHub issue at\n\n      ', '\n  ']),
+    _templateObject3 = _taggedTemplateLiteral(['\n    \nPlease reinstall Cypress by running: ', '\n  '], ['\n    \\nPlease reinstall Cypress by running: ', '\n  ']),
+    _templateObject4 = _taggedTemplateLiteral(['\n\n    Reasons this may happen:\n\n    - node was installed as \'root\' or with \'sudo\'\n    - the cypress npm package as \'root\' or with \'sudo\'\n\n    Please check that you have the appropriate user permissions.\n  '], ['\\n\n    Reasons this may happen:\n\n    - node was installed as \'root\' or with \'sudo\'\n    - the cypress npm package as \'root\' or with \'sudo\'\n\n    Please check that you have the appropriate user permissions.\n  ']),
+    _templateObject5 = _taggedTemplateLiteral(['\n\n    We expected the binary to be installed here: ', '\n\n    Reasons it may be missing:\n\n    - You\'re caching \'node_modules\' but are not caching this path: ', '\n    - You ran \'npm install\' at an earlier build step but did not persist: ', '\n\n    Properly caching the binary will fix this error and avoid downloading and unzipping Cypress.\n\n    Alternatively, you can run \'cypress install\' to download the binary again.\n\n    ', '\n  '], ['\\n\n    We expected the binary to be installed here: ', '\n\n    Reasons it may be missing:\n\n    - You\'re caching \'node_modules\' but are not caching this path: ', '\n    - You ran \'npm install\' at an earlier build step but did not persist: ', '\n\n    Properly caching the binary will fix this error and avoid downloading and unzipping Cypress.\n\n    Alternatively, you can run \'cypress install\' to download the binary again.\n\n    ', '\n  ']),
+    _templateObject6 = _taggedTemplateLiteral(['\n    There was a problem spawning Xvfb.\n\n    This is likely a problem with your system, permissions, or installation of Xvfb.\n    '], ['\n    There was a problem spawning Xvfb.\n\n    This is likely a problem with your system, permissions, or installation of Xvfb.\n    ']),
+    _templateObject7 = _taggedTemplateLiteral(['\n    Install Xvfb and run Cypress again.\n\n    Read our documentation on dependencies for more information:\n\n      ', '\n\n    If you are using Docker, we provide containers with all required dependencies installed.\n    '], ['\n    Install Xvfb and run Cypress again.\n\n    Read our documentation on dependencies for more information:\n\n      ', '\n\n    If you are using Docker, we provide containers with all required dependencies installed.\n    ']),
+    _templateObject8 = _taggedTemplateLiteral(['\n    This command failed with the following output:\n\n    ', '\n\n    '], ['\n    This command failed with the following output:\n\n    ', '\n\n    ']),
+    _templateObject9 = _taggedTemplateLiteral(['\n      Cypress failed to start after spawning a new Xvfb server.\n\n      The error logs we received were:\n\n      ', '\n\n      ', '\n\n      ', '\n\n      This is usually caused by a missing library or dependency.\n\n      The error above should indicate which dependency is missing.\n\n        ', '\n\n      If you are using Docker, we provide containers with all required dependencies installed.\n    '], ['\n      Cypress failed to start after spawning a new Xvfb server.\n\n      The error logs we received were:\n\n      ', '\n\n      ', '\n\n      ', '\n\n      This is usually caused by a missing library or dependency.\n\n      The error above should indicate which dependency is missing.\n\n        ', '\n\n      If you are using Docker, we provide containers with all required dependencies installed.\n    ']),
+    _templateObject10 = _taggedTemplateLiteral(['\n    This is usually caused by a missing library or dependency.\n\n    The error below should indicate which dependency is missing.\n\n      ', '\n\n    If you are using Docker, we provide containers with all required dependencies installed.\n  '], ['\n    This is usually caused by a missing library or dependency.\n\n    The error below should indicate which dependency is missing.\n\n      ', '\n\n    If you are using Docker, we provide containers with all required dependencies installed.\n  ']),
+    _templateObject11 = _taggedTemplateLiteral(['\n    See discussion and possible solutions at\n    ', '\n  '], ['\n    See discussion and possible solutions at\n    ', '\n  ']),
+    _templateObject12 = _taggedTemplateLiteral(['\n    Please search Cypress documentation for possible solutions:\n\n      ', '\n\n    Check if there is a GitHub issue describing this crash:\n\n      ', '\n\n    Consider opening a new issue.\n  '], ['\n    Please search Cypress documentation for possible solutions:\n\n      ', '\n\n    Check if there is a GitHub issue describing this crash:\n\n      ', '\n\n    Consider opening a new issue.\n  ']),
+    _templateObject13 = _taggedTemplateLiteral(['\n    The environment variable CYPRESS_BINARY_VERSION has been renamed to CYPRESS_INSTALL_BINARY as of version ', '\n    '], ['\n    The environment variable CYPRESS_BINARY_VERSION has been renamed to CYPRESS_INSTALL_BINARY as of version ', '\n    ']),
+    _templateObject14 = _taggedTemplateLiteral(['\n    You should set CYPRESS_INSTALL_BINARY instead.\n    '], ['\n    You should set CYPRESS_INSTALL_BINARY instead.\n    ']),
+    _templateObject15 = _taggedTemplateLiteral(['\n    The environment variable CYPRESS_SKIP_BINARY_INSTALL has been removed as of version ', '\n    '], ['\n    The environment variable CYPRESS_SKIP_BINARY_INSTALL has been removed as of version ', '\n    ']),
+    _templateObject16 = _taggedTemplateLiteral(['\n      To skip the binary install, set CYPRESS_INSTALL_BINARY=0\n    '], ['\n      To skip the binary install, set CYPRESS_INSTALL_BINARY=0\n    ']),
+    _templateObject17 = _taggedTemplateLiteral(['\n    Platform: ', ' (', ')\n    Cypress Version: ', '\n  '], ['\n    Platform: ', ' (', ')\n    Cypress Version: ', '\n  ']);
 
 function _taggedTemplateLiteral(strings, raw) { return Object.freeze(Object.defineProperties(strings, { raw: { value: Object.freeze(raw) } })); }
 
@@ -46,49 +47,49 @@ var hr = '----------';
 // common errors Cypress application can encounter
 var failedDownload = {
   description: 'The Cypress App could not be downloaded.',
-  solution: 'Please check network connectivity and try again:'
+  solution: stripIndent(_templateObject)
 };
 
 var failedUnzip = {
   description: 'The Cypress App could not be unzipped.',
-  solution: stripIndent(_templateObject, chalk.blue(util.issuesUrl))
+  solution: stripIndent(_templateObject2, chalk.blue(util.issuesUrl))
 };
 
 var missingApp = function missingApp(binaryDir) {
   return {
     description: 'No version of Cypress is installed in: ' + chalk.cyan(binaryDir),
-    solution: stripIndent(_templateObject2, chalk.cyan('cypress install'))
+    solution: stripIndent(_templateObject3, chalk.cyan('cypress install'))
   };
 };
 
 var binaryNotExecutable = function binaryNotExecutable(executable) {
   return {
     description: 'Cypress cannot run because this binary file does not have executable permissions here:\n\n' + executable,
-    solution: stripIndent(_templateObject3)
+    solution: stripIndent(_templateObject4)
   };
 };
 
 var notInstalledCI = function notInstalledCI(executable) {
   return {
     description: 'The cypress npm package is installed, but the Cypress binary is missing.',
-    solution: stripIndent(_templateObject4, chalk.cyan(executable), util.getCacheDir(), util.getCacheDir(), chalk.blue('https://on.cypress.io/not-installed-ci-error'))
+    solution: stripIndent(_templateObject5, chalk.cyan(executable), util.getCacheDir(), util.getCacheDir(), chalk.blue('https://on.cypress.io/not-installed-ci-error'))
   };
 };
 
 var nonZeroExitCodeXvfb = {
   description: 'Xvfb exited with a non zero exit code.',
-  solution: stripIndent(_templateObject5)
+  solution: stripIndent(_templateObject6)
 };
 
 var missingXvfb = {
   description: 'Your system is missing the dependency: Xvfb',
-  solution: stripIndent(_templateObject6, chalk.blue(requiredDependenciesUrl))
+  solution: stripIndent(_templateObject7, chalk.blue(requiredDependenciesUrl))
 };
 
 var smokeTestFailure = function smokeTestFailure(smokeTestCommand, timedOut) {
   return {
     description: 'Cypress verification ' + (timedOut ? 'timed out' : 'failed') + '.',
-    solution: stripIndent(_templateObject7, smokeTestCommand)
+    solution: stripIndent(_templateObject8, smokeTestCommand)
   };
 };
 
@@ -96,19 +97,19 @@ var invalidSmokeTestDisplayError = {
   code: 'INVALID_SMOKE_TEST_DISPLAY_ERROR',
   description: 'Cypress verification failed.',
   solution: function solution(msg) {
-    return stripIndent(_templateObject8, hr, msg, hr, chalk.blue(requiredDependenciesUrl));
+    return stripIndent(_templateObject9, hr, msg, hr, chalk.blue(requiredDependenciesUrl));
   }
 };
 
 var missingDependency = {
   description: 'Cypress failed to start.',
   // this message is too Linux specific
-  solution: stripIndent(_templateObject9, chalk.blue(requiredDependenciesUrl))
+  solution: stripIndent(_templateObject10, chalk.blue(requiredDependenciesUrl))
 };
 
 var invalidCacheDirectory = {
   description: 'Cypress cannot write to the cache directory due to file permissions',
-  solution: stripIndent(_templateObject10, chalk.blue(util.getGitHubIssueUrl(1281)))
+  solution: stripIndent(_templateObject11, chalk.blue(util.getGitHubIssueUrl(1281)))
 };
 
 var versionMismatch = {
@@ -118,17 +119,23 @@ var versionMismatch = {
 
 var unexpected = {
   description: 'An unexpected error occurred while verifying the Cypress executable.',
-  solution: stripIndent(_templateObject11, chalk.blue(docsUrl), chalk.blue(util.issuesUrl))
+  solution: stripIndent(_templateObject12, chalk.blue(docsUrl), chalk.blue(util.issuesUrl))
+};
+
+var invalidCypressEnv = {
+  description: chalk.red('The environment variable with the reserved name "CYPRESS_ENV" is set.'),
+  solution: chalk.red('Unset the "CYPRESS_ENV" environment variable and run Cypress again.'),
+  exitCode: 11
 };
 
 var removed = {
   CYPRESS_BINARY_VERSION: {
-    description: stripIndent(_templateObject12, chalk.green('3.0.0')),
-    solution: stripIndent(_templateObject13)
+    description: stripIndent(_templateObject13, chalk.green('3.0.0')),
+    solution: stripIndent(_templateObject14)
   },
   CYPRESS_SKIP_BINARY_INSTALL: {
-    description: stripIndent(_templateObject14, chalk.green('3.0.0')),
-    solution: stripIndent(_templateObject15)
+    description: stripIndent(_templateObject15, chalk.green('3.0.0')),
+    solution: stripIndent(_templateObject16)
   }
 };
 
@@ -145,7 +152,7 @@ var CYPRESS_RUN_BINARY = {
 
 function getPlatformInfo() {
   return util.getOsVersionAsync().then(function (version) {
-    return stripIndent(_templateObject16, os.platform(), version, util.pkgVersion());
+    return stripIndent(_templateObject17, os.platform(), version, util.pkgVersion());
   });
 }
 
@@ -216,8 +223,26 @@ var throwFormErrorText = function throwFormErrorText(info) {
   };
 };
 
+/**
+ * Forms full error message with error and OS details, prints to the error output
+ * and then exits the process.
+ * @param {ErrorInformation} info Error information {description, solution}
+ * @example return exitWithError(errors.invalidCypressEnv)('foo')
+ */
+var exitWithError = function exitWithError(info) {
+  return function (msg) {
+    return formErrorText(info, msg).then(function (text) {
+      // eslint-disable-next-line no-console
+      console.error(text);
+      process.exit(info.exitCode || 1);
+    });
+  };
+};
+
 module.exports = {
   raise: raise,
+  exitWithError: exitWithError,
+  // formError,
   formErrorText: formErrorText,
   throwFormErrorText: throwFormErrorText,
   hr: hr,
@@ -233,6 +258,7 @@ module.exports = {
     unexpected: unexpected,
     failedDownload: failedDownload,
     failedUnzip: failedUnzip,
+    invalidCypressEnv: invalidCypressEnv,
     invalidCacheDirectory: invalidCacheDirectory,
     removed: removed,
     CYPRESS_RUN_BINARY: CYPRESS_RUN_BINARY,

package/lib/exec/open.js

@@ -23,6 +23,10 @@ module.exports = {
       args.push('--config', options.config);
     }
 
+    if (options.configFile !== undefined) {
+      args.push('--config-file', options.configFile);
+    }
+
     if (options.browser) {
       args.push('--browser', options.browser);
     }

package/lib/exec/run.js

@@ -30,6 +30,10 @@ var processRunOptions = function processRunOptions() {
     args.push('--config', options.config);
   }
 
+  if (options.configFile !== undefined) {
+    args.push('--config-file', options.configFile);
+  }
+
   if (options.port) {
     args.push('--port', options.port);
   }

package/lib/exec/spawn.js

@@ -11,6 +11,7 @@ var debugElectron = require('debug')('cypress:electron');
 var util = require('../util');
 var state = require('../tasks/state');
 var xvfb = require('./xvfb');
+var verify = require('../tasks/verify');
 
 var _require = require('../errors'),
     throwFormErrorText = _require.throwFormErrorText,
@@ -18,8 +19,9 @@ var _require = require('../errors'),
 
 var isXlibOrLibudevRe = /^(?:Xlib|libudev)/;
 var isHighSierraWarningRe = /\*\*\* WARNING/;
+var isRenderWorkerRe = /\.RenderWorker-/;
 
-var GARBAGE_WARNINGS = [isXlibOrLibudevRe, isHighSierraWarningRe];
+var GARBAGE_WARNINGS = [isXlibOrLibudevRe, isHighSierraWarningRe, isRenderWorkerRe];
 
 var isGarbageLineWarning = function isGarbageLineWarning(str) {
   return _.some(GARBAGE_WARNINGS, function (re) {
@@ -58,6 +60,8 @@ function getStdio(needsXvfb) {
 }
 
 module.exports = {
+  isGarbageLineWarning: isGarbageLineWarning,
+
   start: function start(args) {
     var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
 
@@ -71,6 +75,8 @@ module.exports = {
     debug('needs to start own Xvfb?', needsXvfb);
 
     // always push cwd into the args
+    // which additionally acts as a signal to the
+    // binary that it was invoked through the NPM module
     args = [].concat(args, '--cwd', process.cwd());
 
     _.defaults(options, {
@@ -103,6 +109,10 @@ module.exports = {
         var electronArgs = _.clone(args);
         var node11WindowsFix = isPlatform('win32');
 
+        if (verify.needsSandbox()) {
+          electronArgs.push('--no-sandbox');
+        }
+
         // strip dev out of child process options
         var stdioOptions = _.pick(options, 'env', 'detached', 'stdio');
 
@@ -130,40 +140,64 @@ module.exports = {
 
         var child = cp.spawn(executable, electronArgs, stdioOptions);
 
-        child.on('close', resolve);
+        function resolveOn(event) {
+          return function (code, signal) {
+            debug('child event fired %o', { event: event, code: code, signal: signal });
+            resolve(code);
+          };
+        }
+
+        child.on('close', resolveOn('close'));
+        child.on('exit', resolveOn('exit'));
         child.on('error', reject);
 
-        child.stdin && child.stdin.pipe(process.stdin);
-        child.stdout && child.stdout.pipe(process.stdout);
+        // if stdio options is set to 'pipe', then
+        //   we should set up pipes:
+        //  process STDIN (read stream) => child STDIN (writeable)
+        //  child STDOUT => process STDOUT
+        //  child STDERR => process STDERR with additional filtering
+        if (child.stdin) {
+          debug('piping process STDIN into child STDIN');
+          process.stdin.pipe(child.stdin);
+        }
+
+        if (child.stdout) {
+          debug('piping child STDOUT to process STDOUT');
+          child.stdout.pipe(process.stdout);
+        }
 
         // if this is defined then we are manually piping for linux
         // to filter out the garbage
-        child.stderr && child.stderr.on('data', function (data) {
-          var str = data.toString();
-
-          // bail if this is warning line garbage
-          if (isGarbageLineWarning(str)) {
-            return;
-          }
+        if (child.stderr) {
+          debug('piping child STDERR to process STDERR');
+          child.stderr.on('data', function (data) {
+            var str = data.toString();
+
+            // bail if this is warning line garbage
+            if (isGarbageLineWarning(str)) {
+              return;
+            }
 
-          // if we have a callback and this explictly returns
-          // false then bail
-          if (onStderrData && onStderrData(str) === false) {
-            return;
-          }
+            // if we have a callback and this explictly returns
+            // false then bail
+            if (onStderrData && onStderrData(str) === false) {
+              return;
+            }
 
-          // else pass it along!
-          process.stderr.write(data);
-        });
+            // else pass it along!
+            process.stderr.write(data);
+          });
+        }
 
         // https://github.com/cypress-io/cypress/issues/1841
+        // https://github.com/cypress-io/cypress/issues/5241
         // In some versions of node, it will throw on windows
         // when you close the parent process after piping
         // into the child process. unpiping does not seem
         // to have any effect. so we're just catching the
         // error here and not doing anything.
         process.stdin.on('error', function (err) {
-          if (err.code === 'EPIPE') {
+          if (['EPIPE', 'ENOTCONN'].includes(err.code)) {
             return;
           }
 

package/lib/exec/versions.js

@@ -13,7 +13,6 @@ var _require = require('../errors'),
 
 var getVersions = function getVersions() {
   return Promise.try(function () {
-
     if (util.getEnv('CYPRESS_RUN_BINARY')) {
       var envBinaryPath = path.resolve(util.getEnv('CYPRESS_RUN_BINARY'));
 

package/lib/exec/xvfb.js

@@ -21,7 +21,7 @@ var _require2 = require('../errors'),
 var util = require('../util');
 
 var xvfb = Promise.promisifyAll(new Xvfb({
-  timeout: 5000, // milliseconds
+  timeout: 30000, // milliseconds
   onStderrData: function onStderrData(data) {
     if (debugXvfb.enabled) {
       debugXvfb(data.toString());