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

Utilities to help when developing terra modules.

const { Launcher } = require('webdriverio');
const Logger = require('../utils/logger');

const context = '[Terra-Tookit:wdio-runner]';

async function wdioRunner(options) {
  const {
    configPath, locales, formFactors, gridUrl, browsers, themes, continueOnFail, ...testSetup
  } = options;

  const testlocales = locales || ['en'];
  const testThemes = themes || [null];
  const factors = formFactors || [null];

  if (gridUrl) {
    process.env.SELENIUM_GRID_URL = gridUrl;
  }

  if (browsers) {
    process.env.BROWSERS = browsers;
  }

  function onReturnSuccess(doExit, envValues) {
    if (!doExit) {
      Logger.log(`Finished tests for: ${envValues}\n\n---------------------------------------\n`, { context });
    } else {
      process.exit(0);
    }
  }

  for (let themeI = 0; themeI < testThemes.length; themeI += 1) {
    const theme = testThemes[themeI];
    if (theme) {
      process.env.THEME = theme;
    }

    for (let localeI = 0; localeI < testlocales.length; localeI += 1) {
      const locale = testlocales[localeI];
      process.env.LOCALE = locale;

      for (let factor = 0; factor < factors.length; factor += 1) {
        let envValues = `LOCALE=${locale} `;
        if (theme) {
          envValues += `THEME=${theme} `;
        }

        let exitProcess = false;
        process.on('SIGINT', () => {
          exitProcess = true;
        });

        const form = factors[factor];
        if (form) {
          process.env.FORM_FACTOR = form;
          envValues += `FORM_FACTOR=${form}`;
        }
        envValues = Logger.emphasis(envValues);
        Logger.log(`Running tests for: ${envValues}`, { context });

        // eslint-disable-next-line no-await-in-loop
        await new Launcher(configPath, testSetup)
          .run()
          .then(
            (code) => {
              // If we receive a test failure, exit with a status of 1.  exitProcess is a special case
              // where the user hit Ctrl-C and will be handled in the else block.
              if (code === 1 && !continueOnFail && !exitProcess) {
                Logger.error(`Running tests for: ${envValues} failed.`, { context });
                process.exit(1);
              } else {
                onReturnSuccess(exitProcess, envValues);
              }
            },
            (error) => {
              Logger.error(`Launcher failed to start the test ${error.stacktrace}`, { context });
              process.exit(1);
            },
          );
      }
    }
  }
}

module.exports = wdioRunner;