cypress 15.1.0 → 15.3.0

package/dist/cypress.js

@@ -0,0 +1,104 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+// https://github.com/cypress-io/cypress/issues/316
+const tmp_1 = __importDefault(require("tmp"));
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const open_1 = __importDefault(require("./exec/open"));
+const run_1 = __importDefault(require("./exec/run"));
+const util_1 = __importDefault(require("./util"));
+const cli_1 = __importDefault(require("./cli"));
+const cypressModuleApi = {
+    /**
+     * Opens Cypress GUI
+     * @see https://on.cypress.io/module-api#cypress-open
+     */
+    open(options = {}) {
+        options = util_1.default.normalizeModuleOptions(options);
+        return open_1.default.start(options);
+    },
+    /**
+     * Runs Cypress tests in the current project
+     * @see https://on.cypress.io/module-api#cypress-run
+     */
+    run() {
+        return __awaiter(this, arguments, void 0, function* (options = {}) {
+            if (!run_1.default.isValidProject(options.project)) {
+                throw new Error(`Invalid project path parameter: ${options.project}`);
+            }
+            options = util_1.default.normalizeModuleOptions(options);
+            tmp_1.default.setGracefulCleanup();
+            const outputPath = tmp_1.default.fileSync().name;
+            options.outputPath = outputPath;
+            const failedTests = yield run_1.default.start(options);
+            const output = yield fs_extra_1.default.readJson(outputPath, { throws: false });
+            if (!output) {
+                return {
+                    status: 'failed',
+                    failures: failedTests,
+                    message: 'Could not find Cypress test run results',
+                };
+            }
+            return output;
+        });
+    },
+    cli: {
+        /**
+         * Parses CLI arguments into an object that you can pass to "cypress.run"
+         * @example
+         *  const cypress = require('cypress')
+         *  const cli = ['cypress', 'run', '--browser', 'firefox']
+         *  const options = await cypress.cli.parseRunArguments(cli)
+         *  // options is {browser: 'firefox'}
+         *  await cypress.run(options)
+         * @see https://on.cypress.io/module-api
+         */
+        parseRunArguments(args) {
+            return cli_1.default.parseRunCommand(args);
+        },
+    },
+    /**
+     * Provides automatic code completion for configuration in many popular code editors.
+     * While it's not strictly necessary for Cypress to parse your configuration, we
+     * recommend wrapping your config object with `defineConfig()`
+     * @example
+     * module.exports = defineConfig({
+     *   viewportWith: 400
+     * })
+     *
+     * @see ../types/cypress-npm-api.d.ts
+     * @param {Cypress.ConfigOptions} config
+     * @returns {Cypress.ConfigOptions} the configuration passed in parameter
+     */
+    defineConfig(config) {
+        return config;
+    },
+    /**
+     * Provides automatic code completion for Component Frameworks Definitions.
+     * While it's not strictly necessary for Cypress to parse your configuration, we
+     * recommend wrapping your Component Framework Definition object with `defineComponentFramework()`
+     * @example
+     * module.exports = defineComponentFramework({
+     *   type: 'cypress-ct-solid-js'
+     *   // ...
+     * })
+     *
+     * @see ../types/cypress-npm-api.d.ts
+     * @param {Cypress.ThirdPartyComponentFrameworkDefinition} config
+     * @returns {Cypress.ThirdPartyComponentFrameworkDefinition} the configuration passed in parameter
+     */
+    defineComponentFramework(config) {
+        return config;
+    },
+};
+module.exports = cypressModuleApi;

package/dist/errors.js

