com.android.build.gradle.tasks.PrePackageApplication Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gradle-core Show documentation
Core library to build Android Gradle plugin.
There is a newer version: 2.3.0
/*
 * Copyright (C) 2016 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.tasks;

import com.android.annotations.NonNull;
import com.android.build.gradle.OptionalCompilationStep;
import com.android.build.gradle.internal.incremental.InstantRunBuildContext;
import com.android.build.gradle.internal.incremental.InstantRunPatchingPolicy;
import com.android.build.gradle.internal.scope.VariantScope;

import java.io.File;
import java.io.IOException;

/**
 * PrePackaging step class that will look if the packaging of the main APK split is necessary
 * when running in InstantRun mode. In InstantRun mode targeting an api 23 or above device,
 * resources are packaged in the main split APK. However when a warm swap is possible, it is
 * not necessary to produce immediately the new main SPLIT since the runtime use directly the
 * resources.ap_ file. However, as soon as an incompatible change forcing a cold swap is
 * triggered, the main APK must be rebuilt (even if the resources were changed in a previous
 * build).
 */
public class PrePackageApplication extends KickerTask {

    @Override
    protected void doFullTaskAction() throws IOException {

        // when instantRun is disabled or not targeting 23 and above, we must run the packageApp
        // task.
        if (InstantRunPatchingPolicy.MULTI_APK != instantRunContext.getPatchingPolicy()
                || variantScope.getGlobalScope().isActive(OptionalCompilationStep.RESTART_ONLY)) {
            MarkerFile.createMarkerFile(getMarkerFile(), MarkerFile.Command.RUN);
            return;
        }

        if (instantRunContext.hasPassedVerification()) {
            MarkerFile.createMarkerFile(getMarkerFile(), MarkerFile.Command.BLOCK);
        } else {
            // now the main apk is only necessary if we produced a RESOURCES file in a previous
            // build, let's check it out.
            if (instantRunContext.getPastBuildsArtifactForType(
                    InstantRunBuildContext.FileType.RESOURCES) == null) {
                MarkerFile.createMarkerFile(getMarkerFile(), MarkerFile.Command.BLOCK);
            } else {
                MarkerFile.createMarkerFile(getMarkerFile(), MarkerFile.Command.RUN);
            }
        }
    }

    public static class ConfigAction extends KickerTask.ConfigAction {

        public ConfigAction(@NonNull String name, @NonNull VariantScope scope) {
            super(name, scope);
        }

        @NonNull
        public static File getMarkerFile(@NonNull VariantScope scope) {
            return new File(scope.getInstantRunSupportDir(), "package.marker");
        }

        @NonNull
        @Override
        public Class getType() {
            return PrePackageApplication.class;
        }

        @Override
        public void execute(@NonNull PrePackageApplication task) {
            super.execute(task);
            task.markerFile = getMarkerFile(scope);
        }
    }
}