/
usage_and_help_test.go
295 lines (238 loc) · 11.1 KB
/
usage_and_help_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
// Copyright (c) 2011, SoundCloud Ltd., Daniel Bornkessel
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
// Source code and contact info at http://github.com/kesselborn/go-getopt
package getopt
import (
"os"
"strings"
"syscall"
"testing"
)
func TestUsage(t *testing.T) {
options := Options{
"",
Definitions{
{"debug|d|DEBUG", "debug mode", Flag, true},
{"ports|p|PORTS", "Ports", Optional | ExampleIsDefault, []int64{3000, 3001, 3002}},
{"files", "files that should be read in", IsArg, nil},
{"secondaryports|s|SECONDARY_PORTS", "secondary ports", Optional | ExampleIsDefault, []int{5000, 5001, 5002}},
{"instances||INSTANCES", "Instances", Required, 4},
{"lock||LOCK", "create lock file", Flag, false},
{"logfile||LOGFILE", "logfile", Optional | ExampleIsDefault, "/var/log/foo.log"},
{"directories", "directories", IsArg | Optional, nil},
{"command", "command", IsPassThrough | Required, nil},
{"args", "command's args", IsPassThrough | Optional, nil},
},
}
os.Args = []string{"prog"}
expected := `Usage: prog -d [-p <ports>] <files> [-s <secondaryports>] --instances=<instances> --lock [--logfile=<logfile>] [<directories>] -- <command> [<args>]
`
if got := options.Usage(); got != expected {
t.Errorf("Usage output not as expected:\ngot: |" + strings.Replace(got, " ", "_", -1) + "|\nexpected: |" + strings.Replace(expected, " ", "_", -1) + "|\n")
}
}
func TestUsageWithDifferentProgname(t *testing.T) {
options := Options{
"",
Definitions{
{"debug|d|DEBUG", "debug mode", Flag, true},
{"ports|p|PORTS", "Ports", Optional | ExampleIsDefault, []int64{3000, 3001, 3002}},
{"files", "files that should be read in", IsArg, nil},
{"secondaryports|s|SECONDARY_PORTS", "secondary ports", Optional | ExampleIsDefault, []int{5000, 5001, 5002}},
{"instances||INSTANCES", "Instances", Required, 4},
{"lock||LOCK", "create lock file", Flag, false},
{"logfile||LOGFILE", "logfile", Optional | ExampleIsDefault, "/var/log/foo.log"},
{"directories", "directories", IsArg | Optional, nil},
{"command", "command", IsPassThrough | Required, nil},
{"args", "command's args", IsPassThrough | Optional, nil},
},
}
os.Args = []string{"prog"}
expected := `Usage: otherprogname -d [-p <ports>] <files> [-s <secondaryports>] --instances=<instances> --lock [--logfile=<logfile>] [<directories>] -- <command> [<args>]
`
if got := options.UsageCustomArg0("otherprogname"); got != expected {
t.Errorf("Usage output not as expected:\ngot: |" + strings.Replace(got, " ", "_", -1) + "|\nexpected: |" + strings.Replace(expected, " ", "_", -1) + "|\n")
}
}
func TestHelpWithDifferentProgname(t *testing.T) {
options := Options{
"this is not a program",
Definitions{
{"debug|d|DEBUG", "debug mode", Flag, true},
{"ports|p|PORTS", "Ports", Optional | ExampleIsDefault, []int64{3000, 3001, 3002}},
{"files", "Files that should be read in", IsArg, nil},
{"secondaryports|s", "Secondary ports", Optional | ExampleIsDefault, []int{5000, 5001, 5002}},
{"instances", "Instances", Required, 4},
{"lock||LOCK", "create lock file", Flag, false},
{"logfile||LOGFILE", "Logfile", Optional | ExampleIsDefault, "/var/log/foo.log"},
{"directories", "Directories", IsArg | Optional, nil},
{"pass through args", "arguments for subcommand", IsPassThrough, nil},
},
}
os.Args = []string{"prog"}
expected := `Usage: otherprogname -d [-p <ports>] <files> [-s <secondaryports>] --instances=<instances> --lock [--logfile=<logfile>] [<directories>] -- <pass through args>
this is not a program
Options:
-d, --debug debug mode; setable via $DEBUG
-p, --ports=<ports> Ports (default: 3000,3001,3002); setable via $PORTS
-s, --secondaryports=<secondaryports> Secondary ports (default: 5000,5001,5002)
--instances=<instances> Instances (e.g. 4)
--lock create lock file; setable via $LOCK
--logfile=<logfile> Logfile (default: /var/log/foo.log); setable via $LOGFILE
-h, --help usage (-h) / detailed help text (--help)
Arguments:
<files> Files that should be read in
<directories> Directories
Pass through arguments:
<pass through args> arguments for subcommand
`
if got := options.HelpCustomArg0("otherprogname"); got != expected {
t.Errorf("Usage output not as expected:\ngot: |" + strings.Replace(got, " ", "_", -1) + "|\nexpected: |" + strings.Replace(expected, " ", "_", -1) + "|\n")
}
}
func TestHelp(t *testing.T) {
options := Options{
"this is not a program",
Definitions{
{"debug|d|DEBUG", "debug mode", Flag, true},
{"ports|p|PORTS", "Ports", Optional | ExampleIsDefault, []int64{3000, 3001, 3002}},
{"files", "Files that should be read in", IsArg, nil},
{"secondaryports|s", "Secondary ports", Optional | ExampleIsDefault, []int{5000, 5001, 5002}},
{"instances", "Instances", Required, 4},
{"lock||LOCK", "create lock file", Flag, false},
{"logfile||LOGFILE", "Logfile", Optional | ExampleIsDefault, "/var/log/foo.log"},
{"directories", "Directories", IsArg | Optional, nil},
{"pass through args", "arguments for subcommand", IsPassThrough, nil},
},
}
os.Args = []string{"prog"}
expected := `Usage: prog -d [-p <ports>] <files> [-s <secondaryports>] --instances=<instances> --lock [--logfile=<logfile>] [<directories>] -- <pass through args>
this is not a program
Options:
-d, --debug debug mode; setable via $DEBUG
-p, --ports=<ports> Ports (default: 3000,3001,3002); setable via $PORTS
-s, --secondaryports=<secondaryports> Secondary ports (default: 5000,5001,5002)
--instances=<instances> Instances (e.g. 4)
--lock create lock file; setable via $LOCK
--logfile=<logfile> Logfile (default: /var/log/foo.log); setable via $LOGFILE
-h, --help usage (-h) / detailed help text (--help)
Arguments:
<files> Files that should be read in
<directories> Directories
Pass through arguments:
<pass through args> arguments for subcommand
`
if got := options.Help(); got != expected {
t.Errorf("Usage output not as expected:\ngot: |" + strings.Replace(got, " ", "_", -1) + "|\nexpected: |" + strings.Replace(expected, " ", "_", -1) + "|\n")
}
}
func TestHelpNoOptions(t *testing.T) {
options := Options{
"this is not a program",
Definitions{
{"files", "Files that should be read in", IsArg, nil},
{"directories", "Directories", IsArg | Optional, nil},
},
}
os.Args = []string{"prog"}
expected := `Usage: prog <files> [<directories>]
this is not a program
Arguments:
<files> Files that should be read in
<directories> Directories
`
if got := options.Help(); got != expected {
t.Errorf("Usage output not as expected:\ngot: |" + strings.Replace(got, " ", "_", -1) + "|\nexpected: |" + strings.Replace(expected, " ", "_", -1) + "|\n")
}
}
func TestHelpNoArgs(t *testing.T) {
options := Options{
"this is not a program",
Definitions{
{"debug|d|DEBUG", "debug mode", Flag, true},
{"ports|p|PORTS", "Ports", Optional | ExampleIsDefault, []int64{3000, 3001, 3002}},
{"secondaryports|s", "Secondary ports", Optional | ExampleIsDefault, []int{5000, 5001, 5002}},
{"instances", "Instances", Required, 4},
{"lock||LOCK", "create lock file", Flag, false},
{"logfile||LOGFILE", "Logfile", Optional | ExampleIsDefault, "/var/log/foo.log"},
},
}
os.Args = []string{"prog"}
expected := `Usage: prog -d [-p <ports>] [-s <secondaryports>] --instances=<instances> --lock [--logfile=<logfile>]
this is not a program
Options:
-d, --debug debug mode; setable via $DEBUG
-p, --ports=<ports> Ports (default: 3000,3001,3002); setable via $PORTS
-s, --secondaryports=<secondaryports> Secondary ports (default: 5000,5001,5002)
--instances=<instances> Instances (e.g. 4)
--lock create lock file; setable via $LOCK
--logfile=<logfile> Logfile (default: /var/log/foo.log); setable via $LOGFILE
-h, --help usage (-h) / detailed help text (--help)
`
if got := options.Help(); got != expected {
t.Errorf("Usage output not as expected:\ngot: |" + strings.Replace(got, " ", "_", -1) + "|\nexpected: |" + strings.Replace(expected, " ", "_", -1) + "|\n")
}
}
func TestUsageAndHelpOption(t *testing.T) {
options := Options{
"",
Definitions{
{"debug|d|DEBUG", "debug mode", Flag, true},
{"ports|p|PORTS", "Ports", Optional | ExampleIsDefault, []int64{3000, 3001, 3002}},
},
}
os.Args = []string{"prog", "barbaz", "-d", "-h", "-p5000,6000", "foobar"}
syscall.Clearenv()
parsedOptions, _, _, _ := options.ParseCommandLine()
if helpOption, present := parsedOptions["help"]; !present || helpOption.String != "usage" {
t.Errorf("usage call did not set usage option correctly")
}
os.Args = []string{"prog", "barbaz", "-d", "--help", "-p5000,6000", "foobar"}
syscall.Clearenv()
parsedOptions, _, _, _ = options.ParseCommandLine()
if helpOption, present := parsedOptions["help"]; !present || helpOption.String != "help" {
t.Errorf("help call did not set help option correclty")
}
}
func TestUsageAndHelpOptionInPassThrough(t *testing.T) {
options := Options{
"",
Definitions{
{"debug|d|DEBUG", "debug mode", Flag, true},
{"ports|p|PORTS", "Ports", Optional | ExampleIsDefault, []int64{3000, 3001, 3002}},
},
}
os.Args = []string{"prog", "barbaz", "--", "-h"}
syscall.Clearenv()
if _, _, _, err := options.ParseCommandLine(); err != nil {
t.Errorf("usage option in pass through triggered WantsUsage")
}
os.Args = []string{"prog", "barbaz", "--", "--help"}
syscall.Clearenv()
if _, _, _, err := options.ParseCommandLine(); err != nil {
t.Errorf("help option in pass through triggered WantsUsage")
}
}
func TestUsageAndHelpOptionWithOwnIdentifiers(t *testing.T) {
options := Options{
"",
Definitions{
{"chelp|c", "show usage / help", Usage | Help, nil},
{"debug|d|DEBUG", "debug mode", Flag, true},
{"ports|p|PORTS", "Ports", Optional | ExampleIsDefault, []int64{3000, 3001, 3002}},
},
}
os.Args = []string{"prog", "barbaz", "-d", "-c", "-p5000,6000", "foobar"}
syscall.Clearenv()
parsedOptions, _, _, _ := options.ParseCommandLine()
if helpOption, present := parsedOptions["chelp"]; !present || helpOption.String != "usage" {
t.Errorf("usage call did not set usage option with custom '-c' for usage")
}
os.Args = []string{"prog", "barbaz", "-d", "--chelp", "-p5000,6000", "foobar"}
syscall.Clearenv()
parsedOptions, _, _, _ = options.ParseCommandLine()
if helpOption, present := parsedOptions["chelp"]; !present || helpOption.String != "help" {
t.Errorf("help call did not set help option correctly with custom '--chelp' for usage")
}
}