Merge branch '2.7.x'
This commit is contained in:
commit
8209980ca0
|
|
@ -1,81 +0,0 @@
|
||||||
/*
|
|
||||||
* Copyright 2012-2022 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;
|
|
||||||
|
|
||||||
import java.io.File;
|
|
||||||
import java.io.FileWriter;
|
|
||||||
import java.io.IOException;
|
|
||||||
import java.io.PrintWriter;
|
|
||||||
import java.util.HashMap;
|
|
||||||
import java.util.Map;
|
|
||||||
|
|
||||||
import org.gradle.api.DefaultTask;
|
|
||||||
import org.gradle.api.Task;
|
|
||||||
import org.gradle.api.file.DirectoryProperty;
|
|
||||||
import org.gradle.api.model.ObjectFactory;
|
|
||||||
import org.gradle.api.provider.Property;
|
|
||||||
import org.gradle.api.tasks.Input;
|
|
||||||
import org.gradle.api.tasks.OutputDirectory;
|
|
||||||
import org.gradle.api.tasks.TaskAction;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* {@link Task} to generate properties and write them to disk as a properties file.
|
|
||||||
*
|
|
||||||
* @author Scott Frederick
|
|
||||||
*/
|
|
||||||
public class GeneratePropertiesResource extends DefaultTask {
|
|
||||||
|
|
||||||
private final Property<String> propertiesFileName;
|
|
||||||
|
|
||||||
private final DirectoryProperty destinationDirectory;
|
|
||||||
|
|
||||||
private final Map<String, String> properties = new HashMap<>();
|
|
||||||
|
|
||||||
public GeneratePropertiesResource() {
|
|
||||||
ObjectFactory objects = getProject().getObjects();
|
|
||||||
this.propertiesFileName = objects.property(String.class);
|
|
||||||
this.destinationDirectory = objects.directoryProperty();
|
|
||||||
}
|
|
||||||
|
|
||||||
@OutputDirectory
|
|
||||||
public DirectoryProperty getDestinationDirectory() {
|
|
||||||
return this.destinationDirectory;
|
|
||||||
}
|
|
||||||
|
|
||||||
@Input
|
|
||||||
public Property<String> getPropertiesFileName() {
|
|
||||||
return this.propertiesFileName;
|
|
||||||
}
|
|
||||||
|
|
||||||
public void property(String name, String value) {
|
|
||||||
this.properties.put(name, value);
|
|
||||||
}
|
|
||||||
|
|
||||||
@Input
|
|
||||||
public Map<String, String> getProperties() {
|
|
||||||
return this.properties;
|
|
||||||
}
|
|
||||||
|
|
||||||
@TaskAction
|
|
||||||
void generatePropertiesFile() throws IOException {
|
|
||||||
File outputFile = this.destinationDirectory.file(this.propertiesFileName).get().getAsFile();
|
|
||||||
try (PrintWriter writer = new PrintWriter(new FileWriter(outputFile))) {
|
|
||||||
this.properties.forEach((key, value) -> writer.printf("%s=%s\n", key, value));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
/*
|
/*
|
||||||
* Copyright 2012-2022 the original author or authors.
|
* Copyright 2012-2021 the original author or authors.
|
||||||
*
|
*
|
||||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
* you may not use this file except in compliance with the License.
|
* you may not use this file except in compliance with the License.
|
||||||
|
|
@ -105,8 +105,6 @@ class JavaConventions {
|
||||||
|
|
||||||
private static final String SOURCE_AND_TARGET_COMPATIBILITY = "17";
|
private static final String SOURCE_AND_TARGET_COMPATIBILITY = "17";
|
||||||
|
|
||||||
private static final String SPRING_BOOT_PROPERTIES_FILE = "spring-boot.properties";
|
|
||||||
|
|
||||||
void apply(Project project) {
|
void apply(Project project) {
|
||||||
project.getPlugins().withType(JavaBasePlugin.class, (java) -> {
|
project.getPlugins().withType(JavaBasePlugin.class, (java) -> {
|
||||||
project.getPlugins().apply(TestFailuresPlugin.class);
|
project.getPlugins().apply(TestFailuresPlugin.class);
|
||||||
|
|
@ -115,7 +113,6 @@ class JavaConventions {
|
||||||
configureJavadocConventions(project);
|
configureJavadocConventions(project);
|
||||||
configureTestConventions(project);
|
configureTestConventions(project);
|
||||||
configureJarManifestConventions(project);
|
configureJarManifestConventions(project);
|
||||||
configureMetaInfResourcesConventions(project);
|
|
||||||
configureDependencyManagement(project);
|
configureDependencyManagement(project);
|
||||||
configureToolchain(project);
|
configureToolchain(project);
|
||||||
configureProhibitedDependencyChecks(project);
|
configureProhibitedDependencyChecks(project);
|
||||||
|
|
@ -123,37 +120,29 @@ class JavaConventions {
|
||||||
}
|
}
|
||||||
|
|
||||||
private void configureJarManifestConventions(Project project) {
|
private void configureJarManifestConventions(Project project) {
|
||||||
SourceSetContainer sourceSets = project.getExtensions().getByType(SourceSetContainer.class);
|
|
||||||
Set<String> sourceJarTaskNames = sourceSets.stream().map(SourceSet::getSourcesJarTaskName)
|
|
||||||
.collect(Collectors.toSet());
|
|
||||||
Set<String> javadocJarTaskNames = sourceSets.stream().map(SourceSet::getJavadocJarTaskName)
|
|
||||||
.collect(Collectors.toSet());
|
|
||||||
project.getTasks().withType(Jar.class,
|
|
||||||
(jar) -> project.afterEvaluate((evaluated) -> jar.manifest((manifest) -> {
|
|
||||||
Map<String, Object> attributes = new TreeMap<>();
|
|
||||||
attributes.put("Automatic-Module-Name", project.getName().replace("-", "."));
|
|
||||||
attributes.put("Build-Jdk-Spec", SOURCE_AND_TARGET_COMPATIBILITY);
|
|
||||||
attributes.put("Built-By", "Spring");
|
|
||||||
attributes.put("Implementation-Title",
|
|
||||||
determineImplementationTitle(project, sourceJarTaskNames, javadocJarTaskNames, jar));
|
|
||||||
attributes.put("Implementation-Version", project.getVersion());
|
|
||||||
manifest.attributes(attributes);
|
|
||||||
})));
|
|
||||||
}
|
|
||||||
|
|
||||||
private void configureMetaInfResourcesConventions(Project project) {
|
|
||||||
ExtractResources extractLegalResources = project.getTasks().create("extractLegalResources",
|
ExtractResources extractLegalResources = project.getTasks().create("extractLegalResources",
|
||||||
ExtractResources.class);
|
ExtractResources.class);
|
||||||
extractLegalResources.getDestinationDirectory().set(project.getLayout().getBuildDirectory().dir("legal"));
|
extractLegalResources.getDestinationDirectory().set(project.getLayout().getBuildDirectory().dir("legal"));
|
||||||
extractLegalResources.setResourcesNames(Arrays.asList("LICENSE.txt", "NOTICE.txt"));
|
extractLegalResources.setResourcesNames(Arrays.asList("LICENSE.txt", "NOTICE.txt"));
|
||||||
extractLegalResources.property("version", project.getVersion().toString());
|
extractLegalResources.property("version", project.getVersion().toString());
|
||||||
GeneratePropertiesResource generateInfo = project.getTasks().create("generateSpringBootInfo",
|
SourceSetContainer sourceSets = project.getExtensions().getByType(SourceSetContainer.class);
|
||||||
GeneratePropertiesResource.class);
|
Set<String> sourceJarTaskNames = sourceSets.stream().map(SourceSet::getSourcesJarTaskName)
|
||||||
generateInfo.getDestinationDirectory().set(project.getLayout().getBuildDirectory().dir("info"));
|
.collect(Collectors.toSet());
|
||||||
generateInfo.getPropertiesFileName().set(SPRING_BOOT_PROPERTIES_FILE);
|
Set<String> javadocJarTaskNames = sourceSets.stream().map(SourceSet::getJavadocJarTaskName)
|
||||||
generateInfo.property("version", project.getVersion().toString());
|
.collect(Collectors.toSet());
|
||||||
project.getTasks().withType(Jar.class, (jar) -> project.afterEvaluate(
|
project.getTasks().withType(Jar.class, (jar) -> project.afterEvaluate((evaluated) -> {
|
||||||
(evaluated) -> jar.metaInf((metaInf) -> metaInf.from(extractLegalResources, generateInfo))));
|
jar.metaInf((metaInf) -> metaInf.from(extractLegalResources));
|
||||||
|
jar.manifest((manifest) -> {
|
||||||
|
Map<String, Object> attributes = new TreeMap<>();
|
||||||
|
attributes.put("Automatic-Module-Name", project.getName().replace("-", "."));
|
||||||
|
attributes.put("Build-Jdk-Spec", SOURCE_AND_TARGET_COMPATIBILITY);
|
||||||
|
attributes.put("Built-By", "Spring");
|
||||||
|
attributes.put("Implementation-Title",
|
||||||
|
determineImplementationTitle(project, sourceJarTaskNames, javadocJarTaskNames, jar));
|
||||||
|
attributes.put("Implementation-Version", project.getVersion());
|
||||||
|
manifest.attributes(attributes);
|
||||||
|
});
|
||||||
|
}));
|
||||||
}
|
}
|
||||||
|
|
||||||
private String determineImplementationTitle(Project project, Set<String> sourceJarTaskNames,
|
private String determineImplementationTitle(Project project, Set<String> sourceJarTaskNames,
|
||||||
|
|
|
||||||
|
|
@ -83,7 +83,6 @@ class ConventionsPluginTests {
|
||||||
try (JarFile jar = new JarFile(file)) {
|
try (JarFile jar = new JarFile(file)) {
|
||||||
assertThatLicenseIsPresent(jar);
|
assertThatLicenseIsPresent(jar);
|
||||||
assertThatNoticeIsPresent(jar);
|
assertThatNoticeIsPresent(jar);
|
||||||
assertThatSpringBootPropertiesIsPresent(jar);
|
|
||||||
Attributes mainAttributes = jar.getManifest().getMainAttributes();
|
Attributes mainAttributes = jar.getManifest().getMainAttributes();
|
||||||
assertThat(mainAttributes.getValue("Implementation-Title"))
|
assertThat(mainAttributes.getValue("Implementation-Title"))
|
||||||
.isEqualTo("Test project for manifest customization");
|
.isEqualTo("Test project for manifest customization");
|
||||||
|
|
@ -113,7 +112,6 @@ class ConventionsPluginTests {
|
||||||
try (JarFile jar = new JarFile(file)) {
|
try (JarFile jar = new JarFile(file)) {
|
||||||
assertThatLicenseIsPresent(jar);
|
assertThatLicenseIsPresent(jar);
|
||||||
assertThatNoticeIsPresent(jar);
|
assertThatNoticeIsPresent(jar);
|
||||||
assertThatSpringBootPropertiesIsPresent(jar);
|
|
||||||
Attributes mainAttributes = jar.getManifest().getMainAttributes();
|
Attributes mainAttributes = jar.getManifest().getMainAttributes();
|
||||||
assertThat(mainAttributes.getValue("Implementation-Title"))
|
assertThat(mainAttributes.getValue("Implementation-Title"))
|
||||||
.isEqualTo("Source for " + this.projectDir.getName());
|
.isEqualTo("Source for " + this.projectDir.getName());
|
||||||
|
|
@ -143,7 +141,6 @@ class ConventionsPluginTests {
|
||||||
try (JarFile jar = new JarFile(file)) {
|
try (JarFile jar = new JarFile(file)) {
|
||||||
assertThatLicenseIsPresent(jar);
|
assertThatLicenseIsPresent(jar);
|
||||||
assertThatNoticeIsPresent(jar);
|
assertThatNoticeIsPresent(jar);
|
||||||
assertThatSpringBootPropertiesIsPresent(jar);
|
|
||||||
Attributes mainAttributes = jar.getManifest().getMainAttributes();
|
Attributes mainAttributes = jar.getManifest().getMainAttributes();
|
||||||
assertThat(mainAttributes.getValue("Implementation-Title"))
|
assertThat(mainAttributes.getValue("Implementation-Title"))
|
||||||
.isEqualTo("Javadoc for " + this.projectDir.getName());
|
.isEqualTo("Javadoc for " + this.projectDir.getName());
|
||||||
|
|
@ -168,13 +165,6 @@ class ConventionsPluginTests {
|
||||||
assertThat(noticeContent).doesNotContain("${");
|
assertThat(noticeContent).doesNotContain("${");
|
||||||
}
|
}
|
||||||
|
|
||||||
private void assertThatSpringBootPropertiesIsPresent(JarFile jar) throws IOException {
|
|
||||||
JarEntry properties = jar.getJarEntry("META-INF/spring-boot.properties");
|
|
||||||
assertThat(properties).isNotNull();
|
|
||||||
String content = FileCopyUtils.copyToString(new InputStreamReader(jar.getInputStream(properties)));
|
|
||||||
assertThat(content).contains("version=");
|
|
||||||
}
|
|
||||||
|
|
||||||
@Test
|
@Test
|
||||||
void testRetryIsConfiguredWithThreeRetriesOnCI() throws IOException {
|
void testRetryIsConfiguredWithThreeRetriesOnCI() throws IOException {
|
||||||
try (PrintWriter out = new PrintWriter(new FileWriter(this.buildFile))) {
|
try (PrintWriter out = new PrintWriter(new FileWriter(this.buildFile))) {
|
||||||
|
|
|
||||||
|
|
@ -153,7 +153,26 @@ task extractTomcatConfigProperties(type: Sync) {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
def syncJavaTemplates = tasks.register("syncJavaTemplates", Sync) {
|
||||||
|
from("src/main/javaTemplates")
|
||||||
|
into("build/generated-sources/main")
|
||||||
|
def properties = ["springBootVersion": project.version]
|
||||||
|
expand(properties)
|
||||||
|
inputs.properties(properties)
|
||||||
|
}
|
||||||
|
|
||||||
|
plugins.withType(EclipsePlugin) {
|
||||||
|
eclipse {
|
||||||
|
synchronizationTasks syncJavaTemplates
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
sourceSets {
|
sourceSets {
|
||||||
|
main {
|
||||||
|
java {
|
||||||
|
srcDirs syncJavaTemplates
|
||||||
|
}
|
||||||
|
}
|
||||||
test {
|
test {
|
||||||
output.dir(tomcatConfigProperties, builtBy: "extractTomcatConfigProperties")
|
output.dir(tomcatConfigProperties, builtBy: "extractTomcatConfigProperties")
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -16,18 +16,9 @@
|
||||||
|
|
||||||
package org.springframework.boot;
|
package org.springframework.boot;
|
||||||
|
|
||||||
import java.io.IOException;
|
|
||||||
import java.io.InputStream;
|
|
||||||
import java.util.Properties;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Exposes the Spring Boot version.
|
* Exposes the Spring Boot version.
|
||||||
*
|
*
|
||||||
* The version information is read from a file that is stored in the Spring Boot library.
|
|
||||||
* If the version information cannot be read from the file, consider using a
|
|
||||||
* reflection-based check instead (for example, checking for the presence of a specific
|
|
||||||
* Spring Boot method that you intend to call).
|
|
||||||
*
|
|
||||||
* @author Drummond Dawson
|
* @author Drummond Dawson
|
||||||
* @author Hendrig Sellik
|
* @author Hendrig Sellik
|
||||||
* @author Andy Wilkinson
|
* @author Andy Wilkinson
|
||||||
|
|
@ -40,24 +31,11 @@ public final class SpringBootVersion {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Return the full version string of the present Spring Boot codebase, or {@code null}
|
* Return the full version string of the present Spring Boot codebase.
|
||||||
* if it cannot be determined.
|
* @return the version of Spring Boot
|
||||||
* @return the version of Spring Boot or {@code null}
|
|
||||||
*/
|
*/
|
||||||
public static String getVersion() {
|
public static String getVersion() {
|
||||||
InputStream input = SpringBootVersion.class.getClassLoader()
|
return "${springBootVersion}";
|
||||||
.getResourceAsStream("META-INF/spring-boot.properties");
|
|
||||||
if (input != null) {
|
|
||||||
try {
|
|
||||||
Properties properties = new Properties();
|
|
||||||
properties.load(input);
|
|
||||||
return properties.getProperty("version");
|
|
||||||
}
|
|
||||||
catch (IOException ex) {
|
|
||||||
// fall through
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return null;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
@ -0,0 +1,56 @@
|
||||||
|
/*
|
||||||
|
* Copyright 2012-2022 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;
|
||||||
|
|
||||||
|
import java.io.File;
|
||||||
|
import java.io.IOException;
|
||||||
|
|
||||||
|
import org.junit.jupiter.api.Test;
|
||||||
|
|
||||||
|
import org.springframework.core.io.FileSystemResource;
|
||||||
|
import org.springframework.core.io.support.PropertiesLoaderUtils;
|
||||||
|
|
||||||
|
import static org.assertj.core.api.Assertions.assertThat;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Tests for {@link SpringBootVersion}.
|
||||||
|
*
|
||||||
|
* @author Andy Wilkinson
|
||||||
|
*/
|
||||||
|
public class SpringBootVersionTests {
|
||||||
|
|
||||||
|
@Test
|
||||||
|
void getVersionShouldReturnVersionMatchingGradleProperties() throws IOException {
|
||||||
|
String expectedVersion = PropertiesLoaderUtils.loadProperties(new FileSystemResource(findGradleProperties()))
|
||||||
|
.getProperty("version");
|
||||||
|
assertThat(SpringBootVersion.getVersion()).isEqualTo(expectedVersion);
|
||||||
|
}
|
||||||
|
|
||||||
|
private File findGradleProperties() {
|
||||||
|
File current = new File(".").getAbsoluteFile();
|
||||||
|
while (current != null) {
|
||||||
|
File gradleProperties = new File(current, "gradle.properties");
|
||||||
|
System.out.println(gradleProperties);
|
||||||
|
if (gradleProperties.isFile()) {
|
||||||
|
return gradleProperties;
|
||||||
|
}
|
||||||
|
current = current.getParentFile();
|
||||||
|
}
|
||||||
|
throw new IllegalStateException("Could not find gradle.properties");
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
Loading…
Reference in New Issue