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