SLCORE-275 Replace nulls in issue messages

Author: henryju

core/src/main/java/org/sonarsource/sonarlint/core/analyzer/sensor/DefaultSonarLintIssueLocation.java

@@ -26,6 +26,9 @@
 import org.sonar.api.batch.sensor.issue.NewIssueLocation;
 
 import static java.util.Objects.requireNonNull;
+import static org.apache.commons.lang.StringUtils.abbreviate;
+import static org.apache.commons.lang.StringUtils.replace;
+import static org.apache.commons.lang.StringUtils.trimToEmpty;
 
 public class DefaultSonarLintIssueLocation implements NewIssueLocation, IssueLocation {
 
@@ -50,10 +53,14 @@ public DefaultSonarLintIssueLocation at(TextRange location) {
 
   @Override
   public DefaultSonarLintIssueLocation message(String message) {
-    this.message = message;
+    this.message = abbreviate(trimToEmpty(sanitizeNulls(message)), MESSAGE_MAX_SIZE);
     return this;
   }
 
+  private static String sanitizeNulls(String message) {
+    return replace(message, "\u0000", "[NULL]");
+  }
+
   @Override
   public InputComponent inputComponent() {
     return this.component;

core/src/test/java/org/sonarsource/sonarlint/core/analyzer/sensor/DefaultSonarLintIssueTest.java

@@ -33,6 +33,7 @@
 import org.sonarsource.sonarlint.core.container.analysis.filesystem.SonarLintInputDir;
 import org.sonarsource.sonarlint.core.container.analysis.filesystem.SonarLintInputProject;
 
+import static org.apache.commons.lang.StringUtils.repeat;
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
 import static org.mockito.Mockito.mock;
@@ -81,6 +82,40 @@ public void build_file_issue() {
     verify(storage).store(issue);
   }
 
+  @Test
+  public void replace_null_characters() {
+    SensorStorage storage = mock(SensorStorage.class);
+    DefaultSonarLintIssue issue = new DefaultSonarLintIssue(project, baseDir, storage)
+      .at(new DefaultSonarLintIssueLocation()
+        .on(inputFile)
+        .message("Wrong \u0000 use of NULL\u0000"))
+      .forRule(RuleKey.of("repo", "rule"));
+
+    assertThat(issue.primaryLocation().message()).isEqualTo("Wrong [NULL] use of NULL[NULL]");
+
+    issue.save();
+
+    verify(storage).store(issue);
+  }
+
+  @Test
+  public void truncate_and_trim() {
+    SensorStorage storage = mock(SensorStorage.class);
+    String prefix = "prefix: ";
+    DefaultSonarLintIssue issue = new DefaultSonarLintIssue(project, baseDir, storage)
+      .at(new DefaultSonarLintIssueLocation()
+        .on(inputFile)
+        .message("   " + prefix + repeat("a", 4000)))
+      .forRule(RuleKey.of("repo", "rule"));
+
+    String ellipse = "...";
+    assertThat(issue.primaryLocation().message()).isEqualTo(prefix + repeat("a", 4000 - prefix.length() - ellipse.length()) + ellipse);
+
+    issue.save();
+
+    verify(storage).store(issue);
+  }
+
   @Test
   public void move_directory_issue_to_project_root() {
     SensorStorage storage = mock(SensorStorage.class);