-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcobrabuilder_test.go
321 lines (311 loc) · 14 KB
/
cobrabuilder_test.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
package boa
import (
"errors"
"fmt"
"reflect"
"runtime"
"testing"
"github.com/spf13/cobra"
"github.com/spf13/pflag"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/mock"
)
type MockCobraCmd struct {
mock.Mock
*cobra.Command
}
func TestCobraCmdBuilder(t *testing.T) {
// common values to use for struct literal cobra.Command vs CobraCmdBuilder
// cobra.Command
aliases := []string{"alias1", "alias2"}
suggestFor := []string{"cmd1", "cmd2"}
short := "short desc"
long := "long desc"
groupId := "group ID"
example := `example 1`
validArgs := []string{"arg1", "arg2"}
validArgsFunc := func(*cobra.Command, []string, string) ([]string, cobra.ShellCompDirective) {
return []string{"test"}, cobra.ShellCompDirectiveDefault
}
args := cobra.MatchAll(cobra.MaximumNArgs(1), cobra.OnlyValidArgs)
argAliases := []string{"argAlias1", "argAlias2"}
bashCompFunc := "compFunc"
deprecationMsg := "cmd is deprecated"
annotations := make(map[string]string)
version := "0.1.0"
runFunc := func(*cobra.Command, []string) {}
runEFunc := func(*cobra.Command, []string) error {
return fmt.Errorf("test")
}
errWhitelist := cobra.FParseErrWhitelist{}
options := cobra.CompletionOptions{}
traverseChildren := true
hidden := true
silenceErrors := true
silenceUsage := true
disableFlagParsing := true
disableFlagsInUseLine := true
disableAutoGenTag := true
disableSuggestions := true
suggestionMinDist := 2
subCommands := []*cobra.Command{{Use: "a"}, {Use: "b"}}
usageTemplate := "usage"
helpTemplate := "help"
usageFunc := func(*cobra.Command) error { return errors.New("") }
helpFunc := func(*cobra.Command, []string) {}
// common values to use for mock cobra.Command flagset vs CobraCmdBuilder flagset
boolName := "boolFlag"
boolVarName := "boolVarFlag"
boolPName := "boolPFlag"
boolVarPName := "boolVarPFlag"
boolVar := false
boolShorthand := "a"
boolVarShorthand := "A"
boolDefault := false
boolUsage := "bool usage"
boolSliceName := "boolSliceFlag"
boolSliceVarName := "boolSliceVarFlag"
boolSlicePName := "boolSlicePFlag"
boolSliceVarPName := "boolSliceVarPFlag"
boolSliceVar := []bool{}
boolSliceShorthand := "b"
boolSliceVarShorthand := "B"
boolSliceDefault := []bool{false}
boolSliceUsage := "bool slice usage"
stringName := "stringFlag"
stringVarName := "stringVarFlag"
stringPName := "stringPFlag"
stringVarPName := "stringVarPFlag"
stringSliceName := "stringSliceFlag"
stringSliceVarName := "stringSliceVarFlag"
stringSlicePName := "stringSlicePFlag"
stringSliceVarPName := "stringSliceVarPFlag"
stringVar := "t"
stringShorthand := "c"
stringVarShorthand := "C"
stringDefault := "test"
stringUsage := "string usage"
stringSliceVar := []string{"t"}
stringSliceShorthand := "d"
stringSliceVarShorthand := "D"
stringSliceDefault := []string{"test"}
stringSliceUsage := "string slice usage"
// define mock cobra.Command using struct literal to compare to the resulting
// cobra.Command from the CobraCmdBuilder
mockCmd := &MockCobraCmd{
Command: &cobra.Command{
Aliases: aliases,
SuggestFor: suggestFor,
Short: short,
Long: long,
GroupID: groupId,
Example: example,
ValidArgs: validArgs,
ValidArgsFunction: validArgsFunc,
Args: args,
ArgAliases: argAliases,
BashCompletionFunction: bashCompFunc,
Deprecated: deprecationMsg,
Annotations: annotations,
Version: version,
PersistentPreRun: runFunc,
PersistentPreRunE: runEFunc,
PreRun: runFunc,
PreRunE: runEFunc,
Run: runFunc,
RunE: runEFunc,
PostRun: runFunc,
PostRunE: runEFunc,
PersistentPostRun: runFunc,
PersistentPostRunE: runEFunc,
FParseErrWhitelist: errWhitelist,
CompletionOptions: options,
TraverseChildren: traverseChildren,
Hidden: hidden,
SilenceErrors: silenceErrors,
SilenceUsage: silenceUsage,
DisableFlagParsing: disableFlagParsing,
DisableFlagsInUseLine: disableFlagsInUseLine,
DisableAutoGenTag: disableAutoGenTag,
DisableSuggestions: disableSuggestions,
SuggestionsMinimumDistance: suggestionMinDist,
},
}
// cover the additional cobra.Command methods that the CobraCmdBuilder wraps
mockCmd.AddCommand(subCommands...)
mockCmd.SetUsageTemplate(usageTemplate)
mockCmd.SetHelpTemplate(helpTemplate)
mockCmd.SetUsageFunc(usageFunc)
mockCmd.SetHelpFunc(helpFunc)
// define a mock pflag.Flagset to compare to the cobra.Command.Flags() flagset
// that results from using the builder methods
mockFs := pflag.NewFlagSet("mockfs", pflag.ContinueOnError)
mockFs.Bool(boolName, boolDefault, boolUsage)
mockFs.BoolVar(&boolVar, boolVarName, boolDefault, boolUsage)
mockFs.BoolP(boolPName, boolShorthand, boolDefault, boolUsage)
mockFs.BoolVarP(&boolVar, boolVarPName, boolVarShorthand, boolDefault, boolUsage)
mockFs.BoolSlice(boolSliceName, boolSliceDefault, boolSliceUsage)
mockFs.BoolSliceVar(&boolSliceVar, boolSliceVarName, boolSliceDefault, boolSliceUsage)
mockFs.BoolSliceP(boolSlicePName, boolSliceShorthand, boolSliceDefault, boolSliceUsage)
mockFs.BoolSliceVarP(&boolSliceVar, boolSliceVarPName, boolSliceVarShorthand, boolSliceDefault, boolSliceUsage)
mockFs.String(stringName, stringDefault, stringUsage)
mockFs.StringVar(&stringVar, stringVarName, stringDefault, stringUsage)
mockFs.StringP(stringPName, stringShorthand, stringDefault, stringUsage)
mockFs.StringVarP(&stringVar, stringVarPName, stringVarShorthand, stringDefault, stringUsage)
mockFs.StringSlice(stringSliceName, stringSliceDefault, stringSliceUsage)
mockFs.StringSliceVar(&stringSliceVar, stringSliceVarName, stringSliceDefault, stringSliceUsage)
mockFs.StringSliceP(stringSlicePName, stringSliceShorthand, stringSliceDefault, stringSliceUsage)
mockFs.StringSliceVarP(&stringSliceVar, stringSliceVarPName, stringSliceVarShorthand, stringSliceDefault, stringSliceUsage)
mockCmd.Flags().AddFlagSet(mockFs)
// Create a new cobra.Command using the builder
cmd := NewCobraCmd("test").
WithAliases(aliases).
SuggestFor(suggestFor).
WithShortDescription(short).
WithLongDescription(long).
WithGroupID(groupId).
WithExample(example).
WithValidArgs(validArgs).
WithValidArgsFunction(validArgsFunc).
WithArgs(args).
WithArgAliases(argAliases).
WithBashCompletionFunction(bashCompFunc).
Deprecated(deprecationMsg).
WithAnnotations(annotations).
WithVersion(version).
WithPersistentPreRunFunc(runFunc).
WithPersistentPreRunEFunc(runEFunc).
WithPreRunFunc(runFunc).
WithPreRunEFunc(runEFunc).
WithRunFunc(runFunc).
WithRunEFunc(runEFunc).
WithPostRunFunc(runFunc).
WithPostRunEFunc(runEFunc).
WithPersistentPostRunFunc(runFunc).
WithPersistentPostRunEFunc(runEFunc).
WithFParseErrWhitelist(errWhitelist).
WithCompletionOptions(options).
WithSuggestionsMinimumDistance(suggestionMinDist).
WithSubCommands(subCommands...).
WithUsageTemplate(usageTemplate).
WithHelpTemplate(helpTemplate).
WithUsageFunc(usageFunc).
WithHelpFunc(helpFunc).
TraverseChildren().
Hidden().
SilenceErrors().
SilenceUsage().
DisableFlagParsing().
DisableFlagsInUseLine().
DisableAutoGenTag().
DisableSuggestions().
WithBoolFlag(boolName, boolDefault, boolUsage).
WithBoolVarFlag(&boolVar, boolVarName, boolDefault, boolUsage).
WithBoolPFlag(boolPName, boolShorthand, boolDefault, boolUsage).
WithBoolVarPFlag(&boolVar, boolVarPName, boolVarShorthand, boolDefault, boolUsage).
WithBoolSliceFlag(boolSliceName, boolSliceDefault, boolSliceUsage).
WithBoolSliceVarFlag(&boolSliceVar, boolSliceVarName, boolSliceDefault, boolSliceUsage).
WithBoolSlicePFlag(boolSlicePName, boolSliceShorthand, boolSliceDefault, boolSliceUsage).
WithBoolSliceVarPFlag(&boolSliceVar, boolSliceVarPName, boolSliceVarShorthand, boolSliceDefault, boolSliceUsage).
WithStringFlag(stringName, stringDefault, stringUsage).
WithStringVarFlag(&stringVar, stringVarName, stringDefault, stringUsage).
WithStringPFlag(stringPName, stringShorthand, stringDefault, stringUsage).
WithStringVarPFlag(&stringVar, stringVarPName, stringVarShorthand, stringDefault, stringUsage).
WithStringSliceFlag(stringSliceName, stringSliceDefault, stringSliceUsage).
WithStringSliceVarFlag(&stringSliceVar, stringSliceVarName, stringSliceDefault, stringSliceUsage).
WithStringSlicePFlag(stringSlicePName, stringSliceShorthand, stringSliceDefault, stringSliceUsage).
WithStringSliceVarPFlag(&stringSliceVar, stringSliceVarPName, stringSliceVarShorthand, stringSliceDefault, stringSliceUsage).
Build()
//Field Equality
assert.Equal(t, mockCmd.Aliases, cmd.Aliases)
assert.Equal(t, mockCmd.SuggestFor, cmd.SuggestFor)
assert.Equal(t, mockCmd.Short, cmd.Short)
assert.Equal(t, mockCmd.Long, cmd.Long)
assert.Equal(t, mockCmd.GroupID, cmd.GroupID)
assert.Equal(t, mockCmd.Example, cmd.Example)
assert.Equal(t, mockCmd.ValidArgs, cmd.ValidArgs)
assert.Equal(t, mockCmd.ArgAliases, cmd.ArgAliases)
assert.Equal(t, mockCmd.BashCompletionFunction, cmd.BashCompletionFunction)
assert.Equal(t, mockCmd.Deprecated, cmd.Deprecated)
assert.Equal(t, mockCmd.Annotations, cmd.Annotations)
assert.Equal(t, mockCmd.Version, cmd.Version)
assert.Equal(t, mockCmd.FParseErrWhitelist, cmd.FParseErrWhitelist)
assert.Equal(t, mockCmd.CompletionOptions, cmd.CompletionOptions)
assert.Equal(t, mockCmd.TraverseChildren, cmd.TraverseChildren)
assert.Equal(t, mockCmd.Hidden, cmd.Hidden)
assert.Equal(t, mockCmd.SilenceErrors, cmd.SilenceErrors)
assert.Equal(t, mockCmd.SilenceUsage, cmd.SilenceUsage)
assert.Equal(t, mockCmd.DisableFlagParsing, cmd.DisableFlagParsing)
assert.Equal(t, mockCmd.DisableFlagsInUseLine, cmd.DisableFlagsInUseLine)
assert.Equal(t, mockCmd.DisableAutoGenTag, cmd.DisableAutoGenTag)
assert.Equal(t, mockCmd.DisableSuggestions, cmd.DisableSuggestions)
// Function Equality
assert.Equal(t, getFuncName(mockCmd.ValidArgsFunction), getFuncName(cmd.ValidArgsFunction))
assert.Equal(t, getFuncName(mockCmd.Args), getFuncName(cmd.Args))
assert.Equal(t, getFuncName(mockCmd.PersistentPreRun), getFuncName(cmd.PersistentPreRun))
assert.Equal(t, getFuncName(mockCmd.PersistentPreRunE), getFuncName(cmd.PersistentPreRunE))
assert.Equal(t, getFuncName(mockCmd.PreRun), getFuncName(cmd.PreRun))
assert.Equal(t, getFuncName(mockCmd.PreRunE), getFuncName(cmd.PreRunE))
assert.Equal(t, getFuncName(mockCmd.Run), getFuncName(cmd.Run))
assert.Equal(t, getFuncName(mockCmd.RunE), getFuncName(cmd.RunE))
assert.Equal(t, getFuncName(mockCmd.PostRun), getFuncName(cmd.PostRun))
assert.Equal(t, getFuncName(mockCmd.PostRunE), getFuncName(cmd.PostRunE))
assert.Equal(t, getFuncName(mockCmd.PersistentPostRun), getFuncName(cmd.PersistentPostRun))
assert.Equal(t, getFuncName(mockCmd.PersistentPostRunE), getFuncName(cmd.PersistentPostRunE))
// Flag Equality
// bool flags
mockBoolFlag, _ := mockCmd.Flags().GetBool(boolName)
cmdBoolFlag, _ := cmd.Flags().GetBool(boolName)
assert.Equal(t, mockBoolFlag, cmdBoolFlag)
mockBoolFlag, _ = mockCmd.Flags().GetBool(boolVarName)
cmdBoolFlag, _ = cmd.Flags().GetBool(boolVarName)
assert.Equal(t, mockBoolFlag, cmdBoolFlag)
mockBoolFlag, _ = mockCmd.Flags().GetBool(boolPName)
cmdBoolFlag, _ = cmd.Flags().GetBool(boolPName)
assert.Equal(t, mockBoolFlag, cmdBoolFlag)
mockBoolFlag, _ = mockCmd.Flags().GetBool(boolVarPName)
cmdBoolFlag, _ = cmd.Flags().GetBool(boolVarPName)
assert.Equal(t, mockBoolFlag, cmdBoolFlag)
// bool slice flags
mockBoolSliceFlag, _ := mockCmd.Flags().GetBoolSlice(boolSliceName)
cmdBoolSliceFlag, _ := cmd.Flags().GetBoolSlice(boolSliceName)
assert.Equal(t, mockBoolSliceFlag, cmdBoolSliceFlag)
mockBoolSliceFlag, _ = mockCmd.Flags().GetBoolSlice(boolSliceVarName)
cmdBoolSliceFlag, _ = cmd.Flags().GetBoolSlice(boolSliceVarName)
assert.Equal(t, mockBoolSliceFlag, cmdBoolSliceFlag)
mockBoolSliceFlag, _ = mockCmd.Flags().GetBoolSlice(boolSlicePName)
cmdBoolSliceFlag, _ = cmd.Flags().GetBoolSlice(boolSlicePName)
assert.Equal(t, mockBoolSliceFlag, cmdBoolSliceFlag)
mockBoolSliceFlag, _ = mockCmd.Flags().GetBoolSlice(boolSliceVarPName)
cmdBoolSliceFlag, _ = cmd.Flags().GetBoolSlice(boolSliceVarPName)
assert.Equal(t, mockBoolSliceFlag, cmdBoolSliceFlag)
// string flags
mockStringFlag, _ := mockCmd.Flags().GetString(stringName)
cmdStringFlag, _ := cmd.Flags().GetString(stringName)
assert.Equal(t, mockStringFlag, cmdStringFlag)
mockStringFlag, _ = mockCmd.Flags().GetString(stringVarName)
cmdStringFlag, _ = cmd.Flags().GetString(stringVarName)
assert.Equal(t, mockStringFlag, cmdStringFlag)
mockStringFlag, _ = mockCmd.Flags().GetString(stringPName)
cmdStringFlag, _ = cmd.Flags().GetString(stringPName)
assert.Equal(t, mockStringFlag, cmdStringFlag)
mockStringFlag, _ = mockCmd.Flags().GetString(stringVarPName)
cmdStringFlag, _ = cmd.Flags().GetString(stringVarPName)
assert.Equal(t, mockStringFlag, cmdStringFlag)
// string slice flags
mockStringSliceFlag, _ := mockCmd.Flags().GetStringSlice(stringSliceName)
cmdStringSliceFlag, _ := cmd.Flags().GetStringSlice(stringSliceName)
assert.Equal(t, mockStringSliceFlag, cmdStringSliceFlag)
mockStringSliceFlag, _ = mockCmd.Flags().GetStringSlice(stringSliceVarName)
cmdStringSliceFlag, _ = cmd.Flags().GetStringSlice(stringSliceVarName)
assert.Equal(t, mockStringSliceFlag, cmdStringSliceFlag)
mockStringSliceFlag, _ = mockCmd.Flags().GetStringSlice(stringSlicePName)
cmdStringSliceFlag, _ = cmd.Flags().GetStringSlice(stringSlicePName)
assert.Equal(t, mockStringSliceFlag, cmdStringSliceFlag)
mockStringSliceFlag, _ = mockCmd.Flags().GetStringSlice(stringSliceVarPName)
cmdStringSliceFlag, _ = cmd.Flags().GetStringSlice(stringSliceVarPName)
assert.Equal(t, mockStringSliceFlag, cmdStringSliceFlag)
}
func getFuncName(function any) string {
return runtime.FuncForPC(reflect.ValueOf(function).Pointer()).Name()
}