SONARPY-896 NOSONAR annotation should silence issues on multiline strings (#1060)

Author: guillaume-dequenne

python-frontend/src/main/java/org/sonar/python/metrics/FileLinesVisitor.java

@@ -31,6 +31,7 @@
 import org.sonar.plugins.python.api.PythonVisitorContext;
 import org.sonar.plugins.python.api.SubscriptionContext;
 import org.sonar.plugins.python.api.tree.ClassDef;
+import org.sonar.plugins.python.api.tree.ExpressionStatement;
 import org.sonar.plugins.python.api.tree.FileInput;
 import org.sonar.plugins.python.api.tree.FunctionDef;
 import org.sonar.plugins.python.api.tree.StringLiteral;
@@ -130,16 +131,16 @@ private void visitToken(Token token) {
     }
 
     for (Trivia trivia : token.trivia()) {
-      visitComment(trivia);
+      visitComment(trivia, token);
     }
   }
 
-  private void visitComment(Trivia trivia) {
+  private void visitComment(Trivia trivia, Token parentToken) {
     String commentLine = getContents(trivia.token().value());
     int line = trivia.token().line();
     if (commentLine.contains("NOSONAR")) {
       linesOfComments.remove(line);
-      noSonar.add(line);
+      addNoSonarLines(trivia, parentToken);
     } else if (!isBlank(commentLine)) {
       linesOfComments.add(line);
     }
@@ -185,6 +186,23 @@ private static String getContents(String comment) {
     return comment.substring(comment.indexOf('#'));
   }
 
+  private void addNoSonarLines(Trivia trivia, Token parentToken) {
+    int line = trivia.token().line();
+    if (parentToken.parent().is(Tree.Kind.EXPRESSION_STMT)) {
+      ExpressionStatement expressionStatement = (ExpressionStatement) parentToken.parent();
+      if (!expressionStatement.expressions().isEmpty() && expressionStatement.expressions().get(0).is(Tree.Kind.STRING_LITERAL)) {
+        // Count every line of a string literal as part of the "NOSONAR" scope
+        StringLiteral stringLiteral = (StringLiteral) expressionStatement.expressions().get(0);
+        int firstLine = stringLiteral.firstToken().line();
+        for (int i = firstLine; i < line + 1; i++) {
+          noSonar.add(i);
+        }
+        return;
+      }
+    }
+    noSonar.add(line);
+  }
+
   public int getStatements() {
     return statements;
   }

python-frontend/src/test/java/org/sonar/python/FileLinesVisitorTest.java

@@ -35,12 +35,12 @@ public void test() {
 
     TestPythonVisitorRunner.scanFile(new File(BASE_DIR, "file_lines.py"), visitor);
 
-    assertThat(visitor.getLinesOfCode()).hasSize(12);
-    assertThat(visitor.getLinesOfCode()).containsOnly(6, 8, 11, 12, 13, 14, 15, 16, 18, 19, 21, 25);
+    assertThat(visitor.getLinesOfCode()).hasSize(24);
+    assertThat(visitor.getLinesOfCode()).containsOnly(6, 8, 11, 12, 13, 14, 15, 16, 18, 19, 21, 25, 28, 32, 34, 36, 37, 38, 39, 40, 41, 43, 44, 45);
 
-    assertThat(visitor.getCommentLineCount()).isEqualTo(13);
+    assertThat(visitor.getCommentLineCount()).isEqualTo(16);
 
-    assertThat(visitor.getLinesWithNoSonar()).containsOnly(15);
+    assertThat(visitor.getLinesWithNoSonar()).containsOnly(15, 29, 30, 31, 34, 37, 38, 39, 40, 41, 45);
   }
 
   @Test

python-frontend/src/test/resources/metrics/file_lines.py

@@ -23,3 +23,23 @@ def foo1(x,y,z,): # end of line comment
     3 lines of docstring
     """
     pass
+
+
+def foo2(x,y,z,):
+    """
+    3 lines of docstring
+    """ # NOSONAR
+    pass
+
+"some string literal" # NOSONAR
+
+def foo3():
+    """
+    some tuple
+    """, """
+    of multiline strings
+    """ # NOSONAR
+
+def foo4():
+    (multine,
+    expression) # NOSONAR