/
GHPullRequestTest.java
811 lines (698 loc) · 32.1 KB
/
GHPullRequestTest.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
package org.kohsuke.github;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.kohsuke.github.GHPullRequest.AutoMerge;
import java.io.IOException;
import java.time.temporal.ChronoUnit;
import java.util.Collection;
import java.util.Collections;
import java.util.Date;
import java.util.List;
import java.util.Optional;
import static org.hamcrest.Matchers.*;
// TODO: Auto-generated Javadoc
/**
* The Class GHPullRequestTest.
*
* @author Kohsuke Kawaguchi
*/
public class GHPullRequestTest extends AbstractGitHubWireMockTest {
/**
* Clean up.
*
* @throws Exception the exception
*/
@Before
@After
public void cleanUp() throws Exception {
// Cleanup is only needed when proxying
if (!mockGitHub.isUseProxy()) {
return;
}
for (GHPullRequest pr : getRepository(this.getNonRecordingGitHub()).getPullRequests(GHIssueState.OPEN)) {
pr.close();
}
}
/**
* Creates the pull request.
*
* @throws Exception the exception
*/
@Test
public void createPullRequest() throws Exception {
String name = "createPullRequest";
GHRepository repo = getRepository();
GHPullRequest p = repo.createPullRequest(name, "test/stable", "main", "## test");
assertThat(p.getTitle(), equalTo(name));
assertThat(p.canMaintainerModify(), is(false));
assertThat(p.isDraft(), is(false));
// Check auto merge status of the pull request
final AutoMerge autoMerge = p.getAutoMerge();
assertThat(autoMerge, is(notNullValue()));
assertThat(autoMerge.getCommitMessage(), equalTo("This is a auto merged squash commit message"));
assertThat(autoMerge.getCommitTitle(), equalTo("This is a auto merged squash commit"));
assertThat(autoMerge.getMergeMethod(), equalTo(GHPullRequest.MergeMethod.SQUASH));
assertThat(autoMerge.getEnabledBy(), is(notNullValue()));
}
/**
* Creates the draft pull request.
*
* @throws Exception the exception
*/
@Test
public void createDraftPullRequest() throws Exception {
String name = "createDraftPullRequest";
GHRepository repo = getRepository();
GHPullRequest p = repo.createPullRequest(name, "test/stable", "main", "## test", false, true);
assertThat(p.getTitle(), equalTo(name));
assertThat(p.canMaintainerModify(), is(false));
assertThat(p.isDraft(), is(true));
// There are multiple paths to get PRs and each needs to read draft correctly
p.draft = false;
p.refresh();
assertThat(p.isDraft(), is(true));
GHPullRequest p2 = repo.getPullRequest(p.getNumber());
assertThat(p2.getNumber(), is(p.getNumber()));
assertThat(p2.isDraft(), is(true));
p = repo.queryPullRequests().state(GHIssueState.OPEN).head("test/stable").list().toList().get(0);
assertThat(p2.getNumber(), is(p.getNumber()));
assertThat(p.isDraft(), is(true));
}
/**
* Pull request comment.
*
* @throws Exception the exception
*/
@Test
public void pullRequestComment() throws Exception {
String name = "createPullRequestComment";
GHPullRequest p = getRepository().createPullRequest(name, "test/stable", "main", "## test");
List<GHIssueComment> comments;
comments = p.listComments().toList();
assertThat(comments, hasSize(0));
comments = p.queryComments().list().toList();
assertThat(comments, hasSize(0));
GHIssueComment firstComment = p.comment("First comment");
Date firstCommentCreatedAt = firstComment.getCreatedAt();
Date firstCommentCreatedAtPlus1Second = Date
.from(firstComment.getCreatedAt().toInstant().plus(1, ChronoUnit.SECONDS));
comments = p.listComments().toList();
assertThat(comments, hasSize(1));
assertThat(comments, contains(hasProperty("body", equalTo("First comment"))));
comments = p.queryComments().list().toList();
assertThat(comments, hasSize(1));
assertThat(comments, contains(hasProperty("body", equalTo("First comment"))));
// Test "since"
comments = p.queryComments().since(firstCommentCreatedAt).list().toList();
assertThat(comments, hasSize(1));
assertThat(comments, contains(hasProperty("body", equalTo("First comment"))));
comments = p.queryComments().since(firstCommentCreatedAtPlus1Second).list().toList();
assertThat(comments, hasSize(0));
// "since" is only precise up to the second,
// so if we want to differentiate comments, we need to be completely sure they're created
// at least 1 second from each other.
// Waiting 2 seconds to avoid edge cases.
Thread.sleep(2000);
GHIssueComment secondComment = p.comment("Second comment");
Date secondCommentCreatedAt = secondComment.getCreatedAt();
Date secondCommentCreatedAtPlus1Second = Date
.from(secondComment.getCreatedAt().toInstant().plus(1, ChronoUnit.SECONDS));
assertThat(
"There's an error in the setup of this test; please fix it."
+ " The second comment should be created at least one second after the first one.",
firstCommentCreatedAtPlus1Second.getTime() <= secondCommentCreatedAt.getTime());
comments = p.listComments().toList();
assertThat(comments, hasSize(2));
assertThat(comments,
contains(hasProperty("body", equalTo("First comment")),
hasProperty("body", equalTo("Second comment"))));
comments = p.queryComments().list().toList();
assertThat(comments, hasSize(2));
assertThat(comments,
contains(hasProperty("body", equalTo("First comment")),
hasProperty("body", equalTo("Second comment"))));
// Test "since"
comments = p.queryComments().since(firstCommentCreatedAt).list().toList();
assertThat(comments, hasSize(2));
assertThat(comments,
contains(hasProperty("body", equalTo("First comment")),
hasProperty("body", equalTo("Second comment"))));
comments = p.queryComments().since(firstCommentCreatedAtPlus1Second).list().toList();
assertThat(comments, hasSize(1));
assertThat(comments, contains(hasProperty("body", equalTo("Second comment"))));
comments = p.queryComments().since(secondCommentCreatedAt).list().toList();
assertThat(comments, hasSize(1));
assertThat(comments, contains(hasProperty("body", equalTo("Second comment"))));
comments = p.queryComments().since(secondCommentCreatedAtPlus1Second).list().toList();
assertThat(comments, hasSize(0));
// Test "since" with timestamp instead of Date
comments = p.queryComments().since(secondCommentCreatedAt.getTime()).list().toList();
assertThat(comments, hasSize(1));
assertThat(comments, contains(hasProperty("body", equalTo("Second comment"))));
}
/**
* Close pull request.
*
* @throws Exception the exception
*/
@Test
public void closePullRequest() throws Exception {
String name = "closePullRequest";
GHPullRequest p = getRepository().createPullRequest(name, "test/stable", "main", "## test");
// System.out.println(p.getUrl());
assertThat(p.getTitle(), equalTo(name));
assertThat(getRepository().getPullRequest(p.getNumber()).getState(), equalTo(GHIssueState.OPEN));
p.close();
assertThat(getRepository().getPullRequest(p.getNumber()).getState(), equalTo(GHIssueState.CLOSED));
}
/**
* Pull request reviews.
*
* @throws Exception the exception
*/
@Test
public void pullRequestReviews() throws Exception {
String name = "testPullRequestReviews";
GHPullRequest p = getRepository().createPullRequest(name, "test/stable", "main", "## test");
GHPullRequestReview draftReview = p.createReview()
.body("Some draft review")
.comment("Some niggle", "README.md", 1)
.create();
assertThat(draftReview.getState(), is(GHPullRequestReviewState.PENDING));
assertThat(draftReview.getBody(), is("Some draft review"));
assertThat(draftReview.getCommitId(), notNullValue());
List<GHPullRequestReview> reviews = p.listReviews().toList();
assertThat(reviews.size(), is(1));
GHPullRequestReview review = reviews.get(0);
assertThat(review.getState(), is(GHPullRequestReviewState.PENDING));
assertThat(review.getBody(), is("Some draft review"));
assertThat(review.getCommitId(), notNullValue());
draftReview.submit("Some review comment", GHPullRequestReviewEvent.COMMENT);
List<GHPullRequestReviewComment> comments = review.listReviewComments().toList();
assertThat(comments.size(), equalTo(1));
GHPullRequestReviewComment comment = comments.get(0);
assertThat(comment.getBody(), equalTo("Some niggle"));
draftReview = p.createReview().body("Some new review").comment("Some niggle", "README.md", 1).create();
draftReview.delete();
}
/**
* Pull request review comments.
*
* @throws Exception the exception
*/
@Test
public void pullRequestReviewComments() throws Exception {
String name = "pullRequestReviewComments";
GHPullRequest p = getRepository().createPullRequest(name, "test/stable", "main", "## test");
try {
// System.out.println(p.getUrl());
assertThat(p.listReviewComments().toList(), is(empty()));
p.createReviewComment("Sample review comment", p.getHead().getSha(), "README.md", 1);
List<GHPullRequestReviewComment> comments = p.listReviewComments().toList();
assertThat(comments.size(), equalTo(1));
GHPullRequestReviewComment comment = comments.get(0);
assertThat(comment.getBody(), equalTo("Sample review comment"));
assertThat(comment.getInReplyToId(), equalTo(-1L));
assertThat(comment.getPath(), equalTo("README.md"));
assertThat(comment.getPosition(), equalTo(1));
assertThat(comment.getDiffHunk(), equalTo("@@ -1,3 +1,4 @@\n-Java API for GitHub"));
assertThat(comment.getCommitId(), equalTo("07374fe73aff1c2024a8d4114b32406c7a8e89b7"));
assertThat(comment.getOriginalCommitId(), equalTo("07374fe73aff1c2024a8d4114b32406c7a8e89b7"));
assertThat(comment.getAuthorAssociation(), equalTo(GHCommentAuthorAssociation.MEMBER));
assertThat(comment.getUser(), notNullValue());
// Assert htmlUrl is not null
assertThat(comment.getHtmlUrl(), notNullValue());
assertThat(comment.getHtmlUrl().toString(),
containsString("hub4j-test-org/github-api/pull/" + p.getNumber()));
List<GHReaction> reactions = comment.listReactions().toList();
assertThat(reactions, is(empty()));
GHReaction reaction = comment.createReaction(ReactionContent.CONFUSED);
assertThat(reaction.getContent(), equalTo(ReactionContent.CONFUSED));
reactions = comment.listReactions().toList();
assertThat(reactions.size(), equalTo(1));
comment.deleteReaction(reaction);
reactions = comment.listReactions().toList();
assertThat(reactions.size(), equalTo(0));
GHPullRequestReviewComment reply = comment.reply("This is a reply.");
assertThat(reply.getInReplyToId(), equalTo(comment.getId()));
comments = p.listReviewComments().toList();
assertThat(comments.size(), equalTo(2));
comment.update("Updated review comment");
comments = p.listReviewComments().toList();
comment = comments.get(0);
assertThat(comment.getBody(), equalTo("Updated review comment"));
comment.delete();
comments = p.listReviewComments().toList();
// Reply is still present after delete of original comment, but no longer has replyToId
assertThat(comments.size(), equalTo(1));
assertThat(comments.get(0).getId(), equalTo(reply.getId()));
assertThat(comments.get(0).getInReplyToId(), equalTo(-1L));
} finally {
p.close();
}
}
/**
* Test pull request review requests.
*
* @throws Exception the exception
*/
@Test
public void testPullRequestReviewRequests() throws Exception {
String name = "testPullRequestReviewRequests";
GHPullRequest p = getRepository().createPullRequest(name, "test/stable", "main", "## test");
// System.out.println(p.getUrl());
assertThat(p.getRequestedReviewers(), is(empty()));
GHUser kohsuke2 = gitHub.getUser("kohsuke2");
p.requestReviewers(Collections.singletonList(kohsuke2));
p.refresh();
assertThat(p.getRequestedReviewers(), is(not(empty())));
}
/**
* Test pull request team review requests.
*
* @throws Exception the exception
*/
@Test
public void testPullRequestTeamReviewRequests() throws Exception {
String name = "testPullRequestTeamReviewRequests";
GHPullRequest p = getRepository().createPullRequest(name, "test/stable", "main", "## test");
// System.out.println(p.getUrl());
assertThat(p.getRequestedReviewers(), is(empty()));
GHOrganization testOrg = gitHub.getOrganization("hub4j-test-org");
GHTeam testTeam = testOrg.getTeamBySlug("dummy-team");
p.requestTeamReviewers(Collections.singletonList(testTeam));
int baseRequestCount = mockGitHub.getRequestCount();
p.refresh();
assertThat("We should not eagerly load organizations for teams",
mockGitHub.getRequestCount() - baseRequestCount,
equalTo(1));
assertThat(p.getRequestedTeams().size(), equalTo(1));
assertThat("We should not eagerly load organizations for teams",
mockGitHub.getRequestCount() - baseRequestCount,
equalTo(1));
assertThat("Org should be queried for automatically if asked for",
p.getRequestedTeams().get(0).getOrganization(),
notNullValue());
assertThat("Request count should show lazy load occurred",
mockGitHub.getRequestCount() - baseRequestCount,
equalTo(2));
}
/**
* Merge commit SHA.
*
* @throws Exception the exception
*/
@Test
public void mergeCommitSHA() throws Exception {
String name = "mergeCommitSHA";
GHRepository repo = getRepository();
GHPullRequest p = repo.createPullRequest(name, "test/mergeable_branch", "main", "## test");
int baseRequestCount = mockGitHub.getRequestCount();
assertThat(p.getMergeableNoRefresh(), nullValue());
assertThat("Used existing value", mockGitHub.getRequestCount() - baseRequestCount, equalTo(0));
// mergeability computation takes time, this should still be null immediately after creation
assertThat(p.getMergeable(), nullValue());
assertThat("Asked for PR information", mockGitHub.getRequestCount() - baseRequestCount, equalTo(1));
for (int i = 2; i <= 10; i++) {
if (Boolean.TRUE.equals(p.getMergeable()) && p.getMergeCommitSha() != null) {
assertThat("Asked for PR information", mockGitHub.getRequestCount() - baseRequestCount, equalTo(i));
// make sure commit exists
GHCommit commit = repo.getCommit(p.getMergeCommitSha());
assertThat(commit, notNullValue());
assertThat("Asked for PR information", mockGitHub.getRequestCount() - baseRequestCount, equalTo(i + 1));
return;
}
// mergeability computation takes time. give it more chance
Thread.sleep(1000);
}
// hmm?
fail();
}
/**
* Sets the base branch.
*
* @throws Exception the exception
*/
@Test
public void setBaseBranch() throws Exception {
String prName = "testSetBaseBranch";
String originalBaseBranch = "main";
String newBaseBranch = "gh-pages";
GHPullRequest pullRequest = getRepository().createPullRequest(prName, "test/stable", "main", "## test");
assertThat("Pull request base branch is supposed to be " + originalBaseBranch,
pullRequest.getBase().getRef(),
equalTo(originalBaseBranch));
GHPullRequest responsePullRequest = pullRequest.setBaseBranch(newBaseBranch);
assertThat("Pull request base branch is supposed to be " + newBaseBranch,
responsePullRequest.getBase().getRef(),
equalTo(newBaseBranch));
}
/**
* Sets the base branch non existing.
*
* @throws Exception the exception
*/
@Test
public void setBaseBranchNonExisting() throws Exception {
String prName = "testSetBaseBranchNonExisting";
String originalBaseBranch = "main";
String newBaseBranch = "non-existing";
GHPullRequest pullRequest = getRepository().createPullRequest(prName, "test/stable", "main", "## test");
assertThat("Pull request base branch is supposed to be " + originalBaseBranch,
pullRequest.getBase().getRef(),
equalTo(originalBaseBranch));
try {
pullRequest.setBaseBranch(newBaseBranch);
} catch (HttpException e) {
assertThat(e, instanceOf(HttpException.class));
assertThat(e.toString(), containsString("Proposed base branch 'non-existing' was not found"));
}
pullRequest.close();
}
/**
* Update outdated branches unexpected head.
*
* @throws Exception the exception
*/
@Test
public void updateOutdatedBranchesUnexpectedHead() throws Exception {
String prName = "testUpdateOutdatedBranches";
String outdatedRefName = "refs/heads/outdated";
GHRepository repository = gitHub.getOrganization("hub4j-test-org").getRepository("updateOutdatedBranches");
GHRef outdatedRef = repository.getRef(outdatedRefName);
outdatedRef.updateTo("6440189369f9f33b2366556a94dbc26f2cfdd969", true);
GHPullRequest outdatedPullRequest = repository.createPullRequest(prName, "outdated", "main", "## test");
do {
Thread.sleep(5000);
outdatedPullRequest.refresh();
} while (outdatedPullRequest.getMergeableState().equalsIgnoreCase("unknown"));
assertThat("Pull request is supposed to be not up to date",
outdatedPullRequest.getMergeableState(),
equalTo("behind"));
outdatedRef.updateTo("f567328eb81270487864963b7d7446953353f2b5", true);
try {
outdatedPullRequest.updateBranch();
} catch (HttpException e) {
assertThat(e, instanceOf(HttpException.class));
assertThat(e.toString(), containsString("expected head sha didn’t match current head ref."));
}
outdatedPullRequest.close();
}
/**
* Update outdated branches.
*
* @throws Exception the exception
*/
@Test
public void updateOutdatedBranches() throws Exception {
String prName = "testUpdateOutdatedBranches";
String outdatedRefName = "refs/heads/outdated";
GHRepository repository = gitHub.getOrganization("hub4j-test-org").getRepository("updateOutdatedBranches");
repository.getRef(outdatedRefName).updateTo("6440189369f9f33b2366556a94dbc26f2cfdd969", true);
GHPullRequest outdatedPullRequest = repository.createPullRequest(prName, "outdated", "main", "## test");
do {
Thread.sleep(5000);
outdatedPullRequest.refresh();
} while (outdatedPullRequest.getMergeableState().equalsIgnoreCase("unknown"));
assertThat("Pull request is supposed to be not up to date",
outdatedPullRequest.getMergeableState(),
equalTo("behind"));
outdatedPullRequest.updateBranch();
outdatedPullRequest.refresh();
assertThat("Pull request is supposed to be up to date", outdatedPullRequest.getMergeableState(), not("behind"));
outdatedPullRequest.close();
}
/**
* Squash merge.
*
* @throws Exception the exception
*/
@Test
public void squashMerge() throws Exception {
String name = "squashMerge";
String branchName = "test/" + name;
GHRef mainRef = getRepository().getRef("heads/main");
GHRef branchRef = getRepository().createRef("refs/heads/" + branchName, mainRef.getObject().getSha());
getRepository().createContent(name, name, name, branchName);
Thread.sleep(1000);
GHPullRequest p = getRepository().createPullRequest(name, branchName, "main", "## test squash");
Thread.sleep(1000);
p.merge("squash merge", null, GHPullRequest.MergeMethod.SQUASH);
}
/**
* Update content squash merge.
*
* @throws Exception the exception
*/
@Test
public void updateContentSquashMerge() throws Exception {
String name = "updateContentSquashMerge";
String branchName = "test/" + name;
GHRef mainRef = getRepository().getRef("heads/main");
GHRef branchRef = getRepository().createRef("refs/heads/" + branchName, mainRef.getObject().getSha());
GHContentUpdateResponse response = getRepository().createContent(name, name, name, branchName);
Thread.sleep(1000);
getRepository().createContent()
.content(name + name)
.path(name)
.branch(branchName)
.message(name)
.sha(response.getContent().getSha())
.commit();
GHPullRequest p = getRepository().createPullRequest(name, branchName, "main", "## test squash");
Thread.sleep(1000);
p.merge("squash merge", null, GHPullRequest.MergeMethod.SQUASH);
}
/**
* Query pull requests qualified head.
*
* @throws Exception the exception
*/
@Test
public void queryPullRequestsQualifiedHead() throws Exception {
GHRepository repo = getRepository();
// Create PRs from two different branches to main
repo.createPullRequest("queryPullRequestsQualifiedHead_stable", "test/stable", "main", null);
repo.createPullRequest("queryPullRequestsQualifiedHead_rc", "test/rc", "main", null);
// Query by one of the heads and make sure we only get that branch's PR back.
List<GHPullRequest> prs = repo.queryPullRequests()
.state(GHIssueState.OPEN)
.head("hub4j-test-org:test/stable")
.base("main")
.list()
.toList();
assertThat(prs, notNullValue());
assertThat(prs.size(), equalTo(1));
assertThat(prs.get(0).getHead().getRef(), equalTo("test/stable"));
}
/**
* Query pull requests unqualified head.
*
* @throws Exception the exception
*/
@Test
public void queryPullRequestsUnqualifiedHead() throws Exception {
GHRepository repo = getRepository();
// Create PRs from two different branches to main
repo.createPullRequest("queryPullRequestsUnqualifiedHead_stable", "test/stable", "main", null);
repo.createPullRequest("queryPullRequestsUnqualifiedHead_rc", "test/rc", "main", null);
// Query by one of the heads and make sure we only get that branch's PR back.
List<GHPullRequest> prs = repo.queryPullRequests()
.state(GHIssueState.OPEN)
.head("test/stable")
.base("main")
.list()
.toList();
assertThat(prs, notNullValue());
assertThat(prs.size(), equalTo(1));
assertThat(prs.get(0).getHead().getRef(), equalTo("test/stable"));
}
/**
* Sets the labels.
*
* @throws Exception the exception
*/
@Test
// Requires push access to the test repo to pass
public void setLabels() throws Exception {
GHPullRequest p = getRepository().createPullRequest("setLabels", "test/stable", "main", "## test");
String label = "setLabels_label_name";
p.setLabels(label);
Collection<GHLabel> labels = getRepository().getPullRequest(p.getNumber()).getLabels();
assertThat(labels.size(), equalTo(1));
GHLabel savedLabel = labels.iterator().next();
assertThat(savedLabel.getName(), equalTo(label));
assertThat(savedLabel.getId(), notNullValue());
assertThat(savedLabel.getNodeId(), notNullValue());
assertThat(savedLabel.isDefault(), is(false));
}
/**
* Adds the labels.
*
* @throws Exception the exception
*/
@Test
// Requires push access to the test repo to pass
public void addLabels() throws Exception {
GHPullRequest p = getRepository().createPullRequest("addLabels", "test/stable", "main", "## test");
String addedLabel1 = "addLabels_label_name_1";
String addedLabel2 = "addLabels_label_name_2";
String addedLabel3 = "addLabels_label_name_3";
List<GHLabel> resultingLabels = p.addLabels(addedLabel1);
assertThat(resultingLabels.size(), equalTo(1));
GHLabel ghLabel = resultingLabels.get(0);
assertThat(ghLabel.getName(), equalTo(addedLabel1));
int requestCount = mockGitHub.getRequestCount();
resultingLabels = p.addLabels(addedLabel2, addedLabel3);
// multiple labels can be added with one api call
assertThat(mockGitHub.getRequestCount(), equalTo(requestCount + 1));
assertThat(resultingLabels.size(), equalTo(3));
assertThat(resultingLabels,
containsInAnyOrder(hasProperty("name", equalTo(addedLabel1)),
hasProperty("name", equalTo(addedLabel2)),
hasProperty("name", equalTo(addedLabel3))));
// Adding a label which is already present does not throw an error
resultingLabels = p.addLabels(ghLabel);
assertThat(resultingLabels.size(), equalTo(3));
}
/**
* Adds the labels concurrency issue.
*
* @throws Exception the exception
*/
@Test
// Requires push access to the test repo to pass
public void addLabelsConcurrencyIssue() throws Exception {
String addedLabel1 = "addLabelsConcurrencyIssue_label_name_1";
String addedLabel2 = "addLabelsConcurrencyIssue_label_name_2";
GHPullRequest p1 = getRepository()
.createPullRequest("addLabelsConcurrencyIssue", "test/stable", "main", "## test");
p1.getLabels();
GHPullRequest p2 = getRepository().getPullRequest(p1.getNumber());
p2.addLabels(addedLabel2);
Collection<GHLabel> labels = p1.addLabels(addedLabel1);
assertThat(labels.size(), equalTo(2));
assertThat(labels,
containsInAnyOrder(hasProperty("name", equalTo(addedLabel1)),
hasProperty("name", equalTo(addedLabel2))));
}
/**
* Removes the labels.
*
* @throws Exception the exception
*/
@Test
// Requires push access to the test repo to pass
public void removeLabels() throws Exception {
GHPullRequest p = getRepository().createPullRequest("removeLabels", "test/stable", "main", "## test");
String label1 = "removeLabels_label_name_1";
String label2 = "removeLabels_label_name_2";
String label3 = "removeLabels_label_name_3";
p.setLabels(label1, label2, label3);
Collection<GHLabel> labels = getRepository().getPullRequest(p.getNumber()).getLabels();
assertThat(labels.size(), equalTo(3));
GHLabel ghLabel3 = labels.stream().filter(label -> label3.equals(label.getName())).findFirst().get();
int requestCount = mockGitHub.getRequestCount();
List<GHLabel> resultingLabels = p.removeLabels(label2, label3);
// each label deleted is a separate api call
assertThat(mockGitHub.getRequestCount(), equalTo(requestCount + 2));
assertThat(resultingLabels.size(), equalTo(1));
assertThat(resultingLabels.get(0).getName(), equalTo(label1));
// Removing some labels that are not present does not throw
// This is consistent with earlier behavior and with addLabels()
p.removeLabels(ghLabel3);
// Calling removeLabel() on label that is not present will throw
try {
p.removeLabel(label3);
fail("Expected GHFileNotFoundException");
} catch (GHFileNotFoundException e) {
assertThat(e.getMessage(), containsString("Label does not exist"));
}
}
/**
* Sets the assignee.
*
* @throws Exception the exception
*/
@Test
// Requires push access to the test repo to pass
public void setAssignee() throws Exception {
GHPullRequest p = getRepository().createPullRequest("setAssignee", "test/stable", "main", "## test");
GHMyself user = gitHub.getMyself();
p.assignTo(user);
assertThat(getRepository().getPullRequest(p.getNumber()).getAssignee(), equalTo(user));
}
/**
* Gets the user test.
*
* @throws IOException Signals that an I/O exception has occurred.
*/
@Test
public void getUserTest() throws IOException {
GHPullRequest p = getRepository().createPullRequest("getUserTest", "test/stable", "main", "## test");
GHPullRequest prSingle = getRepository().getPullRequest(p.getNumber());
assertThat(prSingle.getUser().root(), notNullValue());
prSingle.getMergeable();
assertThat(prSingle.getUser().root(), notNullValue());
PagedIterable<GHPullRequest> ghPullRequests = getRepository().listPullRequests(GHIssueState.OPEN);
for (GHPullRequest pr : ghPullRequests) {
assertThat(pr.getUser().root(), notNullValue());
pr.getMergeable();
assertThat(pr.getUser().root(), notNullValue());
}
}
/**
* Check non existent reviewer.
*
* @throws IOException Signals that an I/O exception has occurred.
*/
@Test
public void checkNonExistentReviewer() throws IOException {
// PR id is based on https://github.com/sahansera/TestRepo/pull/1
final GHPullRequest pullRequest = getRepository().getPullRequest(1);
final Optional<GHPullRequestReview> review = pullRequest.listReviews().toList().stream().findFirst();
final GHUser reviewer = review.get().getUser();
assertThat(pullRequest.getRequestedReviewers(), is(empty()));
assertThat(review, notNullValue());
assertThat(reviewer, is(nullValue()));
}
/**
* Check non existent author.
*
* @throws IOException Signals that an I/O exception has occurred.
*/
@Test
public void checkNonExistentAuthor() throws IOException {
// PR id is based on https://github.com/sahansera/TestRepo/pull/2
final GHPullRequest pullRequest = getRepository().getPullRequest(2);
assertThat(pullRequest.getUser(), is(notNullValue()));
assertThat(pullRequest.getUser().login, is("ghost"));
}
/**
* Check pull request reviewer.
*
* @throws IOException Signals that an I/O exception has occurred.
*/
@Test
public void checkPullRequestReviewer() throws IOException {
// PR id is based on https://github.com/sahansera/TestRepo/pull/6
final GHPullRequest pullRequest = getRepository().getPullRequest(6);
final Optional<GHPullRequestReview> review = pullRequest.listReviews().toList().stream().findFirst();
final GHUser reviewer = review.get().getUser();
assertThat(review, notNullValue());
assertThat(reviewer, notNullValue());
}
/**
* Gets the repository.
*
* @return the repository
* @throws IOException Signals that an I/O exception has occurred.
*/
protected GHRepository getRepository() throws IOException {
return getRepository(gitHub);
}
private GHRepository getRepository(GitHub gitHub) throws IOException {
return gitHub.getOrganization("hub4j-test-org").getRepository("github-api");
}
}