Complete inline and global comments

Author: nthienan

pom.xml

@@ -6,7 +6,7 @@
 
   <groupId>io.nthienan</groupId>
   <artifactId>phdiff</artifactId>
-  <version>1.0-SNAPSHOT</version>
+  <version>0.1.0</version>
   <!-- This is important for sonar-packaging-maven-plugin -->
   <packaging>sonar-plugin</packaging>
 
@@ -26,7 +26,14 @@
       <email>nthienan.it@gmail.com</email>
     </developer>
   </developers>
-
+  <url>https://github.com/thienan93/phdiff</url>
+  <issueManagement>
+    <url>https://github.com/thienan93/phdiff/issues</url>
+  </issueManagement>
+  <scm>
+    <url>https://github.com/thienan93/phdiff</url>
+    <connection>scm:git:https://github.com/thienan93/phdiff/issues</connection>
+  </scm>
   <properties>
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     <!-- Minimal version of SonarQube to support -->
@@ -75,14 +82,6 @@
       <version>2.5</version>
     </dependency>
 
-
-    <!-- Just for test, should be remove when submitting -->
-    <dependency>
-      <groupId>org.springframework.boot</groupId>
-      <artifactId>spring-boot-starter-web</artifactId>
-      <version>1.5.4.RELEASE</version>
-    </dependency>
-
     <dependency>
       <groupId>org.jetbrains.kotlin</groupId>
       <artifactId>kotlin-stdlib-jre8</artifactId>

src/main/java/io/nthienan/phdiff/PhabricatorDifferentialPlugin.java

@@ -1,6 +1,6 @@
 package io.nthienan.phdiff;
 
-import io.nthienan.phdiff.report.RemarkGlobalReportBuilder;
+import io.nthienan.phdiff.report.RemarkupGlobalReportBuilder;
 import io.nthienan.phdiff.report.RemarkupInlineReportBuilder;
 import io.nthienan.phdiff.report.RemarkupUtils;
 import org.sonar.api.Plugin;
