SONARPY-2059 PythonScanner should log the parsing exception on the correct line for notebooks (#1912)

Author: ghislainpiot

sonar-python-plugin/src/main/java/org/sonar/plugins/python/PythonScanner.java

@@ -121,12 +121,16 @@ protected void scanFile(PythonInputFile inputFile) throws IOException {
       }
     } catch (RecognitionException e) {
       visitorContext = new PythonVisitorContext(pythonFile, e, context.runtime().getProduct());
+
+      var line = (inputFile.kind() == PythonInputFile.Kind.IPYTHON) ? ((GeneratedIPythonFile) inputFile).locationMap().get(e.getLine()).line() : e.getLine();
+      var newMessage = e.getMessage().replace("line " + e.getLine(), "line " + line);
+
       LOG.error("Unable to parse file: " + inputFile);
-      LOG.error(e.getMessage());
+      LOG.error(newMessage);
       context.newAnalysisError()
         .onFile(inputFile.wrappedFile())
-        .at(inputFile.wrappedFile().newPointer(e.getLine(), 0))
-        .message(e.getMessage())
+        .at(inputFile.wrappedFile().newPointer(line, 0))
+        .message(newMessage)
         .save();
     }
     List<PythonSubscriptionCheck> checksBasedOnTree = new ArrayList<>();

sonar-python-plugin/src/test/java/org/sonar/plugins/python/IPynbSensorTest.java

@@ -26,6 +26,7 @@
 import java.util.List;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
 import org.mockito.Mockito;
 import org.slf4j.event.Level;
 import org.sonar.api.SonarRuntime;
@@ -76,7 +77,7 @@ class IPynbSensorTest {
 
   private ActiveRules activeRules;
 
-  @org.junit.Rule
+  @RegisterExtension
   public LogTesterJUnit5 logTester = new LogTesterJUnit5().setLevel(Level.DEBUG);
 
   @BeforeEach
@@ -227,4 +228,14 @@ void test_notebook_sensor_does_not_execute_cpd_measures() {
     assertThat(tokensLines)
       .isNull();
   }
+
+  @Test
+  void test_notebook_sensor_parse_error_on_valid_line(){
+    inputFile("notebook_parse_error.ipynb");
+    activeRules = new ActiveRulesBuilder().build();
+    var sensor = notebookSensor();
+    sensor.execute(context);
+    var logs = String.join("", logTester.logs());
+    assertThat(logs).contains("Unable to parse file: notebook_parse_error.ipynbParse error at line 1");
+  }
 }

sonar-python-plugin/src/test/resources/org/sonar/plugins/python/ipynb/notebook_parse_error.ipynb

@@ -0,0 +1 @@
+{"cells":[{"cell_type":"code","execution_count":null,"metadata":{},"outputs":[],"source":["a = 3"]},{"cell_type":"code","execution_count":1,"metadata":{},"outputs":[{"ename":"SyntaxError","evalue":"incomplete input (2552824149.py, line 1)","output_type":"error","traceback":["\u001b[0;36m  Cell \u001b[0;32mIn[1], line 1\u001b[0;36m\u001b[0m\n\u001b[0;31m    def main(\u001b[0m\n\u001b[0m             ^\u001b[0m\n\u001b[0;31mSyntaxError\u001b[0m\u001b[0;31m:\u001b[0m incomplete input\n"]}],"source":[" def main(): ..."]}],"metadata":{"kernelspec":{"display_name":"Python 3","language":"python","name":"python3"},"language_info":{"codemirror_mode":{"name":"ipython","version":3},"file_extension":".py","mimetype":"text/x-python","name":"python","nbconvert_exporter":"python","pygments_lexer":"ipython3","version":"3.12.2"}},"nbformat":4,"nbformat_minor":2}