Repository navigation
Expand file tree
/
Copy pathcommand_stop_on_nth_arg_test.go
More file actions
301 lines (281 loc) · 8.98 KB
/
Copy pathcommand_stop_on_nth_arg_test.go
File metadata and controls
301 lines (281 loc) · 8.98 KB
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
package cli
import (
"context"
"testing"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
func TestCommand_StopOnNthArg(t *testing.T) {
tests := []struct {
name string
stopOnNthArg *int
testArgs []string
expectedArgs []string
expectedFlag string
expectedBool bool
}{
{
name: "nil StopOnNthArg - normal parsing",
stopOnNthArg: nil,
testArgs: []string{"cmd", "--flag", "value", "arg1", "--bool", "arg2"},
expectedArgs: []string{"arg1", "arg2"},
expectedFlag: "value",
expectedBool: true,
},
{
name: "stop after 0 args - all become args",
stopOnNthArg: intPtr(0),
testArgs: []string{"cmd", "--flag", "value", "arg1", "--bool", "arg2"},
expectedArgs: []string{"--flag", "value", "arg1", "--bool", "arg2"},
expectedFlag: "",
expectedBool: false,
},
{
name: "stop after 1 arg",
stopOnNthArg: intPtr(1),
testArgs: []string{"cmd", "--flag", "value", "arg1", "--bool", "arg2"},
expectedArgs: []string{"arg1", "--bool", "arg2"},
expectedFlag: "value",
expectedBool: false,
},
{
name: "stop after 2 args",
stopOnNthArg: intPtr(2),
testArgs: []string{"cmd", "--flag", "value", "arg1", "arg2", "--bool", "arg3"},
expectedArgs: []string{"arg1", "arg2", "--bool", "arg3"},
expectedFlag: "value",
expectedBool: false,
},
{
name: "mixed flags and args - stop after 1",
stopOnNthArg: intPtr(1),
testArgs: []string{"cmd", "--flag", "value", "--bool", "arg1", "--flag2", "value2"},
expectedArgs: []string{"arg1", "--flag2", "value2"},
expectedFlag: "value",
expectedBool: true,
},
{
name: "args before flags - stop after 1",
stopOnNthArg: intPtr(1),
testArgs: []string{"cmd", "arg1", "--flag", "value", "--bool"},
expectedArgs: []string{"arg1", "--flag", "value", "--bool"},
expectedFlag: "",
expectedBool: false,
},
{
name: "ssh command example",
stopOnNthArg: intPtr(1),
testArgs: []string{"ssh", "machine-name", "ls", "-la"},
expectedArgs: []string{"machine-name", "ls", "-la"},
expectedFlag: "",
expectedBool: false,
},
{
name: "with double dash terminator",
stopOnNthArg: intPtr(1),
testArgs: []string{"cmd", "--flag", "value", "--", "arg1", "--not-a-flag"},
expectedArgs: []string{"arg1", "--not-a-flag"},
expectedFlag: "value",
expectedBool: false,
},
{
name: "stop after large number of args",
stopOnNthArg: intPtr(100),
testArgs: []string{"cmd", "--flag", "value", "arg1", "arg2", "--bool"},
expectedArgs: []string{"arg1", "arg2"},
expectedFlag: "value",
expectedBool: true,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
var args Args
var flagValue string
var boolValue bool
cmd := &Command{
Name: "test",
StopOnNthArg: tt.stopOnNthArg,
Flags: []Flag{
&StringFlag{Name: "flag", Destination: &flagValue},
&StringFlag{Name: "flag2"},
&BoolFlag{Name: "bool", Destination: &boolValue},
},
Action: func(_ context.Context, cmd *Command) error {
args = cmd.Args()
return nil
},
}
require.NoError(t, cmd.Run(buildTestContext(t), tt.testArgs))
assert.Equal(t, tt.expectedArgs, args.Slice())
assert.Equal(t, tt.expectedFlag, flagValue)
assert.Equal(t, tt.expectedBool, boolValue)
})
}
}
func TestCommand_StopOnNthArg_WithSubcommands(t *testing.T) {
tests := []struct {
name string
parentStopOnNthArg *int
subStopOnNthArg *int
testArgs []string
expectedParentArgs []string
expectedSubArgs []string
expectedSubFlag string
}{
{
name: "parent normal, subcommand stops after 0",
parentStopOnNthArg: nil,
subStopOnNthArg: intPtr(0),
testArgs: []string{"parent", "sub", "--subflag", "value", "subarg", "--not-parsed"},
expectedParentArgs: []string{},
expectedSubArgs: []string{"--subflag", "value", "subarg", "--not-parsed"},
expectedSubFlag: "",
},
{
name: "parent normal, subcommand stops after 1",
parentStopOnNthArg: nil,
subStopOnNthArg: intPtr(1),
testArgs: []string{"parent", "sub", "--subflag", "value", "subarg", "--not-parsed"},
expectedParentArgs: []string{},
expectedSubArgs: []string{"subarg", "--not-parsed"},
expectedSubFlag: "value",
},
{
name: "parent normal, subcommand stops after 2",
parentStopOnNthArg: nil,
subStopOnNthArg: intPtr(2),
testArgs: []string{"parent", "sub", "--subflag", "value", "subarg1", "subarg2", "--not-parsed"},
expectedParentArgs: []string{},
expectedSubArgs: []string{"subarg1", "subarg2", "--not-parsed"},
expectedSubFlag: "value",
},
{
name: "parent normal, subcommand never stops (high StopOnNthArg)",
parentStopOnNthArg: nil,
subStopOnNthArg: intPtr(100),
testArgs: []string{"parent", "sub", "--subflag", "value1", "arg1", "arg2", "--subflag", "value2"},
expectedParentArgs: []string{},
expectedSubArgs: []string{"arg1", "arg2"},
expectedSubFlag: "value2", // Should parse the second --subflag since we never hit the stop limit
},
{
// Meaningless, but okay.
name: "parent stops after 1, subcommand stops after 1",
parentStopOnNthArg: intPtr(1),
subStopOnNthArg: intPtr(1),
testArgs: []string{"parent", "sub", "--subflag", "value", "subarg", "--not-parsed"},
expectedParentArgs: []string{},
expectedSubArgs: []string{"subarg", "--not-parsed"},
expectedSubFlag: "value",
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
var parentArgs, subArgs Args
var subFlagValue string
subCalled := false
subCmd := &Command{
Name: "sub",
StopOnNthArg: tt.subStopOnNthArg,
Flags: []Flag{
&StringFlag{Name: "subflag", Destination: &subFlagValue},
},
Action: func(_ context.Context, cmd *Command) error {
subCalled = true
subArgs = cmd.Args()
return nil
},
}
parentCmd := &Command{
Name: "parent",
StopOnNthArg: tt.parentStopOnNthArg,
Commands: []*Command{subCmd},
Flags: []Flag{
&StringFlag{Name: "parentflag"},
},
Action: func(_ context.Context, cmd *Command) error {
parentArgs = cmd.Args()
return nil
},
}
err := parentCmd.Run(buildTestContext(t), tt.testArgs)
require.NoError(t, err)
if tt.expectedSubArgs != nil {
assert.True(t, subCalled, "subcommand should have been called")
if len(tt.expectedSubArgs) > 0 {
haveNonEmptySubArgsSlice := subArgs != nil && subArgs.Slice() != nil && len(subArgs.Slice()) > 0
assert.True(t, haveNonEmptySubArgsSlice, "subargs.Slice is not nil")
if haveNonEmptySubArgsSlice {
assert.Equal(t, tt.expectedSubArgs, subArgs.Slice())
}
} else {
assert.True(t, subArgs == nil || subArgs.Slice() == nil || len(subArgs.Slice()) == 0, "subargs.Slice is not nil")
}
assert.Equal(t, tt.expectedSubFlag, subFlagValue)
} else {
assert.False(t, subCalled, "subcommand should not have been called")
assert.Equal(t, tt.expectedParentArgs, parentArgs.Slice())
}
})
}
}
func TestCommand_StopOnNthArg_EdgeCases(t *testing.T) {
t.Run("negative StopOnNthArg returns error", func(t *testing.T) {
cmd := &Command{
Name: "test",
StopOnNthArg: intPtr(-1),
Action: func(_ context.Context, cmd *Command) error {
return nil
},
}
// Negative value should return an error
err := cmd.Run(buildTestContext(t), []string{"cmd", "arg1"})
require.Error(t, err)
assert.Contains(t, err.Error(), "StopOnNthArg must be non-negative")
})
t.Run("zero StopOnNthArg with no args", func(t *testing.T) {
var args Args
var flagValue string
cmd := &Command{
Name: "test",
StopOnNthArg: intPtr(0),
Flags: []Flag{
&StringFlag{Name: "flag", Destination: &flagValue},
},
Action: func(_ context.Context, cmd *Command) error {
args = cmd.Args()
return nil
},
}
// All flags should become args
require.NoError(t, cmd.Run(buildTestContext(t), []string{"cmd", "--flag", "value"}))
assert.Equal(t, []string{"--flag", "value"}, args.Slice())
assert.Equal(t, "", flagValue)
})
t.Run("StopOnNthArg with only flags", func(t *testing.T) {
var args Args
var flagValue string
var boolValue bool
cmd := &Command{
Name: "test",
StopOnNthArg: intPtr(1),
Flags: []Flag{
&StringFlag{Name: "flag", Destination: &flagValue},
&BoolFlag{Name: "bool", Destination: &boolValue},
},
Action: func(_ context.Context, cmd *Command) error {
args = cmd.Args()
return nil
},
}
// Should parse all flags since no args are encountered
require.NoError(t, cmd.Run(buildTestContext(t), []string{"cmd", "--flag", "value", "--bool"}))
assert.Equal(t, []string{}, args.Slice())
assert.Equal(t, "value", flagValue)
assert.True(t, boolValue)
})
}
// Helper function to create int pointer
func intPtr(i int) *int {
return &i
}