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
|
package complete
import (
"io/ioutil"
"os"
"testing"
"github.com/posener/complete/v2/internal/arg"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
var testCmd = &Command{
Flags: map[string]Predictor{"cmd-flag": nil},
Sub: map[string]*Command{
"flags": &Command{
Flags: map[string]Predictor{
"values": set{"a", "a a", "b"},
"something": set{""},
"nothing": nil,
},
},
"sub1": &Command{
Flags: map[string]Predictor{"flag1": nil},
Sub: map[string]*Command{
"sub11": &Command{
Flags: map[string]Predictor{"flag11": nil},
},
"sub12": &Command{},
},
Args: set{"arg1", "arg2"},
},
"sub2": &Command{},
"args": &Command{
Args: set{"a", "a a", "b"},
},
},
}
func TestCompleter(t *testing.T) {
t.Parallel()
tests := []struct {
args string
want []string
}{
// Check empty flag name matching.
{args: "flags ", want: []string{"-values", "-nothing", "-something", "-cmd-flag", "-h"}},
{args: "flags -", want: []string{"-values", "-nothing", "-something", "-cmd-flag", "-h"}},
{args: "flags --", want: []string{"--values", "--nothing", "--something", "--cmd-flag", "--help"}},
// If started a flag with no matching prefix, expect to see all possible flags.
{args: "flags -x", want: []string{"-values", "-nothing", "-something", "-cmd-flag", "-h"}},
// Check prefix matching for chain of sub commands.
{args: "sub1 sub11 -fl", want: []string{"-flag11", "-flag1"}},
{args: "sub1 sub11 --fl", want: []string{"--flag11", "--flag1"}},
// Test sub command completion.
{args: "", want: []string{"flags", "sub1", "sub2", "args", "-h"}},
{args: " ", want: []string{"flags", "sub1", "sub2", "args", "-h"}},
{args: "f", want: []string{"flags"}},
{args: "sub", want: []string{"sub1", "sub2"}},
{args: "sub1", want: []string{"sub1"}},
{args: "sub1 ", want: []string{"sub11", "sub12", "-h"}},
// Suggest all sub commands if prefix is not known.
{args: "x", want: []string{"flags", "sub1", "sub2", "args", "-h"}},
// Suggest flag value.
// A flag that has an empty completion should return empty completion. It "completes
// something"... But it doesn't know what, so we should not complete anything else.
{args: "flags -something ", want: []string{""}},
{args: "flags -something foo", want: []string{""}},
// A flag that have nil completion should complete all other options.
{args: "flags -nothing ", want: []string{"-values", "-nothing", "-something", "-cmd-flag", "-h"}},
// Trying to provide a value to the nothing flag should revert the phrase back to nothing.
{args: "flags -nothing=", want: []string{}},
// The flag value was not started, suggest all relevant values.
{args: "flags -values ", want: []string{"a", "a\\ a", "b"}},
{args: "flags -values a", want: []string{"a", "a\\ a"}},
{args: "flags -values a\\", want: []string{"a\\ a"}},
{args: "flags -values a\\ ", want: []string{"a\\ a"}},
{args: "flags -values a\\ a", want: []string{"a\\ a"}},
{args: "flags -values a\\ a ", want: []string{"-values", "-nothing", "-something", "-cmd-flag", "-h"}},
{args: "flags -values \"a", want: []string{"\"a\"", "\"a a\""}},
{args: "flags -values \"a ", want: []string{"\"a a\""}},
{args: "flags -values \"a a", want: []string{"\"a a\""}},
{args: "flags -values \"a a\"", want: []string{"\"a a\""}},
{args: "flags -values \"a a\" ", want: []string{"-values", "-nothing", "-something", "-cmd-flag", "-h"}},
{args: "flags -values=", want: []string{"a", "a\\ a", "b"}},
{args: "flags -values=a", want: []string{"a", "a\\ a"}},
{args: "flags -values=a\\", want: []string{"a\\ a"}},
{args: "flags -values=a\\ ", want: []string{"a\\ a"}},
{args: "flags -values=a\\ a", want: []string{"a\\ a"}},
{args: "flags -values=a\\ a ", want: []string{"-values", "-nothing", "-something", "-cmd-flag", "-h"}},
{args: "flags -values=\"a", want: []string{"\"a\"", "\"a a\""}},
{args: "flags -values=\"a ", want: []string{"\"a a\""}},
{args: "flags -values=\"a a", want: []string{"\"a a\""}},
{args: "flags -values=\"a a\"", want: []string{"\"a a\""}},
{args: "flags -values=\"a a\" ", want: []string{"-values", "-nothing", "-something", "-cmd-flag", "-h"}},
// Complete positional arguments
{args: "args ", want: []string{"-cmd-flag", "-h", "a", "a\\ a", "b"}},
{args: "args a", want: []string{"a", "a\\ a"}},
{args: "args a\\", want: []string{"a\\ a"}},
{args: "args a\\ ", want: []string{"a\\ a"}},
{args: "args a\\ a", want: []string{"a\\ a"}},
{args: "args a\\ a ", want: []string{"-cmd-flag", "-h", "a", "a\\ a", "b"}},
{args: "args \"a", want: []string{"\"a\"", "\"a a\""}},
{args: "args \"a ", want: []string{"\"a a\""}},
{args: "args \"a a", want: []string{"\"a a\""}},
{args: "args \"a a\"", want: []string{"\"a a\""}},
{args: "args \"a a\" ", want: []string{"-cmd-flag", "-h", "a", "a\\ a", "b"}},
// Complete positional arguments from a parent command
{args: "sub1 sub12 arg", want: []string{"arg1", "arg2"}},
// Test help
{args: "-", want: []string{"-h"}},
{args: " -", want: []string{"-h"}},
{args: "--", want: []string{"--help"}},
{args: "-he", want: []string{"-help"}},
{args: "-x", want: []string{"-help"}},
{args: "flags -h", want: []string{"-h"}},
}
for _, tt := range tests {
t.Run(tt.args, func(t *testing.T) {
Test(t, testCmd, tt.args, tt.want)
})
}
}
func TestCompleter_error(t *testing.T) {
t.Parallel()
tests := []struct {
args string
err string
}{
// Sub command already fully typed but unknown.
{args: "x ", err: "unknown subcommand: x"},
}
for _, tt := range tests {
t.Run(tt.args, func(t *testing.T) {
_, err := completer{Completer: testCmd, args: arg.Parse(tt.args)}.complete()
require.Error(t, err)
assert.Equal(t, tt.err, err.Error())
})
}
}
func TestComplete(t *testing.T) {
defer func() {
getEnv = os.Getenv
exit = os.Exit
out = os.Stdout
}()
tests := []struct {
line, point string
shouldExit bool
shouldPanic bool
install string
uninstall string
}{
{shouldExit: true, line: "cmd", point: "1"},
{shouldExit: false, line: "", point: ""},
{shouldPanic: true, line: "cmd", point: ""},
{shouldPanic: true, line: "cmd", point: "a"},
{shouldPanic: true, line: "cmd", point: "4"},
{shouldExit: true, install: "1"},
{shouldExit: false, install: "a"},
{shouldExit: true, uninstall: "1"},
{shouldExit: false, uninstall: "a"},
}
for _, tt := range tests {
t.Run(tt.line+"@"+tt.point, func(t *testing.T) {
getEnv = func(env string) string {
switch env {
case "COMP_LINE":
return tt.line
case "COMP_POINT":
return tt.point
case "COMP_INSTALL":
return tt.install
case "COMP_UNINSTALL":
return tt.uninstall
case "COMP_YES":
return "0"
default:
panic(env)
}
}
isExit := false
exit = func(int) {
isExit = true
}
out = ioutil.Discard
if tt.shouldPanic {
assert.Panics(t, func() { testCmd.Complete("") })
} else {
testCmd.Complete("")
assert.Equal(t, tt.shouldExit, isExit)
}
})
}
}
type set []string
func (s set) Predict(_ string) []string {
return s
}
func TestHasPrefix(t *testing.T) {
t.Parallel()
tests := []struct {
s string
prefix string
want string
wantOK bool
}{
{s: "ab", prefix: `b`, want: ``, wantOK: false},
{s: "", prefix: `b`, want: ``, wantOK: false},
{s: "ab", prefix: `a`, want: `ab`, wantOK: true},
{s: "ab", prefix: `"'b`, want: ``, wantOK: false},
{s: "ab", prefix: `"'a`, want: `"'ab'"`, wantOK: true},
{s: "ab", prefix: `'"a`, want: `'"ab"'`, wantOK: true},
}
for _, tt := range tests {
t.Run(tt.s+"/"+tt.prefix, func(t *testing.T) {
got, gotOK := hasPrefix(tt.s, tt.prefix)
assert.Equal(t, tt.want, got)
assert.Equal(t, tt.wantOK, gotOK)
})
}
}
|
