SONAR-6012 Define protocol for local issue tracking

3 files changed, 356 insertions, 0 deletions

diff --git a/sonar-batch-protocol/src/main/java/org/sonar/batch/protocol/input/issues/PreviousIssue.java b/sonar-batch-protocol/src/main/java/org/sonar/batch/protocol/input/issues/PreviousIssue.java
new file mode 100644
index 00000000000..2711b8f1cae
--- /dev/null
+++ b/sonar-batch-protocol/src/main/java/org/sonar/batch/protocol/input/issues/PreviousIssue.java
@@ -0,0 +1,143 @@
+/*
+ * SonarQube, open source software quality management tool.
+ * Copyright (C) 2008-2014 SonarSource
+ * mailto:contact AT sonarsource DOT com
+ *
+ * SonarQube is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * SonarQube is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+package org.sonar.batch.protocol.input.issues;
+
+import javax.annotation.Nullable;
+
+public class PreviousIssue {
+
+  private String key;
+  private String componentPath;
+  private String ruleKey;
+  private String ruleRepo;
+  private Integer line;
+  private String message;
+  private String severity;
+  private String resolution;
+  private String status;
+  private String checksum;
+  private String assigneeLogin;
+  private String assigneeFullname;
+
+  public PreviousIssue setKey(String key) {
+    this.key = key;
+    return this;
+  }
+
+  public String key() {
+    return key;
+  }
+
+  public PreviousIssue setComponentPath(@Nullable String path) {
+    this.componentPath = path;
+    return this;
+  }
+
+  public String componentPath() {
+    return componentPath;
+  }
+
+  public PreviousIssue setLine(Integer line) {
+    this.line = line;
+    return this;
+  }
+
+  public Integer line() {
+    return line;
+  }
+
+  public PreviousIssue setMessage(String message) {
+    this.message = message;
+    return this;
+  }
+
+  public String message() {
+    return message;
+  }
+
+  public PreviousIssue setResolution(String resolution) {
+    this.resolution = resolution;
+    return this;
+  }
+
+  public String resolution() {
+    return resolution;
+  }
+
+  public PreviousIssue setStatus(String status) {
+    this.status = status;
+    return this;
+  }
+
+  public String status() {
+    return status;
+  }
+
+  public PreviousIssue setSeverity(String severity) {
+    this.severity = severity;
+    return this;
+  }
+
+  public String severity() {
+    return severity;
+  }
+
+  public PreviousIssue setChecksum(String checksum) {
+    this.checksum = checksum;
+    return this;
+  }
+
+  public String checksum() {
+    return checksum;
+  }
+
+  public PreviousIssue setAssigneeLogin(String assigneeLogin) {
+    this.assigneeLogin = assigneeLogin;
+    return this;
+  }
+
+  public String assigneeLogin() {
+    return assigneeLogin;
+  }
+
+  public PreviousIssue setAssigneeFullname(String assigneeFullname) {
+    this.assigneeFullname = assigneeFullname;
+    return this;
+  }
+
+  public String assigneeFullname() {
+    return assigneeFullname;
+  }
+
+  public PreviousIssue setRuleKey(String ruleRepo, String ruleKey) {
+    this.ruleRepo = ruleRepo;
+    this.ruleKey = ruleKey;
+    return this;
+  }
+
+  public String ruleRepo() {
+    return ruleRepo;
+  }
+
+  public String ruleKey() {
+    return ruleKey;
+  }
+
+}
diff --git a/sonar-batch-protocol/src/main/java/org/sonar/batch/protocol/input/issues/PreviousIssueHelper.java b/sonar-batch-protocol/src/main/java/org/sonar/batch/protocol/input/issues/PreviousIssueHelper.java
new file mode 100644
index 00000000000..d8b211eacde
--- /dev/null
+++ b/sonar-batch-protocol/src/main/java/org/sonar/batch/protocol/input/issues/PreviousIssueHelper.java
@@ -0,0 +1,113 @@
+/*
+ * SonarQube, open source software quality management tool.
+ * Copyright (C) 2008-2014 SonarSource
+ * mailto:contact AT sonarsource DOT com
+ *
+ * SonarQube is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * SonarQube is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+package org.sonar.batch.protocol.input.issues;
+
+import com.google.gson.Gson;
+import com.google.gson.stream.JsonReader;
+import com.google.gson.stream.JsonWriter;
+import org.sonar.batch.protocol.GsonHelper;
+
+import javax.annotation.Nullable;
+
+import java.io.IOException;
+import java.io.Reader;
+import java.io.Writer;
+import java.util.Iterator;
+
+public class PreviousIssueHelper {
+
+  private final Gson gson = GsonHelper.create();
+
+  private PreviousIssueHelper() {
+  }
+
+  public static PreviousIssueHelper create() {
+    return new PreviousIssueHelper();
+  }
+
+  public static interface Function<F, T> {
+    T apply(@Nullable F from);
+  }
+
+  public <G> void streamIssues(Writer out, Iterable<G> issues, Function<G, PreviousIssue> converter) {
+    Gson gson = GsonHelper.create();
+    try {
+      JsonWriter writer = new JsonWriter(out);
+      writer.setIndent("  ");
+      writer.beginArray();
+      for (G issue : issues) {
+        gson.toJson(converter.apply(issue), PreviousIssue.class, writer);
+      }
+      writer.endArray();
+      writer.close();
+    } catch (IOException e) {
+      throw new IllegalStateException("Unable to stream issues", e);
+    }
+  }
+
+  public Iterable<PreviousIssue> getIssues(final Reader reader) {
+
+    return new Iterable<PreviousIssue>() {
+      @Override
+      public Iterator<PreviousIssue> iterator() {
+        return new PreviousIssueIterator(reader);
+      }
+    };
+  }
+
+  private final class PreviousIssueIterator implements Iterator<PreviousIssue> {
+
+    private JsonReader jsonreader;
+
+    public PreviousIssueIterator(Reader reader) {
+      try {
+        jsonreader = new JsonReader(reader);
+        jsonreader.beginArray();
+      } catch (IOException e) {
+        throw new IllegalStateException("Unable to read issues", e);
+      }
+    }
+
+    @Override
+    public boolean hasNext() {
+      try {
+        if (jsonreader.hasNext()) {
+          return true;
+        }
+        jsonreader.endArray();
+        jsonreader.close();
+        return false;
+      } catch (IOException e) {
+        throw new IllegalStateException("Unable to iterate over JSON file ", e);
+      }
+    }
+
+    @Override
+    public PreviousIssue next() {
+      return gson.fromJson(jsonreader, PreviousIssue.class);
+    }
+
+    @Override
+    public void remove() {
+      throw new UnsupportedOperationException("remove");
+    }
+  }
+
+}
diff --git a/sonar-batch-protocol/src/test/java/org/sonar/batch/protocol/input/issues/PreviousIssueHelperTest.java b/sonar-batch-protocol/src/test/java/org/sonar/batch/protocol/input/issues/PreviousIssueHelperTest.java
new file mode 100644
index 00000000000..8719db821f8
--- /dev/null
+++ b/sonar-batch-protocol/src/test/java/org/sonar/batch/protocol/input/issues/PreviousIssueHelperTest.java
@@ -0,0 +1,100 @@
+/*
+ * SonarQube, open source software quality management tool.
+ * Copyright (C) 2008-2014 SonarSource
+ * mailto:contact AT sonarsource DOT com
+ *
+ * SonarQube is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * SonarQube is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+package org.sonar.batch.protocol.input.issues;
+
+import org.json.JSONException;
+import org.junit.Test;
+import org.skyscreamer.jsonassert.JSONAssert;
+
+import java.io.StringReader;
+import java.io.StringWriter;
+import java.util.Arrays;
+import java.util.Iterator;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+public class PreviousIssueHelperTest {
+
+  @Test
+  public void writeIssues() throws JSONException {
+    PreviousIssueHelper helper = PreviousIssueHelper.create();
+    StringWriter out = new StringWriter();
+
+    PreviousIssue issue1 = new PreviousIssue();
+    issue1.setKey("key1");
+    issue1.setComponentPath("path");
+    issue1.setRuleKey("repokey", "rulekey");
+    issue1.setLine(2);
+    issue1.setMessage("message");
+    issue1.setSeverity("severity");
+    issue1.setResolution("resolution");
+    issue1.setStatus("status");
+    issue1.setChecksum("checksum");
+    issue1.setAssigneeLogin("login");
+    issue1.setAssigneeFullname("fullname");
+    PreviousIssue issue2 = new PreviousIssue();
+    issue2.setKey("key2");
+
+    helper.streamIssues(out, Arrays.asList(issue1, issue2), new PreviousIssueHelper.Function<PreviousIssue, PreviousIssue>() {
+      @Override
+      public PreviousIssue apply(PreviousIssue from) {
+        return from;
+      }
+    });
+
+    JSONAssert
+      .assertEquals(
+        "[{\"key\": \"key1\", \"componentPath\": \"path\", \"ruleKey\": \"rulekey\", \"ruleRepo\": \"repokey\", \"line\": 2,\"message\": \"message\", \"severity\": \"severity\", \"resolution\": \"resolution\", \"status\": \"status\", \"checksum\": \"checksum\",\"assigneeLogin\": \"login\", \"assigneeFullname\": \"fullname\"},"
+          +
+          "{\"key\": \"key2\"}]",
+        out.getBuffer().toString(), true);
+  }
+
+  @Test
+  public void readIssues() {
+    PreviousIssueHelper helper = PreviousIssueHelper.create();
+    StringReader reader = new StringReader(
+      "[{\"key\": \"key1\", \"componentPath\": \"path\", \"ruleKey\": \"rulekey\", \"ruleRepo\": \"repokey\", \"line\": 2,\"message\": \"message\", \"severity\": \"severity\", \"resolution\": \"resolution\", \"status\": \"status\", \"checksum\": \"checksum\",\"assigneeLogin\": \"login\", \"assigneeFullname\": \"fullname\"},"
+        +
+        "{\"key\": \"key2\"}]");
+
+    Iterator<PreviousIssue> iterator = helper.getIssues(reader).iterator();
+    PreviousIssue issue1 = iterator.next();
+    assertThat(iterator.hasNext()).isTrue();
+    PreviousIssue issue2 = iterator.next();
+    assertThat(iterator.hasNext()).isFalse();
+
+    assertThat(issue1.key()).isEqualTo("key1");
+    assertThat(issue1.componentPath()).isEqualTo("path");
+    assertThat(issue1.ruleRepo()).isEqualTo("repokey");
+    assertThat(issue1.ruleKey()).isEqualTo("rulekey");
+    assertThat(issue1.line()).isEqualTo(2);
+    assertThat(issue1.message()).isEqualTo("message");
+    assertThat(issue1.severity()).isEqualTo("severity");
+    assertThat(issue1.resolution()).isEqualTo("resolution");
+    assertThat(issue1.status()).isEqualTo("status");
+    assertThat(issue1.checksum()).isEqualTo("checksum");
+    assertThat(issue1.assigneeLogin()).isEqualTo("login");
+    assertThat(issue1.assigneeFullname()).isEqualTo("fullname");
+
+    assertThat(issue2.key()).isEqualTo("key2");
+  }
+
+}