Add since to deprecations in config metadata JSON files

Add the `since` field to all deprecated properties in all
additional-spring-configuration-metadata.json files in the project.

Add to the CheckAdditionalSpringConfigurationMetadata build task to
ensure that all deprecated properties have a non-empty `since` field.

Signed-off-by: Scott Frederick <[email protected]>

Author: scottfrederick

buildSrc/src/main/java/org/springframework/boot/build/context/properties/CheckAdditionalSpringConfigurationMetadata.java

@@ -59,6 +59,7 @@ void check() throws IOException {
 		ConfigurationPropertiesAnalyzer analyzer = new ConfigurationPropertiesAnalyzer(getSource().getFiles());
 		Report report = new Report(this.projectDir);
 		analyzer.analyzeSort(report);
+		analyzer.analyzeDeprecationSince(report);
 		File reportFile = getReportLocation().get().getAsFile();
 		report.write(reportFile);
 		if (report.hasProblems()) {

buildSrc/src/main/java/org/springframework/boot/build/context/properties/CheckManualSpringConfigurationMetadata.java

@@ -66,6 +66,7 @@ void check() throws IOException {
 		Report report = new Report(this.projectDir);
 		analyzer.analyzeSort(report);
 		analyzer.analyzePropertyDescription(report, getExclusions().get());
+		analyzer.analyzeDeprecationSince(report);
 		File reportFile = getReportLocation().get().getAsFile();
 		report.write(reportFile);
 		if (report.hasProblems()) {

buildSrc/src/main/java/org/springframework/boot/build/context/properties/ConfigurationPropertiesAnalyzer.java

@@ -133,6 +133,26 @@ private boolean isDescribed(Map<String, Object> property) {
 		return property.get("description") != null;
 	}
 
+	void analyzeDeprecationSince(Report report) throws IOException {
+		for (File source : this.sources) {
+			report.registerAnalysis(source, analyzeDeprecationSince(source));
+		}
+	}
+
+	@SuppressWarnings("unchecked")
+	private Analysis analyzeDeprecationSince(File source) throws IOException {
+		Analysis analysis = new Analysis("The following properties are deprecated without a 'since' version:");
+		Map<String, Object> json = readJsonContent(source);
+		List<Map<String, Object>> properties = (List<Map<String, Object>>) json.get("properties");
+		properties.stream().filter((property) -> property.containsKey("deprecation")).forEach((property) -> {
+			Map<String, Object> deprecation = (Map<String, Object>) property.get("deprecation");
+			if (!deprecation.containsKey("since")) {
+				analysis.addItem(property.get("name").toString());
+			}
+		});
+		return analysis;
+	}
+
 	private Map<String, Object> readJsonContent(File source) throws IOException {
 		return this.objectMapperSupplier.obtain().readValue(source, new TypeReference<Map<String, Object>>() {
 		});

buildSrc/src/test/java/org/springframework/boot/build/context/properties/ConfigurationPropertiesAnalyzerTests.java

@@ -115,6 +115,32 @@ void analyzePropertyDescriptionWithMissingDescription(@TempDir File tempDir) thr
 			.satisfies(((analysis) -> assertThat(analysis.getItems()).containsExactly("def")));
 	}
 
+	@Test
+	void analyzeDeprecatedPropertyWithMissingSince(@TempDir File tempDir) throws IOException {
+		File metadata = new File(tempDir, "metadata.json");
+		Files.writeString(metadata.toPath(), """
+				{ "properties": [
+				  {
+				    "name": "abc",
+				    "description": "This is abc.",
+				    "deprecation": { "reason": "abc reason", "since": "3.0.0" }
+				  },
+				  { "name": "def", "description": "This is def." },
+				  {
+				    "name": "xyz",
+				    "description": "This is xyz.",
+				    "deprecation": { "reason": "xyz reason" }
+				  }
+				  ]
+				}""");
+		Report report = new Report(tempDir);
+		ConfigurationPropertiesAnalyzer analyzer = new ConfigurationPropertiesAnalyzer(List.of(metadata));
+		analyzer.analyzeDeprecationSince(report);
+		assertThat(report.hasProblems()).isTrue();
+		assertThat(report.getAnalyses(metadata)).singleElement()
+			.satisfies(((analysis) -> assertThat(analysis.getItems()).containsExactly("xyz")));
+	}
+
 	@Test
 	void writeEmptyReport(@TempDir File tempDir) throws IOException {
 		assertThat(writeToFile(tempDir, new Report(tempDir))).hasContent("No problems found.");