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