blob: 2ce81a5a665e4a972bb69e727c17ae66aef90957 [file] [log] [blame]
/*
* Copyright (C) 2015 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.variant;
import static com.android.build.gradle.internal.dependency.VariantDependencies.CONFIG_NAME_COMPILE_ONLY;
import static com.android.build.gradle.internal.dependency.VariantDependencies.CONFIG_NAME_TESTED_APKS;
import com.android.annotations.NonNull;
import com.android.build.api.artifact.impl.ArtifactsImpl;
import com.android.build.api.component.ComponentIdentity;
import com.android.build.api.component.impl.AndroidTestImpl;
import com.android.build.api.component.impl.AndroidTestPropertiesImpl;
import com.android.build.api.component.impl.UnitTestImpl;
import com.android.build.api.component.impl.UnitTestPropertiesImpl;
import com.android.build.api.dsl.BuildFeatures;
import com.android.build.api.dsl.TestBuildFeatures;
import com.android.build.api.variant.impl.TestVariantImpl;
import com.android.build.api.variant.impl.TestVariantPropertiesImpl;
import com.android.build.api.variant.impl.VariantOutputConfigurationImpl;
import com.android.build.api.variant.impl.VariantPropertiesImpl;
import com.android.build.gradle.TestAndroidConfig;
import com.android.build.gradle.internal.core.VariantDslInfo;
import com.android.build.gradle.internal.core.VariantSources;
import com.android.build.gradle.internal.dependency.VariantDependencies;
import com.android.build.gradle.internal.dsl.DataBindingOptions;
import com.android.build.gradle.internal.pipeline.TransformManager;
import com.android.build.gradle.internal.plugins.DslContainerProvider;
import com.android.build.gradle.internal.scope.BuildFeatureValues;
import com.android.build.gradle.internal.scope.BuildFeatureValuesImpl;
import com.android.build.gradle.internal.scope.GlobalScope;
import com.android.build.gradle.internal.scope.VariantScope;
import com.android.build.gradle.internal.services.ProjectServices;
import com.android.build.gradle.internal.services.TaskCreationServices;
import com.android.build.gradle.internal.services.VariantApiServices;
import com.android.build.gradle.internal.services.VariantPropertiesApiServices;
import com.android.build.gradle.options.ProjectOptions;
import com.android.builder.core.BuilderConstants;
import com.android.builder.core.VariantType;
import com.android.builder.core.VariantTypeImpl;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import java.util.Map;
import org.gradle.api.GradleException;
import org.gradle.api.Project;
import org.gradle.api.artifacts.Configuration;
import org.gradle.api.artifacts.dsl.DependencyHandler;
/** Customization of {@link AbstractAppVariantFactory} for test-only projects. */
public class TestVariantFactory
extends AbstractAppVariantFactory<TestVariantImpl, TestVariantPropertiesImpl> {
public TestVariantFactory(
@NonNull ProjectServices projectServices, @NonNull GlobalScope globalScope) {
super(projectServices, globalScope);
}
@NonNull
@Override
public TestVariantImpl createVariantObject(
@NonNull ComponentIdentity componentIdentity,
@NonNull VariantDslInfo variantDslInfo,
@NonNull VariantApiServices variantApiServices) {
return projectServices
.getObjectFactory()
.newInstance(
TestVariantImpl.class,
variantDslInfo,
componentIdentity,
variantApiServices);
}
@NonNull
@Override
public UnitTestImpl createUnitTestObject(
@NonNull ComponentIdentity componentIdentity,
@NonNull VariantDslInfo variantDslInfo,
@NonNull VariantApiServices variantApiServices) {
throw new RuntimeException("cannot instantiate unit-test in test plugin");
}
@NonNull
@Override
public AndroidTestImpl createAndroidTestObject(
@NonNull ComponentIdentity componentIdentity,
@NonNull VariantDslInfo variantDslInfo,
@NonNull VariantApiServices variantApiServices) {
throw new RuntimeException("cannot instantiate android-test in test plugin");
}
@NonNull
@Override
public TestVariantPropertiesImpl createVariantPropertiesObject(
@NonNull TestVariantImpl variant,
@NonNull ComponentIdentity componentIdentity,
@NonNull BuildFeatureValues buildFeatures,
@NonNull VariantDslInfo variantDslInfo,
@NonNull VariantDependencies variantDependencies,
@NonNull VariantSources variantSources,
@NonNull VariantPathHelper paths,
@NonNull ArtifactsImpl artifacts,
@NonNull VariantScope variantScope,
@NonNull BaseVariantData variantData,
@NonNull TransformManager transformManager,
@NonNull VariantPropertiesApiServices variantPropertiesApiServices,
@NonNull TaskCreationServices taskCreationServices) {
TestVariantPropertiesImpl variantProperties =
projectServices
.getObjectFactory()
.newInstance(
TestVariantPropertiesImpl.class,
componentIdentity,
buildFeatures,
variantDslInfo,
variantDependencies,
variantSources,
paths,
artifacts,
variantScope,
variantData,
transformManager,
variantPropertiesApiServices,
taskCreationServices,
globalScope);
// create default output
variantProperties.addVariantOutput(
new VariantOutputConfigurationImpl(false, ImmutableList.of()), null);
return variantProperties;
}
@NonNull
@Override
public BuildFeatureValues createBuildFeatureValues(
@NonNull BuildFeatures buildFeatures, @NonNull ProjectOptions projectOptions) {
if (buildFeatures instanceof TestBuildFeatures) {
return new BuildFeatureValuesImpl(
buildFeatures,
true /* androidResources */,
false /* dataBinding */,
false /* mlModelBinding */,
projectOptions);
} else {
throw new RuntimeException("buildFeatures not of type TestBuildFeatures");
}
}
@NonNull
@Override
public BuildFeatureValues createTestBuildFeatureValues(
@NonNull BuildFeatures buildFeatures,
@NonNull DataBindingOptions dataBindingOptions,
@NonNull ProjectOptions projectOptions) {
throw new RuntimeException("cannot instantiate test build features in test plugin");
}
@NonNull
@Override
public UnitTestPropertiesImpl createUnitTestProperties(
@NonNull ComponentIdentity componentIdentity,
@NonNull BuildFeatureValues buildFeatures,
@NonNull VariantDslInfo variantDslInfo,
@NonNull VariantDependencies variantDependencies,
@NonNull VariantSources variantSources,
@NonNull VariantPathHelper paths,
@NonNull ArtifactsImpl artifacts,
@NonNull VariantScope variantScope,
@NonNull TestVariantData variantData,
@NonNull VariantPropertiesImpl testedVariantProperties,
@NonNull TransformManager transformManager,
@NonNull VariantPropertiesApiServices variantPropertiesApiServices,
@NonNull TaskCreationServices taskCreationServices) {
throw new RuntimeException("cannot instantiate unit-test properties in test plugin");
}
@NonNull
@Override
public AndroidTestPropertiesImpl createAndroidTestProperties(
@NonNull ComponentIdentity componentIdentity,
@NonNull BuildFeatureValues buildFeatures,
@NonNull VariantDslInfo variantDslInfo,
@NonNull VariantDependencies variantDependencies,
@NonNull VariantSources variantSources,
@NonNull VariantPathHelper paths,
@NonNull ArtifactsImpl artifacts,
@NonNull VariantScope variantScope,
@NonNull TestVariantData variantData,
@NonNull VariantPropertiesImpl testedVariantProperties,
@NonNull TransformManager transformManager,
@NonNull VariantPropertiesApiServices variantPropertiesApiServices,
@NonNull TaskCreationServices taskCreationServices) {
throw new RuntimeException("cannot instantiate android-test properties in test plugin");
}
@Override
public void preVariantWork(final Project project) {
super.preVariantWork(project);
TestAndroidConfig testExtension = (TestAndroidConfig) globalScope.getExtension();
String path = testExtension.getTargetProjectPath();
if (path == null) {
throw new GradleException(
"targetProjectPath cannot be null in test project " + project.getName());
}
DependencyHandler handler = project.getDependencies();
Map<String, String> projectNotation = ImmutableMap.of("path", path);
// Add the tested project to compileOnly. This cannot be 'implementation' because of the
// following:
//
// The tested project itself only publishes to api, however its transitive library module
// dependencies are published to both api and runtime elements and would be seen in our
// RuntimeClasspath here otherwise.
handler.add(CONFIG_NAME_COMPILE_ONLY, handler.project(projectNotation));
// Create a custom configuration that will be used to consume only the APK from the
// tested project's RuntimeElements published configuration.
Configuration testedApks = project.getConfigurations().maybeCreate(CONFIG_NAME_TESTED_APKS);
testedApks.setCanBeConsumed(false);
testedApks.setCanBeResolved(false);
handler.add(CONFIG_NAME_TESTED_APKS, handler.project(projectNotation));
}
@Override
public void createDefaultComponents(@NonNull DslContainerProvider dslContainers) {
// don't call super as we don't want the default app version.
// must create signing config first so that build type 'debug' can be initialized
// with the debug signing config.
dslContainers.getSigningConfigContainer().create(BuilderConstants.DEBUG);
dslContainers.getBuildTypeContainer().create(BuilderConstants.DEBUG);
}
@NonNull
@Override
public VariantType getVariantType() {
return VariantTypeImpl.TEST_APK;
}
}