| /* |
| * Copyright 2019 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 androidx.build.uptodatedness |
| |
| import org.gradle.api.GradleException |
| import org.gradle.api.Project |
| import org.gradle.api.Task |
| import java.io.File |
| import java.util.Date |
| |
| /** |
| * Validates that all tasks (except a temporary whitelist) are considered up-to-date. |
| * The expected usage of this is that the user will invoke a build with the |
| * TaskUpToDateValidator disabled, and then reinvoke the same build with the TaskUpToDateValidator |
| * enabled. If the second build actually runs any tasks, then some tasks don't have the correct |
| * inputs/outputs declared and are running more often than necessary. |
| */ |
| |
| const val DISALLOW_TASK_EXECUTION_FLAG_NAME = "disallowExecution" |
| |
| // Temporary whitelist of tasks that are known to still be out-of-date after running once |
| val EXEMPT_TASK_NAMES = setOf( |
| "buildOnServer", |
| "checkExternalLicenses", |
| "createArchive", |
| "createDiffArchiveForAll", |
| "createProjectZip", |
| "desugarPublicDebugFileDependencies", |
| "desugarTipOfTreeDebugFileDependencies", |
| "dist", |
| "distPublicDokkaDocs", |
| "dokkaJavaPublicDocs", |
| "dokkaKotlinPublicDocs", |
| "externalNativeBuildDebug", |
| "externalNativeBuildRelease", |
| "generateJsonModelDebug", |
| "generateJsonModelRelease", |
| "generateMetadataFileForKotlinMultiplatformPublication", |
| "generatePomFileForBenchmarkPluginMarkerMavenPublication", |
| "generatePomFileForKotlinMultiplatformPublication", |
| "generatePomFileForMavenPublication", |
| "generatePomFileForPluginMavenPublication", |
| "generatePomFileForMetadataPublication", |
| "generatePomFileForSafeargsJavaPluginMarkerMavenPublication", |
| "generatePomFileForSafeargsKotlinPluginMarkerMavenPublication", |
| "jacocoPublicDebug", |
| "jacocoTipOfTreeDebug", |
| "lint", |
| "lintDebug", |
| "lintVitalRelease", |
| "mergeDexDebug", |
| "mergeExtDexDebug", |
| "mergeExtDexPublicDebug", |
| "mergeExtDexTipOfTreeDebug", |
| "mergeLibDexDebug", |
| "mergeLibDexPublicDebug", |
| "mergeProjectDexPublicDebug", |
| "mergeProjectDexTipOfTreeDebug", |
| "mergePublicDebugAssets", |
| "mergePublicDebugJavaResource", |
| "mergePublicDebugJniLibFolders", |
| "mergePublicDebugNativeLibs", |
| "mergePublicDebugShaders", |
| "mergeTipOfTreeDebugAssets", |
| "mergeTipOfTreeDebugJavaResource", |
| "packageDebug", |
| "packagePublicDebug", |
| "packageTipOfTreeDebug", |
| "partiallyDejetifyArchive", |
| "postInstrumentCode", |
| "publishBenchmarkPluginMarkerMavenPublicationToMavenRepository", |
| "publishKotlinMultiplatformPublicationToMavenRepository", |
| "publishMavenPublicationToMavenRepository", |
| "publishMetadataPublicationToMavenRepository", |
| "publishPluginMavenPublicationToMavenRepository", |
| "publishSafeargsJavaPluginMarkerMavenPublicationToMavenRepository", |
| "publishSafeargsKotlinPluginMarkerMavenPublicationToMavenRepository", |
| "reportLibraryMetrics", |
| "stripArchiveForPartialDejetification", |
| "transformClassesWithDexBuilderForPublicDebug", |
| "transformClassesWithDexBuilderForTipOfTreeDebug", |
| "unzipDokkaPublicDocsDeps", |
| "verifyDependencyVersions", |
| "verifyReleaseResources", |
| "zipEcFiles" |
| ) |
| class TaskUpToDateValidator { |
| companion object { |
| private fun shouldEnable(project: Project): Boolean { |
| return project.hasProperty(DISALLOW_TASK_EXECUTION_FLAG_NAME) |
| } |
| |
| private fun isExemptTask(task: Task): Boolean { |
| return EXEMPT_TASK_NAMES.contains(task.name) |
| } |
| |
| fun setup(rootProject: Project) { |
| if (!shouldEnable(rootProject)) { |
| return |
| } |
| rootProject.gradle.taskGraph.afterTask { task -> |
| if (task.didWork) { |
| if (!isExemptTask(task)) { |
| val message = "Error: executed $task but " + |
| DISALLOW_TASK_EXECUTION_FLAG_NAME + |
| " was specified. This indicates that $task does not declare" + |
| " inputs and/or outputs correctly.\n" + tryToExplainTaskExecution(task) |
| throw GradleException(message) |
| } |
| } |
| } |
| } |
| fun tryToExplainTaskExecution(task: Task): String { |
| val numOutputFiles = task.outputs.files.files.size |
| val outputsMessage = if (numOutputFiles > 0) { |
| task.path + " declares " + numOutputFiles + " output files. This seems fine.\n" |
| } else { |
| task.path + " declares " + numOutputFiles + " output files. This is probably " + |
| "an error.\n" |
| } |
| |
| val inputFiles = task.inputs.files.files |
| var lastModifiedFile: File? = null |
| var lastModifiedWhen = Date(0) |
| for (inputFile in inputFiles) { |
| val modifiedWhen = Date(inputFile.lastModified()) |
| if (modifiedWhen.compareTo(lastModifiedWhen) > 0) { |
| lastModifiedFile = inputFile |
| lastModifiedWhen = modifiedWhen |
| } |
| } |
| val inputsMessage = if (lastModifiedFile != null) { |
| task.path + " declares " + inputFiles.size + " input files. The " + |
| "last modified input file is\n" + lastModifiedFile + "\nmodified at " + |
| lastModifiedWhen + ". " + |
| tryToExplainFileModification(lastModifiedFile, task) |
| } else { |
| task.path + " declares " + inputFiles.size + " input files.\n" |
| } |
| |
| val reproductionMessage = "\nTo reproduce this error you can try running " + |
| "`./gradlew ${task.path} -PverifyUpToDate`\n" |
| return outputsMessage + inputsMessage + reproductionMessage |
| } |
| |
| fun tryToExplainFileModification(file: File, triggeringTask: Task): String { |
| val taskDependencies = triggeringTask.taskDependencies.getDependencies(triggeringTask) |
| var createdByTask: Task? = null |
| for (otherTask in taskDependencies) { |
| if (otherTask.outputs.files.files.contains(file)) { |
| createdByTask = otherTask |
| break |
| } |
| } |
| if (createdByTask == null) { |
| return "This file is not declared as the output of any task." |
| } |
| if (isExemptTask(createdByTask)) { |
| return "This file is declared as an output of " + createdByTask + |
| ", which is a task that is not yet validated by the TaskUpToDateValidator" |
| } else { |
| return "This file is decared as an output of " + createdByTask + |
| ", which is a task that is validated by the TaskUpToDateValidator " + |
| "(and therefore must not have been out-of-date during this build)" |
| } |
| } |
| } |
| } |
