SONARPY-3180 Add support of trailing text for the noqa issue suppression (#392)

GitOrigin-RevId: 07209be932557838d2a3fa85d22542c60b70e71e

Author: maksim-grebeniuk-sonarsource

its/plugin/it-python-plugin-test/src/test/java/com/sonar/python/it/plugin/NoSonarTest.java

@@ -101,7 +101,7 @@ void test_noqa() {
     analyzeProject(createScanner(NOQA_PROJECT_KEY, "projects/nosonar/noqa-project"));
 
     IssueListAssert.assertThat(issues(NOQA_PROJECT_KEY))
-        .hasSize(20)
+        .hasSize(19)
         // basic noqa checks
         .containsIssue(1, "python:PrintStatementUsage")
         .containsIssue(2, "python:S1309").doesNotContainIssue(2, "python:PrintStatementUsage")

python-checks/src/test/resources/checks/nosonarCommentFormat.py

@@ -27,5 +27,5 @@
 # noqa: a,,c
 # Noncompliant@+1
 # noqa: a,c,
-# Noncompliant@+1
+
 # noqa: a, some text

python-commons/src/test/java/org/sonar/plugins/python/nosonar/NoSonarLineInfoCollectorTest.java

@@ -145,10 +145,10 @@ private static Stream<Arguments> provideCollectorParameters() {
         ""
       ),
       Arguments.of("# noqa: some text",
-        Map.of(1, new NoSonarLineInfo(Set.of("some text"))),
+        Map.of(1, new NoSonarLineInfo(Set.of("some"))),
         Set.of(),
-        "some text",
-        "some text:"
+        "some",
+        "some:"
       ),
       Arguments.of("# noqa: a,b",
         Map.of(1, new NoSonarLineInfo(Set.of("a", "b"))),

python-frontend/src/main/java/org/sonar/plugins/python/api/nosonar/NoSonarInfoParser.java

@@ -22,14 +22,15 @@
 import java.util.function.Predicate;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
+import java.util.stream.Collectors;
 import java.util.stream.Stream;
 import javax.annotation.CheckForNull;
 
 public class NoSonarInfoParser {
 
   private static final Integer MAX_COMMENT_LENGTH = 50;
   private static final String NOQA_PREFIX_REGEX = "#\\s*noqa([\\s:].*)?";
-  private static final String NOQA_PATTERN_REGEX = "^#\\s*noqa(?::\\s*(.+))?.*";
+  private static final String NOQA_PATTERN_REGEX = "^#\\s*noqa(?::\\s*(.+))?(?:[\\s;:].*)?";
   private static final String NOSONAR_PREFIX_REGEX = "^#\\s*NOSONAR(\\W.*)?";
   private static final String NOSONAR_PATTERN_REGEX = "^#\\s*NOSONAR(?:\\s*\\(([^)]*)\\))?($|\\s.*)";
 
@@ -65,7 +66,7 @@ private boolean isInvalidNoQaComment(String comment) {
     if (!isValidNoQa(comment)) {
       return true;
     }
-    var rules = parseNoQaRules(comment).toList();
+    var rules = parseNoQaRules(comment);
     return !rules.isEmpty() && rules.stream().anyMatch(r -> r.isBlank() || r.contains(" "));
   }
 
@@ -111,6 +112,7 @@ private NoSonarLineInfo parseComment(String commentLine) {
       comment = parseNoSonarComment(commentLine);
     } else if (isValidNoQa(commentLine)) {
       parseNoQaRules(commentLine)
+        .stream()
         .filter(Predicate.not(String::isEmpty))
         .forEach(rules::add);
       comment = parseNoQaComment(commentLine);
@@ -136,9 +138,20 @@ private String parseNoSonarComment(String noSonarCommentLine) {
     return getTruncatedCommentString(noSonarPattern, noSonarCommentLine).strip();
   }
 
-  private Stream<String> parseNoQaRules(String noSonarCommentLine) {
-    var contentInsideParentheses = getParamsString(noQaPattern, noSonarCommentLine);
-    return parseParamsString(contentInsideParentheses);
+  private List<String> parseNoQaRules(String noSonarCommentLine) {
+    var paramsString = getParamsString(noQaPattern, noSonarCommentLine);
+    var paramsList = parseParamsString(paramsString).collect(Collectors.toList());
+    if (!paramsList.isEmpty()) {
+      // to get the last suppressed rule ID we need to split it to cut the trailing comment text.
+      // valid cases are:
+      // split by space: ruleID1, ruleID2 some comment
+      // or colon with space: ruleID1, ruleID2: some comment
+      var lastParamIndex = paramsList.size() - 1;
+      var lastParamRaw = paramsList.get(lastParamIndex);
+      var lastParam = lastParamRaw.split("(:?\\s)", 0)[0].trim();
+      paramsList.set(lastParamIndex, lastParam);
+    }
+    return paramsList;
   }
 
   private String parseNoQaComment(String noSonarCommentLine) {
@@ -169,7 +182,8 @@ private static Stream<String> parseParamsString(String paramsString) {
       return Stream.of();
     }
 
-    return Stream.of(paramsString.split(",", -1))
+    var paramsArray = paramsString.split(",", -1);
+    return Stream.of(paramsArray)
       .map(String::trim);
   }
 }

python-frontend/src/test/java/org/sonar/plugins/python/api/nosonar/NoSonarInfoParserTest.java

@@ -31,6 +31,8 @@ void noNoSonarCommentTest() {
     var parser = new NoSonarInfoParser();
     var parsingResult = parser.parse("# comment string");
     Assertions.assertThat(parsingResult).isNotPresent();
+    parsingResult = parser.parse("# noqal");
+    Assertions.assertThat(parsingResult).isNotPresent();
   }
 
   @ParameterizedTest
@@ -95,7 +97,7 @@ private static Stream<Arguments> provideParserParameters() {
       ),
       Arguments.of(
         "# noqa: some text",
-        new NoSonarLineInfo(Set.of("some text"))
+        new NoSonarLineInfo(Set.of("some"))
       ),
       Arguments.of(
         "# noqa: a,b",
@@ -116,6 +118,18 @@ private static Stream<Arguments> provideParserParameters() {
       Arguments.of(
         "# noqa some text",
         new NoSonarLineInfo(Set.of())
+      ),
+      Arguments.of(
+        "# noqa: rule1, rule2 some explanation",
+        new NoSonarLineInfo(Set.of("rule1", "rule2"))
+      ),
+      Arguments.of(
+        "# noqa: rule1, rule2: some explanation",
+        new NoSonarLineInfo(Set.of("rule1", "rule2"))
+      ),
+      Arguments.of(
+        "# noqa; noqa; noqa; noqa; noqa",
+        new NoSonarLineInfo(Set.of())
       )
     );
   }
@@ -143,6 +157,9 @@ private static Stream<Arguments> provideValidationParameters() {
       Arguments.of("# noqa: one,two", false),
       Arguments.of("# noqa:one,two", false),
       Arguments.of("# noqa- one,two", false),
+      Arguments.of("# noqa: one,two some text", false),
+      Arguments.of("# noqa: one some text", false),
+      Arguments.of("# noqa:", false),
 
       Arguments.of("# something unrelated", false),
 
@@ -154,9 +171,7 @@ private static Stream<Arguments> provideValidationParameters() {
       Arguments.of("# NOSONAR(a (b))", true),
       Arguments.of("# noqa: one,", true),
       Arguments.of("# noqa: ,two", true),
-      Arguments.of("# noqa: , ", true),
-      Arguments.of("# noqa: one,two some text", true),
-      Arguments.of("# noqa: one some text", true)
+      Arguments.of("# noqa: , ", true)
     );
   }