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_PASSES_SANITIZE_LEAK=true
   9 . ./test-lib.sh
  10
  11 cat >expect <<\EOF
  12 usage: test-tool parse-options <options>
  13
  14     A helper function for the parse-options API.
  15
  16     --yes                 get a boolean
  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
  22
  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>
  31
  32 String options
  33     -s, --string <string>
  34                           get a string
  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
  39
  40 Magic arguments
  41     -NUM                  set integer to NUM
  42     +                     same as -b
  43     --ambiguous           positive ambiguity
  44     --no-ambiguous        negative ambiguity
  45
  46 Standard options
  47     --abbrev[=<n>]        use <n> digits to display object names
  48     -v, --verbose         be verbose
  49     -n, --dry-run         dry run
  50     -q, --quiet           be quiet
  51     --expect <string>     expected output in the variable dump
  52
  53 Alias
  54     -A, --alias-source <string>
  55                           get a string
  56     -Z, --alias-target <string>
  57                           alias of --alias-source
  58
  59 EOF
  60
  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
  65 '
  66
  67 mv expect expect.err
  68
  69 check () {
  70         what="$1" &&
  71         shift &&
  72         expect="$1" &&
  73         shift &&
  74         test-tool parse-options --expect="$what $expect" "$@"
  75 }
  76
  77 check_unknown_i18n() {
  78         case "$1" in
  79         --*)
  80                 echo error: unknown option \`${1#--}\' >expect ;;
  81         -*)
  82                 echo error: unknown switch \`${1#-}\' >expect ;;
  83         esac &&
  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
  88 }
  89
  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'
  95
  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'
  98
  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'
 101
 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'
 104
 105 test_expect_success 'OPT_BOOL() positivation' 'check boolean: 0 -D --doubt'
 106
 107 test_expect_success 'OPT_INT() negative' 'check integer: -2345 -i -2345'
 108
 109 test_expect_success 'OPT_MAGNITUDE() simple' '
 110         check magnitude: 2345678 -m 2345678
 111 '
 112
 113 test_expect_success 'OPT_MAGNITUDE() kilo' '
 114         check magnitude: 239616 -m 234k
 115 '
 116
 117 test_expect_success 'OPT_MAGNITUDE() mega' '
 118         check magnitude: 104857600 -m 100m
 119 '
 120
 121 test_expect_success 'OPT_MAGNITUDE() giga' '
 122         check magnitude: 1073741824 -m 1g
 123 '
 124
 125 test_expect_success 'OPT_MAGNITUDE() 3giga' '
 126         check magnitude: 3221225472 -m 3g
 127 '
 128
 129 cat >expect <<\EOF
 130 boolean: 2
 131 integer: 1729
 132 magnitude: 16384
 133 timestamp: 0
 134 string: 123
 135 abbrev: 7
 136 verbose: 2
 137 quiet: 0
 138 dry run: yes
 139 file: prefix/my.file
 140 EOF
 141
 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
 147 '
 148
 149 cat >expect <<\EOF
 150 boolean: 2
 151 integer: 1729
 152 magnitude: 16384
 153 timestamp: 0
 154 string: 321
 155 abbrev: 10
 156 verbose: 2
 157 quiet: 0
 158 dry run: no
 159 file: prefix/fi.le
 160 EOF
 161
 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
 169 '
 170
 171 test_expect_success 'missing required value' '
 172         cat >expect <<-\EOF &&
 173         error: switch `s'\'' requires a value
 174         EOF
 175         test_expect_code 129 test-tool parse-options -s 2>actual &&
 176         test_cmp expect actual &&
 177
 178         cat >expect <<-\EOF &&
 179         error: option `string'\'' requires a value
 180         EOF
 181         test_expect_code 129 test-tool parse-options --string 2>actual &&
 182         test_cmp expect actual &&
 183
 184         cat >expect <<-\EOF &&
 185         error: option `file'\'' requires a value
 186         EOF
 187         test_expect_code 129 test-tool parse-options --file 2>actual &&
 188         test_cmp expect actual
 189 '
 190
 191 test_expect_success 'superfluous value provided: boolean' '
 192         cat >expect <<-\EOF &&
 193         error: option `yes'\'' takes no value
 194         EOF
 195         test_expect_code 129 test-tool parse-options --yes=hi 2>actual &&
 196         test_cmp expect actual &&
 197
 198         cat >expect <<-\EOF &&
 199         error: option `no-yes'\'' takes no value
 200         EOF
 201         test_expect_code 129 test-tool parse-options --no-yes=hi 2>actual &&
 202         test_cmp expect actual
 203 '
 204
 205 test_expect_success 'superfluous value provided: cmdmode' '
 206         cat >expect <<-\EOF &&
 207         error: option `mode1'\'' takes no value
 208         EOF
 209         test_expect_code 129 test-tool parse-options --mode1=hi 2>actual &&
 210         test_cmp expect actual
 211 '
 212
 213 cat >expect <<\EOF
 214 boolean: 1
 215 integer: 13
 216 magnitude: 0
 217 timestamp: 0
 218 string: 123
 219 abbrev: 7
 220 verbose: -1
 221 quiet: 0
 222 dry run: no
 223 file: (not set)
 224 arg 00: a1
 225 arg 01: b1
 226 arg 02: --boolean
 227 EOF
 228
 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
 234 '
 235
 236 cat >expect <<\EOF
 237 boolean: 0
 238 integer: 2
 239 magnitude: 0
 240 timestamp: 0
 241 string: (not set)
 242 abbrev: 7
 243 verbose: -1
 244 quiet: 0
 245 dry run: no
 246 file: (not set)
 247 EOF
 248
 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
 254 '
 255
 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
 259 '
 260
 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
 264 '
 265
 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
 269 '
 270
 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
 280 '
 281
 282 cat >typo.err <<\EOF
 283 error: did you mean `--boolean` (with two dashes)?
 284 EOF
 285
 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
 290 '
 291
 292 cat >typo.err <<\EOF
 293 error: did you mean `--ambiguous` (with two dashes)?
 294 EOF
 295
 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
 300 '
 301
 302 cat >expect <<\EOF
 303 Callback: "four", 0
 304 boolean: 5
 305 integer: 4
 306 magnitude: 0
 307 timestamp: 0
 308 string: (not set)
 309 abbrev: 7
 310 verbose: -1
 311 quiet: 0
 312 dry run: no
 313 file: (not set)
 314 EOF
 315
 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
 320 '
 321
 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
 326 '
 327
 328 cat >expect <<\EOF
 329 boolean: 1
 330 integer: 23
 331 magnitude: 0
 332 timestamp: 0
 333 string: (not set)
 334 abbrev: 7
 335 verbose: -1
 336 quiet: 0
 337 dry run: no
 338 file: (not set)
 339 EOF
 340
 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
 345 '
 346
 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
 351 '
 352
 353 test_expect_success 'OPT_BIT() works' '
 354         test-tool parse-options --expect="boolean: 6" -bb --or4
 355 '
 356
 357 test_expect_success 'OPT_NEGBIT() works' '
 358         test-tool parse-options --expect="boolean: 6" -bb --no-neg-or4
 359 '
 360
 361 test_expect_success 'OPT_CMDMODE() works' '
 362         test-tool parse-options --expect="integer: 1" --mode1
 363 '
 364
 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
 369 '
 370
 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
 375 '
 376
 377 test_expect_success 'OPT_COUNTUP() with PARSE_OPT_NODASH works' '
 378         test-tool parse-options --expect="boolean: 6" + + + + + +
 379 '
 380
 381 test_expect_success 'OPT_NUMBER_CALLBACK() works' '
 382         test-tool parse-options --expect="integer: 12345" -12345
 383 '
 384
 385 cat >expect <<\EOF
 386 boolean: 0
 387 integer: 0
 388 magnitude: 0
 389 timestamp: 0
 390 string: (not set)
 391 abbrev: 7
 392 verbose: -1
 393 quiet: 0
 394 dry run: no
 395 file: (not set)
 396 EOF
 397
 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
 403 '
 404
 405 cat >>expect <<\EOF
 406 list: foo
 407 list: bar
 408 list: baz
 409 EOF
 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
 413 '
 414
 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
 419 '
 420
 421 test_expect_success 'multiple quiet levels' '
 422         test-tool parse-options --expect="quiet: 3" -q -q -q
 423 '
 424
 425 test_expect_success 'multiple verbose levels' '
 426         test-tool parse-options --expect="verbose: 3" -v -v -v
 427 '
 428
 429 test_expect_success '--no-quiet sets --quiet to 0' '
 430         test-tool parse-options --expect="quiet: 0" --no-quiet
 431 '
 432
 433 test_expect_success '--no-quiet resets multiple -q to 0' '
 434         test-tool parse-options --expect="quiet: 0" -q -q -q --no-quiet
 435 '
 436
 437 test_expect_success '--no-verbose sets verbose to 0' '
 438         test-tool parse-options --expect="verbose: 0" --no-verbose
 439 '
 440
 441 test_expect_success '--no-verbose resets multiple verbose to 0' '
 442         test-tool parse-options --expect="verbose: 0" -v -v -v --no-verbose
 443 '
 444
 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
 450 '
 451
 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
 457 '
 458
 459 test_done