/
flag_groups.go
144 lines (127 loc) · 4.28 KB
/
flag_groups.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
// Copyright © 2022 Steve Francia <spf@spf13.com>.
//
// 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 cobra
import (
"fmt"
"sort"
"strings"
flag "github.com/spf13/pflag"
)
const (
RequiredAsGroup = "cobra_annotation_required_if_others_set"
MutuallyExclusive = "cobra_annotation_mutually_exclusive"
)
func (c *Command) MarkFlagsRequiredTogether(flagNames ...string) {
for _, v := range flagNames {
f := c.Flags().Lookup(v)
if f.Annotations == nil {
f.Annotations = map[string][]string{}
}
// Each time this is called is a single new entry; this allows it to be a member of multiple groups if needed.
f.Annotations[RequiredAsGroup] = append(f.Annotations[RequiredAsGroup], strings.Join(flagNames, " "))
}
}
func (c *Command) MarkFlagsMutuallyExclusive(flagNames ...string) {
for _, v := range flagNames {
f := c.Flags().Lookup(v)
if f.Annotations == nil {
f.Annotations = map[string][]string{}
}
// Each time this is called is a single new entry; this allows it to be a member of multiple groups if needed.
f.Annotations[MutuallyExclusive] = append(f.Annotations[MutuallyExclusive], strings.Join(flagNames, " "))
}
}
// validateFlagGroups validates the mutuallyExclusive/requiredAsGroup logic.
func (c *Command) validateFlagGroups() error {
if c.DisableFlagParsing {
return nil
}
flags := c.Flags()
// groupStatus format is the list of flags as a unique ID,
// then a map of each flag name and whether it is set or not.
groupStatus := map[string]map[string]bool{}
mutuallyExclusiveGroupStatus := map[string]map[string]bool{}
flags.VisitAll(func(pflag *flag.Flag) {
processFlagForGroupAnnotation(pflag, RequiredAsGroup, groupStatus)
processFlagForGroupAnnotation(pflag, MutuallyExclusive, mutuallyExclusiveGroupStatus)
})
errs := validateRequiredFlagGroups(groupStatus)
errsExclusive := validateExclusiveFlagGroups(mutuallyExclusiveGroupStatus)
errs = append(errs, errsExclusive...)
if len(errs) > 0 {
return combineErrors(errs, `, `)
}
return nil
}
func processFlagForGroupAnnotation(pflag *flag.Flag, annotation string, groupStatus map[string]map[string]bool) {
groupInfo, found := pflag.Annotations[annotation]
if found {
for _, group := range groupInfo {
if groupStatus[group] == nil {
groupStatus[group] = map[string]bool{}
flagnames := strings.Split(group, " ")
for _, name := range flagnames {
groupStatus[group][name] = false
}
}
groupStatus[group][pflag.Name] = pflag.Changed
}
}
}
func validateRequiredFlagGroups(data map[string]map[string]bool) []error {
var errs []error
for flagList, flagnameAndStatus := range data {
unset := []string{}
for flagname, isSet := range flagnameAndStatus {
if !isSet {
unset = append(unset, flagname)
}
}
if len(unset) == len(flagnameAndStatus) || len(unset) == 0 {
continue
}
sort.Strings(unset)
errs = append(errs, fmt.Errorf("if any flags in the group [%v] are set they must all be set; missing %v", flagList, unset))
}
return errs
}
func validateExclusiveFlagGroups(data map[string]map[string]bool) []error {
var errs []error
for flagList, flagnameAndStatus := range data {
var set []string
for flagname, isSet := range flagnameAndStatus {
if isSet {
set = append(set, flagname)
}
}
if len(set) == 0 || len(set) == 1 {
continue
}
sort.Strings(set)
errs = append(errs, fmt.Errorf("if any flags in the group [%v] are set none of the others can be; %v were all set", flagList, set))
}
return errs
}
// combineErrors will squash the errors together into a single error with there messages
// joined by the given seperator.
func combineErrors(errs []error, sep string) error {
if len(errs) == 0 {
return nil
}
var msgs []string
for _, e := range errs {
msgs = append(msgs, e.Error())
}
sort.Strings(msgs)
return fmt.Errorf(strings.Join(msgs, sep))
}