gradle/org.gradle.api.tasks.testing/Test

Test

@NullMarked
@CacheableTask
abstract class Test : AbstractTestTask, JavaForkOptions, PatternFilterable(source)

Executes JUnit (3.8.x, 4.x or 5.x) or TestNG tests. Test are always run in (one or more) separate JVMs.

The sample below shows various configuration options. 

plugins {
    id("java-library") // adds 'test' task
}

test {
  // discover and execute JUnit4-based tests
  useJUnit()

  // discover and execute TestNG-based tests
  useTestNG()

  // discover and execute JUnit Platform-based tests
  useJUnitPlatform()

  // set a system property for the test JVM(s)
  systemProperty 'some.prop', 'value'

  // explicitly include or exclude tests
  include 'org/foo/**'
  exclude 'org/boo/**'

  // show standard out and standard error of the test JVM(s) on the console
  testLogging.showStandardStreams = true

  // set heap size for the test JVM(s)
  minHeapSize = "128m"
  maxHeapSize = "512m"

  // set JVM arguments for the test JVM(s)
  jvmArgs('-XX:MaxPermSize=256m')

  // listen to events in the test execution lifecycle
  addTestListener(new TestListener() {
     void beforeTest(TestDescriptor descriptor) {
         logger.lifecycle("Running test: " + descriptor)
     }
  })

  // fail the 'test' task on the first test failure
  failFast = true

  // skip an actual test execution
  dryRun = true

  // listen to standard out and standard error of the test JVM(s)
  addTestOutputListener { descriptor, event ->
     logger.lifecycle("Test: " + descriptor + " produced standard out/err: " + event.message )
  }
}
Content copied to clipboard

The test process can be started in debug mode (see getDebug) in an ad-hoc manner by supplying the `--debug-jvm` switch when invoking the build. 

gradle someTestTask --debug-jvm
Content copied to clipboard

Since

0.7

Constructors

Link copied to clipboard
constructor()
Creates a new Test.

Properties

Link copied to clipboard
@get:Internal(value = "captured by stableClasspath")
open var classpath: FileCollection
Link copied to clipboard
open val conventionMapping: @Nullable ConventionMapping
Link copied to clipboard
@get:Nullable
open var description: @Nullable String
Link copied to clipboard
open var enabled: Boolean
Link copied to clipboard
val ExtensionAware.extra: ExtraPropertiesExtension

The extra properties extension in this object's extension container.

Link copied to clipboard
@get:Internal
open var forkEvery: Long
Link copied to clipboard
@get:Nullable
open var group: @Nullable String
Link copied to clipboard
@get:Internal
open var ignoreFailures: Boolean
Link copied to clipboard
open var impliesSubProjects: Boolean
Link copied to clipboard
open val loggingManager: LoggingManagerInternal
Link copied to clipboard
@get:Internal
open var maxParallelForks: Int
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val state: TaskStateInternal
Link copied to clipboard
val TASK_ACTION: String = "action"
The task action.
Link copied to clipboard
val TASK_CONSTRUCTOR_ARGS: String = "constructorArgs"
Constructor arguments for the Task
Link copied to clipboard
val TASK_DEPENDS_ON: String = "dependsOn"
The task depends on.
Link copied to clipboard
val TASK_DESCRIPTION: String = "description"
The task description.
Link copied to clipboard
val TASK_GROUP: String = "group"
The task group.
Link copied to clipboard
val TASK_NAME: String = "name"
The task name.
Link copied to clipboard
val TASK_OVERWRITE: String = "overwrite"
The task overwrite.
Link copied to clipboard
val TASK_TYPE: String = "type"
The task type.
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
open fun acceptServiceReferences(serviceReferences: Set<ServiceReferenceSpec>)
Link copied to clipboard
open fun addTestListener(listener: TestListener)
Registers a test listener with this task.
Link copied to clipboard
@Incubating
open fun addTestMetadataListener(listener: TestMetadataListener)
Registers a metadata listener with this task.
Link copied to clipboard
open fun addTestOutputListener(listener: TestOutputListener)
Registers a output listener with this task.
Link copied to clipboard
open fun afterSuite(closure: Closure)
Adds a closure to be notified after a test suite has executed.
Link copied to clipboard
open fun afterTest(closure: Closure)
Adds a closure to be notified after a test has executed.
Link copied to clipboard
open fun appendParallelSafeAction(action: Action<in Task>)
Link copied to clipboard
open fun beforeSuite(closure: Closure)
Adds a closure to be notified before a test suite is executed.
Link copied to clipboard
open fun beforeTest(closure: Closure)
Adds a closure to be notified before a test is executed.
Link copied to clipboard
open fun bootstrapClasspath(@Nullable classpath: Array<@Nullable Any>): Test
Adds the given values to the end of the bootstrap classpath for the process.
Link copied to clipboard
open fun compareTo(otherTask: Task): Int
open fun compareTo(otherTask: Task): Int
Link copied to clipboard
open fun configure(closure: Closure): Task
abstract fun configure(configureClosure: Closure): Task
open fun configure(closure: Closure): Task
Applies the statements of the closure against this task object.
abstract fun configure(cl: Closure): T
Configure.
Link copied to clipboard
inline fun <T : Any> ExtensionAware.configure(noinline configuration: T.() -> Unit)

