cypress 15.1.0 → 15.3.0

package/lib/errors.js

@@ -1,392 +0,0 @@
-"use strict";
-
-const chalk = require('chalk');
-const {
-  stripIndent,
-  stripIndents
-} = require('common-tags');
-const la = require('lazy-ass');
-const is = require('check-more-types');
-const util = require('./util');
-const state = require('./tasks/state');
-const docsUrl = 'https://on.cypress.io';
-const requiredDependenciesUrl = `${docsUrl}/required-dependencies`;
-const runDocumentationUrl = `${docsUrl}/cypress-run`;
-
-// TODO it would be nice if all error objects could be enforced via types
-// to only have description + solution properties
-
-const hr = '----------';
-const genericErrorSolution = stripIndent`
-  Search for an existing issue or open a GitHub issue at
-
-    ${chalk.blue(util.issuesUrl)}
-`;
-
-// common errors Cypress application can encounter
-const unknownError = {
-  description: 'Unknown Cypress CLI error',
-  solution: genericErrorSolution
-};
-const invalidRunProjectPath = {
-  description: 'Invalid --project path',
-  solution: stripIndent`
-    Please provide a valid project path.
-
-    Learn more about ${chalk.cyan('cypress run')} at:
-
-      ${chalk.blue(runDocumentationUrl)}
-  `
-};
-const invalidOS = {
-  description: 'The Cypress App could not be installed. Your machine does not meet the operating system requirements.',
-  solution: stripIndent`
-
-  ${chalk.blue('https://on.cypress.io/app/get-started/install-cypress#System-requirements')}`
-};
-const failedDownload = {
-  description: 'The Cypress App could not be downloaded.',
-  solution: stripIndent`
-  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
-
-  Otherwise, please check network connectivity and try again:`
-};
-const failedUnzip = {
-  description: 'The Cypress App could not be unzipped.',
-  solution: genericErrorSolution
-};
-const failedUnzipWindowsMaxPathLength = {
-  description: 'The Cypress App could not be unzipped.',
-  solution: `This is most likely because the maximum path length is being exceeded on your system.
-
-  Read here for solutions to this problem: https://on.cypress.io/win-max-path-length-error`
-};
-const missingApp = binaryDir => {
-  return {
-    description: `No version of Cypress is installed in: ${chalk.cyan(binaryDir)}`,
-    solution: stripIndent`
-    \nPlease reinstall Cypress by running: ${chalk.cyan('cypress install')}
-  `
-  };
-};
-const binaryNotExecutable = executable => {
-  return {
-    description: `Cypress cannot run because this binary file does not have executable permissions here:\n\n${executable}`,
-    solution: stripIndent`\n
-    Reasons this may happen:
-
-    - node was installed as 'root' or with 'sudo'
-    - the cypress npm package as 'root' or with 'sudo'
-
-    Please check that you have the appropriate user permissions.
-
-    You can also try clearing the cache with 'cypress cache clear' and reinstalling.
-  `
-  };
-};
-const notInstalledCI = executable => {
-  return {
-    description: 'The cypress npm package is installed, but the Cypress binary is missing.',
-    solution: stripIndent`\n
-    We expected the binary to be installed here: ${chalk.cyan(executable)}
-
-    Reasons it may be missing:
-
-    - You're caching 'node_modules' but are not caching this path: ${util.getCacheDir()}
-    - You ran 'npm install' at an earlier build step but did not persist: ${util.getCacheDir()}
-
-    Properly caching the binary will fix this error and avoid downloading and unzipping Cypress.
-
-    Alternatively, you can run 'cypress install' to download the binary again.
-
-    ${chalk.blue('https://on.cypress.io/not-installed-ci-error')}
-  `
-  };
-};
-const nonZeroExitCodeXvfb = {
-  description: 'Xvfb exited with a non zero exit code.',
-  solution: stripIndent`
-    There was a problem spawning Xvfb.
-
-    This is likely a problem with your system, permissions, or installation of Xvfb.
-    `
-};
-const missingXvfb = {
-  description: 'Your system is missing the dependency: Xvfb',
-  solution: stripIndent`
-    Install Xvfb and run Cypress again.
-
-    Read our documentation on dependencies for more information:
-
-      ${chalk.blue(requiredDependenciesUrl)}
-
-    If you are using Docker, we provide containers with all required dependencies installed.
-    `
-};
-const smokeTestFailure = (smokeTestCommand, timedOut) => {
-  return {
-    description: `Cypress verification ${timedOut ? 'timed out' : 'failed'}.`,
-    solution: stripIndent`
-    This command failed with the following output:
-
-    ${smokeTestCommand}
-
-    `
-  };
-};
-const invalidSmokeTestDisplayError = {
-  code: 'INVALID_SMOKE_TEST_DISPLAY_ERROR',
-  description: 'Cypress verification failed.',
-  solution(msg) {
-    return stripIndent`
-      Cypress failed to start after spawning a new Xvfb server.
-
-      The error logs we received were:
-
-      ${hr}
-
-      ${msg}
-
-      ${hr}
-
-      This may be due to a missing library or dependency. ${chalk.blue(requiredDependenciesUrl)}
-
-      Please refer to the error above for more detail.
-    `;
-  }
-};
-const missingDependency = {
-  description: 'Cypress failed to start.',
-  // this message is too Linux specific
-  solution: stripIndent`
-    This may be due to a missing library or dependency. ${chalk.blue(requiredDependenciesUrl)}
-
-    Please refer to the error below for more details.
-  `
-};
-const invalidCacheDirectory = {
-  description: 'Cypress cannot write to the cache directory due to file permissions',
-  solution: stripIndent`
-    See discussion and possible solutions at
-    ${chalk.blue(util.getGitHubIssueUrl(1281))}
-  `
-};
-const versionMismatch = {
-  description: 'Installed version does not match package version.',
-  solution: 'Install Cypress and verify app again'
-};
-const incompatibleHeadlessFlags = {
-  description: '`--headed` and `--headless` cannot both be passed.',
-  solution: 'Either pass `--headed` or `--headless`, but not both.'
-};
-const solutionUnknown = stripIndent`
-  Please search Cypress documentation for possible solutions:
-
-    ${chalk.blue(docsUrl)}
-
-  Check if there is a GitHub issue describing this crash:
-
-    ${chalk.blue(util.issuesUrl)}
-
-  Consider opening a new issue.
-`;
-const unexpected = {
-  description: 'An unexpected error occurred while verifying the Cypress executable.',
-  solution: solutionUnknown
-};
-const invalidCypressEnv = {
-  description: chalk.red('The environment variable with the reserved name "CYPRESS_INTERNAL_ENV" is set.'),
-  solution: chalk.red('Unset the "CYPRESS_INTERNAL_ENV" environment variable and run Cypress again.'),
-  exitCode: 11
-};
-const invalidTestingType = {
-  description: 'Invalid testingType',
-  solution: `Please provide a valid testingType. Valid test types are ${chalk.cyan('\'e2e\'')} and ${chalk.cyan('\'component\'')}.`
-};
-const incompatibleTestTypeFlags = {
-  description: '`--e2e` and `--component` cannot both be passed.',
-  solution: 'Either pass `--e2e` or `--component`, but not both.'
-};
-const incompatibleTestingTypeAndFlag = {
-  description: 'Set a `testingType` and also passed `--e2e` or `--component` flags.',
-  solution: 'Either set `testingType` or pass a testing type flag, but not both.'
-};
-const invalidConfigFile = {
-  description: '`--config-file` cannot be false.',
-  solution: 'Either pass a relative path to a valid Cypress config file or remove this option.'
-};
-
-/**
- * This error happens when CLI detects that the child Test Runner process
- * was killed with a signal, like SIGBUS
- * @see https://github.com/cypress-io/cypress/issues/5808
- * @param {'close'|'event'} eventName Child close event name
- * @param {string} signal Signal that closed the child process, like "SIGBUS"
-*/
-const childProcessKilled = (eventName, signal) => {
-  return {
-    description: `The Test Runner unexpectedly exited via a ${chalk.cyan(eventName)} event with signal ${chalk.cyan(signal)}`,
-    solution: solutionUnknown
-  };
-};
-const CYPRESS_RUN_BINARY = {
-  notValid: value => {
-    const properFormat = `**/${state.getPlatformExecutable()}`;
-    return {
-      description: `Could not run binary set by environment variable: CYPRESS_RUN_BINARY=${value}`,
-      solution: `Ensure the environment variable is a path to the Cypress binary, matching ${properFormat}`
-    };
-  }
-};
-function addPlatformInformation(info) {
-  return util.getPlatformInfo().then(platform => {
-    return {
-      ...info,
-      platform
-    };
-  });
-}
-
-/**
- * Given an error object (see the errors above), forms error message text with details,
- * then resolves with Error instance you can throw or reject with.
- * @param {object} errorObject
- * @returns {Promise<Error>} resolves with an Error
- * @example
-  ```js
-  // inside a Promise with "resolve" and "reject"
-  const errorObject = childProcessKilled('exit', 'SIGKILL')
-  return getError(errorObject).then(reject)
-  ```
- */
-function getError(errorObject) {
-  return formErrorText(errorObject).then(errorMessage => {
-    const err = new Error(errorMessage);
-    err.known = true;
-    return err;
-  });
-}
-
-/**
- * Forms nice error message with error and platform information,
- * and if possible a way to solve it. Resolves with a string.
- */
-function formErrorText(info, msg, prevMessage) {
-  return addPlatformInformation(info).then(obj => {
-    const formatted = [];
-    function add(msg) {
-      formatted.push(stripIndents(msg));
-    }
-    la(is.unemptyString(obj.description), 'expected error description to be text', obj.description);
-
-    // assuming that if there the solution is a function it will handle
-    // error message and (optional previous error message)
-    if (is.fn(obj.solution)) {
-      const text = obj.solution(msg, prevMessage);
-      la(is.unemptyString(text), 'expected solution to be text', text);
-      add(`
-        ${obj.description}
-
-        ${text}
-
-      `);
-    } else {
-      la(is.unemptyString(obj.solution), 'expected error solution to be text', obj.solution);
-      add(`
-        ${obj.description}
-
-        ${obj.solution}
-
-      `);
-      if (msg) {
-        add(`
-          ${hr}
-
-          ${msg}
-
-        `);
-      }
-    }
-    add(`
-      ${hr}
-
-      ${obj.platform}
-    `);
-    if (obj.footer) {
-      add(`
-
-        ${hr}
-
-        ${obj.footer}
-      `);
-    }
-    return formatted.join('\n\n');
-  });
-}
-const raise = info => {
-  return text => {
-    const err = new Error(text);
-    if (info.code) {
-      err.code = info.code;
-    }
-    err.known = true;
-    throw err;
-  };
-};
-const throwFormErrorText = info => {
-  return (msg, prevMessage) => {
-    return formErrorText(info, msg, prevMessage).then(raise(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')
- */
-const exitWithError = info => {
-  return msg => {
-    return formErrorText(info, msg).then(text => {
-      // eslint-disable-next-line no-console
-      console.error(text);
-      process.exit(info.exitCode || 1);
-    });
-  };
-};
-module.exports = {
-  raise,
-  exitWithError,
-  // formError,
-  formErrorText,
-  throwFormErrorText,
-  getError,
-  hr,
-  errors: {
-    unknownError,
-    nonZeroExitCodeXvfb,
-    missingXvfb,
-    missingApp,
-    notInstalledCI,
-    missingDependency,
-    invalidOS,
-    invalidSmokeTestDisplayError,
-    versionMismatch,
-    binaryNotExecutable,
-    unexpected,
-    failedDownload,
-    failedUnzip,
-    failedUnzipWindowsMaxPathLength,
-    invalidCypressEnv,
-    invalidCacheDirectory,
-    CYPRESS_RUN_BINARY,
-    smokeTestFailure,
-    childProcessKilled,
-    incompatibleHeadlessFlags,
-    invalidRunProjectPath,
-    invalidTestingType,
-    incompatibleTestTypeFlags,
-    incompatibleTestingTypeAndFlag,
-    invalidConfigFile
-  }
-};

package/lib/exec/info.js

@@ -1,92 +0,0 @@
-"use strict";
-
-/* eslint-disable no-console */
-const spawn = require('./spawn');
-const util = require('../util');
-const state = require('../tasks/state');
-const os = require('os');
-const chalk = require('chalk');
-const prettyBytes = require('pretty-bytes');
-const _ = require('lodash');
-
-// color for numbers and show values
-const g = chalk.green;
-// color for paths
-const p = chalk.cyan;
-const red = chalk.red;
-// urls
-const link = chalk.blue.underline;
-
-// to be exported
-const methods = {};
-methods.findProxyEnvironmentVariables = () => {
-  return _.pick(process.env, ['HTTP_PROXY', 'HTTPS_PROXY', 'NO_PROXY']);
-};
-const maskSensitiveVariables = obj => {
-  const masked = {
-    ...obj
-  };
-  if (masked.CYPRESS_RECORD_KEY) {
-    masked.CYPRESS_RECORD_KEY = '<redacted>';
-  }
-  return masked;
-};
-methods.findCypressEnvironmentVariables = () => {
-  const isCyVariable = (val, key) => key.startsWith('CYPRESS_');
-  return _.pickBy(process.env, isCyVariable);
-};
-const formatCypressVariables = () => {
-  const vars = methods.findCypressEnvironmentVariables();
-  return maskSensitiveVariables(vars);
-};
-methods.start = async (options = {}) => {
-  const args = ['--mode=info'];
-  await spawn.start(args, {
-    dev: options.dev
-  });
-  console.log();
-  const proxyVars = methods.findProxyEnvironmentVariables();
-  if (_.isEmpty(proxyVars)) {
-    console.log('Proxy Settings: none detected');
-  } else {
-    console.log('Proxy Settings:');
-    _.forEach(proxyVars, (value, key) => {
-      console.log('%s: %s', key, g(value));
-    });
-    console.log();
-    console.log('Learn More: %s', link('https://on.cypress.io/proxy-configuration'));
-    console.log();
-  }
-  const cyVars = formatCypressVariables();
-  if (_.isEmpty(cyVars)) {
-    console.log('Environment Variables: none detected');
-  } else {
-    console.log('Environment Variables:');
-    _.forEach(cyVars, (value, key) => {
-      console.log('%s: %s', key, g(value));
-    });
-  }
-  console.log();
-  console.log('Application Data:', p(util.getApplicationDataFolder()));
-  console.log('Browser Profiles:', p(util.getApplicationDataFolder('browsers')));
-  console.log('Binary Caches: %s', p(state.getCacheDir()));
-  console.log();
-  const osVersion = await util.getOsVersionAsync();
-  const buildInfo = util.pkgBuildInfo();
-  const isStable = buildInfo && buildInfo.stable;
-  console.log('Cypress Version: %s', g(util.pkgVersion()), isStable ? g('(stable)') : red('(pre-release)'));
-  console.log('System Platform: %s (%s)', g(os.platform()), g(osVersion));
-  console.log('System Memory: %s free %s', g(prettyBytes(os.totalmem())), g(prettyBytes(os.freemem())));
-  if (!buildInfo) {
-    console.log();
-    console.log('This is the', red('development'), '(un-built) Cypress CLI.');
-  } else if (!isStable) {
-    console.log();
-    console.log('This is a', red('pre-release'), 'build of Cypress.');
-    console.log('Build info:');
-    console.log('  Commit SHA:', g(buildInfo.commitSha));
-    console.log('  Commit Branch:', g(buildInfo.commitBranch));
-    console.log('  Commit Date:', g(buildInfo.commitDate));
-  }
-};
-module.exports = methods;

package/lib/exec/open.js

@@ -1,90 +0,0 @@
-"use strict";
-
-const debug = require('debug')('cypress:cli');
-const util = require('../util');
-const spawn = require('./spawn');
-const verify = require('../tasks/verify');
-const {
-  processTestingType,
-  checkConfigFile
-} = require('./shared');
-const {
-  exitWithError
-} = require('../errors');
-
-/**
- * Maps options collected by the CLI
- * and forms list of CLI arguments to the server.
- *
- * Note: there is lightweight validation, with errors
- * thrown synchronously.
- *
- * @returns {string[]} list of CLI arguments
- */
-const processOpenOptions = (options = {}) => {
-  // In addition to setting the project directory, setting the project option
-  // here ultimately decides whether cypress is run in global mode or not.
-  // It's first based off whether it's installed globally by npm/yarn (-g).
-  // A global install can be overridden by the --project flag, putting Cypress
-  // in project mode. A non-global install can be overridden by the --global
-  // flag, putting it in global mode.
-  if (!util.isInstalledGlobally() && !options.global && !options.project) {
-    options.project = process.cwd();
-  }
-  const args = [];
-  if (options.config) {
-    args.push('--config', options.config);
-  }
-  if (options.configFile !== undefined) {
-    checkConfigFile(options);
-    args.push('--config-file', options.configFile);
-  }
-  if (options.browser) {
-    args.push('--browser', options.browser);
-  }
-  if (options.env) {
-    args.push('--env', options.env);
-  }
-  if (options.port) {
-    args.push('--port', options.port);
-  }
-  if (options.project) {
-    args.push('--project', options.project);
-  }
-  if (options.global) {
-    args.push('--global', options.global);
-  }
-  if (options.inspect) {
-    args.push('--inspect');
-  }
-  if (options.inspectBrk) {
-    args.push('--inspectBrk');
-  }
-  args.push(...processTestingType(options));
-  debug('opening from options %j', options);
-  debug('command line arguments %j', args);
-  return args;
-};
-module.exports = {
-  processOpenOptions,
-  start(options = {}) {
-    function open() {
-      try {
-        const args = processOpenOptions(options);
-        return spawn.start(args, {
-          dev: options.dev,
-          detached: Boolean(options.detached)
-        });
-      } catch (err) {
-        if (err.details) {
-          return exitWithError(err.details)();
-        }
-        throw err;
-      }
-    }
-    if (options.dev) {
-      return open();
-    }
-    return verify.start().then(open);
-  }
-};