SONARJAVA-6521 Exclude lifecycle annotations from S2325 (#5704)

Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com>
Co-authored-by: rombirli <56340680+rombirli@users.noreply.github.com>

Author: 3 people

java-checks-test-sources/default/src/main/files/non-compiling/checks/StaticMethodCheckSample.java

@@ -35,3 +35,36 @@ private void method() { // Compliant
 class SerializableExclusions implements Serializable {
   private Object writeReplace() throws ObjectStreamException { }
 }
+
+class LifecycleAnnotations {
+  private static int counter = 0;
+
+  @javax.annotation.PostConstruct
+  private void initPostConstruct() { // Compliant - lifecycle method
+    System.out.println("PostConstruct");
+  }
+
+  @jakarta.annotation.PreDestroy
+  private void cleanupPreDestroy() { // Compliant - lifecycle method
+    System.out.println("PreDestroy");
+  }
+
+  @javax.ejb.PostActivate
+  private void activatePostActivate() { // Compliant - lifecycle method
+    System.out.println("PostActivate");
+  }
+
+  @jakarta.ejb.PrePassivate
+  private void passivatePrePassivate() { // Compliant - lifecycle method
+    System.out.println("PrePassivate");
+  }
+
+  @io.quarkus.runtime.Startup
+  private void startupMethod() { // Compliant - Quarkus startup method
+    System.out.println("Startup");
+  }
+
+  private void regularMethod() { // Noncompliant {{Make "regularMethod" a "static" method.}}
+    counter++;
+  }
+}

java-checks/src/main/java/org/sonar/java/checks/StaticMethodCheck.java

@@ -16,7 +16,9 @@
  */
 package org.sonar.java.checks;
 
+
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.Deque;
 import java.util.LinkedList;
 import java.util.List;
@@ -72,6 +74,18 @@ public class StaticMethodCheck extends BaseTreeVisitor implements JavaFileScanne
         params.isEmpty() || (params.size() == 1 && params.get(0).isSubtypeOf("java.lang.String[]")))
       .build();
 
+  private static final String[] LIFECYCLE_ANNOTATIONS = {
+    "javax.annotation.PostConstruct",
+    "javax.annotation.PreDestroy",
+    "jakarta.annotation.PostConstruct",
+    "jakarta.annotation.PreDestroy",
+    "javax.ejb.PostActivate",
+    "javax.ejb.PrePassivate",
+    "jakarta.ejb.PostActivate",
+    "jakarta.ejb.PrePassivate",
+    "io.quarkus.runtime.Startup"
+  };
+
   private JavaFileScannerContext context;
   private Deque<MethodReference> methodReferences = new LinkedList<>();
 
@@ -168,7 +182,16 @@ private static boolean shouldBePlacedAfterStatic(Modifier modifier) {
   }
 
   private static boolean isExcluded(MethodTree tree) {
-    return tree.is(Tree.Kind.CONSTRUCTOR) || EXCLUDED_SERIALIZABLE_METHODS.matches(tree) || hasEmptyBody(tree) || MAIN_METHOD.matches(tree);
+    return tree.is(Tree.Kind.CONSTRUCTOR)
+      || EXCLUDED_SERIALIZABLE_METHODS.matches(tree)
+      || hasEmptyBody(tree)
+      || MAIN_METHOD.matches(tree)
+      || hasLifecycleAnnotation(tree);
+  }
+
+  private static boolean hasLifecycleAnnotation(MethodTree tree) {
+    var metadata = tree.symbol().metadata();
+    return Arrays.stream(LIFECYCLE_ANNOTATIONS).anyMatch(metadata::isAnnotatedWith);
   }
 
   private static boolean hasEmptyBody(MethodTree tree) {

java-checks/src/test/java/org/sonar/java/checks/StaticMethodCheckTest.java

@@ -45,7 +45,7 @@ void test_non_compiling() {
     CheckVerifier.newVerifier()
       .onFile(nonCompilingTestSourcesPath("checks/StaticMethodCheckSample.java"))
       .withCheck(new StaticMethodCheck())
-      .verifyNoIssues();
+      .verifyIssues();
   }
 
 }