SONARPY-1490: Add a quickfix for rule S6741. (#1594)

Author: Jeremi Do Dinh

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

@@ -23,14 +23,19 @@
 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.symbols.Symbol;
 import org.sonar.plugins.python.api.tree.QualifiedExpression;
 import org.sonar.plugins.python.api.tree.Tree;
+import org.sonar.python.quickfix.TextEditUtils;
 
 @Rule(key = "S6741")
 public class PandasDataFrameToNumpyCheck extends PythonSubscriptionCheck {
 
+  private static final String DATAFRAME_VALUES_FQN = "pandas.core.frame.DataFrame.values";
   private static final String MESSAGE = "Do not use \"DataFrame.values\".";
+  private static final String QUICK_FIX_MESSAGE = "Replace with DataFrame.to_numpy()";
+
   @Override
   public void initialize(Context context) {
     context.registerSyntaxNodeConsumer(Tree.Kind.QUALIFIED_EXPR, this::checkForDataFrameValues);
@@ -46,7 +51,12 @@ private void checkForDataFrameValues(SubscriptionContext ctx) {
     expr.qualifier().type()
       .resolveMember("values")
       .map(Symbol::fullyQualifiedName)
-      .filter("pandas.core.frame.DataFrame.values"::equals)
-      .ifPresent(str -> ctx.addIssue(expr.name(), MESSAGE));
+      .filter(DATAFRAME_VALUES_FQN::equals)
+      .ifPresent(str -> {
+        PreciseIssue issue = ctx.addIssue(expr.name(), MESSAGE);
+        issue.addQuickFix(PythonQuickFix.newQuickFix(QUICK_FIX_MESSAGE)
+          .addTextEdit(TextEditUtils.replace(expr.name(), "to_numpy()"))
+          .build());
+      });
   }
 }

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

@@ -20,13 +20,81 @@
 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 PandasDataFrameToNumpyCheckTest {
 
+  PandasDataFrameToNumpyCheck check = new PandasDataFrameToNumpyCheck();
+
+  private static final String QUICK_FIX_MESSAGE = "Replace this with a call to DataFrame.to_numpy()";
+
   @Test
   void test() {
-    PythonCheckVerifier.verify("src/test/resources/checks/pandasDataFrameToNumpy.py", new PandasDataFrameToNumpyCheck());
+    PythonCheckVerifier.verify("src/test/resources/checks/pandasDataFrameToNumpy.py", check);
+  }
+
+  @Test
+  void quick_fix_test_1() {
+    final String non_compliant = "def non_compliant_1(xx):\n" +
+      "    import pandas as pd\n" +
+      "\n" +
+      "    df = pd.DataFrame({\n" +
+      "        'X': ['A', 'B', 'A', 'C'],\n" +
+      "        'Y': [10, 7, 12, 5]\n" +
+      "    })\n" +
+      "\n" +
+      "    _ = df.values";
+    final String compliant = "def non_compliant_1(xx):\n" +
+      "    import pandas as pd\n" +
+      "\n" +
+      "    df = pd.DataFrame({\n" +
+      "        'X': ['A', 'B', 'A', 'C'],\n" +
+      "        'Y': [10, 7, 12, 5]\n" +
+      "    })\n" +
+      "\n" +
+      "    _ = df.to_numpy()";
+    performVerification(non_compliant, compliant);
+  }
+
+  @Test
+  void quick_fix_test_2() {
+
+    final String non_compliant = "def non_compliant_1(xx):\n" +
+      "    import pandas as pd\n" +
+      "\n" +
+      "    _ = pd.DataFrame({\n" +
+      "        'X': ['A', 'B', 'A', 'C'],\n" +
+      "        'Y': [10, 7, 12, 5]\n" +
+      "    }).values";
+    final String compliant = "def non_compliant_1(xx):\n" +
+      "    import pandas as pd\n" +
+      "\n" +
+      "    _ = pd.DataFrame({\n" +
+      "        'X': ['A', 'B', 'A', 'C'],\n" +
+      "        'Y': [10, 7, 12, 5]\n" +
+      "    }).to_numpy()";
+    performVerification(non_compliant, compliant);
   }
 
+  @Test
+  void quick_fix_test_3() {
+
+    final String non_compliant = "def dataframe_from_read_csv():\n" +
+      "    import pandas as pd\n" +
+      "\n" +
+      "    my_df = pd.read_csv(\"some_csv.csv\")\n" +
+      "    my_df.values.astype(str)";
+    final String compliant = "def dataframe_from_read_csv():\n" +
+      "    import pandas as pd\n" +
+      "\n" +
+      "    my_df = pd.read_csv(\"some_csv.csv\")\n" +
+      "    my_df.to_numpy().astype(str)";
+    performVerification(non_compliant, compliant);
+  }
+
+  private void performVerification(String non_compliant, String compliant) {
+    PythonQuickFixVerifier.verify(check, non_compliant, compliant);
+    PythonQuickFixVerifier.verifyQuickFixMessages(check, non_compliant, "Replace with DataFrame.to_numpy()");
+  }
 }