SONARPY-2012: IPynbParser should return a GeneratedIPythonFile (#1875)

Author: joke1196

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

@@ -20,19 +20,28 @@
 package org.sonar.plugins.python;
 
 import java.io.IOException;
+import java.util.Map;
 import org.sonar.api.batch.fs.InputFile;
+import org.sonar.plugins.python.IpynbNotebookParser.IPythonLocation;
 
 public class GeneratedIPythonFile implements PythonInputFile {
 
   InputFile wrappedFile;
 
   private String pythonContent;
 
-  public GeneratedIPythonFile(InputFile wrappedFile, String pythonContent) {
+  private Map<Integer, IPythonLocation> locationMap;
+
+  public GeneratedIPythonFile(InputFile wrappedFile, String pythonContent, Map<Integer, IPythonLocation> locationMap) {
+    this.locationMap = locationMap;
     this.wrappedFile = wrappedFile;
     this.pythonContent = pythonContent;
   }
-  
+
+  public Map<Integer, IPythonLocation> locationMap() {
+    return locationMap;
+  }
+
   @Override
   public InputFile wrappedFile() {
     return wrappedFile;

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

@@ -32,7 +32,7 @@ public class IpynbNotebookParser {
 
   public static final String SONAR_PYTHON_NOTEBOOK_CELL_DELIMITER = "\n#SONAR_PYTHON_NOTEBOOK_CELL_DELIMITER\n";
 
-  public static ParseResult parseNotebook(PythonInputFile inputFile) {
+  public static GeneratedIPythonFile parseNotebook(PythonInputFile inputFile) {
     try {
       return new IpynbNotebookParser(inputFile).parseNotebook();
     } catch (IOException e) {
@@ -51,7 +51,7 @@ private IpynbNotebookParser(PythonInputFile inputFile) {
   private final Map<Integer, IPythonLocation> locationMap = new HashMap<>();
   private int aggregatedSourceLine = 1;
 
-  public ParseResult parseNotebook() throws IOException {
+  public GeneratedIPythonFile parseNotebook() throws IOException {
     String content = inputFile.wrappedFile().contents();
     JsonFactory factory = new JsonFactory();
     try (JsonParser jParser = factory.createParser(content)) {
@@ -69,7 +69,7 @@ public ParseResult parseNotebook() throws IOException {
       }
     }
 
-    return new ParseResult(inputFile, aggregatedSource.toString(), locationMap);
+    return new GeneratedIPythonFile(inputFile.wrappedFile(), aggregatedSource.toString(), locationMap);
   }
 
   private void processCodeCell(JsonParser jParser) throws IOException {
@@ -164,9 +164,6 @@ private static Map<Integer, Integer> countEscapeCharacters(String sourceLine, Ma
     return colMap;
   }
 
-  public record ParseResult(PythonInputFile inputFile, String aggregatedSource, Map<Integer, IPythonLocation> locationMap) {
-  }
-
   public record IPythonLocation(int line, int column, Map<Integer, Integer> colOffset) {
   }
 

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

@@ -20,6 +20,7 @@
 package org.sonar.plugins.python;
 
 import java.io.IOException;
+import java.util.Map;
 import org.junit.jupiter.api.Test;
 import org.sonar.api.batch.fs.InputFile;
 import org.sonar.api.batch.fs.internal.TestInputFileBuilder;
@@ -31,28 +32,28 @@ class GeneratedIPythonFileTest {
 
   @Test
   void shouldHaveIPythonKind() {
-    PythonInputFile inputFile = new GeneratedIPythonFile(createWrappedFile(), "");
+    PythonInputFile inputFile = new GeneratedIPythonFile(createWrappedFile(), "", Map.of());
     assertThat(inputFile.kind()).isEqualTo(Kind.IPYTHON);
   }
 
   @Test
   void shouldReturnTheWrappedFile() {
     InputFile wrappedFile = createWrappedFile();
-    GeneratedIPythonFile inputFile = new GeneratedIPythonFile(wrappedFile, "");
+    GeneratedIPythonFile inputFile = new GeneratedIPythonFile(wrappedFile, "", Map.of());
     assertThat(inputFile.wrappedFile()).isEqualTo(wrappedFile);
   }
 
   @Test
   void shouldHaveTheWrappedFileToString() {
     InputFile wrappedFile = createWrappedFile();
-    PythonInputFile inputFile = new GeneratedIPythonFile(wrappedFile, "");
+    PythonInputFile inputFile = new GeneratedIPythonFile(wrappedFile, "", Map.of());
     assertThat(inputFile).hasToString(wrappedFile.toString());
   }
 
   @Test
   void shouldHaveTheContentPassed() throws IOException {
     InputFile wrappedFile = createWrappedFile();
-    PythonInputFile inputFile = new GeneratedIPythonFile(wrappedFile, "test");
+    PythonInputFile inputFile = new GeneratedIPythonFile(wrappedFile, "test", Map.of());
     assertThat(inputFile.contents()).isEqualTo("test");
 
   }

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

@@ -20,6 +20,7 @@
 package org.sonar.plugins.python;
 
 import java.io.File;
+import java.io.IOException;
 import java.util.Map;
 import org.junit.jupiter.api.Test;
 import org.sonar.api.batch.fs.InputFile;
@@ -33,23 +34,22 @@ class IpynbNotebookParserTest {
   private final File baseDir = new File("src/test/resources/org/sonar/plugins/python").getAbsoluteFile();
 
   @Test
-  void testParseNotebook() {
+  void testParseNotebook() throws IOException {
     var inputFile = createInputFile(baseDir, "notebook.ipynb", InputFile.Status.CHANGED, InputFile.Type.MAIN);
 
     var result = IpynbNotebookParser.parseNotebook(inputFile);
 
     assertThat(result.locationMap().keySet()).hasSize(20);
-    assertThat(StringUtils.countMatches(result.aggregatedSource(), IpynbNotebookParser.SONAR_PYTHON_NOTEBOOK_CELL_DELIMITER))
+    assertThat(StringUtils.countMatches(result.contents(), IpynbNotebookParser.SONAR_PYTHON_NOTEBOOK_CELL_DELIMITER))
       .isEqualTo(7);
     assertThat(result.locationMap()).extracting(map -> map.get(17)).isEqualTo(new IpynbNotebookParser.IPythonLocation(64, 27, Map.of(6, 21, 20, 37, -1, 3)));
 
-    // The wrapped file changes the lines of the notebook
-    assertThat(result.locationMap()).extracting(map -> map.get(22)).isEqualTo(new IpynbNotebookParser.IPythonLocation(84, 15, Map.of(6, 21, 15, 32, -1, 3)));
-    assertThat(result.locationMap()).extracting(map -> map.get(23)).isEqualTo(new IpynbNotebookParser.IPythonLocation(84, 37, Map.of(6, 21, 23, 40, -1, 3)));
+    assertThat(result.locationMap()).extracting(map -> map.get(22)).isEqualTo(new IpynbNotebookParser.IPythonLocation(83, 15, Map.of(6, 21, 15, 32, -1, 3)));
+    assertThat(result.locationMap()).extracting(map -> map.get(23)).isEqualTo(new IpynbNotebookParser.IPythonLocation(83, 37, Map.of(6, 21, 23, 40, -1, 3)));
 
     assertThat(result.locationMap()).extracting(map -> map.get(25))
-      .isEqualTo(new IpynbNotebookParser.IPythonLocation(91, 15, Map.of(4, 19, 39, 62, 41, 64, 42, 65, 46, 71, -1, 7)));
-    assertThat(result.locationMap()).extracting(map -> map.get(26)).isEqualTo(new IpynbNotebookParser.IPythonLocation(91, 71, Map.of(-1, 0)));
+      .isEqualTo(new IpynbNotebookParser.IPythonLocation(90, 15, Map.of(4, 19, 39, 62, 41, 64, 42, 65, 46, 71, -1, 7)));
+    assertThat(result.locationMap()).extracting(map -> map.get(26)).isEqualTo(new IpynbNotebookParser.IPythonLocation(90, 71, Map.of(-1, 0)));
   }
 
   @Test

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

@@ -72,8 +72,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "print(\"My\\ntext\")\n",
-    "print(\"Something else\\n\")"
+    "print(\"My\\ntext\")\n", "print(\"Something else\\n\")"
    ]
   },
   {