3 # Copyright (c) 2007 Johannes Schindelin
6 test_description
='our own option parser'
8 TEST_PASSES_SANITIZE_LEAK
=true
12 usage
: test-tool parse-options
<options
>
14 A helper
function for the parse-options API.
16 --[no-
]yes get a boolean
17 -D, --no-doubt begins with
'no-'
18 --doubt opposite of
--no-doubt
19 -B, --no-fear be brave
20 -b, --[no-
]boolean increment by one
21 -4, --[no-
]or4 bitwise-or boolean with ..
.0100
22 --[no-
]neg-or4 same as
--no-or4
24 -i, --[no-
]integer
<n
>
26 -j <n
> get a integer
, too
27 -m, --magnitude <n
> get a magnitude
28 --[no-
]set23
set integer to
23
29 --mode1 set integer to
1 (cmdmode option
)
30 --mode2 set integer to
2 (cmdmode option
)
31 --[no-
]mode34
(3|
4) set integer to
3 or
4 (cmdmode option
)
32 -L, --[no-
]length
<str
>
34 -F, --[no-
]file <file>
38 -s, --[no-
]string
<string
>
40 --[no-
]string2
<str
> get another string
41 --[no-
]st
<st
> get another string
(pervert ordering
)
42 -o <str
> get another string
43 --longhelp help text of this entry
45 --[no-
]list
<str
> add str to list
48 -NUM set integer to NUM
50 --ambiguous positive ambiguity
51 --no-ambiguous negative ambiguity
54 --[no-
]abbrev
[=<n
>] use
<n
> digits to display object names
55 -v, --[no-
]verbose be verbose
56 -n, --[no-
]dry-run dry run
57 -q, --[no-
]quiet be quiet
58 --[no-
]expect
<string
>
59 expected output
in the variable dump
62 -A, --[no-
]alias-source
<string
>
64 -Z, --[no-
]alias-target
<string
>
65 alias of
--alias-source
69 test_expect_success
'test help' '
70 test_must_fail test-tool parse-options -h >output 2>output.err &&
71 test_must_be_empty output.err &&
72 test_cmp expect output
82 test-tool parse-options
--expect="$what $expect" "$@"
85 check_unknown_i18n
() {
88 echo error
: unknown option \
`${1#--}\' >expect ;;
90 echo error: unknown switch \`${1#-}\' >expect
;;
92 cat expect.err
>>expect
&&
93 test_must_fail test-tool parse-options $
* >output
2>output.err
&&
94 test_must_be_empty output
&&
95 test_cmp expect output.err
98 test_expect_success
'OPT_BOOL() #1' 'check boolean: 1 --yes'
99 test_expect_success
'OPT_BOOL() #2' 'check boolean: 1 --no-doubt'
100 test_expect_success
'OPT_BOOL() #3' 'check boolean: 1 -D'
101 test_expect_success
'OPT_BOOL() #4' 'check boolean: 1 --no-fear'
102 test_expect_success
'OPT_BOOL() #5' 'check boolean: 1 -B'
104 test_expect_success
'OPT_BOOL() is idempotent #1' 'check boolean: 1 --yes --yes'
105 test_expect_success
'OPT_BOOL() is idempotent #2' 'check boolean: 1 -DB'
107 test_expect_success
'OPT_BOOL() negation #1' 'check boolean: 0 -D --no-yes'
108 test_expect_success
'OPT_BOOL() negation #2' 'check boolean: 0 -D --no-no-doubt'
110 test_expect_success
'OPT_BOOL() no negation #1' 'check_unknown_i18n --fear'
111 test_expect_success
'OPT_BOOL() no negation #2' 'check_unknown_i18n --no-no-fear'
113 test_expect_success
'OPT_BOOL() positivation' 'check boolean: 0 -D --doubt'
115 test_expect_success
'OPT_INT() negative' 'check integer: -2345 -i -2345'
117 test_expect_success
'OPT_MAGNITUDE() simple' '
118 check magnitude: 2345678 -m 2345678
121 test_expect_success
'OPT_MAGNITUDE() kilo' '
122 check magnitude: 239616 -m 234k
125 test_expect_success
'OPT_MAGNITUDE() mega' '
126 check magnitude: 104857600 -m 100m
129 test_expect_success
'OPT_MAGNITUDE() giga' '
130 check magnitude: 1073741824 -m 1g
133 test_expect_success
'OPT_MAGNITUDE() 3giga' '
134 check magnitude: 3221225472 -m 3g
150 test_expect_success
'short options' '
151 test-tool parse-options -s123 -b -i 1729 -m 16k -b -vv -n -F my.file \
152 >output 2>output.err &&
153 test_cmp expect output &&
154 test_must_be_empty output.err
170 test_expect_success
'long options' '
171 test-tool parse-options --boolean --integer 1729 --magnitude 16k \
172 --boolean --string2=321 --verbose --verbose --no-dry-run \
173 --abbrev=10 --file fi.le --obsolete \
174 >output 2>output.err &&
175 test_must_be_empty output.err &&
176 test_cmp expect output
179 test_expect_success
'missing required value' '
180 cat >expect <<-\EOF &&
181 error: switch `s'\'' requires a value
183 test_expect_code 129 test-tool parse-options -s 2>actual &&
184 test_cmp expect actual &&
186 cat >expect <<-\EOF &&
187 error: option `string'\'' requires a value
189 test_expect_code 129 test-tool parse-options --string 2>actual &&
190 test_cmp expect actual &&
192 cat >expect <<-\EOF &&
193 error: option `file'\'' requires a value
195 test_expect_code 129 test-tool parse-options --file 2>actual &&
196 test_cmp expect actual
199 test_expect_success
'superfluous value provided: boolean' '
200 cat >expect <<-\EOF &&
201 error: option `yes'\'' takes no value
203 test_expect_code 129 test-tool parse-options --yes=hi 2>actual &&
204 test_cmp expect actual &&
206 cat >expect <<-\EOF &&
207 error: option `no-yes'\'' takes no value
209 test_expect_code 129 test-tool parse-options --no-yes=hi 2>actual &&
210 test_cmp expect actual
213 test_expect_success
'superfluous value provided: boolean, abbreviated' '
214 cat >expect <<-\EOF &&
215 error: option `yes'\'' takes no value
217 test_expect_code 129 env GIT_TEST_DISALLOW_ABBREVIATED_OPTIONS=false \
218 test-tool parse-options --ye=hi 2>actual &&
219 test_cmp expect actual &&
221 cat >expect <<-\EOF &&
222 error: option `no-yes'\'' takes no value
224 test_expect_code 129 env GIT_TEST_DISALLOW_ABBREVIATED_OPTIONS=false \
225 test-tool parse-options --no-ye=hi 2>actual &&
226 test_cmp expect actual
229 test_expect_success
'superfluous value provided: cmdmode' '
230 cat >expect <<-\EOF &&
231 error: option `mode1'\'' takes no value
233 test_expect_code 129 test-tool parse-options --mode1=hi 2>actual &&
234 test_cmp expect actual
253 test_expect_success
'intermingled arguments' '
254 test-tool parse-options a1 --string 123 b1 --boolean -j 13 -- --boolean \
255 >output 2>output.err &&
256 test_must_be_empty output.err &&
257 test_cmp expect output
273 test_expect_success
'unambiguously abbreviated option' '
274 GIT_TEST_DISALLOW_ABBREVIATED_OPTIONS=false \
275 test-tool parse-options --int 2 --boolean --no-bo >output 2>output.err &&
276 test_must_be_empty output.err &&
277 test_cmp expect output
280 test_expect_success
'unambiguously abbreviated option with "="' '
281 GIT_TEST_DISALLOW_ABBREVIATED_OPTIONS=false \
282 test-tool parse-options --expect="integer: 2" --int=2
285 test_expect_success
'ambiguously abbreviated option' '
286 test_expect_code 129 env GIT_TEST_DISALLOW_ABBREVIATED_OPTIONS=false \
287 test-tool parse-options --strin 123
290 test_expect_success
'non ambiguous option (after two options it abbreviates)' '
291 GIT_TEST_DISALLOW_ABBREVIATED_OPTIONS=false \
292 test-tool parse-options --expect="string: 123" --st 123
295 test_expect_success
'Alias options do not contribute to abbreviation' '
296 test-tool parse-options --alias-source 123 >output &&
297 grep "^string: 123" output &&
298 test-tool parse-options --alias-target 123 >output &&
299 grep "^string: 123" output &&
300 test_must_fail test-tool parse-options --alias &&
301 GIT_TEST_DISALLOW_ABBREVIATED_OPTIONS=false \
302 test-tool parse-options --alias 123 >output &&
303 grep "^string: 123" output
307 error
: did you mean
`--boolean` (with two dashes
)?
310 test_expect_success
'detect possible typos' '
311 test_must_fail test-tool parse-options -boolean >output 2>output.err &&
312 test_must_be_empty output &&
313 test_cmp typo.err output.err
317 error
: did you mean
`--ambiguous` (with two dashes
)?
320 test_expect_success
'detect possible typos' '
321 test_must_fail test-tool parse-options -ambiguous >output 2>output.err &&
322 test_must_be_empty output &&
323 test_cmp typo.err output.err
340 test_expect_success
'OPT_CALLBACK() and OPT_BIT() work' '
341 test-tool parse-options --length=four -b -4 >output 2>output.err &&
342 test_must_be_empty output.err &&
343 test_cmp expect output
346 test_expect_success
'OPT_CALLBACK() and callback errors work' '
347 test_must_fail test-tool parse-options --no-length >output 2>output.err &&
348 test_must_be_empty output &&
349 test_must_be_empty output.err
365 test_expect_success
'OPT_BIT() and OPT_SET_INT() work' '
366 test-tool parse-options --set23 -bbbbb --no-or4 >output 2>output.err &&
367 test_must_be_empty output.err &&
368 test_cmp expect output
371 test_expect_success
'OPT_NEGBIT() and OPT_SET_INT() work' '
372 test-tool parse-options --set23 -bbbbb --neg-or4 >output 2>output.err &&
373 test_must_be_empty output.err &&
374 test_cmp expect output
377 test_expect_success
'OPT_BIT() works' '
378 test-tool parse-options --expect="boolean: 6" -bb --or4
381 test_expect_success
'OPT_NEGBIT() works' '
382 test-tool parse-options --expect="boolean: 6" -bb --no-neg-or4
385 test_expect_success
'OPT_CMDMODE() works' '
386 test-tool parse-options --expect="integer: 1" --mode1 &&
387 test-tool parse-options --expect="integer: 3" --mode34=3
390 test_expect_success
'OPT_CMDMODE() detects incompatibility (1)' '
391 test_must_fail test-tool parse-options --mode1 --mode2 >output 2>output.err &&
392 test_must_be_empty output &&
393 test_grep "mode1" output.err &&
394 test_grep "mode2" output.err &&
395 test_grep "cannot be used together" output.err
398 test_expect_success
'OPT_CMDMODE() detects incompatibility (2)' '
399 test_must_fail test-tool parse-options --set23 --mode2 >output 2>output.err &&
400 test_must_be_empty output &&
401 test_grep "mode2" output.err &&
402 test_grep "set23" output.err &&
403 test_grep "cannot be used together" output.err
406 test_expect_success
'OPT_CMDMODE() detects incompatibility (3)' '
407 test_must_fail test-tool parse-options --mode2 --set23 >output 2>output.err &&
408 test_must_be_empty output &&
409 test_grep "mode2" output.err &&
410 test_grep "set23" output.err &&
411 test_grep "cannot be used together" output.err
414 test_expect_success
'OPT_CMDMODE() detects incompatibility (4)' '
415 test_must_fail test-tool parse-options --mode2 --mode34=3 \
416 >output 2>output.err &&
417 test_must_be_empty output &&
418 test_grep "mode2" output.err &&
419 test_grep "mode34.3" output.err &&
420 test_grep "cannot be used together" output.err
423 test_expect_success
'OPT_COUNTUP() with PARSE_OPT_NODASH works' '
424 test-tool parse-options --expect="boolean: 6" + + + + + +
427 test_expect_success
'OPT_NUMBER_CALLBACK() works' '
428 test-tool parse-options --expect="integer: 12345" -12345
444 test_expect_success
'negation of OPT_NONEG flags is not ambiguous' '
445 GIT_TEST_DISALLOW_ABBREVIATED_OPTIONS=false \
446 test-tool parse-options --no-ambig >output 2>output.err &&
447 test_must_be_empty output.err &&
448 test_cmp expect output
456 test_expect_success
'--list keeps list of strings' '
457 test-tool parse-options --list foo --list=bar --list=baz >output &&
458 test_cmp expect output
461 test_expect_success
'--no-list resets list' '
462 test-tool parse-options --list=other --list=irrelevant --list=options \
463 --no-list --list=foo --list=bar --list=baz >output &&
464 test_cmp expect output
467 test_expect_success
'multiple quiet levels' '
468 test-tool parse-options --expect="quiet: 3" -q -q -q
471 test_expect_success
'multiple verbose levels' '
472 test-tool parse-options --expect="verbose: 3" -v -v -v
475 test_expect_success
'--no-quiet sets --quiet to 0' '
476 test-tool parse-options --expect="quiet: 0" --no-quiet
479 test_expect_success
'--no-quiet resets multiple -q to 0' '
480 test-tool parse-options --expect="quiet: 0" -q -q -q --no-quiet
483 test_expect_success
'--no-verbose sets verbose to 0' '
484 test-tool parse-options --expect="verbose: 0" --no-verbose
487 test_expect_success
'--no-verbose resets multiple verbose to 0' '
488 test-tool parse-options --expect="verbose: 0" -v -v -v --no-verbose
491 test_expect_success
'GIT_TEST_DISALLOW_ABBREVIATED_OPTIONS works' '
492 GIT_TEST_DISALLOW_ABBREVIATED_OPTIONS=false \
493 test-tool parse-options --ye &&
494 test_must_fail env GIT_TEST_DISALLOW_ABBREVIATED_OPTIONS=true \
495 test-tool parse-options --ye
498 test_expect_success
'--end-of-options treats remainder as args' '
499 test-tool parse-options \
500 --expect="verbose: -1" \
501 --expect="arg 00: --verbose" \
502 --end-of-options --verbose
505 test_expect_success
'KEEP_DASHDASH works' '
506 test-tool parse-options-flags --keep-dashdash cmd --opt=1 -- --opt=2 --unknown >actual &&
507 cat >expect <<-\EOF &&
513 test_cmp expect actual
516 test_expect_success
'KEEP_ARGV0 works' '
517 test-tool parse-options-flags --keep-argv0 cmd arg0 --opt=3 >actual &&
518 cat >expect <<-\EOF &&
523 test_cmp expect actual
526 test_expect_success
'STOP_AT_NON_OPTION works' '
527 test-tool parse-options-flags --stop-at-non-option cmd --opt=4 arg0 --opt=5 --unknown >actual &&
528 cat >expect <<-\EOF &&
534 test_cmp expect actual
537 test_expect_success
'KEEP_UNKNOWN_OPT works' '
538 test-tool parse-options-flags --keep-unknown-opt cmd --unknown=1 --opt=6 -u2 >actual &&
539 cat >expect <<-\EOF &&
544 test_cmp expect actual
547 test_expect_success
'NO_INTERNAL_HELP works for -h' '
548 test_expect_code 129 test-tool parse-options-flags --no-internal-help cmd -h 2>err &&
549 grep "^error: unknown switch \`h$SQ" err &&
553 for help_opt
in help help-all
555 test_expect_success
"NO_INTERNAL_HELP works for --$help_opt" "
556 test_expect_code 129 test-tool parse-options-flags --no-internal-help cmd --$help_opt 2>err &&
557 grep '^error: unknown option \`'$help_opt\' err &&
562 test_expect_success
'KEEP_UNKNOWN_OPT | NO_INTERNAL_HELP works' '
563 test-tool parse-options-flags --keep-unknown-opt --no-internal-help cmd -h --help --help-all >actual &&
564 cat >expect <<-\EOF &&
570 test_cmp expect actual
573 test_expect_success
'subcommand - no subcommand shows error and usage' '
574 test_expect_code 129 test-tool parse-subcommand cmd 2>err &&
575 grep "^error: need a subcommand" err &&
579 test_expect_success
'subcommand - subcommand after -- shows error and usage' '
580 test_expect_code 129 test-tool parse-subcommand cmd -- subcmd-one 2>err &&
581 grep "^error: need a subcommand" err &&
585 test_expect_success
'subcommand - subcommand after --end-of-options shows error and usage' '
586 test_expect_code 129 test-tool parse-subcommand cmd --end-of-options subcmd-one 2>err &&
587 grep "^error: need a subcommand" err &&
591 test_expect_success
'subcommand - unknown subcommand shows error and usage' '
592 test_expect_code 129 test-tool parse-subcommand cmd nope 2>err &&
593 grep "^error: unknown subcommand: \`nope$SQ" err &&
597 test_expect_success
'subcommand - subcommands cannot be abbreviated' '
598 test_expect_code 129 test-tool parse-subcommand cmd subcmd-o 2>err &&
599 grep "^error: unknown subcommand: \`subcmd-o$SQ$" err &&
603 test_expect_success
'subcommand - no negated subcommands' '
604 test_expect_code 129 test-tool parse-subcommand cmd no-subcmd-one 2>err &&
605 grep "^error: unknown subcommand: \`no-subcmd-one$SQ" err &&
609 test_expect_success
'subcommand - simple' '
610 test-tool parse-subcommand cmd subcmd-two >actual &&
611 cat >expect <<-\EOF &&
616 test_cmp expect actual
619 test_expect_success
'subcommand - stop parsing at the first subcommand' '
620 test-tool parse-subcommand cmd --opt=1 subcmd-two subcmd-one --opt=2 >actual &&
621 cat >expect <<-\EOF &&
628 test_cmp expect actual
631 test_expect_success
'subcommand - KEEP_ARGV0' '
632 test-tool parse-subcommand --keep-argv0 cmd subcmd-two >actual &&
633 cat >expect <<-\EOF &&
639 test_cmp expect actual
642 test_expect_success
'subcommand - SUBCOMMAND_OPTIONAL + subcommand not given' '
643 test-tool parse-subcommand --subcommand-optional cmd >actual &&
644 cat >expect <<-\EOF &&
648 test_cmp expect actual
651 test_expect_success
'subcommand - SUBCOMMAND_OPTIONAL + given subcommand' '
652 test-tool parse-subcommand --subcommand-optional cmd subcmd-two branch file >actual &&
653 cat >expect <<-\EOF &&
660 test_cmp expect actual
663 test_expect_success
'subcommand - SUBCOMMAND_OPTIONAL + subcommand not given + unknown dashless args' '
664 test-tool parse-subcommand --subcommand-optional cmd branch file >actual &&
665 cat >expect <<-\EOF &&
671 test_cmp expect actual
674 test_expect_success
'subcommand - SUBCOMMAND_OPTIONAL + subcommand not given + unknown option' '
675 test_expect_code 129 test-tool parse-subcommand --subcommand-optional cmd --subcommand-opt 2>err &&
676 grep "^error: unknown option" err &&
680 test_expect_success
'subcommand - SUBCOMMAND_OPTIONAL | KEEP_UNKNOWN_OPT + subcommand not given + unknown option' '
681 test-tool parse-subcommand --subcommand-optional --keep-unknown-opt cmd --subcommand-opt >actual &&
682 cat >expect <<-\EOF &&
685 arg 00: --subcommand-opt
687 test_cmp expect actual
690 test_expect_success
'subcommand - SUBCOMMAND_OPTIONAL | KEEP_UNKNOWN_OPT + subcommand ignored after unknown option' '
691 test-tool parse-subcommand --subcommand-optional --keep-unknown-opt cmd --subcommand-opt subcmd-two >actual &&
692 cat >expect <<-\EOF &&
695 arg 00: --subcommand-opt
698 test_cmp expect actual
701 test_expect_success
'subcommand - SUBCOMMAND_OPTIONAL | KEEP_UNKNOWN_OPT + command and subcommand options cannot be mixed' '
702 test-tool parse-subcommand --subcommand-optional --keep-unknown-opt cmd --subcommand-opt branch --opt=1 >actual &&
703 cat >expect <<-\EOF &&
706 arg 00: --subcommand-opt
710 test_cmp expect actual
713 test_expect_success
'subcommand - SUBCOMMAND_OPTIONAL | KEEP_UNKNOWN_OPT | KEEP_ARGV0' '
714 test-tool parse-subcommand --subcommand-optional --keep-unknown-opt --keep-argv0 cmd --subcommand-opt branch >actual &&
715 cat >expect <<-\EOF &&
719 arg 01: --subcommand-opt
722 test_cmp expect actual
725 test_expect_success
'subcommand - SUBCOMMAND_OPTIONAL | KEEP_UNKNOWN_OPT | KEEP_DASHDASH' '
726 test-tool parse-subcommand --subcommand-optional --keep-unknown-opt --keep-dashdash cmd -- --subcommand-opt file >actual &&
727 cat >expect <<-\EOF &&
731 arg 01: --subcommand-opt
734 test_cmp expect actual
737 test_expect_success
'subcommand - completion helper' '
738 test-tool parse-subcommand cmd --git-completion-helper >actual &&
739 echo "subcmd-one subcmd-two --opt= --no-opt" >expect &&
740 test_cmp expect actual
743 test_expect_success
'subcommands are incompatible with STOP_AT_NON_OPTION' '
744 test_must_fail test-tool parse-subcommand --stop-at-non-option cmd subcmd-one 2>err &&
748 test_expect_success
'subcommands are incompatible with KEEP_UNKNOWN_OPT unless in combination with SUBCOMMAND_OPTIONAL' '
749 test_must_fail test-tool parse-subcommand --keep-unknown-opt cmd subcmd-two 2>err &&
753 test_expect_success
'subcommands are incompatible with KEEP_DASHDASH unless in combination with SUBCOMMAND_OPTIONAL' '
754 test_must_fail test-tool parse-subcommand --keep-dashdash cmd subcmd-two 2>err &&
758 test_expect_success
'negative magnitude' '
759 test_must_fail test-tool parse-options --magnitude -1 >out 2>err &&
760 grep "non-negative integer" err &&
761 test_must_be_empty out
764 test_expect_success
'magnitude with units but no numbers' '
765 test_must_fail test-tool parse-options --magnitude m >out 2>err &&
766 grep "non-negative integer" err &&
767 test_must_be_empty out