Merge branch 'master' into add-create-repo-with-template-support

Author: bitwiseman

pom.xml

@@ -34,7 +34,7 @@
   <properties>
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     <spotbugs-maven-plugin.version>4.0.4</spotbugs-maven-plugin.version>
-    <spotbugs.version>4.0.6</spotbugs.version>
+    <spotbugs.version>4.1.1</spotbugs.version>
     <spotbugs-maven-plugin.failOnError>true</spotbugs-maven-plugin.failOnError>
     <hamcrest.version>2.2</hamcrest.version>
     <okhttp3.version>4.4.1</okhttp3.version>
@@ -519,7 +519,7 @@
     <dependency>
       <groupId>org.mockito</groupId>
       <artifactId>mockito-core</artifactId>
-      <version>3.4.4</version>
+      <version>3.4.6</version>
       <scope>test</scope>
     </dependency>
     <dependency>

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

@@ -9,6 +9,8 @@
 import java.util.Collection;
 import java.util.Objects;
 
+import javax.annotation.CheckForNull;
+
 /**
  * A branch in a repository.
  *
@@ -165,6 +167,59 @@ public void enableProtection(EnforcementLevel level, Collection<String> contexts
         }
     }
 
+    /**
+     * Merge a branch into this branch.
+     *
+     * @param headBranch
+     *            the branch whose head will be merged
+     *
+     * @param commitMessage
+     *            the commit message
+     *
+     * @return the merge {@link GHCommit} created, or {@code null} if the base already contains the head (nothing to
+     *         merge).
+     *
+     * @throws IOException
+     *             if merging fails
+     */
+    @CheckForNull
+    public GHCommit merge(GHBranch headBranch, String commitMessage) throws IOException {
+        return merge(headBranch.getName(), commitMessage);
+    }
+
+    /**
+     * Merge a ref into this branch.
+     *
+     * @param head
+     *            the ref name that will be merged into this branch. Follows the usual ref naming rules, could be a
+     *            branch name, tag, or commit sha.
+     *
+     * @param commitMessage
+     *            the commit message
+     *
+     * @return the merge {@link GHCommit} created, or {@code null} if the base already contains the head (nothing to
+     *         merge).
+     *
+     * @throws IOException
+     *             if merging fails
+     */
+    @CheckForNull
+    public GHCommit merge(String head, String commitMessage) throws IOException {
+        GHCommit result = root.createRequest()
+                .withUrlPath(owner.getApiTailUrl("merges"))
+                .method("POST")
+                .with("commit_message", commitMessage)
+                .with("base", this.name)
+                .with("head", head)
+                .fetch(GHCommit.class);
+
+        if (result != null) {
+            result.wrapUp(owner);
+        }
+
+        return result;
+    }
+
     String getApiRoute() {
         return owner.getApiTailUrl("/branches/" + name);
     }

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/main/java/org/kohsuke/github/GHEvent.java

