Check that Deprecated have a "since" attribute

This commit enforces a new architecture rule. Methods and Types
annotated with `@Deprecated` should always have a "since" attribute.

Signed-off-by: Brian Clozel <[email protected]>

Author: bclozel

buildSrc/src/main/java/org/springframework/build/architecture/ArchitectureCheck.java

@@ -16,15 +16,16 @@
 
 package org.springframework.build.architecture;
 
-import com.tngtech.archunit.core.domain.JavaClasses;
-import com.tngtech.archunit.core.importer.ClassFileImporter;
-import com.tngtech.archunit.lang.ArchRule;
-import com.tngtech.archunit.lang.EvaluationResult;
 import java.io.File;
 import java.io.IOException;
 import java.nio.file.Files;
 import java.nio.file.StandardOpenOption;
 import java.util.List;
+
+import com.tngtech.archunit.core.domain.JavaClasses;
+import com.tngtech.archunit.core.importer.ClassFileImporter;
+import com.tngtech.archunit.lang.ArchRule;
+import com.tngtech.archunit.lang.EvaluationResult;
 import org.gradle.api.DefaultTask;
 import org.gradle.api.GradleException;
 import org.gradle.api.Task;
@@ -46,6 +47,8 @@
 
 import static org.springframework.build.architecture.ArchitectureRules.allPackagesShouldBeFreeOfTangles;
 import static org.springframework.build.architecture.ArchitectureRules.classesShouldNotImportForbiddenTypes;
+import static org.springframework.build.architecture.ArchitectureRules.deprecatedMethodsShouldHaveSinceAttribute;
+import static org.springframework.build.architecture.ArchitectureRules.deprecatedTypesShouldHaveSinceAttribute;
 import static org.springframework.build.architecture.ArchitectureRules.javaClassesShouldNotImportKotlinAnnotations;
 import static org.springframework.build.architecture.ArchitectureRules.noClassesShouldCallStringToLowerCaseWithoutLocale;
 import static org.springframework.build.architecture.ArchitectureRules.noClassesShouldCallStringToUpperCaseWithoutLocale;
@@ -69,7 +72,10 @@ public ArchitectureCheck() {
 				javaClassesShouldNotImportKotlinAnnotations(),
 				allPackagesShouldBeFreeOfTangles(),
 				noClassesShouldCallStringToLowerCaseWithoutLocale(),
-				noClassesShouldCallStringToUpperCaseWithoutLocale());
+				noClassesShouldCallStringToUpperCaseWithoutLocale(),
+				deprecatedMethodsShouldHaveSinceAttribute(),
+				deprecatedTypesShouldHaveSinceAttribute());
+
 		getRuleDescriptions().set(getRules().map((rules) -> rules.stream().map(ArchRule::getDescription).toList()));
 	}
 

buildSrc/src/main/java/org/springframework/build/architecture/ArchitectureRules.java

@@ -17,16 +17,21 @@
 package org.springframework.build.architecture;
 
 import com.tngtech.archunit.base.DescribedPredicate;
+import com.tngtech.archunit.core.domain.JavaAnnotation;
 import com.tngtech.archunit.core.domain.JavaClass;
 import com.tngtech.archunit.lang.ArchRule;
 import com.tngtech.archunit.lang.syntax.ArchRuleDefinition;
 import com.tngtech.archunit.library.dependencies.SliceAssignment;
 import com.tngtech.archunit.library.dependencies.SliceIdentifier;
 import com.tngtech.archunit.library.dependencies.SlicesRuleDefinition;
-import java.util.List;
 
 abstract class ArchitectureRules {
 
+	private static final String[] SHADED_PACKAGES = {"org.springframework.asm..",
+			"org.springframework.cglib..",
+			"org.springframework.javapoet..",
+			"org.springframework.objenesis.."};
+
 	static ArchRule allPackagesShouldBeFreeOfTangles() {
 		return SlicesRuleDefinition.slices()
 				.assignedFrom(new SpringSlices()).should().beFreeOfCycles();
@@ -80,18 +85,41 @@ public boolean test(JavaClass javaClass) {
 				.allowEmptyShould(true);
 	}
 
-	static class SpringSlices implements SliceAssignment {
+	static ArchRule deprecatedMethodsShouldHaveSinceAttribute() {
+		return ArchRuleDefinition.methods().that()
+				.areDeclaredInClassesThat().resideOutsideOfPackages(SHADED_PACKAGES).and()
+				.areAnnotatedWith(Deprecated.class)
+				.should().beAnnotatedWith(deprecatedWithSinceAttribute())
+				.allowEmptyShould(true);
+	}
 
-		private final List<String> ignoredPackages = List.of("org.springframework.asm",
-				"org.springframework.cglib",
-				"org.springframework.javapoet",
-				"org.springframework.objenesis");
+	static ArchRule deprecatedTypesShouldHaveSinceAttribute() {
+		return ArchRuleDefinition.classes().that()
+				.resideOutsideOfPackages(SHADED_PACKAGES).and()
+				.areAnnotatedWith(Deprecated.class)
+				.should().beAnnotatedWith(deprecatedWithSinceAttribute())
+				.allowEmptyShould(true);
+	}
+
+	private static DescribedPredicate<JavaAnnotation> deprecatedWithSinceAttribute() {
+		return new DescribedPredicate<JavaAnnotation>("@Deprecated(since=\"...\"") {
+			@Override
+			public boolean test(JavaAnnotation annotation) {
+				if (annotation.getRawType().isEquivalentTo(Deprecated.class)) {
+					return annotation.get("since").isPresent() &&
+							!annotation.get("since").get().toString().isEmpty();
+				}
+				return true;
+			}
+		};
+	}
+
+	static class SpringSlices implements SliceAssignment {
 
 		@Override
 		public SliceIdentifier getIdentifierOf(JavaClass javaClass) {
-
 			String packageName = javaClass.getPackageName();
-			for (String ignoredPackage : ignoredPackages) {
+			for (String ignoredPackage : SHADED_PACKAGES) {
 				if (packageName.startsWith(ignoredPackage)) {
 					return SliceIdentifier.ignore();
 				}