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 cat > expect << EOF
 136 boolean: 2
 137 integer: 1729
 138 timestamp: 0
 139 string: 123
 140 abbrev: 7
 141 verbose: 2
 142 quiet: no
 143 dry run: yes
 144 file: prefix/my.file
 145 EOF
 146
 147 test_expect_success 'short options' '
 148         test-parse-options -s123 -b -i 1729 -b -vv -n -F my.file \
 149         > output 2> output.err &&
 150         test_cmp expect output &&
 151         test_must_be_empty output.err
 152 '
 153
 154 cat > expect << EOF
 155 boolean: 2
 156 integer: 1729
 157 timestamp: 0
 158 string: 321
 159 abbrev: 10
 160 verbose: 2
 161 quiet: no
 162 dry run: no
 163 file: prefix/fi.le
 164 EOF
 165
 166 test_expect_success 'long options' '
 167         test-parse-options --boolean --integer 1729 --boolean --string2=321 \
 168                 --verbose --verbose --no-dry-run --abbrev=10 --file fi.le\
 169                 --obsolete > output 2> output.err &&
 170         test_must_be_empty output.err &&
 171         test_cmp expect output
 172 '
 173
 174 test_expect_success 'missing required value' '
 175         test_expect_code 129 test-parse-options -s &&
 176         test_expect_code 129 test-parse-options --string &&
 177         test_expect_code 129 test-parse-options --file
 178 '
 179
 180 cat > expect << EOF
 181 boolean: 1
 182 integer: 13
 183 timestamp: 0
 184 string: 123
 185 abbrev: 7
 186 verbose: 0
 187 quiet: no
 188 dry run: no
 189 file: (not set)
 190 arg 00: a1
 191 arg 01: b1
 192 arg 02: --boolean
 193 EOF
 194
 195 test_expect_success 'intermingled arguments' '
 196         test-parse-options a1 --string 123 b1 --boolean -j 13 -- --boolean \
 197                 > output 2> output.err &&
 198         test_must_be_empty output.err &&
 199         test_cmp expect output
 200 '
 201
 202 cat > expect << EOF
 203 boolean: 0
 204 integer: 2
 205 timestamp: 0
 206 string: (not set)
 207 abbrev: 7
 208 verbose: 0
 209 quiet: no
 210 dry run: no
 211 file: (not set)
 212 EOF
 213
 214 test_expect_success 'unambiguously abbreviated option' '
 215         test-parse-options --int 2 --boolean --no-bo > output 2> output.err &&
 216         test_must_be_empty output.err &&
 217         test_cmp expect output
 218 '
 219
 220 test_expect_success 'unambiguously abbreviated option with "="' '
 221         test-parse-options --int=2 > output 2> output.err &&
 222         test_must_be_empty output.err &&
 223         test_cmp expect output
 224 '
 225
 226 test_expect_success 'ambiguously abbreviated option' '
 227         test_expect_code 129 test-parse-options --strin 123
 228 '
 229
 230 cat > expect << EOF
 231 boolean: 0
 232 integer: 0
 233 timestamp: 0
 234 string: 123
 235 abbrev: 7
 236 verbose: 0
 237 quiet: no
 238 dry run: no
 239 file: (not set)
 240 EOF
 241
 242 test_expect_success 'non ambiguous option (after two options it abbreviates)' '
 243         test-parse-options --st 123 > output 2> output.err &&
 244         test_must_be_empty output.err &&
 245         test_cmp expect output
 246 '
 247
 248 cat > typo.err << EOF
 249 error: did you mean \`--boolean\` (with two dashes ?)
 250 EOF
 251
 252 test_expect_success 'detect possible typos' '
 253         test_must_fail test-parse-options -boolean > output 2> output.err &&
 254         test_must_be_empty output &&
 255         test_cmp typo.err output.err
 256 '
 257
 258 cat > typo.err << EOF
 259 error: did you mean \`--ambiguous\` (with two dashes ?)
 260 EOF
 261
 262 test_expect_success 'detect possible typos' '
 263         test_must_fail test-parse-options -ambiguous > output 2> output.err &&
 264         test_must_be_empty output &&
 265         test_cmp typo.err output.err
 266 '
 267
 268 cat > expect <<EOF
 269 boolean: 0
 270 integer: 0
 271 timestamp: 0
 272 string: (not set)
 273 abbrev: 7
 274 verbose: 0
 275 quiet: no
 276 dry run: no
 277 file: (not set)
 278 arg 00: --quux
 279 EOF
 280
 281 test_expect_success 'keep some options as arguments' '
 282         test-parse-options --quux > output 2> output.err &&
 283         test_must_be_empty output.err &&
 284         test_cmp expect output
 285 '
 286
 287 cat > expect <<EOF
 288 boolean: 0
 289 integer: 0
 290 timestamp: 1
 291 string: (not set)
 292 abbrev: 7
 293 verbose: 0
 294 quiet: yes
 295 dry run: no
 296 file: (not set)
 297 arg 00: foo
 298 EOF
 299
 300 test_expect_success 'OPT_DATE() works' '
 301         test-parse-options -t "1970-01-01 00:00:01 +0000" \
 302                 foo -q > output 2> output.err &&
 303         test_must_be_empty output.err &&
 304         test_cmp expect output
 305 '
 306
 307 cat > expect <<EOF
 308 Callback: "four", 0
 309 boolean: 5
 310 integer: 4
 311 timestamp: 0
 312 string: (not set)
 313 abbrev: 7
 314 verbose: 0
 315 quiet: no
 316 dry run: no
 317 file: (not set)
 318 EOF
 319
 320 test_expect_success 'OPT_CALLBACK() and OPT_BIT() work' '
 321         test-parse-options --length=four -b -4 > output 2> output.err &&
 322         test_must_be_empty output.err &&
 323         test_cmp expect output
 324 '
 325
 326 cat > expect <<EOF
 327 Callback: "not set", 1
 328 EOF
 329
 330 test_expect_success 'OPT_CALLBACK() and callback errors work' '
 331         test_must_fail test-parse-options --no-length > output 2> output.err &&
 332         test_i18ncmp expect output &&
 333         test_i18ncmp expect.err output.err
 334 '
 335
 336 cat > expect <<EOF
 337 boolean: 1
 338 integer: 23
 339 timestamp: 0
 340 string: (not set)
 341 abbrev: 7
 342 verbose: 0
 343 quiet: no
 344 dry run: no
 345 file: (not set)
 346 EOF
 347
 348 test_expect_success 'OPT_BIT() and OPT_SET_INT() work' '
 349         test-parse-options --set23 -bbbbb --no-or4 > output 2> output.err &&
 350         test_must_be_empty output.err &&
 351         test_cmp expect output
 352 '
 353
 354 test_expect_success 'OPT_NEGBIT() and OPT_SET_INT() work' '
 355         test-parse-options --set23 -bbbbb --neg-or4 > output 2> output.err &&
 356         test_must_be_empty output.err &&
 357         test_cmp expect output
 358 '
 359
 360 cat > expect <<EOF
 361 boolean: 6
 362 integer: 0
 363 timestamp: 0
 364 string: (not set)
 365 abbrev: 7
 366 verbose: 0
 367 quiet: no
 368 dry run: no
 369 file: (not set)
 370 EOF
 371
 372 test_expect_success 'OPT_BIT() works' '
 373         test-parse-options -bb --or4 > output 2> output.err &&
 374         test_must_be_empty output.err &&
 375         test_cmp expect output
 376 '
 377
 378 test_expect_success 'OPT_NEGBIT() works' '
 379         test-parse-options -bb --no-neg-or4 > output 2> output.err &&
 380         test_must_be_empty output.err &&
 381         test_cmp expect output
 382 '
 383
 384 test_expect_success 'OPT_COUNTUP() with PARSE_OPT_NODASH works' '
 385         test-parse-options + + + + + + > output 2> output.err &&
 386         test_must_be_empty output.err &&
 387         test_cmp expect output
 388 '
 389
 390 cat > expect <<EOF
 391 boolean: 0
 392 integer: 12345
 393 timestamp: 0
 394 string: (not set)
 395 abbrev: 7
 396 verbose: 0
 397 quiet: no
 398 dry run: no
 399 file: (not set)
 400 EOF
 401
 402 test_expect_success 'OPT_NUMBER_CALLBACK() works' '
 403         test-parse-options -12345 > output 2> output.err &&
 404         test_must_be_empty output.err &&
 405         test_cmp expect output
 406 '
 407
 408 cat >expect <<EOF
 409 boolean: 0
 410 integer: 0
 411 timestamp: 0
 412 string: (not set)
 413 abbrev: 7
 414 verbose: 0
 415 quiet: no
 416 dry run: no
 417 file: (not set)
 418 EOF
 419
 420 test_expect_success 'negation of OPT_NONEG flags is not ambiguous' '
 421         test-parse-options --no-ambig >output 2>output.err &&
 422         test_must_be_empty output.err &&
 423         test_cmp expect output
 424 '
 425
 426 cat >>expect <<'EOF'
 427 list: foo
 428 list: bar
 429 list: baz
 430 EOF
 431 test_expect_success '--list keeps list of strings' '
 432         test-parse-options --list foo --list=bar --list=baz >output &&
 433         test_cmp expect output
 434 '
 435
 436 test_expect_success '--no-list resets list' '
 437         test-parse-options --list=other --list=irrelevant --list=options \
 438                 --no-list --list=foo --list=bar --list=baz >output &&
 439         test_cmp expect output
 440 '
 441
 442 test_done