From 1240c59482b36cba7686d6ae0bc1142a7e77803c Mon Sep 17 00:00:00 2001 From: Andy Wilkinson Date: Tue, 17 Sep 2024 20:06:23 +0100 Subject: [PATCH] Only configure plugin classpath where it's needed When spring-boot-gradle-plugin is using GradleRunner, it needs to be configured with a custom plugin classpath to account for the fact that our Gradle plugin is on the classpath of the system classloader but some of the other plugins would only be available on a Gradle-created classloader. This imbalance cause class loading problems as code in spring-boot-gradle-plugin can't see types at runtime that are only available on the Gradle-created classloader. To overcome this, we need to configure the GradleRunner with a custom plugin classpath that contains both spring-boot-gradle-plugin and all of the other plugins that are used in its various integration tests. Previously, this was done in GradleBuild that's used by both spring-boot-gradle-plugin and spring-boot-image-tests. This caused a problem as spring-boot-image-tests does not have the above-described problem and trying to correct it did not work leaving tests that use spring-boot-gradle-plugin unable to see other plugins such that the native image plugin. This commit reworks the customization of the plugin classpath so that it's only done in spring-boot-gradle-plugin's integration tests. Closes gh-42338 --- .../spring-boot-gradle-plugin/build.gradle | 11 ++ .../junit/GradleCompatibilityExtension.java | 3 +- .../gradle/junit/GradleMultiDslExtension.java | 5 +- .../KotlinPluginActionIntegrationTests.java | 3 +- .../SpringBootPluginIntegrationTests.java | 3 +- .../testkit/PluginClasspathGradleBuild.java | 109 ++++++++++++++++++ .../build.gradle | 10 +- .../gradle/testkit/GradleBuild.java | 64 +--------- .../spring-boot-image-tests/build.gradle | 1 - 9 files changed, 132 insertions(+), 77 deletions(-) create mode 100644 spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/test/java/org/springframework/boot/gradle/testkit/PluginClasspathGradleBuild.java diff --git a/spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/build.gradle b/spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/build.gradle index e491019a75..5e8bb3ff58 100644 --- a/spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/build.gradle +++ b/spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/build.gradle @@ -104,10 +104,21 @@ dependencies { testImplementation(project(":spring-boot-project:spring-boot-tools:spring-boot-gradle-test-support")) testImplementation(project(":spring-boot-project:spring-boot-tools:spring-boot-test-support")) + testImplementation("com.fasterxml.jackson.core:jackson-databind") + testImplementation("com.fasterxml.jackson.module:jackson-module-parameter-names") testImplementation("com.tngtech.archunit:archunit-junit5:0.22.0") + testImplementation("net.java.dev.jna:jna-platform") + testImplementation("org.apache.commons:commons-compress") + testImplementation("org.apache.httpcomponents.client5:httpclient5") testImplementation("org.assertj:assertj-core") + testImplementation("org.graalvm.buildtools:native-gradle-plugin") + testImplementation("org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlinVersion") + testImplementation("org.jetbrains.kotlin:kotlin-compiler-embeddable:$kotlinVersion") + testImplementation("org.jetbrains.kotlin:kotlin-compiler-runner:$kotlinVersion") + testImplementation("org.jetbrains.kotlin:kotlin-daemon-client:$kotlinVersion") testImplementation("org.junit.jupiter:junit-jupiter") testImplementation("org.mockito:mockito-core") + testImplementation("org.tomlj:tomlj:1.0.0") } gradlePlugin { diff --git a/spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/test/java/org/springframework/boot/gradle/junit/GradleCompatibilityExtension.java b/spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/test/java/org/springframework/boot/gradle/junit/GradleCompatibilityExtension.java index 5f339a7f8c..701b0a4895 100644 --- a/spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/test/java/org/springframework/boot/gradle/junit/GradleCompatibilityExtension.java +++ b/spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/test/java/org/springframework/boot/gradle/junit/GradleCompatibilityExtension.java @@ -31,6 +31,7 @@ import org.junit.jupiter.api.extension.TestTemplateInvocationContext; import org.junit.jupiter.api.extension.TestTemplateInvocationContextProvider; import org.junit.platform.commons.util.AnnotationUtils; +import org.springframework.boot.gradle.testkit.PluginClasspathGradleBuild; import org.springframework.boot.testsupport.gradle.testkit.GradleBuild; import org.springframework.boot.testsupport.gradle.testkit.GradleBuildExtension; import org.springframework.boot.testsupport.gradle.testkit.GradleVersions; @@ -96,7 +97,7 @@ final class GradleCompatibilityExtension implements TestTemplateInvocationContex @Override public List getAdditionalExtensions() { - GradleBuild gradleBuild = new GradleBuild().gradleVersion(this.gradleVersion); + GradleBuild gradleBuild = new PluginClasspathGradleBuild().gradleVersion(this.gradleVersion); if (this.configurationCache) { gradleBuild.configurationCache(); } diff --git a/spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/test/java/org/springframework/boot/gradle/junit/GradleMultiDslExtension.java b/spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/test/java/org/springframework/boot/gradle/junit/GradleMultiDslExtension.java index 8171ff8e54..41d82960c9 100644 --- a/spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/test/java/org/springframework/boot/gradle/junit/GradleMultiDslExtension.java +++ b/spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/test/java/org/springframework/boot/gradle/junit/GradleMultiDslExtension.java @@ -26,6 +26,7 @@ import org.junit.jupiter.api.extension.ExtensionContext; import org.junit.jupiter.api.extension.TestTemplateInvocationContext; import org.junit.jupiter.api.extension.TestTemplateInvocationContextProvider; +import org.springframework.boot.gradle.testkit.PluginClasspathGradleBuild; import org.springframework.boot.testsupport.gradle.testkit.Dsl; import org.springframework.boot.testsupport.gradle.testkit.GradleBuild; import org.springframework.boot.testsupport.gradle.testkit.GradleBuildExtension; @@ -60,8 +61,8 @@ public class GradleMultiDslExtension implements TestTemplateInvocationContextPro @Override public List getAdditionalExtensions() { - GradleBuild gradleBuild = new GradleBuild(this.dsl); - gradleBuild.gradleVersion(GradleVersions.minimumCompatible()); + GradleBuild gradleBuild = new PluginClasspathGradleBuild(this.dsl) + .gradleVersion(GradleVersions.minimumCompatible()); return Arrays.asList(new GradleBuildFieldSetter(gradleBuild), new GradleBuildExtension()); } diff --git a/spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/test/java/org/springframework/boot/gradle/plugin/KotlinPluginActionIntegrationTests.java b/spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/test/java/org/springframework/boot/gradle/plugin/KotlinPluginActionIntegrationTests.java index ab32302702..b3978b47f7 100644 --- a/spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/test/java/org/springframework/boot/gradle/plugin/KotlinPluginActionIntegrationTests.java +++ b/spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/test/java/org/springframework/boot/gradle/plugin/KotlinPluginActionIntegrationTests.java @@ -28,6 +28,7 @@ import org.junit.jupiter.api.condition.DisabledForJreRange; import org.junit.jupiter.api.condition.JRE; import org.junit.jupiter.api.extension.ExtendWith; +import org.springframework.boot.gradle.testkit.PluginClasspathGradleBuild; import org.springframework.boot.testsupport.gradle.testkit.GradleBuild; import org.springframework.boot.testsupport.gradle.testkit.GradleBuildExtension; @@ -42,7 +43,7 @@ import static org.assertj.core.api.Assertions.assertThat; @ExtendWith(GradleBuildExtension.class) class KotlinPluginActionIntegrationTests { - GradleBuild gradleBuild = new GradleBuild(); + GradleBuild gradleBuild = new PluginClasspathGradleBuild(); @Test void noKotlinVersionPropertyWithoutKotlinPlugin() { diff --git a/spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/test/java/org/springframework/boot/gradle/plugin/SpringBootPluginIntegrationTests.java b/spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/test/java/org/springframework/boot/gradle/plugin/SpringBootPluginIntegrationTests.java index 8128321c38..6fe2654917 100644 --- a/spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/test/java/org/springframework/boot/gradle/plugin/SpringBootPluginIntegrationTests.java +++ b/spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/test/java/org/springframework/boot/gradle/plugin/SpringBootPluginIntegrationTests.java @@ -22,6 +22,7 @@ import org.junit.jupiter.api.condition.DisabledForJreRange; import org.junit.jupiter.api.condition.JRE; import org.junit.jupiter.api.extension.ExtendWith; +import org.springframework.boot.gradle.testkit.PluginClasspathGradleBuild; import org.springframework.boot.testsupport.gradle.testkit.GradleBuild; import org.springframework.boot.testsupport.gradle.testkit.GradleBuildExtension; @@ -35,7 +36,7 @@ import static org.assertj.core.api.Assertions.assertThat; @ExtendWith(GradleBuildExtension.class) class SpringBootPluginIntegrationTests { - final GradleBuild gradleBuild = new GradleBuild(); + final GradleBuild gradleBuild = new PluginClasspathGradleBuild(); @Test @DisabledForJreRange(min = JRE.JAVA_20) diff --git a/spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/test/java/org/springframework/boot/gradle/testkit/PluginClasspathGradleBuild.java b/spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/test/java/org/springframework/boot/gradle/testkit/PluginClasspathGradleBuild.java new file mode 100644 index 0000000000..f5a9e6029e --- /dev/null +++ b/spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/test/java/org/springframework/boot/gradle/testkit/PluginClasspathGradleBuild.java @@ -0,0 +1,109 @@ +/* + * Copyright 2012-2024 the original author or authors. + * + * 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 + * + * https://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 org.springframework.boot.gradle.testkit; + +import java.io.File; +import java.io.IOException; +import java.util.Arrays; +import java.util.List; + +import com.fasterxml.jackson.annotation.JsonView; +import com.fasterxml.jackson.core.Versioned; +import com.fasterxml.jackson.databind.Module; +import com.fasterxml.jackson.module.paramnames.ParameterNamesModule; +import com.sun.jna.Platform; +import io.spring.gradle.dependencymanagement.DependencyManagementPlugin; +import org.antlr.v4.runtime.Lexer; +import org.apache.commons.compress.archivers.ArchiveEntry; +import org.apache.hc.client5.http.io.HttpClientConnectionManager; +import org.apache.hc.core5.http.HttpRequest; +import org.apache.hc.core5.http2.HttpVersionPolicy; +import org.gradle.testkit.runner.GradleRunner; +import org.jetbrains.kotlin.gradle.model.KotlinProject; +import org.jetbrains.kotlin.gradle.plugin.KotlinCompilerPluginSupportPlugin; +import org.jetbrains.kotlin.gradle.plugin.KotlinPlatformJvmPlugin; +import org.jetbrains.kotlin.project.model.LanguageSettings; +import org.jetbrains.kotlin.tooling.core.KotlinToolingVersion; +import org.tomlj.Toml; + +import org.springframework.asm.ClassVisitor; +import org.springframework.boot.buildpack.platform.build.BuildRequest; +import org.springframework.boot.loader.tools.LaunchScript; +import org.springframework.boot.testsupport.gradle.testkit.Dsl; +import org.springframework.boot.testsupport.gradle.testkit.GradleBuild; + +/** + * Custom {@link GradleBuild} that configures the + * {@link GradleRunner#withPluginClasspath(Iterable) plugin classpath}. + * + * @author Andy Wilkinson + * @author Scott Frederick + */ +public class PluginClasspathGradleBuild extends GradleBuild { + + public PluginClasspathGradleBuild() { + super(); + } + + public PluginClasspathGradleBuild(Dsl dsl) { + super(dsl); + } + + @Override + public GradleRunner prepareRunner(String... arguments) throws IOException { + return super.prepareRunner(arguments).withPluginClasspath(pluginClasspath()); + } + + private List pluginClasspath() { + return Arrays.asList(new File("bin/main"), new File("build/classes/java/main"), + new File("build/resources/main"), new File(pathOfJarContaining(LaunchScript.class)), + new File(pathOfJarContaining(ClassVisitor.class)), + new File(pathOfJarContaining(DependencyManagementPlugin.class)), + new File(pathOfJarContaining("org.jetbrains.kotlin.cli.common.PropertiesKt")), + new File(pathOfJarContaining(KotlinPlatformJvmPlugin.class)), + new File(pathOfJarContaining(KotlinProject.class)), + new File(pathOfJarContaining(KotlinToolingVersion.class)), + new File(pathOfJarContaining("org.jetbrains.kotlin.daemon.client.KotlinCompilerClient")), + new File(pathOfJarContaining(KotlinCompilerPluginSupportPlugin.class)), + new File(pathOfJarContaining(LanguageSettings.class)), + new File(pathOfJarContaining(ArchiveEntry.class)), new File(pathOfJarContaining(BuildRequest.class)), + new File(pathOfJarContaining(HttpClientConnectionManager.class)), + new File(pathOfJarContaining(HttpRequest.class)), + new File(pathOfJarContaining(HttpVersionPolicy.class)), new File(pathOfJarContaining(Module.class)), + new File(pathOfJarContaining(Versioned.class)), + new File(pathOfJarContaining(ParameterNamesModule.class)), + new File(pathOfJarContaining(JsonView.class)), new File(pathOfJarContaining(Platform.class)), + new File(pathOfJarContaining(Toml.class)), new File(pathOfJarContaining(Lexer.class)), + new File(pathOfJarContaining("org.graalvm.buildtools.gradle.NativeImagePlugin")), + new File(pathOfJarContaining("org.graalvm.reachability.GraalVMReachabilityMetadataRepository")), + new File(pathOfJarContaining("org.graalvm.buildtools.utils.SharedConstants"))); + } + + private String pathOfJarContaining(String className) { + try { + return pathOfJarContaining(Class.forName(className)); + } + catch (ClassNotFoundException ex) { + throw new IllegalArgumentException(ex); + } + } + + private String pathOfJarContaining(Class type) { + return type.getProtectionDomain().getCodeSource().getLocation().getPath(); + } + +} diff --git a/spring-boot-project/spring-boot-tools/spring-boot-gradle-test-support/build.gradle b/spring-boot-project/spring-boot-tools/spring-boot-gradle-test-support/build.gradle index c71fca96a3..48a3ac40f9 100644 --- a/spring-boot-project/spring-boot-tools/spring-boot-gradle-test-support/build.gradle +++ b/spring-boot-project/spring-boot-tools/spring-boot-gradle-test-support/build.gradle @@ -9,15 +9,7 @@ dependencies { compileOnly("org.junit.jupiter:junit-jupiter") implementation(gradleTestKit()) - implementation(project(":spring-boot-project:spring-boot-tools:spring-boot-buildpack-platform")) - implementation(project(":spring-boot-project:spring-boot-tools:spring-boot-loader-tools")) implementation("io.spring.gradle:dependency-management-plugin") - implementation("org.graalvm.buildtools:native-gradle-plugin") - implementation("org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlinVersion") - implementation("org.jetbrains.kotlin:kotlin-compiler-embeddable:$kotlinVersion") - implementation("org.jetbrains.kotlin:kotlin-compiler-runner:$kotlinVersion") - implementation("org.jetbrains.kotlin:kotlin-daemon-client:$kotlinVersion") - implementation("org.apache.commons:commons-compress:$commonsCompressVersion") - implementation("org.assertj:assertj-core") + implementation("org.springframework:spring-core") } diff --git a/spring-boot-project/spring-boot-tools/spring-boot-gradle-test-support/src/main/java/org/springframework/boot/testsupport/gradle/testkit/GradleBuild.java b/spring-boot-project/spring-boot-tools/spring-boot-gradle-test-support/src/main/java/org/springframework/boot/testsupport/gradle/testkit/GradleBuild.java index 20ebe5a95c..332deba5f8 100644 --- a/spring-boot-project/spring-boot-tools/spring-boot-gradle-test-support/src/main/java/org/springframework/boot/testsupport/gradle/testkit/GradleBuild.java +++ b/spring-boot-project/spring-boot-tools/spring-boot-gradle-test-support/src/main/java/org/springframework/boot/testsupport/gradle/testkit/GradleBuild.java @@ -32,31 +32,11 @@ import java.util.Map.Entry; import java.util.Properties; import java.util.jar.JarFile; -import com.fasterxml.jackson.annotation.JsonView; -import com.fasterxml.jackson.core.Versioned; -import com.fasterxml.jackson.databind.Module; -import com.fasterxml.jackson.module.paramnames.ParameterNamesModule; -import com.sun.jna.Platform; -import io.spring.gradle.dependencymanagement.DependencyManagementPlugin; import io.spring.gradle.dependencymanagement.dsl.DependencyManagementExtension; -import org.antlr.v4.runtime.Lexer; -import org.apache.commons.compress.archivers.ArchiveEntry; -import org.apache.hc.client5.http.io.HttpClientConnectionManager; -import org.apache.hc.core5.http.HttpRequest; -import org.apache.hc.core5.http2.HttpVersionPolicy; import org.gradle.testkit.runner.BuildResult; import org.gradle.testkit.runner.GradleRunner; import org.gradle.util.GradleVersion; -import org.jetbrains.kotlin.gradle.model.KotlinProject; -import org.jetbrains.kotlin.gradle.plugin.KotlinCompilerPluginSupportPlugin; -import org.jetbrains.kotlin.gradle.plugin.KotlinPlatformJvmPlugin; -import org.jetbrains.kotlin.project.model.LanguageSettings; -import org.jetbrains.kotlin.tooling.core.KotlinToolingVersion; -import org.tomlj.Toml; -import org.springframework.asm.ClassVisitor; -import org.springframework.boot.buildpack.platform.build.BuildRequest; -import org.springframework.boot.loader.tools.LaunchScript; import org.springframework.util.FileCopyUtils; import org.springframework.util.FileSystemUtils; @@ -95,7 +75,7 @@ public class GradleBuild { this(Dsl.GROOVY); } - public GradleBuild(Dsl dsl) { + protected GradleBuild(Dsl dsl) { this.dsl = dsl; } @@ -112,44 +92,6 @@ public class GradleBuild { FileSystemUtils.deleteRecursively(this.projectDir); } - private List pluginClasspath() { - return Arrays.asList(new File("bin/main"), new File("build/classes/java/main"), - new File("build/resources/main"), new File(pathOfJarContaining(LaunchScript.class)), - new File(pathOfJarContaining(ClassVisitor.class)), - new File(pathOfJarContaining(DependencyManagementPlugin.class)), - new File(pathOfJarContaining("org.jetbrains.kotlin.cli.common.PropertiesKt")), - new File(pathOfJarContaining(KotlinPlatformJvmPlugin.class)), - new File(pathOfJarContaining(KotlinProject.class)), - new File(pathOfJarContaining(KotlinToolingVersion.class)), - new File(pathOfJarContaining("org.jetbrains.kotlin.daemon.client.KotlinCompilerClient")), - new File(pathOfJarContaining(KotlinCompilerPluginSupportPlugin.class)), - new File(pathOfJarContaining(LanguageSettings.class)), - new File(pathOfJarContaining(ArchiveEntry.class)), new File(pathOfJarContaining(BuildRequest.class)), - new File(pathOfJarContaining(HttpClientConnectionManager.class)), - new File(pathOfJarContaining(HttpRequest.class)), - new File(pathOfJarContaining(HttpVersionPolicy.class)), new File(pathOfJarContaining(Module.class)), - new File(pathOfJarContaining(Versioned.class)), - new File(pathOfJarContaining(ParameterNamesModule.class)), - new File(pathOfJarContaining(JsonView.class)), new File(pathOfJarContaining(Platform.class)), - new File(pathOfJarContaining(Toml.class)), new File(pathOfJarContaining(Lexer.class)), - new File(pathOfJarContaining("org.graalvm.buildtools.gradle.NativeImagePlugin")), - new File(pathOfJarContaining("org.graalvm.reachability.GraalVMReachabilityMetadataRepository")), - new File(pathOfJarContaining("org.graalvm.buildtools.utils.SharedConstants"))); - } - - private String pathOfJarContaining(String className) { - try { - return pathOfJarContaining(Class.forName(className)); - } - catch (ClassNotFoundException ex) { - throw new IllegalArgumentException(ex); - } - } - - private String pathOfJarContaining(Class type) { - return type.getProtectionDomain().getCodeSource().getLocation().getPath(); - } - public GradleBuild script(String script) { this.script = script.endsWith(this.dsl.getExtension()) ? script : script + this.dsl.getExtension(); return this; @@ -230,9 +172,7 @@ public class GradleBuild { if (repository.exists()) { FileSystemUtils.copyRecursively(repository, new File(this.projectDir, "repository")); } - GradleRunner gradleRunner = GradleRunner.create() - .withProjectDir(this.projectDir) - .withPluginClasspath(pluginClasspath()); + GradleRunner gradleRunner = GradleRunner.create().withProjectDir(this.projectDir); if (!this.configurationCache) { // See https://github.com/gradle/gradle/issues/14125 gradleRunner.withDebug(true); diff --git a/spring-boot-system-tests/spring-boot-image-tests/build.gradle b/spring-boot-system-tests/spring-boot-image-tests/build.gradle index 40cd4ee601..8e11ad60d0 100644 --- a/spring-boot-system-tests/spring-boot-image-tests/build.gradle +++ b/spring-boot-system-tests/spring-boot-image-tests/build.gradle @@ -52,7 +52,6 @@ dependencies { } systemTestImplementation(project(":spring-boot-project:spring-boot-starters:spring-boot-starter-test")) - systemTestImplementation(project(":spring-boot-project:spring-boot-tools:spring-boot-gradle-plugin")) systemTestImplementation(project(":spring-boot-project:spring-boot-tools:spring-boot-gradle-test-support")) systemTestImplementation(project(":spring-boot-project:spring-boot-tools:spring-boot-buildpack-platform")) systemTestImplementation(gradleTestKit())