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