gradle/org.gradle.api.tasks.testing/AbstractTestTask

AbstractTestTask

@DisableCachingByDefault(because = "Abstract super-class, not to be instantiated directly")

abstract class AbstractTestTask : ConventionTask, VerificationTask, Reporting<T> (source)

Abstract class for all test tasks.

Support for test listeners
Support for reporting
Support for report linking in the console output

Note: This abstract class is not intended for implementation by build script or plugin authors.

Since

4.4

Inheritors

XCTest

Test

Constructors

AbstractTestTask

constructor()

Properties

binaryResultsDirectory

@get:OutputDirectory

val binaryResultsDirectory: DirectoryProperty

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.

group

open var group: String

ignoreFailures

@get:Internal

open var ignoreFailures: Boolean

impliesSubProjects

open var impliesSubProjects: Boolean

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"

testLogging

@get:Internal

val testLogging: TestLoggingContainer

timeout

val timeout: Property<Duration>

Functions

acceptServiceReferences

open fun acceptServiceReferences(serviceReferences: Set<ServiceReferenceSpec>)

addTestListener

open fun addTestListener(listener: TestListener)

Registers a test listener with this task.

addTestOutputListener

open fun addTestOutputListener(listener: TestOutputListener)

Registers a output listener with this task.

afterSuite

open fun afterSuite(closure: Closure)

Adds a closure to be notified after a test suite has executed.

afterTest

open fun afterTest(closure: Closure)

Adds a closure to be notified after a test has executed.

appendParallelSafeAction

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

beforeSuite

open fun beforeSuite(closure: Closure)

Adds a closure to be notified before a test suite is executed.

beforeTest

open fun beforeTest(closure: Closure)

Adds a closure to be notified before a test is executed.

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

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)

executeTests

open fun executeTests()

finalizedBy

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

getActions

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

getAnt

open fun getAnt(): AntBuilder

getAsDynamicObject

open fun getAsDynamicObject(): DynamicObject

getConvention

open fun getConvention(): Convention

getDependsOn

open fun getDependsOn(): Set<Any>

getDestroyables

open fun getDestroyables(): TaskDestroyables

getDidWork

open fun getDidWork(): Boolean

getExtensions

open fun getExtensions(): ExtensionContainer

getFilter

open fun getFilter(): TestFilter

Allows filtering tests for execution.

getFinalizedBy

open fun getFinalizedBy(): TaskDependency

getIdentityPath

open fun getIdentityPath(): Path

getIgnoreFailures

abstract fun getIgnoreFailures(): Boolean

getInputs

open fun getInputs(): TaskInputsInternal

abstract fun getInputs(): TaskInputs

getLifecycleDependencies

open fun getLifecycleDependencies(): TaskDependencyInternal

abstract fun getLifecycleDependencies(): TaskDependency

getLocalState

open fun getLocalState(): TaskLocalState

getLogger

open fun getLogger(): Logger

getLogging

open fun getLogging(): LoggingManager

getMustRunAfter

open fun getMustRunAfter(): TaskDependency

getName

open fun getName(): String

getOnlyIf

open fun getOnlyIf(): Spec<in TaskInternal>

getOutputs

open fun getOutputs(): TaskOutputsInternal

abstract fun getOutputs(): TaskOutputs

getPath

open fun getPath(): String

getProject

open fun getProject(): Project

getReasonNotToTrackState

open fun getReasonNotToTrackState(): Optional<String>

getReasonTaskIsIncompatibleWithConfigurationCache

open fun getReasonTaskIsIncompatibleWithConfigurationCache(): Optional<String>

getReports

abstract fun getReports(): T

getRequiredServices

open fun getRequiredServices(): TaskRequiredServices

getSharedResources

open fun getSharedResources(): List<ResourceLock>

abstract fun getSharedResources(): List<out ResourceLock>

getShouldRunAfter

open fun getShouldRunAfter(): TaskDependency

getStandardOutputCapture

open fun getStandardOutputCapture(): StandardOutputCapture

getState

abstract fun getState(): TaskState

getTaskActions

open fun getTaskActions(): List<InputChangesAwareTaskAction>

getTaskDependencies

open fun getTaskDependencies(): TaskDependencyInternal

abstract fun getTaskDependencies(): TaskDependency

getTaskIdentity

open fun getTaskIdentity(): TaskIdentity<out Any>

getTemporaryDir

open fun getTemporaryDir(): File

getTemporaryDirFactory

open fun getTemporaryDirFactory(): Factory<File>

hasProperty

open fun hasProperty(propertyName: String): Boolean

hasTaskActions

open fun hasTaskActions(): Boolean

injectIntoNewInstance

open fun <T : Task?> injectIntoNewInstance(project: ProjectInternal, identity: TaskIdentity<T>, factory: Callable<T>): T

isCompatibleWithConfigurationCache

open fun isCompatibleWithConfigurationCache(): Boolean

isEnabled

open fun isEnabled(): Boolean

isHasCustomActions

open fun isHasCustomActions(): Boolean

mustRunAfter

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

notCompatibleWithConfigurationCache

open fun notCompatibleWithConfigurationCache(reason: String)

onlyIf

open fun onlyIf(spec: Spec<in Task>)

onOutput

open fun onOutput(closure: Closure)

Adds a closure to be notified when output from the test received.

prependParallelSafeAction

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

property

open fun property(propertyName: String): Any

removeTestListener

open fun removeTestListener(listener: TestListener)

Unregisters a test listener with this task.

removeTestOutputListener

open fun removeTestOutputListener(listener: TestOutputListener)

Unregisters a test output listener with this task.

reports

open fun reports(closure: Closure): TestTaskReports

open fun reports(configureAction: Action<in TestTaskReports>): TestTaskReports

Configures the reports that this task potentially produces.

setActions

open fun setActions(replacements: List<Action<in Task>>)

setDependsOn

open fun setDependsOn(dependsOn: Iterable<out Any>)

setDidWork

open fun setDidWork(didWork: Boolean)

setFinalizedBy

open fun setFinalizedBy(finalizedByTasks: Iterable<out Any>)

setIgnoreFailures

abstract fun setIgnoreFailures(ignoreFailures: Boolean)

setMustRunAfter

open fun setMustRunAfter(mustRunAfterTasks: Iterable<out Any>)

setOnlyIf

open fun setOnlyIf(spec: Spec<in Task>)

setProperty

open fun setProperty(name: String, value: Any)

setShouldRunAfter

open fun setShouldRunAfter(shouldRunAfterTasks: Iterable<out Any>)

setTestNameIncludePatterns

open fun setTestNameIncludePatterns(testNamePattern: List<String>): AbstractTestTask

Sets the test name patterns to be included in execution.

shouldRunAfter

open fun shouldRunAfter(paths: Array<Any>): TaskDependency

testLogging

open fun testLogging(@DelegatesTo(value = TestLoggingContainer::class) closure: Closure)

open fun testLogging(action: Action<in TestLoggingContainer>)

Allows configuring the logging of the test execution, for example log eagerly the standard output, etc.

the

inline fun <T : Any> ExtensionAware.the(): T

Returns the extension of the specified type.

fun <T : Any> ExtensionAware.the(extensionType: KClass<T>): T

Returns the extension of the specified extensionType.

usesService

open fun usesService(service: Provider<out BuildService<out Any>>)