@@ -46,7 +46,7 @@ public void define(Context context) {
         context.addExtensions(
             PhabricatorDifferentialPostJob.class,
             Configuration.class,
-            RemarkGlobalReportBuilder.class,
+            RemarkupGlobalReportBuilder.class,
             RemarkupUtils.class,
             RemarkupInlineReportBuilder.class
         );

src/main/java/io/nthienan/phdiff/PhabricatorDifferentialPostJob.java

@@ -28,14 +28,14 @@ public class PhabricatorDifferentialPostJob implements PostJob {
 
     private static final Comparator<PostJobIssue> ISSUE_COMPARATOR = new IssueComparator();
 
-    private final GlobalReportBuilder reportBuilder;
+    private final GlobalReportBuilder globalReportBuilder;
     private final InlineReportBuilder inlineReportBuilder;
     private final String projectKey;
     private final Configuration configuration;
     private DifferentialClient differentialClient;
 
-    public PhabricatorDifferentialPostJob(GlobalReportBuilder reportBuilder, InlineReportBuilder inlineReportBuilder, Configuration configuration) {
-        this.reportBuilder = reportBuilder;
+    public PhabricatorDifferentialPostJob(GlobalReportBuilder globalReportBuilder, InlineReportBuilder inlineReportBuilder, Configuration configuration) {
+        this.globalReportBuilder = globalReportBuilder;
         this.inlineReportBuilder = inlineReportBuilder;
         this.configuration = configuration;
         String url = this.configuration.phabricatorUrl();
@@ -63,20 +63,19 @@ public void execute(PostJobContext context) {
                     .filter(i -> i.inputComponent().isFile())
                     .sorted(ISSUE_COMPARATOR)
                     .forEach(i -> {
-                        reportBuilder.add(i);
+                        globalReportBuilder.add(i);
                         String ic = inlineReportBuilder.issue(i).build();
-                        LOG.error(ic);
                         String filePath = i.componentKey().replace(projectKey, "").substring(1);
-                        LOG.error(filePath);
                         try {
                             differentialClient.postInlineComment(diffID, filePath, i.line(), ic);
+                            LOG.debug("Comment " + ic + " has been published");
                         } catch (ConduitException e) {
                             LOG.error(e.getMessage());
                         }
                     });
             }
-            LOG.error(reportBuilder.buildReport());
-            differentialClient.postComment(diff.getRevisionId(), reportBuilder.buildReport());
+            differentialClient.postComment(diff.getRevisionId(), globalReportBuilder.summarize());
+            LOG.info("Analysis result has been published to your differential revision");
         } catch (ConduitException e) {
             LOG.error(e.getMessage());
         }

src/main/java/io/nthienan/phdiff/report/GlobalReportBuilder.java

@@ -26,6 +26,8 @@ public interface GlobalReportBuilder {
      *
      * @return String in format
      */
-    String buildReport();
+    String build();
+
+    String summarize();
 
 }

src/main/java/io/nthienan/phdiff/report/RemarkGlobalReportBuilder.java renamed to src/main/java/io/nthienan/phdiff/report/RemarkupGlobalReportBuilder.java

@@ -16,13 +16,13 @@
  */
 @BatchSide
 @InstantiationStrategy(InstantiationStrategy.PER_BATCH)
-public class RemarkGlobalReportBuilder implements GlobalReportBuilder {
+public class RemarkupGlobalReportBuilder implements GlobalReportBuilder {
 
     private RemarkupUtils remarkupUtils;
     private StringBuilder sb = new StringBuilder();
     private int[] numberOfIssuesBySeverity = new int[Severity.values().length];
 
-    public RemarkGlobalReportBuilder(RemarkupUtils remarkupUtils) {
+    public RemarkupGlobalReportBuilder(RemarkupUtils remarkupUtils) {
         this.remarkupUtils = remarkupUtils;
     }
 
@@ -40,16 +40,17 @@ public GlobalReportBuilder add(PostJobIssue issue) {
     }
 
     @Override
-    public String buildReport() {
-        return summarize().append(sb).toString();
+    public String build() {
+        return new StringBuilder(summarize()).append(sb).toString();
     }
 
-    private StringBuilder summarize() {
+    @Override
+    public String summarize() {
         StringBuilder sum = new StringBuilder();
         if (hasIssues()) {
             int totalIssues = totalIssues();
-            sum.append(bold("SonarQube")).append(" ")
-                .append("analysis reported ")
+            sum.append(bold("SonarQube"))
+                .append(" reported ")
                 .append(bold(String.valueOf(totalIssues)))
                 .append(" issue")
                 .append(totalIssues > 1 ? "s" : "")
@@ -99,23 +100,24 @@ private StringBuilder summarize() {
                     .append(infoIssues > 1 ? "s" : "")
                     .append(" (").append(remarkupUtils.icon(Severity.INFO)).append(")\n");
             }
+            sum.append("See inline comments for more detail.");
         } else {
-            sum.append("You are great developer.\n")
-                .append(bold("SonarQube"))
-                .append(" analysis reported no issues.");
+            sum.append(bold("SonarQube"))
+                .append(" has found no issue.")
+                .append(" You are great developer.");
         }
-        return sum;
+        return sum.toString();
     }
 
-    public boolean hasIssues() {
+    private boolean hasIssues() {
         return totalIssues() > 0;
     }
 
     private int numberOfIssues(Severity s) {
         return numberOfIssuesBySeverity[s.ordinal()];
     }
 
-    public int totalIssues() {
+    private int totalIssues() {
         final int[] total = {0};
         Arrays.stream(Severity.values())
             .forEach(severity -> total[0] += numberOfIssues(severity));
@@ -124,6 +126,6 @@ public int totalIssues() {
 
     @Override
     public String toString() {
-        return buildReport();
+        return build();
     }
 }

src/main/kotlin/io/nthienan/phdiff/Application.kt

@@ -8,20 +8,24 @@ import org.apache.http.client.methods.HttpPost
 import org.apache.http.impl.client.HttpClientBuilder
 import org.apache.http.message.BasicNameValuePair
 import org.json.JSONObject
+import org.sonar.api.utils.log.Loggers
 import java.net.URL
 import java.util.ArrayList
 
 /**
  * Created on 17-Jul-17.
  * @author nthienan
  */
+val LOG = Loggers.get(ConduitClient::class.java)
+
 class ConduitClient(var url: String, var token: String) {
 
     fun perform(action: String, params: JSONObject): JSONObject {
         val httpClient = HttpClientBuilder.create().build()
         val postRequest = makeRequest(action, params)
         val response = httpClient.execute(postRequest)
         val responseBody = IOUtils.toString(response.entity.content, Charsets.UTF_8)
+        LOG.debug("$url responses: $responseBody")
         if (response.statusLine.statusCode != HttpStatus.SC_OK) {
             throw ConduitException(responseBody, response.statusLine.statusCode)
         }

src/main/kotlin/io/nthienan/phdiff/conduit/ConduitClient.kt

@@ -55,11 +55,9 @@ class DifferentialClient(val conduitClient: ConduitClient) {
         val diff = Diff()
         diff.id = diffJsonObj.get("id").toString()
         diff.revisionId = diffJsonObj.getString("revisionID")
-//        diff.branch = diffJsonObj.getString("branch")
         diff.dateCreated = Date(diffJsonObj.getLong("dateCreated"))
         diff.dateModified = Date(diffJsonObj.getLong("dateModified"))
         return diff
-
     }
 
     /**

src/main/kotlin/io/nthienan/phdiff/conduit/DifferentialClient.kt

@@ -24,7 +24,7 @@ class RemarkupInlineReportBuilder(val remarkupUtils: RemarkupUtils) : InlineRepo
         issue?.let { issue ->
             str = StringBuilder().append(remarkupUtils.icon(issue.severity()))
                 .append(" ").append(remarkupUtils.message(issue.message()))
-                .append(" ").append(remarkupUtils.rule(issue.ruleKey().rule()))
+                .append(" ").append(remarkupUtils.rule(issue.ruleKey().toString()))
                 .toString()
         }
         return str