SONARGITUB-23 Update to SQ plugin API 5.6 (Java 8)

Author: henryju

pom.xml

@@ -5,7 +5,7 @@
   <parent>
     <groupId>org.sonarsource.parent</groupId>
     <artifactId>parent</artifactId>
-    <version>31</version>
+    <version>34</version>
     <relativePath />
   </parent>
 
@@ -19,7 +19,7 @@
   <inceptionYear>2015</inceptionYear>
 
   <properties>
-    <sonar.version>4.5.2</sonar.version>
+    <sonar.version>5.6</sonar.version>
     <sonar.pluginName>GitHub</sonar.pluginName>
     <sonar.pluginClass>org.sonar.plugins.github.GitHubPlugin</sonar.pluginClass>
 
@@ -62,9 +62,9 @@
 
   <repositories>
     <!--
-    Unfortunately this is required because thw transitive dependency org.jenkins-ci:jenkins:pom:1.26
+    Unfortunately this is required because the transitive dependency org.jenkins-ci:jenkins:pom:1.26
     is not available in Maven central repository:
-    org.kohsuke:github-api:jar:1.69 -> com.infradna.tool:bridge-method-annotation:jar:1.14 -> org.jenkins-ci:annotation-indexer:jar:1.4 -> org.jenkins-ci:jenkins:pom:1.26
+    org.kohsuke:github-api:jar:1.76 -> com.infradna.tool:bridge-method-annotation:jar:1.14 -> org.jenkins-ci:annotation-indexer:jar:1.4 -> org.jenkins-ci:jenkins:pom:1.26
     -->
     <repository>
       <id>repo.jenkins-ci.org</id>
@@ -74,7 +74,7 @@
 
   <dependencies>
     <dependency>
-      <groupId>org.codehaus.sonar</groupId>
+      <groupId>org.sonarsource.sonarqube</groupId>
       <artifactId>sonar-plugin-api</artifactId>
       <version>${sonar.version}</version>
       <scope>provided</scope>
@@ -88,17 +88,16 @@
     <dependency>
       <groupId>org.kohsuke</groupId>
       <artifactId>github-api</artifactId>
-      <version>1.73</version>
+      <version>1.76</version>
     </dependency>
-
-    <!-- unit tests -->
     <!-- Override version used by GitHub API -->
     <dependency>
       <groupId>commons-io</groupId>
       <artifactId>commons-io</artifactId>
       <version>2.4</version>
-      <scope>test</scope>
     </dependency>
+
+    <!-- unit tests -->
     <dependency>
       <groupId>junit</groupId>
       <artifactId>junit</artifactId>
@@ -117,12 +116,6 @@
       <version>1.9.5</version>
       <scope>test</scope>
     </dependency>
-    <dependency>
-      <groupId>ch.qos.logback</groupId>
-      <artifactId>logback-classic</artifactId>
-      <version>1.1.2</version>
-      <scope>test</scope>
-    </dependency>
   </dependencies>
 
 </project>

src/main/java/org/sonar/plugins/github/GitHubPlugin.java

@@ -19,13 +19,11 @@
  */
 package org.sonar.plugins.github;
 
-import java.util.Arrays;
-import java.util.List;
 import org.sonar.api.CoreProperties;
+import org.sonar.api.Plugin;
 import org.sonar.api.Properties;
 import org.sonar.api.Property;
 import org.sonar.api.PropertyType;
-import org.sonar.api.SonarPlugin;
 
 @Properties({
   @Property(
@@ -63,7 +61,7 @@
     global = true,
     type = PropertyType.BOOLEAN)
 })
