parse-options: add OPT_STRING_LIST helper
[git/git.git] / 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 -b, --boolean get a boolean
14 -4, --or4 bitwise-or boolean with ...0100
15 --neg-or4 same as --no-or4
16
17 -i, --integer <n> get a integer
18 -j <n> get a integer, too
19 --set23 set integer to 23
20 -t <time> get timestamp of <time>
21 -L, --length <str> get length of <str>
22 -F, --file <file> set file to <file>
23
24 String options
25 -s, --string <string>
26 get a string
27 --string2 <str> get another string
28 --st <st> get another string (pervert ordering)
29 -o <str> get another string
30 --default-string set string to default
31 --list <str> add str to list
32
33 Magic arguments
34 --quux means --quux
35 -NUM set integer to NUM
36 + same as -b
37 --ambiguous positive ambiguity
38 --no-ambiguous negative ambiguity
39
40 Standard options
41 --abbrev[=<n>] use <n> digits to display SHA-1s
42 -v, --verbose be verbose
43 -n, --dry-run dry run
44 -q, --quiet be quiet
45
46 EOF
47
48 test_expect_success 'test help' '
49 test_must_fail test-parse-options -h > output 2> output.err &&
50 test ! -s output.err &&
51 test_cmp expect output
52 '
53
54 mv expect expect.err
55
56 cat > expect << EOF
57 boolean: 2
58 integer: 1729
59 timestamp: 0
60 string: 123
61 abbrev: 7
62 verbose: 2
63 quiet: no
64 dry run: yes
65 file: prefix/my.file
66 EOF
67
68 test_expect_success 'short options' '
69 test-parse-options -s123 -b -i 1729 -b -vv -n -F my.file \
70 > output 2> output.err &&
71 test_cmp expect output &&
72 test ! -s output.err
73 '
74
75 cat > expect << EOF
76 boolean: 2
77 integer: 1729
78 timestamp: 0
79 string: 321
80 abbrev: 10
81 verbose: 2
82 quiet: no
83 dry run: no
84 file: prefix/fi.le
85 EOF
86
87 test_expect_success 'long options' '
88 test-parse-options --boolean --integer 1729 --boolean --string2=321 \
89 --verbose --verbose --no-dry-run --abbrev=10 --file fi.le\
90 > output 2> output.err &&
91 test ! -s output.err &&
92 test_cmp expect output
93 '
94
95 test_expect_success 'missing required value' '
96 test-parse-options -s;
97 test $? = 129 &&
98 test-parse-options --string;
99 test $? = 129 &&
100 test-parse-options --file;
101 test $? = 129
102 '
103
104 cat > expect << EOF
105 boolean: 1
106 integer: 13
107 timestamp: 0
108 string: 123
109 abbrev: 7
110 verbose: 0
111 quiet: no
112 dry run: no
113 file: (not set)
114 arg 00: a1
115 arg 01: b1
116 arg 02: --boolean
117 EOF
118
119 test_expect_success 'intermingled arguments' '
120 test-parse-options a1 --string 123 b1 --boolean -j 13 -- --boolean \
121 > output 2> output.err &&
122 test ! -s output.err &&
123 test_cmp expect output
124 '
125
126 cat > expect << EOF
127 boolean: 0
128 integer: 2
129 timestamp: 0
130 string: (not set)
131 abbrev: 7
132 verbose: 0
133 quiet: no
134 dry run: no
135 file: (not set)
136 EOF
137
138 test_expect_success 'unambiguously abbreviated option' '
139 test-parse-options --int 2 --boolean --no-bo > output 2> output.err &&
140 test ! -s output.err &&
141 test_cmp expect output
142 '
143
144 test_expect_success 'unambiguously abbreviated option with "="' '
145 test-parse-options --int=2 > output 2> output.err &&
146 test ! -s output.err &&
147 test_cmp expect output
148 '
149
150 test_expect_success 'ambiguously abbreviated option' '
151 test-parse-options --strin 123;
152 test $? = 129
153 '
154
155 cat > expect << EOF
156 boolean: 0
157 integer: 0
158 timestamp: 0
159 string: 123
160 abbrev: 7
161 verbose: 0
162 quiet: no
163 dry run: no
164 file: (not set)
165 EOF
166
167 test_expect_success 'non ambiguous option (after two options it abbreviates)' '
168 test-parse-options --st 123 > output 2> output.err &&
169 test ! -s output.err &&
170 test_cmp expect output
171 '
172
173 cat > typo.err << EOF
174 error: did you mean \`--boolean\` (with two dashes ?)
175 EOF
176
177 test_expect_success 'detect possible typos' '
178 test_must_fail test-parse-options -boolean > output 2> output.err &&
179 test ! -s output &&
180 test_cmp typo.err output.err
181 '
182
183 cat > expect <<EOF
184 boolean: 0
185 integer: 0
186 timestamp: 0
187 string: (not set)
188 abbrev: 7
189 verbose: 0
190 quiet: no
191 dry run: no
192 file: (not set)
193 arg 00: --quux
194 EOF
195
196 test_expect_success 'keep some options as arguments' '
197 test-parse-options --quux > output 2> output.err &&
198 test ! -s output.err &&
199 test_cmp expect output
200 '
201
202 cat > expect <<EOF
203 boolean: 0
204 integer: 0
205 timestamp: 1
206 string: default
207 abbrev: 7
208 verbose: 0
209 quiet: yes
210 dry run: no
211 file: (not set)
212 arg 00: foo
213 EOF
214
215 test_expect_success 'OPT_DATE() and OPT_SET_PTR() work' '
216 test-parse-options -t "1970-01-01 00:00:01 +0000" --default-string \
217 foo -q > output 2> output.err &&
218 test ! -s output.err &&
219 test_cmp expect output
220 '
221
222 cat > expect <<EOF
223 Callback: "four", 0
224 boolean: 5
225 integer: 4
226 timestamp: 0
227 string: (not set)
228 abbrev: 7
229 verbose: 0
230 quiet: no
231 dry run: no
232 file: (not set)
233 EOF
234
235 test_expect_success 'OPT_CALLBACK() and OPT_BIT() work' '
236 test-parse-options --length=four -b -4 > output 2> output.err &&
237 test ! -s output.err &&
238 test_cmp expect output
239 '
240
241 cat > expect <<EOF
242 Callback: "not set", 1
243 EOF
244
245 test_expect_success 'OPT_CALLBACK() and callback errors work' '
246 test_must_fail test-parse-options --no-length > output 2> output.err &&
247 test_cmp expect output &&
248 test_cmp expect.err output.err
249 '
250
251 cat > expect <<EOF
252 boolean: 1
253 integer: 23
254 timestamp: 0
255 string: (not set)
256 abbrev: 7
257 verbose: 0
258 quiet: no
259 dry run: no
260 file: (not set)
261 EOF
262
263 test_expect_success 'OPT_BIT() and OPT_SET_INT() work' '
264 test-parse-options --set23 -bbbbb --no-or4 > output 2> output.err &&
265 test ! -s output.err &&
266 test_cmp expect output
267 '
268
269 test_expect_success 'OPT_NEGBIT() and OPT_SET_INT() work' '
270 test-parse-options --set23 -bbbbb --neg-or4 > output 2> output.err &&
271 test ! -s output.err &&
272 test_cmp expect output
273 '
274
275 cat > expect <<EOF
276 boolean: 6
277 integer: 0
278 timestamp: 0
279 string: (not set)
280 abbrev: 7
281 verbose: 0
282 quiet: no
283 dry run: no
284 file: (not set)
285 EOF
286
287 test_expect_success 'OPT_BIT() works' '
288 test-parse-options -bb --or4 > output 2> output.err &&
289 test ! -s output.err &&
290 test_cmp expect output
291 '
292
293 test_expect_success 'OPT_NEGBIT() works' '
294 test-parse-options -bb --no-neg-or4 > output 2> output.err &&
295 test ! -s output.err &&
296 test_cmp expect output
297 '
298
299 test_expect_success 'OPT_BOOLEAN() with PARSE_OPT_NODASH works' '
300 test-parse-options + + + + + + > output 2> output.err &&
301 test ! -s output.err &&
302 test_cmp expect output
303 '
304
305 cat > expect <<EOF
306 boolean: 0
307 integer: 12345
308 timestamp: 0
309 string: (not set)
310 abbrev: 7
311 verbose: 0
312 quiet: no
313 dry run: no
314 file: (not set)
315 EOF
316
317 test_expect_success 'OPT_NUMBER_CALLBACK() works' '
318 test-parse-options -12345 > output 2> output.err &&
319 test ! -s output.err &&
320 test_cmp expect output
321 '
322
323 cat >expect <<EOF
324 boolean: 0
325 integer: 0
326 timestamp: 0
327 string: (not set)
328 abbrev: 7
329 verbose: 0
330 quiet: no
331 dry run: no
332 file: (not set)
333 EOF
334
335 test_expect_success 'negation of OPT_NONEG flags is not ambiguous' '
336 test-parse-options --no-ambig >output 2>output.err &&
337 test ! -s output.err &&
338 test_cmp expect output
339 '
340
341 cat >>expect <<'EOF'
342 list: foo
343 list: bar
344 list: baz
345 EOF
346 test_expect_success '--list keeps list of strings' '
347 test-parse-options --list foo --list=bar --list=baz >output &&
348 test_cmp expect output
349 '
350
351 test_expect_success '--no-list resets list' '
352 test-parse-options --list=other --list=irrelevant --list=options \
353 --no-list --list=foo --list=bar --list=baz >output &&
354 test_cmp expect output
355 '
356
357 test_done