# Package-level declarations

The unit testing org.gradle.api.Task implementations.

## Types

AbstractTestTask
Link copied to clipboard
@DisableCachingByDefault(because = "Abstract super-class, not to be instantiated directly")
abstract class AbstractTestTask : ConventionTask, VerificationTask, Reporting<TestTaskReports>
Abstract class for all test tasks.
AggregateTestReport
Link copied to clipboard
@Incubating
interface AggregateTestReport : ReportSpec
A container for the inputs of an aggregated test report.
GroupTestEventReporter
Link copied to clipboard
@Incubating
interface GroupTestEventReporter : TestEventReporter
Reports test events, and child test event reporters.
JUnitXmlReport
Link copied to clipboard
interface JUnitXmlReport : DirectoryReport
The JUnit XML files, commonly used to communicate results to CI servers.
Test
Link copied to clipboard
@NullMarked
@CacheableTask
abstract class Test : AbstractTestTask, JavaForkOptions, PatternFilterable
Executes JUnit (3.8.x, 4.x or 5.x) or TestNG tests.
TestDescriptor
Link copied to clipboard
@NullMarked
interface TestDescriptor
Describes a test.
TestEventReporter
Link copied to clipboard
@Incubating
interface TestEventReporter : AutoCloseable
Reports test events.
TestEventReporterFactory
Link copied to clipboard
@ServiceScope(value = Build::class)
@Incubating
interface TestEventReporterFactory
A service that provides access to the test event reporting API.
TestExecutionException
Link copied to clipboard
open class TestExecutionException : GradleException
A `TestExecutionException` is thrown when no tests can be found that match the specified test filters.
TestFailure
Link copied to clipboard
@Incubating
abstract class TestFailure
Describes a test failure.
TestFailureDetails
Link copied to clipboard
@Incubating
interface TestFailureDetails
Contains serializable structural information about a test failure.
TestFileAttachmentDataEvent
Link copied to clipboard
@Incubating
@NullMarked
interface TestFileAttachmentDataEvent : TestMetadataEvent
File attachment data published by a test.
TestFilter
Link copied to clipboard
interface TestFilter
Allows filtering tests for execution.
TestFrameworkOptions
Link copied to clipboard
abstract class TestFrameworkOptions
The base class for any test framework specific options.
TestKeyValueDataEvent
Link copied to clipboard
@Incubating
@NullMarked
interface TestKeyValueDataEvent : TestMetadataEvent
Key-value data published by a test.
TestListener
Link copied to clipboard
interface TestListener
Interface for listening to test execution.
TestMetadataEvent
Link copied to clipboard
@NullMarked
interface TestMetadataEvent
Metadata captured during the execution of a test.
TestMetadataListener
Link copied to clipboard
@NullMarked
@Incubating
interface TestMetadataListener
Listens to the metadata events like reporting key-value pairs or file attachments during test execution.
TestOutputEvent
Link copied to clipboard
interface TestOutputEvent
Standard output or standard error message logged during the execution of the test
TestOutputListener
Link copied to clipboard
interface TestOutputListener
Listens to the output events like printing to standard output or error
TestReport
Link copied to clipboard
@DisableCachingByDefault(because = "Not made cacheable, yet")
abstract class TestReport : DefaultTask
Generates an HTML test report from the results of one or more Test tasks.
TestResult
Link copied to clipboard
interface TestResult
Describes a test result.
TestTaskReports
Link copied to clipboard
interface TestTaskReports : ReportContainer<Report>
The reports produced by the Test task.