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