Repository navigation
Expand file tree
/
Copy pathgithub_merger_test.go
More file actions
847 lines (804 loc) · 28.6 KB
/
Copy pathgithub_merger_test.go
File metadata and controls
847 lines (804 loc) · 28.6 KB
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
// Copyright (c) 2026 Uber Technologies, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package github
import (
"context"
"encoding/json"
"fmt"
"net/http"
"net/http/httptest"
"strconv"
"strings"
"sync"
"testing"
"time"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/uber-go/tally"
"go.uber.org/zap/zaptest"
changepb "github.com/uber/submitqueue/api/base/change/protopb"
mergestrategypb "github.com/uber/submitqueue/api/base/mergestrategy/protopb"
runwaymq "github.com/uber/submitqueue/api/runway/messagequeue"
runwaypb "github.com/uber/submitqueue/api/runway/messagequeue/protopb"
"github.com/uber/submitqueue/platform/errs"
phttp "github.com/uber/submitqueue/platform/http"
"github.com/uber/submitqueue/runway/extension/merger"
)
const (
testHost = "github.com"
testOwner = "uber"
testRepo = "submitqueue"
testTarget = "main"
)
func headSHA(n int) string { return fmt.Sprintf("%040x", n) }
func mergeSHA(n int) string { return fmt.Sprintf("%040x", 0xa000+n) }
func uri(n int) string {
return fmt.Sprintf("github://%s/%s/%s/pull/%d/%s", testHost, testOwner, testRepo, n, headSHA(n))
}
// fakeGitHub serves the endpoints the merger calls from in-memory state.
type fakeGitHub struct {
mu sync.Mutex
pulls map[int]*pullRequest
stacks []stack
// submitStatus overrides the merge-async response code (default 202).
submitStatus int
// submitBody overrides the merge-async response body.
submitBody string
// pollsUntilDone is how many status reads stay pending.
pollsUntilDone int
// finalStatus is what a settled merge reports (default merged).
finalStatus string
// mergeableNullReads is how many pull reads report mergeable as null.
mergeableNullReads int
// unmergeable names pull requests reported as conflicting.
unmergeable map[int]bool
// pullErrStatus makes every pull read fail with this code.
pullErrStatus int
// mergedReadLag is how many event reads of a pull request landed by a merge
// still lack its merged event, as github.com does briefly after a stack
// merge settles.
mergedReadLag int
// eventPadding is how many other events precede a merged event, to push it
// past the first page.
eventPadding int
// failMerges names top pull requests whose merge settles as failed.
failMerges map[int]bool
mergeCommits map[int]string
lagging map[int]int
submits []submitCall
polls int
}
type submitCall struct {
number int
req asyncMergeRequest
}
func newFakeGitHub() *fakeGitHub {
return &fakeGitHub{pulls: make(map[int]*pullRequest), mergeCommits: make(map[int]string), lagging: make(map[int]int)}
}
// addPull adds an open pull request with the given base branch.
func (f *fakeGitHub) addPull(n int, base string) {
f.pulls[n] = &pullRequest{
Number: n,
State: pullStateOpen,
Head: gitRef{Ref: "branch-" + strconv.Itoa(n), SHA: headSHA(n)},
Base: gitRef{Ref: base},
}
}
// addStack adds open pull requests forming a GitHub stack on the target,
// bottom to top.
func (f *fakeGitHub) addStack(number int, prs ...int) {
s := stack{Number: number, Open: true, Base: gitRef{Ref: testTarget}}
base := testTarget
for _, n := range prs {
f.addPull(n, base)
base = "branch-" + strconv.Itoa(n)
s.PullRequests = append(s.PullRequests, stackPull{Number: n, State: pullStateOpen, Head: gitRef{Ref: base, SHA: headSHA(n)}})
}
f.stacks = append(f.stacks, s)
}
func (f *fakeGitHub) markMerged(n int) {
pr := f.pulls[n]
pr.Merged = true
pr.State = "closed"
f.mergeCommits[n] = mergeSHA(n)
mergedAt := "2026-10-07T00:00:00Z"
for si := range f.stacks {
for pi := range f.stacks[si].PullRequests {
if f.stacks[si].PullRequests[pi].Number == n {
f.stacks[si].PullRequests[pi].State = "closed"
f.stacks[si].PullRequests[pi].MergedAt = &mergedAt
}
}
}
}
// landStack merges top and every unmerged pull request below it, as GitHub's
// async merge does for a stacked pull request.
func (f *fakeGitHub) landStack(top int) {
for _, s := range f.stacks {
for i, p := range s.PullRequests {
if p.Number != top {
continue
}
for _, below := range s.PullRequests[:i+1] {
if !f.pulls[below.Number].Merged {
f.markMerged(below.Number)
}
}
return
}
}
f.markMerged(top)
}
func (f *fakeGitHub) ServeHTTP(w http.ResponseWriter, r *http.Request) {
f.mu.Lock()
defer f.mu.Unlock()
prefix := "/repos/" + testOwner + "/" + testRepo + "/"
parts := strings.Split(strings.TrimPrefix(r.URL.Path, prefix), "/")
switch {
case r.Method == http.MethodGet && parts[0] == "stacks":
n, _ := strconv.Atoi(r.URL.Query().Get("pull_request"))
var out []stack
for _, s := range f.stacks {
for _, p := range s.PullRequests {
if p.Number == n {
out = append(out, s)
}
}
}
writeJSON(w, http.StatusOK, out)
case r.Method == http.MethodGet && parts[0] == "issues" && len(parts) == 3 && parts[2] == "events":
n, _ := strconv.Atoi(parts[1])
var events []issueEvent
for i := 0; i < f.eventPadding; i++ {
events = append(events, issueEvent{Event: "labeled"})
}
if sha, ok := f.mergeCommits[n]; ok {
if f.lagging[n] > 0 {
f.lagging[n]--
} else {
events = append(events, issueEvent{Event: "merged", CommitID: sha})
}
}
page, _ := strconv.Atoi(r.URL.Query().Get("page"))
perPage, _ := strconv.Atoi(r.URL.Query().Get("per_page"))
start := min((page-1)*perPage, len(events))
writeJSON(w, http.StatusOK, events[start:min(start+perPage, len(events))])
case parts[0] == "pulls" && len(parts) == 2 && r.Method == http.MethodGet:
if f.pullErrStatus != 0 {
w.WriteHeader(f.pullErrStatus)
return
}
n, _ := strconv.Atoi(parts[1])
pr, ok := f.pulls[n]
if !ok {
w.WriteHeader(http.StatusNotFound)
return
}
out := *pr
if !out.Merged {
if f.mergeableNullReads > 0 {
f.mergeableNullReads--
} else {
mergeable := !f.unmergeable[n]
out.Mergeable = &mergeable
if !mergeable {
out.MergeableState = mergeableStateDirty
}
}
}
writeJSON(w, http.StatusOK, out)
case parts[0] == "pulls" && len(parts) == 3 && r.Method == http.MethodPut:
n, _ := strconv.Atoi(parts[1])
var req asyncMergeRequest
_ = json.NewDecoder(r.Body).Decode(&req)
f.submits = append(f.submits, submitCall{number: n, req: req})
if f.submitStatus != 0 {
w.WriteHeader(f.submitStatus)
_, _ = w.Write([]byte(f.submitBody))
return
}
if f.pollsUntilDone == 0 {
f.settle(w, n)
return
}
writeJSON(w, http.StatusAccepted, map[string]any{"status": mergeStatusPending, "details": map[string]string{"uuid": "uuid-1"}})
case parts[0] == "pulls" && len(parts) == 4 && r.Method == http.MethodGet:
n, _ := strconv.Atoi(parts[1])
f.polls++
if f.polls < f.pollsUntilDone {
writeJSON(w, http.StatusOK, map[string]any{"status": mergeStatusPending})
return
}
f.settle(w, n)
default:
w.WriteHeader(http.StatusNotFound)
}
}
func (f *fakeGitHub) settle(w http.ResponseWriter, top int) {
status := f.finalStatus
if status == "" {
status = mergeStatusMerged
}
if f.failMerges[top] {
status = mergeStatusFailed
}
if status == mergeStatusMerged {
f.landStack(top)
for n, pr := range f.pulls {
if pr.Merged {
f.lagging[n] = f.mergedReadLag
}
}
}
writeJSON(w, http.StatusOK, map[string]any{"status": status, "details": map[string]string{"message": "merge " + status, "sha": mergeSHA(top)}})
}
func writeJSON(w http.ResponseWriter, code int, v any) {
w.Header().Set("Content-Type", "application/json")
w.WriteHeader(code)
_ = json.NewEncoder(w).Encode(v)
}
func newTestMerger(t *testing.T, gh *fakeGitHub) merger.Merger {
t.Helper()
srv := httptest.NewServer(gh)
t.Cleanup(srv.Close)
httpClient, err := phttp.NewClient(srv.URL)
require.NoError(t, err)
m, err := New(Params{
HTTPClient: httpClient,
Host: testHost,
Owner: testOwner,
Repo: testRepo,
Target: testTarget,
DefaultStrategy: mergestrategypb.Strategy_SQUASH_REBASE,
PollInterval: -1,
Logger: zaptest.NewLogger(t).Sugar(),
MetricsScope: tally.NoopScope,
})
require.NoError(t, err)
return m
}
func step(id string, strategy mergestrategypb.Strategy, uris ...string) *runwaymq.MergeStep {
return &runwaymq.MergeStep{StepId: id, Change: &changepb.Change{Uris: uris}, Strategy: strategy}
}
func request(steps ...*runwaymq.MergeStep) *runwaymq.MergeRequest {
return &runwaymq.MergeRequest{Id: "req-1", QueueName: "q", Steps: steps}
}
func outputIDs(r *runwaymq.StepResult) []string {
var ids []string
for _, o := range r.GetOutputs() {
ids = append(ids, o.GetId())
}
return ids
}
func TestMerge(t *testing.T) {
tests := []struct {
name string
setup func(*fakeGitHub)
req *runwaymq.MergeRequest
wantErr error
wantOutputs map[string][]string
wantSubmits []submitCall
// wantFailedStep, on an error, names the step reported as failed after
// the steps in wantOutputs landed; empty means no result is returned.
wantFailedStep string
}{
{
name: "single pull request on trunk",
setup: func(f *fakeGitHub) { f.addPull(1, testTarget) },
req: request(step("s1", mergestrategypb.Strategy_REBASE, uri(1))),
wantOutputs: map[string][]string{"s1": {mergeSHA(1)}},
wantSubmits: []submitCall{{number: 1, req: asyncMergeRequest{SHA: headSHA(1), MergeMethod: "rebase", MergeAction: mergeActionDirect}}},
},
{
name: "stack lands with one merge on its top pull request",
setup: func(f *fakeGitHub) { f.addStack(7, 1, 2, 3) },
req: request(step("s1", mergestrategypb.Strategy_DEFAULT, uri(1), uri(2), uri(3))),
wantOutputs: map[string][]string{"s1": {mergeSHA(1), mergeSHA(2), mergeSHA(3)}},
wantSubmits: []submitCall{{number: 3, req: asyncMergeRequest{SHA: headSHA(3), MergeMethod: "squash", MergeAction: mergeActionDirect}}},
},
{
name: "bottom of a stack lands without the pull requests above it",
setup: func(f *fakeGitHub) { f.addStack(7, 1, 2, 3) },
req: request(step("s1", mergestrategypb.Strategy_MERGE, uri(1), uri(2))),
wantOutputs: map[string][]string{"s1": {mergeSHA(1), mergeSHA(2)}},
wantSubmits: []submitCall{{number: 2, req: asyncMergeRequest{SHA: headSHA(2), MergeMethod: "merge", MergeAction: mergeActionDirect}}},
},
{
name: "redelivery skips the already-merged bottom of a stack",
setup: func(f *fakeGitHub) {
f.addStack(7, 1, 2)
f.markMerged(1)
f.pulls[2].Base.Ref = testTarget
},
req: request(step("s1", mergestrategypb.Strategy_SQUASH_REBASE, uri(1), uri(2))),
wantOutputs: map[string][]string{"s1": {mergeSHA(1), mergeSHA(2)}},
wantSubmits: []submitCall{{number: 2, req: asyncMergeRequest{SHA: headSHA(2), MergeMethod: "squash", MergeAction: mergeActionDirect}}},
},
{
name: "fully merged step reports outputs without merging",
setup: func(f *fakeGitHub) {
f.addStack(7, 1, 2)
f.landStack(2)
},
req: request(step("s1", mergestrategypb.Strategy_SQUASH_REBASE, uri(1), uri(2))),
wantOutputs: map[string][]string{"s1": {mergeSHA(1), mergeSHA(2)}},
},
{
name: "merge commits not yet recorded after the merge settles are re-read",
setup: func(f *fakeGitHub) {
f.addStack(7, 1, 2)
f.mergedReadLag = 2
},
req: request(step("s1", mergestrategypb.Strategy_SQUASH_REBASE, uri(1), uri(2))),
wantOutputs: map[string][]string{"s1": {mergeSHA(1), mergeSHA(2)}},
wantSubmits: []submitCall{{number: 2, req: asyncMergeRequest{SHA: headSHA(2), MergeMethod: "squash", MergeAction: mergeActionDirect}}},
},
{
name: "merge commit past the first page of events",
setup: func(f *fakeGitHub) {
f.addPull(1, testTarget)
f.eventPadding = issueEventsPageSize + 5
},
req: request(step("s1", mergestrategypb.Strategy_MERGE, uri(1))),
wantOutputs: map[string][]string{"s1": {mergeSHA(1)}},
wantSubmits: []submitCall{{number: 1, req: asyncMergeRequest{SHA: headSHA(1), MergeMethod: "merge", MergeAction: mergeActionDirect}}},
},
{
name: "pending merge is polled until it lands",
setup: func(f *fakeGitHub) {
f.addPull(1, testTarget)
f.pollsUntilDone = 3
},
req: request(step("s1", mergestrategypb.Strategy_SQUASH_REBASE, uri(1))),
wantOutputs: map[string][]string{"s1": {mergeSHA(1)}},
wantSubmits: []submitCall{{number: 1, req: asyncMergeRequest{SHA: headSHA(1), MergeMethod: "squash", MergeAction: mergeActionDirect}}},
},
{
name: "existing in-flight request is adopted",
setup: func(f *fakeGitHub) {
f.addPull(1, testTarget)
f.pollsUntilDone = 2
f.submitStatus = http.StatusConflict
f.submitBody = `{"status":"pending","details":{"uuid":"uuid-0","expected_head_sha":"` + headSHA(1) + `","merge_method":"squash"}}`
},
req: request(step("s1", mergestrategypb.Strategy_SQUASH_REBASE, uri(1))),
wantOutputs: map[string][]string{"s1": {mergeSHA(1)}},
wantSubmits: []submitCall{{number: 1, req: asyncMergeRequest{SHA: headSHA(1), MergeMethod: "squash", MergeAction: mergeActionDirect}}},
},
{
name: "steps land in order",
setup: func(f *fakeGitHub) {
f.addPull(1, testTarget)
f.addStack(7, 2, 3)
},
req: request(
step("s1", mergestrategypb.Strategy_REBASE, uri(1)),
step("s2", mergestrategypb.Strategy_SQUASH_REBASE, uri(2), uri(3)),
),
wantOutputs: map[string][]string{"s1": {mergeSHA(1)}, "s2": {mergeSHA(2), mergeSHA(3)}},
wantSubmits: []submitCall{
{number: 1, req: asyncMergeRequest{SHA: headSHA(1), MergeMethod: "rebase", MergeAction: mergeActionDirect}},
{number: 3, req: asyncMergeRequest{SHA: headSHA(3), MergeMethod: "squash", MergeAction: mergeActionDirect}},
},
},
{
name: "failed merge is a conflict",
setup: func(f *fakeGitHub) {
f.addPull(1, testTarget)
f.finalStatus = mergeStatusFailed
},
req: request(step("s1", mergestrategypb.Strategy_REBASE, uri(1))),
wantErr: merger.ErrConflict,
wantFailedStep: "s1",
wantSubmits: []submitCall{{number: 1, req: asyncMergeRequest{SHA: headSHA(1), MergeMethod: "rebase", MergeAction: mergeActionDirect}}},
},
{
name: "refused merge is an invalid request",
setup: func(f *fakeGitHub) {
f.addPull(1, testTarget)
f.submitStatus = http.StatusUnprocessableEntity
f.submitBody = `{"details":{"message":"required status checks"}}`
},
req: request(step("s1", mergestrategypb.Strategy_REBASE, uri(1))),
wantErr: merger.ErrInvalidRequest,
wantFailedStep: "s1",
wantSubmits: []submitCall{{number: 1, req: asyncMergeRequest{SHA: headSHA(1), MergeMethod: "rebase", MergeAction: mergeActionDirect}}},
},
{
name: "head moved since the URI was minted",
setup: func(f *fakeGitHub) {
f.addPull(1, testTarget)
f.pulls[1].Head.SHA = headSHA(99)
},
req: request(step("s1", mergestrategypb.Strategy_REBASE, uri(1))),
wantErr: merger.ErrInvalidRequest,
wantFailedStep: "s1",
},
{
name: "closed pull request",
setup: func(f *fakeGitHub) {
f.addPull(1, testTarget)
f.pulls[1].State = "closed"
},
req: request(step("s1", mergestrategypb.Strategy_REBASE, uri(1))),
wantErr: merger.ErrInvalidRequest,
wantFailedStep: "s1",
},
{
name: "stack unstacked after validation is refused before merging",
setup: func(f *fakeGitHub) {
f.addPull(1, testTarget)
f.addPull(2, testTarget)
},
req: request(step("s1", mergestrategypb.Strategy_REBASE, uri(1), uri(2))),
wantErr: merger.ErrInvalidRequest,
wantFailedStep: "s1",
},
{
name: "invalid later step stops the request after earlier steps land",
setup: func(f *fakeGitHub) {
f.addPull(1, testTarget)
f.addPull(2, "feature")
},
req: request(
step("s1", mergestrategypb.Strategy_REBASE, uri(1)),
step("s2", mergestrategypb.Strategy_REBASE, uri(2)),
),
wantErr: merger.ErrInvalidRequest,
wantOutputs: map[string][]string{"s1": {mergeSHA(1)}},
wantFailedStep: "s2",
wantSubmits: []submitCall{{number: 1, req: asyncMergeRequest{SHA: headSHA(1), MergeMethod: "rebase", MergeAction: mergeActionDirect}}},
},
{
name: "merge GitHub fails after a landed step is a conflict",
setup: func(f *fakeGitHub) {
f.addPull(1, testTarget)
f.addPull(2, testTarget)
f.failMerges = map[int]bool{2: true}
},
req: request(
step("s1", mergestrategypb.Strategy_REBASE, uri(1)),
step("s2", mergestrategypb.Strategy_REBASE, uri(2)),
),
wantErr: merger.ErrConflict,
wantOutputs: map[string][]string{"s1": {mergeSHA(1)}},
wantFailedStep: "s2",
wantSubmits: []submitCall{
{number: 1, req: asyncMergeRequest{SHA: headSHA(1), MergeMethod: "rebase", MergeAction: mergeActionDirect}},
{number: 2, req: asyncMergeRequest{SHA: headSHA(2), MergeMethod: "rebase", MergeAction: mergeActionDirect}},
},
},
{
name: "steps after a failed one are not attempted",
setup: func(f *fakeGitHub) {
f.addPull(1, testTarget)
f.addPull(2, testTarget)
f.addPull(3, testTarget)
f.failMerges = map[int]bool{2: true}
},
req: request(
step("s1", mergestrategypb.Strategy_REBASE, uri(1)),
step("s2", mergestrategypb.Strategy_REBASE, uri(2)),
step("s3", mergestrategypb.Strategy_REBASE, uri(3)),
),
wantErr: merger.ErrConflict,
wantOutputs: map[string][]string{"s1": {mergeSHA(1)}},
wantFailedStep: "s2",
wantSubmits: []submitCall{
{number: 1, req: asyncMergeRequest{SHA: headSHA(1), MergeMethod: "rebase", MergeAction: mergeActionDirect}},
{number: 2, req: asyncMergeRequest{SHA: headSHA(2), MergeMethod: "rebase", MergeAction: mergeActionDirect}},
},
},
{
name: "in-flight merge for a different head is not adopted",
setup: func(f *fakeGitHub) {
f.addPull(1, testTarget)
f.submitStatus = http.StatusConflict
f.submitBody = `{"status":"pending","details":{"uuid":"uuid-0","expected_head_sha":"` + headSHA(99) + `","merge_method":"squash"}}`
},
req: request(step("s1", mergestrategypb.Strategy_SQUASH_REBASE, uri(1))),
wantErr: merger.ErrInvalidRequest,
wantFailedStep: "s1",
wantSubmits: []submitCall{{number: 1, req: asyncMergeRequest{SHA: headSHA(1), MergeMethod: "squash", MergeAction: mergeActionDirect}}},
},
{
name: "in-flight merge with a different method is not adopted",
setup: func(f *fakeGitHub) {
f.addPull(1, testTarget)
f.submitStatus = http.StatusConflict
f.submitBody = `{"status":"pending","details":{"uuid":"uuid-0","expected_head_sha":"` + headSHA(1) + `","merge_method":"merge"}}`
},
req: request(step("s1", mergestrategypb.Strategy_SQUASH_REBASE, uri(1))),
wantErr: merger.ErrInvalidRequest,
wantFailedStep: "s1",
wantSubmits: []submitCall{{number: 1, req: asyncMergeRequest{SHA: headSHA(1), MergeMethod: "squash", MergeAction: mergeActionDirect}}},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
gh := newFakeGitHub()
tt.setup(gh)
m := newTestMerger(t, gh)
result, err := m.Merge(context.Background(), tt.req)
assert.Equal(t, tt.wantSubmits, gh.submits)
if tt.wantErr != nil {
require.ErrorIs(t, err, tt.wantErr)
if tt.wantFailedStep == "" {
assert.Nil(t, result)
return
}
assert.Equal(t, runwaypb.Outcome_FAILED, result.GetOutcome())
steps := result.GetSteps()
require.Len(t, steps, len(tt.wantOutputs)+1)
for _, sr := range steps[:len(steps)-1] {
assert.Equal(t, tt.wantOutputs[sr.GetStepId()], outputIDs(sr), sr.GetStepId())
}
failed := steps[len(steps)-1]
assert.Equal(t, tt.wantFailedStep, failed.GetStepId())
assert.NotEmpty(t, failed.GetReason())
assert.Empty(t, failed.GetOutputs())
return
}
require.NoError(t, err)
assert.Equal(t, runwaypb.Outcome_SUCCEEDED, result.GetOutcome())
assert.Equal(t, tt.req.GetId(), result.GetId())
require.Len(t, result.GetSteps(), len(tt.req.GetSteps()))
for _, sr := range result.GetSteps() {
assert.Equal(t, tt.wantOutputs[sr.GetStepId()], outputIDs(sr), sr.GetStepId())
}
})
}
}
func TestMergeErrorClassification(t *testing.T) {
t.Run("server error stays a retryable status error", func(t *testing.T) {
gh := newFakeGitHub()
gh.addPull(1, testTarget)
gh.pullErrStatus = http.StatusBadGateway
m := newTestMerger(t, gh)
_, err := m.Merge(context.Background(), request(step("s1", mergestrategypb.Strategy_REBASE, uri(1))))
require.Error(t, err)
assert.False(t, merger.IsTerminal(err))
var se *phttp.StatusError
require.ErrorAs(t, err, &se)
assert.Equal(t, http.StatusBadGateway, se.StatusCode)
})
t.Run("merge outlasting the poll budget is pending and retryable", func(t *testing.T) {
gh := newFakeGitHub()
gh.addPull(1, testTarget)
gh.pollsUntilDone = 1 << 30
srv := httptest.NewServer(gh)
t.Cleanup(srv.Close)
httpClient, err := phttp.NewClient(srv.URL)
require.NoError(t, err)
m, err := New(Params{
HTTPClient: httpClient,
Host: testHost,
Owner: testOwner,
Repo: testRepo,
Target: testTarget,
DefaultStrategy: mergestrategypb.Strategy_REBASE,
PollInterval: -1,
MaxPollDuration: time.Nanosecond,
Logger: zaptest.NewLogger(t).Sugar(),
MetricsScope: tally.NoopScope,
})
require.NoError(t, err)
_, err = m.Merge(context.Background(), request(step("s1", mergestrategypb.Strategy_REBASE, uri(1))))
require.ErrorIs(t, err, ErrMergePending)
assert.False(t, merger.IsTerminal(err))
assert.True(t, errs.IsRetryable(errs.NewClassifierProcessor(Classifier).Process(err)))
})
}
func TestCheckMergeability(t *testing.T) {
tests := []struct {
name string
setup func(*fakeGitHub)
req *runwaymq.MergeRequest
wantErr error
}{
{
name: "single pull request on trunk is mergeable",
setup: func(f *fakeGitHub) { f.addPull(1, testTarget) },
req: request(step("s1", mergestrategypb.Strategy_REBASE, uri(1))),
},
{
name: "stack in order is mergeable",
setup: func(f *fakeGitHub) { f.addStack(7, 1, 2, 3) },
req: request(step("s1", mergestrategypb.Strategy_REBASE, uri(1), uri(2), uri(3))),
},
{
name: "mergeability still being computed is re-read",
setup: func(f *fakeGitHub) {
f.addPull(1, testTarget)
f.mergeableNullReads = 3
},
req: request(step("s1", mergestrategypb.Strategy_REBASE, uri(1))),
},
{
name: "conflicting pull request is a conflict",
setup: func(f *fakeGitHub) {
f.addStack(7, 1, 2)
f.unmergeable = map[int]bool{2: true}
},
req: request(step("s1", mergestrategypb.Strategy_REBASE, uri(1), uri(2))),
wantErr: merger.ErrConflict,
},
{
name: "independent pull requests on trunk are not a stack",
setup: func(f *fakeGitHub) {
f.addPull(1, testTarget)
f.addPull(2, testTarget)
},
req: request(step("s1", mergestrategypb.Strategy_REBASE, uri(1), uri(2))),
wantErr: merger.ErrInvalidRequest,
},
{
name: "stack listed top first",
setup: func(f *fakeGitHub) { f.addStack(7, 1, 2) },
req: request(step("s1", mergestrategypb.Strategy_REBASE, uri(2), uri(1))),
wantErr: merger.ErrInvalidRequest,
},
{
name: "stack listed with a gap",
setup: func(f *fakeGitHub) { f.addStack(7, 1, 2, 3) },
req: request(step("s1", mergestrategypb.Strategy_REBASE, uri(1), uri(3))),
wantErr: merger.ErrInvalidRequest,
},
{
name: "pull requests from two stacks",
setup: func(f *fakeGitHub) {
f.addStack(7, 1, 2)
f.addStack(8, 3, 4)
},
req: request(step("s1", mergestrategypb.Strategy_REBASE, uri(1), uri(4))),
wantErr: merger.ErrInvalidRequest,
},
{
name: "upper stacked pull request without the ones below it",
setup: func(f *fakeGitHub) { f.addStack(7, 1, 2) },
req: request(step("s1", mergestrategypb.Strategy_REBASE, uri(2))),
wantErr: merger.ErrInvalidRequest,
},
{
name: "stack based on another branch",
setup: func(f *fakeGitHub) {
f.addStack(7, 1, 2)
f.stacks[0].Base.Ref = "release"
f.pulls[1].Base.Ref = "release"
},
req: request(step("s1", mergestrategypb.Strategy_REBASE, uri(1), uri(2))),
wantErr: merger.ErrInvalidRequest,
},
{
name: "draft pull request",
setup: func(f *fakeGitHub) {
f.addPull(1, testTarget)
f.pulls[1].Draft = true
},
req: request(step("s1", mergestrategypb.Strategy_REBASE, uri(1))),
wantErr: merger.ErrInvalidRequest,
},
{
name: "change in another repository",
setup: func(f *fakeGitHub) {},
req: request(step("s1", mergestrategypb.Strategy_REBASE, "github://github.com/uber/other/pull/1/"+headSHA(1))),
wantErr: merger.ErrInvalidRequest,
},
{
name: "change on another host",
setup: func(f *fakeGitHub) {},
req: request(step("s1", mergestrategypb.Strategy_REBASE, "github://github.example.com/uber/submitqueue/pull/1/"+headSHA(1))),
wantErr: merger.ErrInvalidRequest,
},
{
name: "non-github change",
setup: func(f *fakeGitHub) {},
req: request(step("s1", mergestrategypb.Strategy_REBASE, "git://github.com/uber/submitqueue/refs%2Fheads%2Fmain/"+headSHA(1))),
wantErr: merger.ErrInvalidRequest,
},
{
name: "promote is unsupported",
setup: func(f *fakeGitHub) { f.addPull(1, testTarget) },
req: request(step("s1", mergestrategypb.Strategy_PROMOTE, uri(1))),
wantErr: merger.ErrInvalidRequest,
},
{
name: "request without steps",
setup: func(f *fakeGitHub) {},
req: request(),
wantErr: merger.ErrInvalidRequest,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
gh := newFakeGitHub()
tt.setup(gh)
m := newTestMerger(t, gh)
result, err := m.CheckMergeability(context.Background(), tt.req)
assert.Empty(t, gh.submits, "a dry run must not merge")
if tt.wantErr != nil {
require.ErrorIs(t, err, tt.wantErr)
return
}
require.NoError(t, err)
assert.Equal(t, runwaypb.Outcome_SUCCEEDED, result.GetOutcome())
for _, sr := range result.GetSteps() {
assert.Empty(t, sr.GetOutputs())
}
})
}
}
func TestNewRejectsUnusableParams(t *testing.T) {
valid := Params{
HTTPClient: http.DefaultClient,
Host: testHost,
Owner: testOwner,
Repo: testRepo,
Target: testTarget,
DefaultStrategy: mergestrategypb.Strategy_REBASE,
Logger: zaptest.NewLogger(t).Sugar(),
MetricsScope: tally.NoopScope,
}
tests := []struct {
name string
mutate func(*Params)
}{
{name: "missing http client", mutate: func(p *Params) { p.HTTPClient = nil }},
{name: "missing repo", mutate: func(p *Params) { p.Repo = "" }},
{name: "missing target", mutate: func(p *Params) { p.Target = "" }},
{name: "promote default", mutate: func(p *Params) { p.DefaultStrategy = mergestrategypb.Strategy_PROMOTE }},
{name: "default default", mutate: func(p *Params) { p.DefaultStrategy = mergestrategypb.Strategy_DEFAULT }},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
p := valid
tt.mutate(&p)
_, err := New(p)
require.Error(t, err)
})
}
_, err := New(valid)
require.NoError(t, err)
}
func stepPullForTest(n int, merged bool, base string) stepPull {
return stepPull{
ref: changeRef{PRNumber: n, SHA: headSHA(n), Label: fmt.Sprintf("uber/submitqueue#%d", n)},
pr: pullRequest{Number: n, Merged: merged, Base: gitRef{Ref: base}},
}
}
func TestValidateStepIsGitHubStack_MergedMustPrecedeUnmerged(t *testing.T) {
m := &githubMerger{target: testTarget}
step := &runwaymq.MergeStep{}
tests := []struct {
name string
pulls []stepPull
wantErr bool
}{
{name: "all merged", pulls: []stepPull{stepPullForTest(1, true, testTarget), stepPullForTest(2, true, testTarget)}},
{name: "merged prefix then one open pull on target", pulls: []stepPull{stepPullForTest(1, true, testTarget), stepPullForTest(2, false, testTarget)}},
{name: "merged pull listed after an unmerged one", pulls: []stepPull{stepPullForTest(1, false, testTarget), stepPullForTest(2, true, testTarget)}, wantErr: true},
{name: "merged pull between unmerged ones", pulls: []stepPull{stepPullForTest(1, false, testTarget), stepPullForTest(2, true, "branch-1"), stepPullForTest(3, false, "branch-2")}, wantErr: true},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
err := m.validateStepIsGitHubStack(context.Background(), step, tt.pulls)
if tt.wantErr {
require.Error(t, err)
assert.ErrorIs(t, err, merger.ErrInvalidRequest)
return
}
require.NoError(t, err)
})
}
}