SONARJAVA-4543 S5778 does not report on final Enum methods (#5131)

Author: leonardo-pilastri-sonarsource

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

@@ -1,6 +1,6 @@
 {
   "ruleKey": "S5778",
   "hasTruePositives": false,
-  "falseNegatives": 31,
+  "falseNegatives": 32,
   "falsePositives": 0
-}
+}

java-checks-test-sources/default/src/test/java/checks/tests/OneExpectedRuntimeExceptionCheckSample.java

@@ -13,6 +13,29 @@
 
 public class OneExpectedRuntimeExceptionCheckSample {
 
+  private Object fun(Object x) {
+    return x;
+  }
+
+  enum ENUM {
+    E1, E2
+  }
+
+  @Test
+  void testEnumStaticFinalMethods() {
+    var o = fun(ENUM.E1);
+    assertThrows(IllegalStateException.class, () -> fun(ENUM.E1.name())); //Compliant, java.lang.Enum#name is final and cannot throw exceptions
+    assertThrows(IllegalStateException.class, () -> fun(ENUM.E1.ordinal()));
+    assertThrows(IllegalStateException.class, () -> fun(ENUM.E1.hashCode()));
+    assertThrows(IllegalStateException.class, () -> fun(ENUM.E1.compareTo(ENUM.E2)));
+    assertThrows(IllegalStateException.class, () -> fun(ENUM.E1.getDeclaringClass()));
+    assertThrows(IllegalStateException.class, () -> fun(ENUM.E1.describeConstable()));
+    assertThrows(IllegalStateException.class, () -> fun(ENUM.E1.equals(o)));
+
+    //Non-final methods
+    assertThrows(IllegalStateException.class, () -> fun(ENUM.E1.toString())); // Noncompliant
+  }
+
   private final Class<IllegalStateException> myException = IllegalStateException.class;
   private final Executable exec = () -> foo(foo(1));
 

java-checks/src/main/java/org/sonar/java/checks/tests/OneExpectedRuntimeExceptionCheck.java

@@ -33,7 +33,16 @@ public class OneExpectedRuntimeExceptionCheck extends AbstractOneExpectedExcepti
     .names("mock")
     .addParametersMatcher("java.lang.Class").addParametersMatcher("java.lang.Class", "java.lang.String")
     .build();
-  private static final MethodMatchers AUTHORIZED_METHODS = MethodMatchers.or(FAIL_METHOD_MATCHER, MOCKITO_MOCK_METHOD_MATCHERS);
+  private static final MethodMatchers ENUM_FINAL_METHODS = MethodMatchers.create()
+    .ofSubTypes("java.lang.Enum")
+    .names("name", "ordinal", "equals", "hashCode", "compareTo", "getDeclaringClass", "describeConstable")
+    .withAnyParameters()
+    .build();
+  private static final MethodMatchers AUTHORIZED_METHODS = MethodMatchers.or(
+    FAIL_METHOD_MATCHER,
+    MOCKITO_MOCK_METHOD_MATCHERS,
+    ENUM_FINAL_METHODS
+  );
 
   @Override
   void reportMultipleCallInTree(List<Type> expectedExceptions, Tree treeToVisit, Tree reportLocation, String placeToRefactor) {