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

/*
 * Copyright (C) 2018 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.test

import com.android.build.gradle.internal.component.DeviceTestCreationConfig
import com.android.build.gradle.internal.tasks.getApkFiles
import com.android.build.gradle.internal.testing.TestData
import com.android.build.gradle.internal.utils.toImmutableList
import com.android.builder.testing.api.DeviceConfigProvider
import com.google.common.collect.ImmutableList
import org.gradle.api.file.Directory
import org.gradle.api.file.FileCollection
import org.gradle.api.logging.Logging
import org.gradle.api.provider.Provider
import org.gradle.api.tasks.Input
import org.gradle.api.tasks.InputFiles
import org.gradle.api.tasks.Optional
import org.gradle.api.tasks.PathSensitive
import org.gradle.api.tasks.PathSensitivity
import java.io.File
import java.nio.file.Path

/**
 * Implementation of [TestData] for tests that run against
 * the bundle APKs.
 *
 * For the moment, that is only dynamic feature modules.
 */
internal class BundleTestDataImpl constructor(
    namespace: Provider<String>,
    creationConfig: DeviceTestCreationConfig,
    testApkDir: Provider<Directory>,
    @get:Input
    @get:Optional
    val moduleName: String?,
    @get:InputFiles
    @get:PathSensitive(PathSensitivity.RELATIVE)
    @get:Optional
    val apkBundle: FileCollection,
    privacySandboxSdkApks: FileCollection?,
    privacySandboxCompatSdkApks: Provider<Directory>?,
    extraInstrumentationTestRunnerArgs: Map<String, String>
) : AbstractTestDataImpl(
    namespace = namespace,
    creationConfig = creationConfig,
    testApkDir = testApkDir,
    testedApksDir = null,
    privacySandboxSdkApks = privacySandboxSdkApks,
    privacySandboxCompatSdkApks = privacySandboxCompatSdkApks,
    additionalSdkSupportedSplitApks = null,
    extraInstrumentationTestRunnerArgs = extraInstrumentationTestRunnerArgs
) {

    override val libraryType = creationConfig.services.provider { false }

    override val testedApksFinder: ApksFinder
        get() = _testedApksFinder ?:
            BundleApksFinder(apkBundle.singleFile.toPath(), moduleName).also {
                _testedApksFinder = it
            }

    private var _testedApksFinder: BundleApksFinder? = null

    internal class BundleApksFinder(
        private val apkPath: Path,
        private val moduleName: String?
    ): ApksFinder {

        override fun findApks(deviceConfigProvider: DeviceConfigProvider): List<File> {
            if (moduleName != null && deviceConfigProvider.apiLevel < 21) {
                // Bundle tool fuses APKs below 21, requesting a module will return an error even
                // if that module is fused.
                // TODO(https://issuetracker.google.com/119663247): Return the fused APK if the
                // requested module was fused.
                Logging.getLogger(BundleTestDataImpl::class.java).warn(
                    "Testing dynamic features on devices API < 21 is not currently supported.")
                return ImmutableList.of<File>()
            }
            return getApkFiles(
                apkPath,
                deviceConfigProvider,
                moduleName
            ).map { it.toFile() }.toImmutableList()
        }
    }

}