Merge pull request #2 from Leanplum/coverage-lines

ryankillory · web-flow · commit ff1094997acb · 2018-04-30T15:05:27.000-07:00
Added coverage result one-liner to status check. Reads out of newCode…
diff --git a/src/main/java/org/jenkinsci/plugins/ghprb/extensions/status/GhprbSimpleStatus.java b/src/main/java/org/jenkinsci/plugins/ghprb/extensions/status/GhprbSimpleStatus.java
@@ -48,14 +48,16 @@ public class GhprbSimpleStatus extends GhprbExtension implements
 
     private final Boolean addTestResults;
 
+    private final Boolean addCoverageResults;
+
     private final List<GhprbBuildResultMessage> completedStatus;
 
     public GhprbSimpleStatus() {
         this(null);
     }
 
     public GhprbSimpleStatus(String commitStatusContext) {
-        this(false, commitStatusContext, null, null, null, false, new ArrayList<GhprbBuildResultMessage>(0));
+        this(false, commitStatusContext, null, null, null, false, false, new ArrayList<GhprbBuildResultMessage>(0));
     }
 
     @DataBoundConstructor
@@ -65,13 +67,15 @@ public GhprbSimpleStatus(Boolean showMatrixStatus,
                              String triggeredStatus,
                              String startedStatus,
                              Boolean addTestResults,
+                             Boolean addCoverageResults,
                              List<GhprbBuildResultMessage> completedStatus) {
         this.showMatrixStatus = showMatrixStatus;
         this.statusUrl = statusUrl;
         this.commitStatusContext = commitStatusContext == null ? "" : commitStatusContext;
         this.triggeredStatus = triggeredStatus;
         this.startedStatus = startedStatus;
         this.addTestResults = addTestResults;
+        this.addCoverageResults = addCoverageResults;
         this.completedStatus = completedStatus;
     }
 
@@ -99,6 +103,10 @@ public Boolean getAddTestResults() {
         return addTestResults == null ? Boolean.valueOf(false) : addTestResults;
     }
 
+    public Boolean getAddCoverageResults() {
+        return addCoverageResults == null ? Boolean.valueOf(false) : addCoverageResults;
+    }
+
     public List<GhprbBuildResultMessage> getCompletedStatus() {
         return completedStatus == null ? new ArrayList<GhprbBuildResultMessage>(0) : completedStatus;
     }
@@ -215,6 +223,26 @@ public void onBuildComplete(Run<?, ?> build,
                 listener.getLogger().println("Adding one-line test results to commit status...");
                 sb.append(buildManager.getOneLineTestResults());
             }
+            if (getAddCoverageResults()) {
+                listener.getLogger().println("Adding coverage results to commit status...");
+
+                String coverageResultString;
+                GHCommitState coverageState;
+                Map<String, String> envVars = Ghprb.getEnvVars(build, listener);
+                if (!envVars.containsKey("newCodeCoveragePercentage")) {
+                    coverageResultString = "No coverage results found.";
+                    coverageState = GHCommitState.SUCCESS;
+                } else {
+                    String newCodeCoveragePercentage = envVars.get("newCodeCoveragePercentage");
+                    coverageResultString = newCodeCoveragePercentage + "% line coverage on new code.";
+                    int coveragePercent = Integer.parseInt(newCodeCoveragePercentage);
+                    coverageState = coveragePercent > 1 ? GHCommitState.SUCCESS : GHCommitState.ERROR;
+                }
+
+                String context = Util.fixEmpty(commitStatusContext);
+                context = Ghprb.replaceMacros(build, listener, context) + " Coverage";
+                createCommitStatus(build, listener, coverageResultString, repo, coverageState, context);
+            }
         }
 
         createCommitStatus(build, listener, sb.toString(), repo, state);