Executes the given configuration block against the extension of the specified type.

Link copied to clipboard
open fun conventionMapping(property: String, mapping: Callable<out Any>): Task
Link copied to clipboard
open fun copyTo(target: JavaForkOptions): Test
Copies these options to the given options.
open fun copyTo(target: ProcessForkOptions): Test
Copies these options to the given target options.
Link copied to clipboard
open fun debugOptions(action: Action<JavaDebugOptions>)
Configures Java Debug Wire Protocol properties for the process.
Link copied to clipboard
open fun dependsOn(paths: Array<Any>): Task
open fun dependsOn(paths: Array<Any>): Task
Adds the given dependencies to this task.
Link copied to clipboard
open fun doFirst(action: Closure): Task
abstract fun doFirst(@DelegatesTo(value = Task::class) action: Closure): Task
Adds the given closure to the beginning of this task's action list.
open fun doFirst(action: Action<in Task>): Task
open fun doFirst(actionName: String, action: Action<in Task>): Task
open fun doFirst(action: Action<in Task>): Task
Adds the given Action to the beginning of this task's action list.
Link copied to clipboard
open fun doLast(action: Closure): Task
abstract fun doLast(@DelegatesTo(value = Task::class) action: Closure): Task
Adds the given closure to the end of this task's action list.
open fun doLast(action: Action<in Task>): Task
open fun doLast(actionName: String, action: Action<in Task>): Task
open fun doLast(action: Action<in Task>): Task
Adds the given Action to the end of this task's action list.
Link copied to clipboard
abstract fun doNotTrackState(reasonNotToTrackState: String)
open fun doNotTrackState(reasonNotToTrackState: String)
Do not track the state of the task.
Link copied to clipboard
open fun doNotTrackStateIf(reason: String, spec: Spec<in TaskInternal>)
Link copied to clipboard
open fun environment(environmentVariables: Map<String, out Any>): Test
Adds some environment variables to the environment for this process.
open fun environment(name: String, value: Any): Test
Adds an environment variable to the environment for this process.
Link copied to clipboard
inline fun Test.environment(vararg environmentVariables: Pair<String, Any>): Test

Kotlin extension function for org.gradle.api.tasks.testing.Test.environment.

inline fun ProcessForkOptions.environment(vararg environmentVariables: Pair<String, Any>): ProcessForkOptions

Kotlin extension function for org.gradle.process.ProcessForkOptions.environment.

