api / org.gradle.api.tasks.testing.testng / TestNGOptions

TestNGOptions

open class TestNGOptions : TestFrameworkOptions

The TestNG specific test options.

Constructors

<init>

TestNGOptions(projectDir: File)

Properties

DEFAULT_CONFIG_FAILURE_POLICY

static val DEFAULT_CONFIG_FAILURE_POLICY: String

Functions

excludeGroups	`open fun excludeGroups(vararg excludeGroups: String): TestNGOptions`
getConfigFailurePolicy	`open fun getConfigFailurePolicy(): String` Option for what to do for other tests that use a configuration step when that step fails. Can be "skip" or "continue", defaults to "skip".
getExcludeGroups	`open fun getExcludeGroups(): MutableSet<String>` The set of groups to exclude.
getGroupByInstances	`open fun getGroupByInstances(): Boolean`
getIncludeGroups	`open fun getIncludeGroups(): MutableSet<String>` The set of groups to run.
getListeners	`open fun getListeners(): MutableSet<String>` Fully qualified classes that are TestNG listeners (instances of org.testng.ITestListener or org.testng.IReporter). By default, the listeners set is empty. Configuring extra listener: `apply plugin: 'java' test { useTestNG() { // creates emailable HTML file // this reporter typically ships with TestNG library listeners << 'org.testng.reporters.EmailableReporter' } }`
getOutputDirectory	`open fun getOutputDirectory(): File` The location to write TestNG's output. Defaults to the owning test task's location for writing the HTML report.
getParallel	`open fun getParallel(): String` The parallel mode to use for running the tests - one of the following modes: methods, tests, classes or instances. Not required. If not present, parallel mode will not be selected
getPreserveOrder	`open fun getPreserveOrder(): Boolean`
getSuiteName	`open fun getSuiteName(): String` Sets the default name of the test suite, if one is not specified in a suite XML file or in the source code.
getSuiteXmlBuilder	`open fun getSuiteXmlBuilder(): MarkupBuilder`
getSuiteXmlFiles	`open fun getSuiteXmlFiles(): MutableList<File>` The suiteXmlFiles to use for running TestNG. Note: The suiteXmlFiles can be used in conjunction with the suiteXmlBuilder.
getSuiteXmlWriter	`open fun getSuiteXmlWriter(): StringWriter`
getSuites	`open fun getSuites(testSuitesDir: File): MutableList<File>`
getTestName	`open fun getTestName(): String` Sets the default name of the test, if one is not specified in a suite XML file or in the source code.
getThreadCount	`open fun getThreadCount(): Int` The number of threads to use for this run. Ignored unless the parallel mode is also specified
getUseDefaultListeners	`open fun getUseDefaultListeners(): Boolean`
includeGroups	`open fun includeGroups(vararg includeGroups: String): TestNGOptions`
isGroupByInstances	`open fun isGroupByInstances(): Boolean` Indicates whether the tests should be grouped by instances. Grouping by instances will result in resolving test method dependencies for each instance instead of running the dependees of all instances before running the dependants. Not required. If not present, the tests will not be grouped by instances.
isPreserveOrder	`open fun isPreserveOrder(): Boolean` Indicates whether the tests should be run in deterministic order. Preserving the order guarantees that the complete test (including @BeforeXXX and @AfterXXX) is run in a test thread before the next test is run. Not required. If not present, the order will not be preserved.
isUseDefaultListeners	`open fun isUseDefaultListeners(): Boolean` Whether the default listeners and reporters should be used. Since Gradle 1.4 it defaults to 'false' so that Gradle can own the reports generation and provide various improvements. This option might be useful for advanced TestNG users who prefer the reports generated by the TestNG library. If you cannot live without some specific TestNG reporter please use `#listeners` property. If you really want to use all default TestNG reporters (e.g. generate the old reports): `apply plugin: 'java' test { useTestNG() { // report generation delegated to TestNG library: useDefaultListeners = true } // turn off Gradle's HTML report to avoid replacing the // reports generated by TestNG library: reports.html.enabled = false }` Please refer to the documentation of your version of TestNG what are the default listeners. At the moment of writing this documentation, the default listeners are a set of reporters that generate: TestNG variant of HTML results, TestNG variant of XML results in JUnit format, emailable HTML test report, XML results in TestNG format.
methodMissing	`open fun methodMissing(name: String, args: Any): Any`
propertyMissing	`open fun propertyMissing(name: String): Any`
setConfigFailurePolicy	`open fun setConfigFailurePolicy(configFailurePolicy: String): Unit`
setExcludeGroups	`open fun setExcludeGroups(excludeGroups: MutableSet<String>): Unit`
setGroupByInstances	`open fun setGroupByInstances(groupByInstances: Boolean): Unit`
setIncludeGroups	`open fun setIncludeGroups(includeGroups: MutableSet<String>): Unit`
setListeners	`open fun setListeners(listeners: MutableSet<String>): Unit`
setOutputDirectory	`open fun setOutputDirectory(outputDirectory: File): Unit`
setParallel	`open fun setParallel(parallel: String): Unit`
setPreserveOrder	`open fun setPreserveOrder(preserveOrder: Boolean): Unit`
setSuiteName	`open fun setSuiteName(suiteName: String): Unit`
setSuiteXmlBuilder	`open fun setSuiteXmlBuilder(suiteXmlBuilder: MarkupBuilder): Unit`
setSuiteXmlFiles	`open fun setSuiteXmlFiles(suiteXmlFiles: MutableList<File>): Unit`
setSuiteXmlWriter	`open fun setSuiteXmlWriter(suiteXmlWriter: StringWriter): Unit`
setTestName	`open fun setTestName(testName: String): Unit`
setThreadCount	`open fun setThreadCount(threadCount: Int): Unit`
setUseDefaultListeners	`open fun setUseDefaultListeners(useDefaultListeners: Boolean): Unit`
suiteXmlBuilder	`open fun suiteXmlBuilder(): MarkupBuilder`
suites	`open fun suites(vararg suiteFiles: String): Unit` Add suite files by Strings. Each suiteFile String should be a path relative to the project root. `open fun suites(vararg suiteFiles: File): Unit` Add suite files by File objects.
useDefaultListeners	`open fun useDefaultListeners(): TestNGOptions` `open fun useDefaultListeners(useDefaultListeners: Boolean): TestNGOptions`