From e74346fed6d5206d8ab54e4dab5542df597ddd87 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Lesaint?= Date: Mon, 4 Dec 2017 11:11:58 +0100 Subject: [PATCH] support create PR review in single API call & remove @Preview --- .../org/kohsuke/github/GHPullRequest.java | 74 ++++++++---- .../kohsuke/github/GHPullRequestReview.java | 113 ++---------------- .../github/GHPullRequestReviewAbstract.java | 101 ++++++++++++++++ .../github/GHPullRequestReviewDraft.java | 53 ++++++++ .../org/kohsuke/github/PullRequestTest.java | 8 +- 5 files changed, 217 insertions(+), 132 deletions(-) create mode 100644 src/main/java/org/kohsuke/github/GHPullRequestReviewAbstract.java create mode 100644 src/main/java/org/kohsuke/github/GHPullRequestReviewDraft.java diff --git a/src/main/java/org/kohsuke/github/GHPullRequest.java b/src/main/java/org/kohsuke/github/GHPullRequest.java index 369dff911..5a62936f8 100644 --- a/src/main/java/org/kohsuke/github/GHPullRequest.java +++ b/src/main/java/org/kohsuke/github/GHPullRequest.java @@ -23,6 +23,7 @@ */ package org.kohsuke.github; +import javax.annotation.Nullable; import java.io.IOException; import java.net.URL; import java.util.ArrayList; @@ -35,13 +36,16 @@ import static org.kohsuke.github.Previews.*; /** * A pull request. - * + * * @author Kohsuke Kawaguchi * @see GHRepository#getPullRequest(int) */ @SuppressWarnings({"UnusedDeclaration"}) public class GHPullRequest extends GHIssue { + private static final String COMMENTS_ACTION = "/comments"; + private static final String COMMIT_ID_FIELD = "commit_id"; + private String patch_url, diff_url, issue_url; private GHCommitPointer base; private String merged_at; @@ -245,7 +249,6 @@ public class GHPullRequest extends GHIssue { return new PagedIterable() { public PagedIterator _iterator(int pageSize) { return new PagedIterator(root.retrieve() - .withPreview(BLACK_CAT) .asIterator(String.format("%s/reviews", getApiRoute()), GHPullRequestReview[].class, pageSize)) { @Override @@ -265,7 +268,7 @@ public class GHPullRequest extends GHIssue { public PagedIterable listReviewComments() throws IOException { return new PagedIterable() { public PagedIterator _iterator(int pageSize) { - return new PagedIterator(root.retrieve().asIterator(getApiRoute() + "/comments", + return new PagedIterator(root.retrieve().asIterator(getApiRoute() + COMMENTS_ACTION, GHPullRequestReviewComment[].class, pageSize)) { protected void wrapUp(GHPullRequestReviewComment[] page) { for (GHPullRequestReviewComment c : page) @@ -295,37 +298,58 @@ public class GHPullRequest extends GHIssue { }; } - @Preview - @Deprecated - public GHPullRequestReview createReview(String body, GHPullRequestReviewComment... comments) - throws IOException { - return createReview(body, Arrays.asList(comments)); + public GHPullRequestReview createReview(@Nullable String commitId, String body, GHPullRequestReviewEvent event, + GHPullRequestReviewComment... comments) throws IOException { + return createReview(commitId, body, event, Arrays.asList(comments)); } - @Preview - @Deprecated - public GHPullRequestReview createReview(String body, List comments) + public GHPullRequestReview createReview(@Nullable String commitId, String body, GHPullRequestReviewEvent event, + List comments) throws IOException { + List draftComments = toDraftReviewComments(comments); + return new Requester(root).method("POST") + .with(COMMIT_ID_FIELD, commitId) + .with("body", body) + .with("event", event.action()) + ._with("comments", draftComments) + .to(getApiRoute() + "/reviews", GHPullRequestReview.class) + .wrapUp(this); + } + + public GHPullRequestReviewDraft newDraftReview(@Nullable String commitId, String body, GHPullRequestReviewComment... comments) throws IOException { + return newDraftReview(commitId, body, Arrays.asList(comments)); + } + + public GHPullRequestReviewDraft newDraftReview(@Nullable String commitId, String body, List comments) + throws IOException { + List draftComments = toDraftReviewComments(comments); + return new Requester(root).method("POST") + .with(COMMIT_ID_FIELD, commitId) + .with("body", body) + ._with("comments", draftComments) + .to(getApiRoute() + "/reviews", GHPullRequestReviewDraft.class) + .wrapUp(this); + } + + private static List toDraftReviewComments(List comments) { List draftComments = new ArrayList(comments.size()); for (GHPullRequestReviewComment c : comments) { Integer position = c.getPosition(); - draftComments.add(new DraftReviewComment(c.getBody(), c.getPath(), position == null ? 0 : position /*FIXME do not use GHPullRequestReviewComment for new comments*/)); + if (position == null) { + throw new IllegalArgumentException("GHPullRequestReviewComment must have a position"); + } + draftComments.add(new DraftReviewComment(c.getBody(), c.getPath(), position)); } - return new Requester(root).method("POST") - .with("body", body) - //.with("event", event.name()) - ._with("comments", draftComments) - .withPreview(BLACK_CAT) - .to(getApiRoute() + "/reviews", GHPullRequestReview.class).wrapUp(this); + return draftComments; } public GHPullRequestReviewComment createReviewComment(String body, String sha, String path, int position) throws IOException { return new Requester(root).method("POST") .with("body", body) - .with("commit_id", sha) + .with(COMMIT_ID_FIELD, sha) .with("path", path) .with("position", position) - .to(getApiRoute() + "/comments", GHPullRequestReviewComment.class).wrapUp(this); + .to(getApiRoute() + COMMENTS_ACTION, GHPullRequestReviewComment.class).wrapUp(this); } /** @@ -335,7 +359,7 @@ public class GHPullRequest extends GHIssue { return new Requester(owner.root).method("POST") .with("body", body) .with("in_reply_to", comment.getId()) - .to(getApiRoute() + "/comments", GHPullRequestReviewComment.class) + .to(getApiRoute() + COMMENTS_ACTION, GHPullRequestReviewComment.class) .wrapUp(this); } @@ -377,10 +401,10 @@ public class GHPullRequest extends GHIssue { */ public void merge(String msg, String sha, MergeMethod method) throws IOException { new Requester(root).method("PUT") - .with("commit_message",msg) - .with("sha",sha) - .with("merge_method",method) - .to(getApiRoute()+"/merge"); + .with("commit_message", msg) + .with("sha", sha) + .with("merge_method", method) + .to(getApiRoute() + "/merge"); } public enum MergeMethod{ MERGE, SQUASH, REBASE } diff --git a/src/main/java/org/kohsuke/github/GHPullRequestReview.java b/src/main/java/org/kohsuke/github/GHPullRequestReview.java index c96e8f149..3bb155b88 100644 --- a/src/main/java/org/kohsuke/github/GHPullRequestReview.java +++ b/src/main/java/org/kohsuke/github/GHPullRequestReview.java @@ -24,127 +24,34 @@ package org.kohsuke.github; import java.io.IOException; -import java.net.URL; -import javax.annotation.CheckForNull; - -import static org.kohsuke.github.Previews.*; +import java.util.List; /** * Review to the pull request * * @see GHPullRequest#listReviews() - * @see GHPullRequest#createReview(String, GHPullRequestReviewComment...) + * @see GHPullRequest#createReview(String, String, GHPullRequestReviewEvent, List) */ -public class GHPullRequestReview extends GHObject { - GHPullRequest owner; - - private String body; - private GHUser user; - private String commit_id; +public class GHPullRequestReview extends GHPullRequestReviewAbstract { private GHPullRequestReviewState state; - /*package*/ GHPullRequestReview wrapUp(GHPullRequest owner) { + @Override + public GHPullRequestReviewState getState() { + return state; + } + + GHPullRequestReview wrapUp(GHPullRequest owner) { this.owner = owner; return this; } - /** - * Gets the pull request to which this review is associated. - */ - public GHPullRequest getParent() { - return owner; - } - - /** - * The comment itself. - */ - public String getBody() { - return body; - } - - /** - * Gets the user who posted this review. - */ - public GHUser getUser() throws IOException { - return owner.root.getUser(user.getLogin()); - } - - public String getCommitId() { - return commit_id; - } - - @CheckForNull - public GHPullRequestReviewState getState() { - return state; - } - - @Override - public URL getHtmlUrl() { - return null; - } - - protected String getApiRoute() { - return owner.getApiRoute()+"/reviews/"+id; - } - - /** - * Updates the comment. - */ - @Preview - @Deprecated - public void submit(String body, GHPullRequestReviewEvent event) throws IOException { - new Requester(owner.root).method("POST") - .with("body", body) - .with("event", event.action()) - .withPreview("application/vnd.github.black-cat-preview+json") - .to(getApiRoute()+"/events",this); - this.body = body; - } - - /** - * Deletes this review. - */ - @Preview - @Deprecated - public void delete() throws IOException { - new Requester(owner.root).method("DELETE") - .withPreview(BLACK_CAT) - .to(getApiRoute()); - } - /** * Dismisses this review. */ - @Preview - @Deprecated public void dismiss(String message) throws IOException { new Requester(owner.root).method("PUT") .with("message", message) - .withPreview(BLACK_CAT) - .to(getApiRoute()+"/dismissals"); + .to(getApiRoute() + "/dismissals"); state = GHPullRequestReviewState.DISMISSED; } - - /** - * Obtains all the review comments associated with this pull request review. - */ - @Preview - @Deprecated - public PagedIterable listReviewComments() throws IOException { - return new PagedIterable() { - public PagedIterator _iterator(int pageSize) { - return new PagedIterator( - owner.root.retrieve() - .withPreview(BLACK_CAT) - .asIterator(getApiRoute() + "/comments", - GHPullRequestReviewComment[].class, pageSize)) { - protected void wrapUp(GHPullRequestReviewComment[] page) { - for (GHPullRequestReviewComment c : page) - c.wrapUp(owner); - } - }; - } - }; - } - } diff --git a/src/main/java/org/kohsuke/github/GHPullRequestReviewAbstract.java b/src/main/java/org/kohsuke/github/GHPullRequestReviewAbstract.java new file mode 100644 index 000000000..4842a6208 --- /dev/null +++ b/src/main/java/org/kohsuke/github/GHPullRequestReviewAbstract.java @@ -0,0 +1,101 @@ +/* + * The MIT License + * + * Copyright (c) 2011, Eric Maupin + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. + */ +package org.kohsuke.github; + +import edu.umd.cs.findbugs.annotations.SuppressFBWarnings; + +import java.io.IOException; +import java.net.URL; + +@SuppressFBWarnings(value = {"UWF_UNWRITTEN_FIELD"}, justification = "JSON API") +public abstract class GHPullRequestReviewAbstract extends GHObject { + protected GHPullRequest owner; + + protected String body; + private GHUser user; + private String commit_id; + + public abstract GHPullRequestReviewState getState(); + + /** + * Gets the pull request to which this review is associated. + */ + public GHPullRequest getParent() { + return owner; + } + + /** + * The comment itself. + */ + public String getBody() { + return body; + } + + /** + * Gets the user who posted this review. + */ + public GHUser getUser() throws IOException { + return owner.root.getUser(user.getLogin()); + } + + public String getCommitId() { + return commit_id; + } + + @Override + public URL getHtmlUrl() { + return null; + } + + String getApiRoute() { + return owner.getApiRoute() + "/reviews/" + id; + } + + /** + * Deletes this review. + */ + public void delete() throws IOException { + new Requester(owner.root).method("DELETE") + .to(getApiRoute()); + } + + /** + * Obtains all the review comments associated with this pull request review. + */ + public PagedIterable listReviewComments() { + return new PagedIterable() { + public PagedIterator _iterator(int pageSize) { + return new PagedIterator( + owner.root.retrieve() + .asIterator(getApiRoute() + "/comments", + GHPullRequestReviewComment[].class, pageSize)) { + protected void wrapUp(GHPullRequestReviewComment[] page) { + for (GHPullRequestReviewComment c : page) + c.wrapUp(owner); + } + }; + } + }; + } +} diff --git a/src/main/java/org/kohsuke/github/GHPullRequestReviewDraft.java b/src/main/java/org/kohsuke/github/GHPullRequestReviewDraft.java new file mode 100644 index 000000000..689d061bc --- /dev/null +++ b/src/main/java/org/kohsuke/github/GHPullRequestReviewDraft.java @@ -0,0 +1,53 @@ +/* + * The MIT License + * + * Copyright (c) 2011, Eric Maupin + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. + */ +package org.kohsuke.github; + +import java.io.IOException; + +/** + * Draft of a Pull Request review. + * + * @see GHPullRequest#newDraftReview(String, String, GHPullRequestReviewComment...) + */ +public class GHPullRequestReviewDraft extends GHPullRequestReviewAbstract { + + GHPullRequestReviewDraft wrapUp(GHPullRequest owner) { + this.owner = owner; + return this; + } + + @Override + public GHPullRequestReviewState getState() { + return GHPullRequestReviewState.PENDING; + } + + public void submit(String body, GHPullRequestReviewEvent event) throws IOException { + new Requester(owner.root).method("POST") + .with("body", body) + .with("event", event.action()) + .to(getApiRoute() + "/events", this); + this.body = body; + } + +} diff --git a/src/test/java/org/kohsuke/github/PullRequestTest.java b/src/test/java/org/kohsuke/github/PullRequestTest.java index bf45e35c4..97826baea 100644 --- a/src/test/java/org/kohsuke/github/PullRequestTest.java +++ b/src/test/java/org/kohsuke/github/PullRequestTest.java @@ -33,7 +33,7 @@ public class PullRequestTest extends AbstractGitHubApiTestBase { public void testPullRequestReviews() throws Exception { String name = rnd.next(); GHPullRequest p = getRepository().createPullRequest(name, "stable", "master", "## test"); - GHPullRequestReview draftReview = p.createReview("Some draft review", null, + GHPullRequestReviewDraft draftReview = p.newDraftReview(null, "Some draft review", GHPullRequestReviewComment.draft("Some niggle", "changelog.html", 1) ); assertThat(draftReview.getState(), is(GHPullRequestReviewState.PENDING)); @@ -45,15 +45,15 @@ public class PullRequestTest extends AbstractGitHubApiTestBase { assertThat(review.getState(), is(GHPullRequestReviewState.PENDING)); assertThat(review.getBody(), is("Some draft review")); assertThat(review.getCommitId(), notNullValue()); - review.submit("Some review comment", GHPullRequestReviewEvent.COMMENT); + draftReview.submit("Some review comment", GHPullRequestReviewEvent.COMMENT); List comments = review.listReviewComments().asList(); assertEquals(1, comments.size()); GHPullRequestReviewComment comment = comments.get(0); assertEquals("Some niggle", comment.getBody()); - review = p.createReview("Some new review", null, + draftReview = p.newDraftReview(null, "Some new review", GHPullRequestReviewComment.draft("Some niggle", "changelog.html", 1) ); - review.delete(); + draftReview.delete(); } @Test