SONARPY-2049 Remove extra line break when the last line of a source array ends with \n (#1901)

Author: ghislainpiot

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

@@ -135,13 +135,18 @@ private boolean parseSourceArray(JsonParser jParser, JsonToken jsonToken) throws
     }
     appendNewLineAfterPreviousCellDelimiter();
     JsonLocation tokenLocation = jParser.currentTokenLocation();
+    // In case of an empty cell, we don't add an extra line
+    var lastSourceLine = "\n";
     while (jParser.nextToken() != JsonToken.END_ARRAY) {
       String sourceLine = jParser.getValueAsString();
       tokenLocation = jParser.currentTokenLocation();
       var countEscapedChar = countEscapeCharacters(sourceLine, new LinkedHashMap<>(), tokenLocation.getColumnNr());
       addLineToSource(sourceLine, tokenLocation, countEscapedChar);
+      lastSourceLine = sourceLine;
+    }
+    if (!lastSourceLine.endsWith("\n")) {
+      aggregatedSource.append("\n");
     }
-    aggregatedSource.append("\n");
     // Account for the last cell delimiter
     addDelimiterToSource(tokenLocation);
     lastPythonLine = aggregatedSourceLine;

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

@@ -78,7 +78,7 @@ void testParseNotebookWithEmptyLines() throws IOException {
     var result = resultOptional.get();
 
     assertThat(result.locationMap().keySet()).hasSize(4);
-    assertThat(result.contents()).hasLineCount(5);
+    assertThat(result.contents()).hasLineCount(4);
     assertThat(StringUtils.countMatches(result.contents(), IpynbNotebookParser.SONAR_PYTHON_NOTEBOOK_CELL_DELIMITER))
       .isEqualTo(1);
     assertThat(result.locationMap()).extracting(map -> map.get(3)).isEqualTo(new IPythonLocation(11, 5, Map.of(-1, 0)));
@@ -114,4 +114,17 @@ void testParseNotebookWithNoLanguage() {
     assertThat(resultOptional).isPresent();
   }
 
+  @Test
+  void testParseNotebookWithExtraLineEndInArray() throws IOException {
+    var inputFile = createInputFile(baseDir, "notebook_extra_line.ipynb", InputFile.Status.CHANGED, InputFile.Type.MAIN);
+
+    var resultOptional = IpynbNotebookParser.parseNotebook(inputFile);
+
+    assertThat(resultOptional).isPresent();
+
+    var result = resultOptional.get();
+    assertThat(result.locationMap()).hasSize(3);
+    assertThat(result.contents()).hasLineCount(3);
+  }
+
 }

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

@@ -0,0 +1,45 @@
+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": 5,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Files already downloaded and verified\n",
+      "Files already downloaded and verified\n"
+     ]
+    }
+   ],
+   "source": [
+    "#correct += (predicted == y).sum().item()\n",
+    "#print(f'Epoch {epoch}: {correct / total}')\n"
+   ],
+   "id": "6cbd92ef6319ca9a"
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 2
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython2",
+   "version": "2.7.6"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}