Link copied to clipboard
open fun exclude(excludeSpec: Closure): Test
open fun exclude(excludeSpec: Spec<FileTreeElement>): Test
Adds an exclude spec.
open fun exclude(excludes: Iterable<String>): Test
open fun exclude(excludes: Array<String>): Test
Adds exclude patterns for the files in the test classes directory (e.g.
Link copied to clipboard
open fun executable(executable: Any): Test
Sets the name of the executable to use.
Link copied to clipboard
open fun executeTests()
Execute tests.
Link copied to clipboard
open fun filter(action: Action<TestFilter>)
Executes the action against the getFilter.
Link copied to clipboard
open fun finalizedBy(paths: Array<Any>): Task
open fun finalizedBy(paths: Array<Any>): Task
Adds the given finalizer tasks for this task.
Link copied to clipboard
open fun getActions(): List<Action<in Task>>
open fun getActions(): List<Action<in Task>>
Returns the sequence of Action objects which will be executed by this task, in the order of execution.
Link copied to clipboard
open fun getAllJvmArgs(): List<String>
Returns the full set of arguments to use to launch the JVM for the process.
Link copied to clipboard
open fun getAnt(): AntBuilder
open fun getAnt(): AntBuilder
Returns the AntBuilder for this task.
Link copied to clipboard
open fun getAsDynamicObject(): DynamicObject
Link copied to clipboard
@OutputDirectory
abstract fun getBinaryResultsDirectory(): DirectoryProperty
Returns the root directory property for the test results in internal binary format.
Link copied to clipboard
open fun getBootstrapClasspath(): FileCollection
Returns the bootstrap classpath to use for the process.
Link copied to clipboard
@InputFiles
@SkipWhenEmpty
@IgnoreEmptyDirectories
@PathSensitive(value = PathSensitivity.RELATIVE)
open fun getCandidateClassFiles(): FileTree
Returns the classes files to scan for test classes.
Link copied to clipboard
open fun getDebug(): Boolean
Determines whether debugging is enabled for the test process.
Link copied to clipboard
open fun getDebugOptions(): JavaDebugOptions
Returns the Java Debug Wire Protocol properties for the process.
Link copied to clipboard
@Nullable
open fun getDefaultCharacterEncoding(): @Nullable String
Returns the default character encoding to use.
Link copied to clipboard
open fun getDependsOn(): Set<Any>
open fun getDependsOn(): Set<Any>
Returns the dependencies of this task.
Link copied to clipboard
open fun getDestroyables(): TaskDestroyables
open fun getDestroyables(): TaskDestroyables
Returns the destroyables of this task.
Link copied to clipboard
open fun getDidWork(): Boolean
open fun getDidWork(): Boolean
Checks if the task actually did any work.
Link copied to clipboard
@Incubating
@Input
abstract fun getDryRun(): Property<Boolean>
Indicates if this task will skip individual test execution.
Link copied to clipboard
open fun getEnableAssertions(): Boolean
Returns true if assertions are enabled for the process.
Link copied to clipboard
@Internal
open fun getEnvironment(): Map<String, Any>
The environment variables to use for the process.
Link copied to clipboard
@Internal
open fun getExcludes(): Set<String>
Returns the exclude patterns for test execution.
Link copied to clipboard
@Internal
open fun getExecutable(): String
Returns the name of the executable to use.
Link copied to clipboard
open fun getExtensions(): ExtensionContainer
open fun getExtensions(): ExtensionContainer
The container of extensions.
Link copied to clipboard
open fun getFailFast(): Boolean
Indicates if this task will fail on the first failed test
Link copied to clipboard
@Input
abstract fun getFailOnNoDiscoveredTests(): Property<Boolean>
Whether the task should fail if test sources are present, but no tests are discovered during test execution.
Link copied to clipboard
open fun getFilter(): TestFilter
Allows filtering tests for execution.
Link copied to clipboard
open fun getFinalizedBy(): TaskDependency
open fun getFinalizedBy(): TaskDependency
Returns tasks that finalize this task.
Link copied to clipboard
open fun getIdentityPath(): Path
Link copied to clipboard
@Internal
open fun getIncludes(): Set<String>
Returns the include patterns for test execution.
Link copied to clipboard
open fun getInputs(): TaskInputsInternal
@Internal
abstract fun getInputs(): TaskInputs
open fun getInputs(): TaskInputsInternal
Returns the inputs of this task.
Link copied to clipboard
abstract fun getJavaLauncher(): Property<JavaLauncher>
Configures the java executable to be used to run the tests.
Link copied to clipboard
@Input
open fun getJavaVersion(): JavaVersion
Returns the version of Java used to run the tests based on the JavaLauncher specified by getJavaLauncher, or the executable specified by getExecutable if the JavaLauncher is not present.
Link copied to clipboard
open fun getJvmArgs(): List<String>
Returns the extra arguments to use to launch the JVM for the process.
Link copied to clipboard
open fun getJvmArgumentProviders(): List<CommandLineArgumentProvider>
Command line argument providers for the java process to fork.
Link copied to clipboard
open fun getLifecycleDependencies(): TaskDependencyInternal
abstract fun getLifecycleDependencies(): TaskDependency
Link copied to clipboard
open fun getLocalState(): TaskLocalState
open fun getLocalState(): TaskLocalState
Returns the local state of this task.
Link copied to clipboard
open fun getLogger(): Logger
open fun getLogger(): Logger
Returns the logger for this task.
Link copied to clipboard
open fun getLogging(): LoggingManager
open fun getLogging(): LoggingManager
Returns the org.gradle.api.logging.LoggingManager which can be used to receive logging and to control the standard output/error capture for this task.
Link copied to clipboard
@Nullable
open fun getMaxHeapSize(): @Nullable String
Returns the maximum heap size for the process, if any.
Link copied to clipboard
@Nullable
open fun getMinHeapSize(): @Nullable String
Returns the minimum heap size for the process, if any.
Link copied to clipboard
open fun getMustRunAfter(): TaskDependency
open fun getMustRunAfter(): TaskDependency
Returns tasks that this task must run after.
Link copied to clipboard
open fun getName(): String
open fun getName(): String
Returns the name of this task.
Link copied to clipboard
open fun getOnlyIf(): Spec<in TaskInternal>
Link copied to clipboard
open fun getOptions(): TestFrameworkOptions
Returns test framework specific options.
Link copied to clipboard
open fun getOutputs(): TaskOutputsInternal
@Internal
abstract fun getOutputs(): TaskOutputs
open fun getOutputs(): TaskOutputsInternal
Returns the outputs of this task.
Link copied to clipboard
open fun getPath(): String
open fun getPath(): String
Returns the path of the task, which is a fully qualified name for the task.
Link copied to clipboard
open fun getProject(): Project
open fun getProject(): Project
Returns the Project which this task belongs to.
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
abstract fun getReports(): T
A ReportContainer instance.
Link copied to clipboard
open fun getRequiredServices(): TaskRequiredServices
Link copied to clipboard
open fun getSharedResources(): List<ResourceLock>
abstract fun getSharedResources(): List<out ResourceLock>
Link copied to clipboard
open fun getShouldRunAfter(): TaskDependency
open fun getShouldRunAfter(): TaskDependency
Returns tasks that this task should run after.
Link copied to clipboard
open fun getStandardOutputCapture(): StandardOutputCapture
Link copied to clipboard
@Internal
abstract fun getState(): TaskState
Returns the execution state of this task.
Link copied to clipboard
open fun getSystemProperties(): Map<String, @Nullable Any>
Returns the system properties which will be used for the process.
Link copied to clipboard
open fun getTaskActions(): List<InputChangesAwareTaskAction>
Link copied to clipboard
open fun getTaskDependencies(): TaskDependencyInternal
@Internal
abstract fun getTaskDependencies(): TaskDependency
open fun getTaskDependencies(): TaskDependencyInternal
Returns a TaskDependency which contains all the tasks that this task depends on.
Link copied to clipboard
open fun getTaskIdentity(): TaskIdentity<out Any>
Link copied to clipboard
open fun getTemporaryDir(): File
open fun getTemporaryDir(): File
Returns a directory which this task can use to write temporary files to.
Link copied to clipboard
open fun getTemporaryDirFactory(): Factory<File>
Link copied to clipboard
@Incubating
@InputFiles
@SkipWhenEmpty
@IgnoreEmptyDirectories
@PathSensitive(value = PathSensitivity.RELATIVE)
abstract fun getTestDefinitionDirs(): ConfigurableFileCollection
Returns directories to scan for non-class-based test definition files.
Link copied to clipboard
@Internal
open fun getTestFramework(): TestFramework
Returns the test framework.
Link copied to clipboard
open fun getTestFrameworkProperty(): Property<TestFramework>
Returns the configured TestFramework.
Link copied to clipboard
@Internal
open fun getWorkingDir(): File
Returns the working directory for the process.
Link copied to clipboard
@Internal
open fun getWorkingDirectory(): DirectoryProperty
Returns the working directory for the process as a .
Link copied to clipboard
open fun hasProperty(propertyName: String): Boolean
open fun hasProperty(propertyName: String): Boolean
Determines if this task has the given property.
Link copied to clipboard
open fun hasTaskActions(): Boolean
Link copied to clipboard
open fun include(includeSpec: Closure): Test
open fun include(includeSpec: Spec<FileTreeElement>): Test
Adds an include spec.
open fun include(includes: Iterable<String>): Test
open fun include(includes: Array<String>): Test
Adds include patterns for the files in the test classes directory (e.g.
Link copied to clipboard
open fun <T : Task?> injectIntoNewInstance(project: ProjectInternal, identity: TaskIdentity<T>, factory: Callable<T>): T
Link copied to clipboard
Link copied to clipboard
open fun isEnabled(): Boolean
Link copied to clipboard
open fun isHasCustomActions(): Boolean
Link copied to clipboard
@Input
open fun isScanForTestClasses(): Boolean
Specifies whether test classes should be detected.
Link copied to clipboard
open fun jvmArgs(arguments: Iterable<out Any>): Test
open fun jvmArgs(arguments: Array<Any>): Test
Adds some arguments to use to launch the JVM for the process.
Link copied to clipboard
open fun mustRunAfter(paths: Array<Any>): Task
open fun mustRunAfter(paths: Array<Any>): Task
Specifies that this task must run after all of the supplied tasks.
Link copied to clipboard
abstract fun notCompatibleWithConfigurationCache(reason: String)
open fun notCompatibleWithConfigurationCache(reason: String)
Specifies that this task is not compatible with the configuration cache.
Link copied to clipboard
open fun onlyIf(onlyIfClosure: Closure)
abstract fun onlyIf(onlyIfClosure: Closure<out Any>)
open fun onlyIf(onlyIfClosure: Closure)
Execute the task only if the given closure returns true.
open fun onlyIf(spec: Spec<in Task>)
open fun onlyIf(onlyIfReason: String, spec: Spec<in Task>)
abstract fun onlyIf(onlyIfSpec: Spec<in Task>)
@Incubating
abstract fun onlyIf(onlyIfReason: String, onlyIfSpec: Spec<in Task>)
Execute the task only if the given spec is satisfied.
Link copied to clipboard
open fun onOutput(closure: Closure)
Adds a closure to be notified when output from the test received.
Link copied to clipboard
open fun options(@DelegatesTo(value = TestFrameworkOptions::class) testFrameworkConfigure: Closure): TestFrameworkOptions
open fun options(testFrameworkConfigure: Action<in TestFrameworkOptions>): TestFrameworkOptions
Configures test framework specific options.
Link copied to clipboard
open fun prependParallelSafeAction(action: Action<in Task>)
Link copied to clipboard
open fun property(propertyName: String): Any
open fun property(propertyName: String): Any
Returns the value of the given property of this task.
Link copied to clipboard
open fun removeTestListener(listener: TestListener)
Unregisters a test listener with this task.
Link copied to clipboard
@Incubating
open fun removeTestMetadataListener(listener: TestMetadataListener)
Unregisters a test metadata listener with this task.
Link copied to clipboard
open fun removeTestOutputListener(listener: TestOutputListener)
Unregisters a test output listener with this task.
Link copied to clipboard
abstract fun reports(@DelegatesTo(type = "T", strategy = Closure.DELEGATE_FIRST) closure: Closure): T
abstract fun reports(configureAction: Action<in T>): T
Allow configuration of the report container by closure.
open fun reports(closure: Closure): TestTaskReports
open fun reports(configureAction: Action<in TestTaskReports>): TestTaskReports
Configures the reports that this task potentially produces.
Link copied to clipboard
open fun restoreOnlyIf(onlyIf: Spec<in TaskInternal>)
Link copied to clipboard
open fun restoreTaskActions(taskActions: List<InputChangesAwareTaskAction>)
Link copied to clipboard
@Incubating
inline fun <T : ERROR CLASS: Symbol not found for org.gradle.api.services.TaskService> Task.service(serviceType: KClass<T>): T

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.Task.service.

Link copied to clipboard
open fun setActions(replacements: List<Action<in Task>>)
abstract fun setActions(actions: List<Action<in Task>>)
open fun setActions(replacements: List<Action<in Task>>)
Sets the sequence of Action objects which will be executed by this task.
Link copied to clipboard
open fun setAllJvmArgs(arguments: Iterable<out Any>)
open fun setAllJvmArgs(arguments: List<String>)
Sets the full set of arguments to use to launch the JVM for the process.
Link copied to clipboard
open fun setBootstrapClasspath(classpath: FileCollection)
Sets the bootstrap classpath to use for the process.
Link copied to clipboard
open fun setDebug(enabled: Boolean)
Enable or disable debugging for the process.
Link copied to clipboard
open fun setDefaultCharacterEncoding(@Nullable defaultCharacterEncoding: @Nullable String)
Sets the default character encoding to use.
Link copied to clipboard
open fun setDependsOn(dependsOn: Iterable<out Any>)
abstract fun setDependsOn(dependsOnTasks: Iterable<out Any>)
open fun setDependsOn(dependsOn: Iterable<out Any>)
Sets the dependencies of this task.
Link copied to clipboard
open fun setDidWork(didWork: Boolean)
open fun setDidWork(didWork: Boolean)
Sets whether the task actually did any work.
Link copied to clipboard
open fun setEnableAssertions(enabled: Boolean)
Enable or disable assertions for the process.
Link copied to clipboard
open fun setEnvironment(environmentVariables: Map<String, out Any>)
Sets the environment variable to use for the process.
Link copied to clipboard
inline fun ProcessForkOptions.setEnvironment(vararg environmentVariables: Pair<String, Any>)

Kotlin extension function for org.gradle.process.ProcessForkOptions.setEnvironment.

Link copied to clipboard
open fun setExcludes(excludes: Iterable<String>): Test
Sets the exclude patterns for test execution.
Link copied to clipboard
open fun setExecutable(executable: Any)
open fun setExecutable(executable: String)
Sets the name of the executable to use.
Link copied to clipboard
open fun setFailFast(failFast: Boolean)
Enables fail fast behavior causing the task to fail on the first failed test.
Link copied to clipboard
open fun setFinalizedBy(finalizedByTasks: Iterable<out Any>)
abstract fun setFinalizedBy(finalizedBy: Iterable<out Any>)
open fun setFinalizedBy(finalizedByTasks: Iterable<out Any>)
Specifies the set of finalizer tasks for this task.
Link copied to clipboard
open fun setIncludes(includes: Iterable<String>): Test
Sets the include patterns for test execution.
Link copied to clipboard
open fun setJvmArgs(arguments: Iterable<out Any>)
open fun setJvmArgs(arguments: List<String>)
Sets the extra arguments to use to launch the JVM for the process.
Link copied to clipboard
open fun setMaxHeapSize(@Nullable heapSize: @Nullable String)
Sets the maximum heap size for the process.
Link copied to clipboard
open fun setMinHeapSize(@Nullable heapSize: @Nullable String)
Sets the minimum heap size for the process.
Link copied to clipboard
open fun setMustRunAfter(mustRunAfterTasks: Iterable<out Any>)
abstract fun setMustRunAfter(mustRunAfter: Iterable<out Any>)
open fun setMustRunAfter(mustRunAfterTasks: Iterable<out Any>)
Specifies the set of tasks that this task must run after.
Link copied to clipboard
open fun setOnlyIf(onlyIfClosure: Closure)
abstract fun setOnlyIf(onlyIfClosure: Closure<out Any>)
Execute the task only if the given closure returns true.
open fun setOnlyIf(spec: Spec<in Task>)
open fun setOnlyIf(onlyIfReason: String, spec: Spec<in Task>)
abstract fun setOnlyIf(onlyIfSpec: Spec<in Task>)
@Incubating
abstract fun setOnlyIf(onlyIfReason: String, onlyIfSpec: Spec<in Task>)
open fun setOnlyIf(spec: Spec<in Task>)
Execute the task only if the given spec is satisfied.
Link copied to clipboard
open fun setProperty(name: String, value: Any)
open fun setProperty(name: String, value: Any)
Sets a property of this task.
Link copied to clipboard
open fun setScanForTestClasses(scanForTestClasses: Boolean)
Sets the scan for test classes.
Link copied to clipboard
open fun setShouldRunAfter(shouldRunAfterTasks: Iterable<out Any>)
abstract fun setShouldRunAfter(shouldRunAfter: Iterable<out Any>)
open fun setShouldRunAfter(shouldRunAfterTasks: Iterable<out Any>)
Specifies the set of tasks that this task should run after.
Link copied to clipboard
open fun setSystemProperties(properties: Map<String, out @Nullable Any>)
Sets the system properties to use for the process.
Link copied to clipboard
inline fun JavaForkOptions.setSystemProperties(vararg properties: Pair<String, Any>)

Kotlin extension function for org.gradle.process.JavaForkOptions.setSystemProperties.

Link copied to clipboard
open fun setTestNameIncludePatterns(testNamePattern: List<String>): Test
Sets the test name patterns to be included in execution.
Link copied to clipboard
open fun setWorkingDir(dir: File)
open fun setWorkingDir(dir: Any)
Sets the working directory for the process.
Link copied to clipboard
open fun shouldRunAfter(paths: Array<Any>): TaskDependency
open fun shouldRunAfter(paths: Array<Any>): TaskDependency
Specifies that this task should run after all of the supplied tasks.
Link copied to clipboard
open fun systemProperties(properties: Map<String, out @Nullable Any>): Test
Adds some system properties to use for the process.
Link copied to clipboard
inline fun Test.systemProperties(vararg properties: Pair<String, Any>): Test

Kotlin extension function for org.gradle.api.tasks.testing.Test.systemProperties.

inline fun JavaForkOptions.systemProperties(vararg properties: Pair<String, Any>): JavaForkOptions

Kotlin extension function for org.gradle.process.JavaForkOptions.systemProperties.

Link copied to clipboard
open fun systemProperty(name: String, @Nullable value: @Nullable Any): Test
Adds a system property to use for the process.
Link copied to clipboard
open fun testFramework(@Nullable testFrameworkConfigure: @Nullable Closure): TestFramework
Do not call this method.
Link copied to clipboard
open fun testLogging(@DelegatesTo(value = TestLoggingContainer::class) closure: Closure)
open fun testLogging(action: Action<in TestLoggingContainer>)
Allows configuring the logging of the test execution, for example log eagerly the standard output, etc.
Link copied to clipboard
inline fun <T : Any> ExtensionAware.the(): T

Returns the extension of the specified type.

fun <T : Any> ExtensionAware.the(extensionType: KClass<T>): T

Returns the extension of the specified extensionType.

Link copied to clipboard
open fun useJUnit()
Specifies that JUnit4 should be used to discover and execute the tests.
open fun useJUnit(@Nullable @DelegatesTo(value = JUnitOptions::class) testFrameworkConfigure: @Nullable Closure)
open fun useJUnit(testFrameworkConfigure: Action<in JUnitOptions>)
Specifies that JUnit4 should be used to discover and execute the tests with additional configuration.
Link copied to clipboard
open fun useJUnitPlatform()
Specifies that JUnit Platform should be used to discover and execute the tests.
open fun useJUnitPlatform(testFrameworkConfigure: Action<in JUnitPlatformOptions>)
Specifies that JUnit Platform should be used to discover and execute the tests with additional configuration.
Link copied to clipboard
open fun usesService(service: Provider<out BuildService<out Any>>)
open fun usesService(service: Provider<out BuildService<out Any>>)
Registers a BuildService that is used by this task so its constraint on parallel execution can be honored.
Link copied to clipboard
open fun useTestNG()
Specifies that TestNG should be used to discover and execute the tests.
open fun useTestNG(@DelegatesTo(value = TestNGOptions::class) testFrameworkConfigure: Closure)
open fun useTestNG(testFrameworkConfigure: Action<in TestNGOptions>)
Specifies that TestNG should be used to discover and execute the tests with additional configuration.
Link copied to clipboard
open fun workingDir(dir: Any): Test
Sets the working directory for the process.
Generated by Dokka
Gradle Kotlin DSL Reference