Merge pull request #909 from JKalash/jkalash/master

GHCheckRun.getPullRequests public

Author: bitwiseman

src/main/java/org/kohsuke/github/GHCheckRun.java

@@ -1,10 +1,14 @@
 package org.kohsuke.github;
 
+import com.fasterxml.jackson.annotation.JsonProperty;
 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 
 import java.io.IOException;
 import java.net.URL;
+import java.util.Arrays;
+import java.util.Collections;
 import java.util.Date;
+import java.util.List;
 
 /**
  * Represents a check run.
@@ -14,6 +18,8 @@
 @SuppressFBWarnings(value = { "UWF_UNWRITTEN_FIELD", "NP_UNWRITTEN_FIELD", "URF_UNREAD_FIELD" },
         justification = "JSON API")
 public class GHCheckRun extends GHObject {
+
+    @JsonProperty("repository")
     GHRepository owner;
     GitHub root;
 
@@ -34,15 +40,32 @@ public class GHCheckRun extends GHObject {
 
     GHCheckRun wrap(GHRepository owner) {
         this.owner = owner;
-        this.root = owner.root;
+        wrap(owner.root);
         return this;
     }
 
     GHCheckRun wrap(GitHub root) {
         this.root = root;
         if (owner != null) {
             owner.wrap(root);
+            if (pullRequests != null && pullRequests.length != 0) {
+                for (GHPullRequest singlePull : pullRequests) {
+                    singlePull.wrap(owner);
+                }
+            }
+
+        }
+        if (checkSuite != null) {
+            if (owner != null) {
+                checkSuite.wrap(owner);
+            } else {
+                checkSuite.wrap(root);
+            }
         }
+        if (app != null) {
+            app.wrapUp(root);
+        }
+
         return this;
     }
 
@@ -105,15 +128,22 @@ public String getHeadSha() {
     /**
      * Gets the pull requests participated in this check run.
      *
-     * @return Pull requests of this check run
+     * Note this field is only populated for events. When getting a {@link GHCheckRun} outside of an event, this is
+     * always empty.
+     *
+     * @return the list of {@link GHPullRequest}s for this check run. Only populated for events.
+     * @throws IOException
+     *             the io exception
      */
