Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow the project to be built with Java 16 #25171

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,12 @@

package org.springframework.boot.build;

import java.io.File;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.TreeMap;
import java.util.function.Consumer;
import java.util.stream.Collectors;

import io.spring.javaformat.gradle.FormatTask;
Expand All @@ -49,6 +47,7 @@

import org.springframework.boot.build.optional.OptionalDependenciesPlugin;
import org.springframework.boot.build.testing.TestFailuresPlugin;
import org.springframework.boot.build.toolchain.ToolchainPlugin;

/**
* Conventions that are applied in the presence of the {@link JavaBasePlugin}. When the
Expand Down Expand Up @@ -103,6 +102,7 @@ void apply(Project project) {
configureTestConventions(project);
configureJarManifestConventions(project);
configureDependencyManagement(project);
configureToolchain(project);
});
}

Expand Down Expand Up @@ -145,7 +145,6 @@ private String determineImplementationTitle(Project project, Set<String> sourceJ

private void configureTestConventions(Project project) {
project.getTasks().withType(Test.class, (test) -> {
withOptionalBuildJavaHome(project, (javaHome) -> test.setExecutable(javaHome + "/bin/java"));
test.useJUnitPlatform();
test.setMaxHeapSize("1024M");
});
Expand All @@ -165,38 +164,25 @@ private boolean isCi() {
}

private void configureJavadocConventions(Project project) {
project.getTasks().withType(Javadoc.class, (javadoc) -> {
javadoc.getOptions().source("1.8").encoding("UTF-8");
withOptionalBuildJavaHome(project, (javaHome) -> javadoc.setExecutable(javaHome + "/bin/javadoc"));
});
project.getTasks().withType(Javadoc.class, (javadoc) -> javadoc.getOptions().source("1.8").encoding("UTF-8"));
}

private void configureJavaCompileConventions(Project project) {
project.getTasks().withType(JavaCompile.class, (compile) -> {
compile.getOptions().setEncoding("UTF-8");
withOptionalBuildJavaHome(project, (javaHome) -> {
compile.getOptions().setFork(true);
compile.getOptions().getForkOptions().setJavaHome(new File(javaHome));
compile.getOptions().getForkOptions().setExecutable(javaHome + "/bin/javac");
});
compile.setSourceCompatibility("1.8");
compile.setTargetCompatibility("1.8");
List<String> args = compile.getOptions().getCompilerArgs();
if (!args.contains("-parameters")) {
args.add("-parameters");
}
if (JavaVersion.current() == JavaVersion.VERSION_1_8) {
if (!project.hasProperty("toolchainVersion") && JavaVersion.current() == JavaVersion.VERSION_1_8) {
args.addAll(Arrays.asList("-Werror", "-Xlint:unchecked", "-Xlint:deprecation", "-Xlint:rawtypes",
"-Xlint:varargs"));
}
});
}

private void withOptionalBuildJavaHome(Project project, Consumer<String> consumer) {
String buildJavaHome = (String) project.findProperty("buildJavaHome");
if (buildJavaHome != null && !buildJavaHome.isEmpty()) {
consumer.accept(buildJavaHome);
}
}

private void configureSpringJavaFormat(Project project) {
project.getPlugins().apply(SpringJavaFormatPlugin.class);
project.getTasks().withType(FormatTask.class, (formatTask) -> formatTask.setEncoding("UTF-8"));
Expand Down Expand Up @@ -228,4 +214,8 @@ private void configureDependencyManagement(Project project) {
.getByName(OptionalDependenciesPlugin.OPTIONAL_CONFIGURATION_NAME).extendsFrom(dependencyManagement));
}

private void configureToolchain(Project project) {
project.getPlugins().apply(ToolchainPlugin.class);
}

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
/*
* 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.build.toolchain;

import java.util.Optional;

import org.gradle.api.Project;
import org.gradle.jvm.toolchain.JavaLanguageVersion;

/**
* DSL extension for {@link ToolchainPlugin}.
*
* @author Christoph Dreis
*/
public class ToolchainExtension {

private final Project project;

private int maximumCompatibleJavaVersion;

public ToolchainExtension(Project project) {
this.project = project;
}

public void setMaximumCompatibleJavaVersion(int maximumVersion) {
this.maximumCompatibleJavaVersion = maximumVersion;
}

public Optional<JavaLanguageVersion> getToolchainVersion() {
String toolchainVersion = (String) this.project.findProperty("toolchainVersion");
if (toolchainVersion == null) {
return Optional.empty();
}
int version = Integer.parseInt(toolchainVersion);
return getJavaLanguageVersion(version);
}

public boolean isJavaVersionSupported() {
Optional<JavaLanguageVersion> maximumVersion = getJavaLanguageVersion(this.maximumCompatibleJavaVersion);
if (!maximumVersion.isPresent()) {
return true;
}
Optional<JavaLanguageVersion> toolchainVersion = getToolchainVersion();
return toolchainVersion.isPresent() && maximumVersion.get().canCompileOrRun(toolchainVersion.get());
}

private Optional<JavaLanguageVersion> getJavaLanguageVersion(int version) {
if (version >= 8) {
return Optional.of(JavaLanguageVersion.of(version));
}
return Optional.empty();
}

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
/*
* 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.build.toolchain;

import java.util.Arrays;
import java.util.List;
import java.util.Optional;

import org.gradle.api.Action;
import org.gradle.api.Plugin;
import org.gradle.api.Project;
import org.gradle.api.tasks.compile.JavaCompile;
import org.gradle.api.tasks.javadoc.Javadoc;
import org.gradle.api.tasks.testing.Test;
import org.gradle.jvm.toolchain.JavaLanguageVersion;
import org.gradle.jvm.toolchain.JavaToolchainService;
import org.gradle.jvm.toolchain.JavaToolchainSpec;

/**
* {@link Plugin} for customizing Gradle's toolchain support.
*
* @author Christoph Dreis
*/
public class ToolchainPlugin implements Plugin<Project> {

@Override
public void apply(Project project) {
configureToolchain(project);
}

private void configureToolchain(Project project) {
ToolchainExtension toolchain = project.getExtensions().create("toolchain", ToolchainExtension.class, project);
project.afterEvaluate((evaluated) -> {
Optional<JavaLanguageVersion> toolchainVersion = toolchain.getToolchainVersion();
if (toolchainVersion.isPresent()) {
if (!toolchain.isJavaVersionSupported()) {
disableToolchainTasks(project);
}
else {
configureJavaCompileToolchain(project, toolchain);
configureJavadocToolchain(project, toolchain);
configureTestToolchain(project, toolchain);
}
}
});
}

private void disableToolchainTasks(Project project) {
project.getTasks().withType(JavaCompile.class, (task) -> task.setEnabled(false));
project.getTasks().withType(Javadoc.class, (task) -> task.setEnabled(false));
project.getTasks().withType(Test.class, (task) -> task.setEnabled(false));
}

private void configureJavaCompileToolchain(Project project, ToolchainExtension toolchain) {
project.getTasks().withType(JavaCompile.class, (compile) -> {
withOptionalJavaToolchain(toolchain).ifPresent((action) -> {
JavaToolchainService service = getJavaToolchainService(project);
compile.getJavaCompiler().set(service.compilerFor(action));
compile.getOptions().setFork(true);
// See https://github.com/gradle/gradle/issues/15538
List<String> forkArgs = Arrays.asList("--add-opens",
"jdk.compiler/com.sun.tools.javac.code=ALL-UNNAMED");
compile.getOptions().getForkOptions().getJvmArgs().addAll(forkArgs);
});
});
}

private void configureJavadocToolchain(Project project, ToolchainExtension toolchain) {
project.getTasks().withType(Javadoc.class, (javadoc) -> {
withOptionalJavaToolchain(toolchain).ifPresent((action) -> {
JavaToolchainService service = getJavaToolchainService(project);
javadoc.getJavadocTool().set(service.javadocToolFor(action));
});
});
}

private void configureTestToolchain(Project project, ToolchainExtension toolchain) {
project.getTasks().withType(Test.class, (test) -> {
withOptionalJavaToolchain(toolchain).ifPresent((action) -> {
JavaToolchainService service = getJavaToolchainService(project);
test.getJavaLauncher().set(service.launcherFor(action));
// See https://github.com/spring-projects/spring-ldap/issues/570
List<String> arguments = Arrays.asList("--add-exports=java.naming/com.sun.jndi.ldap=ALL-UNNAMED",
"--illegal-access=warn");
test.jvmArgs(arguments);
});
});
}

private JavaToolchainService getJavaToolchainService(Project project) {
return project.getExtensions().getByType(JavaToolchainService.class);
}

private Optional<Action<JavaToolchainSpec>> withOptionalJavaToolchain(ToolchainExtension toolchain) {
return toolchain.getToolchainVersion().map((toolchainVersion) -> {
Action<JavaToolchainSpec> action = (javaToolchainSpec) -> javaToolchainSpec.getLanguageVersion()
.convention(toolchainVersion);
return Optional.of(action);
}).orElse(Optional.empty());
}

}
4 changes: 2 additions & 2 deletions settings.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ rootProject.name="spring-boot-build"
settings.gradle.projectsLoaded {
gradleEnterprise {
buildScan {
if (settings.gradle.rootProject.hasProperty('buildJavaHome')) {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The idea/hope is that the build scans show the actual toolchain, but we'll see. Couldn't test this really.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here's a scan against 2.4.x with -PtoolchainVersion=16: https://ge.spring.io/s/yadj75gujofi6

Copy link
Contributor Author

@dreis2211 dreis2211 Feb 23, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder why 2.4.x is targeted here? I guess we would need Groovy 3 as well in the 2.4.x mainline to make this work. See #24946

Copy link
Member

@snicoll snicoll Feb 23, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Support for Java 16 starts with Spring Framework 5.3 which is what Spring Boot 2.4+ uses. We need a GA release of Spring Boot that folks using Java 15 could rely on once 16 is out (given that 15 will be effectively EOL at that time).

As for Groovy 3, perhaps we could upgrade to it on the Java 16 build?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I would need a little help on getting this to work on 2.4.x - I currently don't see a good way to do this sort of conditional dependency upgrade

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, this would only happen for the actual pipelines e.g. via -x :spring-boot-project:spring-boot-cli:test. I wouldn't know what I should update in this PR - cluttering every CLI test with @DisabledForJreRange seems like an overkill.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd rather find a way to disable tests for the CLI module altogether with Java 16. When we had a Maven build we used profiles to disable Surefire. I guess Gradle should have a similar feature.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you know one that is also aware of the toolchain version, that would be great. We could also use that for the gradle plugin then. I just don't know how we could exclude a whole module based on the toolchain version - apart from coming up with our own way. Let me know if I should experiment around that.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we'll have to come up with our own way. Alternatively, we could use @DisabledForJreRange all over the place. One advantage of that is the tests are disabled no matter how they're launched.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm currently writing a custom plugin that lets you specify the maximum compatible java version inside the build.gradle for that particular submodule. The plan is that this information is consumed in order to dynamically disable the things that run with the optional toolchain.

value('Build Java home', settings.gradle.rootProject.getProperty('buildJavaHome'))
if (settings.gradle.rootProject.hasProperty('toolchainVersion')) {
value('Toolchain Version', settings.gradle.rootProject.getProperty('toolchainVersion'))
}

settings.gradle.rootProject.getBuildDir().mkdirs()
Expand Down
4 changes: 4 additions & 0 deletions spring-boot-project/spring-boot-cli/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ plugins {

description = "Spring Boot CLI"

toolchain {
maximumCompatibleJavaVersion = 15
}

configurations {
dependenciesBom
loader
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2012-2019 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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ plugins {

description = "Spring Boot Gradle Plugin"

toolchain {
maximumCompatibleJavaVersion = 15
}

configurations {
asciidoctorExtensions {
extendsFrom dependencyManagement
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ processResources {
}

compileJava {
if ((!project.hasProperty("buildJavaHome")) && JavaVersion.current() == JavaVersion.VERSION_1_8) {
if ((!project.hasProperty("toolchainVersion")) && JavaVersion.current() == JavaVersion.VERSION_1_8) {
options.compilerArgs += ['-Xlint:-sunapi', '-XDenableSunApiLintControl']
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@
import java.util.stream.Collectors;

import org.junit.jupiter.api.TestTemplate;
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.loader.tools.FileUtils;
Expand Down Expand Up @@ -247,6 +249,7 @@ void whenADependencyHasTestScopeItIsNotIncludedInTheRepackagedJar(MavenBuild mav
});
}

@DisabledForJreRange(min = JRE.JAVA_16) // Remove this once Kotlin supports Java 16
@TestTemplate
void whenAProjectUsesKotlinItsModuleMetadataIsRepackagedIntoBootInfClasses(MavenBuild mavenBuild) {
mavenBuild.project("jar-with-kotlin-module").execute((project) -> {
Expand Down