Test
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
Properties
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Constructor arguments for the Task
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Functions
Link copied to clipboard
Link copied to clipboard
Registers a test listener with this task.
Link copied to clipboard
Registers a metadata listener with this task.
Link copied to clipboard
Registers a output listener with this task.
Link copied to clipboard
Adds a closure to be notified after a test suite has executed.
Link copied to clipboard
Link copied to clipboard
Adds a closure to be notified before a test suite is executed.
Link copied to clipboard
Adds a closure to be notified before a test is executed.
Link copied to clipboard
Adds the given values to the end of the bootstrap classpath for the process.
Link copied to clipboard
Link copied to clipboard
Copies these options to the given options.
Copies these options to the given target options.
Link copied to clipboard
Configures Java Debug Wire Protocol properties for the process.
Link copied to clipboard
Adds the given closure to the beginning of this task's action list.
Adds the given Action to the beginning of this task's action list.
Link copied to clipboard
Adds the given closure to the end of this task's action list.
Adds the given Action to the end of this task's action list.
Link copied to clipboard
Do not track the state of the task.
Link copied to clipboard
Link copied to clipboard
Adds some environment variables to the environment for this process.
Adds an environment variable to the environment for this process.
Link copied to clipboard
Link copied to clipboard
Sets the name of the executable to use.
Link copied to clipboard
Link copied to clipboard
Executes the action against the getFilter.
Link copied to clipboard
Adds the given finalizer tasks for this task.
Link copied to clipboard
Returns the sequence of Action objects which will be executed by this task, in the order of execution.
Link copied to clipboard
Returns the full set of arguments to use to launch the JVM for the process.
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Returns the root directory property for the test results in internal binary format.
Link copied to clipboard
Returns the bootstrap classpath to use for the process.
Link copied to clipboard
Returns the classes files to scan for test classes.
Link copied to clipboard
Returns the Java Debug Wire Protocol properties for the process.
Link copied to clipboard
Returns the default character encoding to use.
Link copied to clipboard
Returns the dependencies of this task.
Link copied to clipboard
Returns the destroyables of this task.
Link copied to clipboard
Checks if the task actually did any work.
Link copied to clipboard
Returns true if assertions are enabled for the process.
Link copied to clipboard
The environment variables to use for the process.
Link copied to clipboard
Returns the exclude patterns for test execution.
Link copied to clipboard
Returns the name of the executable to use.
Link copied to clipboard
The container of extensions.
Link copied to clipboard
Indicates if this task will fail on the first failed test
Link copied to clipboard
Whether the task should fail if test sources are present, but no tests are discovered during test execution.
Link copied to clipboard
Allows filtering tests for execution.
Link copied to clipboard
Returns tasks that finalize this task.
Link copied to clipboard
Link copied to clipboard
Returns the include patterns for test execution.
Link copied to clipboard
Configures the java executable to be used to run the tests.
Link copied to clipboard
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
Returns the extra arguments to use to launch the JVM for the process.
Link copied to clipboard
Command line argument providers for the java process to fork.
Link copied to clipboard
Link copied to clipboard
Returns the local state of this task.
Link copied to clipboard
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
Returns the maximum heap size for the process, if any.
Link copied to clipboard
Returns the minimum heap size for the process, if any.
Link copied to clipboard
Returns tasks that this task must run after.
Link copied to clipboard
Returns test framework specific options.
Link copied to clipboard
Returns the outputs of this task.
Link copied to clipboard
Returns the Project which this task belongs to.
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
A ReportContainer instance.
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Returns tasks that this task should run after.
Link copied to clipboard
Link copied to clipboard
Returns the system properties which will be used for the process.
Link copied to clipboard
Link copied to clipboard
Returns a TaskDependency which contains all the tasks that this task depends on.
Link copied to clipboard
Link copied to clipboard
Returns a directory which this task can use to write temporary files to.
Link copied to clipboard
Link copied to clipboard
Returns directories to scan for non-class-based test definition files.
Link copied to clipboard
Link copied to clipboard
Returns the configured TestFramework.
Link copied to clipboard
Returns the working directory for the process.
Link copied to clipboard
Determines if this task has the given property.
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Specifies whether test classes should be detected.
Link copied to clipboard
Specifies that this task must run after all of the supplied tasks.
Link copied to clipboard
Specifies that this task is not compatible with the configuration cache.
Link copied to clipboard
Execute the task only if the given closure returns true.
Execute the task only if the given spec is satisfied.
Link copied to clipboard
open fun options(@DelegatesTo(value = TestFrameworkOptions::class ) testFrameworkConfigure: Closure): TestFrameworkOptions
Configures test framework specific options.
Link copied to clipboard
Link copied to clipboard
Unregisters a test listener with this task.
Link copied to clipboard
Unregisters a test metadata listener with this task.
Link copied to clipboard
Unregisters a test output listener with this task.
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Sets the sequence of Action objects which will be executed by this task.
Link copied to clipboard
Sets the full set of arguments to use to launch the JVM for the process.
Link copied to clipboard
Sets the bootstrap classpath to use for the process.
Link copied to clipboard
Sets the default character encoding to use.
Link copied to clipboard
Sets the dependencies of this task.
Link copied to clipboard
Sets whether the task actually did any work.
Link copied to clipboard
Enable or disable assertions for the process.
Link copied to clipboard
Sets the environment variable to use for the process.
Link copied to clipboard
Sets the exclude patterns for test execution.
Link copied to clipboard
Sets the name of the executable to use.
Link copied to clipboard
Enables fail fast behavior causing the task to fail on the first failed test.
Link copied to clipboard
Specifies the set of finalizer tasks for this task.
Link copied to clipboard
Sets the include patterns for test execution.
Link copied to clipboard
Sets the extra arguments to use to launch the JVM for the process.
Link copied to clipboard
Sets the maximum heap size for the process.
Link copied to clipboard
Sets the minimum heap size for the process.
Link copied to clipboard
Specifies the set of tasks that this task must run after.
Link copied to clipboard
Execute the task only if the given closure returns true.
Execute the task only if the given spec is satisfied.
Link copied to clipboard
Sets a property of this task.
Link copied to clipboard
Link copied to clipboard
Specifies the set of tasks that this task should run after.
Link copied to clipboard
Sets the system properties to use for the process.
Link copied to clipboard
Sets the test name patterns to be included in execution.
Link copied to clipboard
Sets the working directory for the process.
Link copied to clipboard
Specifies that this task should run after all of the supplied tasks.
Link copied to clipboard
Adds some system properties to use for the process.
Link copied to clipboard
Adds a system property to use for the process.
Link copied to clipboard
Do not call this method.
Link copied to clipboard
Allows configuring the logging of the test execution, for example log eagerly the standard output, etc.
Link copied to clipboard
Specifies that JUnit4 should be used to discover and execute the tests.
open fun useJUnit(@Nullable @DelegatesTo(value = JUnitOptions::class ) testFrameworkConfigure: @Nullable Closure)
Specifies that JUnit4 should be used to discover and execute the tests with additional configuration.
Link copied to clipboard
Specifies that JUnit Platform should be used to discover and execute the tests.
Specifies that JUnit Platform should be used to discover and execute the tests with additional configuration.
Link copied to clipboard
Registers a BuildService that is used by this task so its constraint on parallel execution can be honored.
Link copied to clipboard
Specifies that TestNG should be used to discover and execute the tests.
Specifies that TestNG should be used to discover and execute the tests with additional configuration.
Link copied to clipboard
Sets the working directory for the process.