cypress 15.2.0 → 15.4.0

package/bin/cypress

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
 
-const CLI = require('../lib/cli').default
+const CLI = require('../dist/cli').default
 
 CLI.init()

package/{lib → dist}/cli.js

@@ -1,4 +1,13 @@
 "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 };
 };
@@ -15,7 +24,7 @@ const errors_1 = require("./errors");
 const cache_1 = __importDefault(require("./tasks/cache"));
 const open_1 = __importDefault(require("./exec/open"));
 const run_1 = __importDefault(require("./exec/run"));
-const verify_1 = __importDefault(require("./tasks/verify"));
+const verify_1 = require("./tasks/verify");
 const install_1 = __importDefault(require("./tasks/install"));
 const versions_1 = __importDefault(require("./exec/versions"));
 const info_1 = __importDefault(require("./exec/info"));
@@ -29,7 +38,7 @@ function unknownOption(flag, type = 'option') {
     logger_1.default.error(`  error: unknown ${type}:`, flag);
     logger_1.default.error();
     this.outputHelp();
-    util_1.default.exit(1);
+    process.exit(1);
 }
 commander_1.default.Command.prototype.unknownOption = unknownOption;
 const coerceFalse = (arg) => {
@@ -115,6 +124,7 @@ const descriptions = {
     parallel: 'enables concurrent runs and automatic load balancing of specs across multiple machines or processes',
     port: 'runs Cypress on a specific port. overrides any value in cypress.config.{js,ts,mjs,cjs}.',
     project: 'path to the project',
+    posixExitCodes: 'use POSIX exit codes for error handling',
     quiet: 'run quietly, using only the configured reporter',
     record: 'records the run. sends test results, screenshots and videos to Cypress Cloud.',
     reporter: 'runs a specific mocha reporter. pass a path to use a custom reporter. defaults to "spec"',
@@ -150,50 +160,53 @@ function includesVersion(args) {
         lodash_1.default.includes(args, '-v'));
 }
 function showVersions(opts) {
-    debug('printing Cypress version');
-    debug('additional arguments %o', opts);
-    debug('parsed version arguments %o', opts);
-    const reportAllVersions = (versions) => {
-        logger_1.default.always('Cypress package version:', versions.package);
-        logger_1.default.always('Cypress binary version:', versions.binary);
-        logger_1.default.always('Electron version:', versions.electronVersion);
-        logger_1.default.always('Bundled Node version:', versions.electronNodeVersion);
-    };
-    const reportComponentVersion = (componentName, versions) => {
-        const names = {
-            package: 'package',
-            binary: 'binary',
-            electron: 'electronVersion',
-            node: 'electronNodeVersion',
+    return __awaiter(this, void 0, void 0, function* () {
+        debug('printing Cypress version');
+        debug('additional arguments %o', opts);
+        debug('parsed version arguments %o', opts);
+        const reportAllVersions = (versions) => {
+            logger_1.default.always('Cypress package version:', versions.package);
+            logger_1.default.always('Cypress binary version:', versions.binary);
+            logger_1.default.always('Electron version:', versions.electronVersion);
+            logger_1.default.always('Bundled Node version:', versions.electronNodeVersion);
         };
-        if (!names[componentName]) {
-            throw new Error(`Unknown component name "${componentName}"`);
-        }
-        const name = names[componentName];
-        if (!versions[name]) {
-            throw new Error(`Cannot find version for component "${componentName}" under property "${name}"`);
-        }
-        const version = versions[name];
-        logger_1.default.always(version);
-    };
-    const defaultVersions = {
-        package: undefined,
-        binary: undefined,
-        electronVersion: undefined,
-        electronNodeVersion: undefined,
-    };
-    return versions_1.default
-        .getVersions()
-        .then((versions = defaultVersions) => {
-        if (opts === null || opts === void 0 ? void 0 : opts.component) {
-            reportComponentVersion(opts.component, versions);
+        const reportComponentVersion = (componentName, versions) => {
+            const names = {
+                package: 'package',
+                binary: 'binary',
+                electron: 'electronVersion',
+                node: 'electronNodeVersion',
+            };
+            if (!names[componentName]) {
+                throw new Error(`Unknown component name "${componentName}"`);
+            }
+            const name = names[componentName];
+            if (!versions[name]) {
+                throw new Error(`Cannot find version for component "${componentName}" under property "${name}"`);
+            }
+            const version = versions[name];
+            logger_1.default.always(version);
+        };
+        const defaultVersions = {
+            package: undefined,
+            binary: undefined,
+            electronVersion: undefined,
+            electronNodeVersion: undefined,
+        };
+        try {
+            const versions = (yield versions_1.default.getVersions()) || defaultVersions;
+            if (opts === null || opts === void 0 ? void 0 : opts.component) {
+                reportComponentVersion(opts.component, versions);
+            }
+            else {
+                reportAllVersions(versions);
+            }
+            process.exit(0);
         }
-        else {
-            reportAllVersions(versions);
+        catch (e) {
+            util_1.default.logErrorExit1(e);
         }
-        process.exit(0);
-    })
-        .catch(util_1.default.logErrorExit1);
+    });
 }
 const createProgram = () => {
     const program = new commander_1.default.Command();
@@ -224,6 +237,7 @@ const addCypressRunCommand = (program) => {
         .option('--parallel', text('parallel'))
         .option('-p, --port <port>', text('port'))
         .option('-P, --project <project-path>', text('project'))
+        .option('--posix-exit-codes', text('posixExitCodes'))
         .option('-q, --quiet', text('quiet'))
         .option('--record [bool]', text('record'), coerceFalse)
         .option('-r, --reporter <reporter>', text('reporter'))
@@ -345,171 +359,188 @@ const cliModule = {
      * Parses the command line and kicks off Cypress process.
      */
     init(args) {
-        if (!args) {
-            args = process.argv;
-        }
-        const { CYPRESS_INTERNAL_ENV, CYPRESS_DOWNLOAD_USE_CA } = process.env;
-        if (process.env.CYPRESS_DOWNLOAD_USE_CA) {
-            let msg = `
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!args) {
+                args = process.argv;
+            }
+            const { CYPRESS_INTERNAL_ENV, CYPRESS_DOWNLOAD_USE_CA } = process.env;
+            if (process.env.CYPRESS_DOWNLOAD_USE_CA) {
+                let msg = `
         ${log_symbols_1.default.warning} Warning: It looks like you're setting CYPRESS_DOWNLOAD_USE_CA=${CYPRESS_DOWNLOAD_USE_CA}
 
         The environment variable "CYPRESS_DOWNLOAD_USE_CA" is no longer required to be set.
         
         You can safely unset this environment variable.
       `;
-            logger_1.default.log();
-            logger_1.default.warn((0, common_tags_1.stripIndent)(msg));
-            logger_1.default.log();
-        }
-        if (!util_1.default.isValidCypressInternalEnvValue(CYPRESS_INTERNAL_ENV)) {
-            debug('invalid CYPRESS_INTERNAL_ENV value', CYPRESS_INTERNAL_ENV);
-            return (0, errors_1.exitWithError)(errors_1.errors.invalidCypressEnv)(`CYPRESS_INTERNAL_ENV=${CYPRESS_INTERNAL_ENV}`);
-        }
-        if (util_1.default.isNonProductionCypressInternalEnvValue(CYPRESS_INTERNAL_ENV)) {
-            debug('non-production CYPRESS_INTERNAL_ENV value', CYPRESS_INTERNAL_ENV);
-            let msg = `
+                logger_1.default.log();
+                logger_1.default.warn((0, common_tags_1.stripIndent)(msg));
+                logger_1.default.log();
+            }
+            if (!util_1.default.isValidCypressInternalEnvValue(CYPRESS_INTERNAL_ENV)) {
+                debug('invalid CYPRESS_INTERNAL_ENV value', CYPRESS_INTERNAL_ENV);
+                return (0, errors_1.exitWithError)(errors_1.errors.invalidCypressEnv)(`CYPRESS_INTERNAL_ENV=${CYPRESS_INTERNAL_ENV}`);
+            }
+            if (util_1.default.isNonProductionCypressInternalEnvValue(CYPRESS_INTERNAL_ENV)) {
+                debug('non-production CYPRESS_INTERNAL_ENV value', CYPRESS_INTERNAL_ENV);
+                let msg = `
         ${log_symbols_1.default.warning} Warning: It looks like you're passing CYPRESS_INTERNAL_ENV=${CYPRESS_INTERNAL_ENV}
 
         The environment variable "CYPRESS_INTERNAL_ENV" is reserved and should only be used internally.
 
         Unset the "CYPRESS_INTERNAL_ENV" environment variable and run Cypress again.
       `;
-            logger_1.default.log();
-            logger_1.default.warn((0, common_tags_1.stripIndent)(msg));
-            logger_1.default.log();
-        }
-        const program = createProgram();
-        program
-            .command('help')
-            .description('Shows CLI help and exits')
-            .action(() => {
-            program.help();
-        });
-        const handleVersion = (cmd) => {
-            return cmd
-                .option('--component <package|binary|electron|node>', 'component to report version for')
-                .action((opts, ...other) => {
-                showVersions(util_1.default.parseOpts(opts));
-            });
-        };
-        handleVersion(program
-            .storeOptionsAsProperties()
-            .option('-v, --version', text('version'))
-            .command('version')
-            .description(text('version')));
-        maybeAddInspectFlags(addCypressOpenCommand(program))
-            .action((opts) => {
-            debug('opening Cypress');
-            open_1.default.start(util_1.default.parseOpts(opts))
-                .then(util_1.default.exit)
-                .catch(util_1.default.logErrorExit1);
-        });
-        maybeAddInspectFlags(addCypressRunCommand(program))
-            .action((...fnArgs) => {
-            debug('running Cypress with args %o', fnArgs);
-            run_1.default.start(parseVariableOpts(fnArgs, args))
-                .then(util_1.default.exit)
-                .catch(util_1.default.logErrorExit1);
-        });
-        program
-            .command('install')
-            .usage('[options]')
-            .description('Installs the Cypress executable matching this package\'s version')
-            .option('-f, --force', text('forceInstall'))
-            .action((opts) => {
-            install_1.default
-                .start(util_1.default.parseOpts(opts))
-                .catch(util_1.default.logErrorExit1);
-        });
-        program
-            .command('verify')
-            .usage('[options]')
-            .description('Verifies that Cypress is installed correctly and executable')
-            .option('--dev', text('dev'), coerceFalse)
-            .action((opts) => {
-            const defaultOpts = { force: true, welcomeMessage: false };
-            const parsedOpts = util_1.default.parseOpts(opts);
-            const options = lodash_1.default.extend(parsedOpts, defaultOpts);
-            verify_1.default
-                .start(options)
-                .catch(util_1.default.logErrorExit1);
-        });
-        program
-            .command('cache')
-            .usage('[command]')
-            .description('Manages the Cypress binary cache')
-            .option('list', text('cacheList'))
-            .option('path', text('cachePath'))
-            .option('clear', text('cacheClear'))
-            .option('prune', text('cachePrune'))
-            .option('--size', text('cacheSize'))
-            .action(function (opts, args) {
-            if (!args || !args.length) {
-                this.outputHelp();
-                util_1.default.exit(1);
+                logger_1.default.log();
+                logger_1.default.warn((0, common_tags_1.stripIndent)(msg));
+                logger_1.default.log();
             }
-            const [command] = args;
-            if (!lodash_1.default.includes(['list', 'path', 'clear', 'prune'], command)) {
-                unknownOption.call(this, `cache ${command}`, 'command');
-            }
-            if (command === 'list') {
-                debug('cache command %o', {
-                    command,
-                    size: opts.size,
+            const program = createProgram();
+            program
+                .command('help')
+                .description('Shows CLI help and exits')
+                .action(() => {
+                program.help();
+            });
+            const handleVersion = (cmd) => {
+                return cmd
+                    .option('--component <package|binary|electron|node>', 'component to report version for')
+                    .action((opts, ...other) => {
+                    showVersions(util_1.default.parseOpts(opts));
                 });
-                return cache_1.default.list(opts.size)
-                    .catch({ code: 'ENOENT' }, () => {
-                    logger_1.default.always('No cached binary versions were found.');
-                    process.exit(0);
-                })
-                    .catch((e) => {
-                    debug('cache list command failed with "%s"', e.message);
+            };
+            handleVersion(program
+                .storeOptionsAsProperties()
+                .option('-v, --version', text('version'))
+                .command('version')
+                .description(text('version')));
+            maybeAddInspectFlags(addCypressOpenCommand(program))
+                .action((opts) => __awaiter(this, void 0, void 0, function* () {
+                debug('opening Cypress');
+                try {
+                    const code = yield open_1.default.start(util_1.default.parseOpts(opts));
+                    process.exit(code);
+                }
+                catch (e) {
+                    util_1.default.logErrorExit1(e);
+                }
+            }));
+            maybeAddInspectFlags(addCypressRunCommand(program))
+                .action((...fnArgs) => __awaiter(this, void 0, void 0, function* () {
+                debug('running Cypress with args %o', fnArgs);
+                try {
+                    const code = yield run_1.default.start(parseVariableOpts(fnArgs, args));
+                    process.exit(code);
+                }
+                catch (e) {
+                    util_1.default.logErrorExit1(e);
+                }
+            }));
+            program
+                .command('install')
+                .usage('[options]')
+                .description('Installs the Cypress executable matching this package\'s version')
+                .option('-f, --force', text('forceInstall'))
+                .action((opts) => __awaiter(this, void 0, void 0, function* () {
+                try {
+                    yield install_1.default.start(util_1.default.parseOpts(opts));
+                }
+                catch (e) {
                     util_1.default.logErrorExit1(e);
+                }
+            }));
+            program
+                .command('verify')
+                .usage('[options]')
+                .description('Verifies that Cypress is installed correctly and executable')
+                .option('--dev', text('dev'), coerceFalse)
+                .action((opts) => __awaiter(this, void 0, void 0, function* () {
+                const defaultOpts = { force: true, welcomeMessage: false };
+                const parsedOpts = util_1.default.parseOpts(opts);
+                const options = lodash_1.default.extend(parsedOpts, defaultOpts);
+                try {
+                    yield (0, verify_1.start)(options);
+                }
+                catch (e) {
+                    util_1.default.logErrorExit1(e);
+                }
+            }));
+            program
+                .command('cache')
+                .usage('[command]')
+                .description('Manages the Cypress binary cache')
+                .option('list', text('cacheList'))
+                .option('path', text('cachePath'))
+                .option('clear', text('cacheClear'))
+                .option('prune', text('cachePrune'))
+                .option('--size', text('cacheSize'))
+                .action(function (opts, args) {
+                return __awaiter(this, void 0, void 0, function* () {
+                    if (!args || !args.length) {
+                        this.outputHelp();
+                        process.exit(1);
+                    }
+                    const [command] = args;
+                    if (!lodash_1.default.includes(['list', 'path', 'clear', 'prune'], command)) {
+                        unknownOption.call(this, `cache ${command}`, 'command');
+                    }
+                    if (command === 'list') {
+                        debug('cache command %o', {
+                            command,
+                            size: opts.size,
+                        });
+                        try {
+                            const result = yield cache_1.default.list(opts.size);
+                            return result;
+                        }
+                        catch (e) {
+                            if (e.code === 'ENOENT') {
+                                logger_1.default.always('No cached binary versions were found.');
+                                process.exit(0);
+                            }
+                            util_1.default.logErrorExit1(e);
+                        }
+                    }
+                    cache_1.default[command]();
                 });
+            });
+            program
+                .command('info')
+                .usage('[command]')
+                .description('Prints Cypress and system information')
+                .option('--dev', text('dev'), coerceFalse)
+                .action((opts) => __awaiter(this, void 0, void 0, function* () {
+                try {
+                    const code = yield info_1.default.start(opts);
+                    process.exit(code);
+                }
+                catch (e) {
+                    util_1.default.logErrorExit1(e);
+                }
+            }));
+            debug('cli starts with arguments %j', args);
+            util_1.default.printNodeOptions();
+            // if there are no arguments
+            if (args.length <= 2) {
+                debug('printing help');
+                program.help();
+                // exits
             }
-            cache_1.default[command]();
-        });
-        program
-            .command('info')
-            .usage('[command]')
-            .description('Prints Cypress and system information')
-            .option('--dev', text('dev'), coerceFalse)
-            .action((opts) => {
-            info_1.default
-                .start(opts)
-                .then(util_1.default.exit)
-                .catch(util_1.default.logErrorExit1);
+            const firstCommand = args[2];
+            if (!lodash_1.default.includes(knownCommands, firstCommand)) {
+                debug('unknown command %s', firstCommand);
+                logger_1.default.error('Unknown command', `"${firstCommand}"`);
+                program.outputHelp();
+                return process.exit(1);
+            }
+            if (includesVersion(args)) {
+                // commander 2.11.0 changes behavior
+                // and now does not understand top level options
+                // .option('-v, --version').command('version')
+                // so we have to manually catch '-v, --version'
+                handleVersion(program);
+            }
+            debug('program parsing arguments');
+            return program.parse(args);
         });
-        debug('cli starts with arguments %j', args);
-        util_1.default.printNodeOptions();
-        // if there are no arguments
-        if (args.length <= 2) {
-            debug('printing help');
-            program.help();
-            // exits
-        }
-        const firstCommand = args[2];
-        if (!lodash_1.default.includes(knownCommands, firstCommand)) {
-            debug('unknown command %s', firstCommand);
-            logger_1.default.error('Unknown command', `"${firstCommand}"`);
-            program.outputHelp();
-            return util_1.default.exit(1);
-        }
-        if (includesVersion(args)) {
-            // commander 2.11.0 changes behavior
-            // and now does not understand top level options
-            // .option('-v, --version').command('version')
-            // so we have to manually catch '-v, --version'
-            handleVersion(program);
-        }
-        debug('program parsing arguments');
-        return program.parse(args);
     },
 };
 exports.default = cliModule;
-// @ts-ignore
-if (!module.parent) {
-    logger_1.default.error('This CLI module should be required from another Node module');
-    logger_1.default.error('and not executed directly');
-    process.exit(-1);
-}

package/{lib → dist}/cypress.js

@@ -1,16 +1,23 @@
 "use strict";
-// https://github.com/cypress-io/cypress/issues/316
+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 };
 };
-const bluebird_1 = __importDefault(require("bluebird"));
+// https://github.com/cypress-io/cypress/issues/316
 const tmp_1 = __importDefault(require("tmp"));
-const fs_1 = __importDefault(require("./fs"));
+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 tmp = bluebird_1.default.promisifyAll(tmp_1.default);
 const cypressModuleApi = {
     /**
      * Opens Cypress GUI
@@ -24,29 +31,25 @@ const cypressModuleApi = {
      * Runs Cypress tests in the current project
      * @see https://on.cypress.io/module-api#cypress-run
      */
-    run(options = {}) {
-        if (!run_1.default.isValidProject(options.project)) {
-            return bluebird_1.default.reject(new Error(`Invalid project path parameter: ${options.project}`));
-        }
-        options = util_1.default.normalizeModuleOptions(options);
-        tmp.setGracefulCleanup();
-        return tmp.fileAsync()
-            .then((outputPath) => {
+    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;
-            return run_1.default.start(options)
-                .then((failedTests) => {
-                return fs_1.default.readJsonAsync(outputPath, { throws: false })
-                    .then((output) => {
-                    if (!output) {
-                        return {
-                            status: 'failed',
-                            failures: failedTests,
-                            message: 'Could not find Cypress test run results',
-                        };
-                    }
-                    return output;
-                });
-            });
+            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: {