SONARJAVA-5336 S1068 Fix FP with @Getter and @Setter annotations in automatic analysis (#5022)

Author: tomasz-tylenda-sonarsource

its/autoscan/src/test/java/org/sonar/java/it/AutoScanTest.java

@@ -195,7 +195,7 @@ public void javaCheckTestSources() throws Exception {
     SoftAssertions softly = new SoftAssertions();
     softly.assertThat(newDiffs).containsExactlyInAnyOrderElementsOf(knownDiffs.values());
     softly.assertThat(newTotal).isEqualTo(knownTotal);
-    softly.assertThat(rulesCausingFPs).hasSize(10);
+    softly.assertThat(rulesCausingFPs).hasSize(9);
     softly.assertThat(rulesNotReporting).hasSize(11);
 
     /**

its/autoscan/src/test/resources/autoscan/diffs/diff_S1068.json

@@ -2,5 +2,5 @@
   "ruleKey": "S1068",
   "hasTruePositives": true,
   "falseNegatives": 0,
-  "falsePositives": 4
+  "falsePositives": 0
 }

java-checks-test-sources/default/src/main/java/checks/unused/UnusedPrivateFieldCheck.java

@@ -6,6 +6,9 @@
 import java.io.IOException;
 import java.util.Optional;
 
+import lombok.Getter;
+import lombok.Setter;
+
 class UnusedPrivateFieldCheck {
 
   private int unusedField; // Noncompliant {{Remove this unused "unusedField" private field.}}
@@ -94,6 +97,20 @@ Long transform(String number) {
   }
 }
 
+class UnusedPrivateFieldCheckUnqualifiedAnnotations {
+  @Getter
+  @Setter
+  static class MyData {
+    private String name;
+    private int dob;
+  }
+
+  static class MoreData {
+    private String airline; // Noncompliant
+    private int price; // Noncompliant
+  }
+}
+
 class UnusedPrivateFieldCheckQuickfix {
 
   private String unusedField; // Noncompliant [[quickfixes=qf0]]

java-checks/src/main/java/org/sonar/java/checks/unused/UnusedPrivateFieldCheck.java

@@ -55,6 +55,8 @@
 import org.sonar.plugins.java.api.tree.TypeTree;
 import org.sonar.plugins.java.api.tree.VariableTree;
 
+import static org.sonar.java.checks.helpers.AnnotationsHelper.annotationTypeIdentifier;
+
 @Rule(key = "S1068")
 public class UnusedPrivateFieldCheck extends IssuableSubscriptionVisitor {
 
@@ -193,9 +195,15 @@ && onlyUsedInVariableAssignment(symbol)
 
   private static boolean hasOwnerClassAllowedAnnotations(VariableTree variableTree) {
     var ownerClass = (ClassTree) variableTree.parent();
-    return ownerClass.modifiers().annotations().stream().anyMatch(
-      annotation -> OWNER_CLASS_ALLOWED_ANNOTATIONS.contains(annotation.annotationType().symbolType().fullyQualifiedName())
-    );
+    var metadata = ownerClass.symbol().metadata();
+    for (String name: OWNER_CLASS_ALLOWED_ANNOTATIONS) {
+      // If the annotation does not use a fully qualified name e.g. `@Getter`,
+      // then only the identifier portion will be available in automatic analysis.
+      if (metadata.isAnnotatedWith(name) || metadata.isAnnotatedWith(annotationTypeIdentifier(name))) {
+        return true;
+      }
+    }
+    return false;
   }
 
   private boolean onlyUsedInVariableAssignment(Symbol symbol) {

java-checks/src/test/java/org/sonar/java/checks/unused/UnusedPrivateFieldCheckTest.java

@@ -32,6 +32,20 @@ void test() {
       .verifyIssues();
   }
 
+  /**
+   * Unused private fields can be detected without semantics. The test verifies
+   * that we correctly process annotations which suppress warnings and
+   * do not produce FPs when semantics is missing.
+   */
+  @Test
+  void test_without_semantic() {
+    CheckVerifier.newVerifier()
+      .onFile(mainCodeSourcesPath("checks/unused/UnusedPrivateFieldCheck.java"))
+      .withCheck(new UnusedPrivateFieldCheck())
+      .withoutSemantic()
+      .verifyIssues();
+  }
+
   @Test
   void test_non_compiling() {
     CheckVerifier.newVerifier()