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.
17 -D, --no-doubt begins with
'no-'
18 -B, --no-fear be brave
19 -b, --boolean increment by one
20 -4, --or4 bitwise-or boolean with ..
.0100
21 --neg-or4 same as
--no-or4
23 -i, --integer <n
> get a integer
24 -j <n
> get a integer
, too
25 -m, --magnitude <n
> get a magnitude
26 --set23 set integer to
23
27 --mode1 set integer to
1 (cmdmode option
)
28 --mode2 set integer to
2 (cmdmode option
)
29 -L, --length <str
> get length of
<str
>
30 -F, --file <file> set file to
<file>
35 --string2 <str
> get another string
36 --st <st
> get another string
(pervert ordering
)
37 -o <str
> get another string
38 --list <str
> add str to list
41 -NUM set integer to NUM
43 --ambiguous positive ambiguity
44 --no-ambiguous negative ambiguity
47 --abbrev[=<n
>] use
<n
> digits to display object names
48 -v, --verbose be verbose
51 --expect <string
> expected output
in the variable dump
54 -A, --alias-source <string
>
56 -Z, --alias-target <string
>
57 alias of
--alias-source
61 test_expect_success
'test help' '
62 test_must_fail test-tool parse-options -h >output 2>output.err &&
63 test_must_be_empty output.err &&
64 test_cmp expect output
74 test-tool parse-options
--expect="$what $expect" "$@"
77 check_unknown_i18n
() {
80 echo error
: unknown option \
`${1#--}\' >expect ;;
82 echo error: unknown switch \`${1#-}\' >expect
;;
84 cat expect.err
>>expect
&&
85 test_must_fail test-tool parse-options $
* >output
2>output.err
&&
86 test_must_be_empty output
&&
87 test_cmp expect output.err
90 test_expect_success
'OPT_BOOL() #1' 'check boolean: 1 --yes'
91 test_expect_success
'OPT_BOOL() #2' 'check boolean: 1 --no-doubt'
92 test_expect_success
'OPT_BOOL() #3' 'check boolean: 1 -D'
93 test_expect_success
'OPT_BOOL() #4' 'check boolean: 1 --no-fear'
94 test_expect_success
'OPT_BOOL() #5' 'check boolean: 1 -B'
96 test_expect_success
'OPT_BOOL() is idempotent #1' 'check boolean: 1 --yes --yes'
97 test_expect_success
'OPT_BOOL() is idempotent #2' 'check boolean: 1 -DB'
99 test_expect_success
'OPT_BOOL() negation #1' 'check boolean: 0 -D --no-yes'
100 test_expect_success
'OPT_BOOL() negation #2' 'check boolean: 0 -D --no-no-doubt'
102 test_expect_success
'OPT_BOOL() no negation #1' 'check_unknown_i18n --fear'
103 test_expect_success
'OPT_BOOL() no negation #2' 'check_unknown_i18n --no-no-fear'
105 test_expect_success
'OPT_BOOL() positivation' 'check boolean: 0 -D --doubt'
107 test_expect_success
'OPT_INT() negative' 'check integer: -2345 -i -2345'
109 test_expect_success
'OPT_MAGNITUDE() simple' '
110 check magnitude: 2345678 -m 2345678
113 test_expect_success
'OPT_MAGNITUDE() kilo' '
114 check magnitude: 239616 -m 234k
117 test_expect_success
'OPT_MAGNITUDE() mega' '
118 check magnitude: 104857600 -m 100m
121 test_expect_success
'OPT_MAGNITUDE() giga' '
122 check magnitude: 1073741824 -m 1g
125 test_expect_success
'OPT_MAGNITUDE() 3giga' '
126 check magnitude: 3221225472 -m 3g
142 test_expect_success
'short options' '
143 test-tool parse-options -s123 -b -i 1729 -m 16k -b -vv -n -F my.file \
144 >output 2>output.err &&
145 test_cmp expect output &&
146 test_must_be_empty output.err
162 test_expect_success
'long options' '
163 test-tool parse-options --boolean --integer 1729 --magnitude 16k \
164 --boolean --string2=321 --verbose --verbose --no-dry-run \
165 --abbrev=10 --file fi.le --obsolete \
166 >output 2>output.err &&
167 test_must_be_empty output.err &&
168 test_cmp expect output
171 test_expect_success
'missing required value' '
172 cat >expect <<-\EOF &&
173 error: switch `s'\'' requires a value
175 test_expect_code 129 test-tool parse-options -s 2>actual &&
176 test_cmp expect actual &&
178 cat >expect <<-\EOF &&
179 error: option `string'\'' requires a value
181 test_expect_code 129 test-tool parse-options --string 2>actual &&
182 test_cmp expect actual &&
184 cat >expect <<-\EOF &&
185 error: option `file'\'' requires a value
187 test_expect_code 129 test-tool parse-options --file 2>actual &&
188 test_cmp expect actual
191 test_expect_success
'superfluous value provided: boolean' '
192 cat >expect <<-\EOF &&
193 error: option `yes'\'' takes no value
195 test_expect_code 129 test-tool parse-options --yes=hi 2>actual &&
196 test_cmp expect actual &&
198 cat >expect <<-\EOF &&
199 error: option `no-yes'\'' takes no value
201 test_expect_code 129 test-tool parse-options --no-yes=hi 2>actual &&
202 test_cmp expect actual
205 test_expect_success
'superfluous value provided: cmdmode' '
206 cat >expect <<-\EOF &&
207 error: option `mode1'\'' takes no value
209 test_expect_code 129 test-tool parse-options --mode1=hi 2>actual &&
210 test_cmp expect actual
229 test_expect_success
'intermingled arguments' '
230 test-tool parse-options a1 --string 123 b1 --boolean -j 13 -- --boolean \
231 >output 2>output.err &&
232 test_must_be_empty output.err &&
233 test_cmp expect output
249 test_expect_success
'unambiguously abbreviated option' '
250 GIT_TEST_DISALLOW_ABBREVIATED_OPTIONS=false \
251 test-tool parse-options --int 2 --boolean --no-bo >output 2>output.err &&
252 test_must_be_empty output.err &&
253 test_cmp expect output
256 test_expect_success
'unambiguously abbreviated option with "="' '
257 GIT_TEST_DISALLOW_ABBREVIATED_OPTIONS=false \
258 test-tool parse-options --expect="integer: 2" --int=2
261 test_expect_success
'ambiguously abbreviated option' '
262 test_expect_code 129 env GIT_TEST_DISALLOW_ABBREVIATED_OPTIONS=false \
263 test-tool parse-options --strin 123
266 test_expect_success
'non ambiguous option (after two options it abbreviates)' '
267 GIT_TEST_DISALLOW_ABBREVIATED_OPTIONS=false \
268 test-tool parse-options --expect="string: 123" --st 123
271 test_expect_success
'Alias options do not contribute to abbreviation' '
272 test-tool parse-options --alias-source 123 >output &&
273 grep "^string: 123" output &&
274 test-tool parse-options --alias-target 123 >output &&
275 grep "^string: 123" output &&
276 test_must_fail test-tool parse-options --alias &&
277 GIT_TEST_DISALLOW_ABBREVIATED_OPTIONS=false \
278 test-tool parse-options --alias 123 >output &&
279 grep "^string: 123" output
283 error
: did you mean
`--boolean` (with two dashes
)?
286 test_expect_success
'detect possible typos' '
287 test_must_fail test-tool parse-options -boolean >output 2>output.err &&
288 test_must_be_empty output &&
289 test_cmp typo.err output.err
293 error
: did you mean
`--ambiguous` (with two dashes
)?
296 test_expect_success
'detect possible typos' '
297 test_must_fail test-tool parse-options -ambiguous >output 2>output.err &&
298 test_must_be_empty output &&
299 test_cmp typo.err output.err
316 test_expect_success
'OPT_CALLBACK() and OPT_BIT() work' '
317 test-tool parse-options --length=four -b -4 >output 2>output.err &&
318 test_must_be_empty output.err &&
319 test_cmp expect output
322 test_expect_success
'OPT_CALLBACK() and callback errors work' '
323 test_must_fail test-tool parse-options --no-length >output 2>output.err &&
324 test_must_be_empty output &&
325 test_must_be_empty output.err
341 test_expect_success
'OPT_BIT() and OPT_SET_INT() work' '
342 test-tool parse-options --set23 -bbbbb --no-or4 >output 2>output.err &&
343 test_must_be_empty output.err &&
344 test_cmp expect output
347 test_expect_success
'OPT_NEGBIT() and OPT_SET_INT() work' '
348 test-tool parse-options --set23 -bbbbb --neg-or4 >output 2>output.err &&
349 test_must_be_empty output.err &&
350 test_cmp expect output
353 test_expect_success
'OPT_BIT() works' '
354 test-tool parse-options --expect="boolean: 6" -bb --or4
357 test_expect_success
'OPT_NEGBIT() works' '
358 test-tool parse-options --expect="boolean: 6" -bb --no-neg-or4
361 test_expect_success
'OPT_CMDMODE() works' '
362 test-tool parse-options --expect="integer: 1" --mode1
365 test_expect_success
'OPT_CMDMODE() detects incompatibility' '
366 test_must_fail test-tool parse-options --mode1 --mode2 >output 2>output.err &&
367 test_must_be_empty output &&
368 test_i18ngrep "incompatible with --mode" output.err
371 test_expect_success
'OPT_CMDMODE() detects incompatibility with something else' '
372 test_must_fail test-tool parse-options --set23 --mode2 >output 2>output.err &&
373 test_must_be_empty output &&
374 test_i18ngrep "incompatible with something else" output.err
377 test_expect_success
'OPT_COUNTUP() with PARSE_OPT_NODASH works' '
378 test-tool parse-options --expect="boolean: 6" + + + + + +
381 test_expect_success
'OPT_NUMBER_CALLBACK() works' '
382 test-tool parse-options --expect="integer: 12345" -12345
398 test_expect_success
'negation of OPT_NONEG flags is not ambiguous' '
399 GIT_TEST_DISALLOW_ABBREVIATED_OPTIONS=false \
400 test-tool parse-options --no-ambig >output 2>output.err &&
401 test_must_be_empty output.err &&
402 test_cmp expect output
410 test_expect_success
'--list keeps list of strings' '
411 test-tool parse-options --list foo --list=bar --list=baz >output &&
412 test_cmp expect output
415 test_expect_success
'--no-list resets list' '
416 test-tool parse-options --list=other --list=irrelevant --list=options \
417 --no-list --list=foo --list=bar --list=baz >output &&
418 test_cmp expect output
421 test_expect_success
'multiple quiet levels' '
422 test-tool parse-options --expect="quiet: 3" -q -q -q
425 test_expect_success
'multiple verbose levels' '
426 test-tool parse-options --expect="verbose: 3" -v -v -v
429 test_expect_success
'--no-quiet sets --quiet to 0' '
430 test-tool parse-options --expect="quiet: 0" --no-quiet
433 test_expect_success
'--no-quiet resets multiple -q to 0' '
434 test-tool parse-options --expect="quiet: 0" -q -q -q --no-quiet
437 test_expect_success
'--no-verbose sets verbose to 0' '
438 test-tool parse-options --expect="verbose: 0" --no-verbose
441 test_expect_success
'--no-verbose resets multiple verbose to 0' '
442 test-tool parse-options --expect="verbose: 0" -v -v -v --no-verbose
445 test_expect_success
'GIT_TEST_DISALLOW_ABBREVIATED_OPTIONS works' '
446 GIT_TEST_DISALLOW_ABBREVIATED_OPTIONS=false \
447 test-tool parse-options --ye &&
448 test_must_fail env GIT_TEST_DISALLOW_ABBREVIATED_OPTIONS=true \
449 test-tool parse-options --ye
452 test_expect_success
'--end-of-options treats remainder as args' '
453 test-tool parse-options \
454 --expect="verbose: -1" \
455 --expect="arg 00: --verbose" \
456 --end-of-options --verbose
459 test_expect_success
'KEEP_DASHDASH works' '
460 test-tool parse-options-flags --keep-dashdash cmd --opt=1 -- --opt=2 --unknown >actual &&
461 cat >expect <<-\EOF &&
467 test_cmp expect actual
470 test_expect_success
'KEEP_ARGV0 works' '
471 test-tool parse-options-flags --keep-argv0 cmd arg0 --opt=3 >actual &&
472 cat >expect <<-\EOF &&
477 test_cmp expect actual
480 test_expect_success
'STOP_AT_NON_OPTION works' '
481 test-tool parse-options-flags --stop-at-non-option cmd --opt=4 arg0 --opt=5 --unknown >actual &&
482 cat >expect <<-\EOF &&
488 test_cmp expect actual
491 test_expect_success
'KEEP_UNKNOWN_OPT works' '
492 test-tool parse-options-flags --keep-unknown-opt cmd --unknown=1 --opt=6 -u2 >actual &&
493 cat >expect <<-\EOF &&
498 test_cmp expect actual
501 test_expect_success
'NO_INTERNAL_HELP works for -h' '
502 test_expect_code 129 test-tool parse-options-flags --no-internal-help cmd -h 2>err &&
504 grep "^error: unknown switch \`h$SQ" err &&
508 for help_opt
in help help-all
510 test_expect_success
"NO_INTERNAL_HELP works for --$help_opt" "
511 test_expect_code 129 test-tool parse-options-flags --no-internal-help cmd --$help_opt 2>err &&
513 grep '^error: unknown option \`'$help_opt\' err &&
518 test_expect_success
'KEEP_UNKNOWN_OPT | NO_INTERNAL_HELP works' '
519 test-tool parse-options-flags --keep-unknown-opt --no-internal-help cmd -h --help --help-all >actual &&
520 cat >expect <<-\EOF &&
526 test_cmp expect actual
529 test_expect_success
'subcommand - no subcommand shows error and usage' '
530 test_expect_code 129 test-tool parse-subcommand cmd 2>err &&
531 grep "^error: need a subcommand" err &&
535 test_expect_success
'subcommand - subcommand after -- shows error and usage' '
536 test_expect_code 129 test-tool parse-subcommand cmd -- subcmd-one 2>err &&
537 grep "^error: need a subcommand" err &&
541 test_expect_success
'subcommand - subcommand after --end-of-options shows error and usage' '
542 test_expect_code 129 test-tool parse-subcommand cmd --end-of-options subcmd-one 2>err &&
543 grep "^error: need a subcommand" err &&
547 test_expect_success
'subcommand - unknown subcommand shows error and usage' '
548 test_expect_code 129 test-tool parse-subcommand cmd nope 2>err &&
549 grep "^error: unknown subcommand: \`nope$SQ" err &&
553 test_expect_success
'subcommand - subcommands cannot be abbreviated' '
554 test_expect_code 129 test-tool parse-subcommand cmd subcmd-o 2>err &&
555 grep "^error: unknown subcommand: \`subcmd-o$SQ$" err &&
559 test_expect_success
'subcommand - no negated subcommands' '
560 test_expect_code 129 test-tool parse-subcommand cmd no-subcmd-one 2>err &&
561 grep "^error: unknown subcommand: \`no-subcmd-one$SQ" err &&
565 test_expect_success
'subcommand - simple' '
566 test-tool parse-subcommand cmd subcmd-two >actual &&
567 cat >expect <<-\EOF &&
572 test_cmp expect actual
575 test_expect_success
'subcommand - stop parsing at the first subcommand' '
576 test-tool parse-subcommand cmd --opt=1 subcmd-two subcmd-one --opt=2 >actual &&
577 cat >expect <<-\EOF &&
584 test_cmp expect actual
587 test_expect_success
'subcommand - KEEP_ARGV0' '
588 test-tool parse-subcommand --keep-argv0 cmd subcmd-two >actual &&
589 cat >expect <<-\EOF &&
595 test_cmp expect actual
598 test_expect_success
'subcommand - SUBCOMMAND_OPTIONAL + subcommand not given' '
599 test-tool parse-subcommand --subcommand-optional cmd >actual &&
600 cat >expect <<-\EOF &&
604 test_cmp expect actual
607 test_expect_success
'subcommand - SUBCOMMAND_OPTIONAL + given subcommand' '
608 test-tool parse-subcommand --subcommand-optional cmd subcmd-two branch file >actual &&
609 cat >expect <<-\EOF &&
616 test_cmp expect actual
619 test_expect_success
'subcommand - SUBCOMMAND_OPTIONAL + subcommand not given + unknown dashless args' '
620 test-tool parse-subcommand --subcommand-optional cmd branch file >actual &&
621 cat >expect <<-\EOF &&
627 test_cmp expect actual
630 test_expect_success
'subcommand - SUBCOMMAND_OPTIONAL + subcommand not given + unknown option' '
631 test_expect_code 129 test-tool parse-subcommand --subcommand-optional cmd --subcommand-opt 2>err &&
632 grep "^error: unknown option" err &&
636 test_expect_success
'subcommand - SUBCOMMAND_OPTIONAL | KEEP_UNKNOWN_OPT + subcommand not given + unknown option' '
637 test-tool parse-subcommand --subcommand-optional --keep-unknown-opt cmd --subcommand-opt >actual &&
638 cat >expect <<-\EOF &&
641 arg 00: --subcommand-opt
643 test_cmp expect actual
646 test_expect_success
'subcommand - SUBCOMMAND_OPTIONAL | KEEP_UNKNOWN_OPT + subcommand ignored after unknown option' '
647 test-tool parse-subcommand --subcommand-optional --keep-unknown-opt cmd --subcommand-opt subcmd-two >actual &&
648 cat >expect <<-\EOF &&
651 arg 00: --subcommand-opt
654 test_cmp expect actual
657 test_expect_success
'subcommand - SUBCOMMAND_OPTIONAL | KEEP_UNKNOWN_OPT + command and subcommand options cannot be mixed' '
658 test-tool parse-subcommand --subcommand-optional --keep-unknown-opt cmd --subcommand-opt branch --opt=1 >actual &&
659 cat >expect <<-\EOF &&
662 arg 00: --subcommand-opt
666 test_cmp expect actual
669 test_expect_success
'subcommand - SUBCOMMAND_OPTIONAL | KEEP_UNKNOWN_OPT | KEEP_ARGV0' '
670 test-tool parse-subcommand --subcommand-optional --keep-unknown-opt --keep-argv0 cmd --subcommand-opt branch >actual &&
671 cat >expect <<-\EOF &&
675 arg 01: --subcommand-opt
678 test_cmp expect actual
681 test_expect_success
'subcommand - SUBCOMMAND_OPTIONAL | KEEP_UNKNOWN_OPT | KEEP_DASHDASH' '
682 test-tool parse-subcommand --subcommand-optional --keep-unknown-opt --keep-dashdash cmd -- --subcommand-opt file >actual &&
683 cat >expect <<-\EOF &&
687 arg 01: --subcommand-opt
690 test_cmp expect actual
693 test_expect_success
'subcommand - completion helper' '
694 test-tool parse-subcommand cmd --git-completion-helper >actual &&
695 echo "subcmd-one subcmd-two --opt= --no-opt" >expect &&
696 test_cmp expect actual
699 test_expect_success
'subcommands are incompatible with STOP_AT_NON_OPTION' '
700 test_must_fail test-tool parse-subcommand --stop-at-non-option cmd subcmd-one 2>err &&
704 test_expect_success
'subcommands are incompatible with KEEP_UNKNOWN_OPT unless in combination with SUBCOMMAND_OPTIONAL' '
705 test_must_fail test-tool parse-subcommand --keep-unknown-opt cmd subcmd-two 2>err &&
709 test_expect_success
'subcommands are incompatible with KEEP_DASHDASH unless in combination with SUBCOMMAND_OPTIONAL' '
710 test_must_fail test-tool parse-subcommand --keep-dashdash cmd subcmd-two 2>err &&