Merge branch 'rs/daemon-plug-child-leak'
[git] / t / t0040-parse-options.sh
1 #!/bin/sh
2 #
3 # Copyright (c) 2007 Johannes Schindelin
4 #
5
6 test_description='our own option parser'
7
8 . ./test-lib.sh
9
10 cat > expect << EOF
11 usage: test-parse-options <options>
12
13     --yes                 get a boolean
14     -D, --no-doubt        begins with 'no-'
15     -B, --no-fear         be brave
16     -b, --boolean         increment by one
17     -4, --or4             bitwise-or boolean with ...0100
18     --neg-or4             same as --no-or4
19
20     -i, --integer <n>     get a integer
21     -j <n>                get a integer, too
22     -m, --magnitude <n>   get a magnitude
23     --set23               set integer to 23
24     -t <time>             get timestamp of <time>
25     -L, --length <str>    get length of <str>
26     -F, --file <file>     set file to <file>
27
28 String options
29     -s, --string <string>
30                           get a string
31     --string2 <str>       get another string
32     --st <st>             get another string (pervert ordering)
33     -o <str>              get another string
34     --list <str>          add str to list
35
36 Magic arguments
37     --quux                means --quux
38     -NUM                  set integer to NUM
39     +                     same as -b
40     --ambiguous           positive ambiguity
41     --no-ambiguous        negative ambiguity
42
43 Standard options
44     --abbrev[=<n>]        use <n> digits to display SHA-1s
45     -v, --verbose         be verbose
46     -n, --dry-run         dry run
47     -q, --quiet           be quiet
48
49 EOF
50
51 test_expect_success 'test help' '
52         test_must_fail test-parse-options -h > output 2> output.err &&
53         test_must_be_empty output.err &&
54         test_i18ncmp expect output
55 '
56
57 mv expect expect.err
58
59 cat >expect.template <<EOF
60 boolean: 0
61 integer: 0
62 magnitude: 0
63 timestamp: 0
64 string: (not set)
65 abbrev: 7
66 verbose: 0
67 quiet: no
68 dry run: no
69 file: (not set)
70 EOF
71
72 check() {
73         what="$1" &&
74         shift &&
75         expect="$1" &&
76         shift &&
77         sed "s/^$what .*/$what $expect/" <expect.template >expect &&
78         test-parse-options $* >output 2>output.err &&
79         test_must_be_empty output.err &&
80         test_cmp expect output
81 }
82
83 check_i18n() {
84         what="$1" &&
85         shift &&
86         expect="$1" &&
87         shift &&
88         sed "s/^$what .*/$what $expect/" <expect.template >expect &&
89         test-parse-options $* >output 2>output.err &&
90         test_must_be_empty output.err &&
91         test_i18ncmp expect output
92 }
93
94 check_unknown() {
95         case "$1" in
96         --*)
97                 echo error: unknown option \`${1#--}\' >expect ;;
98         -*)
99                 echo error: unknown switch \`${1#-}\' >expect ;;
100         esac &&
101         cat expect.err >>expect &&
102         test_must_fail test-parse-options $* >output 2>output.err &&
103         test_must_be_empty output &&
104         test_cmp expect output.err
105 }
106
107 check_unknown_i18n() {
108         case "$1" in
109         --*)
110                 echo error: unknown option \`${1#--}\' >expect ;;
111         -*)
112                 echo error: unknown switch \`${1#-}\' >expect ;;
113         esac &&
114         cat expect.err >>expect &&
115         test_must_fail test-parse-options $* >output 2>output.err &&
116         test_must_be_empty output &&
117         test_i18ncmp expect output.err
118 }
119
120 test_expect_success 'OPT_BOOL() #1' 'check boolean: 1 --yes'
121 test_expect_success 'OPT_BOOL() #2' 'check boolean: 1 --no-doubt'
122 test_expect_success 'OPT_BOOL() #3' 'check boolean: 1 -D'
123 test_expect_success 'OPT_BOOL() #4' 'check boolean: 1 --no-fear'
124 test_expect_success 'OPT_BOOL() #5' 'check boolean: 1 -B'
125
126 test_expect_success 'OPT_BOOL() is idempotent #1' 'check boolean: 1 --yes --yes'
127 test_expect_success 'OPT_BOOL() is idempotent #2' 'check boolean: 1 -DB'
128
129 test_expect_success 'OPT_BOOL() negation #1' 'check boolean: 0 -D --no-yes'
130 test_expect_success 'OPT_BOOL() negation #2' 'check boolean: 0 -D --no-no-doubt'
131
132 test_expect_success 'OPT_BOOL() no negation #1' 'check_unknown_i18n --fear'
133 test_expect_success 'OPT_BOOL() no negation #2' 'check_unknown_i18n --no-no-fear'
134
135 test_expect_success 'OPT_BOOL() positivation' 'check boolean: 0 -D --doubt'
136
137 test_expect_success 'OPT_INT() negative' 'check integer: -2345 -i -2345'
138
139 test_expect_success 'OPT_MAGNITUDE() simple' '
140         check magnitude: 2345678 -m 2345678
141 '
142
143 test_expect_success 'OPT_MAGNITUDE() kilo' '
144         check magnitude: 239616 -m 234k
145 '
146
147 test_expect_success 'OPT_MAGNITUDE() mega' '
148         check magnitude: 104857600 -m 100m
149 '
150
151 test_expect_success 'OPT_MAGNITUDE() giga' '
152         check magnitude: 1073741824 -m 1g
153 '
154
155 test_expect_success 'OPT_MAGNITUDE() 3giga' '
156         check magnitude: 3221225472 -m 3g
157 '
158
159 cat > expect << EOF
160 boolean: 2
161 integer: 1729
162 magnitude: 16384
163 timestamp: 0
164 string: 123
165 abbrev: 7
166 verbose: 2
167 quiet: no
168 dry run: yes
169 file: prefix/my.file
170 EOF
171
172 test_expect_success 'short options' '
173         test-parse-options -s123 -b -i 1729 -m 16k -b -vv -n -F my.file \
174         >output 2>output.err &&
175         test_cmp expect output &&
176         test_must_be_empty output.err
177 '
178
179 cat > expect << EOF
180 boolean: 2
181 integer: 1729
182 magnitude: 16384
183 timestamp: 0
184 string: 321
185 abbrev: 10
186 verbose: 2
187 quiet: no
188 dry run: no
189 file: prefix/fi.le
190 EOF
191
192 test_expect_success 'long options' '
193         test-parse-options --boolean --integer 1729 --magnitude 16k \
194                 --boolean --string2=321 --verbose --verbose --no-dry-run \
195                 --abbrev=10 --file fi.le --obsolete \
196                 >output 2>output.err &&
197         test_must_be_empty output.err &&
198         test_cmp expect output
199 '
200
201 test_expect_success 'missing required value' '
202         test_expect_code 129 test-parse-options -s &&
203         test_expect_code 129 test-parse-options --string &&
204         test_expect_code 129 test-parse-options --file
205 '
206
207 cat > expect << EOF
208 boolean: 1
209 integer: 13
210 magnitude: 0
211 timestamp: 0
212 string: 123
213 abbrev: 7
214 verbose: 0
215 quiet: no
216 dry run: no
217 file: (not set)
218 arg 00: a1
219 arg 01: b1
220 arg 02: --boolean
221 EOF
222
223 test_expect_success 'intermingled arguments' '
224         test-parse-options a1 --string 123 b1 --boolean -j 13 -- --boolean \
225                 > output 2> output.err &&
226         test_must_be_empty output.err &&
227         test_cmp expect output
228 '
229
230 cat > expect << EOF
231 boolean: 0
232 integer: 2
233 magnitude: 0
234 timestamp: 0
235 string: (not set)
236 abbrev: 7
237 verbose: 0
238 quiet: no
239 dry run: no
240 file: (not set)
241 EOF
242
243 test_expect_success 'unambiguously abbreviated option' '
244         test-parse-options --int 2 --boolean --no-bo > output 2> output.err &&
245         test_must_be_empty output.err &&
246         test_cmp expect output
247 '
248
249 test_expect_success 'unambiguously abbreviated option with "="' '
250         test-parse-options --int=2 > output 2> output.err &&
251         test_must_be_empty output.err &&
252         test_cmp expect output
253 '
254
255 test_expect_success 'ambiguously abbreviated option' '
256         test_expect_code 129 test-parse-options --strin 123
257 '
258
259 cat > expect << EOF
260 boolean: 0
261 integer: 0
262 magnitude: 0
263 timestamp: 0
264 string: 123
265 abbrev: 7
266 verbose: 0
267 quiet: no
268 dry run: no
269 file: (not set)
270 EOF
271
272 test_expect_success 'non ambiguous option (after two options it abbreviates)' '
273         test-parse-options --st 123 > output 2> output.err &&
274         test_must_be_empty output.err &&
275         test_cmp expect output
276 '
277
278 cat > typo.err << EOF
279 error: did you mean \`--boolean\` (with two dashes ?)
280 EOF
281
282 test_expect_success 'detect possible typos' '
283         test_must_fail test-parse-options -boolean > output 2> output.err &&
284         test_must_be_empty output &&
285         test_cmp typo.err output.err
286 '
287
288 cat > typo.err << EOF
289 error: did you mean \`--ambiguous\` (with two dashes ?)
290 EOF
291
292 test_expect_success 'detect possible typos' '
293         test_must_fail test-parse-options -ambiguous > output 2> output.err &&
294         test_must_be_empty output &&
295         test_cmp typo.err output.err
296 '
297
298 cat > expect <<EOF
299 boolean: 0
300 integer: 0
301 magnitude: 0
302 timestamp: 0
303 string: (not set)
304 abbrev: 7
305 verbose: 0
306 quiet: no
307 dry run: no
308 file: (not set)
309 arg 00: --quux
310 EOF
311
312 test_expect_success 'keep some options as arguments' '
313         test-parse-options --quux > output 2> output.err &&
314         test_must_be_empty output.err &&
315         test_cmp expect output
316 '
317
318 cat > expect <<EOF
319 boolean: 0
320 integer: 0
321 magnitude: 0
322 timestamp: 1
323 string: (not set)
324 abbrev: 7
325 verbose: 0
326 quiet: yes
327 dry run: no
328 file: (not set)
329 arg 00: foo
330 EOF
331
332 test_expect_success 'OPT_DATE() works' '
333         test-parse-options -t "1970-01-01 00:00:01 +0000" \
334                 foo -q > output 2> output.err &&
335         test_must_be_empty output.err &&
336         test_cmp expect output
337 '
338
339 cat > expect <<EOF
340 Callback: "four", 0
341 boolean: 5
342 integer: 4
343 magnitude: 0
344 timestamp: 0
345 string: (not set)
346 abbrev: 7
347 verbose: 0
348 quiet: no
349 dry run: no
350 file: (not set)
351 EOF
352
353 test_expect_success 'OPT_CALLBACK() and OPT_BIT() work' '
354         test-parse-options --length=four -b -4 > output 2> output.err &&
355         test_must_be_empty output.err &&
356         test_cmp expect output
357 '
358
359 cat > expect <<EOF
360 Callback: "not set", 1
361 EOF
362
363 test_expect_success 'OPT_CALLBACK() and callback errors work' '
364         test_must_fail test-parse-options --no-length > output 2> output.err &&
365         test_i18ncmp expect output &&
366         test_i18ncmp expect.err output.err
367 '
368
369 cat > expect <<EOF
370 boolean: 1
371 integer: 23
372 magnitude: 0
373 timestamp: 0
374 string: (not set)
375 abbrev: 7
376 verbose: 0
377 quiet: no
378 dry run: no
379 file: (not set)
380 EOF
381
382 test_expect_success 'OPT_BIT() and OPT_SET_INT() work' '
383         test-parse-options --set23 -bbbbb --no-or4 > output 2> output.err &&
384         test_must_be_empty output.err &&
385         test_cmp expect output
386 '
387
388 test_expect_success 'OPT_NEGBIT() and OPT_SET_INT() work' '
389         test-parse-options --set23 -bbbbb --neg-or4 > output 2> output.err &&
390         test_must_be_empty output.err &&
391         test_cmp expect output
392 '
393
394 cat > expect <<EOF
395 boolean: 6
396 integer: 0
397 magnitude: 0
398 timestamp: 0
399 string: (not set)
400 abbrev: 7
401 verbose: 0
402 quiet: no
403 dry run: no
404 file: (not set)
405 EOF
406
407 test_expect_success 'OPT_BIT() works' '
408         test-parse-options -bb --or4 > output 2> output.err &&
409         test_must_be_empty output.err &&
410         test_cmp expect output
411 '
412
413 test_expect_success 'OPT_NEGBIT() works' '
414         test-parse-options -bb --no-neg-or4 > output 2> output.err &&
415         test_must_be_empty output.err &&
416         test_cmp expect output
417 '
418
419 test_expect_success 'OPT_COUNTUP() with PARSE_OPT_NODASH works' '
420         test-parse-options + + + + + + > output 2> output.err &&
421         test_must_be_empty output.err &&
422         test_cmp expect output
423 '
424
425 cat > expect <<EOF
426 boolean: 0
427 integer: 12345
428 magnitude: 0
429 timestamp: 0
430 string: (not set)
431 abbrev: 7
432 verbose: 0
433 quiet: no
434 dry run: no
435 file: (not set)
436 EOF
437
438 test_expect_success 'OPT_NUMBER_CALLBACK() works' '
439         test-parse-options -12345 > output 2> output.err &&
440         test_must_be_empty output.err &&
441         test_cmp expect output
442 '
443
444 cat >expect <<EOF
445 boolean: 0
446 integer: 0
447 magnitude: 0
448 timestamp: 0
449 string: (not set)
450 abbrev: 7
451 verbose: 0
452 quiet: no
453 dry run: no
454 file: (not set)
455 EOF
456
457 test_expect_success 'negation of OPT_NONEG flags is not ambiguous' '
458         test-parse-options --no-ambig >output 2>output.err &&
459         test_must_be_empty output.err &&
460         test_cmp expect output
461 '
462
463 cat >>expect <<'EOF'
464 list: foo
465 list: bar
466 list: baz
467 EOF
468 test_expect_success '--list keeps list of strings' '
469         test-parse-options --list foo --list=bar --list=baz >output &&
470         test_cmp expect output
471 '
472
473 test_expect_success '--no-list resets list' '
474         test-parse-options --list=other --list=irrelevant --list=options \
475                 --no-list --list=foo --list=bar --list=baz >output &&
476         test_cmp expect output
477 '
478
479 test_done