-    GHPullRequest[] getPullRequests() throws IOException {
+    public List<GHPullRequest> getPullRequests() throws IOException {
         if (pullRequests != null && pullRequests.length != 0) {
             for (GHPullRequest singlePull : pullRequests) {
-                singlePull.refresh();
+                // Only refresh if we haven't do so before
+                singlePull.refresh(singlePull.getTitle());
             }
+            return Collections.unmodifiableList(Arrays.asList(pullRequests));
         }
-        return pullRequests;
+        return Collections.emptyList();
     }
 
     /**

src/main/java/org/kohsuke/github/GHCheckSuite.java

@@ -1,10 +1,14 @@
 package org.kohsuke.github;
 
+import com.fasterxml.jackson.annotation.JsonProperty;
 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 
 import java.io.IOException;
 import java.net.URL;
+import java.util.Arrays;
+import java.util.Collections;
 import java.util.Date;
+import java.util.List;
 
 /**
  * Represents a check suite.
@@ -14,6 +18,8 @@
 @SuppressFBWarnings(value = { "UWF_UNWRITTEN_FIELD", "NP_UNWRITTEN_FIELD", "URF_UNREAD_FIELD" },
         justification = "JSON API")
 public class GHCheckSuite extends GHObject {
+
+    @JsonProperty("repository")
     GHRepository owner;
     GitHub root;
 
@@ -32,14 +38,22 @@ public class GHCheckSuite extends GHObject {
 
     GHCheckSuite wrap(GHRepository owner) {
         this.owner = owner;
-        this.root = owner.root;
+        this.wrap(owner.root);
         return this;
     }
 
     GHCheckSuite wrap(GitHub root) {
         this.root = root;
         if (owner != null) {
             owner.wrap(root);
+            if (pullRequests != null && pullRequests.length != 0) {
+                for (GHPullRequest singlePull : pullRequests) {
+                    singlePull.wrap(owner);
+                }
+            }
+        }
+        if (app != null) {
+            app.wrapUp(root);
         }
         return this;
     }
@@ -153,15 +167,22 @@ public GHApp getApp() {
     /**
      * Gets the pull requests participated in this check suite.
      *
-     * @return Pull requests
+     * Note this field is only populated for events. When getting a {@link GHCheckSuite} outside of an event, this is
+     * always empty.
+     *
+     * @return the list of {@link GHPullRequest}s for this check suite. Only populated for events.
+     * @throws IOException
+     *             the io exception
      */
-    GHPullRequest[] getPullRequests() throws IOException {
+    public List<GHPullRequest> getPullRequests() throws IOException {
         if (pullRequests != null && pullRequests.length != 0) {
             for (GHPullRequest singlePull : pullRequests) {
-                singlePull.refresh();
+                // Only refresh if we haven't do so before
+                singlePull.refresh(singlePull.getTitle());
             }
+            return Collections.unmodifiableList(Arrays.asList(pullRequests));
         }
-        return pullRequests;
+        return Collections.emptyList();
     }
 
     /**

src/test/java/org/kohsuke/github/GHEventPayloadTest.java

@@ -3,6 +3,7 @@
 import org.junit.Rule;
 import org.junit.Test;
 
+import java.io.IOException;
 import java.text.SimpleDateFormat;
 import java.util.Collections;
 import java.util.TimeZone;
@@ -387,7 +388,25 @@ public void status() throws Exception {
     @Payload("check-run")
     public void checkRunEvent() throws Exception {
         GHEventPayload.CheckRun event = GitHub.offline()
-                .parseEventPayload(payload.asReader(), GHEventPayload.CheckRun.class);
+                .parseEventPayload(payload.asReader(mockGitHub::mapToMockGitHub), GHEventPayload.CheckRun.class);
+        GHCheckRun checkRun = verifyBasicCheckRunEvent(event);
+        assertThat("pull body not populated offline", checkRun.getPullRequests().get(0).getBody(), nullValue());
+        assertThat("using offline github", mockGitHub.getRequestCount(), equalTo(0));
+
+        gitHub = getGitHubBuilder().withEndpoint(mockGitHub.apiServer().baseUrl()).build();
+        event = gitHub.parseEventPayload(payload.asReader(mockGitHub::mapToMockGitHub), GHEventPayload.CheckRun.class);
+        checkRun = verifyBasicCheckRunEvent(event);
+
+        int expectedRequestCount = mockGitHub.isUseProxy() ? 3 : 2;
+        assertThat("pull body should be populated",
+                checkRun.getPullRequests().get(0).getBody(),
+                equalTo("This is a pretty simple change that we need to pull into master."));
+        assertThat("multiple getPullRequests() calls are made, the pull is populated only once",
+                mockGitHub.getRequestCount(),
+                equalTo(expectedRequestCount));
+    }
+
+    private GHCheckRun verifyBasicCheckRunEvent(GHEventPayload.CheckRun event) throws IOException {
         assertThat(event.getRepository().getName(), is("Hello-World"));
         assertThat(event.getRepository().getOwner().getLogin(), is("Codertocat"));
         assertThat(event.getAction(), is("created"));
@@ -406,9 +425,9 @@ public void checkRunEvent() throws Exception {
         assertThat(formatter.format(checkRun.getCompletedAt()), is("2019-05-15T20:22:22Z"));
 
         assertThat(checkRun.getConclusion(), is("success"));
-        assertThat(checkRun.getUrl().toString(),
-                is("https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228"));
-        assertThat(checkRun.getHtmlUrl().toString(), is("https://github.com/Codertocat/Hello-World/runs/128620228"));
+        assertThat(checkRun.getUrl().toString(), endsWith("/repos/Codertocat/Hello-World/check-runs/128620228"));
+        assertThat(checkRun.getHtmlUrl().toString(),
+                endsWith("https://github.com/Codertocat/Hello-World/runs/128620228"));
         assertThat(checkRun.getDetailsUrl().toString(), is("https://octocoders.io"));
         assertThat(checkRun.getApp().getId(), is(29310L));
         assertThat(checkRun.getCheckSuite().getId(), is(118578147L));
@@ -417,18 +436,41 @@ public void checkRunEvent() throws Exception {
         assertThat(checkRun.getOutput().getText(), nullValue());
         assertThat(checkRun.getOutput().getAnnotationsCount(), is(0));
         assertThat(checkRun.getOutput().getAnnotationsUrl().toString(),
-                is("https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228/annotations"));
+                endsWith("/repos/Codertocat/Hello-World/check-runs/128620228/annotations"));
 
         // Checks the deserialization of sender
         assertThat(event.getSender().getId(), is(21031067L));
+
+        assertThat(checkRun.getPullRequests(), notNullValue());
+        assertThat(checkRun.getPullRequests().size(), equalTo(1));
+        assertThat(checkRun.getPullRequests().get(0).getNumber(), equalTo(2));
+        return checkRun;
     }
 
     @Test
     @Payload("check-suite")
     public void checkSuiteEvent() throws Exception {
         GHEventPayload.CheckSuite event = GitHub.offline()
-                .parseEventPayload(payload.asReader(), GHEventPayload.CheckSuite.class);
+                .parseEventPayload(payload.asReader(mockGitHub::mapToMockGitHub), GHEventPayload.CheckSuite.class);
+        GHCheckSuite checkSuite = verifyBasicCheckSuiteEvent(event);
+        assertThat("pull body not populated offline", checkSuite.getPullRequests().get(0).getBody(), nullValue());
+        assertThat("using offline github", mockGitHub.getRequestCount(), equalTo(0));
 
+        gitHub = getGitHubBuilder().withEndpoint(mockGitHub.apiServer().baseUrl()).build();
+        event = gitHub.parseEventPayload(payload.asReader(mockGitHub::mapToMockGitHub),
+                GHEventPayload.CheckSuite.class);
+        checkSuite = verifyBasicCheckSuiteEvent(event);
+
+        int expectedRequestCount = mockGitHub.isUseProxy() ? 3 : 2;
+        assertThat("pull body should be populated",
+                checkSuite.getPullRequests().get(0).getBody(),
+                equalTo("This is a pretty simple change that we need to pull into master."));
+        assertThat("multiple getPullRequests() calls are made, the pull is populated only once",
+                mockGitHub.getRequestCount(),
+                lessThanOrEqualTo(expectedRequestCount));
+    }
+
+    private GHCheckSuite verifyBasicCheckSuiteEvent(GHEventPayload.CheckSuite event) throws IOException {
         assertThat(event.getRepository().getName(), is("Hello-World"));
         assertThat(event.getRepository().getOwner().getLogin(), is("Codertocat"));
         assertThat(event.getAction(), is("completed"));
@@ -445,7 +487,7 @@ public void checkSuiteEvent() throws Exception {
         assertThat(checkSuite.getAfter(), is("ec26c3e57ca3a959ca5aad62de7213c562f8c821"));
         assertThat(checkSuite.getLatestCheckRunsCount(), is(1));
         assertThat(checkSuite.getCheckRunsUrl().toString(),
-                is("https://api.github.com/repos/Codertocat/Hello-World/check-suites/118578147/check-runs"));
+                endsWith("/repos/Codertocat/Hello-World/check-suites/118578147/check-runs"));
         assertThat(checkSuite.getHeadCommit().getMessage(), is("Update README.md"));
         assertThat(checkSuite.getHeadCommit().getId(), is("ec26c3e57ca3a959ca5aad62de7213c562f8c821"));
         assertThat(checkSuite.getHeadCommit().getTreeId(), is("31b122c26a97cf9af023e9ddab94a82c6e77b0ea"));
@@ -457,6 +499,11 @@ public void checkSuiteEvent() throws Exception {
         assertThat(formatter.format(checkSuite.getHeadCommit().getTimestamp()), is("2019-05-15T15:20:30Z"));
 
         assertThat(checkSuite.getApp().getId(), is(29310L));
+
+        assertThat(checkSuite.getPullRequests(), notNullValue());
+        assertThat(checkSuite.getPullRequests().size(), equalTo(1));
+        assertThat(checkSuite.getPullRequests().get(0).getNumber(), equalTo(2));
+        return checkSuite;
     }
 
     @Test