/
MailingListBridgeBotTests.java
1951 lines (1735 loc) · 110 KB
/
MailingListBridgeBotTests.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
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright (c) 2019, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package org.openjdk.skara.bots.mlbridge;
import org.openjdk.skara.email.EmailAddress;
import org.openjdk.skara.forge.*;
import org.openjdk.skara.network.URIBuilder;
import org.openjdk.skara.mailinglist.MailingListServerFactory;
import org.openjdk.skara.test.*;
import org.openjdk.skara.vcs.Repository;
import org.junit.jupiter.api.*;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.nio.file.*;
import java.time.*;
import java.util.*;
import java.util.logging.Logger;
import java.util.regex.Pattern;
import java.util.stream.Collectors;
import static org.junit.jupiter.api.Assertions.*;
class MailingListBridgeBotTests {
private final Logger log = Logger.getLogger("org.openjdk.skara.bots.mlbridge.test");
private Optional<String> archiveContents(Path archive) {
try {
var mbox = Files.find(archive, 50, (path, attrs) -> path.toString().endsWith(".mbox")).findAny();
if (mbox.isEmpty()) {
return Optional.empty();
}
return Optional.of(Files.readString(mbox.get(), StandardCharsets.UTF_8));
} catch (IOException e) {
return Optional.empty();
}
}
private boolean archiveContains(Path archive, String text) {
return archiveContainsCount(archive, text) > 0;
}
private int archiveContainsCount(Path archive, String text) {
var lines = archiveContents(archive);
if (lines.isEmpty()) {
return 0;
}
var pattern = Pattern.compile(text);
int count = 0;
for (var line : lines.get().split("\\R")) {
var matcher = pattern.matcher(line);
if (matcher.find()) {
count++;
}
}
return count;
}
private boolean webrevContains(Path webrev, String text) {
try {
var index = Files.find(webrev, 5, (path, attrs) -> path.toString().endsWith("index.html")).findAny();
if (index.isEmpty()) {
return false;
}
var lines = Files.readString(index.get(), StandardCharsets.UTF_8);
return lines.contains(text);
} catch (IOException e) {
return false;
}
}
private long countSubstrings(String string, String substring) {
return Pattern.compile(substring).matcher(string).results().count();
}
private String noreplyAddress(HostedRepository repository) {
return "test+" + repository.forge().currentUser().id() + "+" +
repository.forge().currentUser().userName() +
"@openjdk.java.net";
}
@Test
void simpleArchive(TestInfo testInfo) throws IOException {
try (var credentials = new HostCredentials(testInfo);
var tempFolder = new TemporaryDirectory();
var archiveFolder = new TemporaryDirectory();
var webrevFolder = new TemporaryDirectory();
var listServer = new TestMailmanServer();
var webrevServer = new TestWebrevServer()) {
var author = credentials.getHostedRepository();
var archive = credentials.getHostedRepository();
var ignored = credentials.getHostedRepository();
var listAddress = EmailAddress.parse(listServer.createList("test"));
var censusBuilder = credentials.getCensusBuilder()
.addAuthor(author.forge().currentUser().id());
var from = EmailAddress.from("test", "test@test.mail");
var mlBot = MailingListBridgeBot.newBuilder()
.from(from)
.repo(author)
.archive(archive)
.censusRepo(censusBuilder.build())
.list(listAddress)
.ignoredUsers(Set.of(ignored.forge().currentUser().userName()))
.ignoredComments(Set.of())
.listArchive(listServer.getArchive())
.smtpServer(listServer.getSMTP())
.webrevStorageRepository(archive)
.webrevStorageRef("webrev")
.webrevStorageBase(Path.of("test"))
.webrevStorageBaseUri(webrevServer.uri())
.readyLabels(Set.of("rfr"))
.readyComments(Map.of(ignored.forge().currentUser().userName(), Pattern.compile("ready")))
.issueTracker(URIBuilder.base("http://issues.test/browse/").build())
.headers(Map.of("Extra1", "val1", "Extra2", "val2"))
.sendInterval(Duration.ZERO)
.build();
// Populate the projects repository
var localRepo = CheckableRepository.init(tempFolder.path(), author.repositoryType());
var masterHash = localRepo.resolve("master").orElseThrow();
localRepo.push(masterHash, author.url(), "master", true);
localRepo.push(masterHash, archive.url(), "webrev", true);
// Make a change with a corresponding PR
var editHash = CheckableRepository.appendAndCommit(localRepo, "A simple change",
"Change msg\n\nWith several lines");
localRepo.push(editHash, author.url(), "edit", true);
var pr = credentials.createPullRequest(archive, "master", "edit", "1234: This is a pull request");
pr.setBody("This should not be ready");
// Run an archive pass
TestBotRunner.runPeriodicItems(mlBot);
// A PR that isn't ready for review should not be archived
Repository.materialize(archiveFolder.path(), archive.url(), "master");
assertFalse(archiveContains(archiveFolder.path(), "This is a pull request"));
// Flag it as ready for review
pr.setBody("This should now be ready");
pr.addLabel("rfr");
// Run another archive pass
TestBotRunner.runPeriodicItems(mlBot);
// But it should still not be archived
Repository.materialize(archiveFolder.path(), archive.url(), "master");
assertFalse(archiveContains(archiveFolder.path(), "This is a pull request"));
// Now post a general comment - not a ready marker
var ignoredPr = ignored.pullRequest(pr.id());
ignoredPr.addComment("hello there");
// Run another archive pass
TestBotRunner.runPeriodicItems(mlBot);
// It should still not be archived
Repository.materialize(archiveFolder.path(), archive.url(), "master");
assertFalse(archiveContains(archiveFolder.path(), "This is a pull request"));
// Now post a ready comment
ignoredPr.addComment("ready");
// Run another archive pass
TestBotRunner.runPeriodicItems(mlBot);
// The archive should now contain an entry
Repository.materialize(archiveFolder.path(), archive.url(), "master");
assertTrue(archiveContains(archiveFolder.path(), "This is a pull request"));
assertTrue(archiveContains(archiveFolder.path(), "This should now be ready"));
assertTrue(archiveContains(archiveFolder.path(), "Patch:"));
assertTrue(archiveContains(archiveFolder.path(), "Changes:"));
assertTrue(archiveContains(archiveFolder.path(), "Webrev:"));
assertTrue(archiveContains(archiveFolder.path(), webrevServer.uri().toString()));
assertTrue(archiveContains(archiveFolder.path(), "webrev.00"));
assertTrue(archiveContains(archiveFolder.path(), "Issue:"));
assertTrue(archiveContains(archiveFolder.path(), "http://issues.test/browse/TSTPRJ-1234"));
assertTrue(archiveContains(archiveFolder.path(), "Fetch:"));
assertTrue(archiveContains(archiveFolder.path(), "^ - " + editHash.abbreviate() + ": Change msg"));
assertFalse(archiveContains(archiveFolder.path(), "With several lines"));
// The mailing list as well
listServer.processIncoming();
var mailmanServer = MailingListServerFactory.createMailmanServer(listServer.getArchive(), listServer.getSMTP(), Duration.ZERO);
var mailmanList = mailmanServer.getList(listAddress.address());
var conversations = mailmanList.conversations(Duration.ofDays(1));
assertEquals(1, conversations.size());
var mail = conversations.get(0).first();
assertEquals("RFR: 1234: This is a pull request", mail.subject());
assertEquals(pr.author().fullName(), mail.author().fullName().orElseThrow());
assertEquals(noreplyAddress(archive), mail.author().address());
assertEquals(listAddress, mail.sender());
assertEquals("val1", mail.headerValue("Extra1"));
assertEquals("val2", mail.headerValue("Extra2"));
// And there should be a webrev
Repository.materialize(webrevFolder.path(), archive.url(), "webrev");
assertTrue(webrevContains(webrevFolder.path(), "1 lines changed"));
var comments = pr.comments();
var webrevComments = comments.stream()
.filter(comment -> comment.author().equals(author.forge().currentUser()))
.filter(comment -> comment.body().contains("webrev"))
.filter(comment -> comment.body().contains(editHash.hex()))
.collect(Collectors.toList());
assertEquals(1, webrevComments.size());
// Add a comment
pr.addComment("This is a comment :smile:");
// Add a comment from an ignored user as well
ignoredPr.addComment("Don't mind me");
// Run another archive pass
TestBotRunner.runPeriodicItems(mlBot);
// The archive should now contain the comment, but not the ignored one
Repository.materialize(archiveFolder.path(), archive.url(), "master");
assertTrue(archiveContains(archiveFolder.path(), "This is a comment"));
assertTrue(archiveContains(archiveFolder.path(), "> This should now be ready"));
assertFalse(archiveContains(archiveFolder.path(), "Don't mind me"));
listServer.processIncoming();
conversations = mailmanList.conversations(Duration.ofDays(1));
assertEquals(1, conversations.size());
assertEquals(2, conversations.get(0).allMessages().size());
// Remove the rfr flag and post another comment
pr.addLabel("rfr");
pr.addComment("This is another comment");
// Run another archive pass
TestBotRunner.runPeriodicItems(mlBot);
// The archive should contain the additional comment
Repository.materialize(archiveFolder.path(), archive.url(), "master");
assertTrue(archiveContains(archiveFolder.path(), "This is another comment"));
assertTrue(archiveContains(archiveFolder.path(), ">> This should now be ready"));
listServer.processIncoming();
conversations = mailmanList.conversations(Duration.ofDays(1));
assertEquals(1, conversations.size());
assertEquals(3, conversations.get(0).allMessages().size());
for (var newMail : conversations.get(0).allMessages()) {
assertEquals(noreplyAddress(archive), newMail.author().address());
assertEquals(listAddress, newMail.sender());
}
assertTrue(conversations.get(0).allMessages().get(2).body().contains("This is a comment 😄"));
}
}
@Test
void reviewComment(TestInfo testInfo) throws IOException {
try (var credentials = new HostCredentials(testInfo);
var tempFolder = new TemporaryDirectory();
var archiveFolder = new TemporaryDirectory();
var listServer = new TestMailmanServer();
var webrevServer = new TestWebrevServer()) {
var author = credentials.getHostedRepository();
var archive = credentials.getHostedRepository();
var ignored = credentials.getHostedRepository();
var listAddress = EmailAddress.parse(listServer.createList("test"));
var censusBuilder = credentials.getCensusBuilder()
.addAuthor(author.forge().currentUser().id());
var from = EmailAddress.from("test", "test@test.mail");
var mlBot = MailingListBridgeBot.newBuilder()
.from(from)
.repo(author)
.archive(archive)
.censusRepo(censusBuilder.build())
.list(listAddress)
.ignoredUsers(Set.of(ignored.forge().currentUser().userName()))
.listArchive(listServer.getArchive())
.smtpServer(listServer.getSMTP())
.webrevStorageRepository(archive)
.webrevStorageRef("webrev")
.webrevStorageBase(Path.of("test"))
.webrevStorageBaseUri(webrevServer.uri())
.issueTracker(URIBuilder.base("http://issues.test/browse/").build())
.build();
// Populate the projects repository
var reviewFile = Path.of("reviewfile.txt");
var localRepo = CheckableRepository.init(tempFolder.path(), author.repositoryType(), reviewFile);
var masterHash = localRepo.resolve("master").orElseThrow();
localRepo.push(masterHash, author.url(), "master", true);
localRepo.push(masterHash, archive.url(), "webrev", true);
// Make a change with a corresponding PR
var editHash = CheckableRepository.appendAndCommit(localRepo);
localRepo.push(editHash, author.url(), "edit", true);
var pr = credentials.createPullRequest(archive, "master", "edit", "This is a pull request");
pr.setBody("This is now ready");
TestBotRunner.runPeriodicItems(mlBot);
listServer.processIncoming();
// And make a file specific comment
var currentMaster = localRepo.resolve("master").orElseThrow();
var comment = pr.addReviewComment(masterHash, editHash, reviewFile.toString(), 2, "Review comment");
// Add one from an ignored user as well
var ignoredPr = ignored.pullRequest(pr.id());
ignoredPr.addReviewComment(masterHash, editHash, reviewFile.toString(), 2, "Don't mind me");
// Process comments
TestBotRunner.runPeriodicItems(mlBot);
listServer.processIncoming();
// The archive should now contain an entry
Repository.materialize(archiveFolder.path(), archive.url(), "master");
assertTrue(archiveContains(archiveFolder.path(), "This is a pull request"));
assertTrue(archiveContains(archiveFolder.path(), "This is now ready"));
assertTrue(archiveContains(archiveFolder.path(), "Review comment"));
assertTrue(archiveContains(archiveFolder.path(), "> This is now ready"));
assertTrue(archiveContains(archiveFolder.path(), reviewFile.toString()));
assertFalse(archiveContains(archiveFolder.path(), "Don't mind me"));
// The mailing list as well
var mailmanServer = MailingListServerFactory.createMailmanServer(listServer.getArchive(), listServer.getSMTP(), Duration.ZERO);
var mailmanList = mailmanServer.getList(listAddress.address());
var conversations = mailmanList.conversations(Duration.ofDays(1));
assertEquals(1, conversations.size());
var mail = conversations.get(0).first();
assertEquals("RFR: This is a pull request", mail.subject());
// Comment on the comment
pr.addReviewCommentReply(comment, "This is a review reply");
TestBotRunner.runPeriodicItems(mlBot);
listServer.processIncoming();
// The archive should contain the additional comment (but no quoted footers)
Repository.materialize(archiveFolder.path(), archive.url(), "master");
assertTrue(archiveContains(archiveFolder.path(), "This is a review reply"));
assertTrue(archiveContains(archiveFolder.path(), ">> This is now ready"));
assertFalse(archiveContains(archiveFolder.path(), "^> PR:"));
// As well as the mailing list
conversations = mailmanList.conversations(Duration.ofDays(1));
assertEquals(1, conversations.size());
assertEquals(3, conversations.get(0).allMessages().size());
for (var newMail : conversations.get(0).allMessages()) {
assertEquals(noreplyAddress(archive), newMail.author().address());
assertEquals(listAddress, newMail.sender());
}
}
}
@Test
void combineComments(TestInfo testInfo) throws IOException {
try (var credentials = new HostCredentials(testInfo);
var tempFolder = new TemporaryDirectory();
var archiveFolder = new TemporaryDirectory();
var listServer = new TestMailmanServer();
var webrevServer = new TestWebrevServer()) {
var author = credentials.getHostedRepository();
var archive = credentials.getHostedRepository();
var listAddress = EmailAddress.parse(listServer.createList("test"));
var censusBuilder = credentials.getCensusBuilder()
.addAuthor(author.forge().currentUser().id());
var from = EmailAddress.from("test", "test@test.mail");
var mlBot = MailingListBridgeBot.newBuilder()
.from(from)
.repo(author)
.archive(archive)
.censusRepo(censusBuilder.build())
.list(listAddress)
.listArchive(listServer.getArchive())
.smtpServer(listServer.getSMTP())
.webrevStorageRepository(archive)
.webrevStorageRef("webrev")
.webrevStorageBase(Path.of("test"))
.webrevStorageBaseUri(webrevServer.uri())
.issueTracker(URIBuilder.base("http://issues.test/browse/").build())
.build();
// Populate the projects repository
var reviewFile = Path.of("reviewfile.txt");
var localRepo = CheckableRepository.init(tempFolder.path(), author.repositoryType(), reviewFile);
var masterHash = localRepo.resolve("master").orElseThrow();
localRepo.push(masterHash, author.url(), "master", true);
localRepo.push(masterHash, archive.url(), "webrev", true);
// Make a change with a corresponding PR
var editHash = CheckableRepository.appendAndCommit(localRepo);
localRepo.push(editHash, author.url(), "edit", true);
var pr = credentials.createPullRequest(archive, "master", "edit", "This is a pull request");
pr.setBody("This is now ready");
pr.addComment("Avoid combining");
TestBotRunner.runPeriodicItems(mlBot);
listServer.processIncoming();
listServer.processIncoming();
// Make several file specific comments
var first = pr.addReviewComment(masterHash, editHash, reviewFile.toString(), 2, "Review comment");
pr.addReviewComment(masterHash, editHash, reviewFile.toString(), 2, "Another review comment");
pr.addReviewComment(masterHash, editHash, reviewFile.toString(), 2, "Further review comment");
pr.addReviewComment(masterHash, editHash, reviewFile.toString(), 2, "Final review comment");
TestBotRunner.runPeriodicItems(mlBot);
listServer.processIncoming();
// The archive should contain a combined entry
Repository.materialize(archiveFolder.path(), archive.url(), "master");
assertEquals(2, archiveContainsCount(archiveFolder.path(), "^On.*wrote:"));
// As well as the mailing list
var mailmanServer = MailingListServerFactory.createMailmanServer(listServer.getArchive(), listServer.getSMTP(), Duration.ZERO);
var mailmanList = mailmanServer.getList(listAddress.address());
var conversations = mailmanList.conversations(Duration.ofDays(1));
assertEquals(1, conversations.size());
var mail = conversations.get(0).first();
assertEquals("RFR: This is a pull request", mail.subject());
assertEquals(3, conversations.get(0).allMessages().size());
var commentReply = conversations.get(0).replies(mail).get(0);
assertEquals(2, commentReply.body().split("^On.*wrote:").length);
assertTrue(commentReply.body().contains("Avoid combining\n\n"), commentReply.body());
var reviewReply = conversations.get(0).replies(mail).get(1);
assertEquals(2, reviewReply.body().split("^On.*wrote:").length);
assertEquals(2, reviewReply.body().split("> This is now ready").length, reviewReply.body());
assertEquals("RFR: This is a pull request", reviewReply.subject());
assertTrue(reviewReply.body().contains("Review comment\n\n"), reviewReply.body());
assertTrue(reviewReply.body().contains("Another review comment"), reviewReply.body());
// Now reply to the first (collapsed) comment
pr.addReviewCommentReply(first, "I agree");
TestBotRunner.runPeriodicItems(mlBot);
listServer.processIncoming();
// The archive should contain a new entry
Repository.materialize(archiveFolder.path(), archive.url(), "master");
assertEquals(3, archiveContainsCount(archiveFolder.path(), "^On.*wrote:"));
// The combined review comments should only appear unquoted once
assertEquals(1, archiveContainsCount(archiveFolder.path(), "^Another review comment"));
}
}
@Test
void commentThreading(TestInfo testInfo) throws IOException {
try (var credentials = new HostCredentials(testInfo);
var tempFolder = new TemporaryDirectory();
var archiveFolder = new TemporaryDirectory();
var listServer = new TestMailmanServer();
var webrevServer = new TestWebrevServer()) {
var author = credentials.getHostedRepository();
var reviewer = credentials.getHostedRepository();
var archive = credentials.getHostedRepository();
var listAddress = EmailAddress.parse(listServer.createList("test"));
var censusBuilder = credentials.getCensusBuilder()
.addReviewer(reviewer.forge().currentUser().id())
.addAuthor(author.forge().currentUser().id());
var from = EmailAddress.from("test", "test@test.mail");
var mlBot = MailingListBridgeBot.newBuilder()
.from(from)
.repo(author)
.archive(archive)
.censusRepo(censusBuilder.build())
.list(listAddress)
.listArchive(listServer.getArchive())
.smtpServer(listServer.getSMTP())
.webrevStorageRepository(archive)
.webrevStorageRef("webrev")
.webrevStorageBase(Path.of("test"))
.webrevStorageBaseUri(webrevServer.uri())
.issueTracker(URIBuilder.base("http://issues.test/browse/").build())
.build();
// Populate the projects repository
var reviewFile = Path.of("reviewfile.txt");
var localRepo = CheckableRepository.init(tempFolder.path(), author.repositoryType(), reviewFile);
var masterHash = localRepo.resolve("master").orElseThrow();
localRepo.push(masterHash, author.url(), "master", true);
localRepo.push(masterHash, archive.url(), "webrev", true);
// Make a change with a corresponding PR
var editHash = CheckableRepository.appendAndCommit(localRepo);
localRepo.push(editHash, author.url(), "edit", true);
var pr = credentials.createPullRequest(archive, "master", "edit", "This is a pull request");
pr.setBody("This is now ready");
TestBotRunner.runPeriodicItems(mlBot);
listServer.processIncoming();
// Make a file specific comment
var reviewPr = reviewer.pullRequest(pr.id());
var comment1 = reviewPr.addReviewComment(masterHash, editHash, reviewFile.toString(), 2, "Review comment");
pr.addReviewCommentReply(comment1, "I agree");
reviewPr.addReviewCommentReply(comment1, "Great");
TestBotRunner.runPeriodicItems(mlBot);
listServer.processIncoming();
listServer.processIncoming();
listServer.processIncoming();
// And a second one by ourselves
var comment2 = pr.addReviewComment(masterHash, editHash, reviewFile.toString(), 2, "Another review comment");
reviewPr.addReviewCommentReply(comment2, "Sounds good");
pr.addReviewCommentReply(comment2, "Thanks");
TestBotRunner.runPeriodicItems(mlBot);
listServer.processIncoming();
listServer.processIncoming();
listServer.processIncoming();
// Finally some approvals and another comment
pr.addReview(Review.Verdict.APPROVED, "Nice");
reviewPr.addReviewComment(masterHash, editHash, reviewFile.toString(), 2, "The final review comment");
reviewPr.addReview(Review.Verdict.APPROVED, "Looks fine");
reviewPr.addReviewCommentReply(comment2, "You are welcome");
TestBotRunner.runPeriodicItems(mlBot);
listServer.processIncoming();
listServer.processIncoming();
listServer.processIncoming();
// Sanity check the archive
Repository.materialize(archiveFolder.path(), archive.url(), "master");
assertEquals(9, archiveContainsCount(archiveFolder.path(), "^On.*wrote:"));
// File specific comments should appear after the approval
var archiveText = archiveContents(archiveFolder.path()).orElseThrow();
assertTrue(archiveText.indexOf("Looks fine") < archiveText.indexOf("The final review comment"));
// Check the mailing list
var mailmanServer = MailingListServerFactory.createMailmanServer(listServer.getArchive(), listServer.getSMTP(), Duration.ZERO);
var mailmanList = mailmanServer.getList(listAddress.address());
var conversations = mailmanList.conversations(Duration.ofDays(1));
assertEquals(1, conversations.size());
var mail = conversations.get(0).first();
assertEquals("RFR: This is a pull request", mail.subject());
assertEquals(10, conversations.get(0).allMessages().size());
// There should be four separate threads
var thread1 = conversations.get(0).replies(mail).get(0);
assertEquals(2, thread1.body().split("^On.*wrote:").length);
assertEquals(2, thread1.body().split("> This is now ready").length, thread1.body());
assertEquals("RFR: This is a pull request", thread1.subject());
assertTrue(thread1.body().contains("Review comment\n\n"), thread1.body());
assertFalse(thread1.body().contains("Another review comment"), thread1.body());
var thread1reply1 = conversations.get(0).replies(thread1).get(0);
assertTrue(thread1reply1.body().contains("I agree"));
assertEquals(noreplyAddress(archive), thread1reply1.author().address());
assertEquals(archive.forge().currentUser().fullName(), thread1reply1.author().fullName().orElseThrow());
var thread1reply2 = conversations.get(0).replies(thread1reply1).get(0);
assertTrue(thread1reply2.body().contains("Great"));
assertEquals("integrationreviewer1@openjdk.java.net", thread1reply2.author().address());
assertEquals("Generated Reviewer 1", thread1reply2.author().fullName().orElseThrow());
var thread2 = conversations.get(0).replies(mail).get(1);
assertEquals(2, thread2.body().split("^On.*wrote:").length);
assertEquals(2, thread2.body().split("> This is now ready").length, thread2.body());
assertEquals("RFR: This is a pull request", thread2.subject());
assertFalse(thread2.body().contains("Review comment\n\n"), thread2.body());
assertTrue(thread2.body().contains("Another review comment"), thread2.body());
var thread2reply1 = conversations.get(0).replies(thread2).get(0);
assertTrue(thread2reply1.body().contains("Sounds good"));
var thread2reply2 = conversations.get(0).replies(thread2reply1).get(0);
assertTrue(thread2reply2.body().contains("Thanks"));
var replies = conversations.get(0).replies(mail);
var thread3 = replies.get(2);
assertEquals("RFR: This is a pull request", thread3.subject());
var thread4 = replies.get(3);
assertEquals("RFR: This is a pull request", thread4.subject());
assertTrue(thread4.body().contains("Looks fine"));
assertTrue(thread4.body().contains("The final review comment"));
assertTrue(thread4.body().contains("Marked as reviewed by integrationreviewer1 (Reviewer)"));
}
}
@Test
void commentThreadingSeparated(TestInfo testInfo) throws IOException {
try (var credentials = new HostCredentials(testInfo);
var tempFolder = new TemporaryDirectory();
var archiveFolder = new TemporaryDirectory();
var listServer = new TestMailmanServer();
var webrevServer = new TestWebrevServer()) {
var author = credentials.getHostedRepository();
var reviewer = credentials.getHostedRepository();
var archive = credentials.getHostedRepository();
var listAddress = EmailAddress.parse(listServer.createList("test"));
var censusBuilder = credentials.getCensusBuilder()
.addReviewer(reviewer.forge().currentUser().id())
.addAuthor(author.forge().currentUser().id());
var from = EmailAddress.from("test", "test@test.mail");
var mlBot = MailingListBridgeBot.newBuilder()
.from(from)
.repo(author)
.archive(archive)
.censusRepo(censusBuilder.build())
.list(listAddress)
.listArchive(listServer.getArchive())
.smtpServer(listServer.getSMTP())
.webrevStorageRepository(archive)
.webrevStorageRef("webrev")
.webrevStorageBase(Path.of("test"))
.webrevStorageBaseUri(webrevServer.uri())
.issueTracker(URIBuilder.base("http://issues.test/browse/").build())
.build();
// Populate the projects repository
var reviewFile = Path.of("reviewfile.txt");
var localRepo = CheckableRepository.init(tempFolder.path(), author.repositoryType(), reviewFile);
var masterHash = localRepo.resolve("master").orElseThrow();
localRepo.push(masterHash, author.url(), "master", true);
localRepo.push(masterHash, archive.url(), "webrev", true);
// Make a change with a corresponding PR
var editHash = CheckableRepository.appendAndCommit(localRepo);
localRepo.push(editHash, author.url(), "edit", true);
var pr = credentials.createPullRequest(archive, "master", "edit", "This is a pull request");
pr.setBody("This is now ready");
TestBotRunner.runPeriodicItems(mlBot);
listServer.processIncoming();
// Make two file specific comments
var reviewPr = reviewer.pullRequest(pr.id());
var comment1 = reviewPr.addReviewComment(masterHash, editHash, reviewFile.toString(), 2, "Review comment");
var comment2 = reviewPr.addReviewComment(masterHash, editHash, reviewFile.toString(), 2, "Another review comment");
TestBotRunner.runPeriodicItems(mlBot);
listServer.processIncoming();
pr.addReviewCommentReply(comment1, "I agree");
pr.addReviewCommentReply(comment2, "I don't agree");
TestBotRunner.runPeriodicItems(mlBot);
listServer.processIncoming();
// Sanity check the archive
Repository.materialize(archiveFolder.path(), archive.url(), "master");
assertEquals(3, archiveContainsCount(archiveFolder.path(), "^On.*wrote:"));
}
}
@Test
void reviewContext(TestInfo testInfo) throws IOException {
try (var credentials = new HostCredentials(testInfo);
var tempFolder = new TemporaryDirectory();
var archiveFolder = new TemporaryDirectory();
var listServer = new TestMailmanServer();
var webrevServer = new TestWebrevServer()) {
var author = credentials.getHostedRepository();
var archive = credentials.getHostedRepository();
var listAddress = EmailAddress.parse(listServer.createList("test"));
var censusBuilder = credentials.getCensusBuilder()
.addAuthor(author.forge().currentUser().id());
var from = EmailAddress.from("test", "test@test.mail");
var mlBot = MailingListBridgeBot.newBuilder()
.from(from)
.repo(author)
.archive(archive)
.censusRepo(censusBuilder.build())
.list(listAddress)
.listArchive(listServer.getArchive())
.smtpServer(listServer.getSMTP())
.webrevStorageRepository(archive)
.webrevStorageRef("webrev")
.webrevStorageBase(Path.of("test"))
.webrevStorageBaseUri(webrevServer.uri())
.issueTracker(URIBuilder.base("http://issues.test/browse/").build())
.build();
// Populate the projects repository
var reviewFile = Path.of("reviewfile.txt");
var localRepo = CheckableRepository.init(tempFolder.path(), author.repositoryType(), reviewFile);
var masterHash = localRepo.resolve("master").orElseThrow();
localRepo.push(masterHash, author.url(), "master", true);
localRepo.push(masterHash, archive.url(), "webrev", true);
// Make a change with a corresponding PR
var editHash = CheckableRepository.appendAndCommit(localRepo, "Line 1\nLine 2\nLine 3\nLine 4");
localRepo.push(editHash, author.url(), "edit", true);
var pr = credentials.createPullRequest(archive, "master", "edit", "This is a pull request");
pr.setBody("This is now ready");
TestBotRunner.runPeriodicItems(mlBot);
listServer.processIncoming();
// Make a file specific comment
pr.addReviewComment(masterHash, editHash, reviewFile.toString(), 2, "Review comment");
TestBotRunner.runPeriodicItems(mlBot);
listServer.processIncoming();
// The archive should only contain context around line 2
Repository.materialize(archiveFolder.path(), archive.url(), "master");
assertTrue(archiveContains(archiveFolder.path(), "^> 2: Line 1$"));
assertTrue(archiveContains(archiveFolder.path(), "^> 3: Line 2$"));
assertFalse(archiveContains(archiveFolder.path(), "^> 4: Line 3$"));
}
}
@Test
void multipleReviewContexts(TestInfo testInfo) throws IOException {
try (var credentials = new HostCredentials(testInfo);
var tempFolder = new TemporaryDirectory();
var archiveFolder = new TemporaryDirectory();
var listServer = new TestMailmanServer();
var webrevServer = new TestWebrevServer()) {
var author = credentials.getHostedRepository();
var archive = credentials.getHostedRepository();
var listAddress = EmailAddress.parse(listServer.createList("test"));
var censusBuilder = credentials.getCensusBuilder()
.addAuthor(author.forge().currentUser().id());
var from = EmailAddress.from("test", "test@test.mail");
var mlBot = MailingListBridgeBot.newBuilder()
.from(from)
.repo(author)
.archive(archive)
.censusRepo(censusBuilder.build())
.list(listAddress)
.listArchive(listServer.getArchive())
.smtpServer(listServer.getSMTP())
.webrevStorageRepository(archive)
.webrevStorageRef("webrev")
.webrevStorageBase(Path.of("test"))
.webrevStorageBaseUri(webrevServer.uri())
.issueTracker(URIBuilder.base("http://issues.test/browse/").build())
.build();
// Populate the projects repository
var reviewFile = Path.of("reviewfile.txt");
var localRepo = CheckableRepository.init(tempFolder.path(), author.repositoryType(), reviewFile);
var masterHash = localRepo.resolve("master").orElseThrow();
localRepo.push(masterHash, author.url(), "master", true);
localRepo.push(masterHash, archive.url(), "webrev", true);
var initialHash = CheckableRepository.appendAndCommit(localRepo,
"Line 0.1\nLine 0.2\nLine 0.3\nLine 0.4\n" +
"Line 1\nLine 2\nLine 3\nLine 4\n" +
"Line 5\nLine 6\nLine 7\nLine 8\n" +
"Line 8.1\nLine 8.2\nLine 8.3\nLine 8.4\n" +
"Line 9\nLine 10\nLine 11\nLine 12\n" +
"Line 13\nLine 14\nLine 15\nLine 16\n");
localRepo.push(initialHash, author.url(), "master");
// Make a change with a corresponding PR
var current = Files.readString(localRepo.root().resolve(reviewFile), StandardCharsets.UTF_8);
var updated = current.replaceAll("Line 2", "Line 2 edit\nLine 2.5");
updated = updated.replaceAll("Line 13", "Line 12.5\nLine 13 edit");
Files.writeString(localRepo.root().resolve(reviewFile), updated, StandardCharsets.UTF_8);
var editHash = CheckableRepository.appendAndCommit(localRepo);
localRepo.push(editHash, author.url(), "edit", true);
var pr = credentials.createPullRequest(archive, "master", "edit", "This is a pull request");
pr.setBody("This is now ready");
TestBotRunner.runPeriodicItems(mlBot);
listServer.processIncoming();
// Make file specific comments
pr.addReviewComment(masterHash, editHash, reviewFile.toString(), 7, "Review comment");
pr.addReviewComment(masterHash, editHash, reviewFile.toString(), 24, "Another review comment");
TestBotRunner.runPeriodicItems(mlBot);
listServer.processIncoming();
// The archive should only contain context around line 2 and 20
Repository.materialize(archiveFolder.path(), archive.url(), "master");
assertTrue(archiveContains(archiveFolder.path(), "reviewfile.txt line 7"));
assertTrue(archiveContains(archiveFolder.path(), "^> 6: Line 1$"));
assertTrue(archiveContains(archiveFolder.path(), "^> 7: Line 2 edit$"));
assertFalse(archiveContains(archiveFolder.path(), "Line 3"));
assertTrue(archiveContains(archiveFolder.path(), "reviewfile.txt line 24"));
assertTrue(archiveContains(archiveFolder.path(), "^> 23: Line 12.5$"));
assertTrue(archiveContains(archiveFolder.path(), "^> 24: Line 13 edit$"));
assertFalse(archiveContains(archiveFolder.path(), "^Line 15"));
}
}
@Test
void filterComments(TestInfo testInfo) throws IOException {
try (var credentials = new HostCredentials(testInfo);
var tempFolder = new TemporaryDirectory();
var archiveFolder = new TemporaryDirectory();
var listServer = new TestMailmanServer();
var webrevServer = new TestWebrevServer()) {
var author = credentials.getHostedRepository();
var archive = credentials.getHostedRepository();
var listAddress = EmailAddress.parse(listServer.createList("test"));
var censusBuilder = credentials.getCensusBuilder()
.addAuthor(author.forge().currentUser().id());
var from = EmailAddress.from("test", "test@test.mail");
var mlBot = MailingListBridgeBot.newBuilder()
.from(from)
.repo(author)
.archive(archive)
.censusRepo(censusBuilder.build())
.list(listAddress)
.listArchive(listServer.getArchive())
.smtpServer(listServer.getSMTP())
.webrevStorageRepository(archive)
.webrevStorageRef("webrev")
.webrevStorageBase(Path.of("test"))
.webrevStorageBaseUri(webrevServer.uri())
.issueTracker(URIBuilder.base("http://issues.test/browse/").build())
.build();
// Populate the projects repository
var reviewFile = Path.of("reviewfile.txt");
var localRepo = CheckableRepository.init(tempFolder.path(), author.repositoryType(), reviewFile);
var masterHash = localRepo.resolve("master").orElseThrow();
localRepo.push(masterHash, author.url(), "master", true);
localRepo.push(masterHash, archive.url(), "webrev", true);
// Make a change with a corresponding PR
var editHash = CheckableRepository.appendAndCommit(localRepo);
localRepo.push(editHash, author.url(), "edit", true);
var pr = credentials.createPullRequest(archive, "master", "edit", "This is a pull request");
pr.setBody("This is now ready\n<!-- this is a comment -->\nAnd this is not\n" +
"<!-- Anything below this marker will be hidden -->\nStatus stuff");
// Make a bunch of comments
pr.addComment("Plain comment\n<!-- this is a comment -->");
pr.addReviewComment(masterHash, editHash, reviewFile.toString(), 2, "Review comment <!-- this is a comment -->\n");
pr.addComment("/integrate stuff");
TestBotRunner.runPeriodicItems(mlBot);
// Run an archive pass
TestBotRunner.runPeriodicItems(mlBot);
// The archive should not contain the comment
Repository.materialize(archiveFolder.path(), archive.url(), "master");
assertTrue(archiveContains(archiveFolder.path(), "This is now ready"));
assertFalse(archiveContains(archiveFolder.path(), "this is a comment"));
assertFalse(archiveContains(archiveFolder.path(), "Status stuff"));
assertTrue(archiveContains(archiveFolder.path(), "And this is not"));
assertFalse(archiveContains(archiveFolder.path(), "<!--"));
assertFalse(archiveContains(archiveFolder.path(), "-->"));
assertTrue(archiveContains(archiveFolder.path(), "Plain comment"));
assertTrue(archiveContains(archiveFolder.path(), "Review comment"));
assertFalse(archiveContains(archiveFolder.path(), "/integrate"));
}
}
@Test
void incrementalChanges(TestInfo testInfo) throws IOException {
try (var credentials = new HostCredentials(testInfo);
var tempFolder = new TemporaryDirectory();
var archiveFolder = new TemporaryDirectory();
var listServer = new TestMailmanServer();
var webrevServer = new TestWebrevServer()) {
var author = credentials.getHostedRepository();
var archive = credentials.getHostedRepository();
var commenter = credentials.getHostedRepository();
var listAddress = EmailAddress.parse(listServer.createList("test"));
var censusBuilder = credentials.getCensusBuilder()
.addAuthor(author.forge().currentUser().id());
var from = EmailAddress.from("test", "test@test.mail");
var mlBot = MailingListBridgeBot.newBuilder()
.from(from)
.repo(author)
.archive(archive)
.censusRepo(censusBuilder.build())
.list(listAddress)
.listArchive(listServer.getArchive())
.smtpServer(listServer.getSMTP())
.webrevStorageRepository(archive)
.webrevStorageRef("webrev")
.webrevStorageBase(Path.of("test"))
.webrevStorageBaseUri(webrevServer.uri())
.issueTracker(URIBuilder.base("http://issues.test/browse/").build())
.build();
// Populate the projects repository
var reviewFile = Path.of("reviewfile.txt");
var localRepo = CheckableRepository.init(tempFolder.path(), author.repositoryType(), reviewFile);
var masterHash = localRepo.resolve("master").orElseThrow();
localRepo.push(masterHash, author.url(), "master", true);
localRepo.push(masterHash, archive.url(), "webrev", true);
// Make a change with a corresponding PR
var editHash = CheckableRepository.appendAndCommit(localRepo);
localRepo.push(editHash, author.url(), "edit", true);
var pr = credentials.createPullRequest(archive, "master", "edit", "This is a pull request");
pr.setBody("This is now ready");
// Run an archive pass
TestBotRunner.runPeriodicItems(mlBot);
listServer.processIncoming();
var nextHash = CheckableRepository.appendAndCommit(localRepo, "Yet one more line", "Fixing");
localRepo.push(nextHash, author.url(), "edit");
// Make sure that the push registered
var lastHeadHash = pr.headHash();
var refreshCount = 0;
do {
pr = author.pullRequest(pr.id());
if (refreshCount++ > 100) {
fail("The PR did not update after the new push");
}
} while (pr.headHash().equals(lastHeadHash));
// Run another archive pass
TestBotRunner.runPeriodicItems(mlBot);
TestBotRunner.runPeriodicItems(mlBot);
TestBotRunner.runPeriodicItems(mlBot);
listServer.processIncoming();
// The archive should reference the updated push
Repository.materialize(archiveFolder.path(), archive.url(), "master");
assertTrue(archiveContains(archiveFolder.path(), "1 additional commit"));
assertTrue(archiveContains(archiveFolder.path(), "full.*/" + pr.id() + "/webrev.01"));
assertTrue(archiveContains(archiveFolder.path(), "inc.*/" + pr.id() + "/webrev.00-01"));
assertTrue(archiveContains(archiveFolder.path(), "Patch"));
assertTrue(archiveContains(archiveFolder.path(), "Fetch"));
assertTrue(archiveContains(archiveFolder.path(), "Fixing"));
// The webrev comment should be updated
var comments = pr.comments();
var webrevComments = comments.stream()
.filter(comment -> comment.author().equals(author.forge().currentUser()))
.filter(comment -> comment.body().contains("webrev"))
.filter(comment -> comment.body().contains("Full"))
.filter(comment -> comment.body().contains("Incremental"))
.filter(comment -> comment.body().contains(nextHash.hex()))
.filter(comment -> comment.body().contains(editHash.hex()))
.collect(Collectors.toList());
assertEquals(1, webrevComments.size());
// Check that sender address is set properly
var mailmanServer = MailingListServerFactory.createMailmanServer(listServer.getArchive(), listServer.getSMTP(), Duration.ZERO);
var mailmanList = mailmanServer.getList(listAddress.address());
var conversations = mailmanList.conversations(Duration.ofDays(1));
assertEquals(1, conversations.size());
for (var newMail : conversations.get(0).allMessages()) {
assertEquals(noreplyAddress(archive), newMail.author().address());
assertEquals(listAddress, newMail.sender());
}
// Add a comment
var commenterPr = commenter.pullRequest(pr.id());
commenterPr.addReviewComment(masterHash, nextHash, reviewFile.toString(), 2, "Review comment");
TestBotRunner.runPeriodicItems(mlBot);
listServer.processIncoming();
// Ensure that additional updates are only reported once
for (int i = 0; i < 3; ++i) {
var anotherHash = CheckableRepository.appendAndCommit(localRepo, "Another line", "Fixing");
localRepo.push(anotherHash, author.url(), "edit");
// Make sure that the push registered
lastHeadHash = pr.headHash();
refreshCount = 0;
do {
pr = author.pullRequest(pr.id());
if (refreshCount++ > 100) {
fail("The PR did not update after the new push");
}
} while (pr.headHash().equals(lastHeadHash));
TestBotRunner.runPeriodicItems(mlBot);
TestBotRunner.runPeriodicItems(mlBot);
listServer.processIncoming();
}
var updatedConversations = mailmanList.conversations(Duration.ofDays(1));
assertEquals(1, updatedConversations.size());
var conversation = updatedConversations.get(0);
assertEquals(6, conversation.allMessages().size());
assertEquals("[Rev 01] RFR: This is a pull request", conversation.allMessages().get(1).subject());
assertEquals("[Rev 01] RFR: This is a pull request", conversation.allMessages().get(2).subject(), conversation.allMessages().get(2).toString());
assertEquals("[Rev 04] RFR: This is a pull request", conversation.allMessages().get(5).subject());
}
}
@Test
void rebased(TestInfo testInfo) throws IOException {
try (var credentials = new HostCredentials(testInfo);
var tempFolder = new TemporaryDirectory();
var archiveFolder = new TemporaryDirectory();
var listServer = new TestMailmanServer();
var webrevServer = new TestWebrevServer()) {
var author = credentials.getHostedRepository();
var archive = credentials.getHostedRepository();
var listAddress = EmailAddress.parse(listServer.createList("test"));
var censusBuilder = credentials.getCensusBuilder()
.addAuthor(author.forge().currentUser().id());
var sender = EmailAddress.from("test", "test@test.mail");
var mlBot = MailingListBridgeBot.newBuilder()
.from(sender)
.repo(author)
.archive(archive)
.censusRepo(censusBuilder.build())
.list(listAddress)
.listArchive(listServer.getArchive())