terra-toolkit/config/wdio/selenium.config.js

Utilities to help when developing terra modules.

const http = require('http');

const chromeConfig = {
  browserName: 'chrome',
  maxInstances: 1,
  loggingPrefs: {
    performance: 'ALL',
  },
  'goog:chromeOptions': {
    /** Run in headless mode since Chrome 69 cannot reach the tiny viewport size due to a omnibox size changexx
     * made by the chrome team. See https://bugs.chromium.org/p/chromedriver/issues/detail?id=2626#c1 &&
     * https://bugs.chromium.org/p/chromium/issues/detail?id=849784.
     */
    args: ['headless', 'disable-gpu'],
    perfLoggingPrefs: {
      traceCategories: 'blink.console, devtools.timeline, toplevel, disabled-by-default-devtools.timeline, disabled-by-default-devtools.timeline.frame',
    },
  },
};

const firefoxConfig = {
  browserName: 'firefox',
  maxInstances: 1,
  'moz:firefoxOptions': {
    prefs: {
      'dom.disable_beforeunload': false,
    },
  },
};

const ieConfig = {
  browserName: 'internet explorer',
  maxInstances: 1,
  /** IE Driver custom capabilities must be passed as a sub-object specified under 'se:ieOptions' key for
   * version ^3.3.0.1. and Webdriver.io does not pass these as a sub-options.
   * See https://github.com/SeleniumHQ/selenium/blob/master/cpp/iedriverserver/CHANGELOG#L782.
   */
  'se:ieOptions': {
    javascriptEnabled: true,
    locationContextEnabled: true,
    handlesAlerts: true,
    rotatable: true,
  },
};

const determineCapabilities = ({ useSeleniumGrid, browsers }) => {
  const capabilities = [];

  if (!browsers) {
    // always test chrome by default
    capabilities.push(chromeConfig);

    // always test chrome, firefox and IE by default when selenium grid url is provided
    if (useSeleniumGrid) {
      capabilities.push(firefoxConfig, ieConfig);
    }
  } else {
    if (browsers.includes('chrome')) {
      capabilities.push(chromeConfig);
    }
    if (browsers.includes('firefox')) {
      capabilities.push(firefoxConfig);
    }
    if (useSeleniumGrid && browsers.includes('ie')) {
      capabilities.push(ieConfig);
    }
  }
  /* Randomized the browser order to reduce a heavy number of session request made to the grid for each browser at once. */
  return capabilities.sort(() => 0.5 - Math.random());
};

const determineConfig = (envs) => {
  const {
    ci, seleniumGridUrl, browsers,
  } = envs;

  const useSeleniumGrid = seleniumGridUrl !== undefined;

  const config = {
    seleniumVersion: '3.14',
    maxInstances: 1,
    seleniumDocker: {
      enabled: !(ci || useSeleniumGrid),
    },
    capabilities: determineCapabilities({ useSeleniumGrid, browsers }),
  };

  if (useSeleniumGrid) {
    config.host = seleniumGridUrl;
    config.port = '80';
    config.path = '/wd/hub';
    config.agent = new http.Agent({ keepAlive: true, timeout: 600000 });
  }

  if (ci) {
    config.host = 'standalone-chrome';
  }

  return config;
};

exports.determineConfig = determineConfig;