-
Notifications
You must be signed in to change notification settings - Fork 2.6k
/
tide.go
2254 lines (2026 loc) · 70 KB
/
tide.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 2017 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 tide contains a controller for managing a tide pool of PRs. The
// controller will automatically retest PRs in the pool and merge them if they
// pass tests.
package tide
import (
"bytes"
"context"
"encoding/json"
"fmt"
"net/http"
"sort"
"strconv"
"strings"
"sync"
"time"
"github.com/prometheus/client_golang/prometheus"
githubql "github.com/shurcooL/githubv4"
"github.com/sirupsen/logrus"
"k8s.io/apimachinery/pkg/util/sets"
ctrlruntimeclient "sigs.k8s.io/controller-runtime/pkg/client"
utilerrors "k8s.io/apimachinery/pkg/util/errors"
prowapi "k8s.io/test-infra/prow/apis/prowjobs/v1"
"k8s.io/test-infra/prow/config"
"k8s.io/test-infra/prow/git/v2"
"k8s.io/test-infra/prow/github"
"k8s.io/test-infra/prow/io"
"k8s.io/test-infra/prow/pjutil"
"k8s.io/test-infra/prow/tide/blockers"
"k8s.io/test-infra/prow/tide/history"
"k8s.io/test-infra/prow/version"
)
// For mocking out sleep during unit tests.
var sleep = time.Sleep
type githubClient interface {
CreateStatus(string, string, string, github.Status) error
GetCombinedStatus(org, repo, ref string) (*github.CombinedStatus, error)
ListCheckRuns(org, repo, ref string) (*github.CheckRunList, error)
GetPullRequestChanges(org, repo string, number int) ([]github.PullRequestChange, error)
GetRef(string, string, string) (string, error)
GetRepo(owner, name string) (github.FullRepo, error)
Merge(string, string, int, github.MergeDetails) error
QueryWithGitHubAppsSupport(ctx context.Context, q interface{}, vars map[string]interface{}, org string) error
}
type contextChecker interface {
// IsOptional tells whether a context is optional.
IsOptional(string) bool
// MissingRequiredContexts tells if required contexts are missing from the list of contexts provided.
MissingRequiredContexts([]string) []string
}
// Controller knows how to sync PRs and PJs.
type Controller struct {
ctx context.Context
logger *logrus.Entry
config config.Getter
ghc githubClient
prowJobClient ctrlruntimeclient.Client
gc git.ClientFactory
usesGitHubAppsAuth bool
sc *statusController
m sync.Mutex
pools []Pool
// changedFiles caches the names of files changed by PRs.
// Cache entries expire if they are not used during a sync loop.
changedFiles *changedFilesAgent
mergeChecker *mergeChecker
History *history.History
}
// Action represents what actions the controller can take. It will take
// exactly one action each sync.
type Action string
// Constants for various actions the controller might take
const (
Wait Action = "WAIT"
Trigger Action = "TRIGGER"
TriggerBatch Action = "TRIGGER_BATCH"
Merge Action = "MERGE"
MergeBatch Action = "MERGE_BATCH"
PoolBlocked Action = "BLOCKED"
)
// recordableActions is the subset of actions that we keep historical record of.
// Ignore idle actions to avoid flooding the records with useless data.
var recordableActions = map[Action]bool{
Trigger: true,
TriggerBatch: true,
Merge: true,
MergeBatch: true,
}
// Pool represents information about a tide pool. There is one for every
// org/repo/branch combination that has PRs in the pool.
type Pool struct {
Org string
Repo string
Branch string
// PRs with passing tests, pending tests, and missing or failed tests.
// Note that these results are rolled up. If all tests for a PR are passing
// except for one pending, it will be in PendingPRs.
SuccessPRs []PullRequest
PendingPRs []PullRequest
MissingPRs []PullRequest
// Empty if there is no pending batch.
BatchPending []PullRequest
// Which action did we last take, and to what target(s), if any.
Action Action
Target []PullRequest
Blockers []blockers.Blocker
Error string
// All of the TenantIDs associated with PRs in the pool.
TenantIDs []string
}
// Prometheus Metrics
var (
tideMetrics = struct {
// Per pool
pooledPRs *prometheus.GaugeVec
updateTime *prometheus.GaugeVec
merges *prometheus.HistogramVec
poolErrors *prometheus.CounterVec
queryResults *prometheus.CounterVec
// Singleton
syncDuration prometheus.Gauge
statusUpdateDuration prometheus.Gauge
// Per controller
syncHeartbeat *prometheus.CounterVec
}{
pooledPRs: prometheus.NewGaugeVec(prometheus.GaugeOpts{
Name: "pooledprs",
Help: "Number of PRs in each Tide pool.",
}, []string{
"org",
"repo",
"branch",
}),
updateTime: prometheus.NewGaugeVec(prometheus.GaugeOpts{
Name: "updatetime",
Help: "The last time each subpool was synced. (Used to determine 'pooledprs' freshness.)",
}, []string{
"org",
"repo",
"branch",
}),
merges: prometheus.NewHistogramVec(prometheus.HistogramOpts{
Name: "merges",
Help: "Histogram of merges where values are the number of PRs merged together.",
Buckets: []float64{1, 2, 3, 4, 5, 7, 10, 15, 25},
}, []string{
"org",
"repo",
"branch",
}),
poolErrors: prometheus.NewCounterVec(prometheus.CounterOpts{
Name: "tidepoolerrors",
Help: "Count of Tide pool sync errors.",
}, []string{
"org",
"repo",
"branch",
}),
queryResults: prometheus.NewCounterVec(prometheus.CounterOpts{
Name: "tidequeryresults",
Help: "Count of Tide queries by query index, org shard, and result (success/error).",
}, []string{
"query_index",
"org_shard",
"result",
}),
// Use the sync heartbeat counter to monitor for liveness. Use the duration
// gauges for precise sync duration graphs since the prometheus scrape
// period is likely much larger than the loop periods.
syncDuration: prometheus.NewGauge(prometheus.GaugeOpts{
Name: "syncdur",
Help: "The duration of the last loop of the sync controller.",
}),
statusUpdateDuration: prometheus.NewGauge(prometheus.GaugeOpts{
Name: "statusupdatedur",
Help: "The duration of the last loop of the status update controller.",
}),
syncHeartbeat: prometheus.NewCounterVec(prometheus.CounterOpts{
Name: "tidesyncheartbeat",
Help: "Count of Tide syncs per controller.",
}, []string{
"controller",
}),
}
)
func init() {
prometheus.MustRegister(tideMetrics.pooledPRs)
prometheus.MustRegister(tideMetrics.updateTime)
prometheus.MustRegister(tideMetrics.merges)
prometheus.MustRegister(tideMetrics.syncDuration)
prometheus.MustRegister(tideMetrics.statusUpdateDuration)
prometheus.MustRegister(tideMetrics.syncHeartbeat)
prometheus.MustRegister(tideMetrics.poolErrors)
prometheus.MustRegister(tideMetrics.queryResults)
}
type manager interface {
GetClient() ctrlruntimeclient.Client
GetFieldIndexer() ctrlruntimeclient.FieldIndexer
}
// NewController makes a Controller out of the given clients.
func NewController(ghcSync, ghcStatus github.Client, mgr manager, cfg config.Getter, gc git.ClientFactory, maxRecordsPerPool int, opener io.Opener, historyURI, statusURI string, logger *logrus.Entry, usesGitHubAppsAuth bool) (*Controller, error) {
if logger == nil {
logger = logrus.NewEntry(logrus.StandardLogger())
}
hist, err := history.New(maxRecordsPerPool, opener, historyURI)
if err != nil {
return nil, fmt.Errorf("error initializing history client from %q: %w", historyURI, err)
}
mergeChecker := newMergeChecker(cfg, ghcSync)
ctx := context.Background()
sc, err := newStatusController(ctx, logger, ghcStatus, mgr, gc, cfg, opener, statusURI, mergeChecker, usesGitHubAppsAuth)
if err != nil {
return nil, err
}
go sc.run()
return newSyncController(ctx, logger, ghcSync, mgr, cfg, gc, sc, hist, mergeChecker, usesGitHubAppsAuth)
}
func newStatusController(ctx context.Context, logger *logrus.Entry, ghc githubClient, mgr manager, gc git.ClientFactory, cfg config.Getter, opener io.Opener, statusURI string, mergeChecker *mergeChecker, usesGitHubAppsAuth bool) (*statusController, error) {
if err := mgr.GetFieldIndexer().IndexField(ctx, &prowapi.ProwJob{}, indexNamePassingJobs, indexFuncPassingJobs); err != nil {
return nil, fmt.Errorf("failed to add index for passing jobs to cache: %w", err)
}
return &statusController{
pjClient: mgr.GetClient(),
logger: logger.WithField("controller", "status-update"),
ghc: ghc,
gc: gc,
usesGitHubAppsAuth: usesGitHubAppsAuth,
config: cfg,
mergeChecker: mergeChecker,
newPoolPending: make(chan bool, 1),
shutDown: make(chan bool),
opener: opener,
path: statusURI,
}, nil
}
func newSyncController(
ctx context.Context,
logger *logrus.Entry,
ghcSync githubClient,
mgr manager,
cfg config.Getter,
gc git.ClientFactory,
sc *statusController,
hist *history.History,
mergeChecker *mergeChecker,
usesGitHubAppsAuth bool,
) (*Controller, error) {
if err := mgr.GetFieldIndexer().IndexField(
ctx,
&prowapi.ProwJob{},
cacheIndexName,
cacheIndexFunc,
); err != nil {
return nil, fmt.Errorf("failed to add baseSHA index to cache: %w", err)
}
if err := mgr.GetFieldIndexer().IndexField(
ctx,
&prowapi.ProwJob{},
nonFailedBatchByNameBaseAndPullsIndexName,
nonFailedBatchByNameBaseAndPullsIndexFunc,
); err != nil {
return nil, fmt.Errorf("failed to add index for non failed batches: %w", err)
}
return &Controller{
ctx: ctx,
logger: logger.WithField("controller", "sync"),
ghc: ghcSync,
prowJobClient: mgr.GetClient(),
config: cfg,
gc: gc,
usesGitHubAppsAuth: usesGitHubAppsAuth,
sc: sc,
changedFiles: &changedFilesAgent{
ghc: ghcSync,
nextChangeCache: make(map[changeCacheKey][]string),
},
mergeChecker: mergeChecker,
History: hist,
}, nil
}
// Shutdown signals the statusController to stop working and waits for it to
// finish its last update loop before terminating.
// Controller.Sync() should not be used after this function is called.
func (c *Controller) Shutdown() {
c.History.Flush()
c.sc.shutdown()
}
func prKey(pr *PullRequest) string {
return fmt.Sprintf("%s#%d", string(pr.Repository.NameWithOwner), int(pr.Number))
}
// newExpectedContext creates a Context with Expected state.
func newExpectedContext(c string) Context {
return Context{
Context: githubql.String(c),
State: githubql.StatusStateExpected,
Description: githubql.String(""),
}
}
// contextsToStrings converts a list Context to a list of string
func contextsToStrings(contexts []Context) []string {
var names []string
for _, c := range contexts {
names = append(names, string(c.Context))
}
return names
}
// Sync runs one sync iteration.
func (c *Controller) Sync() error {
start := time.Now()
defer func() {
duration := time.Since(start)
c.logger.WithField("duration", duration.String()).Info("Synced")
tideMetrics.syncDuration.Set(duration.Seconds())
tideMetrics.syncHeartbeat.WithLabelValues("sync").Inc()
version.GatherProwVersion(c.logger)
}()
defer c.changedFiles.prune()
c.config().BranchProtectionWarnings(c.logger, c.config().PresubmitsStatic)
c.logger.Debug("Building tide pool.")
prs, err := c.query()
if err != nil {
return fmt.Errorf("failed to query GitHub for prs: %w", err)
}
c.logger.WithFields(logrus.Fields{
"duration": time.Since(start).String(),
"found_pr_count": len(prs),
}).Debug("Found (unfiltered) pool PRs.")
var blocks blockers.Blockers
if len(prs) > 0 {
if label := c.config().Tide.BlockerLabel; label != "" {
c.logger.WithField("blocker_label", label).Debug("Searching for blocker issues")
orgExcepts, repos := c.config().Tide.Queries.OrgExceptionsAndRepos()
orgs := make([]string, 0, len(orgExcepts))
for org := range orgExcepts {
orgs = append(orgs, org)
}
orgRepoQuery := orgRepoQueryStrings(orgs, repos.UnsortedList(), orgExcepts)
blocks, err = blockers.FindAll(c.ghc, c.logger, label, orgRepoQuery, c.usesGitHubAppsAuth)
if err != nil {
return err
}
}
}
// Partition PRs into subpools and filter out non-pool PRs.
rawPools, err := c.dividePool(prs)
if err != nil {
return err
}
filteredPools := c.filterSubpools(c.mergeChecker.isAllowed, rawPools)
// Notify statusController about the new pool.
c.sc.Lock()
c.sc.blocks = blocks
c.sc.poolPRs = poolPRMap(filteredPools)
c.sc.baseSHAs = baseSHAMap(filteredPools)
c.sc.requiredContexts = requiredContextsMap(filteredPools)
select {
case c.sc.newPoolPending <- true:
c.sc.dontUpdateStatus.reset()
default:
}
c.sc.Unlock()
// Sync subpools in parallel.
poolChan := make(chan Pool, len(filteredPools))
subpoolsInParallel(
c.config().Tide.MaxGoroutines,
filteredPools,
func(sp *subpool) {
pool, err := c.syncSubpool(*sp, blocks.GetApplicable(sp.org, sp.repo, sp.branch))
if err != nil {
tideMetrics.poolErrors.WithLabelValues(sp.org, sp.repo, sp.branch).Inc()
sp.log.WithError(err).Errorf("Error syncing subpool.")
}
poolChan <- pool
},
)
close(poolChan)
pools := make([]Pool, 0, len(poolChan))
for pool := range poolChan {
pools = append(pools, pool)
}
sortPools(pools)
c.m.Lock()
c.pools = pools
c.m.Unlock()
c.History.Flush()
return nil
}
func (c *Controller) query() (map[string]PullRequest, error) {
lock := sync.Mutex{}
wg := sync.WaitGroup{}
prs := make(map[string]PullRequest)
var errs []error
for i, query := range c.config().Tide.Queries {
// Use org-sharded queries only when GitHub apps auth is in use
var queries map[string]string
if c.usesGitHubAppsAuth {
queries = query.OrgQueries()
} else {
queries = map[string]string{"": query.Query()}
}
for org, q := range queries {
org, q, i := org, q, i
wg.Add(1)
go func() {
defer wg.Done()
results, err := search(c.ghc.QueryWithGitHubAppsSupport, c.logger, q, time.Time{}, time.Now(), org)
resultString := "success"
if err != nil {
resultString = "error"
}
tideMetrics.queryResults.WithLabelValues(strconv.Itoa(i), org, resultString).Inc()
lock.Lock()
defer lock.Unlock()
if err != nil && len(results) == 0 {
c.logger.WithField("query", q).WithError(err).Warn("Failed to execute query.")
errs = append(errs, fmt.Errorf("query %d, err: %w", i, err))
return
}
if err != nil {
c.logger.WithError(err).WithField("query", q).Warning("found partial results")
}
for _, pr := range results {
prs[prKey(&pr)] = pr
}
}()
}
}
wg.Wait()
return prs, utilerrors.NewAggregate(errs)
}
func (c *Controller) ServeHTTP(w http.ResponseWriter, r *http.Request) {
c.m.Lock()
defer c.m.Unlock()
b, err := json.Marshal(c.pools)
if err != nil {
c.logger.WithError(err).Error("Encoding JSON.")
b = []byte("[]")
}
if _, err = w.Write(b); err != nil {
c.logger.WithError(err).Error("Writing JSON response.")
}
}
func subpoolsInParallel(goroutines int, sps map[string]*subpool, process func(*subpool)) {
// Load the subpools into a channel for use as a work queue.
queue := make(chan *subpool, len(sps))
for _, sp := range sps {
queue <- sp
}
close(queue)
if goroutines > len(queue) {
goroutines = len(queue)
}
wg := &sync.WaitGroup{}
wg.Add(goroutines)
for i := 0; i < goroutines; i++ {
go func() {
defer wg.Done()
for sp := range queue {
process(sp)
}
}()
}
wg.Wait()
}
// filterSubpools filters non-pool PRs out of the initially identified subpools,
// deleting any pools that become empty.
// See filterSubpool for filtering details.
func (c *Controller) filterSubpools(mergeAllowed func(*PullRequest) (string, error), raw map[string]*subpool) map[string]*subpool {
filtered := make(map[string]*subpool)
var lock sync.Mutex
subpoolsInParallel(
c.config().Tide.MaxGoroutines,
raw,
func(sp *subpool) {
if err := c.initSubpoolData(sp); err != nil {
sp.log.WithError(err).Error("Error initializing subpool.")
return
}
key := poolKey(sp.org, sp.repo, sp.branch)
if spFiltered := filterSubpool(c.ghc, mergeAllowed, sp); spFiltered != nil {
sp.log.WithField("key", key).WithField("pool", spFiltered).Debug("filtered sub-pool")
lock.Lock()
filtered[key] = spFiltered
lock.Unlock()
} else {
sp.log.WithField("key", key).WithField("pool", spFiltered).Debug("filtering sub-pool removed all PRs")
}
},
)
return filtered
}
func (c *Controller) initSubpoolData(sp *subpool) error {
var err error
sp.presubmits, err = c.presubmitsByPull(sp)
if err != nil {
return fmt.Errorf("error determining required presubmit prowjobs: %w", err)
}
sp.cc = make(map[int]contextChecker, len(sp.prs))
for _, pr := range sp.prs {
sp.cc[int(pr.Number)], err = c.config().GetTideContextPolicy(c.gc, sp.org, sp.repo, sp.branch, refGetterFactory(string(sp.sha)), string(pr.HeadRefOID))
if err != nil {
return fmt.Errorf("error setting up context checker for pr %d: %w", int(pr.Number), err)
}
}
return nil
}
// filterSubpool filters PRs from an initially identified subpool, returning the
// filtered subpool.
// If the subpool becomes empty 'nil' is returned to indicate that the subpool
// should be deleted.
func filterSubpool(ghc githubClient, mergeAllowed func(*PullRequest) (string, error), sp *subpool) *subpool {
var toKeep []PullRequest
for _, pr := range sp.prs {
if !filterPR(ghc, mergeAllowed, sp, &pr) {
toKeep = append(toKeep, pr)
}
}
if len(toKeep) == 0 {
return nil
}
sp.prs = toKeep
return sp
}
// filterPR indicates if a PR should be filtered out of the subpool.
// Specifically we filter out PRs that:
// - Have known merge conflicts or invalid merge method.
// - Have failing or missing status contexts.
// - Have pending required status contexts that are not associated with a
// ProwJob. (This ensures that the 'tide' context indicates that the pending
// status is preventing merge. Required ProwJob statuses are allowed to be
// 'pending' because this prevents kicking PRs from the pool when Tide is
// retesting them.)
func filterPR(ghc githubClient, mergeAllowed func(*PullRequest) (string, error), sp *subpool, pr *PullRequest) bool {
log := sp.log.WithFields(pr.logFields())
// Skip PRs that are known to be unmergeable.
if reason, err := mergeAllowed(pr); err != nil {
log.WithError(err).Error("Error checking PR mergeability.")
return true
} else if reason != "" {
log.WithField("reason", reason).Debug("filtering out PR as it is not mergeable")
return true
}
// Filter out PRs with unsuccessful contexts unless the only unsuccessful
// contexts are pending required prowjobs.
contexts, err := headContexts(log, ghc, pr)
if err != nil {
log.WithError(err).Error("Getting head contexts.")
return true
}
presubmitsHaveContext := func(context string) bool {
for _, job := range sp.presubmits[int(pr.Number)] {
if job.Context == context {
return true
}
}
return false
}
for _, ctx := range unsuccessfulContexts(contexts, sp.cc[int(pr.Number)], log) {
if ctx.State != githubql.StatusStatePending {
log.WithField("context", ctx.Context).Debug("filtering out PR as unsuccessful context is not pending")
return true
}
if !presubmitsHaveContext(string(ctx.Context)) {
log.WithField("context", ctx.Context).Debug("filtering out PR as unsuccessful context is not Prow-controlled")
return true
}
}
return false
}
// mergeChecker provides a function to check if a PR can be merged with
// the requested method and does not have a merge conflict.
// It caches results and should be cleared periodically with clearCache()
type mergeChecker struct {
config config.Getter
ghc githubClient
sync.Mutex
cache map[config.OrgRepo]map[github.PullRequestMergeType]bool
}
func newMergeChecker(cfg config.Getter, ghc githubClient) *mergeChecker {
m := &mergeChecker{
config: cfg,
ghc: ghc,
cache: map[config.OrgRepo]map[github.PullRequestMergeType]bool{},
}
go m.clearCache()
return m
}
func (m *mergeChecker) clearCache() {
// Only do this once per token reset since it could be a bit expensive for
// Tide instances that handle hundreds of repos.
ticker := time.NewTicker(time.Hour)
for {
<-ticker.C
m.Lock()
m.cache = make(map[config.OrgRepo]map[github.PullRequestMergeType]bool)
m.Unlock()
}
}
func (m *mergeChecker) repoMethods(orgRepo config.OrgRepo) (map[github.PullRequestMergeType]bool, error) {
m.Lock()
defer m.Unlock()
repoMethods, ok := m.cache[orgRepo]
if !ok {
fullRepo, err := m.ghc.GetRepo(orgRepo.Org, orgRepo.Repo)
if err != nil {
return nil, err
}
repoMethods = map[github.PullRequestMergeType]bool{
github.MergeMerge: fullRepo.AllowMergeCommit,
github.MergeSquash: fullRepo.AllowSquashMerge,
github.MergeRebase: fullRepo.AllowRebaseMerge,
}
m.cache[orgRepo] = repoMethods
}
return repoMethods, nil
}
// isAllowed checks if a PR does not have merge conflicts and requests an
// allowed merge method. If there is no error it returns a string explanation if
// not allowed or "" if allowed.
func (m *mergeChecker) isAllowed(pr *PullRequest) (string, error) {
if pr.Mergeable == githubql.MergeableStateConflicting {
return "PR has a merge conflict.", nil
}
mergeMethod, err := prMergeMethod(m.config().Tide, pr)
if err != nil {
// This should be impossible.
return "", fmt.Errorf("Programmer error! Failed to determine a merge method: %w", err)
}
orgRepo := config.OrgRepo{Org: string(pr.Repository.Owner.Login), Repo: string(pr.Repository.Name)}
repoMethods, err := m.repoMethods(orgRepo)
if err != nil {
return "", fmt.Errorf("error getting repo data: %w", err)
}
if allowed, exists := repoMethods[mergeMethod]; !exists {
// Should be impossible as well.
return "", fmt.Errorf("Programmer error! PR requested the unrecognized merge type %q", mergeMethod)
} else if !allowed {
return fmt.Sprintf("Merge type %q disallowed by repo settings", mergeMethod), nil
}
return "", nil
}
func baseSHAMap(subpoolMap map[string]*subpool) map[string]string {
baseSHAs := make(map[string]string, len(subpoolMap))
for key, sp := range subpoolMap {
baseSHAs[key] = sp.sha
}
return baseSHAs
}
// poolPRMap collects all subpool PRs into a map containing all pooled PRs.
func poolPRMap(subpoolMap map[string]*subpool) map[string]PullRequest {
prs := make(map[string]PullRequest)
for _, sp := range subpoolMap {
for _, pr := range sp.prs {
prs[prKey(&pr)] = pr
}
}
return prs
}
func requiredContextsMap(subpoolMap map[string]*subpool) map[string][]string {
requiredContextsMap := map[string][]string{}
for _, sp := range subpoolMap {
for _, pr := range sp.prs {
requiredContextsSet := sets.String{}
for _, requiredJob := range sp.presubmits[int(pr.Number)] {
requiredContextsSet.Insert(requiredJob.Context)
}
requiredContextsMap[prKey(&pr)] = requiredContextsSet.List()
}
}
return requiredContextsMap
}
type simpleState string
const (
failureState simpleState = "failure"
pendingState simpleState = "pending"
successState simpleState = "success"
)
func toSimpleState(s prowapi.ProwJobState) simpleState {
if s == prowapi.TriggeredState || s == prowapi.PendingState {
return pendingState
} else if s == prowapi.SuccessState {
return successState
}
return failureState
}
// isPassingTests returns whether or not all contexts set on the PR except for
// the tide pool context are passing.
func isPassingTests(log *logrus.Entry, ghc githubClient, pr PullRequest, cc contextChecker) bool {
log = log.WithFields(pr.logFields())
contexts, err := headContexts(log, ghc, &pr)
if err != nil {
log.WithError(err).Error("Getting head commit status contexts.")
// If we can't get the status of the commit, assume that it is failing.
return false
}
unsuccessful := unsuccessfulContexts(contexts, cc, log)
return len(unsuccessful) == 0
}
// unsuccessfulContexts determines which contexts from the list that we care about are
// failed. For instance, we do not care about our own context.
// If the branchProtection is set to only check for required checks, we will skip
// all non-required tests. If required tests are missing from the list, they will be
// added to the list of failed contexts.
func unsuccessfulContexts(contexts []Context, cc contextChecker, log *logrus.Entry) []Context {
var failed []Context
for _, ctx := range contexts {
if string(ctx.Context) == statusContext {
continue
}
if cc.IsOptional(string(ctx.Context)) {
continue
}
if ctx.State != githubql.StatusStateSuccess {
failed = append(failed, ctx)
}
}
for _, c := range cc.MissingRequiredContexts(contextsToStrings(contexts)) {
failed = append(failed, newExpectedContext(c))
}
log.WithFields(logrus.Fields{
"total_context_count": len(contexts),
"context_names": contextsToStrings(contexts),
"failed_context_count": len(failed),
"failed_context_names": contextsToStrings(contexts),
}).Debug("Filtered out failed contexts")
return failed
}
func hasAllLabels(pr PullRequest, labels []string) bool {
if len(labels) == 0 {
return true
}
prLabels := sets.NewString()
for _, l := range pr.Labels.Nodes {
prLabels.Insert(string(l.Name))
}
requiredLabels := sets.NewString(labels...)
return prLabels.Intersection(requiredLabels).Equal(requiredLabels)
}
func pickHighestPriorityPR(log *logrus.Entry, ghc githubClient, prs []PullRequest, cc map[int]contextChecker, isPassingTestsFunc func(*logrus.Entry, githubClient, PullRequest, contextChecker) bool, priorities []config.TidePriority) (bool, PullRequest) {
smallestNumber := -1
var smallestPR PullRequest
for _, p := range append(priorities, config.TidePriority{}) {
for _, pr := range prs {
if !hasAllLabels(pr, p.Labels) {
continue
}
if smallestNumber != -1 && int(pr.Number) >= smallestNumber {
continue
}
if len(pr.Commits.Nodes) < 1 {
continue
}
if !isPassingTestsFunc(log, ghc, pr, cc[int(pr.Number)]) {
continue
}
smallestNumber = int(pr.Number)
smallestPR = pr
}
if smallestNumber > -1 {
return true, smallestPR
}
}
return false, smallestPR
}
// accumulateBatch looks at existing batch ProwJobs and, if applicable, returns:
// * A list of PRs that are part of a batch test that finished successfully
// * A list of PRs that are part of a batch test that hasn't finished yet but didn't have any failures so far
func (c *Controller) accumulateBatch(sp subpool) (successBatch []PullRequest, pendingBatch []PullRequest) {
sp.log.Debug("accumulating PRs for batch testing")
prNums := make(map[int]PullRequest)
for _, pr := range sp.prs {
prNums[int(pr.Number)] = pr
}
type accState struct {
prs []PullRequest
jobStates map[string]simpleState
// Are the pull requests in the ref still acceptable? That is, do they
// still point to the heads of the PRs?
validPulls bool
}
states := make(map[string]*accState)
for _, pj := range sp.pjs {
if pj.Spec.Type != prowapi.BatchJob {
continue
}
// First validate the batch job's refs.
ref := pj.Spec.Refs.String()
if _, ok := states[ref]; !ok {
state := &accState{
jobStates: make(map[string]simpleState),
validPulls: true,
}
for _, pull := range pj.Spec.Refs.Pulls {
if pr, ok := prNums[pull.Number]; ok && string(pr.HeadRefOID) == pull.SHA {
state.prs = append(state.prs, pr)
} else if !ok {
state.validPulls = false
sp.log.WithField("batch", ref).WithFields(pr.logFields()).Debug("batch job invalid, PR left pool")
break
} else {
state.validPulls = false
sp.log.WithField("batch", ref).WithFields(pr.logFields()).Debug("batch job invalid, PR HEAD changed")
break
}
}
states[ref] = state
}
if !states[ref].validPulls {
// The batch contains a PR ref that has changed. Skip it.
continue
}
// Batch job refs are valid. Now accumulate job states by batch ref.
context := pj.Spec.Context
jobState := toSimpleState(pj.Status.State)
// Store the best result for this ref+context.
if s, ok := states[ref].jobStates[context]; !ok || s == failureState || jobState == successState {
states[ref].jobStates[context] = jobState
}
}
for ref, state := range states {
if !state.validPulls {
continue
}
requiredPresubmits, err := c.presubmitsForBatch(state.prs, sp.org, sp.repo, sp.sha, sp.branch)
if err != nil {
sp.log.WithError(err).Error("Error getting presubmits for batch")
continue
}
overallState := successState
for _, p := range requiredPresubmits {
if s, ok := state.jobStates[p.Context]; !ok || s == failureState {
overallState = failureState
sp.log.WithField("batch", ref).Debugf("batch invalid, required presubmit %s is not passing", p.Context)
break
} else if s == pendingState && overallState == successState {
overallState = pendingState
}
}
switch overallState {
// Currently we only consider 1 pending batch and 1 success batch at a time.
// If more are somehow present they will be ignored.
case pendingState:
pendingBatch = state.prs
case successState:
successBatch = state.prs
}
}
return successBatch, pendingBatch
}
// prowJobsFromContexts constructs ProwJob objects from all successful presubmit contexts that include a baseSHA.
// This is needed because otherwise we would always need retesting for results that are older than sinkers
// max_prowjob_age.
func prowJobsFromContexts(l *logrus.Entry, ghc githubClient, pr *PullRequest, baseSHA string) ([]prowapi.ProwJob, error) {
headContexts, err := headContexts(l, ghc, pr)
if err != nil {
return nil, fmt.Errorf("failed to get head contexts: %w", err)
}
var passingCurrentContexts []string
for _, headContext := range headContexts {
if headContext.State != githubql.StatusStateSuccess {
continue
}
if baseSHAForContext := config.BaseSHAFromContextDescription(string(headContext.Description)); baseSHAForContext != "" && baseSHAForContext == baseSHA {
passingCurrentContexts = append(passingCurrentContexts, string((headContext.Context)))
}
}
var prowjobsFromContexts []prowapi.ProwJob
for _, passingCurrentContext := range passingCurrentContexts {
prowjobsFromContexts = append(prowjobsFromContexts, prowapi.ProwJob{
Spec: prowapi.ProwJobSpec{
Context: passingCurrentContext,
Refs: &prowapi.Refs{Pulls: []prowapi.Pull{{Number: int(pr.Number), SHA: string(pr.HeadRefOID)}}},
Type: prowapi.PresubmitJob,
},
Status: prowapi.ProwJobStatus{
State: prowapi.SuccessState,
},
})
}
return prowjobsFromContexts, nil
}
// accumulate returns the supplied PRs sorted into three buckets based on their
// accumulated state across the presubmits.
func accumulate(presubmits map[int][]config.Presubmit, prs []PullRequest, pjs []prowapi.ProwJob, log *logrus.Entry, baseSHA string, ghc githubClient) (successes, pendings, missings []PullRequest, missingTests map[int][]config.Presubmit) {
missingTests = map[int][]config.Presubmit{}
for _, pr := range prs {
if prowjobsFromContexts, err := prowJobsFromContexts(log, ghc, &pr, baseSHA); err != nil {
log.WithError(err).Error("failed to get prowjobs from contexts")
} else {
pjs = append(pjs, prowjobsFromContexts...)
}