AndroidTest

@Incubating interface AndroidTest : TestComponent

Properties for the android test Variant of a module.

Summary

Public methods

abstract Unit
aaptOptions(action: AaptOptions.() -> Unit)

Variant's aaptOptions, initialized by the corresponding global DSL element.

abstract Unit
addResValue(name: String, type: String, value: String, comment: String?)

Adds a ResValue element to the generated resources.

abstract Unit
addResValue(name: String, type: String, value: Provider<String>, comment: String?)

Adds a ResValue element to the generated resources.

abstract Unit

Variant's packagingOptions, initialized by the corresponding global DSL element.

abstract Unit
signingConfig(action: SigningConfig.() -> Unit)

Variant's signingConfig, initialized by the corresponding DSL element.

Inherited functions

Unit setAsmFramesComputationMode(mode: FramesComputationMode)

Sets the frame computation mode that will be applied to the bytecode of the classes instrumented by ASM visitors registered through transformClassesWith. The default mode is to copy frames.

When setting this multiple times, the mode with the highest enum value will be selected.

Unit transformClassesWith(classVisitorFactoryImplClass: Class<out AsmClassVisitorFactory<ParamT>>, scope: InstrumentationScope, instrumentationParamsConfig: (ParamT) -> Unit)

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:

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

Variant's aaptOptions, initialized by the corresponding global DSL element.

abstract Property<String>

Variant's application ID as present in the final manifest file of the APK.

abstract MapProperty<String, out BuildConfigField<out Serializable>>

Variant's BuildConfigField which will be generated in the BuildConfig class.

abstract Property<Boolean>

The functionalTest value to use to run the tests.

abstract Property<Boolean>

The handleProfiling value to use to run the tests.

abstract Property<String>

The instrumentationRunner to use to run the tests.

abstract MapProperty<String, String>

MapProperty of the variant's manifest placeholders.

abstract Provider<String>

The package name into which some classes are generated.

abstract ApkPackagingOptions

Variant's packagingOptions, initialized by the corresponding global DSL element.

abstract SigningConfig

Variant's signingConfig, initialized by the corresponding DSL element.

abstract Property<String?>

The test label.

Inherited properties

Artifacts artifacts

Access to the variant's buildable artifacts for build customization.

String? buildType

Build type name, might be replaced with access to locked DSL object once ready.

String flavorName

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.

List<Pair<String, String>> productFlavors

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.

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 The resource name.
type: String The resource type like 'string'.
value: String The resource value.
comment: String? Optional comment to be added to the generated resource file for the field.

addResValue

abstract fun addResValue(
    name: String,
    type: String,
    value: Provider<String>,
    comment: String?
): Unit

Adds a ResValue element to the generated resources.

Parameters
name: String The resource name.
type: String The resource type like 'string'.
value: Provider<String> A Provider for the value.
comment: String? 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<String>

Variant's application ID as present in the final manifest file of the APK.

buildConfigFields

abstract val buildConfigFields: MapProperty<String, out BuildConfigField<out Serializable>>

Variant's BuildConfigField which will be generated in the BuildConfig class.

functionalTest

abstract val functionalTest: Property<Boolean>

The functionalTest value to use to run the tests.

handleProfiling

abstract val handleProfiling: Property<Boolean>

The handleProfiling value to use to run the tests.

instrumentationRunner

abstract val instrumentationRunner: Property<String>

The instrumentationRunner to use to run the tests.

manifestPlaceholders

abstract val manifestPlaceholders: MapProperty<String, String>

MapProperty of the variant's manifest placeholders.

Placeholders are organized with a key and a value. The value is a String that will be used as is in the merged manifest.

Return
The MapProperty with keys as String.

packageName

abstract val packageName: Provider<String>

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<String?>

The test label.