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

Test

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
  beforeTest { 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)
  onOutput { descriptor, event ->
     logger.lifecycle("Test: " + descriptor + " produced standard out/err: " + event.message )
  }
}

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

Constructors

Test

constructor()

Properties

binaryResultsDirectory

val binaryResultsDirectory: DirectoryProperty

classpath

@get:Internal(value = "captured by stableClasspath")

open var classpath: FileCollection

conventionMapping

open val conventionMapping: ConventionMapping

description

open var description: String

enabled

open var enabled: Boolean

extra

val ExtensionAware.extra: ExtraPropertiesExtension

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

forkEvery

@get:Internal

open var forkEvery: Long

group

open var group: String

ignoreFailures

open var ignoreFailures: Boolean

impliesSubProjects

open var impliesSubProjects: Boolean

javaLauncher

val javaLauncher: Property<JavaLauncher>

maxParallelForks

@get:Internal

open var maxParallelForks: Int

modularity

val modularity: ModularitySpec

reports

val reports: TestTaskReports

state

val state: TaskStateInternal

TASK_ACTION

val TASK_ACTION: String = "action"

TASK_CONSTRUCTOR_ARGS

val TASK_CONSTRUCTOR_ARGS: String = "constructorArgs"

TASK_DEPENDS_ON

val TASK_DEPENDS_ON: String = "dependsOn"

TASK_DESCRIPTION

val TASK_DESCRIPTION: String = "description"

TASK_GROUP

val TASK_GROUP: String = "group"

TASK_NAME

val TASK_NAME: String = "name"

TASK_OVERWRITE

val TASK_OVERWRITE: String = "overwrite"

TASK_TYPE

val TASK_TYPE: String = "type"

testClassesDirs

@get:Internal

open var testClassesDirs: FileCollection

testLogging

val testLogging: TestLoggingContainer

timeout

val timeout: Property<Duration>

Functions

acceptServiceReferences

open fun acceptServiceReferences(serviceReferences: Set<ServiceReferenceSpec>)

addTestListener

open fun addTestListener(listener: TestListener)

addTestOutputListener

open fun addTestOutputListener(listener: TestOutputListener)

afterSuite

open fun afterSuite(closure: Closure)

afterTest

open fun afterTest(closure: Closure)

appendParallelSafeAction

open fun appendParallelSafeAction(action: Action<in Task>)

beforeSuite

open fun beforeSuite(closure: Closure)

beforeTest

open fun beforeTest(closure: Closure)

bootstrapClasspath

open fun bootstrapClasspath(classpath: Array<Any>): Test

compareTo

open fun compareTo(otherTask: Task): Int

configure

open fun configure(closure: Closure): Task

abstract fun configure(cl: Closure): T

configure

inline fun <T : Any> ExtensionAware.configure(noinline configuration: T.() -> Unit)

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

conventionMapping

open fun conventionMapping(property: String, mapping: Callable<out Any>): Task

copyTo

open fun copyTo(target: JavaForkOptions): Test

open fun copyTo(target: ProcessForkOptions): Test

debugOptions

open fun debugOptions(action: Action<JavaDebugOptions>)

dependsOn

open fun dependsOn(paths: Array<Any>): Task

doFirst

open fun doFirst(action: Action<in Task>): Task

doLast

open fun doLast(action: Action<in Task>): Task

doNotTrackState

open fun doNotTrackState(reasonNotToTrackState: String)

environment

open fun environment(environmentVariables: Map<String, out Any>): Test

open fun environment(name: String, value: Any): Test

environment

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.

exclude

open fun exclude(excludeSpec: Closure): Test

open fun exclude(excludeSpec: Spec<FileTreeElement>): Test

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.

executable

open fun executable(executable: Any): Test

executeTests

open fun executeTests()

filter

open fun filter(action: Action<TestFilter>)

Executes the action against the getFilter.

finalizedBy

open fun finalizedBy(paths: Array<Any>): Task

getActions

open fun getActions(): List<Action<in Task>>

getAllJvmArgs

open fun getAllJvmArgs(): List<String>

getAnt

open fun getAnt(): AntBuilder

getAsDynamicObject

open fun getAsDynamicObject(): DynamicObject

getBootstrapClasspath

open fun getBootstrapClasspath(): FileCollection

getCandidateClassFiles

@InputFiles

@SkipWhenEmpty

@IgnoreEmptyDirectories

@PathSensitive(value = PathSensitivity.RELATIVE)

open fun getCandidateClassFiles(): FileTree

Returns the classes files to scan for test classes.

getConvention

open fun getConvention(): Convention

getDebug

open fun getDebug(): Boolean

getDebugOptions

open fun getDebugOptions(): JavaDebugOptions

getDefaultCharacterEncoding

open fun getDefaultCharacterEncoding(): String

getDependsOn

open fun getDependsOn(): Set<Any>

getDestroyables

open fun getDestroyables(): TaskDestroyables

getDidWork

open fun getDidWork(): Boolean

getDryRun

@Incubating

@Input

abstract fun getDryRun(): Property<Boolean>

Indicates if this task will skip individual test execution.

getEnableAssertions

open fun getEnableAssertions(): Boolean

getEnvironment

@Internal

open fun getEnvironment(): Map<String, Any>

getExcludes

@Internal

open fun getExcludes(): Set<String>

Returns the exclude patterns for test execution.

getExecutable

@Internal

open fun getExecutable(): String

getExtensions

open fun getExtensions(): ExtensionContainer

getFailFast

open fun getFailFast(): Boolean

Indicates if this task will fail on the first failed test

getFilter

open fun getFilter(): TestFilter

getFinalizedBy

open fun getFinalizedBy(): TaskDependency

getIdentityPath

open fun getIdentityPath(): Path

getIncludes

@Internal

open fun getIncludes(): Set<String>

Returns the include patterns for test execution.

getInputs

open fun getInputs(): TaskInputsInternal

abstract fun getInputs(): TaskInputs

getJavaVersion

@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.

getJvmArgs