t: prevent '-x' tracing from interfering with test helpers' stderr
[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
3c8f12c9
JH
18# Test the binaries we have just built. The tests are kept in
19# t/ subdirectory and are run in 'trash directory' subdirectory.
20if test -z "$TEST_DIRECTORY"
21then
22 # We allow tests to override this, in case they want to run tests
23 # outside of t/, e.g. for running tests on the test library
24 # itself.
25 TEST_DIRECTORY=$(pwd)
85176d72
FC
26else
27 # ensure that TEST_DIRECTORY is an absolute path so that it
28 # is valid even if the current working directory is changed
29 TEST_DIRECTORY=$(cd "$TEST_DIRECTORY" && pwd) || exit 1
3c8f12c9
JH
30fi
31if test -z "$TEST_OUTPUT_DIRECTORY"
32then
33 # Similarly, override this to store the test-results subdir
34 # elsewhere
35 TEST_OUTPUT_DIRECTORY=$TEST_DIRECTORY
36fi
37GIT_BUILD_DIR="$TEST_DIRECTORY"/..
38
d0cc5796
JK
39# If we were built with ASAN, it may complain about leaks
40# of program-lifetime variables. Disable it by default to lower
41# the noise level. This needs to happen at the start of the script,
42# before we even do our "did we build git yet" check (since we don't
43# want that one to complain to stderr).
bf1ce904 44: ${ASAN_OPTIONS=detect_leaks=0:abort_on_error=1}
d0cc5796
JK
45export ASAN_OPTIONS
46
85b81b35
JK
47# If LSAN is in effect we _do_ want leak checking, but we still
48# want to abort so that we notice the problems.
49: ${LSAN_OPTIONS=abort_on_error=1}
50export LSAN_OPTIONS
51
2006f0ad
RR
52################################################################
53# It appears that people try to run tests without building...
54"$GIT_BUILD_DIR/git" >/dev/null
55if test $? != 1
56then
57 echo >&2 'error: you do not seem to have built git yet.'
58 exit 1
59fi
60
3c8f12c9
JH
61. "$GIT_BUILD_DIR"/GIT-BUILD-OPTIONS
62export PERL_PATH SHELL_PATH
63
4cde519f
RR
64# if --tee was passed, write the output not only to the terminal, but
65# additionally to the file test-results/$BASENAME.out, too.
66case "$GIT_TEST_TEE_STARTED, $* " in
67done,*)
68 # do not redirect again
69 ;;
452320f1 70*' --tee '*|*' --va'*|*' --verbose-log '*)
2d14e13c
JK
71 mkdir -p "$TEST_OUTPUT_DIRECTORY/test-results"
72 BASE="$TEST_OUTPUT_DIRECTORY/test-results/$(basename "$0" .sh)"
452320f1
JK
73
74 # Make this filename available to the sub-process in case it is using
75 # --verbose-log.
76 GIT_TEST_TEE_OUTPUT_FILE=$BASE.out
77 export GIT_TEST_TEE_OUTPUT_FILE
78
79 # Truncate before calling "tee -a" to get rid of the results
80 # from any previous runs.
81 >"$GIT_TEST_TEE_OUTPUT_FILE"
82
3f824e91 83 (GIT_TEST_TEE_STARTED=done ${TEST_SHELL_PATH} "$0" "$@" 2>&1;
452320f1 84 echo $? >"$BASE.exit") | tee -a "$GIT_TEST_TEE_OUTPUT_FILE"
925bdc92 85 test "$(cat "$BASE.exit")" = 0
4cde519f
RR
86 exit
87 ;;
88esac
89
e1970ce4 90# For repeatability, reset the environment to known value.
d5c1b7c2 91# TERM is sanitized below, after saving color control sequences.
e1970ce4 92LANG=C
899460f3 93LC_ALL=C
d9bdd39e 94PAGER=cat
e1970ce4 95TZ=UTC
d5c1b7c2 96export LANG LC_ALL PAGER TZ
8ff99e74 97EDITOR=:
661bfd13
SL
98# A call to "unset" with no arguments causes at least Solaris 10
99# /usr/xpg4/bin/sh and /bin/ksh to bail out. So keep the unsets
100# deriving from the command substitution clustered with the other
101# ones.
3c8f12c9 102unset VISUAL EMAIL LANGUAGE COLUMNS $("$PERL_PATH" -e '
95a1d12e 103 my @env = keys %ENV;
730477f1
JL
104 my $ok = join("|", qw(
105 TRACE
106 DEBUG
730477f1
JL
107 TEST
108 .*_TEST
109 PROVE
110 VALGRIND
ac001282 111 UNZIP
edb54081 112 PERF_
e2a0ccc0 113 CURL_VERBOSE
4527aa10 114 TRACE_CURL
730477f1
JL
115 ));
116 my @vars = grep(/^GIT_/ && !/^GIT_($ok)/o, @env);
95a1d12e
JN
117 print join("\n", @vars);
118')
5adf84eb 119unset XDG_CONFIG_HOME
8bade1e1 120unset GITPERLLIB
29e55cd5
JH
121GIT_AUTHOR_EMAIL=author@example.com
122GIT_AUTHOR_NAME='A U Thor'
29e55cd5
JH
123GIT_COMMITTER_EMAIL=committer@example.com
124GIT_COMMITTER_NAME='C O Mitter'
8d0fc48f 125GIT_MERGE_VERBOSITY=5
f8246281
JH
126GIT_MERGE_AUTOEDIT=no
127export GIT_MERGE_VERBOSITY GIT_MERGE_AUTOEDIT
29e55cd5
JH
128export GIT_AUTHOR_EMAIL GIT_AUTHOR_NAME
129export GIT_COMMITTER_EMAIL GIT_COMMITTER_NAME
d33738d7 130export EDITOR
e1970ce4 131
124647c4
KB
132# Tests using GIT_TRACE typically don't want <timestamp> <file>:<line> output
133GIT_TRACE_BARE=1
134export GIT_TRACE_BARE
135
5d9fc888
TG
136if test -n "${TEST_GIT_INDEX_VERSION:+isset}"
137then
138 GIT_INDEX_VERSION="$TEST_GIT_INDEX_VERSION"
139 export GIT_INDEX_VERSION
140fi
141
a731fa91
EP
142# Add libc MALLOC and MALLOC_PERTURB test
143# only if we are not executing the test with valgrind
1b3185fc 144if expr " $GIT_TEST_OPTS " : ".* --valgrind " >/dev/null ||
ee1431bf 145 test -n "$TEST_NO_MALLOC_CHECK"
1b3185fc
JH
146then
147 setup_malloc_check () {
148 : nothing
149 }
150 teardown_malloc_check () {
151 : nothing
152 }
153else
154 setup_malloc_check () {
155 MALLOC_CHECK_=3 MALLOC_PERTURB_=165
156 export MALLOC_CHECK_ MALLOC_PERTURB_
157 }
158 teardown_malloc_check () {
159 unset MALLOC_CHECK_ MALLOC_PERTURB_
160 }
161fi
a731fa91 162
886a3907
JH
163# Protect ourselves from common misconfiguration to export
164# CDPATH into the environment
165unset CDPATH
166
5565f47c 167unset GREP_OPTIONS
ac001282 168unset UNZIP
5565f47c 169
3d5c0cc9 170case $(echo $GIT_TRACE |tr "[A-Z]" "[a-z]") in
1c0cc756 1711|2|true)
025232e8 172 GIT_TRACE=4
1c0cc756 173 ;;
6ce4e61f
CC
174esac
175
cd3c095c
JH
176# Convenience
177#
5555a2aa 178# A regexp to match 5, 35 and 40 hexdigits
cd3c095c 179_x05='[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
5555a2aa
CB
180_x35="$_x05$_x05$_x05$_x05$_x05$_x05$_x05"
181_x40="$_x35$_x05"
cd3c095c 182
3749fde5
JH
183# Zero SHA-1
184_z40=0000000000000000000000000000000000000000
185
f9e7d9f8 186EMPTY_TREE=4b825dc642cb6eb9a060e54bf8d69288fbee4904
378932d3 187EMPTY_BLOB=e69de29bb2d1d6434b8b29ae775ad8c2e48c5391
f9e7d9f8 188
3f4ab627
JH
189# Line feed
190LF='
191'
192
a42643aa
JK
193# UTF-8 ZERO WIDTH NON-JOINER, which HFS+ ignores
194# when case-folding filenames
195u200c=$(printf '\342\200\214')
196
5555a2aa 197export _x05 _x35 _x40 _z40 LF u200c EMPTY_TREE EMPTY_BLOB
342e9ef2 198
e1970ce4
JH
199# Each test should start with something like this, after copyright notices:
200#
201# test_description='Description of this test...
202# This test checks if command xyzzy does the right thing...
203# '
204# . ./test-lib.sh
d5c1b7c2 205test "x$TERM" != "xdumb" && (
ca92a660
RH
206 test -t 1 &&
207 tput bold >/dev/null 2>&1 &&
208 tput setaf 1 >/dev/null 2>&1 &&
209 tput sgr0 >/dev/null 2>&1
210 ) &&
211 color=t
e1970ce4 212
e1970ce4
JH
213while test "$#" -ne 0
214do
215 case "$1" in
216 -d|--d|--de|--deb|--debu|--debug)
217 debug=t; shift ;;
886856ab
JH
218 -i|--i|--im|--imm|--imme|--immed|--immedi|--immedia|--immediat|--immediate)
219 immediate=t; shift ;;
5e2c08c6 220 -l|--l|--lo|--lon|--long|--long-|--long-t|--long-te|--long-tes|--long-test|--long-tests)
91e80b98 221 GIT_TEST_LONG=t; export GIT_TEST_LONG; shift ;;
0445e6f0
IB
222 -r)
223 shift; test "$#" -ne 0 || {
224 echo 'error: -r requires an argument' >&2;
225 exit 1;
226 }
227 run_list=$1; shift ;;
228 --run=*)
0ff74101 229 run_list=${1#--*=}; shift ;;
e1970ce4 230 -h|--h|--he|--hel|--help)
570f3226 231 help=t; shift ;;
e1970ce4
JH
232 -v|--v|--ve|--ver|--verb|--verbo|--verbos|--verbose)
233 verbose=t; shift ;;
ff09af3f 234 --verbose-only=*)
0ff74101 235 verbose_only=${1#--*=}
ff09af3f 236 shift ;;
1ece1274 237 -q|--q|--qu|--qui|--quie|--quiet)
092c4334
ÆAB
238 # Ignore --quiet under a TAP::Harness. Saying how many tests
239 # passed without the ok/not ok details is always an error.
240 test -z "$HARNESS_ACTIVE" && quiet=t; shift ;;
e4597aae
MO
241 --with-dashes)
242 with_dashes=t; shift ;;
55db1df0 243 --no-color)
faa4bc35 244 color=; shift ;;
4e1be63c 245 --va|--val|--valg|--valgr|--valgri|--valgrin|--valgrind)
952af351
TR
246 valgrind=memcheck
247 shift ;;
248 --valgrind=*)
0ff74101 249 valgrind=${1#--*=}
952af351 250 shift ;;
5dfc368f 251 --valgrind-only=*)
0ff74101 252 valgrind_only=${1#--*=}
5dfc368f 253 shift ;;
44138559
JS
254 --tee)
255 shift ;; # was handled already
f423ef5f 256 --root=*)
0ff74101 257 root=${1#--*=}
f423ef5f 258 shift ;;
bb79af9d
JK
259 --chain-lint)
260 GIT_TEST_CHAIN_LINT=1
261 shift ;;
262 --no-chain-lint)
263 GIT_TEST_CHAIN_LINT=0
264 shift ;;
a136f6d8
JK
265 -x)
266 trace=t
a136f6d8 267 shift ;;
452320f1
JK
268 --verbose-log)
269 verbose_log=t
270 shift ;;
e1970ce4 271 *)
1f729dca 272 echo "error: unknown test option '$1'" >&2; exit 1 ;;
e1970ce4
JH
273 esac
274done
275
26a07309 276if test -n "$valgrind_only"
5dfc368f
TR
277then
278 test -z "$valgrind" && valgrind=memcheck
279 test -z "$verbose" && verbose_only="$valgrind_only"
280elif test -n "$valgrind"
281then
88c6e9d3 282 test -z "$verbose_log" && verbose=t
5dfc368f 283fi
952af351 284
f5ba2de6
JK
285if test -n "$trace" && test -z "$verbose_log"
286then
287 verbose=t
288fi
289
ca92a660
RH
290if test -n "$color"
291then
d5c1b7c2
RH
292 # Save the color control sequences now rather than run tput
293 # each time say_color() is called. This is done for two
294 # reasons:
295 # * TERM will be changed to dumb
296 # * HOME will be changed to a temporary directory and tput
297 # might need to read ~/.terminfo from the original HOME
298 # directory to get the control sequences
299 # Note: This approach assumes the control sequences don't end
300 # in a newline for any terminal of interest (command
301 # substitutions strip trailing newlines). Given that most
302 # (all?) terminals in common use are related to ECMA-48, this
303 # shouldn't be a problem.
304 say_color_error=$(tput bold; tput setaf 1) # bold red
305 say_color_skip=$(tput setaf 4) # blue
306 say_color_warn=$(tput setaf 3) # brown/yellow
307 say_color_pass=$(tput setaf 2) # green
308 say_color_info=$(tput setaf 6) # cyan
309 say_color_reset=$(tput sgr0)
310 say_color_="" # no formatting for normal text
ca92a660 311 say_color () {
d5c1b7c2
RH
312 test -z "$1" && test -n "$quiet" && return
313 eval "say_color_color=\$say_color_$1"
ca92a660 314 shift
d5c1b7c2 315 printf "%s\\n" "$say_color_color$*$say_color_reset"
ca92a660
RH
316 }
317else
318 say_color() {
319 test -z "$1" && test -n "$quiet" && return
320 shift
321 printf "%s\n" "$*"
322 }
323fi
324
d5c1b7c2
RH
325TERM=dumb
326export TERM
327
55db1df0
PH
328error () {
329 say_color error "error: $*"
6e7b5aaf 330 GIT_EXIT_OK=t
55db1df0
PH
331 exit 1
332}
333
334say () {
335 say_color info "$*"
336}
337
614fe015
JK
338if test -n "$HARNESS_ACTIVE"
339then
340 if test "$verbose" = t || test -n "$verbose_only"
341 then
342 printf 'Bail out! %s\n' \
343 'verbose mode forbidden under TAP harness; try --verbose-log'
344 exit 1
345 fi
346fi
347
570f3226
MB
348test "${test_description}" != "" ||
349error "Test script did not set test_description."
350
351if test "$help" = "t"
352then
cb1aefda 353 printf '%s\n' "$test_description"
570f3226
MB
354 exit 0
355fi
356
4d9d62fa 357exec 5>&1
781f76b1 358exec 6<&0
4ecae3c8 359exec 7>&2
452320f1
JK
360if test "$verbose_log" = "t"
361then
362 exec 3>>"$GIT_TEST_TEE_OUTPUT_FILE" 4>&3
363elif test "$verbose" = "t"
e1970ce4
JH
364then
365 exec 4>&2 3>&1
366else
367 exec 4>/dev/null 3>/dev/null
368fi
369
d88785e4
JK
370# Send any "-x" output directly to stderr to avoid polluting tests
371# which capture stderr. We can do this unconditionally since it
372# has no effect if tracing isn't turned on.
373#
374# Note that this sets up the trace fd as soon as we assign the variable, so it
375# must come after the creation of descriptor 4 above. Likewise, we must never
376# unset this, as it has the side effect of closing descriptor 4, which we
377# use to show verbose tests to the user.
378#
379# Note also that we don't need or want to export it. The tracing is local to
380# this shell, and we would not want to influence any shells we exec.
381BASH_XTRACEFD=4
382
e1970ce4
JH
383test_failure=0
384test_count=0
41ac414e
JH
385test_fixed=0
386test_broken=0
2d84e9fb 387test_success=0
e1970ce4 388
d998bd4a
ÆAB
389test_external_has_tap=0
390
faa4bc35 391die () {
6e7b5aaf
CB
392 code=$?
393 if test -n "$GIT_EXIT_OK"
394 then
395 exit $code
396 else
397 echo >&5 "FATAL: Unexpected exit with code $code"
398 exit 1
399 fi
faa4bc35
CB
400}
401
6e7b5aaf 402GIT_EXIT_OK=
35641310 403trap 'die' EXIT
da706545 404trap 'exit $?' INT
41184273 405
12a29b1a
TR
406# The user-facing functions are loaded from a separate file so that
407# test_perf subshells can have them too
3c8f12c9 408. "$TEST_DIRECTORY/test-lib-functions.sh"
05236a5e 409
886856ab 410# You are not expected to call test_ok_ and test_failure_ directly, use
3fa36666 411# the test_expect_* functions instead.
886856ab
JH
412
413test_ok_ () {
d5d9de1b 414 test_success=$(($test_success + 1))
633fe50a 415 say_color "" "ok $test_count - $@"
e1970ce4
JH
416}
417
886856ab 418test_failure_ () {
d5d9de1b 419 test_failure=$(($test_failure + 1))
633fe50a 420 say_color error "not ok $test_count - $1"
bf0dd8a8 421 shift
cb1aefda 422 printf '%s\n' "$*" | sed -e 's/^/# /'
6e7b5aaf 423 test "$immediate" = "" || { GIT_EXIT_OK=t; exit 1; }
886856ab
JH
424}
425
41ac414e 426test_known_broken_ok_ () {
41ac414e 427 test_fixed=$(($test_fixed+1))
633fe50a 428 say_color error "ok $test_count - $@ # TODO known breakage vanished"
41ac414e
JH
429}
430
431test_known_broken_failure_ () {
41ac414e 432 test_broken=$(($test_broken+1))
633fe50a 433 say_color warn "not ok $test_count - $@ # TODO known breakage"
41ac414e 434}
886856ab
JH
435
436test_debug () {
8e832ebc 437 test "$debug" = "" || eval "$1"
e1970ce4
JH
438}
439
e6a6ddc9
TR
440match_pattern_list () {
441 arg="$1"
442 shift
443 test -z "$*" && return 1
444 for pattern_
445 do
446 case "$arg" in
447 $pattern_)
448 return 0
449 esac
450 done
451 return 1
452}
453
0445e6f0
IB
454match_test_selector_list () {
455 title="$1"
456 shift
457 arg="$1"
458 shift
459 test -z "$1" && return 0
460
461 # Both commas and whitespace are accepted as separators.
462 OLDIFS=$IFS
463 IFS=' ,'
464 set -- $1
465 IFS=$OLDIFS
466
467 # If the first selector is negative we include by default.
468 include=
469 case "$1" in
470 !*) include=t ;;
471 esac
472
473 for selector
474 do
475 orig_selector=$selector
476
477 positive=t
478 case "$selector" in
479 !*)
480 positive=
481 selector=${selector##?}
482 ;;
483 esac
484
485 test -z "$selector" && continue
486
487 case "$selector" in
488 *-*)
489 if expr "z${selector%%-*}" : "z[0-9]*[^0-9]" >/dev/null
490 then
491 echo "error: $title: invalid non-numeric in range" \
492 "start: '$orig_selector'" >&2
493 exit 1
494 fi
495 if expr "z${selector#*-}" : "z[0-9]*[^0-9]" >/dev/null
496 then
497 echo "error: $title: invalid non-numeric in range" \
498 "end: '$orig_selector'" >&2
499 exit 1
500 fi
501 ;;
502 *)
503 if expr "z$selector" : "z[0-9]*[^0-9]" >/dev/null
504 then
505 echo "error: $title: invalid non-numeric in test" \
506 "selector: '$orig_selector'" >&2
507 exit 1
508 fi
509 esac
510
511 # Short cut for "obvious" cases
512 test -z "$include" && test -z "$positive" && continue
513 test -n "$include" && test -n "$positive" && continue
514
515 case "$selector" in
516 -*)
517 if test $arg -le ${selector#-}
518 then
519 include=$positive
520 fi
521 ;;
522 *-)
523 if test $arg -ge ${selector%-}
524 then
525 include=$positive
526 fi
527 ;;
528 *-*)
529 if test ${selector%%-*} -le $arg \
530 && test $arg -le ${selector#*-}
531 then
532 include=$positive
533 fi
534 ;;
535 *)
536 if test $arg -eq $selector
537 then
538 include=$positive
539 fi
540 ;;
541 esac
542 done
543
544 test -n "$include"
545}
546
ff09af3f
TR
547maybe_teardown_verbose () {
548 test -z "$verbose_only" && return
549 exec 4>/dev/null 3>/dev/null
550 verbose=
551}
552
553last_verbose=t
554maybe_setup_verbose () {
555 test -z "$verbose_only" && return
26a07309 556 if match_pattern_list $test_count $verbose_only
ff09af3f
TR
557 then
558 exec 4>&2 3>&1
559 # Emit a delimiting blank line when going from
560 # non-verbose to verbose. Within verbose mode the
561 # delimiter is printed by test_expect_*. The choice
562 # of the initial $last_verbose is such that before
563 # test 1, we do not print it.
564 test -z "$last_verbose" && echo >&3 ""
565 verbose=t
566 else
567 exec 4>/dev/null 3>/dev/null
568 verbose=
569 fi
570 last_verbose=$verbose
571}
572
5dfc368f
TR
573maybe_teardown_valgrind () {
574 test -z "$GIT_VALGRIND" && return
575 GIT_VALGRIND_ENABLED=
576}
577
578maybe_setup_valgrind () {
579 test -z "$GIT_VALGRIND" && return
26a07309 580 if test -z "$valgrind_only"
5dfc368f
TR
581 then
582 GIT_VALGRIND_ENABLED=t
583 return
584 fi
585 GIT_VALGRIND_ENABLED=
586 if match_pattern_list $test_count $valgrind_only
587 then
588 GIT_VALGRIND_ENABLED=t
589 fi
590}
591
9b5fe78b 592want_trace () {
f5ba2de6
JK
593 test "$trace" = t && {
594 test "$verbose" = t || test "$verbose_log" = t
595 }
9b5fe78b
JK
596}
597
a136f6d8
JK
598# This is a separate function because some tests use
599# "return" to end a test_expect_success block early
600# (and we want to make sure we run any cleanup like
601# "set +x").
602test_eval_inner_ () {
603 # Do not add anything extra (including LF) after '$*'
604 eval "
9b5fe78b 605 want_trace && set -x
a136f6d8
JK
606 $*"
607}
608
a7c58f28 609test_eval_ () {
90c8a1db
JK
610 # If "-x" tracing is in effect, then we want to avoid polluting stderr
611 # with non-test commands. But once in "set -x" mode, we cannot prevent
a136f6d8
JK
612 # the shell from printing the "set +x" to turn it off (nor the saving
613 # of $? before that). But we can make sure that the output goes to
614 # /dev/null.
615 #
90c8a1db
JK
616 # There are a few subtleties here:
617 #
618 # - we have to redirect descriptor 4 in addition to 2, to cover
619 # BASH_XTRACEFD
620 #
621 # - the actual eval has to come before the redirection block (since
622 # it needs to see descriptor 4 to set up its stderr)
623 #
624 # - likewise, any error message we print must be outside the block to
625 # access descriptor 4
626 #
627 # - checking $? has to come immediately after the eval, but it must
628 # be _inside_ the block to avoid polluting the "set -x" output
629 #
630
631 test_eval_inner_ "$@" </dev/null >&3 2>&4
a136f6d8 632 {
a136f6d8 633 test_eval_ret_=$?
9b5fe78b 634 if want_trace
a136f6d8
JK
635 then
636 set +x
a136f6d8 637 fi
90c8a1db
JK
638 } 2>/dev/null 4>&2
639
640 if test "$test_eval_ret_" != 0 && want_trace
641 then
642 say_color error >&4 "error: last command exited with \$?=$test_eval_ret_"
643 fi
a136f6d8 644 return $test_eval_ret_
a7c58f28
JN
645}
646
4d9d62fa 647test_run_ () {
b6b0afdc 648 test_cleanup=:
b586744a 649 expecting_failure=$2
bb79af9d 650
92b269f5 651 if test "${GIT_TEST_CHAIN_LINT:-1}" != 0; then
2a01ef8c
JK
652 # turn off tracing for this test-eval, as it simply creates
653 # confusing noise in the "-x" output
654 trace_tmp=$trace
655 trace=
bb79af9d
JK
656 # 117 is magic because it is unlikely to match the exit
657 # code of other programs
99a64e4b
JH
658 if test "OK-117" != "$(test_eval_ "(exit 117) && $1${LF}${LF}echo OK-\$?" 3>&1)"
659 then
660 error "bug in the test script: broken &&-chain or run-away HERE-DOC: $1"
bb79af9d 661 fi
2a01ef8c 662 trace=$trace_tmp
bb79af9d
JK
663 fi
664
a57397b0 665 setup_malloc_check
a7c58f28 666 test_eval_ "$1"
b6b0afdc 667 eval_ret=$?
a57397b0 668 teardown_malloc_check
b586744a 669
a136f6d8
JK
670 if test -z "$immediate" || test $eval_ret = 0 ||
671 test -n "$expecting_failure" && test "$test_cleanup" != ":"
b586744a 672 then
1b3185fc 673 setup_malloc_check
a7c58f28 674 test_eval_ "$test_cleanup"
1b3185fc 675 teardown_malloc_check
b586744a 676 fi
1c0cc756
RJ
677 if test "$verbose" = "t" && test -n "$HARNESS_ACTIVE"
678 then
57e1538a
ÆAB
679 echo ""
680 fi
aa0bcf96 681 return "$eval_ret"
4d9d62fa
PR
682}
683
ae75342c 684test_start_ () {
8586f98b 685 test_count=$(($test_count+1))
ff09af3f 686 maybe_setup_verbose
5dfc368f 687 maybe_setup_valgrind
ae75342c
TR
688}
689
690test_finish_ () {
691 echo >&3 ""
5dfc368f 692 maybe_teardown_valgrind
ff09af3f 693 maybe_teardown_verbose
ae75342c
TR
694}
695
696test_skip () {
04ece593 697 to_skip=
ef2ac68d 698 skipped_reason=
e6a6ddc9
TR
699 if match_pattern_list $this_test.$test_count $GIT_SKIP_TESTS
700 then
701 to_skip=t
ef2ac68d 702 skipped_reason="GIT_SKIP_TESTS"
e6a6ddc9 703 fi
05236a5e
JN
704 if test -z "$to_skip" && test -n "$test_prereq" &&
705 ! test_have_prereq "$test_prereq"
a7bb3940
JS
706 then
707 to_skip=t
ef2ac68d 708
07431fc8 709 of_prereq=
05236a5e 710 if test "$missing_prereq" != "$test_prereq"
07431fc8 711 then
05236a5e 712 of_prereq=" of $test_prereq"
07431fc8 713 fi
ef2ac68d
IB
714 skipped_reason="missing $missing_prereq${of_prereq}"
715 fi
0445e6f0
IB
716 if test -z "$to_skip" && test -n "$run_list" &&
717 ! match_test_selector_list '--run' $test_count "$run_list"
718 then
719 to_skip=t
720 skipped_reason="--run"
721 fi
07431fc8 722
ef2ac68d
IB
723 case "$to_skip" in
724 t)
633fe50a 725 say_color skip >&3 "skipping test: $@"
ef2ac68d 726 say_color skip "ok $test_count # skip $1 ($skipped_reason)"
04ece593
JH
727 : true
728 ;;
729 *)
730 false
731 ;;
732 esac
733}
734
342e9ef2
TR
735# stub; perf-lib overrides it
736test_at_end_hook_ () {
737 :
738}
739
e1970ce4 740test_done () {
6e7b5aaf 741 GIT_EXIT_OK=t
2d84e9fb 742
1c0cc756
RJ
743 if test -z "$HARNESS_ACTIVE"
744 then
342e9ef2 745 test_results_dir="$TEST_OUTPUT_DIRECTORY/test-results"
8ef1abe5 746 mkdir -p "$test_results_dir"
dd78478f 747 base=${0##*/}
5c885c1b 748 test_results_path="$test_results_dir/${base%.sh}.counts"
8ef1abe5 749
5c885c1b 750 cat >"$test_results_path" <<-EOF
c54e6be7
ML
751 total $test_count
752 success $test_success
753 fixed $test_fixed
754 broken $test_broken
755 failed $test_failure
756
757 EOF
8ef1abe5 758 fi
41ac414e
JH
759
760 if test "$test_fixed" != 0
761 then
633fe50a 762 say_color error "# $test_fixed known breakage(s) vanished; please update test(s)"
41ac414e
JH
763 fi
764 if test "$test_broken" != 0
765 then
633fe50a 766 say_color warn "# still have $test_broken known breakage(s)"
b73d9a23
AS
767 fi
768 if test "$test_broken" != 0 || test "$test_fixed" != 0
769 then
770 test_remaining=$(( $test_count - $test_broken - $test_fixed ))
771 msg="remaining $test_remaining test(s)"
11d54b8b 772 else
b73d9a23 773 test_remaining=$test_count
11d54b8b 774 msg="$test_count test(s)"
41ac414e 775 fi
e1970ce4 776 case "$test_failure" in
10b94e28 777 0)
1c0cc756
RJ
778 if test $test_external_has_tap -eq 0
779 then
b73d9a23 780 if test $test_remaining -gt 0
d87bd7c1 781 then
633fe50a 782 say_color pass "# passed all $msg"
d87bd7c1 783 fi
c7018be5
JH
784
785 # Maybe print SKIP message
786 test -z "$skip_all" || skip_all="# SKIP $skip_all"
787 case "$test_count" in
788 0)
789 say "1..$test_count${skip_all:+ $skip_all}"
790 ;;
791 *)
792 test -z "$skip_all" ||
793 say_color warn "$skip_all"
794 say "1..$test_count"
795 ;;
796 esac
d998bd4a 797 fi
abc5d372 798
06478dab 799 if test -z "$debug"
4d0912a2 800 then
06478dab 801 test -d "$TRASH_DIRECTORY" ||
4d0912a2 802 error "Tests passed but trash directory already removed before test cleanup; aborting"
abc5d372 803
06478dab
JH
804 cd "$TRASH_DIRECTORY/.." &&
805 rm -fr "$TRASH_DIRECTORY" ||
4d0912a2 806 error "Tests passed but test cleanup failed; aborting"
4d0912a2 807 fi
342e9ef2
TR
808 test_at_end_hook_
809
e1970ce4
JH
810 exit 0 ;;
811
812 *)
1c0cc756
RJ
813 if test $test_external_has_tap -eq 0
814 then
633fe50a
TR
815 say_color error "# failed $test_failure among $msg"
816 say "1..$test_count"
d998bd4a 817 fi
5099b99d 818
e1970ce4
JH
819 exit 1 ;;
820
821 esac
822}
823
e4597aae 824if test -n "$valgrind"
4e1be63c 825then
4e1be63c
JS
826 make_symlink () {
827 test -h "$2" &&
828 test "$1" = "$(readlink "$2")" || {
829 # be super paranoid
830 if mkdir "$2".lock
831 then
832 rm -f "$2" &&
833 ln -s "$1" "$2" &&
834 rm -r "$2".lock
835 else
836 while test -d "$2".lock
837 do
838 say "Waiting for lock on $2."
839 sleep 1
840 done
841 fi
842 }
843 }
844
845 make_valgrind_symlink () {
36bfb0e5 846 # handle only executables, unless they are shell libraries that
11d62145 847 # need to be in the exec-path.
36bfb0e5 848 test -x "$1" ||
11d62145 849 test "# " = "$(head -c 2 <"$1")" ||
36bfb0e5 850 return;
4e1be63c
JS
851
852 base=$(basename "$1")
28fab7b2
RS
853 case "$base" in
854 test-*)
855 symlink_target="$GIT_BUILD_DIR/t/helper/$base"
856 ;;
857 *)
858 symlink_target="$GIT_BUILD_DIR/$base"
859 ;;
860 esac
4e1be63c
JS
861 # do not override scripts
862 if test -x "$symlink_target" &&
863 test ! -d "$symlink_target" &&
864 test "#!" != "$(head -c 2 < "$symlink_target")"
865 then
866 symlink_target=../valgrind.sh
867 fi
efd92ffd
JS
868 case "$base" in
869 *.sh|*.perl)
870 symlink_target=../unprocessed-script
871 esac
4e1be63c
JS
872 # create the link, or replace it if it is out of date
873 make_symlink "$symlink_target" "$GIT_VALGRIND/bin/$base" || exit
874 }
875
26a07309
TR
876 # override all git executables in TEST_DIRECTORY/..
877 GIT_VALGRIND=$TEST_DIRECTORY/valgrind
878 mkdir -p "$GIT_VALGRIND"/bin
503e2241 879 for file in $GIT_BUILD_DIR/git* $GIT_BUILD_DIR/t/helper/test-*
26a07309
TR
880 do
881 make_valgrind_symlink $file
882 done
883 # special-case the mergetools loadables
884 make_symlink "$GIT_BUILD_DIR"/mergetools "$GIT_VALGRIND/bin/mergetools"
885 OLDIFS=$IFS
886 IFS=:
887 for path in $PATH
888 do
889 ls "$path"/git-* 2> /dev/null |
890 while read file
ad0e6233 891 do
26a07309 892 make_valgrind_symlink "$file"
ad0e6233 893 done
26a07309
TR
894 done
895 IFS=$OLDIFS
4e1be63c
JS
896 PATH=$GIT_VALGRIND/bin:$PATH
897 GIT_EXEC_PATH=$GIT_VALGRIND/bin
898 export GIT_VALGRIND
952af351
TR
899 GIT_VALGRIND_MODE="$valgrind"
900 export GIT_VALGRIND_MODE
5dfc368f 901 GIT_VALGRIND_ENABLED=t
26a07309 902 test -n "$valgrind_only" && GIT_VALGRIND_ENABLED=
5dfc368f 903 export GIT_VALGRIND_ENABLED
1c0cc756
RJ
904elif test -n "$GIT_TEST_INSTALLED"
905then
e4597aae
MO
906 GIT_EXEC_PATH=$($GIT_TEST_INSTALLED/git --exec-path) ||
907 error "Cannot run git from $GIT_TEST_INSTALLED."
6cec5c68 908 PATH=$GIT_TEST_INSTALLED:$GIT_BUILD_DIR:$PATH
e4597aae
MO
909 GIT_EXEC_PATH=${GIT_TEST_EXEC_PATH:-$GIT_EXEC_PATH}
910else # normal case, use ../bin-wrappers only unless $with_dashes:
6cec5c68 911 git_bin_dir="$GIT_BUILD_DIR/bin-wrappers"
1c0cc756
RJ
912 if ! test -x "$git_bin_dir/git"
913 then
914 if test -z "$with_dashes"
915 then
e4597aae
MO
916 say "$git_bin_dir/git is not executable; using GIT_EXEC_PATH"
917 fi
918 with_dashes=t
919 fi
920 PATH="$git_bin_dir:$PATH"
6cec5c68 921 GIT_EXEC_PATH=$GIT_BUILD_DIR
1c0cc756
RJ
922 if test -n "$with_dashes"
923 then
6cec5c68 924 PATH="$GIT_BUILD_DIR:$PATH"
e4597aae 925 fi
4e1be63c 926fi
6cec5c68 927GIT_TEMPLATE_DIR="$GIT_BUILD_DIR"/templates/blt
8bfa6bd6 928GIT_CONFIG_NOSYSTEM=1
3c995beb 929GIT_ATTR_NOSYSTEM=1
8f323c00 930export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG_NOSYSTEM GIT_ATTR_NOSYSTEM
49ccb087 931
5e87eae9
JH
932if test -z "$GIT_TEST_CMP"
933then
934 if test -n "$GIT_TEST_CMP_USE_COPIED_CONTEXT"
935 then
936 GIT_TEST_CMP="$DIFF -c"
937 else
938 GIT_TEST_CMP="$DIFF -u"
939 fi
940fi
941
20d2a30f 942GITPERLLIB="$GIT_BUILD_DIR"/perl/build/lib
6fcca938 943export GITPERLLIB
6cec5c68 944test -d "$GIT_BUILD_DIR"/templates/blt || {
eea42069
JH
945 error "You haven't built things yet, have you?"
946}
e1970ce4 947
e6e7530d 948if ! test -x "$GIT_BUILD_DIR"/t/helper/test-chmtime
1c0cc756 949then
56cf9806 950 echo >&2 'You need to build test-chmtime:'
e6e7530d 951 echo >&2 'Run "make t/helper/test-chmtime" in the source (toplevel) directory'
56cf9806
EW
952 exit 1
953fi
954
e1970ce4 955# Test repository
002d4ce8
JK
956TRASH_DIRECTORY="trash directory.$(basename "$0" .sh)"
957test -n "$root" && TRASH_DIRECTORY="$root/$TRASH_DIRECTORY"
958case "$TRASH_DIRECTORY" in
959/*) ;; # absolute path is good
960 *) TRASH_DIRECTORY="$TEST_OUTPUT_DIRECTORY/$TRASH_DIRECTORY" ;;
f423ef5f 961esac
38b074de 962rm -fr "$TRASH_DIRECTORY" || {
6e7b5aaf 963 GIT_EXIT_OK=t
8d14ac94
JH
964 echo >&5 "FATAL: Cannot prepare test area"
965 exit 1
966}
967
90cff968 968HOME="$TRASH_DIRECTORY"
0ea47f9d
JH
969GNUPGHOME="$HOME/gnupg-home-not-used"
970export HOME GNUPGHOME
90cff968 971
1c0cc756
RJ
972if test -z "$TEST_NO_CREATE_REPO"
973then
38b074de 974 test_create_repo "$TRASH_DIRECTORY"
342e9ef2 975else
38b074de 976 mkdir -p "$TRASH_DIRECTORY"
342e9ef2 977fi
1bd9c648
LW
978# Use -P to resolve symlinks in our working directory so that the cwd
979# in subprocesses like git equals our $PWD (for pathname comparisons).
38b074de 980cd -P "$TRASH_DIRECTORY" || exit 1
04ece593 981
d5d9de1b
JS
982this_test=${0##*/}
983this_test=${this_test%%-*}
e6a6ddc9
TR
984if match_pattern_list "$this_test" $GIT_SKIP_TESTS
985then
986 say_color info >&3 "skipping test $this_test altogether"
987 skip_all="skip all tests in $this_test"
988 test_done
989fi
f17e9fbb 990
8648732e
BC
991# Provide an implementation of the 'yes' utility
992yes () {
993 if test $# = 0
994 then
995 y=y
996 else
997 y="$*"
998 fi
999
6129c930
JS
1000 i=0
1001 while test $i -lt 99
8648732e 1002 do
6129c930
JS
1003 echo "$y"
1004 i=$(($i+1))
8648732e
BC
1005 done
1006}
1007
f17e9fbb 1008# Fix some commands on Windows
d98b2c5f
JS
1009uname_s=$(uname -s)
1010case $uname_s in
f17e9fbb
JS
1011*MINGW*)
1012 # Windows has its own (incompatible) sort and find
1013 sort () {
1014 /usr/bin/sort "$@"
1015 }
1016 find () {
1017 /usr/bin/find "$@"
1018 }
4114156a
JS
1019 # git sees Windows-style pwd
1020 pwd () {
1021 builtin pwd -W
1022 }
ee9fb68c 1023 # no POSIX permissions
6fd1106a 1024 # backslashes in pathspec are converted to '/'
fb9a2bea 1025 # exec does not inherit the PID
a94114ad 1026 test_set_prereq MINGW
5f4e02e5 1027 test_set_prereq NATIVE_CRLF
a31d0665 1028 test_set_prereq SED_STRIPS_CR
97669eed 1029 test_set_prereq GREP_STRIPS_CR
4d715ac0 1030 GIT_TEST_CMP=mingw_test_cmp
a31d0665
RJ
1031 ;;
1032*CYGWIN*)
1033 test_set_prereq POSIXPERM
a31d0665 1034 test_set_prereq EXECKEEPSPID
cfa96496 1035 test_set_prereq CYGWIN
a31d0665 1036 test_set_prereq SED_STRIPS_CR
97669eed 1037 test_set_prereq GREP_STRIPS_CR
ee9fb68c
JS
1038 ;;
1039*)
1040 test_set_prereq POSIXPERM
6fd1106a 1041 test_set_prereq BSLASHPSPEC
fb9a2bea 1042 test_set_prereq EXECKEEPSPID
f17e9fbb
JS
1043 ;;
1044esac
704a3143 1045
b082687c 1046( COLUMNS=1 && test $COLUMNS = 1 ) && test_set_prereq COLUMNS_CAN_BE_1
1b19ccd2 1047test -z "$NO_PERL" && test_set_prereq PERL
68c7d276 1048test -z "$NO_PTHREADS" && test_set_prereq PTHREADS
d4e1b47a 1049test -z "$NO_PYTHON" && test_set_prereq PYTHON
94da9193 1050test -n "$USE_LIBPCRE1$USE_LIBPCRE2" && test_set_prereq PCRE
ce9a2570
ÆAB
1051test -n "$USE_LIBPCRE1" && test_set_prereq LIBPCRE1
1052test -n "$USE_LIBPCRE2" && test_set_prereq LIBPCRE2
5e9637c6 1053test -z "$NO_GETTEXT" && test_set_prereq GETTEXT
1b19ccd2 1054
bb946bba 1055# Can we rely on git's output in the C locale?
30955229
JN
1056if test -n "$GETTEXT_POISON"
1057then
1058 GIT_GETTEXT_POISON=YesPlease
1059 export GIT_GETTEXT_POISON
5e9637c6 1060 test_set_prereq GETTEXT_POISON
30955229
JN
1061else
1062 test_set_prereq C_LOCALE_OUTPUT
1063fi
bb946bba 1064
20073274
AS
1065test_lazy_prereq PIPE '
1066 # test whether the filesystem supports FIFOs
7b7bea23
RJ
1067 test_have_prereq !MINGW,!CYGWIN &&
1068 rm -f testfifo && mkfifo testfifo
20073274
AS
1069'
1070
04083f27
JH
1071test_lazy_prereq SYMLINKS '
1072 # test whether the filesystem supports symbolic links
1073 ln -s x y && test -h y
1074'
c91cfd19 1075
b018c735
JN
1076test_lazy_prereq FILEMODE '
1077 test "$(git config --bool core.filemode)" = true
1078'
1079
ac39aa61
MG
1080test_lazy_prereq CASE_INSENSITIVE_FS '
1081 echo good >CamelCase &&
1082 echo bad >camelcase &&
1083 test "$(cat CamelCase)" != good
1084'
1085
5b0b5dd4
MG
1086test_lazy_prereq UTF8_NFD_TO_NFC '
1087 # check whether FS converts nfd unicode to nfc
1088 auml=$(printf "\303\244")
1089 aumlcdiar=$(printf "\141\314\210")
1090 >"$auml" &&
1091 case "$(echo *)" in
1092 "$aumlcdiar")
1093 true ;;
1094 *)
1095 false ;;
1096 esac
1097'
1098
09feffb6
JK
1099test_lazy_prereq AUTOIDENT '
1100 sane_unset GIT_AUTHOR_NAME &&
1101 sane_unset GIT_AUTHOR_EMAIL &&
1102 git var GIT_AUTHOR_IDENT
1103'
1104
6219bb22
JH
1105test_lazy_prereq EXPENSIVE '
1106 test -n "$GIT_TEST_LONG"
1107'
1108
5b1fe6eb
ÆAB
1109test_lazy_prereq EXPENSIVE_ON_WINDOWS '
1110 test_have_prereq EXPENSIVE || test_have_prereq !MINGW,!CYGWIN
1111'
1112
e1ecd9e3
JH
1113test_lazy_prereq USR_BIN_TIME '
1114 test -x /usr/bin/time
1115'
1116
1767c517
JK
1117test_lazy_prereq NOT_ROOT '
1118 uid=$(id -u) &&
1119 test "$uid" != 0
1120'
1121
63b747ce
JT
1122test_lazy_prereq JGIT '
1123 type jgit
1124'
1125
719c3da2
JH
1126# SANITY is about "can you correctly predict what the filesystem would
1127# do by only looking at the permission bits of the files and
1128# directories?" A typical example of !SANITY is running the test
1129# suite as root, where a test may expect "chmod -r file && cat file"
1130# to fail because file is supposed to be unreadable after a successful
1131# chmod. In an environment (i.e. combination of what filesystem is
1132# being used and who is running the tests) that lacks SANITY, you may
1133# be able to delete or create a file when the containing directory
1134# doesn't have write permissions, or access a file even if the
1135# containing directory doesn't have read or execute permissions.
1136
f400e51c
TB
1137test_lazy_prereq SANITY '
1138 mkdir SANETESTD.1 SANETESTD.2 &&
1139
1140 chmod +w SANETESTD.1 SANETESTD.2 &&
1141 >SANETESTD.1/x 2>SANETESTD.2/x &&
1142 chmod -w SANETESTD.1 &&
719c3da2 1143 chmod -r SANETESTD.1/x &&
f400e51c
TB
1144 chmod -rx SANETESTD.2 ||
1145 error "bug in test sript: cannot prepare SANETESTD"
1146
719c3da2 1147 ! test -r SANETESTD.1/x &&
f400e51c
TB
1148 ! rm SANETESTD.1/x && ! test -f SANETESTD.2/x
1149 status=$?
1150
1151 chmod +rwx SANETESTD.1 SANETESTD.2 &&
1152 rm -rf SANETESTD.1 SANETESTD.2 ||
1153 error "bug in test sript: cannot clean SANETESTD"
1154 return $status
1155'
f838ce58 1156
d98b2c5f 1157test FreeBSD != $uname_s || GIT_UNZIP=${GIT_UNZIP:-/usr/local/bin/unzip}
f838ce58
JK
1158GIT_UNZIP=${GIT_UNZIP:-unzip}
1159test_lazy_prereq UNZIP '
1160 "$GIT_UNZIP" -v
1161 test $? -ne 127
1162'
9a308de3
JK
1163
1164run_with_limited_cmdline () {
1165 (ulimit -s 128 && "$@")
1166}
1167
21dac1de
RJ
1168test_lazy_prereq CMDLINE_LIMIT '
1169 test_have_prereq !MINGW,!CYGWIN &&
1170 run_with_limited_cmdline true
1171'
6b9c38e1 1172
4db464f8
MG
1173run_with_limited_stack () {
1174 (ulimit -s 128 && "$@")
1175}
1176
21dac1de
RJ
1177test_lazy_prereq ULIMIT_STACK_SIZE '
1178 test_have_prereq !MINGW,!CYGWIN &&
1179 run_with_limited_stack true
1180'
4db464f8 1181
6b9c38e1
JK
1182build_option () {
1183 git version --build-options |
1184 sed -ne "s/^$1: //p"
1185}
1186
1187test_lazy_prereq LONG_IS_64BIT '
1188 test 8 -le "$(build_option sizeof-long)"
1189'
a07fb050
JS
1190
1191test_lazy_prereq TIME_IS_64BIT 'test-date is64bit'
efac8ac8 1192test_lazy_prereq TIME_T_IS_64BIT 'test-date time_t-is64bit'