GCI100 StringConcatenation fix: resolve conflicts

Co-authored-by: DataLabGroupe-CreditAgricole <[email protected]>

Author: cleophass

CHANGELOG.md

@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - [#73](https://github.com/green-code-initiative/creedengo-python/pull/73) Add rule GCI100 Disable Gradient For model eval, a rule specific to PyTorch and AI/ML
+- [#78](https://github.com/green-code-initiative/creedengo-python/pull/78) Add rule GCI105 on String Concatenation. This rule may also apply to other rules
 - [#74](https://github.com/green-code-initiative/creedengo-python/pull/74) Add rule GCI101 Avoid Conv Bias Before Batch Normalization, a rule specific to Deeplearning
 - [#75](https://github.com/green-code-initiative/creedengo-python/pull/75) Add rule GCI102 avoid non pinned memory for dataloader. This rule is specific to PyTorch and so AI
 - [#68](https://github.com/green-code-initiative/creedengo-python/pull/68) Data : Add rule GCI107 Avoid Iterative Matrix Operations. Use vectorization by the usage of the built-in functions of TensorFlow, NumPy or Pandas

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

@@ -320,21 +320,6 @@ void testGCI99(){
 
         checkIssuesForFile(filePath, ruleId, ruleMsg, startLines, endLines, SEVERITY, TYPE, EFFORT_50MIN);
     }
-
-    @Test
-    void testGCI102(){
-        String filePath = "src/avoidNonPinnedMemoryForDataloaders.py";
-        String ruleId = "creedengo-python:GCI102";
-        String ruleMsg = "Use pinned memory to reduce data transfer in RAM.";
-        int[] startLines = new int[]{
-                7, 8, 9, 10, 11, 12, 13, 14
-        };
-        int[] endLines = new int[]{
-                7, 8, 9, 10, 11, 12, 13, 14
-        };
-
-        checkIssuesForFile(filePath, ruleId, ruleMsg, startLines, endLines, SEVERITY, TYPE, EFFORT_10MIN);
-    }
 
     @Test 
     void testGCI100() {
@@ -366,7 +351,22 @@ void testGCI101(){
 
         checkIssuesForFile(filePath, ruleId, ruleMsg, startLines, endLines, SEVERITY, TYPE, EFFORT_10MIN);
     }
-  
+
+    @Test
+    void testGCI102(){
+        String filePath = "src/avoidNonPinnedMemoryForDataloaders.py";
+        String ruleId = "creedengo-python:GCI102";
+        String ruleMsg = "Use pinned memory to reduce data transfer in RAM.";
+        int[] startLines = new int[]{
+                7, 8, 9, 10, 11, 12, 13, 14
+        };
+        int[] endLines = new int[]{
+                7, 8, 9, 10, 11, 12, 13, 14
+        };
+
+        checkIssuesForFile(filePath, ruleId, ruleMsg, startLines, endLines, SEVERITY, TYPE, EFFORT_10MIN);
+    }
+
     @Test
     void testGCI103(){
 
@@ -380,6 +380,22 @@ void testGCI103(){
             5, 8, 24, 27, 36
         };
 
+        checkIssuesForFile(filePath, ruleId, ruleMsg, startLines, endLines, SEVERITY, TYPE, EFFORT_1MIN);  
+    }
+ 
+    @Test
+    void testGCI105() {
+
+        String filePath = "src/stringConcatenation.py";
+        String ruleId = "creedengo-python:GCI105";
+        String ruleMsg = "Concatenation of strings should be done using f-strings or str.join()";
+        int[] startLines = new int[]{
+            5, 8, 10, 32, 38
+        };
+        int[] endLines = new int[]{
+            5, 8, 10, 32, 38
+        };
+
         checkIssuesForFile(filePath, ruleId, ruleMsg, startLines, endLines, SEVERITY, TYPE, EFFORT_1MIN);
     }
 

src/it/test-projects/creedengo-python-plugin-test-project/src/stringConcatenation.py

@@ -0,0 +1,38 @@
+text = "hello"
+following_words = ["world", "I", "am", "a", "string", "concatenation"]
+
+for word in following_words:
+    text += word  # Noncompliant {{Concatenation of strings should be done using f-strings or str.join()}}
+
+text = "init"
+text += " add this"  # Noncompliant {{Concatenation of strings should be done using f-strings or str.join()}}
+
+text += [word for word in following_words]  # Noncompliant {{Concatenation of strings should be done using f-strings or str.join()}}
+
+
+result = " ".join([text] + following_words) 
+
+
+final = f"{text} {' '.join(following_words)}" 
+
+
+def build_string(base, parts):
+    return f"{base} {' '.join(parts)}"  
+
+mylist = []
+mylist += [1, 2, 3]  # Compliant
+
+
+count = 0
+count += 1  # Compliant
+
+
+msg = "start"
+if True:
+    msg += " continued"  # Noncompliant {{Concatenation of strings should be done using f-strings or str.join()}}
+
+
+def get_text():
+    return "function text"
+
+text += get_text()  # Noncompliant {{Concatenation of strings should be done using f-strings or str.join()}}

src/main/java/org/greencodeinitiative/creedengo/python/PythonRuleRepository.java

@@ -49,7 +49,8 @@ public class PythonRuleRepository implements RulesDefinition, PythonCustomRuleRe
             AvoidIterativeMatrixOperations.class,
             AvoidNonPinnedMemoryForDataloaders.class,
             AvoidConvBiasBeforeBatchNorm.class,
-            DisableGradientForModelEval.class
+            DisableGradientForModelEval.class,
+            StringConcatenation.class
     );
 
     public static final String LANGUAGE = "py";

src/main/java/org/greencodeinitiative/creedengo/python/checks/StringConcatenation.java

@@ -0,0 +1,94 @@
+/*
+ * creedengo - Python language - Provides rules to reduce the environmental footprint of your Python programs
+ * Copyright © 2024 Green Code Initiative (https://green-code-initiative.org)
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+package org.greencodeinitiative.creedengo.python.checks;
+
+import org.sonar.check.Rule;
+import org.sonar.plugins.python.api.PythonSubscriptionCheck;
+import org.sonar.plugins.python.api.SubscriptionContext;
+import org.sonar.plugins.python.api.tree.Name;
+import org.sonar.plugins.python.api.tree.CompoundAssignmentStatement;
+import org.sonar.plugins.python.api.tree.Tree;
+import org.sonar.plugins.python.api.tree.Expression;
+import org.sonar.plugins.python.api.tree.AssignmentStatement;
+
+import java.util.ArrayList;
+import java.util.List;
+
+@Rule(key = "GCI105")
+public class StringConcatenation extends PythonSubscriptionCheck {
+
+    private final List<String> stringVariables = new ArrayList<>();
+
+    public static final String DESCRIPTION = "Concatenation of strings should be done using f-strings or str.join()";
+
+    @Override
+    public void initialize(Context context) {
+        context.registerSyntaxNodeConsumer(Tree.Kind.ASSIGNMENT_STMT, this::trackVariableAssignments);
+        context.registerSyntaxNodeConsumer(Tree.Kind.COMPOUND_ASSIGNMENT, this::checkAssignment);
+    }
+
+    private void checkAssignment(SubscriptionContext context) {
+        CompoundAssignmentStatement compoundAssignment = (CompoundAssignmentStatement) context.syntaxNode();
+        if ("+=".equals(compoundAssignment.compoundAssignmentToken().value())) {
+            Expression lhsExpression = compoundAssignment.lhsExpression();
+            if (lhsExpression.is(Tree.Kind.NAME)) {
+                String variableName = ((Name) lhsExpression).name();
+                if (stringVariables.contains(variableName)) {
+                    context.addIssue(lhsExpression.firstToken(), DESCRIPTION);
+                }
+            }
+        }
+    }
+
+    private void trackVariableAssignments(SubscriptionContext context) {
+        AssignmentStatement assignment = (AssignmentStatement) context.syntaxNode();
+        if (assignment.lhsExpressions().size() == 1) {
+            Expression lhs = assignment.lhsExpressions().get(0).expressions().get(0);
+            if (lhs.is(Tree.Kind.NAME)) {
+                String variableName = ((Name) lhs).name();
+                Expression assignedValue = assignment.assignedValue();
+                if (isStringAssignment(assignedValue)) {
+                    if (!stringVariables.contains(variableName)) {
+                        stringVariables.add(variableName);
+                    }
+                } else {
+                    stringVariables.remove(variableName);
+                }
+            }
+        }
+    }
+
+    private boolean isStringAssignment(Expression assignedValue) {
+        return assignedValue.is(Tree.Kind.STRING_ELEMENT) ||
+                assignedValue.is(Tree.Kind.STRING_LITERAL) ||
+                containsStringElement(assignedValue);
+    }
+
+    private boolean containsStringElement(Tree node) {
+        if (node.is(Tree.Kind.STRING_ELEMENT) || node.is(Tree.Kind.STRING_LITERAL)) {
+            return true;
+        }
+        for (Tree child : node.children()) {
+            if (containsStringElement(child)) {
+                return true;
+            }
+        }
+        return false;
+    }
+
+}

src/main/resources/org/greencodeinitiative/creedengo/python/creedengo_way_profile.json

@@ -17,6 +17,7 @@
 		"GCI101",
 		"GCI102",
 		"GCI103",
+		"GCI105",
 		"GCI106",
 		"GCI107",
 		"GCI203",

src/test/java/org/greencodeinitiative/creedengo/python/checks/StringConcatenationTest.java

@@ -0,0 +1,29 @@
+/*
+ * creedengo - Python language - Provides rules to reduce the environmental footprint of your Python programs
+ * Copyright © 2024 Green Code Initiative (https://green-code-initiative.org)
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+package org.greencodeinitiative.creedengo.python.checks;
+
+import org.junit.Test;
+import org.sonar.python.checks.utils.PythonCheckVerifier;
+
+public class StringConcatenationTest {
+
+  @Test
+  public void test() {
+    PythonCheckVerifier.verify("src/test/resources/checks/stringConcatenation.py", new StringConcatenation());
+  }
+}

src/test/resources/checks/stringConcatenation.py

@@ -0,0 +1,41 @@
+text = "hello"
+following_words = ["world", "I", "am", "a", "string", "concatenation"]
+
+for word in following_words:
+    text += word  # Noncompliant {{Concatenation of strings should be done using f-strings or str.join()}}
+
+text = "init"
+text += " add this"  # Noncompliant {{Concatenation of strings should be done using f-strings or str.join()}}
+
+text += [word for word in following_words]  # Noncompliant {{Concatenation of strings should be done using f-strings or str.join()}}
+
+text = 0
+text +=1 
+
+text = "start"
+result = " ".join([text] + following_words) 
+
+
+final = f"{text} {' '.join(following_words)}" 
+
+
+def build_string(base, parts):
+    return f"{base} {' '.join(parts)}"  
+
+mylist = []
+mylist += [1, 2, 3]  # Compliant
+
+
+count = 0
+count += 1  # Compliant
+
+
+msg = "start"
+if True:
+    msg += " continued"  # Noncompliant {{Concatenation of strings should be done using f-strings or str.join()}}
+
+
+def get_text():
+    return "function text"
+
+text += get_text()  # Noncompliant {{Concatenation of strings should be done using f-strings or str.join()}}