SONARPY-2745: Take into account the end column of mypy reports (#343)

GitOrigin-RevId: 5bcc6490f7636703f51fad91e915af86d966791b

Author: joke1196

python-commons/src/main/java/org/sonar/plugins/python/ExternalIssuesSensor.java

@@ -16,7 +16,6 @@
  */
 package org.sonar.plugins.python;
 
-
 import java.io.File;
 import java.io.IOException;
 import java.util.HashSet;
@@ -104,7 +103,7 @@ protected void saveIssue(SensorContext context, TextReportReader.Issue issue, Se
       .message(issue.message)
       .on(inputFile);
     if (issue.columnNumber != null && issue.columnNumber < inputFile.selectLine(issue.lineNumber).end().lineOffset()) {
-      primaryLocation.at(inputFile.newRange(issue.lineNumber, issue.columnNumber, issue.lineNumber, issue.columnNumber + 1));
+      primaryLocation.at(inputFile.newRange(issue.lineNumber, issue.columnNumber, issue.endLineNumber.orElse(issue.lineNumber), issue.endColNumber.orElse(issue.columnNumber + 1)));
     } else {
       // Pylint formatted issues might not provide column information
       primaryLocation.at(inputFile.selectLine(issue.lineNumber));

python-commons/src/main/java/org/sonar/plugins/python/TextReportReader.java

@@ -20,6 +20,7 @@
 import java.io.IOException;
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Optional;
 import java.util.Scanner;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
@@ -81,7 +82,7 @@ private Issue extractDefaultStyleIssue(Matcher m) {
     columnNumber -= this.reportOffset;
     String ruleKey = m.group(4);
     String message = m.group(5);
-    return new Issue(filePath, ruleKey, message, lineNumber, columnNumber);
+    return new Issue(filePath, ruleKey, message, lineNumber, columnNumber, null, null);
   }
 
   private static Issue extractLegacyStyleIssue(Matcher m) {
@@ -93,7 +94,7 @@ private static Issue extractLegacyStyleIssue(Matcher m) {
       ruleKey = ruleKey.substring(0, keyLastIndex);
     }
     String message = m.group(4);
-    return new Issue(filePath, ruleKey, message, lineNumber, null);
+    return new Issue(filePath, ruleKey, message, lineNumber, null, null, null);
   }
 
   public static class Issue {
@@ -108,12 +109,20 @@ public static class Issue {
 
     public final Integer columnNumber;
 
-    public Issue(String filePath, String ruleKey, String message, Integer lineNumber, @Nullable Integer columnNumber) {
+    public final Optional<Integer> endLineNumber;
+
+    public final Optional<Integer> endColNumber;
+
+    public Issue(String filePath, String ruleKey, String message, Integer lineNumber, @Nullable Integer columnNumber, @Nullable Integer endLineNumber,
+      @Nullable Integer endColNumber) {
       this.filePath = filePath;
       this.ruleKey = ruleKey;
       this.message = message;
       this.lineNumber = lineNumber;
       this.columnNumber = columnNumber;
+      this.endLineNumber = Optional.ofNullable(endLineNumber);
+      this.endColNumber = Optional.ofNullable(endColNumber);
     }
+
   }
 }

python-commons/src/main/java/org/sonar/plugins/python/mypy/MypySensor.java

@@ -44,9 +44,13 @@ public class MypySensor extends ExternalIssuesSensor {
   private static final String FALLBACK_RULE_KEY = "unknown_mypy_rule";
 
   // Pattern -> Location ': ' Severity ':' Message '['Code']'
-  // Location -> File ':' StartLine
-  private static final Pattern PATTERN =
-    Pattern.compile("^(?<file>[^:]+):(?<startLine>\\d+)(?::(?<startCol>\\d+))?(?::\\d+:\\d+)?: (?<severity>\\S+[^:]): (?<message>.*?)(?: \\[(?<code>.*)])?\\s*$");
+  // Location -> File ':' StartLine (':' StartCol (':' EndLine ':' EndCol))
+
+  private static final String START_LOCATION = "(?<startLine>\\d+)(?::(?<startCol>\\d+))?";
+  private static final String END_LOCATION = "(?::(?<endLine>\\d+):(?<endCol>\\d+))?";
+
+  private static final Pattern PATTERN = Pattern
+    .compile(String.format("^(?<file>[^:]+):%s%s: (?<severity>\\S+[^:]): (?<message>.*?)(?: \\[(?<code>.*)])?\\s*$", START_LOCATION, END_LOCATION));
 
   @Override
   protected void importReport(File reportPath, SensorContext context, Set<String> unresolvedInputFiles) throws IOException {
@@ -99,7 +103,21 @@ private static TextReportReader.Issue extractIssue(Matcher m) {
       .map(i -> i - 1)
       .orElse(null);
 
-    return new TextReportReader.Issue(filePath, errorCode, message, lineNumber, columnNumber);
+    Integer endLineNumber = Optional.ofNullable(m.group("endLine"))
+      .map(Integer::parseInt)
+      .orElse(null);
+
+
+    //  Start and end column should be different as this is a requirement from our issue location. 
+    //  If they are the same ExternalIssuesSensor will use start column + 1 
+    Integer endColNumber = Optional.ofNullable(m.group("endCol"))
+      .map(Integer::parseInt)
+      .map(i -> i - 1)
+      .filter(i -> !i.equals(columnNumber))
+      .orElse(null);
+
+
+    return new TextReportReader.Issue(filePath, errorCode, message, lineNumber, columnNumber, endLineNumber, endColNumber);
   }
 
   @Override

python-commons/src/test/java/org/sonar/plugins/python/mypy/MypySensorTest.java

@@ -135,19 +135,19 @@ void issues_with_sonarqube_79_error_end() throws IOException {
     assertIssue(externalIssues.get(0),
       "arg-type",
       "Argument 1 to \"greet_all\" has incompatible type \"List[int]\"; expected \"List[str]\"",
-      11, 10, 11, 11);
+      11, 10, 11, 13);
     assertIssue(externalIssues.get(1),
       "no-untyped-def",
       "Function is missing a type annotation",
-      13, 0, 13, 1);
+      13, 0, 14, 13);
     assertIssue(externalIssues.get(2),
       "import",
       "Cannot find implementation or library stub for module named \"unknown\"",
       16, 0, 16, 1);
     assertIssue(externalIssues.get(3),
       "no-untyped-call",
       "Call to untyped function \"no_type_hints\" in typed context",
-      19, 10, 19, 11);
+      19, 10, 19, 25);
     assertIssue(externalIssues.get(4),
       "unknown_mypy_rule",
       "Unused \"type: ignore\" comment",