Fix Spotless targetExclude patterns being overridden (palantir#1690)

Fix Spotless targetExclude patterns being overridden

Author: crogoz

gradle-palantir-java-format/src/main/java/com/palantir/javaformat/gradle/SpotlessInterop.java

@@ -52,16 +52,17 @@ public SpotlessInterop(Supplier<FormatterService> formatterService) {
     @Override
     public void execute(JavaExtension java) {
         // Exclude generated source directories
-        // Note: We cannot simply exclude **/build/**/* because some repos might contain a build directory
-        // within the src sourceset that should be formatted.
-        java.targetExclude("**/build/generated*/**");
-        java.targetExclude("**/src/generated*/**");
-        java.targetExclude("**/generated_*src/**");
-        java.targetExclude("**/generated_*Src/**");
-        // build/groovy-dsl-plugins contains Java wrapper classes for
-        // https://docs.gradle.org/9.3.1/userguide/implementing_gradle_plugins_convention.html
-        // and don't need to be formatted.
-        java.targetExclude("**/groovy-dsl-plugins/**");
+        java.targetExclude(
+                // Note: We cannot simply exclude **/build/**/* because some repos might contain a build directory
+                // within the src sourceset that should be formatted.
+                "**/build/generated*/**",
+                "**/src/generated*/**",
+                "**/generated_*src/**",
+                "**/generated_*Src/**",
+                // build/groovy-dsl-plugins contains Java wrapper classes for
+                // https://docs.gradle.org/9.3.1/userguide/implementing_gradle_plugins_convention.html
+                // and don't need to be formatted.
+                "**/groovy-dsl-plugins/**");
         // This is configuration cache safe as happening afterEvaluate
         java.addStep(spotlessJavaFormatStep());
     }

gradle-palantir-java-format/src/test/java/com/palantir/javaformat/gradle/SpotlessExcludesTest.java

@@ -0,0 +1,115 @@
+/*
+ * (c) Copyright 2019 Palantir Technologies Inc. All rights reserved.
+ *
+ * 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.palantir.javaformat.gradle;
+
+import static com.palantir.gradle.testing.assertion.GradlePluginTestAssertions.assertThat;
+
+import com.palantir.gradle.testing.execution.GradleInvoker;
+import com.palantir.gradle.testing.execution.InvocationResult;
+import com.palantir.gradle.testing.junit.DisabledConfigurationCache;
+import com.palantir.gradle.testing.junit.GradlePluginTests;
+import com.palantir.gradle.testing.project.RootProject;
+import java.io.File;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.ValueSource;
+
+@GradlePluginTests
+@DisabledConfigurationCache
+class SpotlessExcludesTest {
+
+    private static final String CLASSPATH_FILE = new File("build/impl.classpath").getAbsolutePath();
+
+    @BeforeEach
+    void setup(RootProject project) {
+        project.buildGradle()
+                .plugins()
+                .add("java")
+                .add("com.palantir.java-format")
+                .add("com.diffplug.spotless");
+
+        project.buildGradle().append("""
+            dependencies {
+                palantirJavaFormat files(file("%s").text.split(':'))
+            }
+            """, CLASSPATH_FILE);
+        // Add jvm args to allow spotless and formatter gradle plugins to run with Java 16+
+        project.gradlePropertiesFile()
+                .appendProperty(
+                        "org.gradle.jvmargs",
+                        "--add-exports jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED "
+                                + "--add-exports jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED "
+                                + "--add-exports jdk.compiler/com.sun.tools.javac.parser=ALL-UNNAMED "
+                                + "--add-exports jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED "
+                                + "--add-exports jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED");
+    }
+
+    @ParameterizedTest
+    @ValueSource(
+            strings = {
+                "build/generated/java",
+                "src/generated/java",
+                "src/main/generated_testsrc",
+                "src/main/generated_foo_testsrc",
+                "generated_testSrc",
+                "build/groovy-dsl-plugins/output"
+            })
+    void format_ignores_excluded_directories(String srcDir, GradleInvoker gradle, RootProject project) {
+        project.buildGradle().append("""
+            sourceSets {
+                main {
+                    java { srcDir '%s' }
+                }
+            }
+            """, srcDir);
+
+        project.file(srcDir + "/test/Test.java").overwrite("""
+            package test;
+            import java.lang.Void;
+            public class Test { Void test() { return null; } }
+            """);
+
+        InvocationResult result = gradle.withArgs("spotlessJavaCheck").buildsSuccessfully();
+
+        assertThat(result).task(":spotlessJava").succeeded();
+    }
+
+    @ParameterizedTest
+    @ValueSource(
+            strings = {
+                "foo/generated_foo/src/bar",
+                "src/main/java/test/generatedNamespace",
+            })
+    void format_checks_non_generated_files(String srcDir, GradleInvoker gradle, RootProject project) {
+        project.buildGradle().append("""
+            sourceSets {
+                main {
+                    java { srcDir '%s' }
+                }
+            }
+            """, srcDir);
+
+        project.file(srcDir + "/Test.java").overwrite("""
+            package test;
+            import java.lang.Void;
+            public class Test { Void test() { return null; } }
+            """);
+
+        InvocationResult result = gradle.withArgs("spotlessJavaCheck").buildsWithFailure();
+
+        assertThat(result).task(":spotlessJava").succeeded();
+    }
+}