@@ -224,7 +252,8 @@ private void createCommitStatus(Run<?, ?> build,
                                     TaskListener listener,
                                     String message,
                                     GHRepository repo,
-                                    GHCommitState state) throws GhprbCommitStatusException {
+                                    GHCommitState state,
+                                    String context) throws GhprbCommitStatusException {
 
         Map<String, String> envVars = Ghprb.getEnvVars(build, listener);
 
@@ -245,9 +274,6 @@ private void createCommitStatus(Run<?, ?> build,
             url = Ghprb.replaceMacros(build, listener, statusUrl);
         }
 
-        String context = Util.fixEmpty(commitStatusContext);
-        context = Ghprb.replaceMacros(build, listener, context);
-
         listener.getLogger().println(String.format("Setting status of %s to %s with url %s and message: '%s'",
                 sha1,
                 state,
@@ -265,6 +291,16 @@ private void createCommitStatus(Run<?, ?> build,
         }
     }
 
+    private void createCommitStatus(Run<?, ?> build,
+                                    TaskListener listener,
+                                    String message,
+                                    GHRepository repo,
+                                    GHCommitState state) throws GhprbCommitStatusException {
+        String context = Util.fixEmpty(commitStatusContext);
+        context = Ghprb.replaceMacros(build, listener, context);
+        createCommitStatus(build, listener, message, repo, state, context);
+    }
+
     public void createCommitStatus(Job<?, ?> project,
                                    int prId,
                                    String commitSha,
@@ -321,6 +357,10 @@ public Boolean getAddTestResultsDefault(GhprbSimpleStatus local) {
             return Ghprb.getDefaultValue(local, GhprbSimpleStatus.class, "getAddTestResults");
         }
 
+        public Boolean getAddCoverageResultsDefault(GhprbSimpleStatus local) {
+            return Ghprb.getDefaultValue(local, GhprbSimpleStatus.class, "getAddCoverageResults");
+        }
+
         public List<GhprbBuildResultMessage> getCompletedStatusDefault(GhprbSimpleStatus local) {
             return Ghprb.getDefaultValue(local, GhprbSimpleStatus.class, "getCompletedStatus");
         }
diff --git a/src/main/java/org/jenkinsci/plugins/ghprb/extensions/status/GhprbSimpleStatusDescriptor.java b/src/main/java/org/jenkinsci/plugins/ghprb/extensions/status/GhprbSimpleStatusDescriptor.java
@@ -16,6 +16,8 @@ public abstract class GhprbSimpleStatusDescriptor extends GhprbExtensionDescript
 
     public abstract Boolean getAddTestResultsDefault(GhprbSimpleStatus local);
 
+    public abstract Boolean getAddCoverageResultsDefault(GhprbSimpleStatus local);
+
     public abstract List<GhprbBuildResultMessage> getCompletedStatusDefault(GhprbSimpleStatus local);
 
     public abstract String getCommitStatusContextDefault(GhprbSimpleStatus local);
diff --git a/src/main/java/org/jenkinsci/plugins/ghprb/jobdsl/GhprbContextExtensionPoint.java b/src/main/java/org/jenkinsci/plugins/ghprb/jobdsl/GhprbContextExtensionPoint.java
@@ -76,6 +76,7 @@ public Object downstreamCommitStatus(Runnable closure) {
                 context.triggeredStatus,
                 context.startedStatus,
                 context.addTestResults,
+                context.addCoverageResults,
                 context.completedStatus
         );
     }
diff --git a/src/main/java/org/jenkinsci/plugins/ghprb/jobdsl/GhprbExtensionContext.java b/src/main/java/org/jenkinsci/plugins/ghprb/jobdsl/GhprbExtensionContext.java
@@ -26,6 +26,7 @@ void commitStatus(Runnable closure) {
                 context.triggeredStatus,
                 context.startedStatus,
                 context.addTestResults,
+                context.addCoverageResults,
                 context.completedStatus
         ));
     }
