Use a templated source file for SpringBootVersion

Closes gh-29670

Author: wilkinsona

buildSrc/src/main/java/org/springframework/boot/build/GeneratePropertiesResource.java

@@ -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");
  * you may not use this file except in compliance with the License.
@@ -104,8 +104,6 @@ class JavaConventions {
 
 	private static final String SOURCE_AND_TARGET_COMPATIBILITY = "1.8";
 
-	private static final String SPRING_BOOT_PROPERTIES_FILE = "spring-boot.properties";
-
 	void apply(Project project) {
 		project.getPlugins().withType(JavaBasePlugin.class, (java) -> {
 			project.getPlugins().apply(TestFailuresPlugin.class);
@@ -114,45 +112,36 @@ void apply(Project project) {
 			configureJavadocConventions(project);
 			configureTestConventions(project);
 			configureJarManifestConventions(project);
-			configureMetaInfResourcesConventions(project);
 			configureDependencyManagement(project);
 			configureToolchain(project);
 			configureProhibitedDependencyChecks(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.class);
 		extractLegalResources.getDestinationDirectory().set(project.getLayout().getBuildDirectory().dir("legal"));
 		extractLegalResources.setResourcesNames(Arrays.asList("LICENSE.txt", "NOTICE.txt"));
 		extractLegalResources.property("version", project.getVersion().toString());
-		GeneratePropertiesResource generateInfo = project.getTasks().create("generateSpringBootInfo",
-				GeneratePropertiesResource.class);
-		generateInfo.getDestinationDirectory().set(project.getLayout().getBuildDirectory().dir("info"));
-		generateInfo.getPropertiesFileName().set(SPRING_BOOT_PROPERTIES_FILE);
-		generateInfo.property("version", project.getVersion().toString());
-		project.getTasks().withType(Jar.class, (jar) -> project.afterEvaluate(
-				(evaluated) -> jar.metaInf((metaInf) -> metaInf.from(extractLegalResources, generateInfo))));
+		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.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,

buildSrc/src/main/java/org/springframework/boot/build/JavaConventions.java

@@ -83,7 +83,6 @@ void jarIncludesLegalFiles() throws IOException {
 		try (JarFile jar = new JarFile(file)) {
 			assertThatLicenseIsPresent(jar);
 			assertThatNoticeIsPresent(jar);
-			assertThatSpringBootPropertiesIsPresent(jar);
 			Attributes mainAttributes = jar.getManifest().getMainAttributes();
 			assertThat(mainAttributes.getValue("Implementation-Title"))
 					.isEqualTo("Test project for manifest customization");
@@ -113,7 +112,6 @@ void sourceJarIsBuilt() throws IOException {
 		try (JarFile jar = new JarFile(file)) {
 			assertThatLicenseIsPresent(jar);
 			assertThatNoticeIsPresent(jar);
-			assertThatSpringBootPropertiesIsPresent(jar);
 			Attributes mainAttributes = jar.getManifest().getMainAttributes();
 			assertThat(mainAttributes.getValue("Implementation-Title"))
 					.isEqualTo("Source for " + this.projectDir.getName());
@@ -143,7 +141,6 @@ void javadocJarIsBuilt() throws IOException {
 		try (JarFile jar = new JarFile(file)) {
 			assertThatLicenseIsPresent(jar);
 			assertThatNoticeIsPresent(jar);
-			assertThatSpringBootPropertiesIsPresent(jar);
 			Attributes mainAttributes = jar.getManifest().getMainAttributes();
 			assertThat(mainAttributes.getValue("Implementation-Title"))
 					.isEqualTo("Javadoc for " + this.projectDir.getName());
@@ -168,13 +165,6 @@ private void assertThatNoticeIsPresent(JarFile jar) throws IOException {
 		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
 	void testRetryIsConfiguredWithThreeRetriesOnCI() throws IOException {
 		try (PrintWriter out = new PrintWriter(new FileWriter(this.buildFile))) {

buildSrc/src/test/java/org/springframework/boot/build/ConventionsPluginTests.java

@@ -155,7 +155,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 {
+	main {
+		java {
+			srcDirs syncJavaTemplates
+		}
+	}
 	test {
 		output.dir(tomcatConfigProperties, builtBy: "extractTomcatConfigProperties")
 	}

spring-boot-project/spring-boot/build.gradle

@@ -16,18 +16,9 @@
 
 package org.springframework.boot;
 
-import java.io.IOException;
-import java.io.InputStream;
-import java.util.Properties;
-
 /**
  * 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 Hendrig Sellik
  * @author Andy Wilkinson
@@ -40,24 +31,11 @@ private SpringBootVersion() {
 	}
 
 	/**
-	 * Return the full version string of the present Spring Boot codebase, or {@code null}
-	 * if it cannot be determined.
-	 * @return the version of Spring Boot or {@code null}
+	 * Return the full version string of the present Spring Boot codebase.
+	 * @return the version of Spring Boot
 	 */
 	public static String getVersion() {
-		InputStream input = SpringBootVersion.class.getClassLoader()
-				.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;
+		return "${springBootVersion}";
 	}
 
 }

spring-boot-project/spring-boot/src/main/java/org/springframework/boot/SpringBootVersion.java renamed to spring-boot-project/spring-boot/src/main/javaTemplates/org/springframework/boot/SpringBootVersion.java

@@ -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");
+	}
+
+}