fix(GCI82): update GCI82 rule to handle record types and adjust test cases

Author: Morille, Amelie (ITDV XF) - AF

CHANGELOG.md

@@ -15,6 +15,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - upgrade libraries versions
 - correction of technical problem with Integration tests (because of Maven format in technical answer to "sonar-orchestrator-junit5" library)
 - upgrade JDK from 11 to 17
+- fix GCI82 rule to handle record types and adjust test cases
 
 ### Deleted
 

src/it/java/org/greencodeinitiative/creedengo/java/integration/tests/GCIRulesIT.java

@@ -440,8 +440,8 @@ void testGCI82() {
         String filePath = "src/main/java/org/greencodeinitiative/creedengo/java/checks/MakeNonReassignedVariablesConstants.java";
         String ruleId = "creedengo-java:GCI82";
         String ruleMsg = "The variable is never reassigned and can be 'final'";
-        int[] startLines = new int[]{7, 12, 13, 45};
-        int[] endLines = new int[]{7, 12, 13, 45};
+        int[] startLines = new int[]{7, 17, 18 ,50};
+        int[] endLines = new int[]{7, 17, 18 ,50};
 
         checkIssuesForFile(filePath, ruleId, ruleMsg, startLines, endLines);
     }

src/it/test-projects/creedengo-java-plugin-test-project/src/main/java/org/greencodeinitiative/creedengo/java/checks/MakeNonReassignedVariablesConstants.java

@@ -8,6 +8,11 @@ public class MakeNonReassignedVariablesConstants {
     private Object myNonFinalAndReassignedObject = new Object(); // Compliant
     private final Object myFinalAndNotReassignedObject = new Object(); // Compliant
 
+    private record myRecord(
+            String myImplicitlyFinalStringField, // Compliant
+            Integer myImplicitlyFinalIntField) // Compliant
+    { }
+
     private static final String CONSTANT = "toto";  // Compliant
     private String varDefinedInClassNotReassigned = "0"; // Noncompliant {{The variable is never reassigned and can be 'final'}}
     private String varDefinedInClassNotUsed = "0"; // Noncompliant {{The variable is never reassigned and can be 'final'}}
@@ -66,4 +71,4 @@ void classVariableReassignedBis() {
         logger.info(myFinalAndNotReassignedObject.toString());
     }
 
-}
+}

src/main/java/org/greencodeinitiative/creedengo/java/checks/MakeNonReassignedVariablesConstants.java

@@ -30,7 +30,7 @@ public void visitNode(@Nonnull Tree tree) {
         LOGGER.debug("   => usages = " + variableTree.symbol().usages().size());
         LOGGER.debug("   => isNotReassigned = " + isNotReassigned(variableTree));
 
-        if (isNotFinalAndNotStatic(variableTree) && isNotReassigned(variableTree)) {
+        if (isNotFromRecord(variableTree) && isNotFinalAndNotStatic(variableTree) && isNotReassigned(variableTree)) {
             reportIssue(tree, MESSAGE_RULE);
         } else {
             super.visitNode(tree);
@@ -80,6 +80,13 @@ private static boolean isNotFinalAndNotStatic(VariableTree variableTree) {
         return hasNoneOf(variableTree.modifiers(), Modifier.FINAL, Modifier.STATIC);
     }
 
+    private static boolean isNotFromRecord(VariableTree variableTree) {
+        Tree parent = variableTree.parent();
+        if (parent == null) return false;
+
+        return !parent.is(Kind.RECORD);
+    }
+
     private static boolean hasNoneOf(ModifiersTree modifiersTree, Modifier... unexpectedModifiers) {
         return !hasAnyOf(modifiersTree, unexpectedModifiers);
     }

src/test/files/MakeNonReassignedVariablesConstants.java

@@ -8,6 +8,11 @@ public class MakeNonReassignedVariablesConstants {
     private Object myNonFinalAndReassignedObject = new Object(); // Compliant
     private final Object myFinalAndNotReassignedObject = new Object(); // Compliant
 
+    private record myRecord(
+            String myImplicitlyFinalStringField, // Compliant
+            Integer myImplicitlyFinalIntField) // Compliant
+    { }
+
     private static final String CONSTANT = "toto";  // Compliant
     private String varDefinedInClassNotReassigned = "0"; // Noncompliant {{The variable is never reassigned and can be 'final'}}
     private String varDefinedInClassNotUsed = "0"; // Noncompliant {{The variable is never reassigned and can be 'final'}}
@@ -66,4 +71,4 @@ void classVariableReassignedBis() {
         logger.info(myFinalAndNotReassignedObject.toString());
     }
 
-}
+}

src/test/java/org/greencodeinitiative/creedengo/java/checks/MakeNonReassignedVariablesConstantsTest.java

@@ -29,5 +29,4 @@ void test() {
                 .withCheck(new MakeNonReassignedVariablesConstants())
                 .verifyIssues();
     }
-
 }