diff --git a/src/main/java/org/jenkinsci/plugins/ghprb/jobdsl/GhprbSimpleStatusContext.java b/src/main/java/org/jenkinsci/plugins/ghprb/jobdsl/GhprbSimpleStatusContext.java
@@ -20,6 +20,8 @@ class GhprbSimpleStatusContext implements Context {
 
     Boolean addTestResults;
 
+    Boolean addCoverageResults;
+
     List<GhprbBuildResultMessage> completedStatus = new ArrayList<GhprbBuildResultMessage>();
 
     /**
@@ -71,6 +73,13 @@ void addTestResults(Boolean addTestResults) {
         this.addTestResults = addTestResults;
     }
 
+    /**
+     * Add the coverage results as one line if available.
+     */
+    void addCoverageResults(Boolean addCoverageResults) {
+        this.addCoverageResults = addCoverageResults;
+    }
+
     /**
      * Use a custom status for when a build is completed. Can be called multiple times to set messages for different
      * build results. Valid build results are {@code 'SUCCESS'}, {@code 'FAILURE'}, and {@code 'ERROR'}.
diff --git a/src/main/java/org/jenkinsci/plugins/ghprb/jobdsl/GhprbUpstreamStatusContext.java b/src/main/java/org/jenkinsci/plugins/ghprb/jobdsl/GhprbUpstreamStatusContext.java
@@ -20,6 +20,8 @@ class GhprbUpstreamStatusContext implements Context {
 
     Boolean addTestResults;
 
+    Boolean addCoverageResults;
+
     List<GhprbBuildResultMessage> completedStatus = new ArrayList<GhprbBuildResultMessage>();
 
     /**
@@ -71,6 +73,13 @@ void addTestResults(Boolean addTestResults) {
         this.addTestResults = addTestResults;
     }
 
+    /**
+     * Add the coverage results if available.
+     */
+    void addCoverageResults(Boolean addCoverageResults) {
+        this.addCoverageResults = addCoverageResults;
+    }
+
     /**
      * Use a custom status for when a build is completed. Can be called multiple times to set messages for different
      * build results. Valid build results are {@code 'SUCCESS'}, {@code 'FAILURE'}, and {@code 'ERROR'}.
diff --git a/src/main/java/org/jenkinsci/plugins/ghprb/manager/impl/GhprbBaseBuildManager.java b/src/main/java/org/jenkinsci/plugins/ghprb/manager/impl/GhprbBaseBuildManager.java
@@ -8,16 +8,15 @@
 import hudson.tasks.test.AbstractTestResultAction;
 import hudson.tasks.test.AggregatedTestResultAction;
 import hudson.tasks.test.AggregatedTestResultAction.ChildReport;
-import jenkins.model.Jenkins;
-import org.jenkinsci.plugins.ghprb.manager.GhprbBuildManager;
-import org.jenkinsci.plugins.ghprb.manager.configuration.JobConfiguration;
-
 import java.io.IOException;
 import java.util.ArrayList;
 import java.util.Iterator;
 import java.util.List;
 import java.util.logging.Level;
 import java.util.logging.Logger;
+import jenkins.model.Jenkins;
+import org.jenkinsci.plugins.ghprb.manager.GhprbBuildManager;
+import org.jenkinsci.plugins.ghprb.manager.configuration.JobConfiguration;
 
 /**
  * @author mdelapenya (Manuel de la Peña)
diff --git a/src/main/java/org/jenkinsci/plugins/ghprb/upstream/GhprbUpstreamStatus.java b/src/main/java/org/jenkinsci/plugins/ghprb/upstream/GhprbUpstreamStatus.java
@@ -36,6 +36,8 @@ public class GhprbUpstreamStatus extends BuildWrapper {
 
     private final Boolean addTestResults;
 
+    private final Boolean addCoverageResults;
+
     private final List<GhprbBuildResultMessage> completedStatus;
 
     // sets the context and message as env vars so that they are available in the Listener class
@@ -48,6 +50,7 @@ public void makeBuildVariables(@SuppressWarnings("rawtypes") AbstractBuild build
         variables.put("ghprbStartedStatus", getStartedStatus());
         variables.put("ghprbStatusUrl", getStatusUrl());
         variables.put("ghprbAddTestResults", Boolean.toString(getAddTestResults()));
+        variables.put("ghprbAddCoverageResults", Boolean.toString(getAddCoverageResults()));
 
         Map<GHCommitState, StringBuilder> statusMessages = new HashMap<GHCommitState, StringBuilder>(INITIAL_CAPACITY);
 
@@ -94,6 +97,7 @@ public GhprbUpstreamStatus(
             String triggeredStatus,
             String startedStatus,
             Boolean addTestResults,
+            Boolean addCoverageResults,
             List<GhprbBuildResultMessage> completedStatus
     ) {
         this.showMatrixStatus = showMatrixStatus;
@@ -102,6 +106,7 @@ public GhprbUpstreamStatus(
         this.triggeredStatus = triggeredStatus;
         this.startedStatus = startedStatus;
         this.addTestResults = addTestResults;
+        this.addCoverageResults = addCoverageResults;
         this.completedStatus = completedStatus;
     }
 
@@ -126,6 +131,10 @@ public Boolean getAddTestResults() {
         return addTestResults == null ? Boolean.valueOf(false) : addTestResults;
     }
 
+    public Boolean getAddCoverageResults() {
+        return addCoverageResults == null ? Boolean.valueOf(false) : addCoverageResults;
+    }
+
     public Boolean getShowMatrixStatus() {
         return showMatrixStatus == null ? Boolean.valueOf(false) : showMatrixStatus;
     }
diff --git a/src/main/java/org/jenkinsci/plugins/ghprb/upstream/GhprbUpstreamStatusListener.java b/src/main/java/org/jenkinsci/plugins/ghprb/upstream/GhprbUpstreamStatusListener.java
@@ -75,6 +75,7 @@ private GhprbSimpleStatus returnGhprbSimpleStatus(Map<String, String> envVars) {
                 envVars.get("ghprbTriggeredStatus"),
                 envVars.get("ghprbStartedStatus"),
                 Boolean.valueOf(envVars.get("ghprbAddTestResults")),
+                Boolean.valueOf(envVars.get("ghprbAddCoverageResults")),
                 statusMessages
         );
     }
diff --git a/src/main/resources/org/jenkinsci/plugins/ghprb/extensions/status/GhprbSimpleStatus/config.jelly b/src/main/resources/org/jenkinsci/plugins/ghprb/extensions/status/GhprbSimpleStatus/config.jelly
@@ -15,7 +15,10 @@
   <f:entry title="${%Add test result one liner}" field="addTestResults" >
     <f:checkbox default="${descriptor.getAddTestResultsDefault(instance)}" />
   </f:entry>
+  <f:entry title="${%Add coverage result one liner}" field="addCoverageResults" >
+    <f:checkbox default="${descriptor.getAddCoverageResultsDefault(instance)}" />
+  </f:entry>
   <f:entry title="${%Commit Status Build Result}" field="completedStatus" >
     <f:repeatableProperty field="completedStatus" default="${descriptor.getCompletedStatusDefault(instance)}" />
   </f:entry>
-</j:jelly>
+</j:jelly>
diff --git a/src/main/resources/org/jenkinsci/plugins/ghprb/upstream/GhprbUpstreamStatus/config.jelly b/src/main/resources/org/jenkinsci/plugins/ghprb/upstream/GhprbUpstreamStatus/config.jelly
@@ -18,6 +18,9 @@
   <f:entry title="${%Add test result one liner}" field="addTestResults" >
     <f:checkbox default="${descriptor.getAddTestResultsDefault(instance)}" />
   </f:entry>
+  <f:entry title="${%Add coverage result one liner}" field="addCoverageResults" >
+    <f:checkbox default="${descriptor.getAddCoverageResultsDefault(instance)}" />
+  </f:entry>
   <f:entry title="${%Commit Status Build Result}" field="completedStatus" >
     <f:repeatableProperty field="completedStatus" default="${descriptor.getCompletedStatusDefault(instance)}" />
   </f:entry>
diff --git a/src/test/java/org/jenkinsci/plugins/ghprb/extensions/status/GhprbSimpleStatusTest.java b/src/test/java/org/jenkinsci/plugins/ghprb/extensions/status/GhprbSimpleStatusTest.java
@@ -1,5 +1,13 @@
 package org.jenkinsci.plugins.ghprb.extensions.status;
 
+import static org.mockito.BDDMockito.given;
+import static org.mockito.Matchers.eq;
+import static org.mockito.Matchers.isNull;
+import static org.mockito.Mockito.spy;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.verifyNoMoreInteractions;
+
+import java.util.ArrayList;
 import org.jenkinsci.plugins.ghprb.GhprbPullRequest;
 import org.jenkinsci.plugins.ghprb.GhprbTestUtil;
 import org.jenkinsci.plugins.ghprb.GhprbTrigger;
@@ -14,15 +22,6 @@
 import org.mockito.Mock;
 import org.mockito.runners.MockitoJUnitRunner;
 
-import java.util.ArrayList;
-
-import static org.mockito.BDDMockito.given;
-import static org.mockito.Matchers.eq;
-import static org.mockito.Matchers.isNull;
-import static org.mockito.Mockito.spy;
-import static org.mockito.Mockito.verify;
-import static org.mockito.Mockito.verifyNoMoreInteractions;
-
 @RunWith(MockitoJUnitRunner.class)
 public class GhprbSimpleStatusTest extends org.jenkinsci.plugins.ghprb.extensions.GhprbExtension {
 
@@ -108,7 +107,7 @@ public void testUseDefaultContext() throws Exception {
         given(ghprbPullRequest.isMergeable()).willReturn(false);
 
         GhprbSimpleStatus globalStatus =
-                new GhprbSimpleStatus(true, context, statusUrl, "test1", "test2", false, new ArrayList<GhprbBuildResultMessage>(0));
+                new GhprbSimpleStatus(true, context, statusUrl, "test1", "test2", false, false, new ArrayList<GhprbBuildResultMessage>(0));
         GhprbTrigger.getDscp().getExtensions().add(globalStatus);
 
         GhprbSimpleStatus status = new GhprbSimpleStatus("");

Original file line number	Diff line number	Diff line change
`@@ -76,6 +76,7 @@ public Object downstreamCommitStatus(Runnable closure) {`
`76`	`76`	`context.triggeredStatus,`
`77`	`77`	`context.startedStatus,`
`78`	`78`	`context.addTestResults,`
	`79`	`+ context.addCoverageResults,`
`79`	`80`	`context.completedStatus`
`80`	`81`	`);`
`81`	`82`	`}`
Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,7 @@ void commitStatus(Runnable closure) {`
`26`	`26`	`context.triggeredStatus,`
`27`	`27`	`context.startedStatus,`
`28`	`28`	`context.addTestResults,`
	`29`	`+ context.addCoverageResults,`
`29`	`30`	`context.completedStatus`
`30`	`31`	`));`
`31`	`32`	`}`
Original file line number	Diff line number	Diff line change
`@@ -75,6 +75,7 @@ private GhprbSimpleStatus returnGhprbSimpleStatus(Map<String, String> envVars) {`
`75`	`75`	`envVars.get("ghprbTriggeredStatus"),`
`76`	`76`	`envVars.get("ghprbStartedStatus"),`
`77`	`77`	`Boolean.valueOf(envVars.get("ghprbAddTestResults")),`
	`78`	`+ Boolean.valueOf(envVars.get("ghprbAddCoverageResults")),`
`78`	`79`	`statusMessages`
`79`	`80`	`);`
`80`	`81`	`}`