terra-toolkit/scripts/wdio/wdio-runner-cli.js

Utilities to help when developing terra modules.

#!/usr/bin/env node

const commander = require('commander');
const getWdioConfigPath = require('./getWdioConfigPath');
const cleanScreenshots = require('./clean-screenshots');
const runner = require('./wdio-runner');
const parseCLIList = require('../utils/parse-cli-list');

const packageJson = require('../../package.json');

// Parse process arguments
commander
  .version(packageJson.version)
  .option('--config [path]', 'The wdio config path for the tests. Defaults to wdio.conf.js', undefined)
  .option('--locales [list]', 'The list of locales to test. Defaults to [en]', parseCLIList, undefined)
  .option('--formFactors [list]', 'The list of viewport sizes to test.', parseCLIList, undefined)
  .option('--browsers [list]', 'The list of browsers to test. Defaults to [chrome].', parseCLIList, undefined)
  .option('--themes [list]', 'List of themes to override defined default theme.', parseCLIList, undefined)
  .option('--gridUrl [url]', 'The selenium grid url to run tests against', undefined)
  .option('--continueOnFail', 'Pass to continue executing test runs when a run fails', false)
  .option('--updateReference', 'Pass to remove all reference screenshots during screenshot cleanup', false)
  .option('--host [number]', '[wdio option] The selenium server port', undefined)
  .option('--port [string]', '[wdio option] The selenium server host address', undefined)
  .option('--baseUrl [path]', '[wdio option] The base URL', undefined)
  .option('--suite [path]', '[wdio option] The suite to run', undefined)
  .option('--spec [path]', '[wdio option] The spec file to run', undefined)
  .parse(process.argv);

const {
  continueOnFail,
  config,
  gridUrl,
  browsers,
  themes,
  formFactors,
  locales,
  host,
  port,
  baseUrl,
  suite,
  spec,
  updateReference,
} = commander;

const configPath = getWdioConfigPath(config);

cleanScreenshots({
  updateReference,
});

runner({
  // terra-toolkit wdio runner options
  configPath,
  continueOnFail,
  formFactors,
  locales,
  gridUrl,
  browsers,
  themes,
  // honored wdio cli options
  ...host && { host },
  ...port && { port },
  ...baseUrl && { baseUrl },
  ...spec && { spec },
  ...suite && { suite },
});