SONAR-17287 SonarQube stores issue flow types and descriptions

diff --git a/server/sonar-ce-task-projectanalysis/src/main/java/org/sonar/ce/task/projectanalysis/issue/TrackerRawInputFactory.java b/server/sonar-ce-task-projectanalysis/src/main/java/org/sonar/ce/task/projectanalysis/issue/TrackerRawInputFactory.java
index 45932a95e754265d237e0a8c14c7eb6681e81d84..c824e40efa1e3c8566d374b74d124ebfab509b53 100644 (file)
--- a/server/sonar-ce-task-projectanalysis/src/main/java/org/sonar/ce/task/projectanalysis/issue/TrackerRawInputFactory.java
+++ b/server/sonar-ce-task-projectanalysis/src/main/java/org/sonar/ce/task/projectanalysis/issue/TrackerRawInputFactory.java
@@ -184,15 +184,11 @@ public class TrackerRawInputFactory {
       }
       DbIssues.Locations.Builder dbLocationsBuilder = DbIssues.Locations.newBuilder();
       if (reportIssue.hasTextRange()) {
-        DbCommons.TextRange.Builder textRange = convertTextRange(reportIssue.getTextRange());
-        dbLocationsBuilder.setTextRange(textRange);
+        dbLocationsBuilder.setTextRange(convertTextRange(reportIssue.getTextRange()));
       }
       for (ScannerReport.Flow flow : reportIssue.getFlowList()) {
         if (flow.getLocationCount() > 0) {
-          DbIssues.Flow.Builder dbFlowBuilder = DbIssues.Flow.newBuilder();
-          for (ScannerReport.IssueLocation location : flow.getLocationList()) {
-            convertLocation(location).ifPresent(dbFlowBuilder::addLocation);
-          }
+          DbIssues.Flow.Builder dbFlowBuilder = convertLocations(flow);
           dbLocationsBuilder.addFlow(dbFlowBuilder);
         }
       }
@@ -203,6 +199,18 @@ public class TrackerRawInputFactory {
       return issue;
     }
 
