How to use isComponentTesting method in Cypress

1"use strict";2// @ts-check3const _ = require('lodash');4const R = require('ramda');5const commander = require('commander');6const {7  stripIndent8} = require('common-tags');9const logSymbols = require('log-symbols');10const debug = require('debug')('cypress:cli:cli');11const util = require('./util');12const logger = require('./logger');13const errors = require('./errors');14const cache = require('./tasks/cache'); // patch "commander" method called when a user passed an unknown option15// we want to print help for the current command and exit with an error16function unknownOption(flag, type = 'option') {17  if (this._allowUnknownOption) return;18  logger.error();19  logger.error(`  error: unknown ${type}:`, flag);20  logger.error();21  this.outputHelp();22  util.exit(1);23}24commander.Command.prototype.unknownOption = unknownOption;25const coerceFalseOrString = arg => {26  return arg !== 'false' ? arg : false;27};28const coerceFalse = arg => {29  return arg !== 'false';30};31const coerceAnyStringToInt = arg => {32  return typeof arg === 'string' ? parseInt(arg) : arg;33};34const spaceDelimitedArgsMsg = (flag, args) => {35  let msg = `36    ${logSymbols.warning} Warning: It looks like you're passing --${flag} a space-separated list of arguments:37    "${args.join(' ')}"38    This will work, but it's not recommended.39    If you are trying to pass multiple arguments, separate them with commas instead:40      cypress run --${flag} arg1,arg2,arg341  `;42  if (flag === 'spec') {43    msg += `44    The most common cause of this warning is using an unescaped glob pattern. If you are45    trying to pass a glob pattern, escape it using quotes:46      cypress run --spec "**/*.spec.js"47    `;48  }49  logger.log();50  logger.warn(stripIndent(msg));51  logger.log();52};53const parseVariableOpts = (fnArgs, args) => {54  const [opts, unknownArgs] = fnArgs;55  if (unknownArgs && unknownArgs.length && (opts.spec || opts.tag)) {56    // this will capture space-delimited args after57    // flags that could have possible multiple args58    // but before the next option59    // --spec spec1 spec2 or --tag foo bar60    const multiArgFlags = _.compact([opts.spec ? 'spec' : opts.spec, opts.tag ? 'tag' : opts.tag]);61    _.forEach(multiArgFlags, flag => {62      const argIndex = _.indexOf(args, `--${flag}`) + 2;63      const nextOptOffset = _.findIndex(_.slice(args, argIndex), arg => {64        return _.startsWith(arg, '--');65      });66      const endIndex = nextOptOffset !== -1 ? argIndex + nextOptOffset : args.length;67      const maybeArgs = _.slice(args, argIndex, endIndex);68      const extraArgs = _.intersection(maybeArgs, unknownArgs);69      if (extraArgs.length) {70        opts[flag] = [opts[flag]].concat(extraArgs);71        spaceDelimitedArgsMsg(flag, opts[flag]);72        opts[flag] = opts[flag].join(',');73      }74    });75  }76  debug('variable-length opts parsed %o', {77    args,78    opts79  });80  return util.parseOpts(opts);81};82const descriptions = {83  browserOpenMode: 'path to a custom browser to be added to the list of available browsers in Cypress',84  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.',85  cacheClear: 'delete all cached binaries',86  cachePrune: 'deletes all cached binaries except for the version currently in use',87  cacheList: 'list cached binary versions',88  cachePath: 'print the path to the binary cache',89  cacheSize: 'Used with the list command to show the sizes of the cached folders',90  ciBuildId: 'the unique identifier for a run on your CI provider. typically a "BUILD_ID" env var. this value is automatically detected for most CI providers',91  config: 'sets configuration values. separate multiple values with a comma. overrides any value in cypress.json.',92  configFile: 'path to JSON file where configuration values are set. defaults to "cypress.json". pass "false" to disable.',93  detached: 'runs Cypress application in detached mode',94  dev: 'runs cypress in development and bypasses binary check',95  env: 'sets environment variables. separate multiple values with a comma. overrides any value in cypress.json or cypress.env.json',96  exit: 'keep the browser open after tests finish',97  forceInstall: 'force install the Cypress binary',98  global: 'force Cypress into global mode as if its globally installed',99  group: 'a named group for recorded runs in the Cypress Dashboard',100  headed: 'displays the browser instead of running headlessly (defaults to true for Firefox and Chromium-family browsers)',101  headless: 'hide the browser instead of running headed (defaults to true for Electron)',102  key: 'your secret Record Key. you can omit this if you set a CYPRESS_RECORD_KEY environment variable.',103  parallel: 'enables concurrent runs and automatic load balancing of specs across multiple machines or processes',104  port: 'runs Cypress on a specific port. overrides any value in cypress.json.',105  project: 'path to the project',106  quiet: 'run quietly, using only the configured reporter',107  record: 'records the run. sends test results, screenshots and videos to your Cypress Dashboard.',108  reporter: 'runs a specific mocha reporter. pass a path to use a custom reporter. defaults to "spec"',109  reporterOptions: 'options for the mocha reporter. defaults to "null"',110  spec: 'runs specific spec file(s). defaults to "all"',111  tag: 'named tag(s) for recorded runs in the Cypress Dashboard',112  version: 'prints Cypress version'113};114const knownCommands = ['cache', 'help', '-h', '--help', 'install', 'open', 'open-ct', 'run', 'run-ct', 'verify', '-v', '--version', 'version', 'info'];115const text = description => {116  if (!descriptions[description]) {117    throw new Error(`Could not find description for: ${description}`);118  }119  return descriptions[description];120};121function includesVersion(args) {122  return _.includes(args, 'version') || _.includes(args, '--version') || _.includes(args, '-v');123}124function showVersions(args) {125  debug('printing Cypress version');126  debug('additional arguments %o', args);127  const versionParser = commander.option('--component <package|binary|electron|node>', 'component to report version for').allowUnknownOption(true);128  const parsed = versionParser.parse(args);129  const parsedOptions = {130    component: parsed.component131  };132  debug('parsed version arguments %o', parsedOptions);133  const reportAllVersions = versions => {134    logger.always('Cypress package version:', versions.package);135    logger.always('Cypress binary version:', versions.binary);136    logger.always('Electron version:', versions.electronVersion);137    logger.always('Bundled Node version:', versions.electronNodeVersion);138  };139  const reportComponentVersion = (componentName, versions) => {140    const names = {141      package: 'package',142      binary: 'binary',143      electron: 'electronVersion',144      node: 'electronNodeVersion'145    };146    if (!names[componentName]) {147      throw new Error(`Unknown component name "${componentName}"`);148    }149    const name = names[componentName];150    if (!versions[name]) {151      throw new Error(`Cannot find version for component "${componentName}" under property "${name}"`);152    }153    const version = versions[name];154    logger.always(version);155  };156  const defaultVersions = {157    package: undefined,158    binary: undefined,159    electronVersion: undefined,160    electronNodeVersion: undefined161  };162  return require('./exec/versions').getVersions().then((versions = defaultVersions) => {163    if (parsedOptions.component) {164      reportComponentVersion(parsedOptions.component, versions);165    } else {166      reportAllVersions(versions);167    }168    process.exit(0);169  }).catch(util.logErrorExit1);170}171const createProgram = () => {172  const program = new commander.Command(); // bug in commander not printing name173  // in usage help docs174  program._name = 'cypress';175  program.usage('<command> [options]');176  return program;177};178const addCypressRunCommand = program => {179  return program.command('run').usage('[options]').description('Runs Cypress tests from the CLI without the GUI').option('-b, --browser <browser-name-or-path>', text('browserRunMode')).option('--ci-build-id <id>', text('ciBuildId')).option('-c, --config <config>', text('config')).option('-C, --config-file <config-file>', text('configFile')).option('-e, --env <env>', text('env')).option('--group <name>', text('group')).option('-k, --key <record-key>', text('key')).option('--headed', text('headed')).option('--headless', text('headless')).option('--no-exit', text('exit')).option('--parallel', text('parallel')).option('-p, --port <port>', text('port')).option('-P, --project <project-path>', text('project')).option('-q, --quiet', text('quiet')).option('--record [bool]', text('record'), coerceFalse).option('-r, --reporter <reporter>', text('reporter')).option('-o, --reporter-options <reporter-options>', text('reporterOptions')).option('-s, --spec <spec>', text('spec')).option('-t, --tag <tag>', text('tag')).option('--dev', text('dev'), coerceFalse);180};181/**182 * Casts known command line options for "cypress run" to their intended type.183 * For example if the user passes "--port 5005" the ".port" property should be184 * a number 5005 and not a string "5005".185 *186 * Returns a clone of the original object.187 */188const castCypressRunOptions = opts => {189  // only properties that have type "string | false" in our TS definition190  // require special handling, because CLI parsing takes care of purely191  // boolean arguments192  const result = R.evolve({193    port: coerceAnyStringToInt,194    configFile: coerceFalseOrString195  })(opts);196  return result;197};198module.exports = {199  /**200   * Parses `cypress run` command line option array into an object201   * with options that you can feed into a `cypress.run()` module API call.202   * @example203   *  const options = parseRunCommand(['cypress', 'run', '--browser', 'chrome'])204   *  // options is {browser: 'chrome'}205   */206  parseRunCommand(args) {207    return new Promise((resolve, reject) => {208      if (!Array.isArray(args)) {209        return reject(new Error('Expected array of arguments'));210      } // make a copy of the input arguments array211      // and add placeholders where "node ..." would usually be212      // also remove "cypress" keyword at the start if present213      const cliArgs = args[0] === 'cypress' ? [...args.slice(1)] : [...args];214      cliArgs.unshift(null, null);215      debug('creating program parser');216      const program = createProgram();217      addCypressRunCommand(program).action((...fnArgs) => {218        debug('parsed Cypress run %o', fnArgs);219        const options = parseVariableOpts(fnArgs, cliArgs);220        debug('parsed options %o', options);221        const casted = castCypressRunOptions(options);222        debug('casted options %o', casted);223        resolve(casted);224      });225      debug('parsing args: %o', cliArgs);226      program.parse(cliArgs);227    });228  },229  /**230   * Parses the command line and kicks off Cypress process.231   */232  init(args) {233    if (!args) {234      args = process.argv;235    }236    const {237      CYPRESS_INTERNAL_ENV238    } = process.env;239    if (!util.isValidCypressInternalEnvValue(CYPRESS_INTERNAL_ENV)) {240      debug('invalid CYPRESS_INTERNAL_ENV value', CYPRESS_INTERNAL_ENV);241      return errors.exitWithError(errors.errors.invalidCypressEnv)(`CYPRESS_INTERNAL_ENV=${CYPRESS_INTERNAL_ENV}`);242    }243    if (util.isNonProductionCypressInternalEnvValue(CYPRESS_INTERNAL_ENV)) {244      debug('non-production CYPRESS_INTERNAL_ENV value', CYPRESS_INTERNAL_ENV);245      let msg = `246        ${logSymbols.warning} Warning: It looks like you're passing CYPRESS_INTERNAL_ENV=${CYPRESS_INTERNAL_ENV}247        The environment variable "CYPRESS_INTERNAL_ENV" is reserved and should only be used internally.248        Unset the "CYPRESS_INTERNAL_ENV" environment variable and run Cypress again.249      `;250      logger.log();251      logger.warn(stripIndent(msg));252      logger.log();253    }254    const program = createProgram();255    program.command('help').description('Shows CLI help and exits').action(() => {256      program.help();257    });258    program.option('-v, --version', text('version')).command('version').description(text('version')).action(() => {259      showVersions(args);260    });261    addCypressRunCommand(program).action((...fnArgs) => {262      debug('running Cypress with args %o', fnArgs);263      require('./exec/run').start(parseVariableOpts(fnArgs, args)).then(util.exit).catch(util.logErrorExit1);264    });265    program // TODO make this command public once CT will be merged completely266    .command('open-ct', {267      hidden: true268    }).usage('[options]').description('Opens Cypress component testing interactive mode.').option('-b, --browser <browser-path>', text('browserOpenMode')).option('-c, --config <config>', text('config')).option('-C, --config-file <config-file>', text('configFile')).option('-d, --detached [bool]', text('detached'), coerceFalse).option('-e, --env <env>', text('env')).option('--global', text('global')).option('-p, --port <port>', text('port')).option('-P, --project <project-path>', text('project')).option('--dev', text('dev'), coerceFalse).action(opts => {269      debug('opening Cypress');270      require('./exec/open').start(util.parseOpts(opts), {271        isComponentTesting: true272      }).catch(util.logErrorExit1);273    });274    program // TODO make this command public once CT will be merged completely275    .command('run-ct', {276      hidden: true277    }).usage('[options]').description('Runs all Cypress Component Testing suites').option('-b, --browser <browser-name-or-path>', text('browserRunMode')).option('--ci-build-id <id>', text('ciBuildId')).option('-c, --config <config>', text('config')).option('-C, --config-file <config-file>', text('configFile')).option('-e, --env <env>', text('env')).option('--group <name>', text('group')).option('-k, --key <record-key>', text('key')).option('--headed', text('headed')).option('--headless', text('headless')).option('--no-exit', text('exit')).option('--parallel', text('parallel')).option('-p, --port <port>', text('port')).option('-P, --project <project-path>', text('project')).option('-q, --quiet', text('quiet')).option('--record [bool]', text('record'), coerceFalse).option('-r, --reporter <reporter>', text('reporter')).option('-o, --reporter-options <reporter-options>', text('reporterOptions')).option('-s, --spec <spec>', text('spec')).option('-t, --tag <tag>', text('tag')).option('--dev', text('dev'), coerceFalse).action(opts => {278      debug('running Cypress run-ct');279      require('./exec/run').start(util.parseOpts(opts), {280        isComponentTesting: true281      }).then(util.exit).catch(util.logErrorExit1);282    });283    program.command('open').usage('[options]').description('Opens Cypress in the interactive GUI.').option('-b, --browser <browser-path>', text('browserOpenMode')).option('-c, --config <config>', text('config')).option('-C, --config-file <config-file>', text('configFile')).option('-d, --detached [bool]', text('detached'), coerceFalse).option('-e, --env <env>', text('env')).option('--global', text('global')).option('-p, --port <port>', text('port')).option('-P, --project <project-path>', text('project')).option('--dev', text('dev'), coerceFalse).action(opts => {284      debug('opening Cypress');285      require('./exec/open').start(util.parseOpts(opts)).catch(util.logErrorExit1);286    });287    program.command('install').usage('[options]').description('Installs the Cypress executable matching this package\'s version').option('-f, --force', text('forceInstall')).action(opts => {288      require('./tasks/install').start(util.parseOpts(opts)).catch(util.logErrorExit1);289    });290    program.command('verify').usage('[options]').description('Verifies that Cypress is installed correctly and executable').option('--dev', text('dev'), coerceFalse).action(opts => {291      const defaultOpts = {292        force: true,293        welcomeMessage: false294      };295      const parsedOpts = util.parseOpts(opts);296      const options = _.extend(parsedOpts, defaultOpts);297      require('./tasks/verify').start(options).catch(util.logErrorExit1);298    });299    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) {300      if (!args || !args.length) {301        this.outputHelp();302        util.exit(1);303      }304      const [command] = args;305      if (!_.includes(['list', 'path', 'clear', 'prune'], command)) {306        unknownOption.call(this, `cache ${command}`, 'command');307      }308      if (command === 'list') {309        debug('cache command %o', {310          command,311          size: opts.size312        });313        return cache.list(opts.size).catch({314          code: 'ENOENT'315        }, () => {316          logger.always('No cached binary versions were found.');317          process.exit(0);318        }).catch(e => {319          debug('cache list command failed with "%s"', e.message);320          util.logErrorExit1(e);321        });322      }323      cache[command]();324    });325    program.command('info').usage('[command]').description('Prints Cypress and system information').option('--dev', text('dev'), coerceFalse).action(opts => {326      require('./exec/info').start(opts).then(util.exit).catch(util.logErrorExit1);327    });328    debug('cli starts with arguments %j', args);329    util.printNodeOptions(); // if there are no arguments330    if (args.length <= 2) {331      debug('printing help');332      program.help(); // exits333    }334    const firstCommand = args[2];335    if (!_.includes(knownCommands, firstCommand)) {336      debug('unknown command %s', firstCommand);337      logger.error('Unknown command', `"${firstCommand}"`);338      program.outputHelp();339      return util.exit(1);340    }341    if (includesVersion(args)) {342      // commander 2.11.0 changes behavior343      // and now does not understand top level options344      // .option('-v, --version').command('version')345      // so we have to manually catch '-v, --version'346      return showVersions(args);347    }348    debug('program parsing arguments');349    return program.parse(args);350  }351}; // @ts-ignore352if (!module.parent) {353  logger.error('This CLI module should be required from another Node module');354  logger.error('and not executed directly');355  process.exit(-1);...

