]>
Commit | Line | Data |
---|---|---|
c74c7203 JN |
1 | # Library of functions shared by all tests scripts, included by |
2 | # test-lib.sh. | |
12a29b1a TR |
3 | # |
4 | # Copyright (c) 2005 Junio C Hamano | |
5 | # | |
6 | # This program is free software: you can redistribute it and/or modify | |
7 | # it under the terms of the GNU General Public License as published by | |
8 | # the Free Software Foundation, either version 2 of the License, or | |
9 | # (at your option) any later version. | |
10 | # | |
11 | # This program is distributed in the hope that it will be useful, | |
12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
14 | # GNU General Public License for more details. | |
15 | # | |
16 | # You should have received a copy of the GNU General Public License | |
17 | # along with this program. If not, see http://www.gnu.org/licenses/ . | |
18 | ||
19 | # The semantics of the editor variables are that of invoking | |
20 | # sh -c "$EDITOR \"$@\"" files ... | |
21 | # | |
22 | # If our trash directory contains shell metacharacters, they will be | |
23 | # interpreted if we just set $EDITOR directly, so do a little dance with | |
24 | # environment variables to work around this. | |
25 | # | |
26 | # In particular, quoting isn't enough, as the path may contain the same quote | |
27 | # that we're using. | |
28 | test_set_editor () { | |
29 | FAKE_EDITOR="$1" | |
30 | export FAKE_EDITOR | |
31 | EDITOR='"$FAKE_EDITOR"' | |
32 | export EDITOR | |
33 | } | |
34 | ||
5d9fc888 TG |
35 | test_set_index_version () { |
36 | GIT_INDEX_VERSION="$1" | |
37 | export GIT_INDEX_VERSION | |
38 | } | |
39 | ||
12a29b1a TR |
40 | test_decode_color () { |
41 | awk ' | |
42 | function name(n) { | |
43 | if (n == 0) return "RESET"; | |
44 | if (n == 1) return "BOLD"; | |
097b681b | 45 | if (n == 7) return "REVERSE"; |
12a29b1a TR |
46 | if (n == 30) return "BLACK"; |
47 | if (n == 31) return "RED"; | |
48 | if (n == 32) return "GREEN"; | |
49 | if (n == 33) return "YELLOW"; | |
50 | if (n == 34) return "BLUE"; | |
51 | if (n == 35) return "MAGENTA"; | |
52 | if (n == 36) return "CYAN"; | |
53 | if (n == 37) return "WHITE"; | |
54 | if (n == 40) return "BLACK"; | |
55 | if (n == 41) return "BRED"; | |
56 | if (n == 42) return "BGREEN"; | |
57 | if (n == 43) return "BYELLOW"; | |
58 | if (n == 44) return "BBLUE"; | |
59 | if (n == 45) return "BMAGENTA"; | |
60 | if (n == 46) return "BCYAN"; | |
61 | if (n == 47) return "BWHITE"; | |
62 | } | |
63 | { | |
64 | while (match($0, /\033\[[0-9;]*m/) != 0) { | |
65 | printf "%s<", substr($0, 1, RSTART-1); | |
66 | codes = substr($0, RSTART+2, RLENGTH-3); | |
67 | if (length(codes) == 0) | |
68 | printf "%s", name(0) | |
69 | else { | |
70 | n = split(codes, ary, ";"); | |
71 | sep = ""; | |
72 | for (i = 1; i <= n; i++) { | |
73 | printf "%s%s", sep, name(ary[i]); | |
74 | sep = ";" | |
75 | } | |
76 | } | |
77 | printf ">"; | |
78 | $0 = substr($0, RSTART + RLENGTH, length($0) - RSTART - RLENGTH + 1); | |
79 | } | |
80 | ||
81 | } | |
82 | ' | |
83 | } | |
84 | ||
b249e39f JH |
85 | lf_to_nul () { |
86 | perl -pe 'y/\012/\000/' | |
87 | } | |
88 | ||
12a29b1a | 89 | nul_to_q () { |
94221d22 | 90 | perl -pe 'y/\000/Q/' |
12a29b1a TR |
91 | } |
92 | ||
93 | q_to_nul () { | |
94221d22 | 94 | perl -pe 'y/Q/\000/' |
12a29b1a TR |
95 | } |
96 | ||
97 | q_to_cr () { | |
98 | tr Q '\015' | |
99 | } | |
100 | ||
101 | q_to_tab () { | |
102 | tr Q '\011' | |
103 | } | |
104 | ||
250b3c6c JH |
105 | qz_to_tab_space () { |
106 | tr QZ '\011\040' | |
12a29b1a TR |
107 | } |
108 | ||
109 | append_cr () { | |
110 | sed -e 's/$/Q/' | tr Q '\015' | |
111 | } | |
112 | ||
113 | remove_cr () { | |
114 | tr '\015' Q | sed -e 's/Q$//' | |
115 | } | |
116 | ||
117 | # In some bourne shell implementations, the "unset" builtin returns | |
118 | # nonzero status when a variable to be unset was not set in the first | |
119 | # place. | |
120 | # | |
121 | # Use sane_unset when that should not be considered an error. | |
122 | ||
123 | sane_unset () { | |
124 | unset "$@" | |
125 | return 0 | |
126 | } | |
127 | ||
128 | test_tick () { | |
129 | if test -z "${test_tick+set}" | |
130 | then | |
131 | test_tick=1112911993 | |
132 | else | |
133 | test_tick=$(($test_tick + 60)) | |
134 | fi | |
135 | GIT_COMMITTER_DATE="$test_tick -0700" | |
136 | GIT_AUTHOR_DATE="$test_tick -0700" | |
137 | export GIT_COMMITTER_DATE GIT_AUTHOR_DATE | |
138 | } | |
139 | ||
59210dd5 | 140 | # Stop execution and start a shell. This is useful for debugging tests. |
12a29b1a TR |
141 | # |
142 | # Be sure to remove all invocations of this command before submitting. | |
143 | ||
144 | test_pause () { | |
59210dd5 | 145 | "$SHELL_PATH" <&6 >&5 2>&7 |
12a29b1a TR |
146 | } |
147 | ||
6a94088c JS |
148 | # Wrap git in gdb. Adding this to a command can make it easier to |
149 | # understand what is going on in a failing test. | |
150 | # | |
151 | # Example: "debug git checkout master". | |
152 | debug () { | |
4ecae3c8 | 153 | GIT_TEST_GDB=1 "$@" <&6 >&5 2>&7 |
6a94088c JS |
154 | } |
155 | ||
6f94351b SB |
156 | # Call test_commit with the arguments |
157 | # [-C <directory>] <message> [<file> [<contents> [<tag>]]]" | |
12a29b1a TR |
158 | # |
159 | # This will commit a file with the given contents and the given commit | |
4c994194 | 160 | # message, and tag the resulting commit with the given tag name. |
12a29b1a | 161 | # |
4c994194 | 162 | # <file>, <contents>, and <tag> all default to <message>. |
6f94351b SB |
163 | # |
164 | # If the first argument is "-C", the second argument is used as a path for | |
165 | # the git invocations. | |
12a29b1a TR |
166 | |
167 | test_commit () { | |
9a0231b3 | 168 | notick= && |
5ed75e2a | 169 | signoff= && |
6f94351b | 170 | indir= && |
5ed75e2a MV |
171 | while test $# != 0 |
172 | do | |
173 | case "$1" in | |
174 | --notick) | |
175 | notick=yes | |
176 | ;; | |
177 | --signoff) | |
178 | signoff="$1" | |
179 | ;; | |
6f94351b SB |
180 | -C) |
181 | indir="$2" | |
182 | shift | |
183 | ;; | |
5ed75e2a MV |
184 | *) |
185 | break | |
186 | ;; | |
187 | esac | |
9a0231b3 | 188 | shift |
5ed75e2a | 189 | done && |
6f94351b | 190 | indir=${indir:+"$indir"/} && |
9a0231b3 | 191 | file=${2:-"$1.t"} && |
6f94351b SB |
192 | echo "${3-$1}" > "$indir$file" && |
193 | git ${indir:+ -C "$indir"} add "$file" && | |
9a0231b3 JH |
194 | if test -z "$notick" |
195 | then | |
196 | test_tick | |
197 | fi && | |
6f94351b SB |
198 | git ${indir:+ -C "$indir"} commit $signoff -m "$1" && |
199 | git ${indir:+ -C "$indir"} tag "${4:-$1}" | |
12a29b1a TR |
200 | } |
201 | ||
202 | # Call test_merge with the arguments "<message> <commit>", where <commit> | |
203 | # can be a tag pointing to the commit-to-merge. | |
204 | ||
205 | test_merge () { | |
206 | test_tick && | |
207 | git merge -m "$1" "$2" && | |
208 | git tag "$1" | |
209 | } | |
210 | ||
211 | # This function helps systems where core.filemode=false is set. | |
212 | # Use it instead of plain 'chmod +x' to set or unset the executable bit | |
213 | # of a file in the working directory and add it to the index. | |
214 | ||
215 | test_chmod () { | |
216 | chmod "$@" && | |
217 | git update-index --add "--chmod=$@" | |
218 | } | |
219 | ||
73de1c93 CC |
220 | # Get the modebits from a file. |
221 | test_modebits () { | |
222 | ls -l "$1" | sed -e 's|^\(..........\).*|\1|' | |
223 | } | |
224 | ||
12a29b1a TR |
225 | # Unset a configuration variable, but don't fail if it doesn't exist. |
226 | test_unconfig () { | |
5fafc07f JK |
227 | config_dir= |
228 | if test "$1" = -C | |
229 | then | |
230 | shift | |
231 | config_dir=$1 | |
232 | shift | |
233 | fi | |
234 | git ${config_dir:+-C "$config_dir"} config --unset-all "$@" | |
12a29b1a TR |
235 | config_status=$? |
236 | case "$config_status" in | |
237 | 5) # ok, nothing to unset | |
238 | config_status=0 | |
239 | ;; | |
240 | esac | |
241 | return $config_status | |
242 | } | |
243 | ||
244 | # Set git config, automatically unsetting it after the test is over. | |
245 | test_config () { | |
5fafc07f JK |
246 | config_dir= |
247 | if test "$1" = -C | |
248 | then | |
249 | shift | |
250 | config_dir=$1 | |
251 | shift | |
252 | fi | |
253 | test_when_finished "test_unconfig ${config_dir:+-C '$config_dir'} '$1'" && | |
254 | git ${config_dir:+-C "$config_dir"} config "$@" | |
12a29b1a TR |
255 | } |
256 | ||
257 | test_config_global () { | |
258 | test_when_finished "test_unconfig --global '$1'" && | |
259 | git config --global "$@" | |
260 | } | |
261 | ||
262 | write_script () { | |
263 | { | |
264 | echo "#!${2-"$SHELL_PATH"}" && | |
265 | cat | |
266 | } >"$1" && | |
267 | chmod +x "$1" | |
268 | } | |
269 | ||
270 | # Use test_set_prereq to tell that a particular prerequisite is available. | |
271 | # The prerequisite can later be checked for in two ways: | |
272 | # | |
273 | # - Explicitly using test_have_prereq. | |
274 | # | |
275 | # - Implicitly by specifying the prerequisite tag in the calls to | |
276 | # test_expect_{success,failure,code}. | |
277 | # | |
278 | # The single parameter is the prerequisite tag (a simple word, in all | |
279 | # capital letters by convention). | |
280 | ||
281 | test_set_prereq () { | |
f3cfc3b2 | 282 | satisfied_prereq="$satisfied_prereq$1 " |
12a29b1a | 283 | } |
f3cfc3b2 | 284 | satisfied_prereq=" " |
04083f27 JH |
285 | lazily_testable_prereq= lazily_tested_prereq= |
286 | ||
287 | # Usage: test_lazy_prereq PREREQ 'script' | |
288 | test_lazy_prereq () { | |
289 | lazily_testable_prereq="$lazily_testable_prereq$1 " | |
290 | eval test_prereq_lazily_$1=\$2 | |
291 | } | |
292 | ||
293 | test_run_lazy_prereq_ () { | |
294 | script=' | |
295 | mkdir -p "$TRASH_DIRECTORY/prereq-test-dir" && | |
296 | ( | |
297 | cd "$TRASH_DIRECTORY/prereq-test-dir" &&'"$2"' | |
298 | )' | |
299 | say >&3 "checking prerequisite: $1" | |
300 | say >&3 "$script" | |
301 | test_eval_ "$script" | |
302 | eval_ret=$? | |
303 | rm -rf "$TRASH_DIRECTORY/prereq-test-dir" | |
304 | if test "$eval_ret" = 0; then | |
305 | say >&3 "prerequisite $1 ok" | |
306 | else | |
307 | say >&3 "prerequisite $1 not satisfied" | |
308 | fi | |
309 | return $eval_ret | |
310 | } | |
12a29b1a TR |
311 | |
312 | test_have_prereq () { | |
313 | # prerequisites can be concatenated with ',' | |
314 | save_IFS=$IFS | |
315 | IFS=, | |
316 | set -- $* | |
317 | IFS=$save_IFS | |
318 | ||
319 | total_prereq=0 | |
320 | ok_prereq=0 | |
321 | missing_prereq= | |
322 | ||
323 | for prerequisite | |
324 | do | |
bdccd3c1 JK |
325 | case "$prerequisite" in |
326 | !*) | |
327 | negative_prereq=t | |
328 | prerequisite=${prerequisite#!} | |
329 | ;; | |
330 | *) | |
331 | negative_prereq= | |
332 | esac | |
333 | ||
04083f27 JH |
334 | case " $lazily_tested_prereq " in |
335 | *" $prerequisite "*) | |
336 | ;; | |
337 | *) | |
338 | case " $lazily_testable_prereq " in | |
339 | *" $prerequisite "*) | |
340 | eval "script=\$test_prereq_lazily_$prerequisite" && | |
341 | if test_run_lazy_prereq_ "$prerequisite" "$script" | |
342 | then | |
343 | test_set_prereq $prerequisite | |
344 | fi | |
345 | lazily_tested_prereq="$lazily_tested_prereq$prerequisite " | |
346 | esac | |
347 | ;; | |
348 | esac | |
349 | ||
12a29b1a | 350 | total_prereq=$(($total_prereq + 1)) |
f3cfc3b2 | 351 | case "$satisfied_prereq" in |
12a29b1a | 352 | *" $prerequisite "*) |
bdccd3c1 JK |
353 | satisfied_this_prereq=t |
354 | ;; | |
355 | *) | |
356 | satisfied_this_prereq= | |
357 | esac | |
358 | ||
359 | case "$satisfied_this_prereq,$negative_prereq" in | |
360 | t,|,t) | |
12a29b1a TR |
361 | ok_prereq=$(($ok_prereq + 1)) |
362 | ;; | |
363 | *) | |
bdccd3c1 JK |
364 | # Keep a list of missing prerequisites; restore |
365 | # the negative marker if necessary. | |
366 | prerequisite=${negative_prereq:+!}$prerequisite | |
12a29b1a TR |
367 | if test -z "$missing_prereq" |
368 | then | |
369 | missing_prereq=$prerequisite | |
370 | else | |
371 | missing_prereq="$prerequisite,$missing_prereq" | |
372 | fi | |
373 | esac | |
374 | done | |
375 | ||
376 | test $total_prereq = $ok_prereq | |
377 | } | |
378 | ||
379 | test_declared_prereq () { | |
380 | case ",$test_prereq," in | |
381 | *,$1,*) | |
382 | return 0 | |
383 | ;; | |
384 | esac | |
385 | return 1 | |
386 | } | |
387 | ||
d93d5d51 JH |
388 | test_verify_prereq () { |
389 | test -z "$test_prereq" || | |
390 | expr >/dev/null "$test_prereq" : '[A-Z0-9_,!]*$' || | |
391 | error "bug in the test script: '$test_prereq' does not look like a prereq" | |
392 | } | |
393 | ||
12a29b1a | 394 | test_expect_failure () { |
ae75342c | 395 | test_start_ |
12a29b1a TR |
396 | test "$#" = 3 && { test_prereq=$1; shift; } || test_prereq= |
397 | test "$#" = 2 || | |
398 | error "bug in the test script: not 2 or 3 parameters to test-expect-failure" | |
d93d5d51 | 399 | test_verify_prereq |
12a29b1a TR |
400 | export test_prereq |
401 | if ! test_skip "$@" | |
402 | then | |
403 | say >&3 "checking known breakage: $2" | |
404 | if test_run_ "$2" expecting_failure | |
405 | then | |
406 | test_known_broken_ok_ "$1" | |
407 | else | |
408 | test_known_broken_failure_ "$1" | |
409 | fi | |
410 | fi | |
ae75342c | 411 | test_finish_ |
12a29b1a TR |
412 | } |
413 | ||
414 | test_expect_success () { | |
ae75342c | 415 | test_start_ |
12a29b1a TR |
416 | test "$#" = 3 && { test_prereq=$1; shift; } || test_prereq= |
417 | test "$#" = 2 || | |
418 | error "bug in the test script: not 2 or 3 parameters to test-expect-success" | |
d93d5d51 | 419 | test_verify_prereq |
12a29b1a TR |
420 | export test_prereq |
421 | if ! test_skip "$@" | |
422 | then | |
423 | say >&3 "expecting success: $2" | |
424 | if test_run_ "$2" | |
425 | then | |
426 | test_ok_ "$1" | |
427 | else | |
428 | test_failure_ "$@" | |
429 | fi | |
430 | fi | |
ae75342c | 431 | test_finish_ |
12a29b1a TR |
432 | } |
433 | ||
434 | # test_external runs external test scripts that provide continuous | |
435 | # test output about their progress, and succeeds/fails on | |
436 | # zero/non-zero exit code. It outputs the test output on stdout even | |
437 | # in non-verbose mode, and announces the external script with "# run | |
438 | # <n>: ..." before running it. When providing relative paths, keep in | |
439 | # mind that all scripts run in "trash directory". | |
440 | # Usage: test_external description command arguments... | |
441 | # Example: test_external 'Perl API' perl ../path/to/test.pl | |
442 | test_external () { | |
443 | test "$#" = 4 && { test_prereq=$1; shift; } || test_prereq= | |
444 | test "$#" = 3 || | |
445 | error >&5 "bug in the test script: not 3 or 4 parameters to test_external" | |
446 | descr="$1" | |
447 | shift | |
d93d5d51 | 448 | test_verify_prereq |
12a29b1a TR |
449 | export test_prereq |
450 | if ! test_skip "$descr" "$@" | |
451 | then | |
452 | # Announce the script to reduce confusion about the | |
453 | # test output that follows. | |
454 | say_color "" "# run $test_count: $descr ($*)" | |
455 | # Export TEST_DIRECTORY, TRASH_DIRECTORY and GIT_TEST_LONG | |
456 | # to be able to use them in script | |
457 | export TEST_DIRECTORY TRASH_DIRECTORY GIT_TEST_LONG | |
458 | # Run command; redirect its stderr to &4 as in | |
459 | # test_run_, but keep its stdout on our stdout even in | |
460 | # non-verbose mode. | |
461 | "$@" 2>&4 | |
9e8f8dea | 462 | if test "$?" = 0 |
12a29b1a TR |
463 | then |
464 | if test $test_external_has_tap -eq 0; then | |
465 | test_ok_ "$descr" | |
466 | else | |
467 | say_color "" "# test_external test $descr was ok" | |
468 | test_success=$(($test_success + 1)) | |
469 | fi | |
470 | else | |
471 | if test $test_external_has_tap -eq 0; then | |
472 | test_failure_ "$descr" "$@" | |
473 | else | |
474 | say_color error "# test_external test $descr failed: $@" | |
475 | test_failure=$(($test_failure + 1)) | |
476 | fi | |
477 | fi | |
478 | fi | |
479 | } | |
480 | ||
481 | # Like test_external, but in addition tests that the command generated | |
482 | # no output on stderr. | |
483 | test_external_without_stderr () { | |
484 | # The temporary file has no (and must have no) security | |
485 | # implications. | |
486 | tmp=${TMPDIR:-/tmp} | |
487 | stderr="$tmp/git-external-stderr.$$.tmp" | |
488 | test_external "$@" 4> "$stderr" | |
9e8f8dea | 489 | test -f "$stderr" || error "Internal error: $stderr disappeared." |
12a29b1a TR |
490 | descr="no stderr: $1" |
491 | shift | |
492 | say >&3 "# expecting no stderr from previous command" | |
9e8f8dea DA |
493 | if test ! -s "$stderr" |
494 | then | |
12a29b1a TR |
495 | rm "$stderr" |
496 | ||
497 | if test $test_external_has_tap -eq 0; then | |
498 | test_ok_ "$descr" | |
499 | else | |
500 | say_color "" "# test_external_without_stderr test $descr was ok" | |
501 | test_success=$(($test_success + 1)) | |
502 | fi | |
503 | else | |
9e8f8dea DA |
504 | if test "$verbose" = t |
505 | then | |
506 | output=$(echo; echo "# Stderr is:"; cat "$stderr") | |
12a29b1a TR |
507 | else |
508 | output= | |
509 | fi | |
510 | # rm first in case test_failure exits. | |
511 | rm "$stderr" | |
512 | if test $test_external_has_tap -eq 0; then | |
513 | test_failure_ "$descr" "$@" "$output" | |
514 | else | |
515 | say_color error "# test_external_without_stderr test $descr failed: $@: $output" | |
516 | test_failure=$(($test_failure + 1)) | |
517 | fi | |
518 | fi | |
519 | } | |
520 | ||
521 | # debugging-friendly alternatives to "test [-f|-d|-e]" | |
522 | # The commands test the existence or non-existence of $1. $2 can be | |
523 | # given to provide a more precise diagnosis. | |
524 | test_path_is_file () { | |
9e8f8dea | 525 | if ! test -f "$1" |
12a29b1a | 526 | then |
de248e92 | 527 | echo "File $1 doesn't exist. $2" |
12a29b1a TR |
528 | false |
529 | fi | |
530 | } | |
531 | ||
532 | test_path_is_dir () { | |
9e8f8dea | 533 | if ! test -d "$1" |
12a29b1a | 534 | then |
de248e92 | 535 | echo "Directory $1 doesn't exist. $2" |
12a29b1a TR |
536 | false |
537 | fi | |
538 | } | |
539 | ||
0be7d9b7 JL |
540 | # Check if the directory exists and is empty as expected, barf otherwise. |
541 | test_dir_is_empty () { | |
542 | test_path_is_dir "$1" && | |
543 | if test -n "$(ls -a1 "$1" | egrep -v '^\.\.?$')" | |
544 | then | |
545 | echo "Directory '$1' is not empty, it contains:" | |
546 | ls -la "$1" | |
547 | return 1 | |
548 | fi | |
549 | } | |
550 | ||
12a29b1a | 551 | test_path_is_missing () { |
9e8f8dea | 552 | if test -e "$1" |
12a29b1a TR |
553 | then |
554 | echo "Path exists:" | |
555 | ls -ld "$1" | |
9e8f8dea DA |
556 | if test $# -ge 1 |
557 | then | |
12a29b1a TR |
558 | echo "$*" |
559 | fi | |
560 | false | |
561 | fi | |
562 | } | |
563 | ||
564 | # test_line_count checks that a file has the number of lines it | |
565 | # ought to. For example: | |
566 | # | |
567 | # test_expect_success 'produce exactly one line of output' ' | |
568 | # do something >output && | |
569 | # test_line_count = 1 output | |
570 | # ' | |
571 | # | |
572 | # is like "test $(wc -l <output) = 1" except that it passes the | |
573 | # output through when the number of lines is wrong. | |
574 | ||
575 | test_line_count () { | |
576 | if test $# != 3 | |
577 | then | |
578 | error "bug in the test script: not 3 parameters to test_line_count" | |
579 | elif ! test $(wc -l <"$3") "$1" "$2" | |
580 | then | |
581 | echo "test_line_count: line count for $3 !$1 $2" | |
582 | cat "$3" | |
583 | return 1 | |
584 | fi | |
585 | } | |
586 | ||
bbfe5302 LS |
587 | # Returns success if a comma separated string of keywords ($1) contains a |
588 | # given keyword ($2). | |
589 | # Examples: | |
590 | # `list_contains "foo,bar" bar` returns 0 | |
591 | # `list_contains "foo" bar` returns 1 | |
592 | ||
593 | list_contains () { | |
594 | case ",$1," in | |
595 | *,$2,*) | |
596 | return 0 | |
597 | ;; | |
598 | esac | |
599 | return 1 | |
600 | } | |
601 | ||
12a29b1a TR |
602 | # This is not among top-level (test_expect_success | test_expect_failure) |
603 | # but is a prefix that can be used in the test script, like: | |
604 | # | |
605 | # test_expect_success 'complain and die' ' | |
606 | # do something && | |
607 | # do something else && | |
608 | # test_must_fail git checkout ../outerspace | |
609 | # ' | |
610 | # | |
611 | # Writing this as "! git checkout ../outerspace" is wrong, because | |
612 | # the failure could be due to a segv. We want a controlled failure. | |
613 | ||
614 | test_must_fail () { | |
bbfe5302 LS |
615 | case "$1" in |
616 | ok=*) | |
617 | _test_ok=${1#ok=} | |
618 | shift | |
619 | ;; | |
620 | *) | |
621 | _test_ok= | |
622 | ;; | |
623 | esac | |
12a29b1a TR |
624 | "$@" |
625 | exit_code=$? | |
bbfe5302 LS |
626 | if test $exit_code -eq 0 && ! list_contains "$_test_ok" success |
627 | then | |
12a29b1a TR |
628 | echo >&2 "test_must_fail: command succeeded: $*" |
629 | return 1 | |
2472448c | 630 | elif test_match_signal 13 $exit_code && list_contains "$_test_ok" sigpipe |
8bf4becf LS |
631 | then |
632 | return 0 | |
bbfe5302 LS |
633 | elif test $exit_code -gt 129 && test $exit_code -le 192 |
634 | then | |
f3ed0b37 | 635 | echo >&2 "test_must_fail: died by signal $(($exit_code - 128)): $*" |
12a29b1a | 636 | return 1 |
bbfe5302 LS |
637 | elif test $exit_code -eq 127 |
638 | then | |
12a29b1a TR |
639 | echo >&2 "test_must_fail: command not found: $*" |
640 | return 1 | |
bbfe5302 LS |
641 | elif test $exit_code -eq 126 |
642 | then | |
eeb69131 TR |
643 | echo >&2 "test_must_fail: valgrind error: $*" |
644 | return 1 | |
12a29b1a TR |
645 | fi |
646 | return 0 | |
647 | } | |
648 | ||
649 | # Similar to test_must_fail, but tolerates success, too. This is | |
650 | # meant to be used in contexts like: | |
651 | # | |
652 | # test_expect_success 'some command works without configuration' ' | |
653 | # test_might_fail git config --unset all.configuration && | |
654 | # do something | |
655 | # ' | |
656 | # | |
657 | # Writing "git config --unset all.configuration || :" would be wrong, | |
658 | # because we want to notice if it fails due to segv. | |
659 | ||
660 | test_might_fail () { | |
bbfe5302 | 661 | test_must_fail ok=success "$@" |
12a29b1a TR |
662 | } |
663 | ||
664 | # Similar to test_must_fail and test_might_fail, but check that a | |
665 | # given command exited with a given exit code. Meant to be used as: | |
666 | # | |
667 | # test_expect_success 'Merge with d/f conflicts' ' | |
668 | # test_expect_code 1 git merge "merge msg" B master | |
669 | # ' | |
670 | ||
671 | test_expect_code () { | |
672 | want_code=$1 | |
673 | shift | |
674 | "$@" | |
675 | exit_code=$? | |
676 | if test $exit_code = $want_code | |
677 | then | |
678 | return 0 | |
679 | fi | |
680 | ||
681 | echo >&2 "test_expect_code: command exited with $exit_code, we wanted $want_code $*" | |
682 | return 1 | |
683 | } | |
684 | ||
685 | # test_cmp is a helper function to compare actual and expected output. | |
686 | # You can use it like: | |
687 | # | |
688 | # test_expect_success 'foo works' ' | |
689 | # echo expected >expected && | |
690 | # foo >actual && | |
691 | # test_cmp expected actual | |
692 | # ' | |
693 | # | |
694 | # This could be written as either "cmp" or "diff -u", but: | |
695 | # - cmp's output is not nearly as easy to read as diff -u | |
696 | # - not all diff versions understand "-u" | |
697 | ||
698 | test_cmp() { | |
699 | $GIT_TEST_CMP "$@" | |
700 | } | |
701 | ||
b93e6e36 SK |
702 | # test_cmp_bin - helper to compare binary files |
703 | ||
704 | test_cmp_bin() { | |
705 | cmp "$@" | |
706 | } | |
707 | ||
8ad16524 JK |
708 | # Call any command "$@" but be more verbose about its |
709 | # failure. This is handy for commands like "test" which do | |
710 | # not output anything when they fail. | |
711 | verbose () { | |
712 | "$@" && return 0 | |
713 | echo >&2 "command failed: $(git rev-parse --sq-quote "$@")" | |
714 | return 1 | |
715 | } | |
716 | ||
ca8d148d JH |
717 | # Check if the file expected to be empty is indeed empty, and barfs |
718 | # otherwise. | |
719 | ||
720 | test_must_be_empty () { | |
721 | if test -s "$1" | |
722 | then | |
723 | echo "'$1' is not empty, it contains:" | |
724 | cat "$1" | |
725 | return 1 | |
726 | fi | |
727 | } | |
728 | ||
5d77298d MZ |
729 | # Tests that its two parameters refer to the same revision |
730 | test_cmp_rev () { | |
731 | git rev-parse --verify "$1" >expect.rev && | |
732 | git rev-parse --verify "$2" >actual.rev && | |
733 | test_cmp expect.rev actual.rev | |
734 | } | |
735 | ||
55672a39 JH |
736 | # Print a sequence of integers in increasing order, either with |
737 | # two arguments (start and end): | |
d17cf5f3 | 738 | # |
55672a39 JH |
739 | # test_seq 1 5 -- outputs 1 2 3 4 5 one line at a time |
740 | # | |
741 | # or with one argument (end), in which case it starts counting | |
742 | # from 1. | |
d17cf5f3 MK |
743 | |
744 | test_seq () { | |
745 | case $# in | |
746 | 1) set 1 "$@" ;; | |
747 | 2) ;; | |
748 | *) error "bug in the test script: not 1 or 2 parameters to test_seq" ;; | |
749 | esac | |
4df43135 JH |
750 | test_seq_counter__=$1 |
751 | while test "$test_seq_counter__" -le "$2" | |
752 | do | |
753 | echo "$test_seq_counter__" | |
754 | test_seq_counter__=$(( $test_seq_counter__ + 1 )) | |
755 | done | |
d17cf5f3 MK |
756 | } |
757 | ||
12a29b1a TR |
758 | # This function can be used to schedule some commands to be run |
759 | # unconditionally at the end of the test to restore sanity: | |
760 | # | |
761 | # test_expect_success 'test core.capslock' ' | |
762 | # git config core.capslock true && | |
763 | # test_when_finished "git config --unset core.capslock" && | |
764 | # hello world | |
765 | # ' | |
766 | # | |
767 | # That would be roughly equivalent to | |
768 | # | |
769 | # test_expect_success 'test core.capslock' ' | |
770 | # git config core.capslock true && | |
771 | # hello world | |
772 | # git config --unset core.capslock | |
773 | # ' | |
774 | # | |
775 | # except that the greeting and config --unset must both succeed for | |
776 | # the test to pass. | |
777 | # | |
778 | # Note that under --immediate mode, no clean-up is done to help diagnose | |
779 | # what went wrong. | |
780 | ||
781 | test_when_finished () { | |
0968f12a JK |
782 | # We cannot detect when we are in a subshell in general, but by |
783 | # doing so on Bash is better than nothing (the test will | |
784 | # silently pass on other shells). | |
785 | test "${BASH_SUBSHELL-0}" = 0 || | |
786 | error "bug in test script: test_when_finished does nothing in a subshell" | |
12a29b1a TR |
787 | test_cleanup="{ $* |
788 | } && (exit \"\$eval_ret\"); eval_ret=\$?; $test_cleanup" | |
789 | } | |
790 | ||
791 | # Most tests can use the created repository, but some may need to create more. | |
792 | # Usage: test_create_repo <directory> | |
793 | test_create_repo () { | |
794 | test "$#" = 1 || | |
795 | error "bug in the test script: not 1 parameter to test-create-repo" | |
796 | repo="$1" | |
797 | mkdir -p "$repo" | |
798 | ( | |
799 | cd "$repo" || error "Cannot setup test environment" | |
800 | "$GIT_EXEC_PATH/git-init" "--template=$GIT_BUILD_DIR/templates/blt/" >&3 2>&4 || | |
801 | error "cannot run git init -- have you built things yet?" | |
802 | mv .git/hooks .git/hooks-disabled | |
803 | ) || exit | |
804 | } | |
9ce415d9 JS |
805 | |
806 | # This function helps on symlink challenged file systems when it is not | |
807 | # important that the file system entry is a symbolic link. | |
808 | # Use test_ln_s_add instead of "ln -s x y && git add y" to add a | |
809 | # symbolic link entry y to the index. | |
810 | ||
811 | test_ln_s_add () { | |
812 | if test_have_prereq SYMLINKS | |
813 | then | |
814 | ln -s "$1" "$2" && | |
815 | git update-index --add "$2" | |
816 | else | |
817 | printf '%s' "$1" >"$2" && | |
818 | ln_s_obj=$(git hash-object -w "$2") && | |
817d03e1 JS |
819 | git update-index --add --cacheinfo 120000 $ln_s_obj "$2" && |
820 | # pick up stat info from the file | |
821 | git update-index "$2" | |
9ce415d9 JS |
822 | fi |
823 | } | |
4d715ac0 | 824 | |
ac9afcc3 MT |
825 | # This function writes out its parameters, one per line |
826 | test_write_lines () { | |
827 | printf "%s\n" "$@" | |
828 | } | |
829 | ||
a0e0ec9f JK |
830 | perl () { |
831 | command "$PERL_PATH" "$@" | |
832 | } | |
a3a9cff0 | 833 | |
83d842dc JK |
834 | # Is the value one of the various ways to spell a boolean true/false? |
835 | test_normalize_bool () { | |
836 | git -c magic.variable="$1" config --bool magic.variable 2>/dev/null | |
837 | } | |
838 | ||
839 | # Given a variable $1, normalize the value of it to one of "true", | |
840 | # "false", or "auto" and store the result to it. | |
841 | # | |
842 | # test_tristate GIT_TEST_HTTPD | |
843 | # | |
844 | # A variable set to an empty string is set to 'false'. | |
845 | # A variable set to 'false' or 'auto' keeps its value. | |
846 | # Anything else is set to 'true'. | |
847 | # An unset variable defaults to 'auto'. | |
848 | # | |
849 | # The last rule is to allow people to set the variable to an empty | |
850 | # string and export it to decline testing the particular feature | |
851 | # for versions both before and after this change. We used to treat | |
852 | # both unset and empty variable as a signal for "do not test" and | |
853 | # took any non-empty string as "please test". | |
854 | ||
855 | test_tristate () { | |
856 | if eval "test x\"\${$1+isset}\" = xisset" | |
857 | then | |
858 | # explicitly set | |
859 | eval " | |
860 | case \"\$$1\" in | |
861 | '') $1=false ;; | |
862 | auto) ;; | |
863 | *) $1=\$(test_normalize_bool \$$1 || echo true) ;; | |
864 | esac | |
865 | " | |
866 | else | |
867 | eval "$1=auto" | |
868 | fi | |
869 | } | |
870 | ||
871 | # Exit the test suite, either by skipping all remaining tests or by | |
872 | # exiting with an error. If "$1" is "auto", we then we assume we were | |
873 | # opportunistically trying to set up some tests and we skip. If it is | |
874 | # "true", then we report a failure. | |
875 | # | |
876 | # The error/skip message should be given by $2. | |
877 | # | |
878 | test_skip_or_die () { | |
879 | case "$1" in | |
880 | auto) | |
881 | skip_all=$2 | |
882 | test_done | |
883 | ;; | |
884 | true) | |
885 | error "$2" | |
886 | ;; | |
887 | *) | |
888 | error "BUG: test tristate is '$1' (real error: $2)" | |
889 | esac | |
890 | } | |
891 | ||
4d715ac0 JS |
892 | # The following mingw_* functions obey POSIX shell syntax, but are actually |
893 | # bash scripts, and are meant to be used only with bash on Windows. | |
894 | ||
895 | # A test_cmp function that treats LF and CRLF equal and avoids to fork | |
896 | # diff when possible. | |
897 | mingw_test_cmp () { | |
898 | # Read text into shell variables and compare them. If the results | |
899 | # are different, use regular diff to report the difference. | |
900 | local test_cmp_a= test_cmp_b= | |
901 | ||
902 | # When text came from stdin (one argument is '-') we must feed it | |
903 | # to diff. | |
904 | local stdin_for_diff= | |
905 | ||
906 | # Since it is difficult to detect the difference between an | |
907 | # empty input file and a failure to read the files, we go straight | |
908 | # to diff if one of the inputs is empty. | |
909 | if test -s "$1" && test -s "$2" | |
910 | then | |
911 | # regular case: both files non-empty | |
912 | mingw_read_file_strip_cr_ test_cmp_a <"$1" | |
913 | mingw_read_file_strip_cr_ test_cmp_b <"$2" | |
914 | elif test -s "$1" && test "$2" = - | |
915 | then | |
916 | # read 2nd file from stdin | |
917 | mingw_read_file_strip_cr_ test_cmp_a <"$1" | |
918 | mingw_read_file_strip_cr_ test_cmp_b | |
919 | stdin_for_diff='<<<"$test_cmp_b"' | |
920 | elif test "$1" = - && test -s "$2" | |
921 | then | |
922 | # read 1st file from stdin | |
923 | mingw_read_file_strip_cr_ test_cmp_a | |
924 | mingw_read_file_strip_cr_ test_cmp_b <"$2" | |
925 | stdin_for_diff='<<<"$test_cmp_a"' | |
926 | fi | |
927 | test -n "$test_cmp_a" && | |
928 | test -n "$test_cmp_b" && | |
929 | test "$test_cmp_a" = "$test_cmp_b" || | |
930 | eval "diff -u \"\$@\" $stdin_for_diff" | |
931 | } | |
932 | ||
933 | # $1 is the name of the shell variable to fill in | |
934 | mingw_read_file_strip_cr_ () { | |
935 | # Read line-wise using LF as the line separator | |
936 | # and use IFS to strip CR. | |
937 | local line | |
938 | while : | |
939 | do | |
940 | if IFS=$'\r' read -r -d $'\n' line | |
941 | then | |
942 | # good | |
943 | line=$line$'\n' | |
944 | else | |
945 | # we get here at EOF, but also if the last line | |
946 | # was not terminated by LF; in the latter case, | |
947 | # some text was read | |
948 | if test -z "$line" | |
949 | then | |
950 | # EOF, really | |
951 | break | |
952 | fi | |
953 | fi | |
954 | eval "$1=\$$1\$line" | |
955 | done | |
956 | } | |
d2554c72 JK |
957 | |
958 | # Like "env FOO=BAR some-program", but run inside a subshell, which means | |
959 | # it also works for shell functions (though those functions cannot impact | |
960 | # the environment outside of the test_env invocation). | |
961 | test_env () { | |
962 | ( | |
963 | while test $# -gt 0 | |
964 | do | |
965 | case "$1" in | |
966 | *=*) | |
967 | eval "${1%%=*}=\${1#*=}" | |
968 | eval "export ${1%%=*}" | |
969 | shift | |
970 | ;; | |
971 | *) | |
972 | "$@" | |
973 | exit | |
974 | ;; | |
975 | esac | |
976 | done | |
977 | ) | |
978 | } | |
48860819 | 979 | |
9b67c994 JK |
980 | # Returns true if the numeric exit code in "$2" represents the expected signal |
981 | # in "$1". Signals should be given numerically. | |
982 | test_match_signal () { | |
983 | if test "$2" = "$((128 + $1))" | |
984 | then | |
985 | # POSIX | |
986 | return 0 | |
987 | elif test "$2" = "$((256 + $1))" | |
988 | then | |
989 | # ksh | |
990 | return 0 | |
991 | fi | |
992 | return 1 | |
993 | } | |
39cadeec | 994 | |
48860819 JK |
995 | # Read up to "$1" bytes (or to EOF) from stdin and write them to stdout. |
996 | test_copy_bytes () { | |
997 | perl -e ' | |
998 | my $len = $ARGV[1]; | |
999 | while ($len > 0) { | |
1000 | my $s; | |
1001 | my $nread = sysread(STDIN, $s, $len); | |
1002 | die "cannot read: $!" unless defined($nread); | |
f7f6dc34 | 1003 | last unless $nread; |
48860819 JK |
1004 | print $s; |
1005 | $len -= $nread; | |
1006 | } | |
1007 | ' - "$1" | |
1008 | } | |
de95302a JK |
1009 | |
1010 | # run "$@" inside a non-git directory | |
1011 | nongit () { | |
1012 | test -d non-repo || | |
1013 | mkdir non-repo || | |
1014 | return 1 | |
1015 | ||
1016 | ( | |
1017 | GIT_CEILING_DIRECTORIES=$(pwd) && | |
1018 | export GIT_CEILING_DIRECTORIES && | |
1019 | cd non-repo && | |
1020 | "$@" | |
1021 | ) | |
1022 | } |