-
Notifications
You must be signed in to change notification settings - Fork 2.6k
/
submit-queue.go
1625 lines (1432 loc) · 50.2 KB
/
submit-queue.go
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 2015 The Kubernetes Authors.
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 mungers
import (
"bytes"
"encoding/json"
"errors"
"fmt"
"math"
"net/http"
"sort"
"strconv"
"strings"
"sync"
"sync/atomic"
"time"
utilclock "k8s.io/kubernetes/pkg/util/clock"
"k8s.io/kubernetes/pkg/util/sets"
"k8s.io/contrib/test-utils/utils"
"k8s.io/test-infra/mungegithub/admin"
"k8s.io/test-infra/mungegithub/features"
"k8s.io/test-infra/mungegithub/github"
"k8s.io/test-infra/mungegithub/mungeopts"
"k8s.io/test-infra/mungegithub/mungers/e2e"
fake_e2e "k8s.io/test-infra/mungegithub/mungers/e2e/fake"
"k8s.io/test-infra/mungegithub/mungers/mungerutil"
"k8s.io/test-infra/mungegithub/mungers/shield"
"k8s.io/test-infra/mungegithub/options"
"github.com/NYTimes/gziphandler"
"github.com/golang/glog"
githubapi "github.com/google/go-github/github"
"github.com/prometheus/client_golang/prometheus"
"github.com/prometheus/client_golang/prometheus/promhttp"
)
const (
approvedLabel = "approved"
lgtmLabel = "lgtm"
retestNotRequiredLabel = "retest-not-required"
retestNotRequiredDocsOnlyLabel = "retest-not-required-docs-only"
doNotMergeLabel = "do-not-merge"
claYesLabel = "cla: yes"
claNoLabel = "cla: no"
cncfClaYesLabel = "cncf-cla: yes"
cncfClaNoLabel = "cncf-cla: no"
claHumanLabel = "cla: human-approved"
criticalFixLabel = "queue/critical-fix"
blocksOthersLabel = "queue/blocks-others"
fixLabel = "queue/fix"
multirebaseLabel = "queue/multiple-rebases"
sqContext = "Submit Queue"
githubE2EPollTime = 30 * time.Second
)
var (
// This MUST cause a RETEST of everything in the mungeopts.RequiredContexts.Retest
// TODO(juntee): remove oldRetestBody when the old command retires
newRetestBody = "/test all [submit-queue is verifying that this PR is safe to merge]"
oldRetestBody = fmt.Sprintf("@%s test this [submit-queue is verifying that this PR is safe to merge]", jenkinsBotName)
// this is the order in which labels will be compared for queue priority
labelPriorities = []string{criticalFixLabel, retestNotRequiredLabel, retestNotRequiredDocsOnlyLabel, multirebaseLabel, fixLabel, blocksOthersLabel}
// high priority labels are checked before the release
lastHighPriorityLabel = 2 // retestNotRequiredDocsOnlyLabel
)
type submitStatus struct {
Time time.Time
statusPullRequest
Reason string
}
type statusPullRequest struct {
Number int
URL string
Title string
Login string
AvatarURL string
Additions int
Deletions int
ExtraInfo []string
BaseRef string
}
type e2eQueueStatus struct {
E2ERunning *statusPullRequest
E2EQueue []*statusPullRequest
BatchStatus *submitQueueBatchStatus
}
type submitQueueStatus struct {
PRStatus map[string]submitStatus
}
// Information about the e2e test health. Call updateHealth on the SubmitQueue
// at roughly constant intervals to keep this up to date. The mergeable fraction
// of time for the queue as a whole and the individual jobs will then be
// NumStable[PerJob] / TotalLoops.
type submitQueueHealth struct {
TotalLoops int
NumStable int
NumStablePerJob map[string]int
MergePossibleNow bool
}
// Generate health information using a queue of healthRecords. The bools are
// true for stable and false otherwise.
type healthRecord struct {
Time time.Time
Overall bool
Jobs map[string]bool
}
// information about the sq itself including how fast things are merging and
// how long since the last merge
type submitQueueStats struct {
Added int // Number of items added to the queue since restart
FlakesIgnored int
Initialized bool // true if we've made at least one complete pass
InstantMerges int // Number of merges without retests required
BatchMerges int // Number of merges caused by batch
LastMergeTime time.Time
MergeRate float64
MergesSinceRestart int
Removed int // Number of items dequeued since restart
RetestsAvoided int
StartTime time.Time
Tested int // Number of e2e tests completed
}
// pull-request that has been tested as successful, but interrupted because head flaked
type submitQueueInterruptedObject struct {
obj *github.MungeObject
// If these two items match when we're about to kick off a retest, it's safe to skip the retest.
interruptedMergeHeadSHA string
interruptedMergeBaseSHA string
}
// Contains metadata about this instance of the submit queue such as URLs.
// Consumed by the template system.
type submitQueueMetadata struct {
ProjectName string
ChartUrl string
HistoryUrl string
// chartUrl and historyUrl are option storage locations. They are distinct from ChartUrl and
// HistoryUrl since the the public variables are used asynchronously by a fileserver and updates
// to the options values should not cause a race condition.
chartUrl string
historyUrl string
RepoPullUrl string
ProwUrl string
}
type submitQueueBatchStatus struct {
Error map[string]string
Running *prowJob
}
type prometheusMetrics struct {
Loops prometheus.Counter
Blocked prometheus.Gauge
OpenPRs prometheus.Gauge
QueuedPRs prometheus.Gauge
MergeCount prometheus.Counter
}
var (
promMetrics = prometheusMetrics{
Loops: prometheus.NewCounter(prometheus.CounterOpts{
Name: "submitqueue_loops",
Help: "Number of loops performed by the queue",
}),
Blocked: prometheus.NewGauge(prometheus.GaugeOpts{
Name: "submitqueue_blocked",
Help: "The submit-queue is currently blocked",
}),
OpenPRs: prometheus.NewGauge(prometheus.GaugeOpts{
Name: "submitqueue_open_pullrequests_total",
Help: "Number of open pull-requests",
}),
QueuedPRs: prometheus.NewGauge(prometheus.GaugeOpts{
Name: "submitqueue_queued_pullrequests_total",
Help: "Number of pull-requests queued",
}),
MergeCount: prometheus.NewCounter(prometheus.CounterOpts{
Name: "submitqueue_merge_total",
Help: "Number of merges done",
}),
}
)
// SubmitQueue will merge PR which meet a set of requirements.
// PR must have LGTM after the last commit
// PR must have passed all github CI checks
// The google internal jenkins instance must be passing the BlockingJobNames e2e tests
type SubmitQueue struct {
githubConfig *github.Config
opts *options.Options
NonBlockingJobNames []string
GateApproved bool
GateCLA bool
// If FakeE2E is true, don't try to connect to JenkinsHost, all jobs are passing.
FakeE2E bool
DoNotMergeMilestones []string
Metadata submitQueueMetadata
AdminPort int
sync.Mutex
prStatus map[string]submitStatus // protected by sync.Mutex
statusHistory []submitStatus // protected by sync.Mutex
lastClosedTime time.Time
clock utilclock.Clock
startTime time.Time // when the queue started (duh)
lastMergeTime time.Time
totalMerges int32
mergeRate float64 // per 24 hours
loopStarts int32 // if > 1, then we must have made a complete pass.
githubE2ERunning *github.MungeObject // protect by sync.Mutex!
githubE2EQueue map[int]*github.MungeObject // protected by sync.Mutex!
githubE2EPollTime time.Duration
lgtmTimeCache *mungerutil.LabelTimeCache
lastE2EStable bool // was e2e stable last time they were checked, protect by sync.Mutex
e2e e2e.E2ETester
interruptedObj *submitQueueInterruptedObject
flakesIgnored int32 // Increments for each merge while 1+ job is flaky
instantMerges int32 // Increments whenever we merge without retesting
batchMerges int32 // Increments whenever we merge because of a batch
prsAdded int32 // Increments whenever an items queues
prsRemoved int32 // Increments whenever an item dequeues
prsTested int32 // Number of prs that completed second testing
retestsAvoided int32 // Increments whenever we skip due to head not changing.
health submitQueueHealth
healthHistory []healthRecord
emergencyMergeStopFlag int32
features *features.Features
mergeLock sync.Mutex // acquired when attempting to merge a specific PR
ProwUrl string // prow base page
BatchEnabled bool
ContextURL string
batchStatus submitQueueBatchStatus
}
func init() {
clock := utilclock.RealClock{}
prometheus.MustRegister(promMetrics.Loops)
prometheus.MustRegister(promMetrics.Blocked)
prometheus.MustRegister(promMetrics.OpenPRs)
prometheus.MustRegister(promMetrics.QueuedPRs)
prometheus.MustRegister(promMetrics.MergeCount)
sq := &SubmitQueue{
clock: clock,
startTime: clock.Now(),
lastMergeTime: clock.Now(),
lastE2EStable: true,
prStatus: map[string]submitStatus{},
githubE2EQueue: map[int]*github.MungeObject{},
}
RegisterMungerOrDie(sq)
RegisterStaleIssueComments(sq)
}
// Name is the name usable in --pr-mungers
func (sq *SubmitQueue) Name() string { return "submit-queue" }
// RequiredFeatures is a slice of 'features' that must be provided
func (sq *SubmitQueue) RequiredFeatures() []string {
return []string{features.BranchProtectionFeature}
}
func (sq *SubmitQueue) emergencyMergeStop() bool {
return atomic.LoadInt32(&sq.emergencyMergeStopFlag) != 0
}
func (sq *SubmitQueue) setEmergencyMergeStop(stopMerges bool) {
if stopMerges {
atomic.StoreInt32(&sq.emergencyMergeStopFlag, 1)
} else {
atomic.StoreInt32(&sq.emergencyMergeStopFlag, 0)
}
}
// EmergencyStopHTTP sets the emergency stop flag. It expects the path of
// req.URL to contain either "emergency/stop", "emergency/resume", or "emergency/status".
func (sq *SubmitQueue) EmergencyStopHTTP(res http.ResponseWriter, req *http.Request) {
switch {
case strings.Contains(req.URL.Path, "emergency/stop"):
sq.setEmergencyMergeStop(true)
case strings.Contains(req.URL.Path, "emergency/resume"):
sq.setEmergencyMergeStop(false)
case strings.Contains(req.URL.Path, "emergency/status"):
default:
http.NotFound(res, req)
return
}
sq.serve(sq.marshal(struct{ EmergencyInProgress bool }{sq.emergencyMergeStop()}), res, req)
}
func round(num float64) int {
return int(num + math.Copysign(0.5, num))
}
func toFixed(num float64) float64 {
output := math.Pow(10, float64(3))
return float64(round(num*output)) / output
}
// This is the calculation of the exponential smoothing factor. It tries to
// make sure that if we get lots of fast merges we don't race the 'daily'
// avg really high really fast. But more importantly it means that if merges
// start going slowly the 'daily' average will get pulled down a lot by one
// slow merge instead of requiring numerous merges to get pulled down
func getSmoothFactor(dur time.Duration) float64 {
hours := dur.Hours()
smooth := .155*math.Log(hours) + .422
if smooth < .1 {
return .1
}
if smooth > .999 {
return .999
}
return smooth
}
// This calculates an exponentially smoothed merge Rate based on the formula
// newRate = (1-smooth)oldRate + smooth*newRate
// Which is really great and simple for constant time series data. But of course
// ours isn't time series data so I vary the smoothing factor based on how long
// its been since the last entry. See the comments on the `getSmoothFactor` for
// a discussion of why.
// This whole thing was dreamed up by eparis one weekend via a combination
// of guess-and-test and intuition. Someone who knows about this stuff
// is likely to laugh at the naivete. Point him to where someone intelligent
// has thought about this stuff and he will gladly do something smart.
// Merges that took less than 5 minutes are ignored completely for the rate
// calculation.
func calcMergeRate(oldRate float64, last, now time.Time) float64 {
since := now.Sub(last)
if since <= 5*time.Minute {
// retest-not-required PR merges shouldn't affect our best
// guess about the rate.
return oldRate
}
var rate float64
if since == 0 {
rate = 96
} else {
rate = 24.0 * time.Hour.Hours() / since.Hours()
}
smoothingFactor := getSmoothFactor(since)
mergeRate := ((1.0 - smoothingFactor) * oldRate) + (smoothingFactor * rate)
return toFixed(mergeRate)
}
// Updates a smoothed rate at which PRs are merging per day.
// Updates merge stats. Should be called once for every merge.
func (sq *SubmitQueue) updateMergeRate() {
now := sq.clock.Now()
sq.mergeRate = calcMergeRate(sq.mergeRate, sq.lastMergeTime, now)
// Update stats
promMetrics.MergeCount.Inc()
atomic.AddInt32(&sq.totalMerges, 1)
sq.lastMergeTime = now
}
// This calculated the smoothed merge rate BUT it looks at the time since
// the last merge vs 'Now'. If we have not passed the next 'expected' time
// for a merge this just returns previous calculations. If 'Now' is later
// than we would expect given the existing mergeRate then pretend a merge
// happened right now and return the new merge rate. This way the merge rate
// is lower even if no merge has happened in a long time.
func (sq *SubmitQueue) calcMergeRateWithTail() float64 {
now := sq.clock.Now()
if sq.mergeRate == 0 {
return 0
}
// Figure out when we think the next merge would happen given the history
next := time.Duration(24/sq.mergeRate*time.Hour.Hours()) * time.Hour
expectedMergeTime := sq.lastMergeTime.Add(next)
// If we aren't there yet, just return the history
if !now.After(expectedMergeTime) {
return sq.mergeRate
}
// Pretend as though a merge happened right now to pull down the rate
return calcMergeRate(sq.mergeRate, sq.lastMergeTime, now)
}
// Initialize will initialize the munger
func (sq *SubmitQueue) Initialize(config *github.Config, features *features.Features) error {
sq.features = features
return sq.internalInitialize(config, features, "")
}
// internalInitialize will initialize the munger.
// if overrideUrl is specified, will create testUtils
func (sq *SubmitQueue) internalInitialize(config *github.Config, features *features.Features, overrideUrl string) error {
sq.Lock()
defer sq.Unlock()
sq.Metadata.ChartUrl = sq.Metadata.chartUrl
sq.Metadata.HistoryUrl = sq.Metadata.historyUrl
sq.Metadata.ProwUrl = sq.ProwUrl
sq.Metadata.RepoPullUrl = fmt.Sprintf("https://github.com/%s/%s/pulls/", config.Org, config.Project)
sq.Metadata.ProjectName = strings.Title(config.Project)
sq.githubConfig = config
if sq.BatchEnabled && sq.ProwUrl == "" {
return errors.New("batch merges require prow-url to be set!")
}
// TODO: This is not how injection for tests should work.
if sq.FakeE2E {
sq.e2e = &fake_e2e.FakeE2ETester{}
} else {
var gcs *utils.Utils
if overrideUrl != "" {
gcs = utils.NewTestUtils("bucket", "logs", overrideUrl)
} else {
gcs = utils.NewWithPresubmitDetection(
mungeopts.GCS.BucketName, mungeopts.GCS.LogDir,
mungeopts.GCS.PullKey, mungeopts.GCS.PullLogDir,
)
}
sq.e2e = (&e2e.RealE2ETester{
Opts: sq.opts,
NonBlockingJobNames: &sq.NonBlockingJobNames,
BuildStatus: map[string]e2e.BuildInfo{},
GoogleGCSBucketUtils: gcs,
}).Init(admin.Mux)
}
sq.lgtmTimeCache = mungerutil.NewLabelTimeCache(lgtmLabel)
if len(mungeopts.Server.Address) > 0 {
if len(mungeopts.Server.WWWRoot) > 0 {
http.Handle("/", gziphandler.GzipHandler(http.FileServer(http.Dir(mungeopts.Server.WWWRoot))))
}
http.Handle("/prometheus", promhttp.Handler())
http.Handle("/prs", gziphandler.GzipHandler(http.HandlerFunc(sq.servePRs)))
http.Handle("/history", gziphandler.GzipHandler(http.HandlerFunc(sq.serveHistory)))
http.Handle("/github-e2e-queue", gziphandler.GzipHandler(http.HandlerFunc(sq.serveGithubE2EStatus)))
http.Handle("/google-internal-ci", gziphandler.GzipHandler(http.HandlerFunc(sq.serveGoogleInternalStatus)))
http.Handle("/merge-info", gziphandler.GzipHandler(http.HandlerFunc(sq.serveMergeInfo)))
http.Handle("/priority-info", gziphandler.GzipHandler(http.HandlerFunc(sq.servePriorityInfo)))
http.Handle("/health", gziphandler.GzipHandler(http.HandlerFunc(sq.serveHealth)))
http.Handle("/health.svg", gziphandler.GzipHandler(http.HandlerFunc(sq.serveHealthSVG)))
http.Handle("/sq-stats", gziphandler.GzipHandler(http.HandlerFunc(sq.serveSQStats)))
http.Handle("/flakes", gziphandler.GzipHandler(http.HandlerFunc(sq.serveFlakes)))
http.Handle("/metadata", gziphandler.GzipHandler(http.HandlerFunc(sq.serveMetadata)))
if sq.BatchEnabled {
http.Handle("/batch", gziphandler.GzipHandler(http.HandlerFunc(sq.serveBatch)))
}
config.ServeDebugStats("/stats")
go http.ListenAndServe(mungeopts.Server.Address, nil)
}
admin.Mux.HandleFunc("/api/emergency/stop", sq.EmergencyStopHTTP)
admin.Mux.HandleFunc("/api/emergency/resume", sq.EmergencyStopHTTP)
admin.Mux.HandleFunc("/api/emergency/status", sq.EmergencyStopHTTP)
if sq.githubE2EPollTime == 0 {
sq.githubE2EPollTime = githubE2EPollTime
}
sq.healthHistory = make([]healthRecord, 0)
go sq.handleGithubE2EAndMerge()
go sq.updateGoogleE2ELoop()
if sq.BatchEnabled {
go sq.handleGithubE2EBatchMerge()
}
if sq.AdminPort != 0 {
go http.ListenAndServe(fmt.Sprintf("0.0.0.0:%v", sq.AdminPort), admin.Mux)
}
return nil
}
// EachLoop is called at the start of every munge loop
func (sq *SubmitQueue) EachLoop() error {
issues := []*githubapi.Issue{}
if !sq.lastClosedTime.IsZero() {
listOpts := &githubapi.IssueListByRepoOptions{
State: "closed",
Since: sq.lastClosedTime,
}
var err error
issues, err = sq.githubConfig.ListAllIssues(listOpts)
if err != nil {
return err
}
} else {
sq.lastClosedTime = time.Now()
}
sq.Lock()
for _, issue := range issues {
if issue.ClosedAt != nil && issue.ClosedAt.After(sq.lastClosedTime) {
sq.lastClosedTime = *issue.ClosedAt
}
delete(sq.prStatus, strconv.Itoa(*issue.Number))
}
sq.updateHealth()
promMetrics.OpenPRs.Set(float64(len(sq.prStatus)))
promMetrics.QueuedPRs.Set(float64(len(sq.githubE2EQueue)))
objs := []*github.MungeObject{}
for _, obj := range sq.githubE2EQueue {
objs = append(objs, obj)
}
sq.Unlock()
for _, obj := range objs {
obj.Refresh()
// This should recheck it and clean up the queue, we don't care about the result
_ = sq.validForMerge(obj)
}
atomic.AddInt32(&sq.loopStarts, 1)
promMetrics.Loops.Inc()
return nil
}
// RegisterOptions registers options for this munger; returns any that require a restart when changed.
func (sq *SubmitQueue) RegisterOptions(opts *options.Options) sets.String {
sq.opts = opts
opts.RegisterStringSlice(&sq.NonBlockingJobNames, "nonblocking-jobs", []string{}, "Comma separated list of jobs that don't block merges, but will have status reported and issues filed.")
opts.RegisterBool(&sq.FakeE2E, "fake-e2e", false, "Whether to use a fake for testing E2E stability.")
opts.RegisterStringSlice(&sq.DoNotMergeMilestones, "do-not-merge-milestones", []string{}, "List of milestones which, when applied, will cause the PR to not be merged")
opts.RegisterInt(&sq.AdminPort, "admin-port", 9999, "If non-zero, will serve administrative actions on this port.")
opts.RegisterString(&sq.Metadata.historyUrl, "history-url", "", "URL to access the submit-queue instance's health history.")
opts.RegisterString(&sq.Metadata.chartUrl, "chart-url", "", "URL to access the submit-queue instance's health charts.")
opts.RegisterString(&sq.ProwUrl, "prow-url", "", "Prow deployment base URL to read batch results and direct users to.")
opts.RegisterBool(&sq.BatchEnabled, "batch-enabled", false, "Do batch merges (requires prow/splice coordination).")
opts.RegisterString(&sq.ContextURL, "context-url", "", "URL where the submit queue is serving - used in Github status contexts")
opts.RegisterBool(&sq.GateApproved, "gate-approved", false, "Gate on approved label")
opts.RegisterBool(&sq.GateCLA, "gate-cla", false, "Gate on cla labels")
opts.RegisterUpdateCallback(func(changed sets.String) error {
if changed.HasAny("prow-url", "batch-enabled") {
if sq.BatchEnabled && sq.ProwUrl == "" {
return fmt.Errorf("batch merges require prow-url to be set!")
}
}
return nil
})
return sets.NewString(
"batch-enabled", // Need to start or kill batch processing.
"context-url", // Need to remunge all PRs to update statuses with new url.
"admin-port", // Need to restart server on new port.
// For the following: need to restart fileserver.
"chart-url",
"history-url",
// For the following: need to re-initialize e2e which is used by other goroutines.
"fake-e2e",
"gcs-bucket",
"gcs-logs-dir",
"pull-logs-dir",
"pull-key",
// For the following: need to remunge all PRs if changed from true to false.
"gate-cla",
"gate-approved",
)
}
// Hold the lock
func (sq *SubmitQueue) updateHealth() {
// Remove old entries from the front.
for len(sq.healthHistory) > 0 && time.Since(sq.healthHistory[0].Time).Hours() > 24.0 {
sq.healthHistory = sq.healthHistory[1:]
}
// Make the current record
sq.e2e.LoadNonBlockingStatus()
emergencyStop := sq.emergencyMergeStop()
newEntry := healthRecord{
Time: time.Now(),
Overall: !emergencyStop,
Jobs: map[string]bool{},
}
for job, status := range sq.e2e.GetBuildStatus() {
// Ignore flakes.
newEntry.Jobs[job] = status.Status != "Not Stable"
}
if emergencyStop {
// invent an "emergency stop" job that's failing.
newEntry.Jobs["Emergency Stop"] = false
}
sq.healthHistory = append(sq.healthHistory, newEntry)
// Now compute the health structure so we don't have to do it on page load
sq.health.TotalLoops = len(sq.healthHistory)
sq.health.NumStable = 0
sq.health.NumStablePerJob = map[string]int{}
sq.health.MergePossibleNow = !emergencyStop
if sq.health.MergePossibleNow {
promMetrics.Blocked.Set(0)
} else {
promMetrics.Blocked.Set(1)
}
for _, record := range sq.healthHistory {
if record.Overall {
sq.health.NumStable += 1
}
for job, stable := range record.Jobs {
if _, ok := sq.health.NumStablePerJob[job]; !ok {
sq.health.NumStablePerJob[job] = 0
}
if stable {
sq.health.NumStablePerJob[job]++
}
}
}
}
func (sq *SubmitQueue) e2eStable(aboutToMerge bool) bool {
wentStable := false
wentUnstable := false
sq.e2e.LoadNonBlockingStatus()
stable := !sq.emergencyMergeStop()
sq.Lock()
last := sq.lastE2EStable
if last && !stable {
wentUnstable = true
} else if !last && stable {
wentStable = true
}
sq.lastE2EStable = stable
sq.Unlock()
reason := ""
avatar := ""
if wentStable {
reason = e2eRecover
avatar = "success.png"
} else if wentUnstable {
reason = e2eFailure
avatar = "error.png"
}
if reason != "" {
submitStatus := submitStatus{
Time: sq.clock.Now(),
statusPullRequest: statusPullRequest{
Title: reason,
AvatarURL: avatar,
},
Reason: reason,
}
sq.Lock()
sq.statusHistory = append(sq.statusHistory, submitStatus)
sq.Unlock()
}
return stable
}
// This serves little purpose other than to show updates every minute in the
// web UI. Stable() will get called as needed against individual PRs as well.
func (sq *SubmitQueue) updateGoogleE2ELoop() {
for {
_ = sq.e2eStable(false)
time.Sleep(1 * time.Minute)
}
}
func objToStatusPullRequest(obj *github.MungeObject) *statusPullRequest {
if obj == nil {
return &statusPullRequest{}
}
res := statusPullRequest{
Number: *obj.Issue.Number,
URL: *obj.Issue.HTMLURL,
Title: *obj.Issue.Title,
Login: *obj.Issue.User.Login,
AvatarURL: *obj.Issue.User.AvatarURL,
}
pr, ok := obj.GetPR()
if !ok {
return &res
}
if pr.Additions != nil {
res.Additions = *pr.Additions
}
if pr.Deletions != nil {
res.Deletions = *pr.Deletions
}
if pr.Base != nil && pr.Base.Ref != nil {
res.BaseRef = *pr.Base.Ref
}
labelPriority := labelPriority(obj)
if labelPriority <= lastHighPriorityLabel {
res.ExtraInfo = append(res.ExtraInfo, labelPriorities[labelPriority])
}
milestone, ok := obj.Annotations["milestone"]
if !ok {
milestone, ok = obj.ReleaseMilestone()
obj.Annotations["milestone"] = milestone
}
if milestone != "" {
res.ExtraInfo = append(res.ExtraInfo, milestone)
}
if labelPriority > lastHighPriorityLabel && labelPriority < len(labelPriorities) {
res.ExtraInfo = append(res.ExtraInfo, labelPriorities[labelPriority])
}
return &res
}
func reasonToState(reason string) string {
switch reason {
case merged, mergedByHand, mergedSkippedRetest, mergedBatch:
return "success"
case e2eFailure, ghE2EQueued, ghE2EWaitingStart, ghE2ERunning:
return "success"
case unknown:
return "failure"
default:
return "pending"
}
}
// SetMergeStatus will set the status given a particular PR. This function should
// be used instead of manipulating the prStatus directly as sq.Lock() must be
// called when manipulating that structure
// `obj` is the active github object
// `reason` is the new 'status' for this object
func (sq *SubmitQueue) SetMergeStatus(obj *github.MungeObject, reason string) {
glog.V(4).Infof("SubmitQueue not merging %d because %q", *obj.Issue.Number, reason)
submitStatus := submitStatus{
Time: sq.clock.Now(),
statusPullRequest: *objToStatusPullRequest(obj),
Reason: reason,
}
status, ok := obj.GetStatus(sqContext)
if !ok || status == nil || *status.Description != reason {
state := reasonToState(reason)
sq.opts.Lock()
contextURL := sq.ContextURL
sq.opts.Unlock()
url := fmt.Sprintf("%s/#/prs?prDisplay=%d&historyDisplay=%d", contextURL, *obj.Issue.Number, *obj.Issue.Number)
_ = obj.SetStatus(state, url, reason, sqContext)
}
sq.Lock()
defer sq.Unlock()
// If we are currently retesting E2E the normal munge loop might find
// that the ci tests are not green. That's normal and expected and we
// should just ignore that status update entirely.
if sq.githubE2ERunning != nil && *sq.githubE2ERunning.Issue.Number == *obj.Issue.Number && strings.HasPrefix(reason, ciFailure) {
return
}
if sq.onQueue(obj) {
sq.statusHistory = append(sq.statusHistory, submitStatus)
if len(sq.statusHistory) > 128 {
sq.statusHistory = sq.statusHistory[1:]
}
}
sq.prStatus[strconv.Itoa(*obj.Issue.Number)] = submitStatus
sq.cleanupOldE2E(obj, reason)
}
// setContextFailedStatus calls SetMergeStatus after determining a particular github status
// which is failed.
func (sq *SubmitQueue) setContextFailedStatus(obj *github.MungeObject, contexts []string) {
for i, context := range contexts {
contextSlice := contexts[i : i+1]
success, ok := obj.IsStatusSuccess(contextSlice)
if ok && success {
continue
}
failMsg := fmt.Sprintf(ciFailureFmt, context)
sq.SetMergeStatus(obj, failMsg)
return
}
glog.Errorf("Inside setContextFailedStatus() but none of the status's failed! %d: %v", obj.Number(), contexts)
sq.SetMergeStatus(obj, ciFailure)
}
// sq.Lock() MUST be held!
func (sq *SubmitQueue) getE2EQueueStatus() []*statusPullRequest {
queue := []*statusPullRequest{}
keys := sq.orderedE2EQueue()
for _, k := range keys {
obj := sq.githubE2EQueue[k]
request := objToStatusPullRequest(obj)
queue = append(queue, request)
}
return queue
}
func (sq *SubmitQueue) marshal(data interface{}) []byte {
b, err := json.Marshal(data)
if err != nil {
glog.Errorf("Unable to Marshal data: %#v: %v", data, err)
return nil
}
return b
}
func (sq *SubmitQueue) getQueueHistory() []byte {
sq.Lock()
defer sq.Unlock()
return sq.marshal(sq.statusHistory)
}
// GetQueueStatus returns a json representation of the state of the submit
// queue. This can be used to generate web pages about the submit queue.
func (sq *SubmitQueue) getQueueStatus() []byte {
status := submitQueueStatus{PRStatus: map[string]submitStatus{}}
sq.Lock()
defer sq.Unlock()
for key, value := range sq.prStatus {
status.PRStatus[key] = value
}
return sq.marshal(status)
}
func (sq *SubmitQueue) getGithubE2EStatus() []byte {
sq.Lock()
defer sq.Unlock()
status := e2eQueueStatus{
E2EQueue: sq.getE2EQueueStatus(),
E2ERunning: objToStatusPullRequest(sq.githubE2ERunning),
BatchStatus: &sq.batchStatus,
}
return sq.marshal(status)
}
func (sq *SubmitQueue) getGoogleInternalStatus() []byte {
sq.Lock()
defer sq.Unlock()
return sq.marshal(sq.e2e.GetBuildStatus())
}
func (sq *SubmitQueue) getHealth() []byte {
sq.Lock()
defer sq.Unlock()
return sq.marshal(sq.health)
}
func (sq *SubmitQueue) getMetaData() []byte {
sq.Lock()
defer sq.Unlock()
return sq.marshal(sq.Metadata)
}
const (
unknown = "unknown failure"
noCLA = "PR is missing CLA label; needs one of " + claYesLabel + ", " + cncfClaYesLabel + " or " + claHumanLabel
noLGTM = "PR does not have " + lgtmLabel + " label."
noApproved = "PR does not have " + approvedLabel + " label."
lgtmEarly = "The PR was changed after the " + lgtmLabel + " label was added."
unmergeable = "PR is unable to be automatically merged. Needs rebase."
undeterminedMergability = "Unable to determine is PR is mergeable. Will try again later."
noMerge = "Will not auto merge because " + doNotMergeLabel + " is present"
ciFailure = "Required Github CI test is not green"
ciFailureFmt = ciFailure + ": %s"
e2eFailure = "The e2e tests are failing. The entire submit queue is blocked."
e2eRecover = "The e2e tests started passing. The submit queue is unblocked."
merged = "MERGED!"
mergedSkippedRetest = "MERGED! (skipped retest because of label)"
mergedBatch = "MERGED! (batch)"
mergedByHand = "MERGED! (by hand outside of submit queue)"
ghE2EQueued = "Queued to run github e2e tests a second time."
ghE2EWaitingStart = "Requested and waiting for github e2e test to start running a second time."
ghE2ERunning = "Running github e2e tests a second time."
ghE2EFailed = "Second github e2e run failed."
unmergeableMilestone = "Milestone is for a future release and cannot be merged"
headCommitChanged = "This PR has changed since we ran the tests"
)
// validForMergeExt is the base logic about what PR can be automatically merged.
// PRs must pass this logic to be placed on the queue and they must pass this
// logic a second time to be retested/merged after they get to the top of
// the queue.
//
// checkStatus is true if the PR should only merge if the appropriate Github status
// checks are passing.
//
// If you update the logic PLEASE PLEASE PLEASE update serveMergeInfo() as well.
func (sq *SubmitQueue) validForMergeExt(obj *github.MungeObject, checkStatus bool) bool {
// Can't merge an issue!
if !obj.IsPR() {
return false
}
// Can't merge something already merged.
if m, ok := obj.IsMerged(); !ok {
glog.Errorf("%d: unknown err", *obj.Issue.Number)
sq.SetMergeStatus(obj, unknown)
return false
} else if m {
sq.SetMergeStatus(obj, mergedByHand)
return false
}
// Lock to get options since we may be running on a goroutine besides the main one.
sq.opts.Lock()
gateCLA := sq.GateCLA
gateApproved := sq.GateApproved
doNotMergeMilestones := sq.DoNotMergeMilestones
mergeContexts := mungeopts.RequiredContexts.Merge
retestContexts := mungeopts.RequiredContexts.Retest
sq.opts.Unlock()
if milestone := obj.Issue.Milestone; true {
title := ""
// Net set means the empty milestone, ""
if milestone != nil && milestone.Title != nil {
title = *milestone.Title
}
for _, blocked := range doNotMergeMilestones {
if title == blocked {
sq.SetMergeStatus(obj, unmergeableMilestone)
return false
}
}
}
// Must pass CLA checks
if gateCLA {
if !obj.HasLabel(claYesLabel) && !obj.HasLabel(claHumanLabel) && !obj.HasLabel(cncfClaYesLabel) {
sq.SetMergeStatus(obj, noCLA)
return false
}
}
// Obviously must be mergeable
if mergeable, ok := obj.IsMergeable(); !ok {
sq.SetMergeStatus(obj, undeterminedMergability)
return false
} else if !mergeable {
sq.SetMergeStatus(obj, unmergeable)
return false
}
// Validate the status information for this PR
if checkStatus {
if len(mergeContexts) > 0 {
if success, ok := obj.IsStatusSuccess(mergeContexts); !ok || !success {
sq.setContextFailedStatus(obj, mergeContexts)
return false
}
}
if len(retestContexts) > 0 {
if success, ok := obj.IsStatusSuccess(retestContexts); !ok || !success {
sq.setContextFailedStatus(obj, retestContexts)
return false
}
}
}
if !obj.HasLabel(lgtmLabel) {