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