gradle

9.1.0-20250628022042+0000

gradle/org.gradle.tooling/TestLauncher

TestLauncher

interface TestLauncher : ConfigurableLauncher<T> (source)

A TestLauncher allows you to execute tests in a Gradle build.

If the target Gradle version is >=6.8 then you can use TestLauncher to execute tests from included builds. Test operation descriptors from included builds work out-of-the-box. You can target tasks from included builds by specifying the task identity path (i.e. ':included-build-name:subproject-name:taskName').

However, you cannot use the methods with included builds that don't specify the target test tasks (e.g. withJvmTestClasses() and withJvmTestMethods()). Those methods configure all test tasks in the root build only.

Since

2.6

Functions

abstract fun addArguments(arguments: Array<String>): T

abstract fun addArguments(arguments: Array<String>): LongRunningOperation

addJvmArguments

abstract fun addJvmArguments(jvmArguments: Array<String>): T

abstract fun addJvmArguments(jvmArguments: Array<String>): LongRunningOperation

addProgressListener

abstract fun addProgressListener(listener: ProgressListener): T

abstract fun addProgressListener(listener: ProgressListener): LongRunningOperation

abstract fun debugTestsOn(port: Int): TestLauncher

Configures test JVM to run in debug mode.

abstract fun forTasks(tasks: Array<String>): TestLauncher

Sets the tasks to be executed.

abstract fun run()

Executes the tests, blocking until complete.

abstract fun run(handler: ResultHandler<in Void>)

Starts executing the tests.

abstract fun setColorOutput(colorOutput: Boolean): T

abstract fun setColorOutput(colorOutput: Boolean): LongRunningOperation

setEnvironmentVariables

abstract fun setEnvironmentVariables(envVariables: Map<String, String>): T

abstract fun setEnvironmentVariables(envVariables: @Nullable Map<String, String>): LongRunningOperation

abstract fun setJavaHome(javaHome: File): T

abstract fun setJavaHome(javaHome: @Nullable File): LongRunningOperation

setJvmArguments

abstract fun setJvmArguments(jvmArguments: Array<String>): T

abstract fun setJvmArguments(jvmArguments: Array<@Nullable String>): LongRunningOperation

setStandardError

abstract fun setStandardError(outputStream: OutputStream): T

abstract fun setStandardError(outputStream: OutputStream): LongRunningOperation

setStandardInput

abstract fun setStandardInput(inputStream: InputStream): T

abstract fun setStandardInput(inputStream: InputStream): LongRunningOperation

setStandardOutput

abstract fun setStandardOutput(outputStream: OutputStream): T

abstract fun setStandardOutput(outputStream: OutputStream): LongRunningOperation

abstract fun withArguments(arguments: Array<String>): T

abstract fun withArguments(arguments: Array<@Nullable String>): LongRunningOperation

withCancellationToken

abstract fun withCancellationToken(cancellationToken: CancellationToken): T

abstract fun withCancellationToken(cancellationToken: CancellationToken): LongRunningOperation

withDetailedFailure

abstract fun withDetailedFailure(): T

abstract fun withDetailedFailure(): LongRunningOperation

withJvmTestClasses

abstract fun withJvmTestClasses(testClasses: Iterable<String>): TestLauncher

abstract fun withJvmTestClasses(testClasses: Array<String>): TestLauncher

Adds tests to be executed declared by class name.

withJvmTestMethods

abstract fun withJvmTestMethods(testClass: String, methods: Iterable<String>): TestLauncher

Adds tests to be executed declared by class and methods name.

abstract fun withJvmTestMethods(testClass: String, methods: Array<String>): TestLauncher

Adds tests to be executed declared by class and method name.

withSystemProperties

abstract fun withSystemProperties(systemProperties: Map<String, String>): T

abstract fun withSystemProperties(systemProperties: Map<String, String>): LongRunningOperation

withTaskAndTestClasses

abstract fun withTaskAndTestClasses(task: String, testClasses: Iterable<String>): TestLauncher

Adds tests to be executed declared by the container task and the class name.

withTaskAndTestMethods

abstract fun withTaskAndTestMethods(task: String, testClass: String, methods: Iterable<String>): TestLauncher

Adds tests to be executed declared by the container task, class and method name.

abstract fun withTests(descriptors: Iterable<out TestOperationDescriptor>): TestLauncher

abstract fun withTests(descriptors: Array<TestOperationDescriptor>): TestLauncher

Adds tests to be executed by passing test descriptors received from a previous Gradle Run.

abstract fun withTestsFor(testSpec: Action<TestSpecs>): TestLauncher

Adds tests to be executed declared using a fine-grained test selection API.