# AndroidTest # AndroidTest ``` @Incubating interface AndroidTest : TestComponent ``` |----------------------------------------------------------------------------------------------------------------------------------------------------------| | [com.android.build.api.component.AndroidTest](https://developer.android.com/reference/tools/gradle-api/4.2/com/android/build/api/component/AndroidTest#) | Properties for the android test Variant of a module. ## Summary | ### Public methods || |--------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | abstract[Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [aaptOptions](https://developer.android.com/reference/tools/gradle-api/4.2/com/android/build/api/component/AndroidTest#aaptOptions(kotlin.Function1))`(`action:` `[AaptOptions](https://developer.android.com/reference/tools/gradle-api/4.2/com/android/build/api/variant/AaptOptions.html#).()` `->` `[Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)` Variant's aaptOptions, initialized by the corresponding global DSL element. | | abstract[Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [addResValue](https://developer.android.com/reference/tools/gradle-api/4.2/com/android/build/api/component/AndroidTest#addResValue(kotlin.String,%20kotlin.String,%20kotlin.String,%20kotlin.String))`(`name:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `type:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `value:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `comment:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?`)` Adds a ResValue element to the generated resources. | | abstract[Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [addResValue](https://developer.android.com/reference/tools/gradle-api/4.2/com/android/build/api/component/AndroidTest#addResValue(kotlin.String,%20kotlin.String,%20org.gradle.api.provider.Provider,%20kotlin.String))`(`name:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `type:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `value:` `[Provider](https://docs.gradle.org/current/javadoc/org/gradle/api/provider/Provider.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>`, `comment:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?`)` Adds a ResValue element to the generated resources. | | abstract[Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [packagingOptions](https://developer.android.com/reference/tools/gradle-api/4.2/com/android/build/api/component/AndroidTest#packagingOptions(kotlin.Function1))`(`action:` `[ApkPackagingOptions](https://developer.android.com/reference/tools/gradle-api/4.2/com/android/build/api/variant/ApkPackagingOptions.html#).()` `->` `[Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)` Variant's packagingOptions, initialized by the corresponding global DSL element. | | abstract[Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [signingConfig](https://developer.android.com/reference/tools/gradle-api/4.2/com/android/build/api/component/AndroidTest#signingConfig(kotlin.Function1))`(`action:` `[SigningConfig](https://developer.android.com/reference/tools/gradle-api/4.2/com/android/build/api/variant/SigningConfig.html#).()` `->` `[Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)` Variant's signingConfig, initialized by the corresponding DSL element. | | ### Inherited functions || |---|---| | From class[Component](https://developer.android.com/reference/tools/gradle-api/4.2/com/android/build/api/component/Component) |------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [setAsmFramesComputationMode](https://developer.android.com/reference/tools/gradle-api/4.2/com/android/build/api/component/Component#setAsmFramesComputationMode(com.android.build.api.instrumentation.FramesComputationMode))`(`mode:` `[FramesComputationMode](https://developer.android.com/reference/tools/gradle-api/4.2/com/android/build/api/instrumentation/FramesComputationMode.html#)`)`
Sets the frame computation mode that will be applied to the bytecode of the classes instrumented by ASM visitors registered through[transformClassesWith](https://developer.android.com/reference/tools/gradle-api/4.2/com/android/build/api/component/Component#transformClassesWith(java.lang.Class,%20com.android.build.api.instrumentation.InstrumentationScope,%20kotlin.Function1)). The default mode is to[copy frames](https://developer.android.com/reference/tools/gradle-api/4.2/com/android/build/api/instrumentation/FramesComputationMode.html#ENUM_VALUE:COPY_FRAMES). When setting this multiple times, the mode with the highest enum value will be selected.
| | [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [transformClassesWith](https://developer.android.com/reference/tools/gradle-api/4.2/com/android/build/api/component/Component#transformClassesWith(java.lang.Class,%20com.android.build.api.instrumentation.InstrumentationScope,%20kotlin.Function1))`(`classVisitorFactoryImplClass:` `[Class](http://docs.oracle.com/javase/8/docs/api/java/lang/Class.html)>`, `scope:` `[InstrumentationScope](https://developer.android.com/reference/tools/gradle-api/4.2/com/android/build/api/instrumentation/InstrumentationScope.html#)`, `instrumentationParamsConfig:` `(ParamT)` `->` `[Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`)`
Registers an asm class visitor to instrument the classes defined by the given scope. An instance of the factory will be instantiated and used to create visitors for each class. Example: ```scdoc androidComponentsExtension.onVariants(selector().all(), { transformClassesWith(AsmClassVisitorFactoryImpl.class, InstrumentationScope.Project) { params -> params.x = "value" } setAsmFramesComputationMode(COMPUTE_FRAMES_FOR_INSTRUMENTED_METHODS) }) ``` This API is experimental and subject to breaking change and we strongly suggest you don't publish plugins that depend on it yet.
| || | ### Properties || |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | abstract[AaptOptions](https://developer.android.com/reference/tools/gradle-api/4.2/com/android/build/api/variant/AaptOptions.html#) | [aaptOptions](https://developer.android.com/reference/tools/gradle-api/4.2/com/android/build/api/component/AndroidTest#aaptOptions:com.android.build.api.variant.AaptOptions) Variant's aaptOptions, initialized by the corresponding global DSL element. | | abstract[Property](https://docs.gradle.org/current/javadoc/org/gradle/api/provider/Property.html)\<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)\> | [applicationId](https://developer.android.com/reference/tools/gradle-api/4.2/com/android/build/api/component/AndroidTest#applicationId:org.gradle.api.provider.Property) Variant's application ID as present in the final manifest file of the APK. | | abstract[MapProperty](https://docs.gradle.org/current/javadoc/org/gradle/api/provider/MapProperty.html)\<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html),out[BuildConfigField](https://developer.android.com/reference/tools/gradle-api/4.2/com/android/build/api/variant/BuildConfigField.html#)\\> | [buildConfigFields](https://developer.android.com/reference/tools/gradle-api/4.2/com/android/build/api/component/AndroidTest#buildConfigFields:org.gradle.api.provider.MapProperty) Variant's[BuildConfigField](https://developer.android.com/reference/tools/gradle-api/4.2/com/android/build/api/variant/BuildConfigField.html#)which will be generated in the BuildConfig class. | | abstract[Property](https://docs.gradle.org/current/javadoc/org/gradle/api/provider/Property.html)\<[Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)\> | [functionalTest](https://developer.android.com/reference/tools/gradle-api/4.2/com/android/build/api/component/AndroidTest#functionalTest:org.gradle.api.provider.Property) The functionalTest value to use to run the tests. | | abstract[Property](https://docs.gradle.org/current/javadoc/org/gradle/api/provider/Property.html)\<[Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)\> | [handleProfiling](https://developer.android.com/reference/tools/gradle-api/4.2/com/android/build/api/component/AndroidTest#handleProfiling:org.gradle.api.provider.Property) The handleProfiling value to use to run the tests. | | abstract[Property](https://docs.gradle.org/current/javadoc/org/gradle/api/provider/Property.html)\<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)\> | [instrumentationRunner](https://developer.android.com/reference/tools/gradle-api/4.2/com/android/build/api/component/AndroidTest#instrumentationRunner:org.gradle.api.provider.Property) The instrumentationRunner to use to run the tests. | | abstract[MapProperty](https://docs.gradle.org/current/javadoc/org/gradle/api/provider/MapProperty.html)\<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html),[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)\> | [manifestPlaceholders](https://developer.android.com/reference/tools/gradle-api/4.2/com/android/build/api/component/AndroidTest#manifestPlaceholders:org.gradle.api.provider.MapProperty) [MapProperty](https://docs.gradle.org/current/javadoc/org/gradle/api/provider/MapProperty.html)of the variant's manifest placeholders. | | abstract[Provider](https://docs.gradle.org/current/javadoc/org/gradle/api/provider/Provider.html)\<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)\> | [packageName](https://developer.android.com/reference/tools/gradle-api/4.2/com/android/build/api/component/AndroidTest#packageName:org.gradle.api.provider.Provider) The package name into which some classes are generated. | | abstract[ApkPackagingOptions](https://developer.android.com/reference/tools/gradle-api/4.2/com/android/build/api/variant/ApkPackagingOptions.html#) | [packagingOptions](https://developer.android.com/reference/tools/gradle-api/4.2/com/android/build/api/component/AndroidTest#packagingOptions:com.android.build.api.variant.ApkPackagingOptions) Variant's packagingOptions, initialized by the corresponding global DSL element. | | abstract[SigningConfig](https://developer.android.com/reference/tools/gradle-api/4.2/com/android/build/api/variant/SigningConfig.html#) | [signingConfig](https://developer.android.com/reference/tools/gradle-api/4.2/com/android/build/api/component/AndroidTest#signingConfig:com.android.build.api.variant.SigningConfig) Variant's signingConfig, initialized by the corresponding DSL element. | | abstract[Property](https://docs.gradle.org/current/javadoc/org/gradle/api/provider/Property.html)\<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?\> | [testLabel](https://developer.android.com/reference/tools/gradle-api/4.2/com/android/build/api/component/AndroidTest#testLabel:org.gradle.api.provider.Property) The test label. | | ### Inherited properties || |---|---| | From class[Component](https://developer.android.com/reference/tools/gradle-api/4.2/com/android/build/api/component/Component) |--------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [Artifacts](https://developer.android.com/reference/tools/gradle-api/4.2/com/android/build/api/artifact/Artifacts.html#) | [artifacts](https://developer.android.com/reference/tools/gradle-api/4.2/com/android/build/api/component/Component#artifacts:com.android.build.api.artifact.Artifacts)
Access to the variant's buildable artifacts for build customization.
| || | From class[ComponentIdentity](https://developer.android.com/reference/tools/gradle-api/4.2/com/android/build/api/component/ComponentIdentity) |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? | [buildType](https://developer.android.com/reference/tools/gradle-api/4.2/com/android/build/api/component/ComponentIdentity#buildType:kotlin.String)
Build type name, might be replaced with access to locked DSL object once ready.
| | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | [flavorName](https://developer.android.com/reference/tools/gradle-api/4.2/com/android/build/api/component/ComponentIdentity#flavorName:kotlin.String)
The multi-flavor name of the variant. This does not include the build type. If no flavors are present, this is an empty string. The full name of the variant is queried via[getName](https://docs.gradle.org/current/javadoc/org/gradle/api/Named.html#getName()).
| | [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[Pair](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html),` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>> | [productFlavors](https://developer.android.com/reference/tools/gradle-api/4.2/com/android/build/api/component/ComponentIdentity#productFlavors:kotlin.collections.List)
List of flavor names, might be replaced with access to locked DSL objects once ready. The order is properly sorted based on the associated dimension order.
| || | From class[TestComponent](https://developer.android.com/reference/tools/gradle-api/4.2/com/android/build/api/component/TestComponent) |---------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [Variant](https://developer.android.com/reference/tools/gradle-api/4.2/com/android/build/api/variant/Variant.html#) | [testedVariant](https://developer.android.com/reference/tools/gradle-api/4.2/com/android/build/api/component/TestComponent#testedVariant:com.android.build.api.variant.Variant)
| || ## Public methods ### aaptOptions ``` abstract fun aaptOptions(action: AaptOptions.() -> Unit): Unit ``` Variant's aaptOptions, initialized by the corresponding global DSL element. ### addResValue ``` abstract fun addResValue(     name: String,     type: String,     value: String,     comment: String? ): Unit ``` Adds a ResValue element to the generated resources. | Parameters || |-------------------------------------------------------------------------------------------|----------------------------------------------------------------------------| | name:[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | The resource name. | | type:[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | The resource type like 'string'. | | value:[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | The resource value. | | comment:[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? | Optional comment to be added to the generated resource file for the field. | ### addResValue ``` abstract fun addResValue(     name: String,     type: String,     value: Provider,     comment: String? ): Unit ``` Adds a ResValue element to the generated resources. | Parameters || |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------| | name:[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | The resource name. | | type:[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | The resource type like 'string'. | | value:[Provider](https://docs.gradle.org/current/javadoc/org/gradle/api/provider/Provider.html)\<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)\> | A[Provider](https://docs.gradle.org/current/javadoc/org/gradle/api/provider/Provider.html)for the value. | | comment:[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? | Optional comment to be added to the generated resource file for the field. | ### packagingOptions ``` abstract fun packagingOptions(action: ApkPackagingOptions.() -> Unit): Unit ``` Variant's packagingOptions, initialized by the corresponding global DSL element. ### signingConfig ``` abstract fun signingConfig(action: SigningConfig.() -> Unit): Unit ``` Variant's signingConfig, initialized by the corresponding DSL element. ## Properties ### aaptOptions ``` abstract val aaptOptions: AaptOptions ``` Variant's aaptOptions, initialized by the corresponding global DSL element. ### applicationId ``` abstract val applicationId: Property ``` Variant's application ID as present in the final manifest file of the APK. ### buildConfigFields ``` abstract val buildConfigFields: MapProperty> ``` Variant's[BuildConfigField](https://developer.android.com/reference/tools/gradle-api/4.2/com/android/build/api/variant/BuildConfigField.html#)which will be generated in the BuildConfig class. ### functionalTest ``` abstract val functionalTest: Property ``` The functionalTest value to use to run the tests. ### handleProfiling ``` abstract val handleProfiling: Property ``` The handleProfiling value to use to run the tests. ### instrumentationRunner ``` abstract val instrumentationRunner: Property ``` The instrumentationRunner to use to run the tests. ### manifestPlaceholders ``` abstract val manifestPlaceholders: MapProperty ``` [MapProperty](https://docs.gradle.org/current/javadoc/org/gradle/api/provider/MapProperty.html)of the variant's manifest placeholders. Placeholders are organized with a key and a value. The value is a[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)that will be used as is in the merged manifest. | Return || |---|---| | The[MapProperty](https://docs.gradle.org/current/javadoc/org/gradle/api/provider/MapProperty.html)with keys as[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html). || ### packageName ``` abstract val packageName: Provider ``` The package name into which some classes are generated. ### packagingOptions ``` abstract val packagingOptions: ApkPackagingOptions ``` Variant's packagingOptions, initialized by the corresponding global DSL element. ### signingConfig ``` abstract val signingConfig: SigningConfig ``` Variant's signingConfig, initialized by the corresponding DSL element. ### testLabel ``` abstract val testLabel: Property ``` The test label.