SONARPY-1727: S5905: Make sure the quick fix removes trailing commas (#…

…2020) * SONARPY-1727 remove trailing comma of singelton tuple * SONARPY-1727 fix after review * SONARPY-1727 fix review nitpick
SonarSource · Sep 30, 2024 · cacf1e6 · cacf1e6
1 parent 0478d39
commit cacf1e6
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 12 deletions.
diff --git a/python-checks/src/main/java/org/sonar/python/checks/tests/AssertOnTupleLiteralCheck.java b/python-checks/src/main/java/org/sonar/python/checks/tests/AssertOnTupleLiteralCheck.java
@@ -21,10 +21,11 @@
 
 import org.sonar.check.Rule;
 import org.sonar.plugins.python.api.PythonSubscriptionCheck;
+import org.sonar.plugins.python.api.quickfix.PythonQuickFix;
 import org.sonar.plugins.python.api.tree.AssertStatement;
+import org.sonar.plugins.python.api.tree.Token;
 import org.sonar.plugins.python.api.tree.Tree;
 import org.sonar.plugins.python.api.tree.Tuple;
-import org.sonar.plugins.python.api.quickfix.PythonQuickFix;
 import org.sonar.python.quickfix.TextEditUtils;
 
 @Rule(key = "S5905")
@@ -43,17 +44,22 @@ public void initialize(Context context) {
 
         var issue = ctx.addIssue(tuple, MESSAGE);
 
-        if (tuple.leftParenthesis() != null && tuple.rightParenthesis() != null) {
-          // defensive condition
-          issue.addQuickFix(PythonQuickFix.newQuickFix(QUICK_FIX_MESSAGE)
+        if (isSingletonTupleWithParenthesis(tuple)) {
+          Token comma =  tuple.commas().get(0);
+          var quickfixBuilder = PythonQuickFix.newQuickFix(QUICK_FIX_MESSAGE)
             .addTextEdit(TextEditUtils.remove(tuple.leftParenthesis()))
-            .addTextEdit(TextEditUtils.remove(tuple.rightParenthesis()))
-            .build());
+            .addTextEdit(TextEditUtils.replaceRange(comma, tuple.rightParenthesis(), ""));
+
+          issue.addQuickFix(quickfixBuilder.build());
         }
       }
     });
   }
 
+  private static boolean isSingletonTupleWithParenthesis(Tuple tuple) {
+    return tuple.leftParenthesis() != null && tuple.rightParenthesis() != null && tuple.elements().size() == 1;
+  }
+
   @Override
   public CheckScope scope() {
     return CheckScope.ALL;

diff --git a/python-checks/src/test/java/org/sonar/python/checks/tests/AssertOnTupleLiteralCheckTest.java b/python-checks/src/test/java/org/sonar/python/checks/tests/AssertOnTupleLiteralCheckTest.java
@@ -35,12 +35,11 @@ void test() {
 
   @Test
   void quickFixTest() {
-    var before = "def foo():\n" +
-      "    assert (a, b)";
-    var after = "def foo():\n" +
-      "    assert a, b";
-    PythonQuickFixVerifier.verify(new AssertOnTupleLiteralCheck(), before, after);
-    PythonQuickFixVerifier.verifyQuickFixMessages(new AssertOnTupleLiteralCheck(), before, AssertOnTupleLiteralCheck.QUICK_FIX_MESSAGE);
+    PythonQuickFixVerifier.verifyQuickFixMessages(new AssertOnTupleLiteralCheck(), "assert (foo(),)", "Remove parentheses");
+    PythonQuickFixVerifier.verify(new AssertOnTupleLiteralCheck(), "assert (foo(),)", "assert foo()");
+    PythonQuickFixVerifier.verifyNoQuickFixes(new AssertOnTupleLiteralCheck(), "assert (foo(),b,)");
+    PythonQuickFixVerifier.verifyNoQuickFixes(new AssertOnTupleLiteralCheck(), "assert (foo(),b)");
+    PythonQuickFixVerifier.verifyNoQuickFixes(new AssertOnTupleLiteralCheck(), "assert ()");
   }
 
   @Test