@@ -0,0 +1,391 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.errors = exports.exitWithError = exports.throwFormErrorText = exports.raise = exports.hr = void 0;
+exports.getError = getError;
+exports.formErrorText = formErrorText;
+const chalk_1 = __importDefault(require("chalk"));
+const common_tags_1 = require("common-tags");
+const lodash_1 = __importDefault(require("lodash"));
+const assert_1 = __importDefault(require("assert"));
+const util_1 = __importDefault(require("./util"));
+const state_1 = __importDefault(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
+exports.hr = '----------';
+const genericErrorSolution = (0, common_tags_1.stripIndent) `
+  Search for an existing issue or open a GitHub issue at
+
+    ${chalk_1.default.blue(util_1.default.issuesUrl)}
+`;
+// common errors Cypress application can encounter
+const unknownError = {
+    description: 'Unknown Cypress CLI error',
+    solution: genericErrorSolution,
+};
+const invalidRunProjectPath = {
+    description: 'Invalid --project path',
+    solution: (0, common_tags_1.stripIndent) `
+    Please provide a valid project path.
+
+    Learn more about ${chalk_1.default.cyan('cypress run')} at:
+
+      ${chalk_1.default.blue(runDocumentationUrl)}
+  `,
+};
+const invalidOS = {
+    description: 'The Cypress App could not be installed. Your machine does not meet the operating system requirements.',
+    solution: (0, common_tags_1.stripIndent) `
+
+  ${chalk_1.default.blue('https://on.cypress.io/app/get-started/install-cypress#System-requirements')}`,
+};
+const failedDownload = {
+    description: 'The Cypress App could not be downloaded.',
+    solution: (0, common_tags_1.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_1.default.cyan(binaryDir)}`,
+        solution: (0, common_tags_1.stripIndent) `
+    \nPlease reinstall Cypress by running: ${chalk_1.default.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: (0, common_tags_1.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: (0, common_tags_1.stripIndent) `\n
+    We expected the binary to be installed here: ${chalk_1.default.cyan(executable)}
+
+    Reasons it may be missing:
+
+    - You're caching 'node_modules' but are not caching this path: ${util_1.default.getCacheDir()}
+    - You ran 'npm install' at an earlier build step but did not persist: ${util_1.default.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_1.default.blue('https://on.cypress.io/not-installed-ci-error')}
+  `,
+    };
+};
+const nonZeroExitCodeXvfb = {
+    description: 'Xvfb exited with a non zero exit code.',
+    solution: (0, common_tags_1.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: (0, common_tags_1.stripIndent) `
+    Install Xvfb and run Cypress again.
+
+    Read our documentation on dependencies for more information:
+
+      ${chalk_1.default.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: (0, common_tags_1.stripIndent) `
+    This command failed with the following output:
+
+    ${smokeTestCommand}
+
+    `,
+    };
+};
+const invalidSmokeTestDisplayError = {
+    code: 'INVALID_SMOKE_TEST_DISPLAY_ERROR',
+    description: 'Cypress verification failed.',
+    solution(msg) {
+        return (0, common_tags_1.stripIndent) `
+      Cypress failed to start after spawning a new Xvfb server.
+
+      The error logs we received were:
+
+      ${exports.hr}
+
+      ${msg}
+
+      ${exports.hr}
+
+      This may be due to a missing library or dependency. ${chalk_1.default.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: (0, common_tags_1.stripIndent) `
+    This may be due to a missing library or dependency. ${chalk_1.default.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: (0, common_tags_1.stripIndent) `
+    See discussion and possible solutions at
+    ${chalk_1.default.blue(util_1.default.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 = (0, common_tags_1.stripIndent) `
+  Please search Cypress documentation for possible solutions:
+
+    ${chalk_1.default.blue(docsUrl)}
+
+  Check if there is a GitHub issue describing this crash:
+
+    ${chalk_1.default.blue(util_1.default.issuesUrl)}
+
+  Consider opening a new issue.
+`;
+const unexpected = {
+    description: 'An unexpected error occurred while verifying the Cypress executable.',
+    solution: solutionUnknown,
+};
+const invalidCypressEnv = {
+    description: chalk_1.default.red('The environment variable with the reserved name "CYPRESS_INTERNAL_ENV" is set.'),
+    solution: chalk_1.default.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_1.default.cyan('\'e2e\'')} and ${chalk_1.default.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_1.default.cyan(eventName)} event with signal ${chalk_1.default.cyan(signal)}`,
+        solution: solutionUnknown,
+    };
+};
+const CYPRESS_RUN_BINARY = {
+    notValid: (value) => {
+        const properFormat = `**/${state_1.default.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 __awaiter(this, void 0, void 0, function* () {
+        const platform = yield util_1.default.getPlatformInfo();
+        return Object.assign(Object.assign({}, 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 __awaiter(this, void 0, void 0, function* () {
+        const errorMessage = yield formErrorText(errorObject);
+        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 __awaiter(this, void 0, void 0, function* () {
+        const infoWithPlatform = yield addPlatformInformation(info);
+        const formatted = [];
+        function add(msg) {
+            formatted.push((0, common_tags_1.stripIndents)(msg));
+        }
+        assert_1.default.ok(lodash_1.default.isString(infoWithPlatform.description) && !lodash_1.default.isEmpty(infoWithPlatform.description), 'expected error description to be text.');
+        // assuming that if there the solution is a function it will handle
+        // error message and (optional previous error message)
+        if (lodash_1.default.isFunction(infoWithPlatform.solution)) {
+            const text = infoWithPlatform.solution(msg, prevMessage);
+            assert_1.default.ok(lodash_1.default.isString(text) && !lodash_1.default.isEmpty(text), 'expected solution to be text.');
+            add(`
+        ${infoWithPlatform.description}
+
+        ${text}
+
+      `);
+        }
+        else {
+            assert_1.default.ok(lodash_1.default.isString(infoWithPlatform.solution) && !lodash_1.default.isEmpty(infoWithPlatform.solution), 'expected error solution to be text.');
+            add(`
+        ${infoWithPlatform.description}
+
+        ${infoWithPlatform.solution}
+
+      `);
+            if (msg) {
+                add(`
+          ${exports.hr}
+
+          ${msg}
+
+        `);
+            }
+        }
+        add(`
+      ${exports.hr}
+
+      ${infoWithPlatform.platform}
+    `);
+        if (infoWithPlatform.footer) {
+            add(`
+
+        ${exports.hr}
+
+        ${infoWithPlatform.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;
+    };
+};
+exports.raise = raise;
+const throwFormErrorText = (info) => {
+    return (msg, prevMessage) => __awaiter(void 0, void 0, void 0, function* () {
+        const errorText = yield formErrorText(info, msg, prevMessage);
+        (0, exports.raise)(info)(errorText);
+    });
+};
+exports.throwFormErrorText = throwFormErrorText;
+/**
+ * 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) => __awaiter(void 0, void 0, void 0, function* () {
+        const text = yield formErrorText(info, msg);
+        // eslint-disable-next-line no-console
+        console.error(text);
+        process.exit(info.exitCode || 1);
+    });
+};
+exports.exitWithError = exitWithError;
+exports.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/dist/exec/info.js

@@ -0,0 +1,103 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable no-console */
+const spawn_1 = __importDefault(require("./spawn"));
+const util_1 = __importDefault(require("../util"));
+const state_1 = __importDefault(require("../tasks/state"));
+const os_1 = __importDefault(require("os"));
+const chalk_1 = __importDefault(require("chalk"));
+const pretty_bytes_1 = __importDefault(require("pretty-bytes"));
+const lodash_1 = __importDefault(require("lodash"));
+// color for numbers and show values
+const g = chalk_1.default.green;
+// color for paths
+const p = chalk_1.default.cyan;
+const red = chalk_1.default.red;
+// urls
+const link = chalk_1.default.blue.underline;
+// to be exported
+const methods = {};
+methods.findProxyEnvironmentVariables = () => {
+    return lodash_1.default.pick(process.env, ['HTTP_PROXY', 'HTTPS_PROXY', 'NO_PROXY']);
+};
+const maskSensitiveVariables = (obj) => {
+    const masked = Object.assign({}, obj);
+    if (masked.CYPRESS_RECORD_KEY) {
+        masked.CYPRESS_RECORD_KEY = '<redacted>';
+    }
+    return masked;
+};
+methods.findCypressEnvironmentVariables = () => {
+    const isCyVariable = (val, key) => key.startsWith('CYPRESS_');
+    return lodash_1.default.pickBy(process.env, isCyVariable);
+};
+const formatCypressVariables = () => {
+    const vars = methods.findCypressEnvironmentVariables();
+    return maskSensitiveVariables(vars);
+};
+methods.start = (...args_1) => __awaiter(void 0, [...args_1], void 0, function* (options = {}) {
+    const args = ['--mode=info'];
+    yield spawn_1.default.start(args, {
+        dev: options.dev,
+    });
+    console.log();
+    const proxyVars = methods.findProxyEnvironmentVariables();
+    if (lodash_1.default.isEmpty(proxyVars)) {
+        console.log('Proxy Settings: none detected');
+    }
+    else {
+        console.log('Proxy Settings:');
+        lodash_1.default.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 (lodash_1.default.isEmpty(cyVars)) {
+        console.log('Environment Variables: none detected');
+    }
+    else {
+        console.log('Environment Variables:');
+        lodash_1.default.forEach(cyVars, (value, key) => {
+            console.log('%s: %s', key, g(value));
+        });
+    }
+    console.log();
+    console.log('Application Data:', p(util_1.default.getApplicationDataFolder()));
+    console.log('Browser Profiles:', p(util_1.default.getApplicationDataFolder('browsers')));
+    console.log('Binary Caches: %s', p(state_1.default.getCacheDir()));
+    console.log();
+    const osVersion = yield util_1.default.getOsVersionAsync();
+    const buildInfo = util_1.default.pkgBuildInfo();
+    const isStable = buildInfo && buildInfo.stable;
+    console.log('Cypress Version: %s', g(util_1.default.pkgVersion()), isStable ? g('(stable)') : red('(pre-release)'));
+    console.log('System Platform: %s (%s)', g(os_1.default.platform()), g(osVersion));
+    console.log('System Memory: %s free %s', g((0, pretty_bytes_1.default)(os_1.default.totalmem())), g((0, pretty_bytes_1.default)(os_1.default.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));
+    }
+});
+exports.default = methods;