build-system/gradle/src/build-test/groovy/com/android/build/gradle/BuildTest.java

/*
 * Copyright (C) 2012 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;

import com.android.annotations.NonNull;
import com.android.build.gradle.internal.test.BaseTest;
import com.google.common.collect.Lists;

import java.io.File;
import java.util.Collection;
import java.util.Collections;
import java.util.List;

/**
 * Base class for build tests.
 *
 * This requires an SDK, found through the ANDROID_HOME environment variable or present in the
 * Android Source tree under out/host/<platform>/sdk/... (result of 'make sdk')
 */
abstract class BuildTest extends BaseTest {
    private static final Collection<String> IGNORED_GRADLE_VERSIONS = Lists.newArrayList("1.10", "1.11");

    protected File testDir;
    protected File sdkDir;
    protected File ndkDir;

    @Override
    protected void setUp() throws Exception {
        testDir = getTestDir();
        sdkDir = getSdkDir();
        ndkDir = getNdkDir();
    }

    /**
     * Indicates whether the given Gradle version should be ignored in tests (for example, when a Gradle version has
     * not been publicly released yet.)
     *
     * @param gradleVersion the given Gradle version.
     * @return {@code true} if the given Gradle version should be ignored, {@code false} otherwise.
     */
    protected static boolean isIgnoredGradleVersion(String gradleVersion) {
      return IGNORED_GRADLE_VERSIONS.contains(gradleVersion);
    }

    protected File buildProject(@NonNull String name, @NonNull String gradleVersion) {
        return runTasksOnProject(
                name,
                gradleVersion,
                Collections.<String>emptyList(),
                "clean", "assembleDebug", "lint");
    }

    protected File runTasksOnProject(
            @NonNull String name,
            @NonNull String gradleVersion,
            @NonNull List<String> arguments,
            @NonNull String... tasks) {
        File project = new File(testDir, name);

        File buildGradle = new File(project, "build.gradle");
        assertTrue("Missing file: " + buildGradle, buildGradle.isFile());

        // build the project
        runGradleTasks(sdkDir, ndkDir, gradleVersion, project, arguments, tasks);

        return project;
    }
}