Repository navigation
Expand file tree
/
Copy pathcomplete_test.go
More file actions
217 lines (201 loc) · 5.38 KB
/
Copy pathcomplete_test.go
File metadata and controls
217 lines (201 loc) · 5.38 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
package cli
import (
"bufio"
"os"
"sort"
"strconv"
"strings"
"testing"
"github.com/posener/complete"
)
// newCompletionTestApp builds an app exercising every completion path:
// commands with aliases (including a hidden top-level alias and a hidden
// nested alias), a hidden command, a subcommand tree (with a hidden child),
// a leaf command carrying an arg predictor, a command with a visible and a
// hidden flag-value predictor, a value flag with no predictor at all, and
// app-level (root-only) and global (inherited) flags, each with a visible and
// a hidden one. Help/version are
// hidden to keep predictions clean.
func newCompletionTestApp() *App {
app := NewApp()
app.Name = "prog"
app.HideHelp = true
app.HideHelpCommand = true
app.HideVersion = true
app.EnableBashCompletion = true
app.Flags = []Flag{
StringFlag{Name: "verbosity", Completer: complete.PredictSet("debug", "info")},
StringFlag{Name: "secret-app-flag", Hidden: true},
}
app.GlobalFlags = []Flag{
StringFlag{Name: "profile", Completer: complete.PredictSet("dev", "prod")},
StringFlag{Name: "secret-global-flag", Hidden: true},
}
app.Commands = []Command{
{
Name: "widget",
Aliases: []string{"w"},
// size takes a value but has no Completer. Its value must be left
// to the user, not filled in with widget's subcommand names.
Flags: []Flag{StringFlag{Name: "size"}},
Subcommands: Commands{
// mk is a hidden alias of make: exercises the nested
// HiddenAliases path alongside the top-level one on pick.
{Name: "make", Aliases: []string{"mk"}, HiddenAliases: true},
{Name: "list"},
{Name: "internal", Hidden: true},
},
},
{
Name: "pick",
Aliases: []string{"pk"},
HiddenAliases: true,
Completer: complete.PredictSet("alpha", "beta"),
},
{
Name: "paint",
Flags: []Flag{
StringFlag{Name: "color", Completer: complete.PredictSet("green", "red")},
StringFlag{Name: "secret-color-flag", Hidden: true},
},
},
{
Name: "secret",
Hidden: true,
},
}
return app
}
func TestShellCompletion(t *testing.T) {
app := newCompletionTestApp()
cases := []struct {
name string
line string
want []string
}{
{
name: "top-level command names, hidden excluded, aliases included, hidden alias excluded",
line: "prog ",
want: []string{"paint", "pick", "w", "widget"},
},
{
name: "subcommand recursion, hidden child excluded, hidden nested alias excluded",
line: "prog widget ",
want: []string{"list", "make"},
},
{
name: "alias resolves to same subcommands",
line: "prog w ",
want: []string{"list", "make"},
},
{
name: "arg predictor on leaf command",
line: "prog pick ",
want: []string{"alpha", "beta"},
},
{
name: "arg predictor honors prefix",
line: "prog pick a",
want: []string{"alpha"},
},
{
name: "app-level flag name completion at root, hidden app flag excluded",
line: "prog -",
want: []string{"--profile", "--verbosity"},
},
{
name: "app-level flag value prediction at root",
line: "prog --verbosity ",
want: []string{"debug", "info"},
},
{
name: "app-level flags are not inherited by commands, unlike global flags",
line: "prog paint -",
want: []string{"--color", "--profile"},
},
{
name: "flag value prediction",
line: "prog paint --color ",
want: []string{"green", "red"},
},
{
name: "value flag without a Completer predicts nothing, not subcommand names",
line: "prog widget --size ",
want: nil,
},
{
name: "global flag value predicted inside a child command",
line: "prog widget --profile ",
want: []string{"dev", "prod"},
},
}
for _, tc := range cases {
t.Run(tc.name, func(t *testing.T) {
got := completeLine(t, app, tc.line)
if !eqStrings(got, tc.want) {
t.Errorf("line %q: got %v, want %v", tc.line, got, tc.want)
}
})
}
}
// TestShellCompletionDisabled verifies that without EnableBashCompletion the
// COMP_LINE path is not taken.
func TestShellCompletionDisabled(t *testing.T) {
app := newCompletionTestApp()
app.EnableBashCompletion = false
// No-op action so the normal (non-completion) path produces no output.
app.Action = func(*Context) error { return nil }
got := completeLine(t, app, "prog ")
if len(got) != 0 {
t.Errorf("expected no completion output when disabled, got %v", got)
}
}
// completeLine drives a single COMP_LINE completion request through app.Run and
// returns the predicted options, sorted, capturing what posener writes to
// stdout.
func completeLine(t *testing.T, app *App, line string) []string {
t.Helper()
if err := os.Setenv("COMP_LINE", line); err != nil {
t.Fatal(err)
}
if err := os.Setenv("COMP_POINT", strconv.Itoa(len(line))); err != nil {
t.Fatal(err)
}
defer os.Unsetenv("COMP_LINE")
defer os.Unsetenv("COMP_POINT")
old := os.Stdout
r, w, err := os.Pipe()
if err != nil {
t.Fatal(err)
}
os.Stdout = w
runErr := app.Run([]string{"prog"})
w.Close()
os.Stdout = old
if runErr != nil {
t.Fatalf("Run returned error during completion: %v", runErr)
}
var out []string
sc := bufio.NewScanner(r)
for sc.Scan() {
if s := strings.TrimSpace(sc.Text()); s != "" {
out = append(out, s)
}
}
if err := sc.Err(); err != nil {
t.Fatal(err)
}
sort.Strings(out)
return out
}
func eqStrings(a, b []string) bool {
if len(a) != len(b) {
return false
}
for i := range a {
if a[i] != b[i] {
return false
}
}
return true
}