Review API

Author: ericg138

plugin-api/src/main/java/org/sonar/api/batch/sensor/SensorContext.java

@@ -21,6 +21,7 @@
 
 import java.io.InputStream;
 import java.io.Serializable;
+import java.util.Collection;
 import org.sonar.api.Beta;
 import org.sonar.api.SonarRuntime;
 import org.sonar.api.batch.fs.FileSystem;
@@ -45,6 +46,7 @@
 import org.sonar.api.batch.sensor.symbol.NewSymbolTable;
 import org.sonar.api.config.Configuration;
 import org.sonar.api.config.Settings;
+import org.sonar.api.issue.SonarResolveData;
 import org.sonar.api.scanner.fs.InputProject;
 import org.sonar.api.scanner.sensor.ProjectSensor;
 import org.sonar.api.utils.Version;
@@ -305,4 +307,12 @@ public interface SensorContext {
    */
   @Beta
   boolean isFeatureAvailable(String featureName);
+
+  /**
+   * Register sonar-resolve annotations for a file.
+   * @param inputFile the file containing the annotations
+   * @param data the annotation data parsed from the file
+   * @since 13.5
+   */
+  void addSonarResolveData(InputFile inputFile, Collection<SonarResolveData> data);
 }

plugin-api/src/main/java/org/sonar/api/issue/SonarResolveData.java

@@ -25,6 +25,7 @@
 
 /**
  * Holds per-line annotation data parsed from {@code sonar-resolve}.
+ *
  * @since 13.5
  */
 public final class SonarResolveData {
@@ -35,20 +36,30 @@ public enum Status {
   }
 
   private final Set<RuleKey> ruleKeys;
+  private final Set<Integer> lines;
   private final String comment;
   private final Status status;
 
   /**
+   * @param lines    line numbers where matching issues should be resolved
    * @param ruleKeys the set of rule keys targeted by the annotation
    * @param comment  the justification comment
    * @param status   the target status, or {@code null} to default to {@link Status#ACCEPT}
    */
-  public SonarResolveData(Set<RuleKey> ruleKeys, String comment, @Nullable Status status) {
+  public SonarResolveData(Set<Integer> lines, Set<RuleKey> ruleKeys, String comment, @Nullable Status status) {
+    this.lines = lines;
     this.ruleKeys = ruleKeys;
     this.comment = comment;
     this.status = status != null ? status : Status.ACCEPT;
   }
 
+  /**
+   * @return line numbers where matching issues should be resolved
+   */
+  public Set<Integer> lines() {
+    return lines;
+  }
+
   /**
    * @return the set of rule keys targeted by the annotation
    */
@@ -69,4 +80,14 @@ public String comment() {
   public Status status() {
     return status;
   }
+
+  @Override
+  public String toString() {
+    return "SonarResolveData{" +
+      "ruleKeys=" + ruleKeys +
+      ", lines=" + lines +
+      ", comment='" + comment + '\'' +
+      ", status=" + status +
+      '}';
+  }
 }

plugin-api/src/main/java/org/sonar/api/issue/SonarResolveFilter.java

@@ -30,31 +30,33 @@ public class SonarResolveDataTest {
   @Test
   public void constructor_shouldStoreFields() {
     Set<RuleKey> ruleKeys = Set.of(RuleKey.of("java", "S123"));
-    SonarResolveData data = new SonarResolveData(ruleKeys, "reason", SonarResolveData.Status.FALSE_POSITIVE);
+    Set<Integer> lines = Set.of(10, 20);
+    SonarResolveData data = new SonarResolveData(lines, ruleKeys, "reason", SonarResolveData.Status.FALSE_POSITIVE);
 
     assertThat(data.ruleKeys()).isEqualTo(ruleKeys);
+    assertThat(data.lines()).containsExactlyInAnyOrder(10, 20);
     assertThat(data.comment()).isEqualTo("reason");
     assertThat(data.status()).isEqualTo(SonarResolveData.Status.FALSE_POSITIVE);
   }
 
   @Test
   public void constructor_whenStatusIsNull_shouldDefaultToAccept() {
-    SonarResolveData data = new SonarResolveData(Set.of(RuleKey.of("java", "S123")), "reason", null);
+    SonarResolveData data = new SonarResolveData(Set.of(1), Set.of(RuleKey.of("java", "S123")), "reason", null);
 
     assertThat(data.status()).isEqualTo(SonarResolveData.Status.ACCEPT);
   }
 
   @Test
   public void constructor_whenStatusIsAccept_shouldKeepAccept() {
-    SonarResolveData data = new SonarResolveData(Set.of(RuleKey.of("java", "S123")), "reason", SonarResolveData.Status.ACCEPT);
+    SonarResolveData data = new SonarResolveData(Set.of(1), Set.of(RuleKey.of("java", "S123")), "reason", SonarResolveData.Status.ACCEPT);
 
     assertThat(data.status()).isEqualTo(SonarResolveData.Status.ACCEPT);
   }
 
   @Test
   public void constructor_shouldSupportMultipleRuleKeys() {
     Set<RuleKey> ruleKeys = Set.of(RuleKey.of("java", "S123"), RuleKey.of("java", "S456"));
-    SonarResolveData data = new SonarResolveData(ruleKeys, "comment", null);
+    SonarResolveData data = new SonarResolveData(Set.of(5), ruleKeys, "comment", null);
 
     assertThat(data.ruleKeys()).containsExactlyInAnyOrder(
       RuleKey.of("java", "S123"),