CommandLineArgs.java

package org.testng;

import com.beust.jcommander.Parameter;
import java.util.ArrayList;
import java.util.List;
import org.testng.collections.Lists;
import org.testng.xml.XmlSuite;

public class CommandLineArgs {

  @Parameter(description = "The XML suite files to run")
  public List<String> suiteFiles = Lists.newArrayList();

  public static final String LOG = "-log";
  public static final String VERBOSE = "-verbose";

  @Parameter(
      names = {LOG, VERBOSE},
      description = "Level of verbosity")
  public Integer verbose;

  public static final String GROUPS = "-groups";

  @Parameter(names = GROUPS, description = "Comma-separated list of group names to be run")
  public String groups;

  public static final String EXCLUDED_GROUPS = "-excludegroups";

  @Parameter(
      names = EXCLUDED_GROUPS,
      description = "Comma-separated list of group names to " + " exclude")
  public String excludedGroups;

  public static final String OUTPUT_DIRECTORY = "-d";

  @Parameter(names = OUTPUT_DIRECTORY, description = "Output directory")
  public String outputDirectory;

  public static final String MIXED = "-mixed";

  @Parameter(
      names = MIXED,
      description =
          "Mixed mode - autodetect the type of current test"
              + " and run it with appropriate runner")
  public Boolean mixed = Boolean.FALSE;

  public static final String LISTENER = "-listener";

  @Parameter(
      names = LISTENER,
      description =
          "List of .class files or list of class names"
              + " implementing ITestListener or ISuiteListener")
  public String listener;

  public static final String METHOD_SELECTORS = "-methodselectors";

  @Parameter(
      names = METHOD_SELECTORS,
      description = "List of .class files or list of class " + "names implementing IMethodSelector")
  public String methodSelectors;

  public static final String OBJECT_FACTORY = "-objectfactory";

  @Parameter(
      names = OBJECT_FACTORY,
      description =
          "Fully qualified class name that implements org.testng.ITestObjectFactory which can be used to create test class and listener instances.")
  public String objectFactory;

  public static final String PARALLEL = "-parallel";

  @Parameter(names = PARALLEL, description = "Parallel mode (methods, tests or classes)")
  public XmlSuite.ParallelMode parallelMode;

  public static final String CONFIG_FAILURE_POLICY = "-configfailurepolicy";

  @Parameter(
      names = CONFIG_FAILURE_POLICY,
      description = "Configuration failure policy (skip or continue)")
  public String configFailurePolicy;

  public static final String THREAD_COUNT = "-threadcount";

  @Parameter(
      names = THREAD_COUNT,
      description = "Number of threads to use when running tests " + "in parallel")
  public Integer threadCount;

  public static final String DATA_PROVIDER_THREAD_COUNT = "-dataproviderthreadcount";

  @Parameter(
      names = DATA_PROVIDER_THREAD_COUNT,
      description = "Number of threads to use when " + "running data providers")
  public Integer dataProviderThreadCount;

  public static final String SUITE_NAME = "-suitename";

  @Parameter(
      names = SUITE_NAME,
      description =
          "Default name of test suite, if not specified "
              + "in suite definition file or source code")
  public String suiteName;

  public static final String TEST_NAME = "-testname";

  @Parameter(
      names = TEST_NAME,
      description =
          "Default name of test, if not specified in suite" + "definition file or source code")
  public String testName;

  public static final String REPORTER = "-reporter";

  @Parameter(names = REPORTER, description = "Extended configuration for custom report listener")
  public String reporter;

  public static final String USE_DEFAULT_LISTENERS = "-usedefaultlisteners";

  @Parameter(names = USE_DEFAULT_LISTENERS, description = "Whether to use the default listeners")
  public String useDefaultListeners = "true";

  public static final String SKIP_FAILED_INVOCATION_COUNTS = "-skipfailedinvocationcounts";

  @Parameter(names = SKIP_FAILED_INVOCATION_COUNTS, hidden = true)
  public Boolean skipFailedInvocationCounts;

  public static final String TEST_CLASS = "-testclass";

  @Parameter(names = TEST_CLASS, description = "The list of test classes")
  public String testClass;

  public static final String TEST_NAMES = "-testnames";

  @Parameter(names = TEST_NAMES, description = "The list of test names to run")
  public String testNames;

  public static final String IGNORE_MISSED_TEST_NAMES = "-ignoreMissedTestNames";

  @Parameter(
      names = IGNORE_MISSED_TEST_NAMES,
      description =
          "Ignore missed test names given by '-testnames' and continue to run existing tests, if any.")
  public boolean ignoreMissedTestNames = false;

  public static final String TEST_JAR = "-testjar";

  @Parameter(names = TEST_JAR, description = "A jar file containing the tests")
  public String testJar;

  public static final String XML_PATH_IN_JAR = "-xmlpathinjar";
  public static final String XML_PATH_IN_JAR_DEFAULT = "testng.xml";

  @Parameter(
      names = XML_PATH_IN_JAR,
      description =
          "The full path to the xml file inside the jar file (only valid if -testjar was specified)")
  public String xmlPathInJar = XML_PATH_IN_JAR_DEFAULT;

