testarmada-magellan/src/cli_help.js

Massively parallel automated testing

"use strict";

var project = require("../package.json");
var settings = require("./settings");

/*eslint max-len: 0*/
/*eslint max-statements: 0*/
module.exports = {
  help: function () {
    console.log("Usage: magellan [options]");
    console.log("");
    console.log("By default, magellan will run all available tests in parallel with phantomjs.");
    console.log("");
    console.log(" Parallelism, Workflow and Filtering:");
    console.log("  --serial                       Run tests one at a time with detailed output.");
    console.log("  --max_workers=N                Set maximum number of parallel works to (see defaults below).");
    console.log("  --max_test_attempts=N          Retry tests N times (default: 3).");
    console.log("  --bail_early                   Kill builds that have failed at least 10% of tests, after 10 or more test runs.");
    console.log("  --bail_fast                    Kill builds that fail any test.");
    console.log("  --bail_time                    Set test kill time in milliseconds. *CAN* be used without bail_early/bail_fast.");
    console.log("  --early_bail_threshold         A decimal ratio (eg 0.25 for 25%) how many tests to fail before bail_early");
    console.log("  --early_bail_min_attempts      How many test runs to run before applying bail_early rule.");
    console.log("  --debug                        Enable debugging magellan messages (dev mode).");
    console.log("");
    console.log(" Configuration:");
    console.log("  --config=config-path           Specify Magellan configuration location.");
    console.log("  --temp_dir=path                Specify temporary file directory for Magellan (default: temp/).");
    console.log("");
    console.log(" Reporting and CI Integration:");
    console.log("  --aggregate_screenshots        Activate harvesting of screenshots for uploading to a screenshot service.");
    console.log("  --screenshot_aggregator_url    Specify the URL to the screenshot service endpoint.");
    console.log("  --external_build_id            Use an external build id, i.e. from CI. Must be filename and URL-safe.");
    console.log("");
    console.log(" Browser and SauceLabs Support:");
    console.log("  --sauce                        Run tests on SauceLabs cloud.");
    console.log("  --no_ssl_bump_domains=domains  Disable SSL re-encrypted on sauce connect tunnel.");
    console.log("  --list_browsers                List the available browsers configured.");
    console.log("  --browser=browsername          Run tests in chrome, firefox, etc (default: phantomjs).");
    console.log("  --browsers=b1,b2,..            Run multiple browsers in parallel.");
    console.log("  --browsers=all                 Run all available browsers (sauce only).");
    console.log("  --create_tunnels               Create secure tunnels in sauce mode (for use with --sauce only)");
    console.log("  --sauce_tunnel_id              Use an existing secure tunnel (for use with --sauce only, exclusive with --create_tunnels)");
    console.log("  --shared_sauce_parent_account  Specify parent account name if existing shared secure tunnel is in use (for use with --sauce only, exclusive with --create_tunnels)");
    console.log("  --profile=p1,p2,..             Specify lists of browsers to use defined in profiles in magellan.json config.");
    console.log("  --profile=http://abc/p#p1,p2   Use profiles p1 and p2 hosted at JSON file http://abc/p (see README for details).");

    var help;

    if (settings.testFramework && settings.testFramework.help) {
      help = settings.testFramework.help;
    }

    if (help) {
      console.log("");
      console.log(" Framework-specific (" + settings.framework + "):");
      var maxWidth = 31;

      Object.keys(help).forEach(function (key) {
        var str = "  --" + key;
        if (help[key].example) {
          str += "=" + help[key].example;
        }
        // pad
        while (str.length < maxWidth) {
          str += " ";
        }
        // truncate just in case the example was too long to begin with
        str = str.substr(0, maxWidth);
        str += help[key].description;
        console.log(str);
      });
    }

    console.log("");
    console.log("  +------------------------------------------+-----------+-------------------+");
    console.log("  | Workflow / Output Examples               | # workers | output style      |");
    console.log("  +------------------------------------------+-----------+-------------------+");
    console.log("  |--browser=phantomjs                       | 8         | summary, failures |");
    console.log("  |--browser=<not phantom> --sauce           | 3         | summary, failures |");
    console.log("  |--browser=<not phantom>                   | 3         | summary, failures |");
    console.log("  |--sauce --browser=<xxxx> --serial         | 1         | detail, all tests |");
    console.log("  |--sauce --browser=<not phantom> --serial  | 1         | detail, all tests |");
    console.log("  |--browser=<any> --serial                  | 1         | detail, all tests |");
    console.log("  +------------------------------------------+-----------+-------------------+");

    console.log("");
    console.log("magellan v" + project.version);
  }
};