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

TestNGOptions

abstract class TestNGOptions : TestFrameworkOptions(source)

The TestNG specific test options.

Constructors

TestNGOptions

@Inject

constructor(projectLayout: ProjectLayout, objects: ObjectFactory)

Properties

DEFAULT_CONFIG_FAILURE_POLICY

val DEFAULT_CONFIG_FAILURE_POLICY: String = "skip"

suiteXmlBuilder

@get:Internal

open val suiteXmlBuilder: Property<MarkupBuilder>

suiteXmlWriter

@get:Internal

open val suiteXmlWriter: Property<StringWriter>

Functions

copyFrom

open fun copyFrom(other: TestNGOptions)

Copies the options from the source options into the current one.

excludeGroups

open fun excludeGroups(excludeGroups: Array<String>): TestNGOptions

getConfigFailurePolicy

@Internal

abstract fun getConfigFailurePolicy(): Property<String>

Option for what to do for other tests that use a configuration step when that step fails.

getExcludeGroups

@Input

abstract fun getExcludeGroups(): SetProperty<String>

The set of groups to exclude.

getGroupByInstances

@Internal

abstract fun getGroupByInstances(): Property<Boolean>

Indicates whether the tests should be grouped by instances.

getIncludeGroups

@Input

abstract fun getIncludeGroups(): SetProperty<String>

The set of groups to run.

getIsGroupByInstances

@Internal

open fun getIsGroupByInstances(): Property<Boolean>

getIsPreserveOrder

@Internal

open fun getIsPreserveOrder(): Property<Boolean>

getIsUseDefaultListeners

@Internal

open fun getIsUseDefaultListeners(): Property<Boolean>

getListeners

@Internal

abstract fun getListeners(): SetProperty<String>

Fully qualified classes that are TestNG listeners (instances of org.testng.ITestListener or org.testng.IReporter).

getOutputDirectory

@OutputDirectory

abstract fun getOutputDirectory(): DirectoryProperty

The location to write TestNG's output.

getParallel

@Internal

abstract fun getParallel(): Property<String>

The parallel mode to use for running the tests - one of the following modes: methods, tests, classes or instances.

getPreserveOrder

@Internal

abstract fun getPreserveOrder(): Property<Boolean>

Indicates whether the tests should be run in deterministic order.

getSuiteName

@Internal

abstract fun getSuiteName(): Property<String>

Sets the default name of the test suite, if one is not specified in a suite XML file or in the source code.

getSuites

open fun getSuites(testSuitesDir: File): List<File>

getSuiteThreadPoolSize

@Internal

@Incubating

abstract fun getSuiteThreadPoolSize(): Property<Integer>

The number of XML suites will run parallel

getSuiteXmlFiles

@InputFiles

@PathSensitive(value = PathSensitivity.NONE)

abstract fun getSuiteXmlFiles(): ConfigurableFileCollection

The suiteXmlFiles to use for running TestNG.

getTestName

@Internal

abstract fun getTestName(): Property<String>

Sets the default name of the test, if one is not specified in a suite XML file or in the source code.

getThreadCount

@Internal

abstract fun getThreadCount(): Property<Integer>

The number of threads to use for this run.

getThreadPoolFactoryClass

@Internal

@Incubating

abstract fun getThreadPoolFactoryClass(): Property<String>

ThreadPoolExecutorFactory class used by TestNG

getUseDefaultListeners

@Internal

abstract fun getUseDefaultListeners(): Property<Boolean>

Whether the default listeners and reporters should be used.

includeGroups

open fun includeGroups(includeGroups: Array<String>): TestNGOptions

methodMissing

open fun methodMissing(name: String, args: Any): Any

propertyMissing

open fun propertyMissing(name: String): Any

setConfigFailurePolicy

open fun setConfigFailurePolicy(configFailurePolicy: String)

setExcludeGroups

open fun setExcludeGroups(excludeGroups: Set<String>)

setGroupByInstances

open fun setGroupByInstances(groupByInstances: Boolean)

setIncludeGroups

open fun setIncludeGroups(includeGroups: Set<String>)

setListeners

open fun setListeners(listeners: Set<String>)

setOutputDirectory

open fun setOutputDirectory(outputDirectory: File)

setParallel

open fun setParallel(@Nullable parallel: @Nullable String)

setPreserveOrder

open fun setPreserveOrder(preserveOrder: Boolean)

setSuiteName

open fun setSuiteName(suiteName: String)

setSuiteXmlBuilder

open fun setSuiteXmlBuilder(suiteXmlBuilder: MarkupBuilder)

setSuiteXmlFiles

open fun setSuiteXmlFiles(suiteXmlFiles: List<File>)

setSuiteXmlWriter

open fun setSuiteXmlWriter(suiteXmlWriter: StringWriter)

setTestName

open fun setTestName(testName: String)

setThreadCount

open fun setThreadCount(threadCount: Int)

setThreadPoolFactoryClass

@Incubating

open fun setThreadPoolFactoryClass(threadPoolFactoryClass: String)

Sets a custom threadPoolExecutorFactory class.

setUseDefaultListeners

open fun setUseDefaultListeners(useDefaultListeners: Boolean)

suites

open fun suites(suiteFiles: Array<File>)

Add suite files by File objects.

open fun suites(suiteFiles: Array<String>)

Add suite files by Strings.

suiteXmlBuilder

open fun suiteXmlBuilder(): MarkupBuilder

useDefaultListeners

open fun useDefaultListeners(): TestNGOptions

open fun useDefaultListeners(useDefaultListeners: Boolean): TestNGOptions