forked from kubernetes/test-infra
-
Notifications
You must be signed in to change notification settings - Fork 0
/
main.go
1031 lines (925 loc) · 32.4 KB
/
main.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.
*/
// This is a label_sync tool, details in README.md
package main
import (
"encoding/hex"
"errors"
"flag"
"fmt"
"math"
"os"
"path/filepath"
"regexp"
"sort"
"strings"
"sync"
"text/template"
"time"
"unicode"
"github.com/sirupsen/logrus"
"k8s.io/apimachinery/pkg/util/sets"
"sigs.k8s.io/yaml"
"k8s.io/test-infra/prow/config/secret"
"k8s.io/test-infra/prow/flagutil"
"k8s.io/test-infra/prow/github"
"k8s.io/test-infra/prow/logrusutil"
)
const maxConcurrentWorkers = 20
// A label in a repository.
// LabelTarget specifies the intent of the label (PR or issue)
type LabelTarget string
const (
prTarget LabelTarget = "prs"
issueTarget LabelTarget = "issues"
bothTarget LabelTarget = "both"
)
// Label holds declarative data about the label.
type Label struct {
// Name is the current name of the label
Name string `json:"name"`
// Color is rrggbb or color
Color string `json:"color"`
// Description is brief text explaining its meaning, who can apply it
Description string `json:"description"`
// Target specifies whether it targets PRs, issues or both
Target LabelTarget `json:"target"`
// ProwPlugin specifies which prow plugin add/removes this label
ProwPlugin string `json:"prowPlugin"`
// IsExternalPlugin specifies if the prow plugin is external or not
IsExternalPlugin bool `json:"isExternalPlugin"`
// AddedBy specifies whether human/munger/bot adds the label
AddedBy string `json:"addedBy"`
// Previously lists deprecated names for this label
Previously []Label `json:"previously,omitempty"`
// DeleteAfter specifies the label is retired and a safe date for deletion
DeleteAfter *time.Time `json:"deleteAfter,omitempty"`
parent *Label // Current name for previous labels (used internally)
}
// Configuration is a list of Repos defining Required Labels to sync into them
// There is also a Default list of labels applied to every Repo
type Configuration struct {
Repos map[string]RepoConfig `json:"repos,omitempty"`
Orgs map[string]RepoConfig `json:"orgs,omitempty"`
Default RepoConfig `json:"default"`
}
// RepoConfig contains only labels for the moment
type RepoConfig struct {
Labels []Label `json:"labels"`
}
// RepoLabels holds a repo => []github.Label mapping.
type RepoLabels map[string][]github.Label
// Update a label in a repo
type Update struct {
repo string
Why string
Wanted *Label `json:"wanted,omitempty"`
Current *Label `json:"current,omitempty"`
}
// RepoUpdates Repositories to update: map repo name --> list of Updates
type RepoUpdates map[string][]Update
const (
defaultTokens = 300
defaultBurst = 100
)
type options struct {
debug bool
confirm bool
endpoint flagutil.Strings
graphqlEndpoint string
labelsPath string
onlyRepos string
orgs string
skipRepos string
token string
action string
cssTemplate string
cssOutput string
docsTemplate string
docsOutput string
tokens int
tokenBurst int
github flagutil.GitHubOptions
}
func gatherOptions() (opts options, deprecatedOptions bool) {
o := options{}
fs := flag.NewFlagSet(os.Args[0], flag.ExitOnError)
fs.BoolVar(&o.debug, "debug", false, "Turn on debug to be more verbose")
fs.BoolVar(&o.confirm, "confirm", false, "Make mutating API calls to GitHub.")
o.endpoint = flagutil.NewStrings(github.DefaultAPIEndpoint)
fs.Var(&o.endpoint, "endpoint", "GitHub's API endpoint. DEPRECATED: use --github-endpoint")
fs.StringVar(&o.graphqlEndpoint, "graphql-endpoint", github.DefaultGraphQLEndpoint, "GitHub's GraphQL API endpoint. DEPRECATED: use --github-graphql-endpoint")
fs.StringVar(&o.labelsPath, "config", "", "Path to labels.yaml")
fs.StringVar(&o.onlyRepos, "only", "", "Only look at the following comma separated org/repos")
fs.StringVar(&o.orgs, "orgs", "", "Comma separated list of orgs to sync")
fs.StringVar(&o.skipRepos, "skip", "", "Comma separated list of org/repos to skip syncing")
fs.StringVar(&o.token, "token", "", "Path to github oauth secret. DEPRECATED: use --github-token-path")
fs.StringVar(&o.action, "action", "sync", "One of: sync, docs")
fs.StringVar(&o.cssTemplate, "css-template", "", "Path to template file for label css")
fs.StringVar(&o.cssOutput, "css-output", "", "Path to output file for css")
fs.StringVar(&o.docsTemplate, "docs-template", "", "Path to template file for label docs")
fs.StringVar(&o.docsOutput, "docs-output", "", "Path to output file for docs")
fs.IntVar(&o.tokens, "tokens", defaultTokens, "Throttle hourly token consumption (0 to disable). DEPRECATED: use --github-hourly-tokens")
fs.IntVar(&o.tokenBurst, "token-burst", defaultBurst, "Allow consuming a subset of hourly tokens in a short burst. DEPRECATED: use --github-allowed-burst")
o.github.AddCustomizedFlags(fs, flagutil.ThrottlerDefaults(defaultTokens, defaultBurst))
fs.Parse(os.Args[1:])
deprecatedGitHubOptions := false
newGitHubOptions := false
fs.Visit(func(f *flag.Flag) {
switch f.Name {
case "github-endpoint",
"github-graphql-endpoint",
"github-token-path",
"github-hourly-tokens",
"github-allowed-burst":
newGitHubOptions = true
case "token",
"endpoint",
"graphql-endpoint",
"tokens",
"token-burst":
deprecatedGitHubOptions = true
}
})
if deprecatedGitHubOptions && newGitHubOptions {
logrus.Fatalf("deprecated GitHub options, include --endpoint, --graphql-endpoint, --token, --tokens, --token-burst cannot be combined with new --github-XXX counterparts")
}
return o, deprecatedGitHubOptions
}
func pathExists(path string) bool {
_, err := os.Stat(path)
return err == nil
}
// Writes the golang text template at templatePath to outputPath using the given data
func writeTemplate(templatePath string, outputPath string, data interface{}) error {
// set up template
funcMap := template.FuncMap{
"anchor": func(input string) string {
return strings.Replace(input, ":", " ", -1)
},
}
t, err := template.New(filepath.Base(templatePath)).Funcs(funcMap).ParseFiles(templatePath)
if err != nil {
return err
}
// ensure output path exists
if !pathExists(outputPath) {
_, err = os.Create(outputPath)
if err != nil {
return err
}
}
// open file at output path and truncate
f, err := os.OpenFile(outputPath, os.O_RDWR, 0644)
if err != nil {
return err
}
defer f.Close()
f.Truncate(0)
// render template to output path
err = t.Execute(f, data)
if err != nil {
return err
}
return nil
}
// validate runs checks to ensure the label inputs are valid
// It ensures that no two label names (including previous names) have the same
// lowercase value, and that the description is not over 100 characters.
func validate(labels []Label, parent string, seen map[string]string) (map[string]string, error) {
newSeen := copyStringMap(seen)
for _, l := range labels {
name := strings.ToLower(l.Name)
path := parent + "." + name
if other, present := newSeen[name]; present {
return newSeen, fmt.Errorf("duplicate label %s at %s and %s", name, path, other)
}
newSeen[name] = path
if newSeen, err := validate(l.Previously, path, newSeen); err != nil {
return newSeen, err
}
if len(l.Description) > 100 { // github limits the description field to 100 chars
return newSeen, fmt.Errorf("description for %s is too long", name)
}
}
return newSeen, nil
}
func copyStringMap(originalMap map[string]string) map[string]string {
newMap := make(map[string]string)
for k, v := range originalMap {
newMap[k] = v
}
return newMap
}
func stringInSortedSlice(a string, list []string) bool {
i := sort.SearchStrings(list, a)
if i < len(list) && list[i] == a {
return true
}
return false
}
// Labels returns a sorted list of labels unique by name
func (c Configuration) Labels() []Label {
var labelarrays [][]Label
labelarrays = append(labelarrays, c.Default.Labels)
for _, org := range c.Orgs {
labelarrays = append(labelarrays, org.Labels)
}
for _, repo := range c.Repos {
labelarrays = append(labelarrays, repo.Labels)
}
labelmap := make(map[string]Label)
for _, labels := range labelarrays {
for _, l := range labels {
name := strings.ToLower(l.Name)
if _, ok := labelmap[name]; !ok {
labelmap[name] = l
}
}
}
var labels []Label
for _, label := range labelmap {
labels = append(labels, label)
}
sort.Slice(labels, func(i, j int) bool { return labels[i].Name < labels[j].Name })
return labels
}
// TODO(spiffxp): needs to validate labels duped across repos are identical
// Ensures the config does not duplicate label names between default and repo
func (c Configuration) validate(orgs string) error {
// Check default labels
defaultSeen, err := validate(c.Default.Labels, "default", make(map[string]string))
if err != nil {
return fmt.Errorf("invalid config: %w", err)
}
// Generate list of orgs
sortedOrgs := strings.Split(orgs, ",")
sort.Strings(sortedOrgs)
// Check org-level labels for duplicities with default labels
orgSeen := map[string]map[string]string{}
for org, orgConfig := range c.Orgs {
if orgSeen[org], err = validate(orgConfig.Labels, org, defaultSeen); err != nil {
return fmt.Errorf("invalid config: %w", err)
}
}
for repo, repoconfig := range c.Repos {
data := strings.Split(repo, "/")
if len(data) != 2 {
return fmt.Errorf("invalid repo name '%s', expected org/repo form", repo)
}
org := data[0]
if _, ok := orgSeen[org]; !ok {
orgSeen[org] = defaultSeen
}
// Check repo labels for duplicities with default and org-level labels
if _, err := validate(repoconfig.Labels, repo, orgSeen[org]); err != nil {
return fmt.Errorf("invalid config: %w", err)
}
// If orgs have been specified, warn if repo isn't under orgs
if len(orgs) > 0 && !stringInSortedSlice(org, sortedOrgs) {
logrus.WithField("orgs", orgs).WithField("org", org).WithField("repo", repo).Warn("Repo isn't inside orgs")
}
}
return nil
}
// LabelsForTarget returns labels that have a given target
func LabelsForTarget(labels []Label, target LabelTarget) (filteredLabels []Label) {
for _, label := range labels {
if target == label.Target {
filteredLabels = append(filteredLabels, label)
}
}
// We also sort to make nice tables
sort.Slice(filteredLabels, func(i, j int) bool { return filteredLabels[i].Name < filteredLabels[j].Name })
return
}
// LoadConfig reads the yaml config at path
func LoadConfig(path string, orgs string) (*Configuration, error) {
if path == "" {
return nil, errors.New("empty path")
}
var c Configuration
data, err := os.ReadFile(path)
if err != nil {
return nil, err
}
if err = yaml.Unmarshal(data, &c); err != nil {
return nil, err
}
if err = c.validate(orgs); err != nil { // Ensure no dups
return nil, err
}
return &c, nil
}
// GetOrg returns organization from "org" or "user:name"
// Org can be organization name like "kubernetes"
// But we can also request all user's public repos via user:github_user_name
func GetOrg(org string) (string, bool) {
data := strings.Split(org, ":")
if len(data) == 2 && data[0] == "user" {
return data[1], true
}
return org, false
}
// loadRepos read what (filtered) repos exist under an org
func loadRepos(org string, gc client) ([]string, error) {
org, isUser := GetOrg(org)
repos, err := gc.GetRepos(org, isUser)
if err != nil {
return nil, err
}
var rl []string
for _, r := range repos {
// Skip Archived repos as they can't be modified in this way
if r.Archived {
continue
}
// Skip private security forks as they can't be modified in this way
if r.Private && github.SecurityForkNameRE.MatchString(r.Name) {
continue
}
rl = append(rl, r.Name)
}
return rl, nil
}
// loadLabels returns what labels exist in github
func loadLabels(gc client, org string, repos []string) (*RepoLabels, error) {
repoChan := make(chan string, len(repos))
for _, repo := range repos {
repoChan <- repo
}
close(repoChan)
wg := sync.WaitGroup{}
wg.Add(maxConcurrentWorkers)
labels := make(chan RepoLabels, len(repos))
errChan := make(chan error, len(repos))
for i := 0; i < maxConcurrentWorkers; i++ {
go func(repositories <-chan string) {
defer wg.Done()
for repository := range repositories {
logrus.WithField("org", org).WithField("repo", repository).Info("Listing labels for repo")
repoLabels, err := gc.GetRepoLabels(org, repository)
if err != nil {
logrus.WithField("org", org).WithField("repo", repository).WithError(err).Error("Failed listing labels for repo")
errChan <- err
}
labels <- RepoLabels{repository: repoLabels}
}
}(repoChan)
}
wg.Wait()
close(labels)
close(errChan)
rl := RepoLabels{}
for data := range labels {
for repo, repoLabels := range data {
rl[repo] = repoLabels
}
}
var overallErr error
if len(errChan) > 0 {
var listErrs []error
for listErr := range errChan {
listErrs = append(listErrs, listErr)
}
overallErr = fmt.Errorf("failed to list labels: %v", listErrs)
}
return &rl, overallErr
}
// Delete the label
func kill(repo string, label Label) Update {
logrus.WithField("repo", repo).WithField("label", label.Name).Info("kill")
return Update{Why: "dead", Current: &label, repo: repo}
}
// Create the label
func create(repo string, label Label) Update {
logrus.WithField("repo", repo).WithField("label", label.Name).Info("create")
return Update{Why: "missing", Wanted: &label, repo: repo}
}
// Rename the label (will also update color)
func rename(repo string, previous, wanted Label) Update {
logrus.WithField("repo", repo).WithField("from", previous.Name).WithField("to", wanted.Name).Info("rename")
return Update{Why: "rename", Current: &previous, Wanted: &wanted, repo: repo}
}
// Update the label color/description
func change(repo string, label Label) Update {
logrus.WithField("repo", repo).WithField("label", label.Name).WithField("color", label.Color).Info("change")
return Update{Why: "change", Current: &label, Wanted: &label, repo: repo}
}
// Migrate labels to another label
func move(repo string, previous, wanted Label) Update {
logrus.WithField("repo", repo).WithField("from", previous.Name).WithField("to", wanted.Name).Info("migrate")
return Update{Why: "migrate", Wanted: &wanted, Current: &previous, repo: repo}
}
// classifyLabels will put labels into the required, archaic, dead maps as appropriate.
func classifyLabels(labels []Label, required, archaic, dead map[string]Label, now time.Time, parent *Label) (map[string]Label, map[string]Label, map[string]Label) {
newRequired := copyLabelMap(required)
newArchaic := copyLabelMap(archaic)
newDead := copyLabelMap(dead)
for i, l := range labels {
first := parent
if first == nil {
first = &labels[i]
}
lower := strings.ToLower(l.Name)
switch {
case parent == nil && l.DeleteAfter == nil: // Live label
newRequired[lower] = l
case l.DeleteAfter != nil && now.After(*l.DeleteAfter):
newDead[lower] = l
case parent != nil:
l.parent = parent
newArchaic[lower] = l
}
newRequired, newArchaic, newDead = classifyLabels(l.Previously, newRequired, newArchaic, newDead, now, first)
}
return newRequired, newArchaic, newDead
}
func copyLabelMap(originalMap map[string]Label) map[string]Label {
newMap := make(map[string]Label)
for k, v := range originalMap {
newMap[k] = v
}
return newMap
}
func syncLabels(config Configuration, org string, repos RepoLabels) (RepoUpdates, error) {
// Find required, dead and archaic labels
defaultRequired, defaultArchaic, defaultDead := classifyLabels(config.Default.Labels, make(map[string]Label), make(map[string]Label), make(map[string]Label), time.Now(), nil)
if orgLabels, ok := config.Orgs[org]; ok {
defaultRequired, defaultArchaic, defaultDead = classifyLabels(orgLabels.Labels, defaultRequired, defaultArchaic, defaultDead, time.Now(), nil)
}
var validationErrors []error
var actions []Update
// Process all repos
for repo, repoLabels := range repos {
var required, archaic, dead map[string]Label
// Check if we have more labels for repo
if repoconfig, ok := config.Repos[org+"/"+repo]; ok {
// Use classifyLabels() to add them to default ones
required, archaic, dead = classifyLabels(repoconfig.Labels, defaultRequired, defaultArchaic, defaultDead, time.Now(), nil)
} else {
// Otherwise just copy the pointers
required = defaultRequired // Must exist
archaic = defaultArchaic // Migrate
dead = defaultDead // Delete
}
// Convert github.Label to Label
var labels []Label
for _, l := range repoLabels {
labels = append(labels, Label{Name: l.Name, Description: l.Description, Color: l.Color})
}
// Check for any duplicate labels
if _, err := validate(labels, "", make(map[string]string)); err != nil {
validationErrors = append(validationErrors, fmt.Errorf("invalid labels in %s: %w", repo, err))
continue
}
// Create lowercase map of current labels, checking for dead labels to delete.
current := make(map[string]Label)
for _, l := range labels {
lower := strings.ToLower(l.Name)
// Should we delete this dead label?
if _, found := dead[lower]; found {
actions = append(actions, kill(repo, l))
}
current[lower] = l
}
var moveActions []Update // Separate list to do last
// Look for labels to migrate
for name, l := range archaic {
// Does the archaic label exist?
cur, found := current[name]
if !found { // No
continue
}
// What do we want to migrate it to?
desired := Label{Name: l.parent.Name, Description: l.Description, Color: l.parent.Color}
desiredName := strings.ToLower(l.parent.Name)
// Does the new label exist?
_, found = current[desiredName]
if found { // Yes, migrate all these labels
moveActions = append(moveActions, move(repo, cur, desired))
} else { // No, rename the existing label
actions = append(actions, rename(repo, cur, desired))
current[desiredName] = desired
}
}
// Look for missing labels
for name, l := range required {
cur, found := current[name]
switch {
case !found:
actions = append(actions, create(repo, l))
case l.Name != cur.Name:
actions = append(actions, rename(repo, cur, l))
case l.Color != cur.Color:
actions = append(actions, change(repo, l))
case l.Description != cur.Description:
actions = append(actions, change(repo, l))
}
}
actions = append(actions, moveActions...)
}
u := RepoUpdates{}
for _, a := range actions {
u[a.repo] = append(u[a.repo], a)
}
var overallErr error
if len(validationErrors) > 0 {
overallErr = fmt.Errorf("label validation failed: %v", validationErrors)
}
return u, overallErr
}
type repoUpdate struct {
repo string
update Update
}
// DoUpdates iterates generated update data and adds and/or modifies labels on repositories
// Uses AddLabel GH API to add missing labels
// And UpdateLabel GH API to update color or name (name only when case differs)
func (ru RepoUpdates) DoUpdates(org string, gc client) error {
var numUpdates int
for _, updates := range ru {
numUpdates += len(updates)
}
updateChan := make(chan repoUpdate, numUpdates)
for repo, updates := range ru {
logrus.WithField("org", org).WithField("repo", repo).Infof("Applying %d changes", len(updates))
for _, item := range updates {
updateChan <- repoUpdate{repo: repo, update: item}
}
}
close(updateChan)
wrapErr := func(action, why, org, repo string, err error) error {
return fmt.Errorf("update failed %s %s %s/%s: %w", action, why, org, repo, err)
}
wg := sync.WaitGroup{}
wg.Add(maxConcurrentWorkers)
errChan := make(chan error, numUpdates)
for i := 0; i < maxConcurrentWorkers; i++ {
go func(updates <-chan repoUpdate) {
defer wg.Done()
for item := range updates {
repo := item.repo
update := item.update
logrus.WithField("org", org).WithField("repo", repo).WithField("why", update.Why).Debug("running update")
switch update.Why {
case "missing":
err := gc.AddRepoLabel(org, repo, update.Wanted.Name, update.Wanted.Description, update.Wanted.Color)
if err != nil {
errChan <- wrapErr("add-repo-label", update.Why, org, item.repo, err)
}
case "change", "rename":
err := gc.UpdateRepoLabel(org, repo, update.Current.Name, update.Wanted.Name, update.Wanted.Description, update.Wanted.Color)
if err != nil {
errChan <- wrapErr("update-repo-label", update.Why, org, item.repo, err)
}
case "dead":
err := gc.DeleteRepoLabel(org, repo, update.Current.Name)
if err != nil {
errChan <- wrapErr("delete-repo-label", update.Why, org, item.repo, err)
}
case "migrate":
issues, err := gc.FindIssuesWithOrg(org, fmt.Sprintf("is:open repo:%s/%s label:\"%s\" -label:\"%s\"", org, repo, update.Current.Name, update.Wanted.Name), "", false)
if err != nil {
errChan <- wrapErr("find-issues-with-org", update.Why, org, item.repo, err)
}
if len(issues) == 0 {
if err = gc.DeleteRepoLabel(org, repo, update.Current.Name); err != nil {
errChan <- wrapErr("delete-repo-label", update.Why, org, item.repo, err)
}
}
for _, i := range issues {
if err = gc.AddLabel(org, repo, i.Number, update.Wanted.Name); err != nil {
errChan <- wrapErr("add-label", update.Why, org, item.repo, err)
continue
}
if err = gc.RemoveLabel(org, repo, i.Number, update.Current.Name); err != nil {
errChan <- wrapErr("remove-label", update.Why, org, item.repo, err)
}
}
default:
errChan <- errors.New("unknown label operation: " + update.Why)
}
}
}(updateChan)
}
wg.Wait()
close(errChan)
var overallErr error
if len(errChan) > 0 {
var updateErrs []error
for updateErr := range errChan {
updateErrs = append(updateErrs, updateErr)
}
overallErr = fmt.Errorf("failed to update labels: %v", updateErrs)
}
return overallErr
}
type client interface {
AddRepoLabel(org, repo, name, description, color string) error
UpdateRepoLabel(org, repo, currentName, newName, description, color string) error
DeleteRepoLabel(org, repo, label string) error
AddLabel(org, repo string, number int, label string) error
RemoveLabel(org, repo string, number int, label string) error
FindIssuesWithOrg(org, query, sort string, asc bool) ([]github.Issue, error)
GetRepos(org string, isUser bool) ([]github.Repo, error)
GetRepoLabels(string, string) ([]github.Label, error)
SetMax404Retries(int)
}
func newClient(tokenPath string, tokens, tokenBurst int, dryRun bool, graphqlEndpoint string, hosts ...string) (client, error) {
if tokenPath == "" {
return nil, errors.New("--token unset")
}
if err := secret.Add(tokenPath); err != nil {
logrus.WithError(err).Fatal("Error starting secrets agent.")
}
if dryRun {
return github.NewDryRunClient(secret.GetTokenGenerator(tokenPath), secret.Censor, graphqlEndpoint, hosts...)
}
c, err := github.NewClient(secret.GetTokenGenerator(tokenPath), secret.Censor, graphqlEndpoint, hosts...)
if err != nil {
return nil, fmt.Errorf("failed to construct github client: %v", err)
}
if tokens > 0 && tokenBurst >= tokens {
return nil, fmt.Errorf("--tokens=%d must exceed --token-burst=%d", tokens, tokenBurst)
}
if tokens > 0 {
c.Throttle(tokens, tokenBurst) // 300 hourly tokens, bursts of 100
}
return c, nil
}
// Main function
// Typical run with production configuration should require no parameters
// It expects:
// "labels" file in "/etc/config/labels.yaml"
// github OAuth2 token in "/etc/github/oauth", this token must have write access to all org's repos
// It uses request retrying (in case of run out of GH API points)
// It took about 10 minutes to process all my 8 repos with all wanted "kubernetes" labels (70+)
// Next run takes about 22 seconds to check if all labels are correct on all repos
func main() {
logrusutil.ComponentInit()
o, deprecated := gatherOptions()
if o.debug {
logrus.SetLevel(logrus.DebugLevel)
}
config, err := LoadConfig(o.labelsPath, o.orgs)
if err != nil {
logrus.WithError(err).Fatalf("failed to load --config=%s", o.labelsPath)
}
if o.onlyRepos != "" && o.skipRepos != "" {
logrus.Fatalf("--only and --skip cannot both be set")
}
if o.onlyRepos != "" && o.orgs != "" {
logrus.Fatalf("--only and --orgs cannot both be set")
}
switch {
case o.action == "docs":
if err := writeDocs(o.docsTemplate, o.docsOutput, *config); err != nil {
logrus.WithError(err).Fatalf("failed to write docs using docs-template %s to docs-output %s", o.docsTemplate, o.docsOutput)
}
case o.action == "css":
if err := writeCSS(o.cssTemplate, o.cssOutput, *config); err != nil {
logrus.WithError(err).Fatalf("failed to write css file using css-template %s to css-output %s", o.cssTemplate, o.cssOutput)
}
case o.action == "sync":
var githubClient client
var err error
if deprecated {
githubClient, err = newClient(o.token, o.tokens, o.tokenBurst, !o.confirm, o.graphqlEndpoint, o.endpoint.Strings()...)
} else {
err = o.github.Validate(!o.confirm)
if err == nil {
githubClient, err = o.github.GitHubClient(!o.confirm)
}
}
if err != nil {
logrus.WithError(err).Fatal("failed to create client")
}
githubClient.SetMax404Retries(0)
// there are three ways to configure which repos to sync:
// - a list of org/repo values
// - a list of orgs for which we sync all repos
// - a list of orgs to sync with a list of org/repo values to skip
if o.onlyRepos != "" {
reposToSync, parseError := parseCommaDelimitedList(o.onlyRepos)
if parseError != nil {
logrus.WithError(err).Fatal("invalid value for --only")
}
for org := range reposToSync {
if err = syncOrg(org, githubClient, *config, reposToSync[org], o.confirm); err != nil {
logrus.WithError(err).Fatalf("failed to update %s", org)
}
}
return
}
skippedRepos := map[string][]string{}
if o.skipRepos != "" {
reposToSkip, parseError := parseCommaDelimitedList(o.skipRepos)
if parseError != nil {
logrus.WithError(err).Fatal("invalid value for --skip")
}
skippedRepos = reposToSkip
}
for _, org := range strings.Split(o.orgs, ",") {
org = strings.TrimSpace(org)
logger := logrus.WithField("org", org)
logger.Info("Reading repos")
repos, err := loadRepos(org, githubClient)
if err != nil {
logger.WithError(err).Fatalf("failed to read repos")
}
if skipped, exist := skippedRepos[org]; exist {
repos = sets.NewString(repos...).Difference(sets.NewString(skipped...)).UnsortedList()
}
if err = syncOrg(org, githubClient, *config, repos, o.confirm); err != nil {
logrus.WithError(err).Fatalf("failed to update %s", org)
}
}
default:
logrus.Fatalf("unrecognized action: %s", o.action)
}
}
// parseCommaDelimitedList parses values in the format:
//
// org/repo,org2/repo2,org/repo3
//
// into a mapping of org to repos, i.e.:
//
// org: repo, repo3
// org2: repo2
func parseCommaDelimitedList(list string) (map[string][]string, error) {
mapping := map[string][]string{}
for _, r := range strings.Split(list, ",") {
value := strings.TrimSpace(r)
if strings.Count(value, "/") != 1 {
return nil, fmt.Errorf("invalid org/repo value %q", value)
}
parts := strings.SplitN(value, "/", 2)
if others, exist := mapping[parts[0]]; !exist {
mapping[parts[0]] = []string{parts[1]}
} else {
mapping[parts[0]] = append(others, parts[1])
}
}
return mapping, nil
}
type labelData struct {
Description, Link, Labels interface{}
}
func writeDocs(template string, output string, config Configuration) error {
var desc string
var data []labelData
desc = "all repos, for both issues and PRs"
data = append(data, labelData{desc, linkify(desc), LabelsForTarget(config.Default.Labels, bothTarget)})
desc = "all repos, only for issues"
data = append(data, labelData{desc, linkify(desc), LabelsForTarget(config.Default.Labels, issueTarget)})
desc = "all repos, only for PRs"
data = append(data, labelData{desc, linkify(desc), LabelsForTarget(config.Default.Labels, prTarget)})
// Let's sort orgs
var orgs []string
for org := range config.Orgs {
orgs = append(orgs, org)
}
sort.Strings(orgs)
// And append their labels
for _, org := range orgs {
lead := fmt.Sprintf("all repos in %s", org)
if l := LabelsForTarget(config.Orgs[org].Labels, bothTarget); len(l) > 0 {
desc = lead + ", for both issues and PRs"
data = append(data, labelData{desc, linkify(desc), l})
}
if l := LabelsForTarget(config.Orgs[org].Labels, issueTarget); len(l) > 0 {
desc = lead + ", only for issues"
data = append(data, labelData{desc, linkify(desc), l})
}
if l := LabelsForTarget(config.Orgs[org].Labels, prTarget); len(l) > 0 {
desc = lead + ", only for PRs"
data = append(data, labelData{desc, linkify(desc), l})
}
}
// Let's sort repos
var repos []string
for repo := range config.Repos {
repos = append(repos, repo)
}
sort.Strings(repos)
// And append their labels
for _, repo := range repos {
if l := LabelsForTarget(config.Repos[repo].Labels, bothTarget); len(l) > 0 {
desc = repo + ", for both issues and PRs"
data = append(data, labelData{desc, linkify(desc), l})
}
if l := LabelsForTarget(config.Repos[repo].Labels, issueTarget); len(l) > 0 {
desc = repo + ", only for issues"
data = append(data, labelData{desc, linkify(desc), l})
}
if l := LabelsForTarget(config.Repos[repo].Labels, prTarget); len(l) > 0 {
desc = repo + ", only for PRs"
data = append(data, labelData{desc, linkify(desc), l})
}
}
if err := writeTemplate(template, output, data); err != nil {
return err
}
return nil
}
// linkify transforms a string into a markdown anchor link
// I could not find a proper doc, so rules here a mostly empirical
func linkify(text string) string {
// swap space with dash
link := strings.Replace(text, " ", "-", -1)
// discard some special characters
discard, _ := regexp.Compile("[,/]")
link = discard.ReplaceAllString(link, "")
// lowercase
return strings.ToLower(link)
}
func syncOrg(org string, githubClient client, config Configuration, repos []string, confirm bool) error {
logger := logrus.WithField("org", org)
logger.Infof("Found %d repos", len(repos))
currLabels, err := loadLabels(githubClient, org, repos)
if err != nil {
return err
}
logger.Infof("Syncing labels for %d repos", len(repos))
updates, err := syncLabels(config, org, *currLabels)
if err != nil {
return err
}
y, _ := yaml.Marshal(updates)
logger.Debug(string(y))
if !confirm {
logger.Infof("Running without --confirm, no mutations made")
return nil
}
if err = updates.DoUpdates(org, githubClient); err != nil {
return err
}
return nil
}
type labelCSSData struct {
BackgroundColor, Color, Name string
}
// Returns the CSS escaped label name. Escaped method based on
// https://www.w3.org/International/questions/qa-escapes#cssescapes
func cssEscape(s string) (escaped string) {
var IsAlpha = regexp.MustCompile(`^[a-zA-Z]+$`).MatchString
for i, c := range s {
if (i == 0 && unicode.IsDigit(c)) || !(unicode.IsDigit(c) || IsAlpha(string(c))) {
escaped += fmt.Sprintf("x%0.6x", c)
continue
}
escaped += string(c)
}
return
}
// Returns the text color (whether black or white) given the background color.
// Details: https://www.w3.org/TR/WCAG20/#contrastratio
func getTextColor(backgroundColor string) (string, error) {
d, err := hex.DecodeString(backgroundColor)
if err != nil || len(d) != 3 {
return "", errors.New("expect 6-digit color hex of label")
}
// Calculate the relative luminance (L) of a color
// L = 0.2126 * R + 0.7152 * G + 0.0722 * B
// Formula details at: https://www.w3.org/TR/WCAG20/#relativeluminancedef
color := [3]float64{}
for i, v := range d {
color[i] = float64(v) / 255.0