From 29c541dc4886e8f5b1023401caf4144847b20a7b Mon Sep 17 00:00:00 2001
From: Duarte Meneses <duarte.meneses@sonarsource.com>
Date: Tue, 10 Apr 2018 15:41:07 +0200
Subject: [PATCH] SONAR-10543 Fix mandatory fields

---
 .../rule/OneExternalIssuePerLineSensor.java   |  5 +++-
 .../issue/TrackerRawInputFactory.java         |  2 +-
 .../api/batch/sensor/issue/ExternalIssue.java |  5 ++++
 .../batch/sensor/issue/NewExternalIssue.java  |  5 ++++
 .../issue/internal/DefaultExternalIssue.java  | 18 +++++++++++---
 .../internal/SensorContextTesterTest.java     |  2 ++
 .../internal/DefaultExternalIssueTest.java    | 24 +++++++++++++++++++
 .../org/sonar/scanner/issue/ModuleIssues.java |  1 +
 .../sonar/scanner/issue/ModuleIssuesTest.java |  3 ++-
 .../src/main/protobuf/scanner_report.proto    |  1 -
 10 files changed, 59 insertions(+), 7 deletions(-)

diff --git a/plugins/sonar-xoo-plugin/src/main/java/org/sonar/xoo/rule/OneExternalIssuePerLineSensor.java b/plugins/sonar-xoo-plugin/src/main/java/org/sonar/xoo/rule/OneExternalIssuePerLineSensor.java
index 4dbf744243b..e47ddd4ef60 100644
--- a/plugins/sonar-xoo-plugin/src/main/java/org/sonar/xoo/rule/OneExternalIssuePerLineSensor.java
+++ b/plugins/sonar-xoo-plugin/src/main/java/org/sonar/xoo/rule/OneExternalIssuePerLineSensor.java
@@ -40,11 +40,12 @@ public class OneExternalIssuePerLineSensor implements Sensor {
   public static final Long EFFORT = 10l;
   public static final RuleType type = RuleType.BUG;
   public static final String ACTIVATE_EXTERNAL_ISSUES = "sonar.oneExternalIssuePerLine.activate";
+  private static final String NAME = "One External Issue Per Line";
 
   @Override
   public void describe(SensorDescriptor descriptor) {
     descriptor
-      .name("One External Issue Per Line")
+      .name(NAME)
       .onlyOnLanguages(Xoo.KEY, Xoo2.KEY)
       .onlyWhenConfiguration(c -> c.getBoolean(ACTIVATE_EXTERNAL_ISSUES).orElse(false));
   }
@@ -73,6 +74,8 @@ public class OneExternalIssuePerLineSensor implements Sensor {
           .on(file)
           .at(file.selectLine(line))
           .message("This issue is generated on each line"))
+        .ruleTitle(NAME)
+        .descriptionUrl("http://oneexternalissueperline.xoo.net")
         .severity(Severity.valueOf(SEVERITY))
         .remediationEffort(EFFORT)
         .type(type)
diff --git a/server/sonar-server/src/main/java/org/sonar/server/computation/task/projectanalysis/issue/TrackerRawInputFactory.java b/server/sonar-server/src/main/java/org/sonar/server/computation/task/projectanalysis/issue/TrackerRawInputFactory.java
index 0bc49a026d6..0154e69b055 100644
--- a/server/sonar-server/src/main/java/org/sonar/server/computation/task/projectanalysis/issue/TrackerRawInputFactory.java
+++ b/server/sonar-server/src/main/java/org/sonar/server/computation/task/projectanalysis/issue/TrackerRawInputFactory.java
@@ -219,7 +219,7 @@ public class TrackerRawInputFactory {
         .setType(toRuleType(reportIssue.getType()))
         .setKey(RuleKey.of(RuleKey.EXTERNAL_RULE_REPO_PREFIX + reportIssue.getRuleRepository(), reportIssue.getRuleKey()))
         .setPluginKey(reportIssue.getRuleRepository())
-        .setName(reportIssue.getRuleName());
+        .setName(reportIssue.getRuleTitle());
 
       if (reportIssue.getSeverity() != Severity.UNSET_SEVERITY) {
         builder.setSeverity(reportIssue.getSeverity().name());
diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/batch/sensor/issue/ExternalIssue.java b/sonar-plugin-api/src/main/java/org/sonar/api/batch/sensor/issue/ExternalIssue.java
index cdc7d6df2f2..ec72c49de1a 100644
--- a/sonar-plugin-api/src/main/java/org/sonar/api/batch/sensor/issue/ExternalIssue.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/batch/sensor/issue/ExternalIssue.java
@@ -48,4 +48,9 @@ public interface ExternalIssue extends IIssue {
    * Type of the issue.
    */
   RuleType type();
+  
+  /**
+   * Short description of the rule. Should not depend on the issue being raised.
+   */
+  String ruleTitle();
 }
diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/batch/sensor/issue/NewExternalIssue.java b/sonar-plugin-api/src/main/java/org/sonar/api/batch/sensor/issue/NewExternalIssue.java
index 2a3f41b4f60..8049c44e1dc 100644
--- a/sonar-plugin-api/src/main/java/org/sonar/api/batch/sensor/issue/NewExternalIssue.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/batch/sensor/issue/NewExternalIssue.java
@@ -79,6 +79,11 @@ public interface NewExternalIssue {
    */
   NewIssueLocation newLocation();
 
+  /**
+   * Add the description of the rule. Should not depend on the issue being raised.
+   */
+  NewExternalIssue ruleTitle(String title);
+  
   /**
    * Save the issue. If rule key is unknown or rule not enabled in the current quality profile then a warning is logged but no exception
    * is thrown.
diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/batch/sensor/issue/internal/DefaultExternalIssue.java b/sonar-plugin-api/src/main/java/org/sonar/api/batch/sensor/issue/internal/DefaultExternalIssue.java
index de3eed8b4e4..6bbf40078e7 100644
--- a/sonar-plugin-api/src/main/java/org/sonar/api/batch/sensor/issue/internal/DefaultExternalIssue.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/batch/sensor/issue/internal/DefaultExternalIssue.java
@@ -36,6 +36,7 @@ public class DefaultExternalIssue extends AbstractDefaultIssue<DefaultExternalIs
   private Severity severity;
   private String url;
   private RuleType type;
+  private String ruleTitle;
 
   public DefaultExternalIssue() {
     super(null);
@@ -70,12 +71,12 @@ public class DefaultExternalIssue extends AbstractDefaultIssue<DefaultExternalIs
 
   @Override
   public void doSave() {
-    requireNonNull(this.ruleKey, "ruleKey is mandatory on external issue");
+    requireNonNull(this.ruleKey, "Rule key is mandatory on external issue");
     checkState(primaryLocation != null, "Primary location is mandatory on every external issue");
     checkState(primaryLocation.inputComponent().isFile(), "External issues must be located in files");
-    checkState(type != null, "Type is mandatory on every external issue");
-    checkState(severity != null, "Severity is mandatory on every external issue");
+    checkState(ruleTitle != null, "Rule title is mandatory on every external issue");
     checkState(severity != null, "Severity is mandatory on every external issue");
+    checkState(type != null, "Type is mandatory on every external issue");
     storage.store(this);
   }
 
@@ -100,4 +101,15 @@ public class DefaultExternalIssue extends AbstractDefaultIssue<DefaultExternalIs
     this.type = type;
     return this;
   }
+
+  @Override
+  public String ruleTitle() {
+    return ruleTitle;
+  }
+
+  @Override
+  public DefaultExternalIssue ruleTitle(String ruleTitle) {
+    this.ruleTitle = ruleTitle;
+    return this;
+  }
 }
diff --git a/sonar-plugin-api/src/test/java/org/sonar/api/batch/sensor/internal/SensorContextTesterTest.java b/sonar-plugin-api/src/test/java/org/sonar/api/batch/sensor/internal/SensorContextTesterTest.java
index 0cee9bc2a96..b47ef208fed 100644
--- a/sonar-plugin-api/src/test/java/org/sonar/api/batch/sensor/internal/SensorContextTesterTest.java
+++ b/sonar-plugin-api/src/test/java/org/sonar/api/batch/sensor/internal/SensorContextTesterTest.java
@@ -117,6 +117,7 @@ public class SensorContextTesterTest {
       .forRule(RuleKey.of("repo", "rule"))
       .type(RuleType.BUG)
       .severity(Severity.BLOCKER)
+      .ruleTitle("title")
       .save();
     newExternalIssue = tester.newExternalIssue();
     newExternalIssue
@@ -124,6 +125,7 @@ public class SensorContextTesterTest {
       .type(RuleType.BUG)
       .severity(Severity.BLOCKER)
       .forRule(RuleKey.of("repo", "rule"))
+      .ruleTitle("title")
       .save();
     assertThat(tester.allExternalIssues()).hasSize(2);
   }
diff --git a/sonar-plugin-api/src/test/java/org/sonar/api/batch/sensor/issue/internal/DefaultExternalIssueTest.java b/sonar-plugin-api/src/test/java/org/sonar/api/batch/sensor/issue/internal/DefaultExternalIssueTest.java
index d219cefc8ed..57998dc4ba8 100644
--- a/sonar-plugin-api/src/test/java/org/sonar/api/batch/sensor/issue/internal/DefaultExternalIssueTest.java
+++ b/sonar-plugin-api/src/test/java/org/sonar/api/batch/sensor/issue/internal/DefaultExternalIssueTest.java
@@ -54,6 +54,7 @@ public class DefaultExternalIssueTest {
       .remediationEffort(10l)
       .descriptionUrl("url")
       .type(RuleType.BUG)
+      .ruleTitle("rule")
       .severity(Severity.BLOCKER);
 
     assertThat(issue.primaryLocation().inputComponent()).isEqualTo(inputFile);
@@ -63,6 +64,7 @@ public class DefaultExternalIssueTest {
     assertThat(issue.descriptionUrl()).isEqualTo("url");
     assertThat(issue.type()).isEqualTo(RuleType.BUG);
     assertThat(issue.severity()).isEqualTo(Severity.BLOCKER);
+    assertThat(issue.ruleTitle()).isEqualTo("rule");
     assertThat(issue.primaryLocation().message()).isEqualTo("Wrong way!");
 
     issue.save();
@@ -81,6 +83,7 @@ public class DefaultExternalIssueTest {
       .forRule(RuleKey.of("repo", "rule"))
       .remediationEffort(10l)
       .descriptionUrl("url")
+      .ruleTitle("rule")
       .severity(Severity.BLOCKER);
 
     exception.expect(IllegalStateException.class);
@@ -98,6 +101,7 @@ public class DefaultExternalIssueTest {
       .forRule(RuleKey.of("repo", "rule"))
       .remediationEffort(10l)
       .descriptionUrl("url")
+      .ruleTitle("rule")
       .severity(Severity.BLOCKER);
 
     exception.expect(IllegalStateException.class);
@@ -116,6 +120,7 @@ public class DefaultExternalIssueTest {
       .forRule(RuleKey.of("repo", "rule"))
       .remediationEffort(10l)
       .descriptionUrl("url")
+      .ruleTitle("rule")
       .type(RuleType.BUG);
 
     exception.expect(IllegalStateException.class);
@@ -123,4 +128,23 @@ public class DefaultExternalIssueTest {
     issue.save();
   }
 
+  @Test
+  public void fail_to_store_if_no_rule_title() {
+    SensorStorage storage = mock(SensorStorage.class);
+    DefaultExternalIssue issue = new DefaultExternalIssue(storage)
+      .at(new DefaultIssueLocation()
+        .on(inputFile)
+        .at(inputFile.selectLine(1))
+        .message("Wrong way!"))
+      .forRule(RuleKey.of("repo", "rule"))
+      .remediationEffort(10l)
+      .descriptionUrl("url")
+      .severity(Severity.BLOCKER)
+      .type(RuleType.BUG);
+
+    exception.expect(IllegalStateException.class);
+    exception.expectMessage("Rule title is mandatory");
+    issue.save();
+  }
+
 }
diff --git a/sonar-scanner-engine/src/main/java/org/sonar/scanner/issue/ModuleIssues.java b/sonar-scanner-engine/src/main/java/org/sonar/scanner/issue/ModuleIssues.java
index 40167c3c769..a6bdaad62f2 100644
--- a/sonar-scanner-engine/src/main/java/org/sonar/scanner/issue/ModuleIssues.java
+++ b/sonar-scanner-engine/src/main/java/org/sonar/scanner/issue/ModuleIssues.java
@@ -121,6 +121,7 @@ public class ModuleIssues {
     builder.setSeverity(severity);
     builder.setRuleRepository(issue.ruleKey().repository());
     builder.setRuleKey(issue.ruleKey().rule());
+    builder.setRuleTitle(issue.ruleTitle());
     builder.setMsg(primaryMessage);
     locationBuilder.setMsg(primaryMessage);
 
diff --git a/sonar-scanner-engine/src/test/java/org/sonar/scanner/issue/ModuleIssuesTest.java b/sonar-scanner-engine/src/test/java/org/sonar/scanner/issue/ModuleIssuesTest.java
index 6309720339d..844f6edcfab 100644
--- a/sonar-scanner-engine/src/test/java/org/sonar/scanner/issue/ModuleIssuesTest.java
+++ b/sonar-scanner-engine/src/test/java/org/sonar/scanner/issue/ModuleIssuesTest.java
@@ -155,7 +155,8 @@ public class ModuleIssuesTest {
     DefaultExternalIssue issue = new DefaultExternalIssue()
       .at(new DefaultIssueLocation().on(file).at(file.selectLine(3)).message("Foo"))
       .forRule(SQUID_RULE_KEY)
-      .severity(org.sonar.api.batch.rule.Severity.CRITICAL);
+      .severity(org.sonar.api.batch.rule.Severity.CRITICAL)
+      .ruleTitle("title");
 
     moduleIssues.initAndAddExternalIssue(issue);
 
diff --git a/sonar-scanner-protocol/src/main/protobuf/scanner_report.proto b/sonar-scanner-protocol/src/main/protobuf/scanner_report.proto
index 9bdb00bd4cf..13cf6dd56cc 100644
--- a/sonar-scanner-protocol/src/main/protobuf/scanner_report.proto
+++ b/sonar-scanner-protocol/src/main/protobuf/scanner_report.proto
@@ -201,7 +201,6 @@ message ExternalIssue {
   string descriptionUrl = 8;
   IssueType type = 9;
   string rule_title = 10;
-  string rule_name = 11;
 }
 
 enum IssueType {
-- 
2.39.5