Excavator: Migrate Groovy nebula test SupportsSpotless622 to the new Java Junit framework

Author: svc-excavator-bot

build.gradle

@@ -17,7 +17,7 @@ buildscript {
         classpath 'com.palantir.gradle.idea-language-injector:gradle-idea-language-injector:0.2.0'
         classpath 'com.palantir.gradle.jdks:gradle-jdks:0.69.0'
         classpath 'com.palantir.gradle.jdkslatest:gradle-jdks-latest:0.24.0'
-        classpath 'com.palantir.gradle.plugintesting:gradle-plugin-testing:0.6.0'
+        classpath 'com.palantir.gradle.plugintesting:gradle-plugin-testing:0.39.0'
         classpath 'com.palantir.javaformat:gradle-palantir-java-format:2.82.0'
         classpath 'com.palantir.suppressible-error-prone:gradle-suppressible-error-prone:2.26.0'
         classpath 'me.champeau.jmh:jmh-gradle-plugin:0.7.3'

gradle-palantir-java-format/src/test/groovy/com/palantir/javaformat/gradle/SupportsSpotless622.groovy

@@ -0,0 +1,116 @@
+/*
+ * (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 com.google.common.base.Splitter;
+import com.palantir.gradle.testing.execution.GradleInvoker;
+import com.palantir.gradle.testing.files.gradle.GradleFile;
+import com.palantir.gradle.testing.junit.GradlePluginTests;
+import com.palantir.gradle.testing.project.RootProject;
+import java.io.File;
+import java.io.IOException;
+import java.nio.file.Files;
+import java.util.List;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+
+/**
+ * When we were getting gradle-baseline to support the configuration cache, spotless had some poorly written tasks
+ * which caused issues with the configuration cache.
+ *
+ * Bumping spotless to 6.22.0 fixed this, but revealed a new error — the {@code palantirJavaFormat} configuration was
+ * being <a href="https://github.com/palantir/palantir-java-format/blob/b7b5995df3be690780939c0d0cb2ec49b99c68c8/gradle-palantir-java-format/src/main/java/com/palantir/javaformat/gradle/spotless/NativePalantirJavaFormatStep.java#L45"> resolved eagerly</a>.
+ *
+ * gradle-consistent-versions enforces against resolving configurations at configuration time, and throws an error.
+ *
+ * This test forces creation of the spotless steps, which will reveal any eager resolution of configurations.
+ */
+@GradlePluginTests
+class SupportsSpotless622 {
+    private static final String CLASSPATH_FILE = new File("build/impl.classpath").getAbsolutePath();
+
+    @BeforeEach
+    void setup(RootProject rootProject) throws IOException {
+        rootProject.buildGradle().overwrite("""
+            buildscript {
+                repositories {
+                    mavenCentral() { metadataSources { mavenPom(); ignoreGradleMetadataRedirection() } }
+                    gradlePluginPortal() { metadataSources { mavenPom(); ignoreGradleMetadataRedirection() } }
+                }
+                 dependencies {
+                     classpath 'com.palantir.gradle.consistentversions:gradle-consistent-versions:2.34.0'
+                     classpath 'com.diffplug.spotless:spotless-plugin-gradle:6.22.0'
+                 }
+            }
+
+            version = '0.1.0'
+            """);
+
+        // Apply plugins using the old syntax because these are external buildscript plugins
+        // not available via the plugins {} DSL in tests
+        // Suppressing GradleTestPluginsBlock because this test specifically tests buildscript-loaded plugins
+        @SuppressWarnings("GradleTestPluginsBlock")
+        GradleFile unused = rootProject.buildGradle().append("""
+            apply plugin: 'java'
+            apply plugin: 'com.palantir.java-format'
+            apply plugin: 'com.palantir.consistent-versions'
+            apply plugin: 'com.diffplug.spotless'
+            """);
+
+        rootProject.file("versions.props").createEmpty();
+        rootProject.file("versions.lock").createEmpty();
+    }
+
+    @Test
+    void palantir_java_format_plugin_works_with_spotless_6_22_0(GradleInvoker gradle, RootProject rootProject)
+            throws IOException {
+        // First, generate the wrapper
+        gradle.withArgs("wrapper").buildsSuccessfully();
+
+        // Read the impl.classpath file and add the palantirJavaFormat dependency
+        String classpathContent = Files.readString(new File(CLASSPATH_FILE).toPath());
+        List<String> classpathEntries = Splitter.on(':').splitToList(classpathContent);
+
+        StringBuilder dependenciesBlock = new StringBuilder("dependencies {\n");
+        dependenciesBlock.append("    palantirJavaFormat files(\n");
+        for (int i = 0; i < classpathEntries.size(); i++) {
+            dependenciesBlock
+                    .append("        '")
+                    .append(classpathEntries.get(i))
+                    .append("'");
+            if (i < classpathEntries.size() - 1) {
+                dependenciesBlock.append(",");
+            }
+            dependenciesBlock.append("\n");
+        }
+        dependenciesBlock.append("    )\n");
+        dependenciesBlock.append("}\n");
+
+        rootProject.buildGradle().append(dependenciesBlock.toString());
+
+        rootProject.buildGradle().append("""
+
+            // This forces the realization of the spotlessJava task, creating the spotless steps.
+            // If any configurations are eagerly resolved in the spotless steps,
+            // consistent-versions should catch it and throw here.
+            project.getTasks().getByName("spotlessJava")
+            """);
+
+        // The test passes if the build succeeds, meaning consistent-versions did not catch
+        // eager configuration resolution, which would have caused a build failure
+        gradle.withArgs("classes", "--info").buildsSuccessfully();
+    }
+}