]> git.ipfire.org Git - thirdparty/git.git/blame - t/t0040-parse-options.sh
test-parse-options: fix output when callback option fails
[thirdparty/git.git] / t / t0040-parse-options.sh
CommitLineData
beb47437
JS
1#!/bin/sh
2#
3# Copyright (c) 2007 Johannes Schindelin
4#
5
6test_description='our own option parser'
7
8. ./test-lib.sh
9
8425b7ea 10cat >expect <<\EOF
beb47437
JS
11usage: test-parse-options <options>
12
b9e63ddd
RS
13 --yes get a boolean
14 -D, --no-doubt begins with 'no-'
15 -B, --no-fear be brave
16 -b, --boolean increment by one
010a2dac 17 -4, --or4 bitwise-or boolean with ...0100
2f4b97f9 18 --neg-or4 same as --no-or4
010a2dac 19
beb47437
JS
20 -i, --integer <n> get a integer
21 -j <n> get a integer, too
2a514ed8 22 -m, --magnitude <n> get a magnitude
010a2dac
SB
23 --set23 set integer to 23
24 -t <time> get timestamp of <time>
25 -L, --length <str> get length of <str>
41dbcd45 26 -F, --file <file> set file to <file>
beb47437 27
010a2dac 28String options
beb47437
JS
29 -s, --string <string>
30 get a string
31 --string2 <str> get another string
243e0614 32 --st <st> get another string (pervert ordering)
3a9f0f41 33 -o <str> get another string
c8ba1639 34 --list <str> add str to list
beb47437 35
010a2dac 36Magic arguments
580d5bff 37 --quux means --quux
e0319ff5 38 -NUM set integer to NUM
51a9949e 39 + same as -b
6bbfd1fa
AS
40 --ambiguous positive ambiguity
41 --no-ambiguous negative ambiguity
580d5bff 42
010a2dac
SB
43Standard 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
beb47437
JS
49EOF
50
51test_expect_success 'test help' '
8425b7ea 52 test_must_fail test-parse-options -h >output 2>output.err &&
ca8d148d 53 test_must_be_empty output.err &&
9a001381 54 test_i18ncmp expect output
beb47437
JS
55'
56
9c7304e3
GS
57mv expect expect.err
58
8425b7ea 59cat >expect.template <<\EOF
b9e63ddd
RS
60boolean: 0
61integer: 0
2a514ed8 62magnitude: 0
b9e63ddd
RS
63timestamp: 0
64string: (not set)
65abbrev: 7
e0070e8b 66verbose: -1
36e6a5ba 67quiet: 0
b9e63ddd
RS
68dry run: no
69file: (not set)
70EOF
71
72check() {
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 &&
ca8d148d 79 test_must_be_empty output.err &&
b9e63ddd
RS
80 test_cmp expect output
81}
82
9a001381
JX
83check_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 &&
ca8d148d 90 test_must_be_empty output.err &&
9a001381
JX
91 test_i18ncmp expect output
92}
93
b9e63ddd
RS
94check_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 &&
ca8d148d 103 test_must_be_empty output &&
b9e63ddd
RS
104 test_cmp expect output.err
105}
106
9a001381
JX
107check_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 &&
ca8d148d 116 test_must_be_empty output &&
9a001381
JX
117 test_i18ncmp expect output.err
118}
119
b9e63ddd
RS
120test_expect_success 'OPT_BOOL() #1' 'check boolean: 1 --yes'
121test_expect_success 'OPT_BOOL() #2' 'check boolean: 1 --no-doubt'
122test_expect_success 'OPT_BOOL() #3' 'check boolean: 1 -D'
123test_expect_success 'OPT_BOOL() #4' 'check boolean: 1 --no-fear'
124test_expect_success 'OPT_BOOL() #5' 'check boolean: 1 -B'
125
126test_expect_success 'OPT_BOOL() is idempotent #1' 'check boolean: 1 --yes --yes'
127test_expect_success 'OPT_BOOL() is idempotent #2' 'check boolean: 1 -DB'
128
129test_expect_success 'OPT_BOOL() negation #1' 'check boolean: 0 -D --no-yes'
130test_expect_success 'OPT_BOOL() negation #2' 'check boolean: 0 -D --no-no-doubt'
131
9a001381
JX
132test_expect_success 'OPT_BOOL() no negation #1' 'check_unknown_i18n --fear'
133test_expect_success 'OPT_BOOL() no negation #2' 'check_unknown_i18n --no-no-fear'
b9e63ddd 134
0f1930c5 135test_expect_success 'OPT_BOOL() positivation' 'check boolean: 0 -D --doubt'
b9e63ddd 136
81a48cc0
CB
137test_expect_success 'OPT_INT() negative' 'check integer: -2345 -i -2345'
138
2a514ed8
CB
139test_expect_success 'OPT_MAGNITUDE() simple' '
140 check magnitude: 2345678 -m 2345678
141'
142
143test_expect_success 'OPT_MAGNITUDE() kilo' '
144 check magnitude: 239616 -m 234k
145'
146
147test_expect_success 'OPT_MAGNITUDE() mega' '
148 check magnitude: 104857600 -m 100m
149'
150
151test_expect_success 'OPT_MAGNITUDE() giga' '
152 check magnitude: 1073741824 -m 1g
153'
154
155test_expect_success 'OPT_MAGNITUDE() 3giga' '
156 check magnitude: 3221225472 -m 3g
157'
158
8425b7ea 159cat >expect <<\EOF
beb47437
JS
160boolean: 2
161integer: 1729
2a514ed8 162magnitude: 16384
c4aca9cc 163timestamp: 0
beb47437 164string: 123
010a2dac
SB
165abbrev: 7
166verbose: 2
36e6a5ba 167quiet: 0
010a2dac 168dry run: yes
df217ed6 169file: prefix/my.file
beb47437
JS
170EOF
171
172test_expect_success 'short options' '
2a514ed8
CB
173 test-parse-options -s123 -b -i 1729 -m 16k -b -vv -n -F my.file \
174 >output 2>output.err &&
3af82863 175 test_cmp expect output &&
ca8d148d 176 test_must_be_empty output.err
beb47437 177'
010a2dac 178
8425b7ea 179cat >expect <<\EOF
beb47437
JS
180boolean: 2
181integer: 1729
2a514ed8 182magnitude: 16384
c4aca9cc 183timestamp: 0
beb47437 184string: 321
010a2dac
SB
185abbrev: 10
186verbose: 2
36e6a5ba 187quiet: 0
010a2dac 188dry run: no
df217ed6 189file: prefix/fi.le
beb47437
JS
190EOF
191
192test_expect_success 'long options' '
2a514ed8
CB
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 &&
ca8d148d 197 test_must_be_empty output.err &&
3af82863 198 test_cmp expect output
beb47437
JS
199'
200
d5d745f9 201test_expect_success 'missing required value' '
c21fc9d0
JK
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
d5d745f9
OM
205'
206
8425b7ea 207cat >expect <<\EOF
beb47437
JS
208boolean: 1
209integer: 13
2a514ed8 210magnitude: 0
c4aca9cc 211timestamp: 0
beb47437 212string: 123
010a2dac 213abbrev: 7
e0070e8b 214verbose: -1
36e6a5ba 215quiet: 0
010a2dac 216dry run: no
df217ed6 217file: (not set)
beb47437
JS
218arg 00: a1
219arg 01: b1
220arg 02: --boolean
221EOF
222
223test_expect_success 'intermingled arguments' '
224 test-parse-options a1 --string 123 b1 --boolean -j 13 -- --boolean \
8425b7ea 225 >output 2>output.err &&
ca8d148d 226 test_must_be_empty output.err &&
3af82863 227 test_cmp expect output
beb47437
JS
228'
229
8425b7ea 230cat >expect <<\EOF
7f275b91
JS
231boolean: 0
232integer: 2
2a514ed8 233magnitude: 0
c4aca9cc 234timestamp: 0
7f275b91 235string: (not set)
010a2dac 236abbrev: 7
e0070e8b 237verbose: -1
36e6a5ba 238quiet: 0
010a2dac 239dry run: no
df217ed6 240file: (not set)
7f275b91
JS
241EOF
242
243test_expect_success 'unambiguously abbreviated option' '
8425b7ea 244 test-parse-options --int 2 --boolean --no-bo >output 2>output.err &&
ca8d148d 245 test_must_be_empty output.err &&
3af82863 246 test_cmp expect output
7f275b91
JS
247'
248
249test_expect_success 'unambiguously abbreviated option with "="' '
8425b7ea 250 test-parse-options --int=2 >output 2>output.err &&
ca8d148d 251 test_must_be_empty output.err &&
3af82863 252 test_cmp expect output
7f275b91
JS
253'
254
41ac414e 255test_expect_success 'ambiguously abbreviated option' '
c21fc9d0 256 test_expect_code 129 test-parse-options --strin 123
7f275b91
JS
257'
258
8425b7ea 259cat >expect <<\EOF
243e0614
JS
260boolean: 0
261integer: 0
2a514ed8 262magnitude: 0
c4aca9cc 263timestamp: 0
243e0614 264string: 123
010a2dac 265abbrev: 7
e0070e8b 266verbose: -1
36e6a5ba 267quiet: 0
010a2dac 268dry run: no
df217ed6 269file: (not set)
243e0614
JS
270EOF
271
272test_expect_success 'non ambiguous option (after two options it abbreviates)' '
8425b7ea 273 test-parse-options --st 123 >output 2>output.err &&
ca8d148d 274 test_must_be_empty output.err &&
3af82863 275 test_cmp expect output
243e0614
JS
276'
277
8425b7ea
PB
278cat >typo.err <<\EOF
279error: did you mean `--boolean` (with two dashes ?)
3a9f0f41
PH
280EOF
281
282test_expect_success 'detect possible typos' '
8425b7ea 283 test_must_fail test-parse-options -boolean >output 2>output.err &&
ca8d148d 284 test_must_be_empty output &&
010a2dac 285 test_cmp typo.err output.err
3a9f0f41
PH
286'
287
8425b7ea
PB
288cat >typo.err <<\EOF
289error: did you mean `--ambiguous` (with two dashes ?)
38916c5b
RS
290EOF
291
292test_expect_success 'detect possible typos' '
8425b7ea 293 test_must_fail test-parse-options -ambiguous >output 2>output.err &&
ca8d148d 294 test_must_be_empty output &&
38916c5b
RS
295 test_cmp typo.err output.err
296'
297
8425b7ea 298cat >expect <<\EOF
580d5bff
PH
299boolean: 0
300integer: 0
2a514ed8 301magnitude: 0
c4aca9cc 302timestamp: 0
580d5bff 303string: (not set)
010a2dac 304abbrev: 7
e0070e8b 305verbose: -1
36e6a5ba 306quiet: 0
010a2dac 307dry run: no
df217ed6 308file: (not set)
580d5bff
PH
309arg 00: --quux
310EOF
311
312test_expect_success 'keep some options as arguments' '
8425b7ea 313 test-parse-options --quux >output 2>output.err &&
ca8d148d 314 test_must_be_empty output.err &&
8425b7ea 315 test_cmp expect output
580d5bff
PH
316'
317
8425b7ea 318cat >expect <<\EOF
010a2dac 319boolean: 0
c4aca9cc 320integer: 0
2a514ed8 321magnitude: 0
c4aca9cc 322timestamp: 1
20d1c652 323string: (not set)
010a2dac 324abbrev: 7
e0070e8b 325verbose: -1
36e6a5ba 326quiet: 1
010a2dac 327dry run: no
df217ed6 328file: (not set)
010a2dac
SB
329arg 00: foo
330EOF
331
20d1c652
MR
332test_expect_success 'OPT_DATE() works' '
333 test-parse-options -t "1970-01-01 00:00:01 +0000" \
8425b7ea 334 foo -q >output 2>output.err &&
ca8d148d 335 test_must_be_empty output.err &&
010a2dac
SB
336 test_cmp expect output
337'
338
8425b7ea 339cat >expect <<\EOF
010a2dac
SB
340Callback: "four", 0
341boolean: 5
342integer: 4
2a514ed8 343magnitude: 0
c4aca9cc 344timestamp: 0
010a2dac
SB
345string: (not set)
346abbrev: 7
e0070e8b 347verbose: -1
36e6a5ba 348quiet: 0
010a2dac 349dry run: no
df217ed6 350file: (not set)
010a2dac
SB
351EOF
352
353test_expect_success 'OPT_CALLBACK() and OPT_BIT() work' '
8425b7ea 354 test-parse-options --length=four -b -4 >output 2>output.err &&
ca8d148d 355 test_must_be_empty output.err &&
010a2dac
SB
356 test_cmp expect output
357'
358
accac419 359>expect
010a2dac
SB
360
361test_expect_success 'OPT_CALLBACK() and callback errors work' '
8425b7ea 362 test_must_fail test-parse-options --no-length >output 2>output.err &&
9a001381
JX
363 test_i18ncmp expect output &&
364 test_i18ncmp expect.err output.err
010a2dac
SB
365'
366
8425b7ea 367cat >expect <<\EOF
010a2dac
SB
368boolean: 1
369integer: 23
2a514ed8 370magnitude: 0
c4aca9cc 371timestamp: 0
010a2dac
SB
372string: (not set)
373abbrev: 7
e0070e8b 374verbose: -1
36e6a5ba 375quiet: 0
010a2dac 376dry run: no
df217ed6 377file: (not set)
010a2dac
SB
378EOF
379
380test_expect_success 'OPT_BIT() and OPT_SET_INT() work' '
8425b7ea 381 test-parse-options --set23 -bbbbb --no-or4 >output 2>output.err &&
ca8d148d 382 test_must_be_empty output.err &&
010a2dac
SB
383 test_cmp expect output
384'
385
2f4b97f9 386test_expect_success 'OPT_NEGBIT() and OPT_SET_INT() work' '
8425b7ea 387 test-parse-options --set23 -bbbbb --neg-or4 >output 2>output.err &&
ca8d148d 388 test_must_be_empty output.err &&
2f4b97f9
RS
389 test_cmp expect output
390'
391
8425b7ea 392cat >expect <<\EOF
2f4b97f9
RS
393boolean: 6
394integer: 0
2a514ed8 395magnitude: 0
2f4b97f9
RS
396timestamp: 0
397string: (not set)
398abbrev: 7
e0070e8b 399verbose: -1
36e6a5ba 400quiet: 0
2f4b97f9 401dry run: no
df217ed6 402file: (not set)
2f4b97f9
RS
403EOF
404
405test_expect_success 'OPT_BIT() works' '
8425b7ea 406 test-parse-options -bb --or4 >output 2>output.err &&
ca8d148d 407 test_must_be_empty output.err &&
2f4b97f9
RS
408 test_cmp expect output
409'
410
411test_expect_success 'OPT_NEGBIT() works' '
8425b7ea 412 test-parse-options -bb --no-neg-or4 >output 2>output.err &&
ca8d148d 413 test_must_be_empty output.err &&
2f4b97f9
RS
414 test_cmp expect output
415'
010a2dac 416
b9e63ddd 417test_expect_success 'OPT_COUNTUP() with PARSE_OPT_NODASH works' '
8425b7ea 418 test-parse-options + + + + + + >output 2>output.err &&
ca8d148d 419 test_must_be_empty output.err &&
51a9949e
RS
420 test_cmp expect output
421'
422
8425b7ea 423cat >expect <<\EOF
e0319ff5
RS
424boolean: 0
425integer: 12345
2a514ed8 426magnitude: 0
e0319ff5
RS
427timestamp: 0
428string: (not set)
429abbrev: 7
e0070e8b 430verbose: -1
36e6a5ba 431quiet: 0
e0319ff5 432dry run: no
df217ed6 433file: (not set)
e0319ff5
RS
434EOF
435
436test_expect_success 'OPT_NUMBER_CALLBACK() works' '
8425b7ea 437 test-parse-options -12345 >output 2>output.err &&
ca8d148d 438 test_must_be_empty output.err &&
e0319ff5
RS
439 test_cmp expect output
440'
441
8425b7ea 442cat >expect <<\EOF
6bbfd1fa
AS
443boolean: 0
444integer: 0
2a514ed8 445magnitude: 0
6bbfd1fa
AS
446timestamp: 0
447string: (not set)
448abbrev: 7
e0070e8b 449verbose: -1
36e6a5ba 450quiet: 0
6bbfd1fa
AS
451dry run: no
452file: (not set)
453EOF
454
455test_expect_success 'negation of OPT_NONEG flags is not ambiguous' '
456 test-parse-options --no-ambig >output 2>output.err &&
ca8d148d 457 test_must_be_empty output.err &&
6bbfd1fa
AS
458 test_cmp expect output
459'
460
8425b7ea 461cat >>expect <<\EOF
c8ba1639
JK
462list: foo
463list: bar
464list: baz
465EOF
466test_expect_success '--list keeps list of strings' '
467 test-parse-options --list foo --list=bar --list=baz >output &&
468 test_cmp expect output
469'
470
471test_expect_success '--no-list resets list' '
472 test-parse-options --list=other --list=irrelevant --list=options \
473 --no-list --list=foo --list=bar --list=baz >output &&
474 test_cmp expect output
475'
476
7d177152
PB
477cat >expect <<\EOF
478boolean: 0
479integer: 0
480magnitude: 0
481timestamp: 0
482string: (not set)
483abbrev: 7
e0070e8b 484verbose: -1
7d177152
PB
485quiet: 3
486dry run: no
487file: (not set)
488EOF
489
490test_expect_success 'multiple quiet levels' '
491 test-parse-options -q -q -q >output 2>output.err &&
492 test_must_be_empty output.err &&
493 test_cmp expect output
494'
495
496cat >expect <<\EOF
497boolean: 0
498integer: 0
499magnitude: 0
500timestamp: 0
501string: (not set)
502abbrev: 7
503verbose: 3
504quiet: 0
505dry run: no
506file: (not set)
507EOF
508
509test_expect_success 'multiple verbose levels' '
510 test-parse-options -v -v -v >output 2>output.err &&
511 test_must_be_empty output.err &&
512 test_cmp expect output
513'
514
515cat >expect <<\EOF
516boolean: 0
517integer: 0
518magnitude: 0
519timestamp: 0
520string: (not set)
521abbrev: 7
e0070e8b 522verbose: -1
7d177152
PB
523quiet: 0
524dry run: no
525file: (not set)
526EOF
527
528test_expect_success '--no-quiet sets --quiet to 0' '
529 test-parse-options --no-quiet >output 2>output.err &&
530 test_must_be_empty output.err &&
531 test_cmp expect output
532'
533
534cat >expect <<\EOF
535boolean: 0
536integer: 0
537magnitude: 0
538timestamp: 0
539string: (not set)
540abbrev: 7
e0070e8b 541verbose: -1
7d177152
PB
542quiet: 0
543dry run: no
544file: (not set)
545EOF
546
547test_expect_success '--no-quiet resets multiple -q to 0' '
548 test-parse-options -q -q -q --no-quiet >output 2>output.err &&
549 test_must_be_empty output.err &&
550 test_cmp expect output
551'
552
553cat >expect <<\EOF
554boolean: 0
555integer: 0
556magnitude: 0
557timestamp: 0
558string: (not set)
559abbrev: 7
560verbose: 0
561quiet: 0
562dry run: no
563file: (not set)
564EOF
565
566test_expect_success '--no-verbose sets verbose to 0' '
567 test-parse-options --no-verbose >output 2>output.err &&
568 test_must_be_empty output.err &&
569 test_cmp expect output
570'
571
572cat >expect <<\EOF
573boolean: 0
574integer: 0
575magnitude: 0
576timestamp: 0
577string: (not set)
578abbrev: 7
579verbose: 0
580quiet: 0
581dry run: no
582file: (not set)
583EOF
584
585test_expect_success '--no-verbose resets multiple verbose to 0' '
586 test-parse-options -v -v -v --no-verbose >output 2>output.err &&
587 test_must_be_empty output.err &&
588 test_cmp expect output
589'
590
beb47437 591test_done