...86        const ret = fn(memo);87        return ret ? ret : memo;88    }, lodash_1.default.cloneDeep(obj));89}90function isComponentTesting(options = {}) {91    return options.testingType === 'component';92}93exports.isComponentTesting = isComponentTesting;94function configFile(options = {}) {95    // default is only used in tests.96    // This prevents a the change from becoming bigger than it should97    // FIXME: remove the default98    return options.configFile === false ? false : (options.configFile || 'cypress.json');99}100exports.configFile = configFile;101function id(projectRoot, options = {}) {102    const file = pathToConfigFile(projectRoot, options);103    return fs_1.fs.readJson(file)104        .then((config) => config.projectId)105        .catch(() => {106        return null;107    });108}109exports.id = id;110function read(projectRoot, options = {}) {111    if (options.configFile === false) {112        return bluebird_1.default.resolve({});113    }114    const file = pathToConfigFile(projectRoot, options);115    const readPromise = /\.json$/.test(file) ? fs_1.fs.readJSON(path_1.default.resolve(projectRoot, file)) : (0, require_async_1.requireAsync)(file, {116        projectRoot,117        loadErrorCode: 'CONFIG_FILE_ERROR',118    });119    return readPromise120        .catch((err) => {121        var _a;122        if (err.type === 'MODULE_NOT_FOUND' || err.code === 'ENOENT') {123            if ((_a = options.args) === null || _a === void 0 ? void 0 : _a.runProject) {124                return bluebird_1.default.reject(errors_1.default.get('CONFIG_FILE_NOT_FOUND', options.configFile, projectRoot));125            }126            return _write(file, {});127        }128        return bluebird_1.default.reject(err);129    })130        .then((configObject = {}) => {131        if (isComponentTesting(options) && 'component' in configObject) {132            configObject = Object.assign(Object.assign({}, configObject), configObject.component);133        }134        if (!isComponentTesting(options) && 'e2e' in configObject) {135            configObject = Object.assign(Object.assign({}, configObject), configObject.e2e);136        }137        debug('resolved configObject', configObject);138        const changed = _applyRewriteRules(configObject);139        // if our object is unchanged140        // then just return it141        if (lodash_1.default.isEqual(configObject, changed)) {142            return configObject;143        }144        // else write the new reduced obj145        return _write(file, changed)146            .then((config) => {147            return config;148        });...

1"use strict";2const _ = require('lodash');3const debug = require('debug')('cypress:cli:run');4const util = require('../util');5const spawn = require('./spawn');6const verify = require('../tasks/verify');7const {8  exitWithError,9  errors10} = require('../errors');11/**12 * Throws an error with "details" property from13 * "errors" object.14 * @param {Object} details - Error details15 */16const throwInvalidOptionError = details => {17  if (!details) {18    details = errors.unknownError;19  } // throw this error synchronously, it will be caught later on and20  // the details will be propagated to the promise chain21  const err = new Error();22  err.details = details;23  throw err;24};25/**26 * Typically a user passes a string path to the project.27 * But "cypress open" allows using `false` to open in global mode,28 * and the user can accidentally execute `cypress run --project false`29 * which should be invalid.30 */31const isValidProject = v => {32  if (typeof v === 'boolean') {33    return false;34  }35  if (v === '' || v === 'false' || v === 'true') {36    return false;37  }38  return true;39};40/**41 * Maps options collected by the CLI42 * and forms list of CLI arguments to the server.43 *44 * Note: there is lightweight validation, with errors45 * thrown synchronously.46 *47 * @returns {string[]} list of CLI arguments48 */49const processRunOptions = (options = {}) => {50  debug('processing run options %o', options);51  if (!isValidProject(options.project)) {52    debug('invalid project option %o', {53      project: options.project54    });55    return throwInvalidOptionError(errors.invalidRunProjectPath);56  }57  const args = ['--run-project', options.project];58  if (options.browser) {59    args.push('--browser', options.browser);60  }61  if (options.ciBuildId) {62    args.push('--ci-build-id', options.ciBuildId);63  }64  if (options.config) {65    args.push('--config', options.config);66  }67  if (options.configFile !== undefined) {68    args.push('--config-file', options.configFile);69  }70  if (options.env) {71    args.push('--env', options.env);72  }73  if (options.exit === false) {74    args.push('--no-exit');75  }76  if (options.group) {77    args.push('--group', options.group);78  }79  if (options.headed) {80    args.push('--headed', options.headed);81  }82  if (options.headless) {83    if (options.headed) {84      return throwInvalidOptionError(errors.incompatibleHeadlessFlags);85    }86    args.push('--headed', !options.headless);87  } // if key is set use that - else attempt to find it by environment variable88  if (options.key == null) {89    debug('--key is not set, looking up environment variable CYPRESS_RECORD_KEY');90    options.key = util.getEnv('CYPRESS_RECORD_KEY');91  } // if we have a key assume we're in record mode92  if (options.key) {93    args.push('--key', options.key);94  }95  if (options.outputPath) {96    args.push('--output-path', options.outputPath);97  }98  if (options.parallel) {99    args.push('--parallel');100  }101  if (options.port) {102    args.push('--port', options.port);103  }104  if (options.quiet) {105    args.push('--quiet');106  } // if record is defined and we're not107  // already in ci mode, then send it up108  if (options.record != null) {109    args.push('--record', options.record);110  } // if we have a specific reporter push that into the args111  if (options.reporter) {112    args.push('--reporter', options.reporter);113  } // if we have a specific reporter push that into the args114  if (options.reporterOptions) {115    args.push('--reporter-options', options.reporterOptions);116  } // if we have specific spec(s) push that into the args117  if (options.spec) {118    args.push('--spec', options.spec);119  }120  if (options.tag) {121    args.push('--tag', options.tag);122  }123  return args;124};125module.exports = {126  processRunOptions,127  isValidProject,128  // resolves with the number of failed tests129  start(options = {}, {130    isComponentTesting131  } = {132    isComponentTesting: false133  }) {134    _.defaults(options, {135      key: null,136      spec: null,137      reporter: null,138      reporterOptions: null,139      project: process.cwd()140    });141    function run() {142      let args;143      try {144        args = processRunOptions(options);145      } catch (err) {146        if (err.details) {147          return exitWithError(err.details)();148        }149        throw err;150      }151      if (isComponentTesting) {152        args.push('--componentTesting');153      }154      debug('run to spawn.start args %j', args);155      return spawn.start(args, {156        dev: options.dev157      });158    }159    if (options.dev) {160      return run();161    }162    return verify.start().then(run);163  }...

1const debug = require('debug')('cypress:cli')2const util = require('../util')3const spawn = require('./spawn')4const verify = require('../tasks/verify')5module.exports = {6  start (options = {}, { isComponentTesting } = { isComponentTesting: false }) {7    if (!util.isInstalledGlobally() && !options.global && !options.project) {8      options.project = process.cwd()9    }10    const args = []11    if (options.config) {12      args.push('--config', options.config)13    }14    if (options.configFile !== undefined) {15      args.push('--config-file', options.configFile)16    }17    if (options.browser) {18      args.push('--browser', options.browser)19    }20    if (options.env) {21      args.push('--env', options.env)22    }23    if (options.port) {24      args.push('--port', options.port)25    }26    if (options.project) {27      args.push('--project', options.project)28    }29    if (isComponentTesting) {30      args.push('--componentTesting')31    }32    debug('opening from options %j', options)33    debug('command line arguments %j', args)34    function open () {35      return spawn.start(args, {36        dev: options.dev,37        detached: Boolean(options.detached),38        stdio: 'inherit',39      })40    }41    if (options.dev) {42      return open()43    }44    return verify.start()45    .then(open)46  },...