testarmada-magellan/src/settings.js

Massively parallel automated testing

"use strict";

/*eslint-disable no-magic-numbers, no-bitwise, no-console */

const guid = require("./util/guid");
const yargs = require("yargs");
const margs = require("marge");
const fs = require("fs");
const path = require("path");
const logger = require("./logger");

const configFilePath = yargs.argv.config;
const DEFAULT_CONFIG = "./magellan.json";

if (configFilePath) {
  logger.log("Loading configuration from: " + configFilePath);
} else {
  logger.log("Loading configuration from default location: " + DEFAULT_CONFIG);
}

// NOTE: marge can throw an error here if --config points at a file that doesn't exist
// FIXME: handle this error nicely instead of printing an ugly stack trace
margs.init(DEFAULT_CONFIG, configFilePath);

const argv = margs.argv;
// Allow an external build id (eg: from CI system, for example) to be used. If we're not given one,
// we generate a random build id instead. NOTE: This build id must work as a part of a filename.
// NOTE: The result of this line is that buildId is truthy so toString() should work
const buildId = (argv.external_build_id || "magellan-" + guid()).toString();

// Create a temporary directory for child build assets like configuration, screenshots, etc.
const mkdirSync = require("./util/mkdir_sync");
const TEMP_DIR = path.resolve(argv.temp_dir || "./temp");

try {
  // Check if TEMP_DIR already exists.
  // NOTE: This doesn't work in node 0.10. Those envs will suffer as a result
  /* istanbul ignore else */
  if (fs.accessSync) {
    fs.accessSync(TEMP_DIR, fs.R_OK | fs.W_OK);
  } else {
    throw new Error("old node version");
  }
} catch (e) {
  // Create it if it doesn't..
  /* istanbul ignore next */
  mkdirSync(TEMP_DIR);
}

try {
  // Check if creation worked or if we have access to the directory we were told to use.
  // NOTE: This doesn't work in node 0.10. Those envs will suffer as a result
  // if we don't have accessSync, then we proceed without being sure about TEMP_DIR.
  // A crash will occur LATER in old node versions
  if (fs.accessSync) {
    fs.accessSync(TEMP_DIR, fs.R_OK | fs.W_OK);
  }
  logger.log("Creating temporary files at: " + TEMP_DIR);
} catch (e) {
  /* istanbul ignore next */
  throw new Error("Cannot write to or create the temporary directory: " + TEMP_DIR);
}

let testTimeout = 8 * 60 * 1000;
if (argv.test_timeout) {
  testTimeout = argv.test_timeout;
} else if (argv.bail_time) {
  // --------------------
  // ALERT!!!!! Will be deprecated in next release
  //
  // backward compatible
  testTimeout = argv.bail_time;
}

module.exports = {

  // Port allocation scheme:
  // - All port allocation starts at BASE_PORT_START
  // - Magellan gets a block of ports offset from the start BASE_PORT_RANGE wide
  // - Each worker instance gets BASE_PORT_SPACING ports to use
  //
  //           [...........[0,1,2][0,1,2]...............]
  //            ^ start                ^ spacing (eg: 3)
  //            ---------------- range -----------------
  //
  BASE_PORT_START: parseInt(argv.base_port_start) || 12000,
  BASE_PORT_RANGE: parseInt(argv.base_port_range) || 2000,
  BASE_PORT_SPACING: parseInt(argv.base_port_spacing) || 3,
  MAX_WORKERS: argv.serial ? 1 : parseInt(argv.max_workers) || 3,
  MAX_TEST_ATTEMPTS: parseInt(argv.max_test_attempts) || 3,

  MAX_ALLOCATION_ATTEMPTS: 120,
  WORKER_START_DELAY: 1000,

  environment: process.env,
  debug: Boolean(argv.debug) || Boolean(argv.debugVerbose),
  debugVerbose: Boolean(argv.debugVerbose),
  serial: Boolean(argv.serial),

  gatherTrends: argv.gather_trends,

  // for successful tests, running in non-serial mode, output the logging for each step
  enablePassedTestsLogging: Boolean(argv.enablePassedTestsLogging),

  aggregateScreenshots: argv.aggregate_screenshots,
  tempDir: TEMP_DIR,

  testTimeout,

  buildId,

  framework: argv.framework || "nightwatch",

  customSauceBrowsers: argv.customSauceBrowsers || []
};