ConfigurableLauncher<TestLauncher>
, LongRunningOperation
public interface TestLauncher extends ConfigurableLauncher<TestLauncher>
TestLauncher
allows you to execute tests in a Gradle build.Modifier and Type | Method | Description |
---|---|---|
TestLauncher |
debugTestsOn(int port) |
Configures test JVM to run in debug mode.
|
void |
run() |
Executes the tests, blocking until complete.
|
void |
run(ResultHandler<? super Void> handler) |
Starts executing the tests.
|
TestLauncher |
withJvmTestClasses(Iterable<String> testClasses) |
Adds tests to be executed declared by class name.
|
TestLauncher |
withJvmTestClasses(String... testClasses) |
Adds tests to be executed declared by class name.
|
TestLauncher |
withJvmTestMethods(String testClass,
Iterable<String> methods) |
Adds tests to be executed declared by class and methods name.
|
TestLauncher |
withJvmTestMethods(String testClass,
String... methods) |
Adds tests to be executed declared by class and method name.
|
TestLauncher |
withTaskAndTestClasses(String task,
Iterable<String> testClasses) |
Adds tests to be executed declared by the container task and the class name.
|
TestLauncher |
withTaskAndTestMethods(String task,
String testClass,
Iterable<String> methods) |
Adds tests to be executed declared by the container task, class and method name.
|
TestLauncher |
withTests(Iterable<? extends TestOperationDescriptor> descriptors) |
Adds tests to be executed by passing test descriptors received from a previous Gradle Run.
|
TestLauncher |
withTests(TestOperationDescriptor... descriptors) |
Adds tests to be executed by passing test descriptors received from a previous Gradle Run.
|
addArguments, addArguments, addJvmArguments, addJvmArguments, addProgressListener, addProgressListener, addProgressListener, addProgressListener, setColorOutput, setEnvironmentVariables, setJavaHome, setJvmArguments, setJvmArguments, setStandardError, setStandardInput, setStandardOutput, withArguments, withArguments, withCancellationToken
TestLauncher withTests(TestOperationDescriptor... descriptors)
descriptors
- The OperationDescriptor defining one or more tests.TestLauncher withTests(Iterable<? extends TestOperationDescriptor> descriptors)
descriptors
- The OperationDescriptor defining one or more tests.TestLauncher withJvmTestClasses(String... testClasses)
testClasses
- The class names of the tests to be executed.TestLauncher withJvmTestClasses(Iterable<String> testClasses)
testClasses
- The class names of the tests to be executed.TestLauncher withJvmTestMethods(String testClass, String... methods)
testClass
- The name of the class containing the methods to execute.methods
- The names of the test methods to be executed.TestLauncher withJvmTestMethods(String testClass, Iterable<String> methods)
testClass
- The name of the class containing the methods to execute.methods
- The names of the test methods to be executed.@Incubating TestLauncher withTaskAndTestClasses(String task, Iterable<String> testClasses)
Note: These tests are ignored for target Gradle version earlier than 6.1
task
- The path of the target task.testClasses
- The class names of the tests to be executed.@Incubating TestLauncher withTaskAndTestMethods(String task, String testClass, Iterable<String> methods)
Note: These tests are ignored for target Gradle version earlier than 6.1
task
- The path of the target task.testClass
- The name of the class containing the methods to execute.methods
- The names of the test methods to be executed.@Incubating TestLauncher debugTestsOn(int port)
When called, the forked test JVM is launched with the following argument:
-agentlib:jdwp=transport=dt_socket,server=n,suspend=n,address=localhost:<port>This means the test JVM expects a debugger at the specified port that uses a socket listening connector. If the debugger is not present then the test execution will fail.
Invoking this method adjusts the test task to launch only one JVM. More specifically, the parallel execution
gets disabled and the forkEvery
property is set to 0.
port
- the target port where the test JVM expects the debuggervoid run() throws TestExecutionException
TestExecutionException
- when one or more tests fail, or no tests for execution declared or no matching tests can be found.UnsupportedVersionException
- When the target Gradle version does not support test execution.UnsupportedBuildArgumentException
- When there is a problem with build arguments provided by ConfigurableLauncher.withArguments(String...)
.UnsupportedOperationConfigurationException
- When the target Gradle version does not support some requested configuration option.BuildException
- On some failure while executing the tests in the Gradle build.BuildCancelledException
- When the operation was cancelled before it completed successfully.GradleConnectionException
- On some other failure using the connection.IllegalStateException
- When the connection has been closed or is closing.void run(ResultHandler<? super Void> handler)
If the operation fails, the handler's ResultHandler.onFailure(GradleConnectionException)
method is called with the appropriate exception. See run()
for a description of the various exceptions that the operation may fail with.
handler
- The handler to supply the result to.IllegalStateException
- When the connection has been closed or is closing.