@@ -63,6 +63,7 @@ public enum GHEvent {
     TEAM_ADD,
     WATCH,
     WORKFLOW_DISPATCH,
+    WORKFLOW_RUN,
 
     /**
      * Special event type that means "every possible event"

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

@@ -239,7 +239,7 @@ private void editNullable(String key, Object value) throws IOException {
     }
 
     private void editIssue(String key, Object value) throws IOException {
-        root.createRequest().with(key, value).method("PATCH").withUrlPath(getIssuesApiRoute()).send();
+        root.createRequest().withNullable(key, value).method("PATCH").withUrlPath(getIssuesApiRoute()).send();
     }
 
     /**
@@ -296,9 +296,9 @@ public void setBody(String body) throws IOException {
      */
     public void setMilestone(GHMilestone milestone) throws IOException {
         if (milestone == null) {
-            editNullable("milestone", null);
+            editIssue("milestone", null);
         } else {
-            edit("milestone", milestone.getNumber());
+            editIssue("milestone", milestone.getNumber());
         }
     }
 

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

@@ -465,7 +465,7 @@ public GHProject createProject(String name, String body) throws IOException {
      * The enum Permission.
      */
     public enum Permission {
-        ADMIN, PUSH, PULL
+        ADMIN, MAINTAIN, PUSH, TRIAGE, PULL
     }
 
     /**

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

@@ -532,7 +532,7 @@ public PagedIterable<GHOrganization> listOrganizations(final String since) {
     }
 
     /**
-     * Gets the repository object from 'user/reponame' string that GitHub calls as "repository name"
+     * Gets the repository object from 'owner/repo' string that GitHub calls as "repository name"
      *
      * @param name
      *            the name
@@ -543,6 +543,9 @@ public PagedIterable<GHOrganization> listOrganizations(final String since) {
      */
     public GHRepository getRepository(String name) throws IOException {
         String[] tokens = name.split("/");
+        if (tokens.length < 2) {
+            throw new IllegalArgumentException("Repository name must be in format owner/repo");
+        }
         return createRequest().withUrlPath("/repos/" + tokens[0] + '/' + tokens[1])
                 .fetch(GHRepository.class)
                 .wrap(this);

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

@@ -78,9 +78,14 @@ class GitHubResponse<T> {
     @CheckForNull
     static <T> T parseBody(ResponseInfo responseInfo, Class<T> type) throws IOException {
 
-        if (responseInfo.statusCode() == HttpURLConnection.HTTP_NO_CONTENT && type != null && type.isArray()) {
-            // no content
-            return type.cast(Array.newInstance(type.getComponentType(), 0));
+        if (responseInfo.statusCode() == HttpURLConnection.HTTP_NO_CONTENT) {
+            if (type != null && type.isArray()) {
+                // no content for array should be empty array
+                return type.cast(Array.newInstance(type.getComponentType(), 0));
+            } else {
+                // no content for object should be null
+                return null;
+            }
         }
 
         String data = responseInfo.getBodyAsString();

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

@@ -0,0 +1,47 @@
+package org.kohsuke.github;
+
+import org.junit.Test;
+
+import java.io.IOException;
+
+import static org.hamcrest.Matchers.*;
+
+public class GHBranchTest extends AbstractGitHubWireMockTest {
+    private static final String BRANCH_1 = "testBranch1";
+    private static final String BRANCH_2 = "testBranch2";
+
+    private GHRepository repository;
+
+    @Test
+    public void testMergeBranch() throws Exception {
+        repository = getTempRepository();
+
+        String masterHead = repository.getRef("heads/master").getObject().getSha();
+        createRefAndPostContent(BRANCH_1, masterHead);
+        createRefAndPostContent(BRANCH_2, masterHead);
+
+        GHBranch otherBranch = repository.getBranch(BRANCH_2);
+        String commitMessage = "merging " + BRANCH_2;
+        GHCommit mergeCommit = repository.getBranch(BRANCH_1).merge(otherBranch, commitMessage);
+        assertThat(mergeCommit, notNullValue());
+        assertThat(mergeCommit.getCommitShortInfo().getMessage(), equalTo(commitMessage));
+
+        // Merging commit sha should work
+        commitMessage = "merging from " + mergeCommit.getSHA1();
+        GHBranch master = repository.getBranch("master");
+        mergeCommit = master.merge(mergeCommit.getSHA1(), commitMessage);
+
+        assertThat(mergeCommit, notNullValue());
+        assertThat(mergeCommit.getCommitShortInfo().getMessage(), equalTo(commitMessage));
+
+        mergeCommit = master.merge(mergeCommit.getSHA1(), commitMessage);
+        // Should be null since all changes already merged
+        assertThat(mergeCommit, nullValue());
+    }
+
+    private void createRefAndPostContent(String branchName, String sha) throws IOException {
+        String refName = "refs/heads/" + branchName;
+        repository.createRef(refName, sha);
+        repository.createContent().content(branchName).message(branchName).path(branchName).branch(branchName).commit();
+    }
+}