Test

The full set of arguments to use to launch the JVM for the process. This includes arguments to define system properties, the minimum/maximum heap size, and the bootstrap classpath.

The root directory property for the test results in internal binary format.

The bootstrap classpath to use for the process. The default bootstrap classpath for the JVM is used when this classpath is empty.

The classpath to use to execute the tests.

Determines whether debugging is enabled for the test process. When enabled — debug = true — the process is started in a suspended state, listening on port 5005. You should disable parallel test execution when debugging and you will need to reattach the debugger occasionally if you use a non-zero value for Test.getForkEvery().

Since Gradle 5.6, you can configure the port and other Java debug properties via JavaForkOptions.debugOptions(org.gradle.api.Action).

The Java Debug Wire Protocol properties for the process. If enabled then the -agentlib:jdwp=... will be appended to the JVM arguments with the configuration from the parameter.

Indicates if this task will skip individual test execution.

For JUnit 4 and 5, this will report tests that would have executed as skipped. For TestNG, this will report tests that would have executed as passed.

Only versions of TestNG which support native dry-running are supported, i.e. TestNG 6.14 or later.

Returns true if assertions are enabled for the process.

The environment variables to use for the process. Defaults to the environment of this process.

The exclude patterns for test execution.

The name of the executable to use.

Indicates if this task will fail on the first failed test

The maximum number of test classes to execute in a forked test process. The forked test process will be restarted when this limit is reached.

By default, Gradle automatically uses a separate JVM when executing tests.

This property can have a large impact on performance due to the cost of stopping and starting each test process. It is unusual for this property to be changed from the default.

Specifies whether the build should break when the verifications performed by this task fail.

The include patterns for test execution.

Configures the java executable to be used to run the tests.

The extra arguments to use to launch the JVM for the process. Does not include system properties and the minimum/maximum heap size.

Command line argument providers for the java process to fork.

The maximum heap size for the process, if any.

The maximum number of test processes to start in parallel.

By default, Gradle executes a single test class at a time.

This property cannot exceed the value of max-workers for the current build. Gradle will also limit the number of started test processes across all Test tasks.

The minimum heap size for the process, if any.

The module path handling of this test task.

Returns test framework specific options. Make sure to call Test.useJUnit(), Test.useJUnitPlatform() or Test.useTestNG() before using this method.

The reports that this task potentially produces.

Specifies whether test classes should be detected. When true the classes which match the include and exclude patterns are scanned for test classes, and any found are executed. When false the classes which match the include and exclude patterns are executed.

The system properties which will be used for the process.

The directories for the compiled test sources.

Allows to set options related to which test events are logged to the console, and on which detail level. For example, to show more information about exceptions use:

apply plugin: 'java'

test.testLogging {
    exceptionFormat = "full"
}

For further information see TestLoggingContainer.

The working directory for the process. Defaults to the project directory.

The JacocoTaskExtension added by the jacoco plugin.

Registers a test listener with this task. Consider also the following handy methods for quicker hooking into test execution: AbstractTestTask.beforeTest(groovy.lang.Closure), AbstractTestTask.afterTest(groovy.lang.Closure), AbstractTestTask.beforeSuite(groovy.lang.Closure), AbstractTestTask.afterSuite(groovy.lang.Closure)

This listener will NOT be notified of tests executed by other tasks. To get that behavior, use Gradle.addListener(java.lang.Object).

Registers a output listener with this task. Quicker way of hooking into output events is using the AbstractTestTask.onOutput(groovy.lang.Closure) method.

Adds a closure to be notified after a test suite has executed. A TestDescriptor and TestResult instance are passed to the closure as a parameter.

This method is also called after all test suites are executed. The provided descriptor will have a null parent suite.

Adds a closure to be notified after a test has executed. A TestDescriptor and TestResult instance are passed to the closure as a parameter.

Adds a closure to be notified before a test suite is executed. A TestDescriptor instance is passed to the closure as a parameter.

This method is also called before any test suites are executed. The provided descriptor will have a null parent suite.

Adds a closure to be notified before a test is executed. A TestDescriptor instance is passed to the closure as a parameter.

Adds the given values to the end of the bootstrap classpath for the process.

Copies these options to the given options.

Copies these options to the given target options.

