From b09b0296c3019364ff26494f0c7db34bf497cd81 Mon Sep 17 00:00:00 2001 From: Andy Wilkinson Date: Thu, 13 Nov 2025 09:23:10 +0000 Subject: [PATCH] Check aggregated property metadata Closes gh-47972 --- ...AggregatedSpringConfigurationMetadata.java | 121 ++++++++++++++++++ ...itional-spring-configuration-metadata.json | 9 +- .../autoconfigure/kafka/KafkaProperties.java | 2 +- .../spring-boot-docs/build.gradle | 6 + 4 files changed, 131 insertions(+), 7 deletions(-) create mode 100644 buildSrc/src/main/java/org/springframework/boot/build/context/properties/CheckAggregatedSpringConfigurationMetadata.java diff --git a/buildSrc/src/main/java/org/springframework/boot/build/context/properties/CheckAggregatedSpringConfigurationMetadata.java b/buildSrc/src/main/java/org/springframework/boot/build/context/properties/CheckAggregatedSpringConfigurationMetadata.java new file mode 100644 index 00000000000..c896edd22c2 --- /dev/null +++ b/buildSrc/src/main/java/org/springframework/boot/build/context/properties/CheckAggregatedSpringConfigurationMetadata.java @@ -0,0 +1,121 @@ +/* + * Copyright 2025 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.context.properties; + +import java.io.File; +import java.io.IOException; +import java.nio.file.Files; +import java.nio.file.StandardOpenOption; +import java.util.ArrayList; +import java.util.Iterator; +import java.util.List; +import java.util.Set; +import java.util.stream.Collectors; + +import org.gradle.api.DefaultTask; +import org.gradle.api.Task; +import org.gradle.api.file.FileCollection; +import org.gradle.api.file.RegularFileProperty; +import org.gradle.api.tasks.InputFiles; +import org.gradle.api.tasks.OutputFile; +import org.gradle.api.tasks.PathSensitive; +import org.gradle.api.tasks.PathSensitivity; +import org.gradle.api.tasks.TaskAction; +import org.gradle.api.tasks.VerificationException; + +/** + * {@link Task} that checks aggregated Spring configuration metadata. + * + * @author Andy Wilkinson + */ +public abstract class CheckAggregatedSpringConfigurationMetadata extends DefaultTask { + + private FileCollection configurationPropertyMetadata; + + @OutputFile + public abstract RegularFileProperty getReportLocation(); + + @InputFiles + @PathSensitive(PathSensitivity.RELATIVE) + public FileCollection getConfigurationPropertyMetadata() { + return this.configurationPropertyMetadata; + } + + public void setConfigurationPropertyMetadata(FileCollection configurationPropertyMetadata) { + this.configurationPropertyMetadata = configurationPropertyMetadata; + } + + @TaskAction + void check() throws IOException { + Report report = createReport(); + File reportFile = getReportLocation().get().getAsFile(); + Files.write(reportFile.toPath(), report, StandardOpenOption.CREATE, StandardOpenOption.TRUNCATE_EXISTING); + if (report.hasProblems()) { + throw new VerificationException( + "Problems found in aggregated Spring configuration metadata. See " + reportFile + " for details."); + } + } + + private Report createReport() { + ConfigurationProperties configurationProperties = ConfigurationProperties + .fromFiles(this.configurationPropertyMetadata); + Set propertyNames = configurationProperties.stream() + .map(ConfigurationProperty::getName) + .collect(Collectors.toSet()); + List missingReplacement = configurationProperties.stream() + .filter(ConfigurationProperty::isDeprecated) + .filter((deprecated) -> { + String replacement = deprecated.getDeprecation().replacement(); + return replacement != null && !propertyNames.contains(replacement); + }) + .toList(); + return new Report(missingReplacement); + } + + private static final class Report implements Iterable { + + private final List propertiesWithMissingReplacement; + + private Report(List propertiesWithMissingReplacement) { + this.propertiesWithMissingReplacement = propertiesWithMissingReplacement; + } + + private boolean hasProblems() { + return !this.propertiesWithMissingReplacement.isEmpty(); + } + + @Override + public Iterator iterator() { + List lines = new ArrayList<>(); + if (this.propertiesWithMissingReplacement.isEmpty()) { + lines.add("No problems found."); + } + else { + lines.add("The following properties have a replacement that does not exist:"); + lines.add(""); + lines.addAll(this.propertiesWithMissingReplacement.stream() + .map((property) -> "\t" + property.getName() + " (replacement " + + property.getDeprecation().replacement() + ")") + .toList()); + } + lines.add(""); + return lines.iterator(); + } + + } + +} diff --git a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json index d241e47083b..2ec2a503d7a 100644 --- a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json +++ b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json @@ -324,7 +324,6 @@ "defaultValue": true, "deprecation": { "level": "error", - "replacement": "management.metrics.enable.process.files", "reason": "Instead, filter 'process.files' metrics." } }, @@ -335,7 +334,6 @@ "defaultValue": true, "deprecation": { "level": "error", - "replacement": "management.metrics.enable.jvm", "reason": "Instead, disable JvmMetricsAutoConfiguration or filter 'jvm' metrics." } }, @@ -346,7 +344,6 @@ "defaultValue": true, "deprecation": { "level": "error", - "replacement": "management.metrics.enable.logback", "reason": "Instead, disable LogbackMetricsAutoConfiguration or filter 'logback' metrics." } }, @@ -676,7 +673,7 @@ "type": "java.lang.String", "deprecation": { "level": "error", - "replacement": "management.dynatrace.metrics.export.device-id" + "replacement": "management.dynatrace.metrics.export.v1.device-id" } }, { @@ -692,7 +689,7 @@ "type": "java.lang.String", "deprecation": { "level": "error", - "replacement": "management.dynatrace.metrics.export.group" + "replacement": "management.dynatrace.metrics.export.v1.group" } }, { @@ -723,7 +720,7 @@ "type": "java.lang.String", "deprecation": { "level": "error", - "replacement": "management.dynatrace.metrics.export.technology-type" + "replacement": "management.dynatrace.metrics.export.v1.technology-type" } }, { diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/kafka/KafkaProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/kafka/KafkaProperties.java index 5c7490fb662..77faaaf954e 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/kafka/KafkaProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/kafka/KafkaProperties.java @@ -1619,7 +1619,7 @@ public class KafkaProperties { getBackoff().setMultiplier(multiplier); } - @DeprecatedConfigurationProperty(replacement = "spring.kafka.retry.topic.backoff.maxDelay", since = "3.4.0") + @DeprecatedConfigurationProperty(replacement = "spring.kafka.retry.topic.backoff.max-delay", since = "3.4.0") @Deprecated(since = "3.4.0", forRemoval = true) public Duration getMaxDelay() { return getBackoff().getMaxDelay(); diff --git a/spring-boot-project/spring-boot-docs/build.gradle b/spring-boot-project/spring-boot-docs/build.gradle index 2f6899d91ad..9abb6601dff 100644 --- a/spring-boot-project/spring-boot-docs/build.gradle +++ b/spring-boot-project/spring-boot-docs/build.gradle @@ -271,6 +271,12 @@ def configurationPropertiesMetadataAggregate = aggregates.create("configurationP usage = "configuration-properties-metadata" } +def checkAggregatedSpringConfigurationMetadata = tasks.register("checkAggregatedSpringConfigurationMetadata", org.springframework.boot.build.context.properties.CheckAggregatedSpringConfigurationMetadata) { + configurationPropertyMetadata = configurationPropertiesMetadataAggregate.files + reportLocation = layout.buildDirectory.file("checkAggregatedSpringConfigurationMetadata/report.txt") +} +tasks.named("check") { dependsOn checkAggregatedSpringConfigurationMetadata } + tasks.register("documentConfigurationProperties", org.springframework.boot.build.context.properties.DocumentConfigurationProperties) { configurationPropertyMetadata = configurationPropertiesMetadataAggregate.files deprecated = false