Post 2.3 cyce (batch #10)
[git/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
124647c4
KB
112# Tests using GIT_TRACE typically don't want <timestamp> <file>:<line> output
113GIT_TRACE_BARE=1
114export GIT_TRACE_BARE
115
5d9fc888
TG
116if test -n "${TEST_GIT_INDEX_VERSION:+isset}"
117then
118 GIT_INDEX_VERSION="$TEST_GIT_INDEX_VERSION"
119 export GIT_INDEX_VERSION
120fi
121
a731fa91
EP
122# Add libc MALLOC and MALLOC_PERTURB test
123# only if we are not executing the test with valgrind
1b3185fc 124if expr " $GIT_TEST_OPTS " : ".* --valgrind " >/dev/null ||
ee1431bf 125 test -n "$TEST_NO_MALLOC_CHECK"
1b3185fc
JH
126then
127 setup_malloc_check () {
128 : nothing
129 }
130 teardown_malloc_check () {
131 : nothing
132 }
133else
134 setup_malloc_check () {
135 MALLOC_CHECK_=3 MALLOC_PERTURB_=165
136 export MALLOC_CHECK_ MALLOC_PERTURB_
137 }
138 teardown_malloc_check () {
139 unset MALLOC_CHECK_ MALLOC_PERTURB_
140 }
141fi
a731fa91 142
b0f4c908
JK
143: ${ASAN_OPTIONS=detect_leaks=0}
144export ASAN_OPTIONS
145
886a3907
JH
146# Protect ourselves from common misconfiguration to export
147# CDPATH into the environment
148unset CDPATH
149
5565f47c 150unset GREP_OPTIONS
ac001282 151unset UNZIP
5565f47c 152
3d5c0cc9 153case $(echo $GIT_TRACE |tr "[A-Z]" "[a-z]") in
1c0cc756
RJ
1541|2|true)
155 echo "* warning: Some tests will not work if GIT_TRACE" \
156 "is set as to trace on STDERR ! *"
157 echo "* warning: Please set GIT_TRACE to something" \
158 "other than 1, 2 or true ! *"
159 ;;
6ce4e61f
CC
160esac
161
cd3c095c
JH
162# Convenience
163#
164# A regexp to match 5 and 40 hexdigits
165_x05='[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
166_x40="$_x05$_x05$_x05$_x05$_x05$_x05$_x05$_x05"
167
3749fde5
JH
168# Zero SHA-1
169_z40=0000000000000000000000000000000000000000
170
3f4ab627
JH
171# Line feed
172LF='
173'
174
a42643aa
JK
175# UTF-8 ZERO WIDTH NON-JOINER, which HFS+ ignores
176# when case-folding filenames
177u200c=$(printf '\342\200\214')
178
179export _x05 _x40 _z40 LF u200c
342e9ef2 180
e1970ce4
JH
181# Each test should start with something like this, after copyright notices:
182#
183# test_description='Description of this test...
184# This test checks if command xyzzy does the right thing...
185# '
186# . ./test-lib.sh
e1970ce4 187
102fc80d 188unset color
e1970ce4
JH
189while test "$#" -ne 0
190do
191 case "$1" in
192 -d|--d|--de|--deb|--debu|--debug)
193 debug=t; shift ;;
886856ab
JH
194 -i|--i|--im|--imm|--imme|--immed|--immedi|--immedia|--immediat|--immediate)
195 immediate=t; shift ;;
5e2c08c6 196 -l|--l|--lo|--lon|--long|--long-|--long-t|--long-te|--long-tes|--long-test|--long-tests)
91e80b98 197 GIT_TEST_LONG=t; export GIT_TEST_LONG; shift ;;
0445e6f0
IB
198 -r)
199 shift; test "$#" -ne 0 || {
200 echo 'error: -r requires an argument' >&2;
201 exit 1;
202 }
203 run_list=$1; shift ;;
204 --run=*)
205 run_list=$(expr "z$1" : 'z[^=]*=\(.*\)'); shift ;;
e1970ce4 206 -h|--h|--he|--hel|--help)
570f3226 207 help=t; shift ;;
e1970ce4
JH
208 -v|--v|--ve|--ver|--verb|--verbo|--verbos|--verbose)
209 verbose=t; shift ;;
ff09af3f
TR
210 --verbose-only=*)
211 verbose_only=$(expr "z$1" : 'z[^=]*=\(.*\)')
212 shift ;;
1ece1274 213 -q|--q|--qu|--qui|--quie|--quiet)
092c4334
ÆAB
214 # Ignore --quiet under a TAP::Harness. Saying how many tests
215 # passed without the ok/not ok details is always an error.
216 test -z "$HARNESS_ACTIVE" && quiet=t; shift ;;
e4597aae
MO
217 --with-dashes)
218 with_dashes=t; shift ;;
55db1df0 219 --no-color)
faa4bc35 220 color=; shift ;;
4e1be63c 221 --va|--val|--valg|--valgr|--valgri|--valgrin|--valgrind)
952af351
TR
222 valgrind=memcheck
223 shift ;;
224 --valgrind=*)
225 valgrind=$(expr "z$1" : 'z[^=]*=\(.*\)')
226 shift ;;
5dfc368f
TR
227 --valgrind-only=*)
228 valgrind_only=$(expr "z$1" : 'z[^=]*=\(.*\)')
229 shift ;;
44138559
JS
230 --tee)
231 shift ;; # was handled already
f423ef5f
JK
232 --root=*)
233 root=$(expr "z$1" : 'z[^=]*=\(.*\)')
234 shift ;;
a136f6d8
JK
235 -x)
236 trace=t
237 verbose=t
238 shift ;;
e1970ce4 239 *)
1f729dca 240 echo "error: unknown test option '$1'" >&2; exit 1 ;;
e1970ce4
JH
241 esac
242done
243
26a07309 244if test -n "$valgrind_only"
5dfc368f
TR
245then
246 test -z "$valgrind" && valgrind=memcheck
247 test -z "$verbose" && verbose_only="$valgrind_only"
248elif test -n "$valgrind"
249then
250 verbose=t
251fi
952af351 252
55db1df0
PH
253error () {
254 say_color error "error: $*"
6e7b5aaf 255 GIT_EXIT_OK=t
55db1df0
PH
256 exit 1
257}
258
259say () {
260 say_color info "$*"
261}
262
570f3226
MB
263test "${test_description}" != "" ||
264error "Test script did not set test_description."
265
266if test "$help" = "t"
267then
cb1aefda 268 printf '%s\n' "$test_description"
570f3226
MB
269 exit 0
270fi
271
4d9d62fa 272exec 5>&1
781f76b1 273exec 6<&0
e1970ce4
JH
274if test "$verbose" = "t"
275then
276 exec 4>&2 3>&1
277else
278 exec 4>/dev/null 3>/dev/null
279fi
280
281test_failure=0
282test_count=0
41ac414e
JH
283test_fixed=0
284test_broken=0
2d84e9fb 285test_success=0
e1970ce4 286
d998bd4a
ÆAB
287test_external_has_tap=0
288
faa4bc35 289die () {
6e7b5aaf
CB
290 code=$?
291 if test -n "$GIT_EXIT_OK"
292 then
293 exit $code
294 else
295 echo >&5 "FATAL: Unexpected exit with code $code"
296 exit 1
297 fi
faa4bc35
CB
298}
299
6e7b5aaf 300GIT_EXIT_OK=
35641310 301trap 'die' EXIT
41184273 302
12a29b1a
TR
303# The user-facing functions are loaded from a separate file so that
304# test_perf subshells can have them too
3c8f12c9 305. "$TEST_DIRECTORY/test-lib-functions.sh"
05236a5e 306
886856ab 307# You are not expected to call test_ok_ and test_failure_ directly, use
3fa36666 308# the test_expect_* functions instead.
886856ab
JH
309
310test_ok_ () {
d5d9de1b 311 test_success=$(($test_success + 1))
633fe50a 312 say_color "" "ok $test_count - $@"
e1970ce4
JH
313}
314
886856ab 315test_failure_ () {
d5d9de1b 316 test_failure=$(($test_failure + 1))
633fe50a 317 say_color error "not ok $test_count - $1"
bf0dd8a8 318 shift
cb1aefda 319 printf '%s\n' "$*" | sed -e 's/^/# /'
6e7b5aaf 320 test "$immediate" = "" || { GIT_EXIT_OK=t; exit 1; }
886856ab
JH
321}
322
41ac414e 323test_known_broken_ok_ () {
41ac414e 324 test_fixed=$(($test_fixed+1))
633fe50a 325 say_color error "ok $test_count - $@ # TODO known breakage vanished"
41ac414e
JH
326}
327
328test_known_broken_failure_ () {
41ac414e 329 test_broken=$(($test_broken+1))
633fe50a 330 say_color warn "not ok $test_count - $@ # TODO known breakage"
41ac414e 331}
886856ab
JH
332
333test_debug () {
8e832ebc 334 test "$debug" = "" || eval "$1"
e1970ce4
JH
335}
336
e6a6ddc9
TR
337match_pattern_list () {
338 arg="$1"
339 shift
340 test -z "$*" && return 1
341 for pattern_
342 do
343 case "$arg" in
344 $pattern_)
345 return 0
346 esac
347 done
348 return 1
349}
350
0445e6f0
IB
351match_test_selector_list () {
352 title="$1"
353 shift
354 arg="$1"
355 shift
356 test -z "$1" && return 0
357
358 # Both commas and whitespace are accepted as separators.
359 OLDIFS=$IFS
360 IFS=' ,'
361 set -- $1
362 IFS=$OLDIFS
363
364 # If the first selector is negative we include by default.
365 include=
366 case "$1" in
367 !*) include=t ;;
368 esac
369
370 for selector
371 do
372 orig_selector=$selector
373
374 positive=t
375 case "$selector" in
376 !*)
377 positive=
378 selector=${selector##?}
379 ;;
380 esac
381
382 test -z "$selector" && continue
383
384 case "$selector" in
385 *-*)
386 if expr "z${selector%%-*}" : "z[0-9]*[^0-9]" >/dev/null
387 then
388 echo "error: $title: invalid non-numeric in range" \
389 "start: '$orig_selector'" >&2
390 exit 1
391 fi
392 if expr "z${selector#*-}" : "z[0-9]*[^0-9]" >/dev/null
393 then
394 echo "error: $title: invalid non-numeric in range" \
395 "end: '$orig_selector'" >&2
396 exit 1
397 fi
398 ;;
399 *)
400 if expr "z$selector" : "z[0-9]*[^0-9]" >/dev/null
401 then
402 echo "error: $title: invalid non-numeric in test" \
403 "selector: '$orig_selector'" >&2
404 exit 1
405 fi
406 esac
407
408 # Short cut for "obvious" cases
409 test -z "$include" && test -z "$positive" && continue
410 test -n "$include" && test -n "$positive" && continue
411
412 case "$selector" in
413 -*)
414 if test $arg -le ${selector#-}
415 then
416 include=$positive
417 fi
418 ;;
419 *-)
420 if test $arg -ge ${selector%-}
421 then
422 include=$positive
423 fi
424 ;;
425 *-*)
426 if test ${selector%%-*} -le $arg \
427 && test $arg -le ${selector#*-}
428 then
429 include=$positive
430 fi
431 ;;
432 *)
433 if test $arg -eq $selector
434 then
435 include=$positive
436 fi
437 ;;
438 esac
439 done
440
441 test -n "$include"
442}
443
ff09af3f
TR
444maybe_teardown_verbose () {
445 test -z "$verbose_only" && return
446 exec 4>/dev/null 3>/dev/null
447 verbose=
448}
449
450last_verbose=t
451maybe_setup_verbose () {
452 test -z "$verbose_only" && return
26a07309 453 if match_pattern_list $test_count $verbose_only
ff09af3f
TR
454 then
455 exec 4>&2 3>&1
456 # Emit a delimiting blank line when going from
457 # non-verbose to verbose. Within verbose mode the
458 # delimiter is printed by test_expect_*. The choice
459 # of the initial $last_verbose is such that before
460 # test 1, we do not print it.
461 test -z "$last_verbose" && echo >&3 ""
462 verbose=t
463 else
464 exec 4>/dev/null 3>/dev/null
465 verbose=
466 fi
467 last_verbose=$verbose
468}
469
5dfc368f
TR
470maybe_teardown_valgrind () {
471 test -z "$GIT_VALGRIND" && return
472 GIT_VALGRIND_ENABLED=
473}
474
475maybe_setup_valgrind () {
476 test -z "$GIT_VALGRIND" && return
26a07309 477 if test -z "$valgrind_only"
5dfc368f
TR
478 then
479 GIT_VALGRIND_ENABLED=t
480 return
481 fi
482 GIT_VALGRIND_ENABLED=
483 if match_pattern_list $test_count $valgrind_only
484 then
485 GIT_VALGRIND_ENABLED=t
486 fi
487}
488
a136f6d8
JK
489# This is a separate function because some tests use
490# "return" to end a test_expect_success block early
491# (and we want to make sure we run any cleanup like
492# "set +x").
493test_eval_inner_ () {
494 # Do not add anything extra (including LF) after '$*'
495 eval "
496 test \"$trace\" = t && set -x
497 $*"
498}
499
a7c58f28 500test_eval_ () {
a136f6d8
JK
501 # We run this block with stderr redirected to avoid extra cruft
502 # during a "-x" trace. Once in "set -x" mode, we cannot prevent
503 # the shell from printing the "set +x" to turn it off (nor the saving
504 # of $? before that). But we can make sure that the output goes to
505 # /dev/null.
506 #
507 # The test itself is run with stderr put back to &4 (so either to
508 # /dev/null, or to the original stderr if --verbose was used).
509 {
510 test_eval_inner_ "$@" </dev/null >&3 2>&4
511 test_eval_ret_=$?
512 if test "$trace" = t
513 then
514 set +x
515 if test "$test_eval_ret_" != 0
516 then
517 say_color error >&4 "error: last command exited with \$?=$test_eval_ret_"
518 fi
519 fi
520 } 2>/dev/null
521 return $test_eval_ret_
a7c58f28
JN
522}
523
4d9d62fa 524test_run_ () {
b6b0afdc 525 test_cleanup=:
b586744a 526 expecting_failure=$2
a57397b0 527 setup_malloc_check
a7c58f28 528 test_eval_ "$1"
b6b0afdc 529 eval_ret=$?
a57397b0 530 teardown_malloc_check
b586744a 531
a136f6d8
JK
532 if test -z "$immediate" || test $eval_ret = 0 ||
533 test -n "$expecting_failure" && test "$test_cleanup" != ":"
b586744a 534 then
1b3185fc 535 setup_malloc_check
a7c58f28 536 test_eval_ "$test_cleanup"
1b3185fc 537 teardown_malloc_check
b586744a 538 fi
1c0cc756
RJ
539 if test "$verbose" = "t" && test -n "$HARNESS_ACTIVE"
540 then
57e1538a
ÆAB
541 echo ""
542 fi
aa0bcf96 543 return "$eval_ret"
4d9d62fa
PR
544}
545
ae75342c 546test_start_ () {
8586f98b 547 test_count=$(($test_count+1))
ff09af3f 548 maybe_setup_verbose
5dfc368f 549 maybe_setup_valgrind
ae75342c
TR
550}
551
552test_finish_ () {
553 echo >&3 ""
5dfc368f 554 maybe_teardown_valgrind
ff09af3f 555 maybe_teardown_verbose
ae75342c
TR
556}
557
558test_skip () {
04ece593 559 to_skip=
ef2ac68d 560 skipped_reason=
e6a6ddc9
TR
561 if match_pattern_list $this_test.$test_count $GIT_SKIP_TESTS
562 then
563 to_skip=t
ef2ac68d 564 skipped_reason="GIT_SKIP_TESTS"
e6a6ddc9 565 fi
05236a5e
JN
566 if test -z "$to_skip" && test -n "$test_prereq" &&
567 ! test_have_prereq "$test_prereq"
a7bb3940
JS
568 then
569 to_skip=t
ef2ac68d 570
07431fc8 571 of_prereq=
05236a5e 572 if test "$missing_prereq" != "$test_prereq"
07431fc8 573 then
05236a5e 574 of_prereq=" of $test_prereq"
07431fc8 575 fi
ef2ac68d
IB
576 skipped_reason="missing $missing_prereq${of_prereq}"
577 fi
0445e6f0
IB
578 if test -z "$to_skip" && test -n "$run_list" &&
579 ! match_test_selector_list '--run' $test_count "$run_list"
580 then
581 to_skip=t
582 skipped_reason="--run"
583 fi
07431fc8 584
ef2ac68d
IB
585 case "$to_skip" in
586 t)
633fe50a 587 say_color skip >&3 "skipping test: $@"
ef2ac68d 588 say_color skip "ok $test_count # skip $1 ($skipped_reason)"
04ece593
JH
589 : true
590 ;;
591 *)
592 false
593 ;;
594 esac
595}
596
342e9ef2
TR
597# stub; perf-lib overrides it
598test_at_end_hook_ () {
599 :
600}
601
e1970ce4 602test_done () {
6e7b5aaf 603 GIT_EXIT_OK=t
2d84e9fb 604
1c0cc756
RJ
605 if test -z "$HARNESS_ACTIVE"
606 then
342e9ef2 607 test_results_dir="$TEST_OUTPUT_DIRECTORY/test-results"
8ef1abe5 608 mkdir -p "$test_results_dir"
dd78478f
FC
609 base=${0##*/}
610 test_results_path="$test_results_dir/${base%.sh}-$$.counts"
8ef1abe5 611
c54e6be7
ML
612 cat >>"$test_results_path" <<-EOF
613 total $test_count
614 success $test_success
615 fixed $test_fixed
616 broken $test_broken
617 failed $test_failure
618
619 EOF
8ef1abe5 620 fi
41ac414e
JH
621
622 if test "$test_fixed" != 0
623 then
633fe50a 624 say_color error "# $test_fixed known breakage(s) vanished; please update test(s)"
41ac414e
JH
625 fi
626 if test "$test_broken" != 0
627 then
633fe50a 628 say_color warn "# still have $test_broken known breakage(s)"
b73d9a23
AS
629 fi
630 if test "$test_broken" != 0 || test "$test_fixed" != 0
631 then
632 test_remaining=$(( $test_count - $test_broken - $test_fixed ))
633 msg="remaining $test_remaining test(s)"
11d54b8b 634 else
b73d9a23 635 test_remaining=$test_count
11d54b8b 636 msg="$test_count test(s)"
41ac414e 637 fi
e1970ce4 638 case "$test_failure" in
10b94e28 639 0)
5099b99d 640 # Maybe print SKIP message
bf4b7219
RJ
641 if test -n "$skip_all" && test $test_count -gt 0
642 then
643 error "Can't use skip_all after running some tests"
644 fi
46f32a99 645 test -z "$skip_all" || skip_all=" # SKIP $skip_all"
5099b99d 646
1c0cc756
RJ
647 if test $test_external_has_tap -eq 0
648 then
b73d9a23 649 if test $test_remaining -gt 0
d87bd7c1 650 then
633fe50a 651 say_color pass "# passed all $msg"
d87bd7c1 652 fi
633fe50a 653 say "1..$test_count$skip_all"
d998bd4a 654 fi
abc5d372
JS
655
656 test -d "$remove_trash" &&
657 cd "$(dirname "$remove_trash")" &&
658 rm -rf "$(basename "$remove_trash")"
659
342e9ef2
TR
660 test_at_end_hook_
661
e1970ce4
JH
662 exit 0 ;;
663
664 *)
1c0cc756
RJ
665 if test $test_external_has_tap -eq 0
666 then
633fe50a
TR
667 say_color error "# failed $test_failure among $msg"
668 say "1..$test_count"
d998bd4a 669 fi
5099b99d 670
e1970ce4
JH
671 exit 1 ;;
672
673 esac
674}
675
e4597aae 676if test -n "$valgrind"
4e1be63c 677then
4e1be63c
JS
678 make_symlink () {
679 test -h "$2" &&
680 test "$1" = "$(readlink "$2")" || {
681 # be super paranoid
682 if mkdir "$2".lock
683 then
684 rm -f "$2" &&
685 ln -s "$1" "$2" &&
686 rm -r "$2".lock
687 else
688 while test -d "$2".lock
689 do
690 say "Waiting for lock on $2."
691 sleep 1
692 done
693 fi
694 }
695 }
696
697 make_valgrind_symlink () {
36bfb0e5 698 # handle only executables, unless they are shell libraries that
11d62145 699 # need to be in the exec-path.
36bfb0e5 700 test -x "$1" ||
11d62145 701 test "# " = "$(head -c 2 <"$1")" ||
36bfb0e5 702 return;
4e1be63c
JS
703
704 base=$(basename "$1")
6cec5c68 705 symlink_target=$GIT_BUILD_DIR/$base
4e1be63c
JS
706 # do not override scripts
707 if test -x "$symlink_target" &&
708 test ! -d "$symlink_target" &&
709 test "#!" != "$(head -c 2 < "$symlink_target")"
710 then
711 symlink_target=../valgrind.sh
712 fi
efd92ffd
JS
713 case "$base" in
714 *.sh|*.perl)
715 symlink_target=../unprocessed-script
716 esac
4e1be63c
JS
717 # create the link, or replace it if it is out of date
718 make_symlink "$symlink_target" "$GIT_VALGRIND/bin/$base" || exit
719 }
720
26a07309
TR
721 # override all git executables in TEST_DIRECTORY/..
722 GIT_VALGRIND=$TEST_DIRECTORY/valgrind
723 mkdir -p "$GIT_VALGRIND"/bin
724 for file in $GIT_BUILD_DIR/git* $GIT_BUILD_DIR/test-*
725 do
726 make_valgrind_symlink $file
727 done
728 # special-case the mergetools loadables
729 make_symlink "$GIT_BUILD_DIR"/mergetools "$GIT_VALGRIND/bin/mergetools"
730 OLDIFS=$IFS
731 IFS=:
732 for path in $PATH
733 do
734 ls "$path"/git-* 2> /dev/null |
735 while read file
ad0e6233 736 do
26a07309 737 make_valgrind_symlink "$file"
ad0e6233 738 done
26a07309
TR
739 done
740 IFS=$OLDIFS
4e1be63c
JS
741 PATH=$GIT_VALGRIND/bin:$PATH
742 GIT_EXEC_PATH=$GIT_VALGRIND/bin
743 export GIT_VALGRIND
952af351
TR
744 GIT_VALGRIND_MODE="$valgrind"
745 export GIT_VALGRIND_MODE
5dfc368f 746 GIT_VALGRIND_ENABLED=t
26a07309 747 test -n "$valgrind_only" && GIT_VALGRIND_ENABLED=
5dfc368f 748 export GIT_VALGRIND_ENABLED
1c0cc756
RJ
749elif test -n "$GIT_TEST_INSTALLED"
750then
e4597aae
MO
751 GIT_EXEC_PATH=$($GIT_TEST_INSTALLED/git --exec-path) ||
752 error "Cannot run git from $GIT_TEST_INSTALLED."
6cec5c68 753 PATH=$GIT_TEST_INSTALLED:$GIT_BUILD_DIR:$PATH
e4597aae
MO
754 GIT_EXEC_PATH=${GIT_TEST_EXEC_PATH:-$GIT_EXEC_PATH}
755else # normal case, use ../bin-wrappers only unless $with_dashes:
6cec5c68 756 git_bin_dir="$GIT_BUILD_DIR/bin-wrappers"
1c0cc756
RJ
757 if ! test -x "$git_bin_dir/git"
758 then
759 if test -z "$with_dashes"
760 then
e4597aae
MO
761 say "$git_bin_dir/git is not executable; using GIT_EXEC_PATH"
762 fi
763 with_dashes=t
764 fi
765 PATH="$git_bin_dir:$PATH"
6cec5c68 766 GIT_EXEC_PATH=$GIT_BUILD_DIR
1c0cc756
RJ
767 if test -n "$with_dashes"
768 then
6cec5c68 769 PATH="$GIT_BUILD_DIR:$PATH"
e4597aae 770 fi
4e1be63c 771fi
6cec5c68 772GIT_TEMPLATE_DIR="$GIT_BUILD_DIR"/templates/blt
8bfa6bd6 773GIT_CONFIG_NOSYSTEM=1
3c995beb 774GIT_ATTR_NOSYSTEM=1
8f323c00 775export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG_NOSYSTEM GIT_ATTR_NOSYSTEM
49ccb087 776
5e87eae9
JH
777if test -z "$GIT_TEST_CMP"
778then
779 if test -n "$GIT_TEST_CMP_USE_COPIED_CONTEXT"
780 then
781 GIT_TEST_CMP="$DIFF -c"
782 else
783 GIT_TEST_CMP="$DIFF -u"
784 fi
785fi
786
6cec5c68 787GITPERLLIB="$GIT_BUILD_DIR"/perl/blib/lib:"$GIT_BUILD_DIR"/perl/blib/arch/auto/Git
6fcca938 788export GITPERLLIB
6cec5c68 789test -d "$GIT_BUILD_DIR"/templates/blt || {
eea42069
JH
790 error "You haven't built things yet, have you?"
791}
e1970ce4 792
1c0cc756
RJ
793if ! test -x "$GIT_BUILD_DIR"/test-chmtime
794then
56cf9806
EW
795 echo >&2 'You need to build test-chmtime:'
796 echo >&2 'Run "make test-chmtime" in the source (toplevel) directory'
797 exit 1
798fi
799
e1970ce4 800# Test repository
002d4ce8
JK
801TRASH_DIRECTORY="trash directory.$(basename "$0" .sh)"
802test -n "$root" && TRASH_DIRECTORY="$root/$TRASH_DIRECTORY"
803case "$TRASH_DIRECTORY" in
804/*) ;; # absolute path is good
805 *) TRASH_DIRECTORY="$TEST_OUTPUT_DIRECTORY/$TRASH_DIRECTORY" ;;
f423ef5f 806esac
91c8b825 807test ! -z "$debug" || remove_trash=$TRASH_DIRECTORY
38b074de 808rm -fr "$TRASH_DIRECTORY" || {
6e7b5aaf 809 GIT_EXIT_OK=t
8d14ac94
JH
810 echo >&5 "FATAL: Cannot prepare test area"
811 exit 1
812}
813
90cff968 814HOME="$TRASH_DIRECTORY"
0ea47f9d
JH
815GNUPGHOME="$HOME/gnupg-home-not-used"
816export HOME GNUPGHOME
90cff968 817
102fc80d
RH
818# run the tput tests *after* changing HOME (in case ncurses needs
819# ~/.terminfo for $TERM)
820test -n "${color+set}" || test "x$ORIGINAL_TERM" != "xdumb" && (
821 TERM=$ORIGINAL_TERM &&
822 export TERM &&
823 test -t 1 &&
824 tput bold >/dev/null 2>&1 &&
825 tput setaf 1 >/dev/null 2>&1 &&
826 tput sgr0 >/dev/null 2>&1
827 ) &&
828 color=t
829
830if test -n "$color"
831then
832 say_color () {
833 (
834 TERM=$ORIGINAL_TERM
835 export TERM
836 case "$1" in
837 error)
838 tput bold; tput setaf 1;; # bold red
839 skip)
840 tput setaf 4;; # blue
841 warn)
842 tput setaf 3;; # brown/yellow
843 pass)
844 tput setaf 2;; # green
845 info)
846 tput setaf 6;; # cyan
847 *)
848 test -n "$quiet" && return;;
849 esac
850 shift
851 printf "%s" "$*"
852 tput sgr0
853 echo
854 )
855 }
856else
857 say_color() {
858 test -z "$1" && test -n "$quiet" && return
859 shift
860 printf "%s\n" "$*"
861 }
862fi
863
1c0cc756
RJ
864if test -z "$TEST_NO_CREATE_REPO"
865then
38b074de 866 test_create_repo "$TRASH_DIRECTORY"
342e9ef2 867else
38b074de 868 mkdir -p "$TRASH_DIRECTORY"
342e9ef2 869fi
1bd9c648
LW
870# Use -P to resolve symlinks in our working directory so that the cwd
871# in subprocesses like git equals our $PWD (for pathname comparisons).
38b074de 872cd -P "$TRASH_DIRECTORY" || exit 1
04ece593 873
d5d9de1b
JS
874this_test=${0##*/}
875this_test=${this_test%%-*}
e6a6ddc9
TR
876if match_pattern_list "$this_test" $GIT_SKIP_TESTS
877then
878 say_color info >&3 "skipping test $this_test altogether"
879 skip_all="skip all tests in $this_test"
880 test_done
881fi
f17e9fbb 882
8648732e
BC
883# Provide an implementation of the 'yes' utility
884yes () {
885 if test $# = 0
886 then
887 y=y
888 else
889 y="$*"
890 fi
891
892 while echo "$y"
893 do
894 :
895 done
896}
897
f17e9fbb
JS
898# Fix some commands on Windows
899case $(uname -s) in
900*MINGW*)
901 # Windows has its own (incompatible) sort and find
902 sort () {
903 /usr/bin/sort "$@"
904 }
905 find () {
906 /usr/bin/find "$@"
907 }
5397ea31
JS
908 sum () {
909 md5sum "$@"
910 }
4114156a
JS
911 # git sees Windows-style pwd
912 pwd () {
913 builtin pwd -W
914 }
ee9fb68c 915 # no POSIX permissions
6fd1106a 916 # backslashes in pathspec are converted to '/'
fb9a2bea 917 # exec does not inherit the PID
a94114ad 918 test_set_prereq MINGW
5f4e02e5 919 test_set_prereq NATIVE_CRLF
a31d0665 920 test_set_prereq SED_STRIPS_CR
97669eed 921 test_set_prereq GREP_STRIPS_CR
4d715ac0 922 GIT_TEST_CMP=mingw_test_cmp
a31d0665
RJ
923 ;;
924*CYGWIN*)
925 test_set_prereq POSIXPERM
a31d0665 926 test_set_prereq EXECKEEPSPID
cfa96496 927 test_set_prereq CYGWIN
a31d0665 928 test_set_prereq SED_STRIPS_CR
97669eed 929 test_set_prereq GREP_STRIPS_CR
ee9fb68c
JS
930 ;;
931*)
932 test_set_prereq POSIXPERM
6fd1106a 933 test_set_prereq BSLASHPSPEC
fb9a2bea 934 test_set_prereq EXECKEEPSPID
f17e9fbb
JS
935 ;;
936esac
704a3143 937
b082687c 938( COLUMNS=1 && test $COLUMNS = 1 ) && test_set_prereq COLUMNS_CAN_BE_1
1b19ccd2 939test -z "$NO_PERL" && test_set_prereq PERL
d4e1b47a 940test -z "$NO_PYTHON" && test_set_prereq PYTHON
8f852ce6 941test -n "$USE_LIBPCRE" && test_set_prereq LIBPCRE
5e9637c6 942test -z "$NO_GETTEXT" && test_set_prereq GETTEXT
1b19ccd2 943
bb946bba 944# Can we rely on git's output in the C locale?
30955229
JN
945if test -n "$GETTEXT_POISON"
946then
947 GIT_GETTEXT_POISON=YesPlease
948 export GIT_GETTEXT_POISON
5e9637c6 949 test_set_prereq GETTEXT_POISON
30955229
JN
950else
951 test_set_prereq C_LOCALE_OUTPUT
952fi
bb946bba 953
cabdee2c
JH
954# Use this instead of test_cmp to compare files that contain expected and
955# actual output from git commands that can be translated. When running
956# under GETTEXT_POISON this pretends that the command produced expected
957# results.
958test_i18ncmp () {
959 test -n "$GETTEXT_POISON" || test_cmp "$@"
960}
961
127df8c6
JH
962# Use this instead of "grep expected-string actual" to see if the
963# output from a git command that can be translated either contains an
964# expected string, or does not contain an unwanted one. When running
965# under GETTEXT_POISON this pretends that the command produced expected
966# results.
967test_i18ngrep () {
968 if test -n "$GETTEXT_POISON"
969 then
970 : # pretend success
971 elif test "x!" = "x$1"
972 then
973 shift
974 ! grep "$@"
975 else
976 grep "$@"
977 fi
978}
979
20073274
AS
980test_lazy_prereq PIPE '
981 # test whether the filesystem supports FIFOs
9443605b
ML
982 case $(uname -s) in
983 CYGWIN*)
984 false
985 ;;
986 *)
987 rm -f testfifo && mkfifo testfifo
988 ;;
989 esac
20073274
AS
990'
991
04083f27
JH
992test_lazy_prereq SYMLINKS '
993 # test whether the filesystem supports symbolic links
994 ln -s x y && test -h y
995'
c91cfd19 996
b018c735
JN
997test_lazy_prereq FILEMODE '
998 test "$(git config --bool core.filemode)" = true
999'
1000
ac39aa61
MG
1001test_lazy_prereq CASE_INSENSITIVE_FS '
1002 echo good >CamelCase &&
1003 echo bad >camelcase &&
1004 test "$(cat CamelCase)" != good
1005'
1006
5b0b5dd4
MG
1007test_lazy_prereq UTF8_NFD_TO_NFC '
1008 # check whether FS converts nfd unicode to nfc
1009 auml=$(printf "\303\244")
1010 aumlcdiar=$(printf "\141\314\210")
1011 >"$auml" &&
1012 case "$(echo *)" in
1013 "$aumlcdiar")
1014 true ;;
1015 *)
1016 false ;;
1017 esac
1018'
1019
09feffb6
JK
1020test_lazy_prereq AUTOIDENT '
1021 sane_unset GIT_AUTHOR_NAME &&
1022 sane_unset GIT_AUTHOR_EMAIL &&
1023 git var GIT_AUTHOR_IDENT
1024'
1025
6219bb22
JH
1026test_lazy_prereq EXPENSIVE '
1027 test -n "$GIT_TEST_LONG"
1028'
1029
e1ecd9e3
JH
1030test_lazy_prereq USR_BIN_TIME '
1031 test -x /usr/bin/time
1032'
1033
1767c517
JK
1034test_lazy_prereq NOT_ROOT '
1035 uid=$(id -u) &&
1036 test "$uid" != 0
1037'
1038
f400e51c
TB
1039# On a filesystem that lacks SANITY, a file can be deleted even if
1040# the containing directory doesn't have write permissions, or a file
1041# can be accessed even if the containing directory doesn't have read
1042# or execute permissions, causing our tests that validate that Git
1043# works sensibly in such situations.
1044test_lazy_prereq SANITY '
1045 mkdir SANETESTD.1 SANETESTD.2 &&
1046
1047 chmod +w SANETESTD.1 SANETESTD.2 &&
1048 >SANETESTD.1/x 2>SANETESTD.2/x &&
1049 chmod -w SANETESTD.1 &&
1050 chmod -rx SANETESTD.2 ||
1051 error "bug in test sript: cannot prepare SANETESTD"
1052
1053 ! rm SANETESTD.1/x && ! test -f SANETESTD.2/x
1054 status=$?
1055
1056 chmod +rwx SANETESTD.1 SANETESTD.2 &&
1057 rm -rf SANETESTD.1 SANETESTD.2 ||
1058 error "bug in test sript: cannot clean SANETESTD"
1059 return $status
1060'
f838ce58
JK
1061
1062GIT_UNZIP=${GIT_UNZIP:-unzip}
1063test_lazy_prereq UNZIP '
1064 "$GIT_UNZIP" -v
1065 test $? -ne 127
1066'