From 425faf9f7a86d44bdb5d10620878735bd2fc4bde Mon Sep 17 00:00:00 2001 From: Romain Brenguier Date: Tue, 10 Nov 2026 08:40:29 +0000 Subject: [PATCH 1/2] SONARJAVA-6048 Add qualified deprecation regression cases Co-Authored-By: Fabrik --- .../DeprecatedTagPresenceCheckSample.java | 5 +- .../checks/MissingDeprecatedCheckSample.java | 49 ++++++++++++++++++- .../helpers/DeprecatedCheckerHelperTest.java | 17 +++++++ 3 files changed, 68 insertions(+), 3 deletions(-) diff --git a/java-checks-test-sources/default/src/main/files/non-compiling/checks/DeprecatedTagPresenceCheckSample.java b/java-checks-test-sources/default/src/main/files/non-compiling/checks/DeprecatedTagPresenceCheckSample.java index fe3f15a843a..57cac60c52c 100644 --- a/java-checks-test-sources/default/src/main/files/non-compiling/checks/DeprecatedTagPresenceCheckSample.java +++ b/java-checks-test-sources/default/src/main/files/non-compiling/checks/DeprecatedTagPresenceCheckSample.java @@ -54,8 +54,9 @@ public int foo7() { // Noncompliant public void foo8() { // Noncompliant } - @java.lang.Deprecated // Compliant - no one does this - public void foo9() { + @java.lang.Deprecated + public void foo9() { // Noncompliant {{Do not forget to remove this deprecated code someday.}} +// ^^^^ @Deprecated int local1 = 0; // Noncompliant diff --git a/java-checks-test-sources/default/src/main/java/checks/MissingDeprecatedCheckSample.java b/java-checks-test-sources/default/src/main/java/checks/MissingDeprecatedCheckSample.java index 0fc709f3f00..3f303aa5e4f 100644 --- a/java-checks-test-sources/default/src/main/java/checks/MissingDeprecatedCheckSample.java +++ b/java-checks-test-sources/default/src/main/java/checks/MissingDeprecatedCheckSample.java @@ -54,7 +54,8 @@ public void foo8() { // Noncompliant } @java.lang.Deprecated - public void foo9() { + public void foo9() { // Noncompliant {{Add the missing @deprecated Javadoc tag.}} +// ^^^^ @Deprecated int local1 = 0; @@ -153,3 +154,49 @@ interface mockito { @Deprecated T createMock(Class toMock, Method... mockedMethods); } + +class QualifiedDeprecation { + + static class Annotations { + @interface Deprecated {} + } + + /** @deprecated Use replacement instead. */ + @Annotations.Deprecated + public void customAnnotation() {} // Noncompliant {{Add the missing @Deprecated annotation.}} +// ^^^^^^^^^^^^^^^^ + + /** @deprecated Use replacement instead. */ + @java.lang.Deprecated + public void method() {} + + /** @deprecated Use replacement instead. */ + @java.lang.Deprecated + public int field; + + @java.lang.Deprecated + public int undocumentedField; // Noncompliant {{Add the missing @deprecated Javadoc tag.}} +// ^^^^^^^^^^^^^^^^^ + + public enum State { + UNKNOWN; + + /** @deprecated Use {@link #forNumber(int)} instead. */ + @java.lang.Deprecated + public static State valueOf(int value) { + return forNumber(value); + } + + public static State forNumber(int value) { + return UNKNOWN; + } + } +} + +/** @deprecated Use replacement instead. */ +@java.lang.Deprecated +class QualifiedDeprecatedClass {} + +@java.lang.Deprecated +class UndocumentedQualifiedDeprecatedClass {} // Noncompliant {{Add the missing @deprecated Javadoc tag.}} +// ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/java-checks/src/test/java/org/sonar/java/checks/helpers/DeprecatedCheckerHelperTest.java b/java-checks/src/test/java/org/sonar/java/checks/helpers/DeprecatedCheckerHelperTest.java index a945a056ba3..8343e5eafb0 100644 --- a/java-checks/src/test/java/org/sonar/java/checks/helpers/DeprecatedCheckerHelperTest.java +++ b/java-checks/src/test/java/org/sonar/java/checks/helpers/DeprecatedCheckerHelperTest.java @@ -21,6 +21,7 @@ import org.junit.jupiter.params.ParameterizedTest; import org.junit.jupiter.params.provider.Arguments; import org.junit.jupiter.params.provider.MethodSource; +import org.junit.jupiter.params.provider.ValueSource; import org.sonar.plugins.java.api.tree.ClassTree; import org.sonar.plugins.java.api.tree.CompilationUnitTree; @@ -29,6 +30,22 @@ class DeprecatedCheckerHelperTest { + @ParameterizedTest + @ValueSource(strings = {"Deprecated", "java.lang.Deprecated"}) + void deprecatedAnnotation(String name) { + var classTree = parseClass("@" + name + "(since = \"9\", forRemoval = true) class A {}"); + var annotation = DeprecatedCheckerHelper.deprecatedAnnotation(classTree); + assertThat(annotation).isNotNull(); + assertThat(DeprecatedCheckerHelper.getAnnotationAttributeValue(annotation, "since", String.class)).contains("9"); + assertThat(DeprecatedCheckerHelper.getAnnotationAttributeValue(annotation, "forRemoval", Boolean.class)).contains(true); + } + + @ParameterizedTest + @ValueSource(strings = {"other.Deprecated", "java.lang.Override"}) + void unrelatedAnnotation(String name) { + assertThat(DeprecatedCheckerHelper.deprecatedAnnotation(parseClass("@" + name + " class A {}"))).isNull(); + } + @Test void getAnnotationAttributeValue() { assertValue("@Deprecated(forRemoval = true)", "forRemoval", true, Boolean.class); From 080bb2ff36b1e806633790c0783dd066303dd2d3 Mon Sep 17 00:00:00 2001 From: Romain Brenguier Date: Tue, 10 Nov 2026 08:42:00 +0000 Subject: [PATCH 2/2] SONARJAVA-6048 Recognize qualified Deprecated annotations Preserve short-name detection and resolve qualified annotation types against java.lang.Deprecated. Keep missing-tag reports for qualified annotations. Co-Authored-By: Fabrik --- .../sonar/java/checks/helpers/DeprecatedCheckerHelper.java | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/java-checks/src/main/java/org/sonar/java/checks/helpers/DeprecatedCheckerHelper.java b/java-checks/src/main/java/org/sonar/java/checks/helpers/DeprecatedCheckerHelper.java index 1e6a743ebaa..d3124c939f6 100644 --- a/java-checks/src/main/java/org/sonar/java/checks/helpers/DeprecatedCheckerHelper.java +++ b/java-checks/src/main/java/org/sonar/java/checks/helpers/DeprecatedCheckerHelper.java @@ -39,6 +39,7 @@ public class DeprecatedCheckerHelper { + private static final String DEPRECATED_ANNOTATION = "java.lang.Deprecated"; private static final String DEPRECATED_TAG = "@deprecated"; private static final Kind[] CLASS_KINDS = PublicApiChecker.classKinds(); private static final Kind[] METHOD_KINDS = PublicApiChecker.methodKinds(); @@ -148,8 +149,10 @@ private static AnnotationTree deprecatedAnnotation(Iterable anno } private static boolean isDeprecated(AnnotationTree tree) { - return tree.annotationType().is(Kind.IDENTIFIER) && - "Deprecated".equals(((IdentifierTree) tree.annotationType()).name()); + if (tree.annotationType().is(Kind.IDENTIFIER)) { + return "Deprecated".equals(((IdentifierTree) tree.annotationType()).name()); + } + return tree.annotationType().symbolType().is(DEPRECATED_ANNOTATION); } /**