-
Notifications
You must be signed in to change notification settings - Fork 124
/
flag.go
277 lines (251 loc) · 7.78 KB
/
flag.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
// Copyright (c) Contributors to the Apptainer project, established as
// Apptainer a Series of LF Projects LLC.
// For website terms of use, trademark policy, privacy policy and other
// project policies see https://lfprojects.org/policies
// Copyright (c) 2019-2021, Sylabs Inc. All rights reserved.
// This software is licensed under a 3-clause BSD license. Please consult the
// LICENSE.md file distributed with the sources of this project regarding your
// rights to use or distribute this software.
package cmdline
import (
"fmt"
"os"
"github.com/apptainer/apptainer/internal/pkg/util/env"
"github.com/apptainer/apptainer/pkg/sylog"
"github.com/spf13/cobra"
"github.com/spf13/pflag"
)
type StringArray []string
// Flag holds information about a command flag
type Flag struct {
ID string
Value interface{}
DefaultValue interface{}
Name string
ShortHand string
Usage string
Tag string
Deprecated string
Hidden bool
Required bool
EnvKeys []string
EnvHandler EnvHandler
// Export envar also without prefix
WithoutPrefix bool
}
// flagManager manages cobra command flags and store them
// in a hash map
type flagManager struct {
flags map[string]*Flag
}
// newFlagManager instantiates a flag manager and returns it
func newFlagManager() *flagManager {
return &flagManager{
flags: make(map[string]*Flag),
}
}
func (m *flagManager) setFlagOptions(flag *Flag, cmd *cobra.Command) {
cmd.Flags().SetAnnotation(flag.Name, "argtag", []string{flag.Tag})
cmd.Flags().SetAnnotation(flag.Name, "ID", []string{flag.ID})
if len(flag.EnvKeys) > 0 {
cmd.Flags().SetAnnotation(flag.Name, "envkey", flag.EnvKeys)
// Environment flags can also be exported without a prefix (e.g. DOCKER_*)
if flag.WithoutPrefix {
cmd.Flags().SetAnnotation(flag.Name, "withoutPrefix", []string{"true"})
}
}
if flag.Deprecated != "" {
cmd.Flags().MarkDeprecated(flag.Name, flag.Deprecated)
}
if flag.Hidden {
cmd.Flags().MarkHidden(flag.Name)
}
if flag.Required {
cmd.MarkFlagRequired(flag.Name)
}
}
func (m *flagManager) registerFlagForCmd(flag *Flag, cmds ...*cobra.Command) error {
for _, c := range cmds {
if c == nil {
return fmt.Errorf("nil command provided")
}
}
if flag == nil {
return fmt.Errorf("nil flag provided")
}
if flag.EnvHandler == nil {
flag.EnvHandler = EnvSetValue
}
switch flag.DefaultValue.(type) {
case string:
m.registerStringVar(flag, cmds)
case map[string]string:
m.registerStringMapVar(flag, cmds)
case []string:
m.registerStringSliceVar(flag, cmds)
case StringArray:
m.registerStringArrayVar(flag, cmds)
case bool:
m.registerBoolVar(flag, cmds)
case int:
m.registerIntVar(flag, cmds)
case uint32:
m.registerUint32Var(flag, cmds)
default:
return fmt.Errorf("flag %s of type %T is not supported", flag.Name, flag.DefaultValue)
}
m.flags[flag.ID] = flag
return nil
}
func (m *flagManager) registerStringVar(flag *Flag, cmds []*cobra.Command) error {
for _, c := range cmds {
if flag.ShortHand != "" {
c.Flags().StringVarP(flag.Value.(*string), flag.Name, flag.ShortHand, flag.DefaultValue.(string), flag.Usage)
} else {
c.Flags().StringVar(flag.Value.(*string), flag.Name, flag.DefaultValue.(string), flag.Usage)
}
m.setFlagOptions(flag, c)
}
return nil
}
func (m *flagManager) registerStringSliceVar(flag *Flag, cmds []*cobra.Command) error {
for _, c := range cmds {
if flag.ShortHand != "" {
c.Flags().StringSliceVarP(flag.Value.(*[]string), flag.Name, flag.ShortHand, flag.DefaultValue.([]string), flag.Usage)
} else {
c.Flags().StringSliceVar(flag.Value.(*[]string), flag.Name, flag.DefaultValue.([]string), flag.Usage)
}
m.setFlagOptions(flag, c)
}
return nil
}
func (m *flagManager) registerStringArrayVar(flag *Flag, cmds []*cobra.Command) error {
for _, c := range cmds {
if flag.ShortHand != "" {
c.Flags().StringArrayVarP(flag.Value.(*[]string), flag.Name, flag.ShortHand, ([]string)(flag.DefaultValue.(StringArray)), flag.Usage)
} else {
c.Flags().StringArrayVar(flag.Value.(*[]string), flag.Name, ([]string)(flag.DefaultValue.(StringArray)), flag.Usage)
}
m.setFlagOptions(flag, c)
}
return nil
}
// registerStringArrayCommas uses StringToStringVarP, a variant to allow commas (and a map of string/string)
func (m *flagManager) registerStringMapVar(flag *Flag, cmds []*cobra.Command) error {
for _, c := range cmds {
if flag.ShortHand != "" {
c.Flags().StringToStringVarP(flag.Value.(*map[string]string), flag.Name, flag.ShortHand, flag.DefaultValue.(map[string]string), flag.Usage)
} else {
c.Flags().StringToStringVar(flag.Value.(*map[string]string), flag.Name, flag.DefaultValue.(map[string]string), flag.Usage)
}
m.setFlagOptions(flag, c)
}
return nil
}
func (m *flagManager) registerBoolVar(flag *Flag, cmds []*cobra.Command) error {
for _, c := range cmds {
if flag.ShortHand != "" {
c.Flags().BoolVarP(flag.Value.(*bool), flag.Name, flag.ShortHand, flag.DefaultValue.(bool), flag.Usage)
} else {
c.Flags().BoolVar(flag.Value.(*bool), flag.Name, flag.DefaultValue.(bool), flag.Usage)
}
m.setFlagOptions(flag, c)
}
return nil
}
func (m *flagManager) registerIntVar(flag *Flag, cmds []*cobra.Command) error {
for _, c := range cmds {
if flag.ShortHand != "" {
c.Flags().IntVarP(flag.Value.(*int), flag.Name, flag.ShortHand, flag.DefaultValue.(int), flag.Usage)
} else {
c.Flags().IntVar(flag.Value.(*int), flag.Name, flag.DefaultValue.(int), flag.Usage)
}
m.setFlagOptions(flag, c)
}
return nil
}
func (m *flagManager) registerUint32Var(flag *Flag, cmds []*cobra.Command) error {
for _, c := range cmds {
if flag.ShortHand != "" {
c.Flags().Uint32VarP(flag.Value.(*uint32), flag.Name, flag.ShortHand, flag.DefaultValue.(uint32), flag.Usage)
} else {
c.Flags().Uint32Var(flag.Value.(*uint32), flag.Name, flag.DefaultValue.(uint32), flag.Usage)
}
m.setFlagOptions(flag, c)
}
return nil
}
func (m *flagManager) updateCmdFlagFromEnv(cmd *cobra.Command, precedence int, foundKeys map[string]string) error {
var errs []error
var prefix string
if precedence >= 0 {
prefix = env.ApptainerPrefixes[precedence]
}
fn := func(flag *pflag.Flag) {
envKeys, ok := flag.Annotations["envkey"]
if !ok {
return
}
id, ok := flag.Annotations["ID"]
if !ok {
return
}
mflag, ok := m.flags[id[0]]
if !ok {
return
}
for _, key := range envKeys {
// First priority goes to prefixed variable
val, set := os.LookupEnv(prefix + key)
withoutPrefix := false
if !set {
// The prefix-less check only needs to be done for precedence 0
if precedence > 0 {
continue
}
// Determine if environment keys should be looked for without prefix
// This annotation just needs to be present, period
_, withoutPrefix = flag.Annotations["withoutPrefix"]
if !withoutPrefix {
continue
}
// Second try - looking for the same without prefix!
val, set = os.LookupEnv(key)
if !set {
continue
}
}
if precedence > 0 {
if foundVal, ok := foundKeys[key]; ok {
if foundVal == val {
sylog.Debugf("%s and %s have the same value [%s]", prefix+key, env.ApptainerPrefixes[0]+key, val)
} else {
sylog.Warningf("%s and %s have different values, using the latter", prefix+key, env.ApptainerPrefixes[0]+key)
}
continue
} else {
sylog.Infof("Environment variable %v is set, but %v is preferred", prefix+key, env.ApptainerPrefixes[0]+key)
}
}
if !withoutPrefix {
foundKeys[key] = val
}
if mflag.EnvHandler != nil {
if err := mflag.EnvHandler(flag, val); err != nil {
errs = append(errs, err)
break
}
}
}
}
// visit each child commands
cmd.Flags().VisitAll(fn)
if len(errs) > 0 {
errStr := ""
for _, e := range errs {
errStr += fmt.Sprintf("\n%s", e.Error())
}
return fmt.Errorf(errStr)
}
return nil
}