AgpTestSuite

@Incubating
interface AgpTestSuite : TestSuite

A test suite that runs with the Android Gradle Plugin.

An AgpTestSuite can run against a single or multiple variants. Users should use com.android.build.api.dsl.AgpTestSuite.targetVariants to identify the final list of variants that will be tested.

Although this is not strictly necessary, if the test suite has source code, it will be recompiled for each variant it targets. This is to ensure the compatibility of the test suite with each variant individually.

Defines how different types of source files are organized and declared for a test suite within the Android Gradle Plugin. Test suites can incorporate various kinds of sources, each serving a distinct purpose and following specific conventions.

All sources for a given test suite (e.g., one named myTestSuite) are typically organized under the src/myTestSuite/ directory, relative to the module's root. Within this directory, specific source types will reside in conventional subdirectories.

Three primary types of sources can be associated with a test suite using the methods on this interface:

1. Asset Test Sources (configured via assets):

• Content: A single folder containing static files like XML, JSON, or other declarative resources that describe or support tests. These files are not compiled.

• Purpose: Typically interpreted directly by test execution engines (e.g., JUnit).

• Default Location: src/<testSuiteName>/assets/

2. Host Test Sources (configured via hostJar):

• Content: A single folder containing compilable source code (e.g., Kotlin or Java) intended for tests that run on the host machine (JVM).

• Purpose: Compiled before test execution. The compiled classes are then used by test engines.

• Default Location: src/<testSuiteName>/ (which would then contain standard source layouts like java/, kotlin/, resources/)

3. Device Test Sources (configured via testApk):

• Content: A standard Android source set structure, including compilable source code (Kotlin/Java), Android resources (res/), Android assets (assets/), and an AndroidManifest.xml file.

• Purpose: Compiled into a test APK that runs on an Android device or emulator.

• Default Location: src/<testSuiteName>/androidTest/ (which would then contain standard Android source layouts like java/, res/, assets/, etc.)

Configuration Notes:

• A test suite can include one or more of these source types. For example, a suite might define both hostTest sources and assetTest sources.

• Currently, it is not possible to declare the same type of source (e.g., two hostTest blocks) for a single test suite.

• Future versions of this API may introduce more flexibility, such as allowing multiple instances of the same source type or providing ways to customize the default directory names.

Test execution engines can retrieve the locations or outputs of these configured sources through properties defined in com.android.build.api.variant.AgpTestSuiteInputParameters (e.g., STATIC_FILES, TEST_CLASSES, TESTED_APKS). *

Summary

@Incubating
fun assets(action: TestSuiteAssetsSpec.() -> Unit): Unit

@Incubating
fun configureTestTasks(action: Test.(context: TestTaskContext) -> Unit): Unit

@Incubating
fun getTargets(): NamedDomainObjectContainer<AgpTestSuiteTarget>

@Incubating
fun hostJar(action: TestSuiteHostJarSpec.() -> Unit): Unit

@Incubating
fun testApk(action: TestSuiteTestApkSpec.() -> Unit): Unit

@Incubating
fun useJunitEngine(action: JUnitEngineSpec.() -> Unit): Unit

val targetVariants: MutableList<String>

val useJunitEngine: JUnitEngineSpec