-public class GitHubPlugin extends SonarPlugin {
+public class GitHubPlugin implements Plugin {
 
   public static final String GITHUB_ENDPOINT = "sonar.github.endpoint";
   public static final String GITHUB_OAUTH = "sonar.github.oauth";
@@ -72,14 +70,12 @@ public class GitHubPlugin extends SonarPlugin {
   public static final String GITHUB_DISABLE_INLINE_COMMENTS = "sonar.github.disableInlineComments";
 
   @Override
-  public List getExtensions() {
-    return Arrays.asList(
+  public void define(Context context) {
+    context.addExtensions(
       PullRequestIssuePostJob.class,
       GitHubPluginConfiguration.class,
       PullRequestProjectBuilder.class,
       PullRequestFacade.class,
-      InputFileCacheSensor.class,
-      InputFileCache.class,
       MarkDownUtils.class);
   }
 

src/main/java/org/sonar/plugins/github/GitHubPluginConfiguration.java

@@ -22,16 +22,17 @@
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 import javax.annotation.CheckForNull;
-import org.sonar.api.BatchComponent;
 import org.sonar.api.CoreProperties;
+import org.sonar.api.batch.BatchSide;
 import org.sonar.api.batch.InstantiationStrategy;
 import org.sonar.api.config.Settings;
 import org.sonar.api.utils.MessageException;
 
 import static org.apache.commons.lang.StringUtils.isNotBlank;
 
+@BatchSide
 @InstantiationStrategy(InstantiationStrategy.PER_BATCH)
-public class GitHubPluginConfiguration implements BatchComponent {
+public class GitHubPluginConfiguration {
 
   public static final int MAX_GLOBAL_ISSUES = 10;
 

src/main/java/org/sonar/plugins/github/GlobalReport.java

@@ -19,16 +19,16 @@
  */
 package org.sonar.plugins.github;
 
-import com.google.common.annotations.VisibleForTesting;
+import java.util.Locale;
 import javax.annotation.Nullable;
 import org.kohsuke.github.GHCommitState;
-import org.sonar.api.issue.Issue;
-import org.sonar.api.rule.Severity;
+import org.sonar.api.batch.postjob.issue.PostJobIssue;
+import org.sonar.api.batch.rule.Severity;
 
 public class GlobalReport {
   private final MarkDownUtils markDownUtils;
   private final boolean tryReportIssuesInline;
-  private int[] newIssuesBySeverity = new int[Severity.ALL.size()];
+  private int[] newIssuesBySeverity = new int[Severity.values().length];
   private StringBuilder notReportedOnDiff = new StringBuilder();
   private int extraIssueCount = 0;
   private int maxGlobalReportedIssues;
@@ -37,15 +37,14 @@ public GlobalReport(MarkDownUtils markDownUtils, boolean tryReportIssuesInline)
     this(markDownUtils, tryReportIssuesInline, GitHubPluginConfiguration.MAX_GLOBAL_ISSUES);
   }
 
-  @VisibleForTesting
   public GlobalReport(MarkDownUtils markDownUtils, boolean tryReportIssuesInline, int maxGlobalReportedIssues) {
     this.markDownUtils = markDownUtils;
     this.tryReportIssuesInline = tryReportIssuesInline;
     this.maxGlobalReportedIssues = maxGlobalReportedIssues;
   }
 
-  private void increment(String severity) {
-    this.newIssuesBySeverity[Severity.ALL.indexOf(severity)]++;
+  private void increment(org.sonar.api.batch.rule.Severity severity) {
+    this.newIssuesBySeverity[severity.ordinal()]++;
   }
 
   public String formatForMarkdown() {
@@ -78,7 +77,8 @@ public String formatForMarkdown() {
           sb.append(extraCount).append(" extra issue").append(extraCount > 1 ? "s" : "").append("\n");
         }
         sb.append(
-          "\nNote: The following issues were found on lines that were not modified in the pull request. Because these issues can't be reported as line comments, they are summarized here:\n");
+          "\nNote: The following issues were found on lines that were not modified in the pull request. "
+            + "Because these issues can't be reported as line comments, they are summarized here:\n");
       } else if (extraIssuesTruncated) {
         sb.append("\n#### Top ").append(maxGlobalReportedIssues).append(" issues\n");
       }
@@ -99,8 +99,8 @@ public GHCommitState getStatus() {
     return (newIssues(Severity.BLOCKER) > 0 || newIssues(Severity.CRITICAL) > 0) ? GHCommitState.ERROR : GHCommitState.SUCCESS;
   }
 
-  private int newIssues(String s) {
-    return newIssuesBySeverity[Severity.ALL.indexOf(s)];
+  private int newIssues(Severity s) {
+    return newIssuesBySeverity[s.ordinal()];
   }
 
   private void printSummaryBySeverityMarkdown(StringBuilder sb) {
@@ -128,26 +128,27 @@ private void printNewIssuesInline(StringBuilder sb) {
     }
   }
 
-  private void printNewIssuesInline(StringBuilder sb, String severity) {
+  private void printNewIssuesInline(StringBuilder sb, Severity severity) {
     int issueCount = newIssues(severity);
     if (issueCount > 0) {
       if (sb.charAt(sb.length() - 1) == ',') {
         sb.append(" with ");
       } else {
         sb.append(" and ");
       }
-      sb.append(issueCount).append(" ").append(severity.toLowerCase());
+      sb.append(issueCount).append(" ").append(severity.name().toLowerCase(Locale.ENGLISH));
     }
   }
 
-  private void printNewIssuesForMarkdown(StringBuilder sb, String severity) {
+  private void printNewIssuesForMarkdown(StringBuilder sb, Severity severity) {
     int issueCount = newIssues(severity);
     if (issueCount > 0) {
-      sb.append("* ").append(MarkDownUtils.getImageMarkdownForSeverity(severity)).append(" ").append(issueCount).append(" ").append(severity.toLowerCase()).append("\n");
+      sb.append("* ").append(MarkDownUtils.getImageMarkdownForSeverity(severity)).append(" ").append(issueCount).append(" ").append(severity.name().toLowerCase(Locale.ENGLISH))
+        .append("\n");
     }
   }
 
-  public void process(Issue issue, @Nullable String githubUrl, boolean reportedOnDiff) {
+  public void process(PostJobIssue issue, @Nullable String githubUrl, boolean reportedOnDiff) {
     increment(issue.severity());
     if (!reportedOnDiff) {
       if (extraIssueCount < maxGlobalReportedIssues) {

src/main/java/org/sonar/plugins/github/InputFileCache.java

@@ -22,12 +22,12 @@
 import java.util.Comparator;
 import java.util.Objects;
 import javax.annotation.Nullable;
-import org.sonar.api.issue.Issue;
-import org.sonar.api.rule.Severity;
+import org.sonar.api.batch.postjob.issue.PostJobIssue;
+import org.sonar.api.batch.rule.Severity;
 
-public final class IssueComparator implements Comparator<Issue> {
+public final class IssueComparator implements Comparator<PostJobIssue> {
   @Override
-  public int compare(Issue left, Issue right) {
+  public int compare(PostJobIssue left, PostJobIssue right) {
     // Most severe issues should be displayed first.
     if (left == right) {
       return 0;
@@ -46,15 +46,15 @@ public int compare(Issue left, Issue right) {
     return compareSeverity(left.severity(), right.severity());
   }
 
-  private static int compareComponentKeyAndLine(Issue left, Issue right) {
+  private static int compareComponentKeyAndLine(PostJobIssue left, PostJobIssue right) {
     if (!left.componentKey().equals(right.componentKey())) {
       return left.componentKey().compareTo(right.componentKey());
     }
     return compareInt(left.line(), right.line());
   }
 
-  private static int compareSeverity(String leftSeverity, String rightSeverity) {
-    if (Severity.ALL.indexOf(leftSeverity) > Severity.ALL.indexOf(rightSeverity)) {
+  private static int compareSeverity(Severity leftSeverity, Severity rightSeverity) {
+    if (leftSeverity.ordinal() > rightSeverity.ordinal()) {
       // Display higher severity first. Relies on Severity.ALL to be sorted by severity.
       return -1;
     } else {