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