SONARPY-2980: Create QuickFix for Rule S7504 (#317)

GitOrigin-RevId: 6d1bb481a199fde32cfd7c564fa1ca284dce751c

Author: joke1196

python-checks/src/main/java/org/sonar/python/checks/UnnecessaryListCastCheck.java

@@ -21,13 +21,16 @@
 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.quickfix.PythonQuickFix;
 import org.sonar.plugins.python.api.tree.CallExpression;
 import org.sonar.plugins.python.api.tree.ComprehensionFor;
 import org.sonar.plugins.python.api.tree.Expression;
 import org.sonar.plugins.python.api.tree.ForStatement;
 import org.sonar.plugins.python.api.tree.RegularArgument;
 import org.sonar.plugins.python.api.tree.Tree;
 import org.sonar.plugins.python.api.types.v2.TriBool;
+import org.sonar.python.quickfix.TextEditUtils;
+import org.sonar.python.tree.TreeUtils;
 import org.sonar.python.types.v2.TypeCheckBuilder;
 
 @Rule(key = "S7504")
@@ -57,7 +60,13 @@ private void checkComprehensions(SubscriptionContext ctx) {
 
   private void checkListCastCheck(List<Expression> expressions, SubscriptionContext ctx) {
     hasListCallOnIterable(expressions)
-      .ifPresent(listCall -> ctx.addIssue(listCall.callee(), "Remove this unnecessary `list()` call on an already iterable object."));
+      .ifPresent(listCall -> {
+        PreciseIssue issue = ctx.addIssue(listCall.callee(), "Remove this unnecessary `list()` call on an already iterable object.");
+        Optional.ofNullable(TreeUtils.treeToString(listCall.argumentList(), false))
+          .map(replacementText -> TextEditUtils.replace(listCall, replacementText))
+          .map(textEdit -> PythonQuickFix.newQuickFix("Remove the \"list\" call", textEdit))
+          .ifPresent(issue::addQuickFix);
+      });
   }
 
   private Optional<CallExpression> hasListCallOnIterable(List<Expression> testExpressions) {

python-checks/src/test/java/org/sonar/python/checks/UnnecessaryListCastCheckTest.java

@@ -17,13 +17,52 @@
 package org.sonar.python.checks;
 
 import org.junit.jupiter.api.Test;
+import org.sonar.python.checks.quickfix.PythonQuickFixVerifier;
 import org.sonar.python.checks.utils.PythonCheckVerifier;
 
 class UnnecessaryListCastCheckTest {
 
+  private static final UnnecessaryListCastCheck check = new UnnecessaryListCastCheck();
+
   @Test
   void test() {
-    PythonCheckVerifier.verify("src/test/resources/checks/unnecessaryListCast.py", new UnnecessaryListCastCheck());
+    PythonCheckVerifier.verify("src/test/resources/checks/unnecessaryListCast.py", check);
+  }
+
+  @Test
+  void test_quick_fix() {
+    String codeWithIssue = """
+    for x in list([1,2,5]):
+        ...
+    """;
+    PythonQuickFixVerifier.verifyQuickFixMessages(check, codeWithIssue, "Remove the \"list\" call");
+
+    String correctCode = """
+    for x in [1,2,5]:
+        ...
+    """;
+
+    PythonQuickFixVerifier.verify(check, codeWithIssue, correctCode);
   }
 
+  @Test
+  void test_quick_fix_comprehension() {
+    String codeWithIssue = "{i for i in list([1,2,3])}";
+    String correctCode = "{i for i in [1,2,3]}";
+
+    PythonQuickFixVerifier.verify(check, codeWithIssue, correctCode);
+  }
+
+  @Test
+  void test_no_quick_fix_on_multiline() {
+    String codeWithIssue = """
+    for x in list(
+        [
+        1,
+        2,
+        5]):
+        ...
+    """;
+    PythonQuickFixVerifier.verifyNoQuickFixes(check, codeWithIssue);
+  }
 }