Support non-main source sets (#8)

* Support non-main source sets (eg `test`) * Provide a `compileAllErrorProne` task that depends on all the compile tasks with that have errorprone applied and enabled.
palantir · Nov 5, 2024 · a04a5b6 · a04a5b6
1 parent e5e2591
commit a04a5b6
Show file tree

Hide file tree

Showing 5 changed files with 154 additions and 89 deletions.
diff --git a/changelog/@unreleased/pr-8.v2.yml b/changelog/@unreleased/pr-8.v2.yml
@@ -0,0 +1,7 @@
+type: fix
+fix:
+  description: |-
+    * Support non-main source sets (eg `test`)
+    * Provide a `compileAllErrorProne` task that depends on all the compile tasks that have errorprone applied and enabled.
+  links:
+  - https://github.com/palantir/suppressible-error-prone/pull/8
diff --git a/...main/java/com/palantir/gradle/suppressibleerrorprone/SuppressibleErrorProneExtension.java b/...main/java/com/palantir/gradle/suppressibleerrorprone/SuppressibleErrorProneExtension.java
@@ -22,7 +22,6 @@
 import net.ltgt.gradle.errorprone.ErrorProneOptions;
 import org.gradle.api.Action;
 import org.gradle.api.Project;
-import org.gradle.api.plugins.ExtensionAware;
 import org.gradle.api.provider.ListProperty;
 import org.gradle.api.provider.SetProperty;
 import org.gradle.api.tasks.compile.JavaCompile;
@@ -49,9 +48,9 @@ public final Set<String> patchChecksForCompilation(JavaCompile javaCompile) {
     }
 
     public final void configureEachErrorProneOptions(Action<ErrorProneOptions> action) {
-        project.getTasks().withType(JavaCompile.class).configureEach(javaCompile -> ((ExtensionAware)
-                        javaCompile.getOptions())
-                .getExtensions()
-                .configure(ErrorProneOptions.class, action));
+        project.getTasks()
+                .withType(JavaCompile.class)
+                .configureEach(
+                        javaCompile -> SuppressibleErrorPronePlugin.configureErrorProneOptions(javaCompile, action));
     }
 }
diff --git a/...rc/main/java/com/palantir/gradle/suppressibleerrorprone/SuppressibleErrorPronePlugin.java b/...rc/main/java/com/palantir/gradle/suppressibleerrorprone/SuppressibleErrorPronePlugin.java
@@ -26,8 +26,10 @@
 import net.ltgt.gradle.errorprone.CheckSeverity;
 import net.ltgt.gradle.errorprone.ErrorProneOptions;
 import net.ltgt.gradle.errorprone.ErrorPronePlugin;
+import org.gradle.api.Action;
 import org.gradle.api.Plugin;
 import org.gradle.api.Project;
+import org.gradle.api.Task;
 import org.gradle.api.attributes.Attribute;
 import org.gradle.api.plugins.ExtensionAware;
 import org.gradle.api.tasks.SourceSetContainer;
@@ -84,11 +86,9 @@ private void applyToJavaProject(Project project) {
         project.getTasks().withType(JavaCompile.class).configureEach(javaCompile -> {
             configureJavaCompile(project, javaCompile);
 
-            ((ExtensionAware) javaCompile.getOptions())
-                    .getExtensions()
-                    .configure(ErrorProneOptions.class, errorProneOptions -> {
-                        configureErrorProneOptions(project, extension, javaCompile, errorProneOptions);
-                    });
+            configureErrorProneOptions(javaCompile, errorProneOptions -> {
+                setupErrorProneOptions(project, extension, javaCompile, errorProneOptions);
+            });
         });
 
         addAnnotationDependencyForSuppressingStage2(project, version);
@@ -110,6 +110,13 @@ private void applyToJavaProject(Project project) {
                 });
             });
         }
+
+        project.getTasks().register("compileAllErrorProne", Task.class, compileAll -> {
+            compileAll.dependsOn(project.provider(
+                    () -> project.getTasks().withType(JavaCompile.class).matching(javaCompile -> {
+                        return errorProneOptionsFor(javaCompile).getEnabled().get();
+                    })));
+        });
     }
 
     private static void setupErrorProneArtifactTransform(Project project) {
@@ -123,22 +130,27 @@ private static void setupErrorProneArtifactTransform(Project project) {
                 .getAttributes()
                 .attribute(suppressible, false);
 
-        // It's the annotationProcessor configuration, not the errorprone that, is actually used by the compiler
-        // and so where we must put our transform. annotationProcessor extendsFrom errorprone.
-        project.getConfigurations().named("annotationProcessor").configure(errorProneConfiguration -> {
-            errorProneConfiguration
-                    .getDependencies()
-                    .add(project.getDependencies().create("com.google.errorprone:error_prone_check_api"));
-            errorProneConfiguration.getAttributes().attribute(suppressible, true);
-        });
-
         project.getDependencies().registerTransform(ModifyErrorProneCheckApi.class, spec -> {
             spec.getParameters().getSuppressionStage1().set(isSuppressingStageOne(project));
 
             Attribute<String> artifactType = Attribute.of("artifactType", String.class);
             spec.getFrom().attribute(suppressible, false).attribute(artifactType, "jar");
             spec.getTo().attribute(suppressible, true).attribute(artifactType, "jar");
         });
+
+        // We need to configure the transform in each source set as they each have their own compile task
+        project.getExtensions().getByType(SourceSetContainer.class).configureEach(sourceSet -> {
+            // It's the annotationProcessor configuration, not the errorprone that, is actually used by the compiler
+            // and so where we must put our transform. annotationProcessor extendsFrom errorprone.
+            project.getConfigurations()
+                    .named(sourceSet.getAnnotationProcessorConfigurationName())
+                    .configure(errorProneConfiguration -> {
+                        errorProneConfiguration
+                                .getDependencies()
+                                .add(project.getDependencies().create("com.google.errorprone:error_prone_check_api"));
+                        errorProneConfiguration.getAttributes().attribute(suppressible, true);
+                    });
+        });
     }
 
     private void configureJavaCompile(Project project, JavaCompile javaCompile) {
@@ -148,7 +160,7 @@ private void configureJavaCompile(Project project, JavaCompile javaCompile) {
         }
     }
 
-    private void configureErrorProneOptions(
+    private void setupErrorProneOptions(
             Project project,
             SuppressibleErrorProneExtension extension,
             JavaCompile javaCompile,
@@ -241,6 +253,14 @@ private static void addAnnotationDependencyForSuppressingStage2(Project project,
         }
     }
 
+    private static ErrorProneOptions errorProneOptionsFor(JavaCompile javaCompile) {
+        return ((ExtensionAware) javaCompile.getOptions()).getExtensions().getByType(ErrorProneOptions.class);
+    }
+
+    static void configureErrorProneOptions(JavaCompile javaCompile, Action<ErrorProneOptions> action) {
+        ((ExtensionAware) javaCompile.getOptions()).getExtensions().configure(ErrorProneOptions.class, action);
+    }
+
     private static boolean isAnyKindOfPatching(Project project) {
         return isApplyingSuggestedPatches(project) || isSuppressingStageOne(project) || isSuppressingStageTwo(project);
     }