Merge pull request #133 from gradle/gh/7.0-fixes

ghale · web-flow · commit 812226841894 · 2021-01-27T14:23:17.000-05:00
Updates to make plugin compatible with Gradle 7.0
diff --git a/README.md b/README.md
@@ -58,3 +58,25 @@ Please star them if you are experiencing them in your project.
 * DexFileDependenciesTask is not cacheable: https://issuetracker.google.com/160138798
 * MergeResources is not relocatable: https://issuetracker.google.com/issues/141301405
 * Room annotation processor causes cache misses, doesn't declare outputs, overlapping outputs, etc: https://issuetracker.google.com/issues/132245929
+
+## Implementation Notes
+
+### RoomSchemaLocationWorkaround
+
+Most of the workarounds in this plugin should apply to your project without any changes.  However, one workaround
+requires some extra configuration.  The Room schema location workaround allows you to specify an output directory for
+Room schema exports without breaking caching for your Java and/or Kapt tasks where the annotation processor has been configured.
+There are various issues with how this annotation processor works (see https://issuetracker.google.com/issues/132245929
+and https://issuetracker.google.com/issues/139438151) which this workaround attempts to mitigate.  However, in order to
+do so in a manageable way, it imposes some restrictions:
+
+* The schema export directory must be configured via the "room" project extension instead of as an explicit annotation
+processor argument.  If an explicit annotation processor argument is provided, an exception will be thrown, instructing
+the user to configure it via the extension:
+```
+room {
+    schemaLocationDir = file("roomSchemas")
+}
+```
+* There can only be a single schema export directory for the project - you cannot configure variant-specific export
+directories.  Schemas exported from different variants will be merged in the directory specified in the "room" extension.
diff --git a/build.gradle b/build.gradle
@@ -13,11 +13,11 @@ version = ["git", "describe", "--match", "[0-9]*", "--dirty"].execute().text.tri
 
 // Maps supported Android plugin versions to the versions of Gradle that support it
 def supportedVersions = [
-    "4.2.0-beta03": ["6.7.1"],
-    "4.1.2": ["6.5.1"],
-    "4.0.2": ["6.1.1", "6.3", "6.4.1"],
-    "3.6.4": ["5.6.4", "6.3", "6.4.1"],
-    "3.5.4": ["5.4.1", "5.6.4", "6.3", "6.4.1"]
+    "4.2.0-beta03": ["6.8.1", "7.0-20210119173355+0000"],
+    "4.1.1": ["6.5.1", "6.8.1"],
+    "4.0.2": ["6.1.1", "6.8.1"],
+    "3.6.4": ["5.6.4", "6.8.1"],
+    "3.5.4": ["5.4.1", "5.6.4", "6.8.1"]
 ]
 
 repositories {
diff --git a/src/main/groovy/org/gradle/android/workarounds/AbstractAbsolutePathWorkaround.groovy b/src/main/groovy/org/gradle/android/workarounds/AbstractAbsolutePathWorkaround.groovy
@@ -19,16 +19,16 @@ abstract class AbstractAbsolutePathWorkaround implements Workaround {
     void apply(WorkaroundContext context) {
         Project project = context.project
         project.tasks.withType(androidTaskClass).configureEach { Task task ->
-            FileCollection originalPropertyValue
+            FileCollection originalPropertyValue = project.files()
             // Create a synthetic input with the original property value and RELATIVE path sensitivity
+            task.inputs.files(originalPropertyValue)
+                .withPathSensitivity(PathSensitivity.RELATIVE)
+                .withPropertyName("${propertyName}.workaround")
+                .optional()
             project.gradle.taskGraph.beforeTask {
                 if (it == task) {
-                    originalPropertyValue = task.getProperty(propertyName)
+                    originalPropertyValue.from(task.getProperty(propertyName))
                     setPropertyValue(task, project.files())
-                    task.inputs.files(originalPropertyValue)
-                        .withPathSensitivity(PathSensitivity.RELATIVE)
-                        .withPropertyName("${propertyName}.workaround")
-                        .optional()
                 }
             }
             // Set the task property back to its original value
diff --git a/src/main/groovy/org/gradle/android/workarounds/CompileLibraryResourcesWorkaround_4_0.groovy b/src/main/groovy/org/gradle/android/workarounds/CompileLibraryResourcesWorkaround_4_0.groovy
@@ -32,19 +32,19 @@ class CompileLibraryResourcesWorkaround_4_0 implements Workaround {
     void apply(WorkaroundContext context) {
         Project project = context.project
         project.tasks.withType(androidTaskClass).configureEach { Task task ->
-            DirectoryProperty originalPropertyValue
+            DirectoryProperty originalPropertyValue = project.objects.directoryProperty()
             // Create a synthetic input with the original property value and RELATIVE path sensitivity
+            task.inputs.dir(originalPropertyValue)
+                .withPathSensitivity(PathSensitivity.RELATIVE)
+                .withPropertyName("${propertyName}.workaround")
+                .optional()
             project.gradle.taskGraph.beforeTask {
                 if (it == task) {
-                    originalPropertyValue = task.getProperty(propertyName)
+                    originalPropertyValue.set(task.getProperty(propertyName))
                     def dummyProperty = project.objects.directoryProperty()
                     // Non-existent file to give the DirectoryProperty a value.
                     dummyProperty.set(project.file('/doesnt-exist'))
                     setPropertyValue(task, dummyProperty)
-                    task.inputs.dir(originalPropertyValue)
-                            .withPathSensitivity(PathSensitivity.RELATIVE)
-                            .withPropertyName("${propertyName}.workaround")
-                            .optional()
                 }
             }
             // Set the task property back to its original value
diff --git a/src/main/groovy/org/gradle/android/workarounds/CompileLibraryResourcesWorkaround_4_2.groovy b/src/main/groovy/org/gradle/android/workarounds/CompileLibraryResourcesWorkaround_4_2.groovy
@@ -34,19 +34,19 @@ class CompileLibraryResourcesWorkaround_4_2 implements Workaround {
     void apply(WorkaroundContext context) {
         Project project = context.project
         project.tasks.withType(androidTaskClass).configureEach { Task task ->
-            ConfigurableFileCollection originalPropertyValue
+            ConfigurableFileCollection originalPropertyValue = project.files()
             // Create a synthetic input with the original property value and RELATIVE path sensitivity
+            task.inputs.files(originalPropertyValue)
+                .withPathSensitivity(PathSensitivity.RELATIVE)
+                .withPropertyName("${propertyName}.workaround")
+                .optional()
             project.gradle.taskGraph.beforeTask {
                 if (it == task) {
-                    originalPropertyValue = task.getProperty(propertyName)
+                    originalPropertyValue.from(task.getProperty(propertyName))
                     def dummyProperty = project.objects.fileCollection()
                     // Non-existent file to give the ConfigurableFileCollection a value.
                     dummyProperty.setFrom(project.file('/doesnt-exist'))
                     setPropertyValue(task, dummyProperty)
-                    task.inputs.files(originalPropertyValue)
-                            .withPathSensitivity(PathSensitivity.RELATIVE)
-                            .withPropertyName("${propertyName}.workaround")
-                            .optional()
                 }
             }
             // Set the task property back to its original value
diff --git a/src/main/groovy/org/gradle/android/workarounds/MergeResourcesWorkaround.groovy b/src/main/groovy/org/gradle/android/workarounds/MergeResourcesWorkaround.groovy
@@ -4,6 +4,7 @@ import org.gradle.android.AndroidIssue
 import org.gradle.api.Project
 import org.gradle.api.Task
 import org.gradle.api.file.FileCollection
+import org.gradle.api.provider.MapProperty
 import org.gradle.api.tasks.PathSensitivity
 
 /**
@@ -21,20 +22,20 @@ class MergeResourcesWorkaround implements Workaround {
     void apply(WorkaroundContext context) {
         Project project = context.project
         project.tasks.withType(androidTaskClass).configureEach { Task task ->
-            Map<String, FileCollection> originalResources = [:]
+            MapProperty<String, FileCollection> originalResources = project.objects.mapProperty(String, FileCollection)
             // Create a synthetic input with the original value and RELATIVE path sensitivity
+            task.inputs.files(originalResources.map {it.values() })
+                .withPathSensitivity(PathSensitivity.RELATIVE)
+                .withPropertyName("rawLocalResources.workaround")
             project.gradle.taskGraph.beforeTask {
                 if (it == task) {
-                    originalResources.putAll(task.resourcesComputer.resources)
+                    task.resourcesComputer.resources.each { key, value -> originalResources.put(key, value) }
                     task.resourcesComputer.resources.clear()
-                    task.inputs.files(originalResources.values())
-                            .withPathSensitivity(PathSensitivity.RELATIVE)
-                            .withPropertyName("rawLocalResources.workaround")
                 }
             }
             // Set the source back to its original value before we execute the main task action
             task.doFirst {
-                task.resourcesComputer.resources.putAll(originalResources)
+                task.resourcesComputer.resources.putAll(originalResources.get())
             }
         }
     }
diff --git a/src/main/groovy/org/gradle/android/workarounds/RoomSchemaLocationWorkaround.groovy b/src/main/groovy/org/gradle/android/workarounds/RoomSchemaLocationWorkaround.groovy
diff --git a/src/test/groovy/org/gradle/android/RoomSchemaLocationWorkaroundTest.groovy b/src/test/groovy/org/gradle/android/RoomSchemaLocationWorkaroundTest.groovy
diff --git a/src/test/groovy/org/gradle/android/SimpleAndroidApp.groovy b/src/test/groovy/org/gradle/android/SimpleAndroidApp.groovy
