build-system/gradle-core/src/main/java/com/android/build/gradle/internal/ManagedDeviceUtils.kt

/*
 * Copyright (C) 2020 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.android.build.gradle.internal

import com.android.build.api.dsl.DeviceGroup
import com.android.build.gradle.internal.component.InstrumentedTestCreationConfig
import com.android.build.gradle.internal.dsl.ManagedVirtualDevice
import com.android.build.gradle.options.ProjectOptions
import com.android.build.gradle.options.StringOption
import com.android.prefs.AndroidLocationsProvider
import com.android.testing.utils.computeVendorString
import com.android.utils.CpuArchitecture
import com.android.utils.osArchitecture
import org.gradle.api.file.DirectoryProperty
import org.gradle.api.model.ObjectFactory
import org.gradle.api.provider.ProviderFactory

private const val GRADLE_AVD_DIRECTORY_PATH = "gradle/avd"

/**
 * Gets the provider of the avd folder for managed devices across all projects.
 */
fun getManagedDeviceAvdFolder(
    objectFactory: ObjectFactory,
    providerFactory: ProviderFactory,
    androidLocationsProvider: AndroidLocationsProvider
): DirectoryProperty =
    objectFactory.directoryProperty().fileProvider(providerFactory.provider {
        androidLocationsProvider.gradleAvdLocation.toFile()
    })

fun computeAvdName(device: ManagedVirtualDevice): String =
    computeAvdName(
        device.apiLevel,
        device.systemImageSource,
        computeAbiFromArchitecture(device),
        device.device)

fun computeAvdName(
    apiLevel: Int,
    imageSource: String,
    abi: String,
    hardwareProfile: String
): String {
    val sanitizedProfile = sanitizeProfileName(hardwareProfile)
    val vendor = computeVendorString(imageSource)
    return "dev${apiLevel}_${vendor}_${abi}_$sanitizedProfile"
}

fun sanitizeProfileName(hardwareProfile: String) =
    hardwareProfile.replace(Regex("[() ]"), "_")

fun setupTaskName(device: ManagedVirtualDevice): String = "${device.name}Setup"

fun managedDeviceAllVariantsTaskName(device: ManagedVirtualDevice): String = "${device.name}Check"

fun managedDeviceGroupAllVariantsTaskName(deviceGroup: DeviceGroup): String =
    "${deviceGroup.name}GroupCheck"

fun managedDeviceGroupSingleVariantTaskName(
    creationConfig: InstrumentedTestCreationConfig, deviceGroup: DeviceGroup): String =
    creationConfig.computeTaskName("${deviceGroup.name}Group")

fun computeAbiFromArchitecture(device: ManagedVirtualDevice): String =
    computeAbiFromArchitecture(
        device.require64Bit,
        device.apiLevel,
        device.systemImageSource
    )

fun computeAbiFromArchitecture(
    require64Bit: Boolean,
    apiLevel: Int,
    vendor: String,
    cpuArch: CpuArchitecture = osArchitecture
): String = when {
    cpuArch == CpuArchitecture.ARM
            || cpuArch == CpuArchitecture.X86_ON_ARM-> "arm64-v8a"
    require64Bit -> "x86_64"
    // Neither system-images;android-30;default;x86 nor system-images;android-26;default;x86
    // exist, but the google images do.
    vendor == "aosp" && apiLevel in listOf(26, 30) -> "x86_64"
    apiLevel <= 30 -> "x86"
    else -> "x86_64"
}

fun computeManagedDeviceEmulatorMode(projectOptions: ProjectOptions) =
    projectOptions[StringOption.GRADLE_MANAGED_DEVICE_EMULATOR_GPU_MODE] ?: "auto-no-window"