Disable failing Gradle plugin tests on JDK 17

See spring-projectsgh-26767
dreis2211 · Jul 14, 2021 · adc969b · adc969b
1 parent d8f9a20
commit adc969b
Show file tree

Hide file tree

Showing 8 changed files with 146 additions and 10 deletions.
diff --git a/...rc/test/java/org/springframework/boot/gradle/junit/DisabledTemplateInvocationContext.java b/...rc/test/java/org/springframework/boot/gradle/junit/DisabledTemplateInvocationContext.java
@@ -0,0 +1,49 @@
+/*
+ * Copyright 2012-2021 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.junit;
+
+import java.util.Collections;
+import java.util.List;
+
+import org.junit.jupiter.api.extension.ConditionEvaluationResult;
+import org.junit.jupiter.api.extension.ExecutionCondition;
+import org.junit.jupiter.api.extension.Extension;
+import org.junit.jupiter.api.extension.ExtensionContext;
+import org.junit.jupiter.api.extension.TestTemplateInvocationContext;
+
+/**
+ * {@link TestTemplateInvocationContext} that disables tests.
+ *
+ * @author Christoph Dreis
+ */
+final class DisabledTemplateInvocationContext implements TestTemplateInvocationContext {
+
+	@Override
+	public List<Extension> getAdditionalExtensions() {
+		return Collections.singletonList(new DisabledCondition());
+	}
+
+	private static class DisabledCondition implements ExecutionCondition {
+
+		@Override
+		public ConditionEvaluationResult evaluateExecutionCondition(ExtensionContext context) {
+			return ConditionEvaluationResult.disabled("");
+		}
+
+	}
+
+}
diff --git a/...gin/src/test/java/org/springframework/boot/gradle/junit/GradleCompatibilityExtension.java b/...gin/src/test/java/org/springframework/boot/gradle/junit/GradleCompatibilityExtension.java
@@ -57,6 +57,9 @@ final class GradleCompatibilityExtension implements TestTemplateInvocationContex
 
 	@Override
 	public Stream<TestTemplateInvocationContext> provideTestTemplateInvocationContexts(ExtensionContext context) {
+		if (JavaVersion.current() == JavaVersion.VERSION_17) {
+			return Stream.of(new DisabledTemplateInvocationContext());
+		}
 		Stream<String> gradleVersions = GRADLE_VERSIONS.stream().map((version) -> {
 			if (version.equals("current")) {
 				return GradleVersion.current().getVersion();

diff --git a/...e-plugin/src/test/java/org/springframework/boot/gradle/junit/GradleMultiDslExtension.java b/...e-plugin/src/test/java/org/springframework/boot/gradle/junit/GradleMultiDslExtension.java
@@ -42,6 +42,9 @@ public class GradleMultiDslExtension implements TestTemplateInvocationContextPro
 
 	@Override
 	public Stream<TestTemplateInvocationContext> provideTestTemplateInvocationContexts(ExtensionContext context) {
+		if (JavaVersion.current() == JavaVersion.VERSION_17) {
+			return Stream.of(new DisabledTemplateInvocationContext());
+		}
 		return Stream.of(Dsl.values()).map(DslTestTemplateInvocationContext::new);
 	}
 

diff --git a/...adle-plugin/src/test/java/org/springframework/boot/gradle/junit/GradleProjectBuilder.java b/...adle-plugin/src/test/java/org/springframework/boot/gradle/junit/GradleProjectBuilder.java
@@ -0,0 +1,81 @@
+/*
+ * Copyright 2012-2021 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.junit;
+
+import java.io.File;
+
+import org.gradle.api.JavaVersion;
+import org.gradle.api.Project;
+import org.gradle.internal.nativeintegration.services.NativeServices;
+import org.gradle.testfixtures.ProjectBuilder;
+import org.gradle.testfixtures.internal.ProjectBuilderImpl;
+
+import org.springframework.util.Assert;
+import org.springframework.util.StringUtils;
+
+/**
+ * Helper class to build Gradle {@link Project Projects} for test fixtures. Wraps
+ * functionality of Gradle's own {@link ProjectBuilder} in order to workaround an issue on
+ * JDK 17.
+ *
+ * @author Christoph Dreis
+ * @see <a href="https://github.com/gradle/gradle/issues/16857">Gradle Support JDK 17</a>
+ */
+public final class GradleProjectBuilder {
+
+	private File projectDir;
+
+	private String name;
+
+	private GradleProjectBuilder() {
+	}
+
+	public static GradleProjectBuilder builder() {
+		return new GradleProjectBuilder();
+	}
+
+	public GradleProjectBuilder withProjectDir(File dir) {
+		this.projectDir = dir;
+		return this;
+	}
+
+	public GradleProjectBuilder withName(String name) {
+		this.name = name;
+		return this;
+	}
+
+	public Project build() {
+		Assert.notNull(this.projectDir, "ProjectDir must not be null");
+		ProjectBuilder builder = ProjectBuilder.builder();
+		builder.withProjectDir(this.projectDir);
+		File userHome = new File(this.projectDir, "userHome");
+		builder.withGradleUserHomeDir(userHome);
+		if (StringUtils.hasText(this.name)) {
+			builder.withName(this.name);
+		}
+		if (JavaVersion.current() == JavaVersion.VERSION_17) {
+			NativeServices.initialize(userHome);
+			try {
+				ProjectBuilderImpl.getGlobalServices();
+			}
+			catch (Throwable ignore) {
+			}
+		}
+		return builder.build();
+	}
+
+}
diff --git a/...le-plugin/src/test/java/org/springframework/boot/gradle/plugin/SpringBootPluginTests.java b/...le-plugin/src/test/java/org/springframework/boot/gradle/plugin/SpringBootPluginTests.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2020 the original author or authors.
+ * Copyright 2012-2021 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.
@@ -20,10 +20,10 @@
 
 import org.gradle.api.Project;
 import org.gradle.api.artifacts.Configuration;
-import org.gradle.testfixtures.ProjectBuilder;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.io.TempDir;
 
+import org.springframework.boot.gradle.junit.GradleProjectBuilder;
 import org.springframework.boot.testsupport.classpath.ClassPathExclusions;
 
 import static org.assertj.core.api.Assertions.assertThat;
@@ -42,7 +42,7 @@ class SpringBootPluginTests {
 
 	@Test
 	void bootArchivesConfigurationsCannotBeResolved() {
-		Project project = ProjectBuilder.builder().withProjectDir(this.temp).build();
+		Project project = GradleProjectBuilder.builder().withProjectDir(this.temp).build();
 		project.getPlugins().apply(SpringBootPlugin.class);
 		Configuration bootArchives = project.getConfigurations()
 				.getByName(SpringBootPlugin.BOOT_ARCHIVES_CONFIGURATION_NAME);

diff --git a/...-plugin/src/test/java/org/springframework/boot/gradle/tasks/buildinfo/BuildInfoTests.java b/...-plugin/src/test/java/org/springframework/boot/gradle/tasks/buildinfo/BuildInfoTests.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2020 the original author or authors.
+ * Copyright 2012-2021 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.
@@ -26,10 +26,10 @@
 import org.gradle.api.Project;
 import org.gradle.api.internal.project.ProjectInternal;
 import org.gradle.initialization.GradlePropertiesController;
-import org.gradle.testfixtures.ProjectBuilder;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.io.TempDir;
 
+import org.springframework.boot.gradle.junit.GradleProjectBuilder;
 import org.springframework.boot.testsupport.classpath.ClassPathExclusions;
 
 import static org.assertj.core.api.Assertions.assertThat;
@@ -131,7 +131,7 @@ void additionalPropertiesAreReflectedInProperties() {
 
 	private Project createProject(String projectName) {
 		File projectDir = new File(this.temp, projectName);
-		Project project = ProjectBuilder.builder().withProjectDir(projectDir).withName(projectName).build();
+		Project project = GradleProjectBuilder.builder().withProjectDir(projectDir).withName(projectName).build();
 		((ProjectInternal) project).getServices().get(GradlePropertiesController.class)
 				.loadGradlePropertiesFrom(projectDir);
 		return project;

diff --git a/...rc/test/java/org/springframework/boot/gradle/tasks/bundling/AbstractBootArchiveTests.java b/...rc/test/java/org/springframework/boot/gradle/tasks/bundling/AbstractBootArchiveTests.java
@@ -61,11 +61,11 @@
 import org.gradle.api.internal.file.archive.ZipCopyAction;
 import org.gradle.api.tasks.bundling.AbstractArchiveTask;
 import org.gradle.api.tasks.bundling.Jar;
-import org.gradle.testfixtures.ProjectBuilder;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.io.TempDir;
 
+import org.springframework.boot.gradle.junit.GradleProjectBuilder;
 import org.springframework.boot.loader.tools.DefaultLaunchScript;
 import org.springframework.boot.loader.tools.JarModeLibrary;
 
@@ -115,7 +115,7 @@ void createTask() {
 		try {
 			File projectDir = new File(this.temp, "project");
 			projectDir.mkdirs();
-			this.project = ProjectBuilder.builder().withProjectDir(projectDir).build();
+			this.project = GradleProjectBuilder.builder().withProjectDir(projectDir).build();
 			this.project.setDescription("Test project for " + this.taskClass.getSimpleName());
 			this.task = configure(this.project.getTasks().create("testArchive", this.taskClass));
 		}

diff --git a/...gin/src/test/java/org/springframework/boot/gradle/tasks/bundling/BootBuildImageTests.java b/...gin/src/test/java/org/springframework/boot/gradle/tasks/bundling/BootBuildImageTests.java
@@ -24,14 +24,14 @@
 import org.gradle.api.GradleException;
 import org.gradle.api.JavaVersion;
 import org.gradle.api.Project;
-import org.gradle.testfixtures.ProjectBuilder;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.io.TempDir;
 
 import org.springframework.boot.buildpack.platform.build.BuildRequest;
 import org.springframework.boot.buildpack.platform.build.BuildpackReference;
 import org.springframework.boot.buildpack.platform.build.PullPolicy;
 import org.springframework.boot.buildpack.platform.docker.type.Binding;
+import org.springframework.boot.gradle.junit.GradleProjectBuilder;
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
@@ -55,7 +55,7 @@ class BootBuildImageTests {
 	BootBuildImageTests() {
 		File projectDir = new File(this.temp, "project");
 		projectDir.mkdirs();
-		this.project = ProjectBuilder.builder().withProjectDir(projectDir).withName("build-image-test").build();
+		this.project = GradleProjectBuilder.builder().withProjectDir(projectDir).withName("build-image-test").build();
 		this.project.setDescription("Test project for BootBuildImage");
 		this.buildImage = this.project.getTasks().create("buildImage", BootBuildImage.class);
 	}