+    private DbIssues.Flow.Builder convertLocations(ScannerReport.Flow flow) {
+      DbIssues.Flow.Builder dbFlowBuilder = DbIssues.Flow.newBuilder();
+      for (ScannerReport.IssueLocation location : flow.getLocationList()) {
+        convertLocation(location).ifPresent(dbFlowBuilder::addLocation);
+      }
+      if (isNotEmpty(flow.getDescription())) {
+        dbFlowBuilder.setDescription(flow.getDescription());
+      }
+      toFlowType(flow.getType()).ifPresent(dbFlowBuilder::setType);
+      return dbFlowBuilder;
+    }
+
     private DefaultIssue toExternalIssue(LineHashSequence lineHashSeq, ScannerReport.ExternalIssue reportExternalIssue, Map<RuleKey, ScannerReport.AdHocRule> adHocRuleMap) {
       DefaultIssue issue = new DefaultIssue();
       RuleType type = toRuleType(reportExternalIssue.getType());
@@ -230,10 +238,7 @@ public class TrackerRawInputFactory {
       }
       for (ScannerReport.Flow flow : reportExternalIssue.getFlowList()) {
         if (flow.getLocationCount() > 0) {
-          DbIssues.Flow.Builder dbFlowBuilder = DbIssues.Flow.newBuilder();
-          for (ScannerReport.IssueLocation location : flow.getLocationList()) {
-            convertLocation(location).ifPresent(dbFlowBuilder::addLocation);
-          }
+          DbIssues.Flow.Builder dbFlowBuilder = convertLocations(flow);
           dbLocationsBuilder.addFlow(dbFlowBuilder);
         }
       }
@@ -252,6 +257,17 @@ public class TrackerRawInputFactory {
       return new NewAdHocRule(reportIssue);
     }
 
+    private Optional<DbIssues.FlowType> toFlowType(ScannerReport.FlowType flowType) {
+      switch (flowType) {
+        case DATA:
+          return Optional.of(DbIssues.FlowType.DATA);
+        case EXECUTION:
+          return Optional.of(DbIssues.FlowType.EXECUTION);
+        default:
+          return Optional.empty();
+      }
+    }
+
     private RuleType toRuleType(IssueType type) {
       switch (type) {
         case BUG:

diff --git a/server/sonar-ce-task-projectanalysis/src/test/java/org/sonar/ce/task/projectanalysis/issue/TrackerRawInputFactoryTest.java b/server/sonar-ce-task-projectanalysis/src/test/java/org/sonar/ce/task/projectanalysis/issue/TrackerRawInputFactoryTest.java
index 3f0b1f4c289d052ad549d2f26e18f1e0ee04c496..3a598f67fbac1a7d5c57424a303615d083c17d66 100644 (file)
--- a/server/sonar-ce-task-projectanalysis/src/test/java/org/sonar/ce/task/projectanalysis/issue/TrackerRawInputFactoryTest.java
+++ b/server/sonar-ce-task-projectanalysis/src/test/java/org/sonar/ce/task/projectanalysis/issue/TrackerRawInputFactoryTest.java
@@ -25,11 +25,7 @@ import com.tngtech.java.junit.dataprovider.DataProviderRunner;
 import com.tngtech.java.junit.dataprovider.UseDataProvider;
 import java.util.Collection;
 import java.util.Collections;
-import java.util.Iterator;
-import java.util.List;
 import java.util.Optional;
-import java.util.stream.IntStream;
-import org.apache.commons.codec.digest.DigestUtils;
 import org.junit.Before;
 import org.junit.Rule;
 import org.junit.Test;
@@ -47,16 +43,14 @@ import org.sonar.ce.task.projectanalysis.issue.filter.IssueFilter;
 import org.sonar.ce.task.projectanalysis.qualityprofile.ActiveRule;
 import org.sonar.ce.task.projectanalysis.qualityprofile.ActiveRulesHolderRule;
 import org.sonar.ce.task.projectanalysis.source.SourceLinesHashRepository;
-import org.sonar.ce.task.projectanalysis.source.SourceLinesRepository;
 import org.sonar.core.issue.DefaultIssue;
 import org.sonar.core.issue.tracking.Input;
-import org.sonar.core.util.CloseableIterator;
 import org.sonar.db.protobuf.DbIssues;
 import org.sonar.scanner.protocol.Constants;
 import org.sonar.scanner.protocol.output.ScannerReport;
 import org.sonar.scanner.protocol.output.ScannerReport.IssueType;
-import org.sonar.scanner.protocol.output.ScannerReport.TextRange;
 import org.sonar.server.rule.CommonRuleKeys;
+import org.sonarqube.ws.Common;
 
 import static java.util.Arrays.asList;
 import static java.util.Collections.emptyMap;
@@ -100,9 +94,14 @@ public class TrackerRawInputFactoryTest {
   private final TrackerRawInputFactory underTest = new TrackerRawInputFactory(treeRootHolder, reportReader, sourceLinesHash,
     commonRuleEngine, issueFilter, ruleRepository, activeRulesHolder);
 
+  @Before
+  public void before() {
+    when(sourceLinesHash.getLineHashesMatchingDBVersion(FILE)).thenReturn(Collections.singletonList("line"));
+    when(issueFilter.accept(any(), eq(FILE))).thenReturn(true);
+  }
+
   @Test
   public void load_source_hash_sequences() {
-    when(sourceLinesHash.getLineHashesMatchingDBVersion(FILE)).thenReturn(Collections.singletonList("line"));
     Input<DefaultIssue> input = underTest.create(FILE);
 
     assertThat(input.getLineHashSequence()).isNotNull();
@@ -125,9 +124,7 @@ public class TrackerRawInputFactoryTest {
   public void load_issues_from_report() {
     RuleKey ruleKey = RuleKey.of("java", "S001");
     markRuleAsActive(ruleKey);
-    when(issueFilter.accept(any(), eq(FILE))).thenReturn(true);
 
-    when(sourceLinesHash.getLineHashesMatchingDBVersion(FILE)).thenReturn(Collections.singletonList("line"));
     ScannerReport.Issue reportIssue = ScannerReport.Issue.newBuilder()
       .setTextRange(newTextRange(2))
       .setMsg("the message")
@@ -160,13 +157,43 @@ public class TrackerRawInputFactoryTest {
     assertThat(issue.getRuleDescriptionContextKey()).isEmpty();
   }
 
+  @Test
+  public void load_issues_from_report_with_locations() {
+    RuleKey ruleKey = RuleKey.of("java", "S001");
+    markRuleAsActive(ruleKey);
+
+    ScannerReport.Issue reportIssue = ScannerReport.Issue.newBuilder()
+      .setMsg("the message")
+      .setRuleRepository(ruleKey.repository())
+      .setRuleKey(ruleKey.rule())
+      .addFlow(ScannerReport.Flow.newBuilder()
+        .setType(ScannerReport.FlowType.DATA)
+        .setDescription("flow1")
+        .addLocation(ScannerReport.IssueLocation.newBuilder().setMsg("loc1").setComponentRef(1).build())
+        .addLocation(ScannerReport.IssueLocation.newBuilder().setMsg("loc2").setComponentRef(1).build()))
+      .addFlow(ScannerReport.Flow.newBuilder()
+        .addLocation(ScannerReport.IssueLocation.newBuilder().setTextRange(newTextRange(2)).setComponentRef(1).build()))
+      .build();
+    reportReader.putIssues(FILE.getReportAttributes().getRef(), singletonList(reportIssue));
+    Input<DefaultIssue> input = underTest.create(FILE);
+
+    Collection<DefaultIssue> issues = input.getIssues();
+    DbIssues.Locations locations = Iterators.getOnlyElement(issues.iterator()).getLocations();
+    assertThat(locations.getFlowCount()).isEqualTo(2);
+    assertThat(locations.getFlow(0).getDescription()).isEqualTo("flow1");
+    assertThat(locations.getFlow(0).getType()).isEqualTo(DbIssues.FlowType.DATA);
+    assertThat(locations.getFlow(0).getLocationList()).hasSize(2);
+
+    assertThat(locations.getFlow(1).hasDescription()).isFalse();
+    assertThat(locations.getFlow(1).hasType()).isFalse();
+    assertThat(locations.getFlow(1).getLocationList()).hasSize(1);
+  }
+
   @Test
   public void load_issues_from_report_with_rule_description_context_key() {
     RuleKey ruleKey = RuleKey.of("java", "S001");
     markRuleAsActive(ruleKey);
-    when(issueFilter.accept(any(), eq(FILE))).thenReturn(true);
 
-    when(sourceLinesHash.getLineHashesMatchingDBVersion(FILE)).thenReturn(Collections.singletonList("line"));
     ScannerReport.Issue reportIssue = ScannerReport.Issue.newBuilder()
       .setTextRange(newTextRange(2))
       .setMsg("the message")
@@ -189,8 +216,6 @@ public class TrackerRawInputFactoryTest {
     RuleKey ruleKey = RuleKey.of("java", "S001");
     markRuleAsActive(ruleKey);
     registerRule(ruleKey, "Rule 1");
-    when(issueFilter.accept(any(), eq(FILE))).thenReturn(true);
-    when(sourceLinesHash.getLineHashesMatchingDBVersion(FILE)).thenReturn(Collections.singletonList("line"));
     ScannerReport.Issue reportIssue = ScannerReport.Issue.newBuilder()
       .setRuleRepository(ruleKey.repository())
       .setRuleKey(ruleKey.rule())
@@ -216,9 +241,7 @@ public class TrackerRawInputFactoryTest {
   public void load_issues_from_report_missing_secondary_location_component() {
     RuleKey ruleKey = RuleKey.of("java", "S001");
     markRuleAsActive(ruleKey);
-    when(issueFilter.accept(any(), eq(FILE))).thenReturn(true);
 
-    when(sourceLinesHash.getLineHashesMatchingDBVersion(FILE)).thenReturn(Collections.singletonList("line"));
     ScannerReport.Issue reportIssue = ScannerReport.Issue.newBuilder()
       .setTextRange(newTextRange(2))
       .setMsg("the message")
@@ -260,7 +283,6 @@ public class TrackerRawInputFactoryTest {
   @Test
   @UseDataProvider("ruleTypeAndStatusByIssueType")
   public void load_external_issues_from_report(IssueType issueType, RuleType expectedRuleType, String expectedStatus) {
-    when(sourceLinesHash.getLineHashesMatchingDBVersion(FILE)).thenReturn(Collections.singletonList("line"));
     ScannerReport.ExternalIssue reportIssue = ScannerReport.ExternalIssue.newBuilder()
       .setTextRange(newTextRange(2))
       .setMsg("the message")
@@ -304,7 +326,6 @@ public class TrackerRawInputFactoryTest {
   @Test
   @UseDataProvider("ruleTypeAndStatusByIssueType")
   public void load_external_issues_from_report_with_default_effort(IssueType issueType, RuleType expectedRuleType, String expectedStatus) {
-    when(sourceLinesHash.getLineHashesMatchingDBVersion(FILE)).thenReturn(Collections.singletonList("line"));
     ScannerReport.ExternalIssue reportIssue = ScannerReport.ExternalIssue.newBuilder()
       .setTextRange(newTextRange(2))
       .setMsg("the message")
@@ -337,9 +358,6 @@ public class TrackerRawInputFactoryTest {
   @Test
   public void excludes_issues_on_inactive_rules() {
     RuleKey ruleKey = RuleKey.of("java", "S001");
-    when(issueFilter.accept(any(), eq(FILE))).thenReturn(true);
-
-    when(sourceLinesHash.getLineHashesMatchingDBVersion(FILE)).thenReturn(Collections.singletonList("line"));
     ScannerReport.Issue reportIssue = ScannerReport.Issue.newBuilder()
       .setTextRange(newTextRange(2))
       .setMsg("the message")
@@ -360,7 +378,6 @@ public class TrackerRawInputFactoryTest {
     RuleKey ruleKey = RuleKey.of("java", "S001");
     markRuleAsActive(ruleKey);
     when(issueFilter.accept(any(), eq(FILE))).thenReturn(false);
-    when(sourceLinesHash.getLineHashesMatchingDBVersion(FILE)).thenReturn(Collections.singletonList("line"));
     ScannerReport.Issue reportIssue = ScannerReport.Issue.newBuilder()
       .setTextRange(newTextRange(2))
       .setMsg("the message")
@@ -380,7 +397,6 @@ public class TrackerRawInputFactoryTest {
   public void exclude_issues_on_common_rules() {
     RuleKey ruleKey = RuleKey.of(CommonRuleKeys.commonRepositoryForLang("java"), "S001");
     markRuleAsActive(ruleKey);
-    when(sourceLinesHash.getLineHashesMatchingDBVersion(FILE)).thenReturn(Collections.singletonList("line"));
     ScannerReport.Issue reportIssue = ScannerReport.Issue.newBuilder()
       .setMsg("the message")
       .setRuleRepository(ruleKey.repository())
@@ -398,8 +414,6 @@ public class TrackerRawInputFactoryTest {
   public void load_issues_of_compute_engine_common_rules() {
     RuleKey ruleKey = RuleKey.of(CommonRuleKeys.commonRepositoryForLang("java"), "InsufficientCoverage");
     markRuleAsActive(ruleKey);
-    when(issueFilter.accept(any(), eq(FILE))).thenReturn(true);
-    when(sourceLinesHash.getLineHashesMatchingDBVersion(FILE)).thenReturn(Collections.singletonList("line"));
     DefaultIssue ceIssue = new DefaultIssue()
       .setRuleKey(ruleKey)
       .setMessage("not enough coverage")
@@ -417,7 +431,6 @@ public class TrackerRawInputFactoryTest {
     RuleKey ruleKey = RuleKey.of(CommonRuleKeys.commonRepositoryForLang("java"), "InsufficientCoverage");
     markRuleAsActive(ruleKey);
     when(issueFilter.accept(any(), eq(FILE))).thenReturn(false);
-    when(sourceLinesHash.getLineHashesMatchingDBVersion(FILE)).thenReturn(Collections.singletonList("line"));
     DefaultIssue ceIssue = new DefaultIssue()
       .setRuleKey(ruleKey)
       .setMessage("not enough coverage")

diff --git a/server/sonar-db-dao/src/main/protobuf/db-issues.proto b/server/sonar-db-dao/src/main/protobuf/db-issues.proto
index 6b64ce30f5955a5091f951b178324a8fd46f874e..3138260372dd2d8425e36b722aee982ff3be7f88 100644 (file)
--- a/server/sonar-db-dao/src/main/protobuf/db-issues.proto
+++ b/server/sonar-db-dao/src/main/protobuf/db-issues.proto
@@ -38,6 +38,13 @@ message Locations {
 
 message Flow {
   repeated Location location = 1;
+  optional string description = 2;
+  optional FlowType type = 3;
+}
+
+enum FlowType {
+  DATA = 0;
+  EXECUTION = 1;
 }
 
 message Location {