]> git.ipfire.org Git - thirdparty/git.git/blame - t/test-lib.sh
trace: add infrastructure to augment trace output with additional info
[thirdparty/git.git] / t / test-lib.sh
CommitLineData
c74c7203 1# Test framework for git. See t/README for usage.
e1970ce4
JH
2#
3# Copyright (c) 2005 Junio C Hamano
4#
64b90323
MS
5# This program is free software: you can redistribute it and/or modify
6# it under the terms of the GNU General Public License as published by
7# the Free Software Foundation, either version 2 of the License, or
8# (at your option) any later version.
9#
10# This program is distributed in the hope that it will be useful,
11# but WITHOUT ANY WARRANTY; without even the implied warranty of
12# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13# GNU General Public License for more details.
14#
15# You should have received a copy of the GNU General Public License
16# along with this program. If not, see http://www.gnu.org/licenses/ .
e1970ce4 17
c2116a17
JH
18# Keep the original TERM for say_color
19ORIGINAL_TERM=$TERM
20
3c8f12c9
JH
21# Test the binaries we have just built. The tests are kept in
22# t/ subdirectory and are run in 'trash directory' subdirectory.
23if test -z "$TEST_DIRECTORY"
24then
25 # We allow tests to override this, in case they want to run tests
26 # outside of t/, e.g. for running tests on the test library
27 # itself.
28 TEST_DIRECTORY=$(pwd)
85176d72
FC
29else
30 # ensure that TEST_DIRECTORY is an absolute path so that it
31 # is valid even if the current working directory is changed
32 TEST_DIRECTORY=$(cd "$TEST_DIRECTORY" && pwd) || exit 1
3c8f12c9
JH
33fi
34if test -z "$TEST_OUTPUT_DIRECTORY"
35then
36 # Similarly, override this to store the test-results subdir
37 # elsewhere
38 TEST_OUTPUT_DIRECTORY=$TEST_DIRECTORY
39fi
40GIT_BUILD_DIR="$TEST_DIRECTORY"/..
41
2006f0ad
RR
42################################################################
43# It appears that people try to run tests without building...
44"$GIT_BUILD_DIR/git" >/dev/null
45if test $? != 1
46then
47 echo >&2 'error: you do not seem to have built git yet.'
48 exit 1
49fi
50
3c8f12c9
JH
51. "$GIT_BUILD_DIR"/GIT-BUILD-OPTIONS
52export PERL_PATH SHELL_PATH
53
4cde519f
RR
54# if --tee was passed, write the output not only to the terminal, but
55# additionally to the file test-results/$BASENAME.out, too.
56case "$GIT_TEST_TEE_STARTED, $* " in
57done,*)
58 # do not redirect again
59 ;;
60*' --tee '*|*' --va'*)
2d14e13c
JK
61 mkdir -p "$TEST_OUTPUT_DIRECTORY/test-results"
62 BASE="$TEST_OUTPUT_DIRECTORY/test-results/$(basename "$0" .sh)"
4cde519f
RR
63 (GIT_TEST_TEE_STARTED=done ${SHELL_PATH} "$0" "$@" 2>&1;
64 echo $? > $BASE.exit) | tee $BASE.out
65 test "$(cat $BASE.exit)" = 0
66 exit
67 ;;
68esac
69
e1970ce4
JH
70# For repeatability, reset the environment to known value.
71LANG=C
899460f3 72LC_ALL=C
d9bdd39e 73PAGER=cat
e1970ce4 74TZ=UTC
c2116a17
JH
75TERM=dumb
76export LANG LC_ALL PAGER TERM TZ
8ff99e74 77EDITOR=:
661bfd13
SL
78# A call to "unset" with no arguments causes at least Solaris 10
79# /usr/xpg4/bin/sh and /bin/ksh to bail out. So keep the unsets
80# deriving from the command substitution clustered with the other
81# ones.
3c8f12c9 82unset VISUAL EMAIL LANGUAGE COLUMNS $("$PERL_PATH" -e '
95a1d12e 83 my @env = keys %ENV;
730477f1
JL
84 my $ok = join("|", qw(
85 TRACE
86 DEBUG
87 USE_LOOKUP
88 TEST
89 .*_TEST
90 PROVE
91 VALGRIND
ac001282 92 UNZIP
edb54081 93 PERF_
e2a0ccc0 94 CURL_VERBOSE
730477f1
JL
95 ));
96 my @vars = grep(/^GIT_/ && !/^GIT_($ok)/o, @env);
95a1d12e
JN
97 print join("\n", @vars);
98')
5adf84eb 99unset XDG_CONFIG_HOME
8bade1e1 100unset GITPERLLIB
29e55cd5
JH
101GIT_AUTHOR_EMAIL=author@example.com
102GIT_AUTHOR_NAME='A U Thor'
29e55cd5
JH
103GIT_COMMITTER_EMAIL=committer@example.com
104GIT_COMMITTER_NAME='C O Mitter'
8d0fc48f 105GIT_MERGE_VERBOSITY=5
f8246281
JH
106GIT_MERGE_AUTOEDIT=no
107export GIT_MERGE_VERBOSITY GIT_MERGE_AUTOEDIT
29e55cd5
JH
108export GIT_AUTHOR_EMAIL GIT_AUTHOR_NAME
109export GIT_COMMITTER_EMAIL GIT_COMMITTER_NAME
d33738d7 110export EDITOR
e1970ce4 111
5d9fc888
TG
112if test -n "${TEST_GIT_INDEX_VERSION:+isset}"
113then
114 GIT_INDEX_VERSION="$TEST_GIT_INDEX_VERSION"
115 export GIT_INDEX_VERSION
116fi
117
a731fa91
EP
118# Add libc MALLOC and MALLOC_PERTURB test
119# only if we are not executing the test with valgrind
1b3185fc 120if expr " $GIT_TEST_OPTS " : ".* --valgrind " >/dev/null ||
ee1431bf 121 test -n "$TEST_NO_MALLOC_CHECK"
1b3185fc
JH
122then
123 setup_malloc_check () {
124 : nothing
125 }
126 teardown_malloc_check () {
127 : nothing
128 }
129else
130 setup_malloc_check () {
131 MALLOC_CHECK_=3 MALLOC_PERTURB_=165
132 export MALLOC_CHECK_ MALLOC_PERTURB_
133 }
134 teardown_malloc_check () {
135 unset MALLOC_CHECK_ MALLOC_PERTURB_
136 }
137fi
a731fa91 138
886a3907
JH
139# Protect ourselves from common misconfiguration to export
140# CDPATH into the environment
141unset CDPATH
142
5565f47c 143unset GREP_OPTIONS
ac001282 144unset UNZIP
5565f47c 145
3d5c0cc9 146case $(echo $GIT_TRACE |tr "[A-Z]" "[a-z]") in
1c0cc756
RJ
1471|2|true)
148 echo "* warning: Some tests will not work if GIT_TRACE" \
149 "is set as to trace on STDERR ! *"
150 echo "* warning: Please set GIT_TRACE to something" \
151 "other than 1, 2 or true ! *"
152 ;;
6ce4e61f
CC
153esac
154
cd3c095c
JH
155# Convenience
156#
157# A regexp to match 5 and 40 hexdigits
158_x05='[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
159_x40="$_x05$_x05$_x05$_x05$_x05$_x05$_x05$_x05"
160
3749fde5
JH
161# Zero SHA-1
162_z40=0000000000000000000000000000000000000000
163
3f4ab627
JH
164# Line feed
165LF='
166'
167
342e9ef2
TR
168export _x05 _x40 _z40 LF
169
e1970ce4
JH
170# Each test should start with something like this, after copyright notices:
171#
172# test_description='Description of this test...
173# This test checks if command xyzzy does the right thing...
174# '
175# . ./test-lib.sh
c2116a17
JH
176[ "x$ORIGINAL_TERM" != "xdumb" ] && (
177 TERM=$ORIGINAL_TERM &&
178 export TERM &&
179 [ -t 1 ] &&
180 tput bold >/dev/null 2>&1 &&
181 tput setaf 1 >/dev/null 2>&1 &&
182 tput sgr0 >/dev/null 2>&1
183 ) &&
55db1df0 184 color=t
e1970ce4 185
e1970ce4
JH
186while test "$#" -ne 0
187do
188 case "$1" in
189 -d|--d|--de|--deb|--debu|--debug)
190 debug=t; shift ;;
886856ab
JH
191 -i|--i|--im|--imm|--imme|--immed|--immedi|--immedia|--immediat|--immediate)
192 immediate=t; shift ;;
5e2c08c6 193 -l|--l|--lo|--lon|--long|--long-|--long-t|--long-te|--long-tes|--long-test|--long-tests)
91e80b98 194 GIT_TEST_LONG=t; export GIT_TEST_LONG; shift ;;
0445e6f0
IB
195 -r)
196 shift; test "$#" -ne 0 || {
197 echo 'error: -r requires an argument' >&2;
198 exit 1;
199 }
200 run_list=$1; shift ;;
201 --run=*)
202 run_list=$(expr "z$1" : 'z[^=]*=\(.*\)'); shift ;;
e1970ce4 203 -h|--h|--he|--hel|--help)
570f3226 204 help=t; shift ;;
e1970ce4
JH
205 -v|--v|--ve|--ver|--verb|--verbo|--verbos|--verbose)
206 verbose=t; shift ;;
ff09af3f
TR
207 --verbose-only=*)
208 verbose_only=$(expr "z$1" : 'z[^=]*=\(.*\)')
209 shift ;;
1ece1274 210 -q|--q|--qu|--qui|--quie|--quiet)
092c4334
ÆAB
211 # Ignore --quiet under a TAP::Harness. Saying how many tests
212 # passed without the ok/not ok details is always an error.
213 test -z "$HARNESS_ACTIVE" && quiet=t; shift ;;
e4597aae
MO
214 --with-dashes)
215 with_dashes=t; shift ;;
55db1df0 216 --no-color)
faa4bc35 217 color=; shift ;;
4e1be63c 218 --va|--val|--valg|--valgr|--valgri|--valgrin|--valgrind)
952af351
TR
219 valgrind=memcheck
220 shift ;;
221 --valgrind=*)
222 valgrind=$(expr "z$1" : 'z[^=]*=\(.*\)')
223 shift ;;
5dfc368f
TR
224 --valgrind-only=*)
225 valgrind_only=$(expr "z$1" : 'z[^=]*=\(.*\)')
226 shift ;;
44138559
JS
227 --tee)
228 shift ;; # was handled already
f423ef5f
JK
229 --root=*)
230 root=$(expr "z$1" : 'z[^=]*=\(.*\)')
231 shift ;;
e1970ce4 232 *)
1f729dca 233 echo "error: unknown test option '$1'" >&2; exit 1 ;;
e1970ce4
JH
234 esac
235done
236
26a07309 237if test -n "$valgrind_only"
5dfc368f
TR
238then
239 test -z "$valgrind" && valgrind=memcheck
240 test -z "$verbose" && verbose_only="$valgrind_only"
241elif test -n "$valgrind"
242then
243 verbose=t
244fi
952af351 245
1c0cc756
RJ
246if test -n "$color"
247then
55db1df0 248 say_color () {
c2116a17
JH
249 (
250 TERM=$ORIGINAL_TERM
251 export TERM
55db1df0 252 case "$1" in
1c0cc756
RJ
253 error)
254 tput bold; tput setaf 1;; # bold red
255 skip)
b8fc855a 256 tput setaf 4;; # blue
e8e51955
AS
257 warn)
258 tput setaf 3;; # brown/yellow
1c0cc756 259 pass)
0a6d4751 260 tput setaf 2;; # green
1c0cc756 261 info)
0a6d4751 262 tput setaf 6;; # cyan
1c0cc756
RJ
263 *)
264 test -n "$quiet" && return;;
55db1df0
PH
265 esac
266 shift
5099b99d 267 printf "%s" "$*"
55db1df0 268 tput sgr0
b8eecafd 269 echo
c2116a17 270 )
55db1df0
PH
271 }
272else
273 say_color() {
1ece1274 274 test -z "$1" && test -n "$quiet" && return
55db1df0 275 shift
7bc0911d 276 printf "%s\n" "$*"
55db1df0
PH
277 }
278fi
279
280error () {
281 say_color error "error: $*"
6e7b5aaf 282 GIT_EXIT_OK=t
55db1df0
PH
283 exit 1
284}
285
286say () {
287 say_color info "$*"
288}
289
570f3226
MB
290test "${test_description}" != "" ||
291error "Test script did not set test_description."
292
293if test "$help" = "t"
294then
cb1aefda 295 printf '%s\n' "$test_description"
570f3226
MB
296 exit 0
297fi
298
4d9d62fa 299exec 5>&1
781f76b1 300exec 6<&0
e1970ce4
JH
301if test "$verbose" = "t"
302then
303 exec 4>&2 3>&1
304else
305 exec 4>/dev/null 3>/dev/null
306fi
307
308test_failure=0
309test_count=0
41ac414e
JH
310test_fixed=0
311test_broken=0
2d84e9fb 312test_success=0
e1970ce4 313
d998bd4a
ÆAB
314test_external_has_tap=0
315
faa4bc35 316die () {
6e7b5aaf
CB
317 code=$?
318 if test -n "$GIT_EXIT_OK"
319 then
320 exit $code
321 else
322 echo >&5 "FATAL: Unexpected exit with code $code"
323 exit 1
324 fi
faa4bc35
CB
325}
326
6e7b5aaf 327GIT_EXIT_OK=
35641310 328trap 'die' EXIT
41184273 329
12a29b1a
TR
330# The user-facing functions are loaded from a separate file so that
331# test_perf subshells can have them too
3c8f12c9 332. "$TEST_DIRECTORY/test-lib-functions.sh"
05236a5e 333
886856ab 334# You are not expected to call test_ok_ and test_failure_ directly, use
3fa36666 335# the test_expect_* functions instead.
886856ab
JH
336
337test_ok_ () {
d5d9de1b 338 test_success=$(($test_success + 1))
633fe50a 339 say_color "" "ok $test_count - $@"
e1970ce4
JH
340}
341
886856ab 342test_failure_ () {
d5d9de1b 343 test_failure=$(($test_failure + 1))
633fe50a 344 say_color error "not ok $test_count - $1"
bf0dd8a8 345 shift
cb1aefda 346 printf '%s\n' "$*" | sed -e 's/^/# /'
6e7b5aaf 347 test "$immediate" = "" || { GIT_EXIT_OK=t; exit 1; }
886856ab
JH
348}
349
41ac414e 350test_known_broken_ok_ () {
41ac414e 351 test_fixed=$(($test_fixed+1))
633fe50a 352 say_color error "ok $test_count - $@ # TODO known breakage vanished"
41ac414e
JH
353}
354
355test_known_broken_failure_ () {
41ac414e 356 test_broken=$(($test_broken+1))
633fe50a 357 say_color warn "not ok $test_count - $@ # TODO known breakage"
41ac414e 358}
886856ab
JH
359
360test_debug () {
8e832ebc 361 test "$debug" = "" || eval "$1"
e1970ce4
JH
362}
363
e6a6ddc9
TR
364match_pattern_list () {
365 arg="$1"
366 shift
367 test -z "$*" && return 1
368 for pattern_
369 do
370 case "$arg" in
371 $pattern_)
372 return 0
373 esac
374 done
375 return 1
376}
377
0445e6f0
IB
378match_test_selector_list () {
379 title="$1"
380 shift
381 arg="$1"
382 shift
383 test -z "$1" && return 0
384
385 # Both commas and whitespace are accepted as separators.
386 OLDIFS=$IFS
387 IFS=' ,'
388 set -- $1
389 IFS=$OLDIFS
390
391 # If the first selector is negative we include by default.
392 include=
393 case "$1" in
394 !*) include=t ;;
395 esac
396
397 for selector
398 do
399 orig_selector=$selector
400
401 positive=t
402 case "$selector" in
403 !*)
404 positive=
405 selector=${selector##?}
406 ;;
407 esac
408
409 test -z "$selector" && continue
410
411 case "$selector" in
412 *-*)
413 if expr "z${selector%%-*}" : "z[0-9]*[^0-9]" >/dev/null
414 then
415 echo "error: $title: invalid non-numeric in range" \
416 "start: '$orig_selector'" >&2
417 exit 1
418 fi
419 if expr "z${selector#*-}" : "z[0-9]*[^0-9]" >/dev/null
420 then
421 echo "error: $title: invalid non-numeric in range" \
422 "end: '$orig_selector'" >&2
423 exit 1
424 fi
425 ;;
426 *)
427 if expr "z$selector" : "z[0-9]*[^0-9]" >/dev/null
428 then
429 echo "error: $title: invalid non-numeric in test" \
430 "selector: '$orig_selector'" >&2
431 exit 1
432 fi
433 esac
434
435 # Short cut for "obvious" cases
436 test -z "$include" && test -z "$positive" && continue
437 test -n "$include" && test -n "$positive" && continue
438
439 case "$selector" in
440 -*)
441 if test $arg -le ${selector#-}
442 then
443 include=$positive
444 fi
445 ;;
446 *-)
447 if test $arg -ge ${selector%-}
448 then
449 include=$positive
450 fi
451 ;;
452 *-*)
453 if test ${selector%%-*} -le $arg \
454 && test $arg -le ${selector#*-}
455 then
456 include=$positive
457 fi
458 ;;
459 *)
460 if test $arg -eq $selector
461 then
462 include=$positive
463 fi
464 ;;
465 esac
466 done
467
468 test -n "$include"
469}
470
ff09af3f
TR
471maybe_teardown_verbose () {
472 test -z "$verbose_only" && return
473 exec 4>/dev/null 3>/dev/null
474 verbose=
475}
476
477last_verbose=t
478maybe_setup_verbose () {
479 test -z "$verbose_only" && return
26a07309 480 if match_pattern_list $test_count $verbose_only
ff09af3f
TR
481 then
482 exec 4>&2 3>&1
483 # Emit a delimiting blank line when going from
484 # non-verbose to verbose. Within verbose mode the
485 # delimiter is printed by test_expect_*. The choice
486 # of the initial $last_verbose is such that before
487 # test 1, we do not print it.
488 test -z "$last_verbose" && echo >&3 ""
489 verbose=t
490 else
491 exec 4>/dev/null 3>/dev/null
492 verbose=
493 fi
494 last_verbose=$verbose
495}
496
5dfc368f
TR
497maybe_teardown_valgrind () {
498 test -z "$GIT_VALGRIND" && return
499 GIT_VALGRIND_ENABLED=
500}
501
502maybe_setup_valgrind () {
503 test -z "$GIT_VALGRIND" && return
26a07309 504 if test -z "$valgrind_only"
5dfc368f
TR
505 then
506 GIT_VALGRIND_ENABLED=t
507 return
508 fi
509 GIT_VALGRIND_ENABLED=
510 if match_pattern_list $test_count $valgrind_only
511 then
512 GIT_VALGRIND_ENABLED=t
513 fi
514}
515
a7c58f28
JN
516test_eval_ () {
517 # This is a separate function because some tests use
518 # "return" to end a test_expect_success block early.
781f76b1 519 eval </dev/null >&3 2>&4 "$*"
a7c58f28
JN
520}
521
4d9d62fa 522test_run_ () {
b6b0afdc 523 test_cleanup=:
b586744a 524 expecting_failure=$2
a57397b0 525 setup_malloc_check
a7c58f28 526 test_eval_ "$1"
b6b0afdc 527 eval_ret=$?
a57397b0 528 teardown_malloc_check
b586744a
JH
529
530 if test -z "$immediate" || test $eval_ret = 0 || test -n "$expecting_failure"
531 then
1b3185fc 532 setup_malloc_check
a7c58f28 533 test_eval_ "$test_cleanup"
1b3185fc 534 teardown_malloc_check
b586744a 535 fi
1c0cc756
RJ
536 if test "$verbose" = "t" && test -n "$HARNESS_ACTIVE"
537 then
57e1538a
ÆAB
538 echo ""
539 fi
aa0bcf96 540 return "$eval_ret"
4d9d62fa
PR
541}
542
ae75342c 543test_start_ () {
8586f98b 544 test_count=$(($test_count+1))
ff09af3f 545 maybe_setup_verbose
5dfc368f 546 maybe_setup_valgrind
ae75342c
TR
547}
548
549test_finish_ () {
550 echo >&3 ""
5dfc368f 551 maybe_teardown_valgrind
ff09af3f 552 maybe_teardown_verbose
ae75342c
TR
553}
554
555test_skip () {
04ece593 556 to_skip=
ef2ac68d 557 skipped_reason=
e6a6ddc9
TR
558 if match_pattern_list $this_test.$test_count $GIT_SKIP_TESTS
559 then
560 to_skip=t
ef2ac68d 561 skipped_reason="GIT_SKIP_TESTS"
e6a6ddc9 562 fi
05236a5e
JN
563 if test -z "$to_skip" && test -n "$test_prereq" &&
564 ! test_have_prereq "$test_prereq"
a7bb3940
JS
565 then
566 to_skip=t
ef2ac68d 567
07431fc8 568 of_prereq=
05236a5e 569 if test "$missing_prereq" != "$test_prereq"
07431fc8 570 then
05236a5e 571 of_prereq=" of $test_prereq"
07431fc8 572 fi
ef2ac68d
IB
573 skipped_reason="missing $missing_prereq${of_prereq}"
574 fi
0445e6f0
IB
575 if test -z "$to_skip" && test -n "$run_list" &&
576 ! match_test_selector_list '--run' $test_count "$run_list"
577 then
578 to_skip=t
579 skipped_reason="--run"
580 fi
07431fc8 581
ef2ac68d
IB
582 case "$to_skip" in
583 t)
633fe50a 584 say_color skip >&3 "skipping test: $@"
ef2ac68d 585 say_color skip "ok $test_count # skip $1 ($skipped_reason)"
04ece593
JH
586 : true
587 ;;
588 *)
589 false
590 ;;
591 esac
592}
593
342e9ef2
TR
594# stub; perf-lib overrides it
595test_at_end_hook_ () {
596 :
597}
598
e1970ce4 599test_done () {
6e7b5aaf 600 GIT_EXIT_OK=t
2d84e9fb 601
1c0cc756
RJ
602 if test -z "$HARNESS_ACTIVE"
603 then
342e9ef2 604 test_results_dir="$TEST_OUTPUT_DIRECTORY/test-results"
8ef1abe5 605 mkdir -p "$test_results_dir"
dd78478f
FC
606 base=${0##*/}
607 test_results_path="$test_results_dir/${base%.sh}-$$.counts"
8ef1abe5 608
c54e6be7
ML
609 cat >>"$test_results_path" <<-EOF
610 total $test_count
611 success $test_success
612 fixed $test_fixed
613 broken $test_broken
614 failed $test_failure
615
616 EOF
8ef1abe5 617 fi
41ac414e
JH
618
619 if test "$test_fixed" != 0
620 then
633fe50a 621 say_color error "# $test_fixed known breakage(s) vanished; please update test(s)"
41ac414e
JH
622 fi
623 if test "$test_broken" != 0
624 then
633fe50a 625 say_color warn "# still have $test_broken known breakage(s)"
b73d9a23
AS
626 fi
627 if test "$test_broken" != 0 || test "$test_fixed" != 0
628 then
629 test_remaining=$(( $test_count - $test_broken - $test_fixed ))
630 msg="remaining $test_remaining test(s)"
11d54b8b 631 else
b73d9a23 632 test_remaining=$test_count
11d54b8b 633 msg="$test_count test(s)"
41ac414e 634 fi
e1970ce4 635 case "$test_failure" in
10b94e28 636 0)
5099b99d 637 # Maybe print SKIP message
bf4b7219
RJ
638 if test -n "$skip_all" && test $test_count -gt 0
639 then
640 error "Can't use skip_all after running some tests"
641 fi
5099b99d
ÆAB
642 [ -z "$skip_all" ] || skip_all=" # SKIP $skip_all"
643
1c0cc756
RJ
644 if test $test_external_has_tap -eq 0
645 then
b73d9a23 646 if test $test_remaining -gt 0
d87bd7c1 647 then
633fe50a 648 say_color pass "# passed all $msg"
d87bd7c1 649 fi
633fe50a 650 say "1..$test_count$skip_all"
d998bd4a 651 fi
abc5d372
JS
652
653 test -d "$remove_trash" &&
654 cd "$(dirname "$remove_trash")" &&
655 rm -rf "$(basename "$remove_trash")"
656
342e9ef2
TR
657 test_at_end_hook_
658
e1970ce4
JH
659 exit 0 ;;
660
661 *)
1c0cc756
RJ
662 if test $test_external_has_tap -eq 0
663 then
633fe50a
TR
664 say_color error "# failed $test_failure among $msg"
665 say "1..$test_count"
d998bd4a 666 fi
5099b99d 667
e1970ce4
JH
668 exit 1 ;;
669
670 esac
671}
672
e4597aae 673if test -n "$valgrind"
4e1be63c 674then
4e1be63c
JS
675 make_symlink () {
676 test -h "$2" &&
677 test "$1" = "$(readlink "$2")" || {
678 # be super paranoid
679 if mkdir "$2".lock
680 then
681 rm -f "$2" &&
682 ln -s "$1" "$2" &&
683 rm -r "$2".lock
684 else
685 while test -d "$2".lock
686 do
687 say "Waiting for lock on $2."
688 sleep 1
689 done
690 fi
691 }
692 }
693
694 make_valgrind_symlink () {
36bfb0e5 695 # handle only executables, unless they are shell libraries that
11d62145 696 # need to be in the exec-path.
36bfb0e5 697 test -x "$1" ||
11d62145 698 test "# " = "$(head -c 2 <"$1")" ||
36bfb0e5 699 return;
4e1be63c
JS
700
701 base=$(basename "$1")
6cec5c68 702 symlink_target=$GIT_BUILD_DIR/$base
4e1be63c
JS
703 # do not override scripts
704 if test -x "$symlink_target" &&
705 test ! -d "$symlink_target" &&
706 test "#!" != "$(head -c 2 < "$symlink_target")"
707 then
708 symlink_target=../valgrind.sh
709 fi
efd92ffd
JS
710 case "$base" in
711 *.sh|*.perl)
712 symlink_target=../unprocessed-script
713 esac
4e1be63c
JS
714 # create the link, or replace it if it is out of date
715 make_symlink "$symlink_target" "$GIT_VALGRIND/bin/$base" || exit
716 }
717
26a07309
TR
718 # override all git executables in TEST_DIRECTORY/..
719 GIT_VALGRIND=$TEST_DIRECTORY/valgrind
720 mkdir -p "$GIT_VALGRIND"/bin
721 for file in $GIT_BUILD_DIR/git* $GIT_BUILD_DIR/test-*
722 do
723 make_valgrind_symlink $file
724 done
725 # special-case the mergetools loadables
726 make_symlink "$GIT_BUILD_DIR"/mergetools "$GIT_VALGRIND/bin/mergetools"
727 OLDIFS=$IFS
728 IFS=:
729 for path in $PATH
730 do
731 ls "$path"/git-* 2> /dev/null |
732 while read file
ad0e6233 733 do
26a07309 734 make_valgrind_symlink "$file"
ad0e6233 735 done
26a07309
TR
736 done
737 IFS=$OLDIFS
4e1be63c
JS
738 PATH=$GIT_VALGRIND/bin:$PATH
739 GIT_EXEC_PATH=$GIT_VALGRIND/bin
740 export GIT_VALGRIND
952af351
TR
741 GIT_VALGRIND_MODE="$valgrind"
742 export GIT_VALGRIND_MODE
5dfc368f 743 GIT_VALGRIND_ENABLED=t
26a07309 744 test -n "$valgrind_only" && GIT_VALGRIND_ENABLED=
5dfc368f 745 export GIT_VALGRIND_ENABLED
1c0cc756
RJ
746elif test -n "$GIT_TEST_INSTALLED"
747then
e4597aae
MO
748 GIT_EXEC_PATH=$($GIT_TEST_INSTALLED/git --exec-path) ||
749 error "Cannot run git from $GIT_TEST_INSTALLED."
6cec5c68 750 PATH=$GIT_TEST_INSTALLED:$GIT_BUILD_DIR:$PATH
e4597aae
MO
751 GIT_EXEC_PATH=${GIT_TEST_EXEC_PATH:-$GIT_EXEC_PATH}
752else # normal case, use ../bin-wrappers only unless $with_dashes:
6cec5c68 753 git_bin_dir="$GIT_BUILD_DIR/bin-wrappers"
1c0cc756
RJ
754 if ! test -x "$git_bin_dir/git"
755 then
756 if test -z "$with_dashes"
757 then
e4597aae
MO
758 say "$git_bin_dir/git is not executable; using GIT_EXEC_PATH"
759 fi
760 with_dashes=t
761 fi
762 PATH="$git_bin_dir:$PATH"
6cec5c68 763 GIT_EXEC_PATH=$GIT_BUILD_DIR
1c0cc756
RJ
764 if test -n "$with_dashes"
765 then
6cec5c68 766 PATH="$GIT_BUILD_DIR:$PATH"
e4597aae 767 fi
4e1be63c 768fi
6cec5c68 769GIT_TEMPLATE_DIR="$GIT_BUILD_DIR"/templates/blt
8bfa6bd6 770GIT_CONFIG_NOSYSTEM=1
3c995beb 771GIT_ATTR_NOSYSTEM=1
8f323c00 772export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG_NOSYSTEM GIT_ATTR_NOSYSTEM
49ccb087 773
5e87eae9
JH
774if test -z "$GIT_TEST_CMP"
775then
776 if test -n "$GIT_TEST_CMP_USE_COPIED_CONTEXT"
777 then
778 GIT_TEST_CMP="$DIFF -c"
779 else
780 GIT_TEST_CMP="$DIFF -u"
781 fi
782fi
783
6cec5c68 784GITPERLLIB="$GIT_BUILD_DIR"/perl/blib/lib:"$GIT_BUILD_DIR"/perl/blib/arch/auto/Git
6fcca938 785export GITPERLLIB
6cec5c68 786test -d "$GIT_BUILD_DIR"/templates/blt || {
eea42069
JH
787 error "You haven't built things yet, have you?"
788}
e1970ce4 789
1c0cc756
RJ
790if ! test -x "$GIT_BUILD_DIR"/test-chmtime
791then
56cf9806
EW
792 echo >&2 'You need to build test-chmtime:'
793 echo >&2 'Run "make test-chmtime" in the source (toplevel) directory'
794 exit 1
795fi
796
e1970ce4 797# Test repository
002d4ce8
JK
798TRASH_DIRECTORY="trash directory.$(basename "$0" .sh)"
799test -n "$root" && TRASH_DIRECTORY="$root/$TRASH_DIRECTORY"
800case "$TRASH_DIRECTORY" in
801/*) ;; # absolute path is good
802 *) TRASH_DIRECTORY="$TEST_OUTPUT_DIRECTORY/$TRASH_DIRECTORY" ;;
f423ef5f 803esac
91c8b825 804test ! -z "$debug" || remove_trash=$TRASH_DIRECTORY
38b074de 805rm -fr "$TRASH_DIRECTORY" || {
6e7b5aaf 806 GIT_EXIT_OK=t
8d14ac94
JH
807 echo >&5 "FATAL: Cannot prepare test area"
808 exit 1
809}
810
90cff968
AR
811HOME="$TRASH_DIRECTORY"
812export HOME
813
1c0cc756
RJ
814if test -z "$TEST_NO_CREATE_REPO"
815then
38b074de 816 test_create_repo "$TRASH_DIRECTORY"
342e9ef2 817else
38b074de 818 mkdir -p "$TRASH_DIRECTORY"
342e9ef2 819fi
1bd9c648
LW
820# Use -P to resolve symlinks in our working directory so that the cwd
821# in subprocesses like git equals our $PWD (for pathname comparisons).
38b074de 822cd -P "$TRASH_DIRECTORY" || exit 1
04ece593 823
d5d9de1b
JS
824this_test=${0##*/}
825this_test=${this_test%%-*}
e6a6ddc9
TR
826if match_pattern_list "$this_test" $GIT_SKIP_TESTS
827then
828 say_color info >&3 "skipping test $this_test altogether"
829 skip_all="skip all tests in $this_test"
830 test_done
831fi
f17e9fbb 832
8648732e
BC
833# Provide an implementation of the 'yes' utility
834yes () {
835 if test $# = 0
836 then
837 y=y
838 else
839 y="$*"
840 fi
841
842 while echo "$y"
843 do
844 :
845 done
846}
847
f17e9fbb
JS
848# Fix some commands on Windows
849case $(uname -s) in
850*MINGW*)
851 # Windows has its own (incompatible) sort and find
852 sort () {
853 /usr/bin/sort "$@"
854 }
855 find () {
856 /usr/bin/find "$@"
857 }
5397ea31
JS
858 sum () {
859 md5sum "$@"
860 }
4114156a
JS
861 # git sees Windows-style pwd
862 pwd () {
863 builtin pwd -W
864 }
ee9fb68c 865 # no POSIX permissions
6fd1106a 866 # backslashes in pathspec are converted to '/'
fb9a2bea 867 # exec does not inherit the PID
a94114ad 868 test_set_prereq MINGW
cfa96496 869 test_set_prereq NOT_CYGWIN
a31d0665 870 test_set_prereq SED_STRIPS_CR
97669eed 871 test_set_prereq GREP_STRIPS_CR
4d715ac0 872 GIT_TEST_CMP=mingw_test_cmp
a31d0665
RJ
873 ;;
874*CYGWIN*)
875 test_set_prereq POSIXPERM
a31d0665
RJ
876 test_set_prereq EXECKEEPSPID
877 test_set_prereq NOT_MINGW
cfa96496 878 test_set_prereq CYGWIN
a31d0665 879 test_set_prereq SED_STRIPS_CR
97669eed 880 test_set_prereq GREP_STRIPS_CR
ee9fb68c
JS
881 ;;
882*)
883 test_set_prereq POSIXPERM
6fd1106a 884 test_set_prereq BSLASHPSPEC
fb9a2bea 885 test_set_prereq EXECKEEPSPID
3ba9ba8f 886 test_set_prereq NOT_MINGW
cfa96496 887 test_set_prereq NOT_CYGWIN
f17e9fbb
JS
888 ;;
889esac
704a3143 890
b082687c 891( COLUMNS=1 && test $COLUMNS = 1 ) && test_set_prereq COLUMNS_CAN_BE_1
1b19ccd2 892test -z "$NO_PERL" && test_set_prereq PERL
d4e1b47a 893test -z "$NO_PYTHON" && test_set_prereq PYTHON
8f852ce6 894test -n "$USE_LIBPCRE" && test_set_prereq LIBPCRE
5e9637c6 895test -z "$NO_GETTEXT" && test_set_prereq GETTEXT
1b19ccd2 896
bb946bba 897# Can we rely on git's output in the C locale?
30955229
JN
898if test -n "$GETTEXT_POISON"
899then
900 GIT_GETTEXT_POISON=YesPlease
901 export GIT_GETTEXT_POISON
5e9637c6 902 test_set_prereq GETTEXT_POISON
30955229
JN
903else
904 test_set_prereq C_LOCALE_OUTPUT
905fi
bb946bba 906
cabdee2c
JH
907# Use this instead of test_cmp to compare files that contain expected and
908# actual output from git commands that can be translated. When running
909# under GETTEXT_POISON this pretends that the command produced expected
910# results.
911test_i18ncmp () {
912 test -n "$GETTEXT_POISON" || test_cmp "$@"
913}
914
127df8c6
JH
915# Use this instead of "grep expected-string actual" to see if the
916# output from a git command that can be translated either contains an
917# expected string, or does not contain an unwanted one. When running
918# under GETTEXT_POISON this pretends that the command produced expected
919# results.
920test_i18ngrep () {
921 if test -n "$GETTEXT_POISON"
922 then
923 : # pretend success
924 elif test "x!" = "x$1"
925 then
926 shift
927 ! grep "$@"
928 else
929 grep "$@"
930 fi
931}
932
20073274
AS
933test_lazy_prereq PIPE '
934 # test whether the filesystem supports FIFOs
9443605b
ML
935 case $(uname -s) in
936 CYGWIN*)
937 false
938 ;;
939 *)
940 rm -f testfifo && mkfifo testfifo
941 ;;
942 esac
20073274
AS
943'
944
04083f27
JH
945test_lazy_prereq SYMLINKS '
946 # test whether the filesystem supports symbolic links
947 ln -s x y && test -h y
948'
c91cfd19 949
b018c735
JN
950test_lazy_prereq FILEMODE '
951 test "$(git config --bool core.filemode)" = true
952'
953
ac39aa61
MG
954test_lazy_prereq CASE_INSENSITIVE_FS '
955 echo good >CamelCase &&
956 echo bad >camelcase &&
957 test "$(cat CamelCase)" != good
958'
959
5b0b5dd4
MG
960test_lazy_prereq UTF8_NFD_TO_NFC '
961 # check whether FS converts nfd unicode to nfc
962 auml=$(printf "\303\244")
963 aumlcdiar=$(printf "\141\314\210")
964 >"$auml" &&
965 case "$(echo *)" in
966 "$aumlcdiar")
967 true ;;
968 *)
969 false ;;
970 esac
971'
972
09feffb6
JK
973test_lazy_prereq AUTOIDENT '
974 sane_unset GIT_AUTHOR_NAME &&
975 sane_unset GIT_AUTHOR_EMAIL &&
976 git var GIT_AUTHOR_IDENT
977'
978
c91cfd19
ÆAB
979# When the tests are run as root, permission tests will report that
980# things are writable when they shouldn't be.
981test -w / || test_set_prereq SANITY
f838ce58
JK
982
983GIT_UNZIP=${GIT_UNZIP:-unzip}
984test_lazy_prereq UNZIP '
985 "$GIT_UNZIP" -v
986 test $? -ne 127
987'