Configures Java Debug Wire Protocol properties for the process. If JavaForkOptions.setDebug(boolean) is enabled then the -agentlib:jdwp=... will be appended to the JVM arguments with the configuration from the parameter.

Adds an environment variable to the environment for this process.

Adds some environment variables to the environment for this process.

Adds an exclude spec. This method may be called multiple times to append new specs.The given closure is passed a FileTreeElement as its parameter. The closure should return true or false. Example:

copySpec {
  from 'source'
  into 'destination'
  //an example of excluding files from certain configuration:
  exclude { it.file in configurations.someConf.files }
}

If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any exclude pattern to be processed.

Adds exclude patterns for the files in the test classes directory (e.g. '**/*Test.class')).

Adds exclude patterns for the files in the test classes directory (e.g. '**/*Test.class')).

Adds an exclude spec. This method may be called multiple times to append new specs. If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any exclude pattern to be processed.

Sets the name of the executable to use.

Adds an include spec. This method may be called multiple times to append new specs. The given closure is passed a FileTreeElement as its parameter. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns or specs to be included.

Adds include patterns for the files in the test classes directory (e.g. '**/*Test.class')).

Adds include patterns for the files in the test classes directory (e.g. '**/*Test.class')).

Adds an include spec. This method may be called multiple times to append new specs. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns or specs to be included.

Adds some arguments to use to launch the JVM for the process.

Adds some arguments to use to launch the JVM for the process.

Adds a closure to be notified when output from the test received. A TestDescriptor and TestOutputEvent instance are passed to the closure as a parameter.

apply plugin: 'java'

test {
   onOutput { descriptor, event ->
       if (event.destination == TestOutputEvent.Destination.StdErr) {
           logger.error("Test: " + descriptor + ", error: " + event.message)
       }
   }
}

Configures test framework specific options.

When a Test task is created outside of Test Suites, you should call Test.useJUnit(), Test.useJUnitPlatform() or Test.useTestNG() before using this method. If no test framework has been set, the task will assume JUnit4.

Unregisters a test listener with this task. This method will only remove listeners that were added by calling AbstractTestTask.addTestListener(org.gradle.api.tasks.testing.TestListener) on this task. If the listener was registered with Gradle using Gradle.addListener(java.lang.Object) this method will not do anything. Instead, use Gradle.removeListener(java.lang.Object).

Unregisters a test output listener with this task. This method will only remove listeners that were added by calling AbstractTestTask.addTestOutputListener(org.gradle.api.tasks.testing.TestOutputListener) on this task. If the listener was registered with Gradle using Gradle.addListener(java.lang.Object) this method will not do anything. Instead, use Gradle.removeListener(java.lang.Object).

Configures the reports that this task potentially produces.

Sets the test name patterns to be included in execution. Classes or method names are supported, wildcard '*' is supported. For more information see the user guide chapter on testing. For more information on supported patterns see TestFilter

Adds some system properties to use for the process.

Specifies that JUnit4 should be used to discover and execute the tests.

Specifies that JUnit4 should be used to discover and execute the tests with additional configuration.

The supplied action configures an instance of JUnitOptions.

Specifies that JUnit4 should be used to discover and execute the tests with additional configuration.

The supplied action configures an instance of JUnitOptions.

Specifies that JUnit Platform should be used to discover and execute the tests.

Use this option if your tests use JUnit Jupiter/JUnit5.

JUnit Platform supports multiple test engines, which allows other testing frameworks to be built on top of it. You may need to use this option even if you are not using JUnit directly.

Specifies that JUnit Platform should be used to discover and execute the tests with additional configuration.

Use this option if your tests use JUnit Jupiter/JUnit5.

JUnit Platform supports multiple test engines, which allows other testing frameworks to be built on top of it. You may need to use this option even if you are not using JUnit directly.

The supplied action configures an instance of JUnitPlatformOptions.

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.

The supplied action configures an instance of TestNGOptions.

Specifies that TestNG should be used to discover and execute the tests with additional configuration.

The supplied action configures an instance of TestNGOptions.

Sets the working directory for the process. The supplied argument is evaluated as per Project.file(java.lang.Object).

Configures test framework specific options.

When a Test task is created outside of Test Suites, you should call Test.useJUnit(), Test.useJUnitPlatform() or Test.useTestNG() before using this method. If no test framework has been set, the task will assume JUnit4.

Configures the JacocoTaskExtension added by the jacoco plugin.