  public static final String TEST_RUNNER_FACTORY = "-testrunfactory";

  @Parameter(
      names = {TEST_RUNNER_FACTORY, "-testRunFactory"},
      description = "The factory used to create tests")
  public String testRunnerFactory;

  public static final String LISTENER_FACTORY = "-listenerfactory";

  @Parameter(names = LISTENER_FACTORY, description = "The factory used to create TestNG listeners")
  public String listenerFactory;

  public static final String METHODS = "-methods";

  @Parameter(names = METHODS, description = "Comma separated of test methods")
  public List<String> commandLineMethods = new ArrayList<>();

  public static final String SUITE_THREAD_POOL_SIZE = "-suitethreadpoolsize";
  public static final Integer SUITE_THREAD_POOL_SIZE_DEFAULT = 1;

  @Parameter(
      names = SUITE_THREAD_POOL_SIZE,
      description = "Size of the thread pool to use to run suites")
  public Integer suiteThreadPoolSize = SUITE_THREAD_POOL_SIZE_DEFAULT;

  public static final String RANDOMIZE_SUITES = "-randomizesuites";

  @Parameter(
      names = RANDOMIZE_SUITES,
      hidden = true,
      description = "Whether to run suites in same order as specified in XML or not")
  public Boolean randomizeSuites = Boolean.FALSE;

  public static final String ALWAYS_RUN_LISTENERS = "-alwaysrunlisteners";

  @Parameter(
      names = ALWAYS_RUN_LISTENERS,
      description = "Should MethodInvocation Listeners be run even for skipped methods")
  public Boolean alwaysRunListeners = Boolean.TRUE;

  public static final String THREAD_POOL_FACTORY_CLASS = "-threadpoolfactoryclass";

  @Parameter(
      names = THREAD_POOL_FACTORY_CLASS,
      description = "The threadpool executor factory implementation that TestNG should use.")
  public String threadPoolFactoryClass;

  public static final String DEPENDENCY_INJECTOR_FACTORY = "-dependencyinjectorfactory";

  @Parameter(
      names = DEPENDENCY_INJECTOR_FACTORY,
      description = "The dependency injector factory implementation that TestNG should use.")
  public String dependencyInjectorFactoryClass;

  public static final String FAIL_IF_ALL_TESTS_SKIPPED = "-failwheneverythingskipped";

  @Parameter(
      names = FAIL_IF_ALL_TESTS_SKIPPED,
      description = "Should TestNG fail execution if all tests were skipped and nothing was run.")
  public Boolean failIfAllTestsSkipped = false;

  public static final String LISTENERS_TO_SKIP_VIA_SPI = "-spilistenerstoskip";

  @Parameter(
      names = LISTENERS_TO_SKIP_VIA_SPI,
      description =
          "Comma separated fully qualified class names of listeners that should be skipped from being wired in via Service Loaders.")
  public String spiListenersToSkip = "";

  public static final String OVERRIDE_INCLUDED_METHODS = "-overrideincludedmethods";

  @Parameter(
      names = OVERRIDE_INCLUDED_METHODS,
      description =
          "Comma separated fully qualified class names of listeners that should be skipped from being wired in via Service Loaders.")
  public Boolean overrideIncludedMethods = false;

  public static final String INCLUDE_ALL_DATA_DRIVEN_TESTS_WHEN_SKIPPING =
      "-includeAllDataDrivenTestsWhenSkipping";

  @Parameter(
      names = INCLUDE_ALL_DATA_DRIVEN_TESTS_WHEN_SKIPPING,
      description =
          "Should TestNG report all iterations of a data driven test as individual skips, in-case of upstream failures.")
  public Boolean includeAllDataDrivenTestsWhenSkipping = false;

  public static final String PROPAGATE_DATA_PROVIDER_FAILURES_AS_TEST_FAILURE =
      "-propagateDataProviderFailureAsTestFailure";

  @Parameter(
      names = PROPAGATE_DATA_PROVIDER_FAILURES_AS_TEST_FAILURE,
      description = "Should TestNG consider failures in Data Providers  as test failures.")
  public Boolean propagateDataProviderFailureAsTestFailure = false;

  public static final String GENERATE_RESULTS_PER_SUITE = "-generateResultsPerSuite";

  @Parameter(
      names = GENERATE_RESULTS_PER_SUITE,
      description =
          "Should TestNG generate results on a per suite basis by creating a sub directory for each suite and dumping results into it.")
  public Boolean generateResultsPerSuite = false;

  public static final String SHARE_THREAD_POOL_FOR_DATA_PROVIDERS =
      "-shareThreadPoolForDataProviders";

  @Parameter(
      names = SHARE_THREAD_POOL_FOR_DATA_PROVIDERS,
      description =
          "Should TestNG use a global Shared ThreadPool (At suite level) for running data providers.")
  public Boolean shareThreadPoolForDataProviders = false;

  public static final String USE_GLOBAL_THREAD_POOL = "-useGlobalThreadPool";

  @Parameter(
      names = USE_GLOBAL_THREAD_POOL,
      description =
          "Should TestNG use a global Shared ThreadPool (At suite level) for running regular and data driven tests.")
  public Boolean useGlobalThreadPool = false;
}