detox/local-cli/testCommand/builder.js

E2E tests and automation for mobile

module.exports = {
  C: {
    alias: 'config-path',
    group: 'Configuration:',
    describe: 'Specify Detox config file path. If not supplied, detox searches for .detoxrc[.js] or "detox" section in package.json',
  },
  c: {
    alias: ['configuration'],
    group: 'Configuration:',
    describe:
      'Select a device configuration from your defined configurations, if not supplied, and there\'s only one configuration, detox will default to it',
  },
  l: {
    alias: 'loglevel',
    group: 'Debugging:',
    choices: ['fatal', 'error', 'warn', 'info', 'verbose', 'debug', 'trace'],
    describe: 'Log level',
  },
  R: {
    alias: 'retries',
    group: 'Execution:',
    describe: 'Re-spawn the test runner for individual failing suite files until they pass, or <N> times at least.',
    number: true,
  },
  r: {
    alias: 'reuse',
    group: 'Execution:',
    describe: 'Reuse existing installed app (do not delete + reinstall) for a faster run.',
    boolean: true,
  },
  start: {
    group: 'Execution:',
    describe: 'Run app "start" scripts before running the tests. Use --no-start to disable that, and --start=force to ignore errors.',
    default: true,
  },
  u: {
    alias: 'cleanup',
    group: 'Execution:',
    describe: 'Shutdown simulator when test is over, useful for CI scripts, to make sure detox exits cleanly with no residue',
    boolean: true,
  },
  d: {
    alias: 'debug-synchronization',
    group: 'Debugging:',
    coerce(value) {
      if (value === false || value === 'false') {
        return 0;
      }

      if (value === true || value === 'true') {
        return 3000;
      }

      return Number.isNaN(+value) ? value : +value;
    },
    describe:
      'Customize how long an action/expectation can take to complete before Detox starts querying the app why it is busy. ' +
      'By default, the app status will be printed if the action takes more than 10s to complete.'
  },
  a: {
    alias: 'artifacts-location',
    group: 'Debugging:',
    describe: 'Artifacts (logs, screenshots, etc) root directory.',
  },
  'record-logs': {
    group: 'Debugging:',
    choices: ['failing', 'all', 'none'],
    describe: 'Save logs during each test to artifacts directory. Pass "failing" to save logs of failing tests only.',
  },
  'take-screenshots': {
    group: 'Debugging:',
    choices: ['manual', 'failing', 'all', 'none'],
    describe: 'Save screenshots before and after each test to artifacts directory. Pass "failing" to save screenshots of failing tests only.',
  },
  'record-videos': {
    group: 'Debugging:',
    choices: ['failing', 'all', 'none'],
    describe: 'Save screen recordings of each test to artifacts directory. Pass "failing" to save recordings of failing tests only.',
  },
  'record-performance': {
    group: 'Debugging:',
    choices: ['all', 'none'],
    describe: '[iOS Only] Save Detox Instruments performance recordings of each test to artifacts directory.',
  },
  'capture-view-hierarchy': {
    group: 'Debugging:',
    choices: ['enabled', 'disabled'],
    describe: '[iOS Only] Capture *.uihierarchy snapshots on view action errors and device.captureViewHierarchy() calls.',
  },
  'jest-report-specs': {
    group: 'Execution:',
    describe: 'Whether to output logs per each running spec, in real-time. By default, disabled with multiple workers.',
    boolean: true,
  },
  H: {
    alias: 'headless',
    group: 'Execution:',
    describe: 'Launch device in headless mode. Useful when running on CI.',
    boolean: true,
  },
  gpu: {
    group: 'Execution:',
    choices: ['auto', 'host', 'swiftshader_indirect', 'angle_indirect', 'guest', 'off'],
    describe: '[Android Only] Launch emulator with the specific -gpu [gpu mode] parameter.',
  },
  keepLockFile: {
    group: 'Configuration:',
    describe:'Keep the device lock file when running Detox tests',
    boolean: true,
  },
  n: {
    alias: 'device-name',
    group: 'Configuration:',
    describe: 'Override the device name specified in a configuration. Useful for running a single build configuration on multiple devices.',
  },
  'device-boot-args': {
    group: 'Execution:',
    describe: 'Custom arguments to pass (through) onto the device (emulator/simulator) binary when booted.',
  },
  'app-launch-args': {
    group: 'Execution:',
    describe: 'Custom arguments to pass (through) onto the app every time it is launched.',
  },
  'use-custom-logger': {
    boolean: true,
    group: 'Execution:',
    describe: `Use Detox' custom console-logging implementation, for logging Detox (non-device) logs. Disabling will fallback to node.js / test runner's implementation (e.g. Jest).`,
  },
  'force-adb-install': {
    boolean: true,
    group: 'Execution:',
    describe: `[Android Only] Due to problems with the "adb install" command on Android, Detox resorts to a different scheme for install APK's. Setting true will disable that and force usage of "adb install", instead.`,
  },
  'inspect-brk': {
    group: 'Debugging:',
    describe: '[Jest Only] Allows debugging of the underlying test runner',
    boolean: true,
  }
};