]> git.ipfire.org Git - thirdparty/git.git/blame - t/test-lib.sh
t6040 test: stop using global "script" variable
[thirdparty/git.git] / t / test-lib.sh
CommitLineData
c74c7203 1# Test framework for git. See t/README for usage.
e1970ce4
JH
2#
3# Copyright (c) 2005 Junio C Hamano
4#
64b90323
MS
5# This program is free software: you can redistribute it and/or modify
6# it under the terms of the GNU General Public License as published by
7# the Free Software Foundation, either version 2 of the License, or
8# (at your option) any later version.
9#
10# This program is distributed in the hope that it will be useful,
11# but WITHOUT ANY WARRANTY; without even the implied warranty of
12# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13# GNU General Public License for more details.
14#
15# You should have received a copy of the GNU General Public License
16# along with this program. If not, see http://www.gnu.org/licenses/ .
e1970ce4 17
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
8abfdf44
JS
52if test ! -f "$GIT_BUILD_DIR"/GIT-BUILD-OPTIONS
53then
54 echo >&2 'error: GIT-BUILD-OPTIONS missing (has Git been built?).'
55 exit 1
56fi
57. "$GIT_BUILD_DIR"/GIT-BUILD-OPTIONS
58export PERL_PATH SHELL_PATH
59
b02e7d5d
JS
60# Disallow the use of abbreviated options in the test suite by default
61if test -z "${GIT_TEST_DISALLOW_ABBREVIATED_OPTIONS}"
62then
63 GIT_TEST_DISALLOW_ABBREVIATED_OPTIONS=true
64 export GIT_TEST_DISALLOW_ABBREVIATED_OPTIONS
65fi
66
2006f0ad
RR
67################################################################
68# It appears that people try to run tests without building...
8abfdf44 69"${GIT_TEST_INSTALLED:-$GIT_BUILD_DIR}/git$X" >/dev/null
2006f0ad
RR
70if test $? != 1
71then
ed306e4e
JS
72 if test -n "$GIT_TEST_INSTALLED"
73 then
74 echo >&2 "error: there is no working Git at '$GIT_TEST_INSTALLED'"
75 else
76 echo >&2 'error: you do not seem to have built git yet.'
77 fi
2006f0ad
RR
78 exit 1
79fi
80
8cf58006
SG
81# Parse options while taking care to leave $@ intact, so we will still
82# have all the original command line options when executing the test
83# script again for '--tee' and '--verbose-log' below.
84store_arg_to=
85prev_opt=
86for opt
87do
88 if test -n "$store_arg_to"
89 then
90 eval $store_arg_to=\$opt
91 store_arg_to=
92 prev_opt=
93 continue
94 fi
95
96 case "$opt" in
97 -d|--d|--de|--deb|--debu|--debug)
98 debug=t ;;
99 -i|--i|--im|--imm|--imme|--immed|--immedi|--immedia|--immediat|--immediate)
100 immediate=t ;;
101 -l|--l|--lo|--lon|--long|--long-|--long-t|--long-te|--long-tes|--long-test|--long-tests)
102 GIT_TEST_LONG=t; export GIT_TEST_LONG ;;
103 -r)
104 store_arg_to=run_list
105 ;;
106 --run=*)
107 run_list=${opt#--*=} ;;
108 -h|--h|--he|--hel|--help)
109 help=t ;;
110 -v|--v|--ve|--ver|--verb|--verbo|--verbos|--verbose)
111 verbose=t ;;
112 --verbose-only=*)
113 verbose_only=${opt#--*=}
114 ;;
115 -q|--q|--qu|--qui|--quie|--quiet)
116 # Ignore --quiet under a TAP::Harness. Saying how many tests
117 # passed without the ok/not ok details is always an error.
118 test -z "$HARNESS_ACTIVE" && quiet=t ;;
119 --with-dashes)
120 with_dashes=t ;;
dd167a30
JS
121 --no-bin-wrappers)
122 no_bin_wrappers=t ;;
8cf58006
SG
123 --no-color)
124 color= ;;
125 --va|--val|--valg|--valgr|--valgri|--valgrin|--valgrind)
126 valgrind=memcheck
127 tee=t
128 ;;
129 --valgrind=*)
130 valgrind=${opt#--*=}
131 tee=t
132 ;;
133 --valgrind-only=*)
134 valgrind_only=${opt#--*=}
135 tee=t
136 ;;
137 --tee)
138 tee=t ;;
139 --root=*)
140 root=${opt#--*=} ;;
141 --chain-lint)
142 GIT_TEST_CHAIN_LINT=1 ;;
143 --no-chain-lint)
144 GIT_TEST_CHAIN_LINT=0 ;;
145 -x)
146 trace=t ;;
147 -V|--verbose-log)
148 verbose_log=t
149 tee=t
150 ;;
22231908
JS
151 --write-junit-xml)
152 write_junit_xml=t
153 ;;
fb7d1e3a
SG
154 --stress)
155 stress=t ;;
156 --stress=*)
f5457371
JS
157 echo "error: --stress does not accept an argument: '$opt'" >&2
158 echo "did you mean --stress-jobs=${opt#*=} or --stress-limit=${opt#*=}?" >&2
159 exit 1
160 ;;
161 --stress-jobs=*)
162 stress=t;
fb7d1e3a
SG
163 stress=${opt#--*=}
164 case "$stress" in
7d661e5e 165 *[!0-9]*|0*|"")
f5457371 166 echo "error: --stress-jobs=<N> requires the number of jobs to run" >&2
fb7d1e3a
SG
167 exit 1
168 ;;
169 *) # Good.
170 ;;
171 esac
172 ;;
76e27fbf 173 --stress-limit=*)
de69e6f6 174 stress=t;
76e27fbf
SG
175 stress_limit=${opt#--*=}
176 case "$stress_limit" in
7d661e5e 177 *[!0-9]*|0*|"")
76e27fbf
SG
178 echo "error: --stress-limit=<N> requires the number of repetitions" >&2
179 exit 1
180 ;;
181 *) # Good.
182 ;;
183 esac
184 ;;
8cf58006
SG
185 *)
186 echo "error: unknown test option '$opt'" >&2; exit 1 ;;
187 esac
188
189 prev_opt=$opt
190done
191if test -n "$store_arg_to"
192then
193 echo "error: $prev_opt requires an argument" >&2
194 exit 1
195fi
196
197if test -n "$valgrind_only"
198then
199 test -z "$valgrind" && valgrind=memcheck
200 test -z "$verbose" && verbose_only="$valgrind_only"
201elif test -n "$valgrind"
202then
203 test -z "$verbose_log" && verbose=t
204fi
205
fb7d1e3a
SG
206if test -n "$stress"
207then
208 verbose=t
209 trace=t
210 immediate=t
211fi
212
213TEST_STRESS_JOB_SFX="${GIT_TEST_STRESS_JOB_NR:+.stress-$GIT_TEST_STRESS_JOB_NR}"
62c379b8
SG
214TEST_NAME="$(basename "$0" .sh)"
215TEST_RESULTS_DIR="$TEST_OUTPUT_DIRECTORY/test-results"
fb7d1e3a
SG
216TEST_RESULTS_BASE="$TEST_RESULTS_DIR/$TEST_NAME$TEST_STRESS_JOB_SFX"
217TRASH_DIRECTORY="trash directory.$TEST_NAME$TEST_STRESS_JOB_SFX"
61f292db
SG
218test -n "$root" && TRASH_DIRECTORY="$root/$TRASH_DIRECTORY"
219case "$TRASH_DIRECTORY" in
220/*) ;; # absolute path is good
221 *) TRASH_DIRECTORY="$TEST_OUTPUT_DIRECTORY/$TRASH_DIRECTORY" ;;
222esac
62c379b8 223
fb7d1e3a
SG
224# If --stress was passed, run this test repeatedly in several parallel loops.
225if test "$GIT_TEST_STRESS_STARTED" = "done"
226then
227 : # Don't stress test again.
228elif test -n "$stress"
229then
230 if test "$stress" != t
231 then
232 job_count=$stress
233 elif test -n "$GIT_TEST_STRESS_LOAD"
234 then
235 job_count="$GIT_TEST_STRESS_LOAD"
236 elif job_count=$(getconf _NPROCESSORS_ONLN 2>/dev/null) &&
237 test -n "$job_count"
238 then
239 job_count=$((2 * $job_count))
240 else
241 job_count=8
242 fi
243
244 mkdir -p "$TEST_RESULTS_DIR"
245 stressfail="$TEST_RESULTS_BASE.stress-failed"
246 rm -f "$stressfail"
247
248 stress_exit=0
249 trap '
250 kill $job_pids 2>/dev/null
251 wait
252 stress_exit=1
253 ' TERM INT HUP
254
255 job_pids=
256 job_nr=0
257 while test $job_nr -lt "$job_count"
258 do
259 (
260 GIT_TEST_STRESS_STARTED=done
261 GIT_TEST_STRESS_JOB_NR=$job_nr
262 export GIT_TEST_STRESS_STARTED GIT_TEST_STRESS_JOB_NR
263
264 trap '
265 kill $test_pid 2>/dev/null
266 wait
267 exit 1
268 ' TERM INT
269
76e27fbf
SG
270 cnt=1
271 while ! test -e "$stressfail" &&
272 { test -z "$stress_limit" ||
273 test $cnt -le $stress_limit ; }
fb7d1e3a
SG
274 do
275 $TEST_SHELL_PATH "$0" "$@" >"$TEST_RESULTS_BASE.stress-$job_nr.out" 2>&1 &
276 test_pid=$!
277
278 if wait $test_pid
279 then
280 printf "OK %2d.%d\n" $GIT_TEST_STRESS_JOB_NR $cnt
281 else
282 echo $GIT_TEST_STRESS_JOB_NR >>"$stressfail"
283 printf "FAIL %2d.%d\n" $GIT_TEST_STRESS_JOB_NR $cnt
284 fi
285 cnt=$(($cnt + 1))
286 done
287 ) &
288 job_pids="$job_pids $!"
289 job_nr=$(($job_nr + 1))
290 done
291
292 wait
293
294 if test -f "$stressfail"
295 then
76e27fbf 296 stress_exit=1
fb7d1e3a
SG
297 echo "Log(s) of failed test run(s):"
298 for failed_job_nr in $(sort -n "$stressfail")
299 do
300 echo "Contents of '$TEST_RESULTS_BASE.stress-$failed_job_nr.out':"
301 cat "$TEST_RESULTS_BASE.stress-$failed_job_nr.out"
302 done
303 rm -rf "$TRASH_DIRECTORY.stress-failed"
304 # Move the last one.
305 mv "$TRASH_DIRECTORY.stress-$failed_job_nr" "$TRASH_DIRECTORY.stress-failed"
306 fi
307
308 exit $stress_exit
309fi
310
4cde519f
RR
311# if --tee was passed, write the output not only to the terminal, but
312# additionally to the file test-results/$BASENAME.out, too.
8cf58006
SG
313if test "$GIT_TEST_TEE_STARTED" = "done"
314then
315 : # do not redirect again
316elif test -n "$tee"
317then
62c379b8 318 mkdir -p "$TEST_RESULTS_DIR"
452320f1
JK
319
320 # Make this filename available to the sub-process in case it is using
321 # --verbose-log.
62c379b8 322 GIT_TEST_TEE_OUTPUT_FILE=$TEST_RESULTS_BASE.out
452320f1
JK
323 export GIT_TEST_TEE_OUTPUT_FILE
324
325 # Truncate before calling "tee -a" to get rid of the results
326 # from any previous runs.
327 >"$GIT_TEST_TEE_OUTPUT_FILE"
328
3f824e91 329 (GIT_TEST_TEE_STARTED=done ${TEST_SHELL_PATH} "$0" "$@" 2>&1;
62c379b8
SG
330 echo $? >"$TEST_RESULTS_BASE.exit") | tee -a "$GIT_TEST_TEE_OUTPUT_FILE"
331 test "$(cat "$TEST_RESULTS_BASE.exit")" = 0
4cde519f 332 exit
8cf58006
SG
333fi
334
335if test -n "$trace" && test -n "$test_untraceable"
336then
337 # '-x' tracing requested, but this test script can't be reliably
338 # traced, unless it is run with a Bash version supporting
339 # BASH_XTRACEFD (introduced in Bash v4.1).
340 #
341 # Perform this version check _after_ the test script was
342 # potentially re-executed with $TEST_SHELL_PATH for '--tee' or
343 # '--verbose-log', so the right shell is checked and the
344 # warning is issued only once.
345 if test -n "$BASH_VERSION" && eval '
346 test ${BASH_VERSINFO[0]} -gt 4 || {
347 test ${BASH_VERSINFO[0]} -eq 4 &&
348 test ${BASH_VERSINFO[1]} -ge 1
349 }
350 '
351 then
352 : Executed by a Bash version supporting BASH_XTRACEFD. Good.
353 else
354 echo >&2 "warning: ignoring -x; '$0' is untraceable without BASH_XTRACEFD"
355 trace=
356 fi
357fi
358if test -n "$trace" && test -z "$verbose_log"
359then
360 verbose=t
361fi
4cde519f 362
e1970ce4 363# For repeatability, reset the environment to known value.
d5c1b7c2 364# TERM is sanitized below, after saving color control sequences.
e1970ce4 365LANG=C
899460f3 366LC_ALL=C
d9bdd39e 367PAGER=cat
e1970ce4 368TZ=UTC
d5c1b7c2 369export LANG LC_ALL PAGER TZ
8ff99e74 370EDITOR=:
6cdccfce
ÆAB
371
372# GIT_TEST_GETTEXT_POISON should not influence git commands executed
373# during initialization of test-lib and the test repo. Back it up,
374# unset and then restore after initialization is finished.
375if test -n "$GIT_TEST_GETTEXT_POISON"
376then
377 GIT_TEST_GETTEXT_POISON_ORIG=$GIT_TEST_GETTEXT_POISON
378 unset GIT_TEST_GETTEXT_POISON
379fi
380
661bfd13
SL
381# A call to "unset" with no arguments causes at least Solaris 10
382# /usr/xpg4/bin/sh and /bin/ksh to bail out. So keep the unsets
383# deriving from the command substitution clustered with the other
384# ones.
3c8f12c9 385unset VISUAL EMAIL LANGUAGE COLUMNS $("$PERL_PATH" -e '
95a1d12e 386 my @env = keys %ENV;
730477f1
JL
387 my $ok = join("|", qw(
388 TRACE
c1ee5796 389 TR2_
730477f1 390 DEBUG
730477f1
JL
391 TEST
392 .*_TEST
393 PROVE
394 VALGRIND
ac001282 395 UNZIP
edb54081 396 PERF_
e2a0ccc0 397 CURL_VERBOSE
4527aa10 398 TRACE_CURL
730477f1
JL
399 ));
400 my @vars = grep(/^GIT_/ && !/^GIT_($ok)/o, @env);
95a1d12e
JN
401 print join("\n", @vars);
402')
7976e901 403unset XDG_CACHE_HOME
5adf84eb 404unset XDG_CONFIG_HOME
8bade1e1 405unset GITPERLLIB
29e55cd5
JH
406GIT_AUTHOR_EMAIL=author@example.com
407GIT_AUTHOR_NAME='A U Thor'
29e55cd5
JH
408GIT_COMMITTER_EMAIL=committer@example.com
409GIT_COMMITTER_NAME='C O Mitter'
8d0fc48f 410GIT_MERGE_VERBOSITY=5
f8246281
JH
411GIT_MERGE_AUTOEDIT=no
412export GIT_MERGE_VERBOSITY GIT_MERGE_AUTOEDIT
29e55cd5
JH
413export GIT_AUTHOR_EMAIL GIT_AUTHOR_NAME
414export GIT_COMMITTER_EMAIL GIT_COMMITTER_NAME
d33738d7 415export EDITOR
e1970ce4 416
124647c4
KB
417# Tests using GIT_TRACE typically don't want <timestamp> <file>:<line> output
418GIT_TRACE_BARE=1
419export GIT_TRACE_BARE
420
4cb54d0a 421check_var_migration () {
4231d1ba
JH
422 # the warnings and hints given from this helper depends
423 # on end-user settings, which will disrupt the self-test
424 # done on the test framework itself.
425 case "$GIT_TEST_FRAMEWORK_SELFTEST" in
426 t) return ;;
427 esac
428
4cb54d0a
BP
429 old_name=$1 new_name=$2
430 eval "old_isset=\${${old_name}:+isset}"
431 eval "new_isset=\${${new_name}:+isset}"
4231d1ba 432
4cb54d0a
BP
433 case "$old_isset,$new_isset" in
434 isset,)
435 echo >&2 "warning: $old_name is now $new_name"
436 echo >&2 "hint: set $new_name too during the transition period"
437 eval "$new_name=\$$old_name"
438 ;;
439 isset,isset)
440 # do this later
441 # echo >&2 "warning: $old_name is now $new_name"
442 # echo >&2 "hint: remove $old_name"
443 ;;
444 esac
445}
446
447check_var_migration GIT_FSMONITOR_TEST GIT_TEST_FSMONITOR
1f357b04 448check_var_migration TEST_GIT_INDEX_VERSION GIT_TEST_INDEX_VERSION
5765d97b 449check_var_migration GIT_FORCE_PRELOAD_TEST GIT_TEST_PRELOAD_INDEX
1f357b04
BP
450
451# Use specific version of the index file format
452if test -n "${GIT_TEST_INDEX_VERSION:+isset}"
5d9fc888 453then
1f357b04 454 GIT_INDEX_VERSION="$GIT_TEST_INDEX_VERSION"
5d9fc888
TG
455 export GIT_INDEX_VERSION
456fi
457
a731fa91
EP
458# Add libc MALLOC and MALLOC_PERTURB test
459# only if we are not executing the test with valgrind
8cf58006 460if test -n "$valgrind" ||
ee1431bf 461 test -n "$TEST_NO_MALLOC_CHECK"
1b3185fc
JH
462then
463 setup_malloc_check () {
464 : nothing
465 }
466 teardown_malloc_check () {
467 : nothing
468 }
469else
470 setup_malloc_check () {
471 MALLOC_CHECK_=3 MALLOC_PERTURB_=165
472 export MALLOC_CHECK_ MALLOC_PERTURB_
473 }
474 teardown_malloc_check () {
475 unset MALLOC_CHECK_ MALLOC_PERTURB_
476 }
477fi
a731fa91 478
886a3907
JH
479# Protect ourselves from common misconfiguration to export
480# CDPATH into the environment
481unset CDPATH
482
5565f47c 483unset GREP_OPTIONS
ac001282 484unset UNZIP
5565f47c 485
3d5c0cc9 486case $(echo $GIT_TRACE |tr "[A-Z]" "[a-z]") in
1c0cc756 4871|2|true)
025232e8 488 GIT_TRACE=4
1c0cc756 489 ;;
6ce4e61f
CC
490esac
491
cd3c095c
JH
492# Convenience
493#
5555a2aa 494# A regexp to match 5, 35 and 40 hexdigits
cd3c095c 495_x05='[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
5555a2aa
CB
496_x35="$_x05$_x05$_x05$_x05$_x05$_x05$_x05"
497_x40="$_x35$_x05"
cd3c095c 498
3749fde5
JH
499# Zero SHA-1
500_z40=0000000000000000000000000000000000000000
501
bd981d5f 502OID_REGEX="$_x40"
198857bf 503ZERO_OID=$_z40
f9e7d9f8 504EMPTY_TREE=4b825dc642cb6eb9a060e54bf8d69288fbee4904
378932d3 505EMPTY_BLOB=e69de29bb2d1d6434b8b29ae775ad8c2e48c5391
f9e7d9f8 506
3f4ab627
JH
507# Line feed
508LF='
509'
510
a42643aa
JK
511# UTF-8 ZERO WIDTH NON-JOINER, which HFS+ ignores
512# when case-folding filenames
513u200c=$(printf '\342\200\214')
514
bd981d5f 515export _x05 _x35 _x40 _z40 LF u200c EMPTY_TREE EMPTY_BLOB ZERO_OID OID_REGEX
342e9ef2 516
e1970ce4
JH
517# Each test should start with something like this, after copyright notices:
518#
519# test_description='Description of this test...
520# This test checks if command xyzzy does the right thing...
521# '
522# . ./test-lib.sh
d5c1b7c2 523test "x$TERM" != "xdumb" && (
ca92a660
RH
524 test -t 1 &&
525 tput bold >/dev/null 2>&1 &&
526 tput setaf 1 >/dev/null 2>&1 &&
527 tput sgr0 >/dev/null 2>&1
528 ) &&
529 color=t
e1970ce4 530
ca92a660
RH
531if test -n "$color"
532then
d5c1b7c2
RH
533 # Save the color control sequences now rather than run tput
534 # each time say_color() is called. This is done for two
535 # reasons:
536 # * TERM will be changed to dumb
537 # * HOME will be changed to a temporary directory and tput
538 # might need to read ~/.terminfo from the original HOME
539 # directory to get the control sequences
540 # Note: This approach assumes the control sequences don't end
541 # in a newline for any terminal of interest (command
542 # substitutions strip trailing newlines). Given that most
543 # (all?) terminals in common use are related to ECMA-48, this
544 # shouldn't be a problem.
545 say_color_error=$(tput bold; tput setaf 1) # bold red
546 say_color_skip=$(tput setaf 4) # blue
547 say_color_warn=$(tput setaf 3) # brown/yellow
548 say_color_pass=$(tput setaf 2) # green
549 say_color_info=$(tput setaf 6) # cyan
550 say_color_reset=$(tput sgr0)
551 say_color_="" # no formatting for normal text
ca92a660 552 say_color () {
d5c1b7c2
RH
553 test -z "$1" && test -n "$quiet" && return
554 eval "say_color_color=\$say_color_$1"
ca92a660 555 shift
d5c1b7c2 556 printf "%s\\n" "$say_color_color$*$say_color_reset"
ca92a660
RH
557 }
558else
559 say_color() {
560 test -z "$1" && test -n "$quiet" && return
561 shift
562 printf "%s\n" "$*"
563 }
564fi
565
d5c1b7c2
RH
566TERM=dumb
567export TERM
568
55db1df0
PH
569error () {
570 say_color error "error: $*"
6e7b5aaf 571 GIT_EXIT_OK=t
55db1df0
PH
572 exit 1
573}
574
165293af
SG
575BUG () {
576 error >&7 "bug in the test script: $*"
577}
578
55db1df0
PH
579say () {
580 say_color info "$*"
581}
582
614fe015
JK
583if test -n "$HARNESS_ACTIVE"
584then
585 if test "$verbose" = t || test -n "$verbose_only"
586 then
587 printf 'Bail out! %s\n' \
588 'verbose mode forbidden under TAP harness; try --verbose-log'
589 exit 1
590 fi
591fi
592
570f3226
MB
593test "${test_description}" != "" ||
594error "Test script did not set test_description."
595
596if test "$help" = "t"
597then
cb1aefda 598 printf '%s\n' "$test_description"
570f3226
MB
599 exit 0
600fi
601
4d9d62fa 602exec 5>&1
781f76b1 603exec 6<&0
4ecae3c8 604exec 7>&2
452320f1
JK
605if test "$verbose_log" = "t"
606then
607 exec 3>>"$GIT_TEST_TEE_OUTPUT_FILE" 4>&3
608elif test "$verbose" = "t"
e1970ce4
JH
609then
610 exec 4>&2 3>&1
611else
612 exec 4>/dev/null 3>/dev/null
613fi
614
d88785e4
JK
615# Send any "-x" output directly to stderr to avoid polluting tests
616# which capture stderr. We can do this unconditionally since it
617# has no effect if tracing isn't turned on.
618#
619# Note that this sets up the trace fd as soon as we assign the variable, so it
620# must come after the creation of descriptor 4 above. Likewise, we must never
621# unset this, as it has the side effect of closing descriptor 4, which we
622# use to show verbose tests to the user.
623#
624# Note also that we don't need or want to export it. The tracing is local to
625# this shell, and we would not want to influence any shells we exec.
626BASH_XTRACEFD=4
627
e1970ce4
JH
628test_failure=0
629test_count=0
41ac414e
JH
630test_fixed=0
631test_broken=0
2d84e9fb 632test_success=0
e1970ce4 633
d998bd4a
ÆAB
634test_external_has_tap=0
635
faa4bc35 636die () {
6e7b5aaf 637 code=$?
900721e1
JS
638 # This is responsible for running the atexit commands even when a
639 # test script run with '--immediate' fails, or when the user hits
640 # ctrl-C, i.e. when 'test_done' is not invoked at all.
641 test_atexit_handler || code=$?
6e7b5aaf
CB
642 if test -n "$GIT_EXIT_OK"
643 then
644 exit $code
645 else
646 echo >&5 "FATAL: Unexpected exit with code $code"
647 exit 1
648 fi
faa4bc35
CB
649}
650
6e7b5aaf 651GIT_EXIT_OK=
35641310 652trap 'die' EXIT
c5c39f4e
SG
653# Disable '-x' tracing, because with some shells, notably dash, it
654# prevents running the cleanup commands when a test script run with
655# '--verbose-log -x' is interrupted.
656trap '{ code=$?; set +x; } 2>/dev/null; exit $code' INT TERM HUP
41184273 657
12a29b1a
TR
658# The user-facing functions are loaded from a separate file so that
659# test_perf subshells can have them too
3c8f12c9 660. "$TEST_DIRECTORY/test-lib-functions.sh"
05236a5e 661
886856ab 662# You are not expected to call test_ok_ and test_failure_ directly, use
3fa36666 663# the test_expect_* functions instead.
886856ab
JH
664
665test_ok_ () {
22231908
JS
666 if test -n "$write_junit_xml"
667 then
668 write_junit_xml_testcase "$*"
669 fi
d5d9de1b 670 test_success=$(($test_success + 1))
633fe50a 671 say_color "" "ok $test_count - $@"
e1970ce4
JH
672}
673
886856ab 674test_failure_ () {
22231908
JS
675 if test -n "$write_junit_xml"
676 then
677 junit_insert="<failure message=\"not ok $test_count -"
678 junit_insert="$junit_insert $(xml_attr_encode "$1")\">"
679 junit_insert="$junit_insert $(xml_attr_encode \
af9912ef
JS
680 "$(if test -n "$GIT_TEST_TEE_OUTPUT_FILE"
681 then
682 test-tool path-utils skip-n-bytes \
683 "$GIT_TEST_TEE_OUTPUT_FILE" $GIT_TEST_TEE_OFFSET
684 else
685 printf '%s\n' "$@" | sed 1d
686 fi)")"
22231908 687 junit_insert="$junit_insert</failure>"
af9912ef
JS
688 if test -n "$GIT_TEST_TEE_OUTPUT_FILE"
689 then
690 junit_insert="$junit_insert<system-err>$(xml_attr_encode \
691 "$(cat "$GIT_TEST_TEE_OUTPUT_FILE")")</system-err>"
692 fi
22231908
JS
693 write_junit_xml_testcase "$1" " $junit_insert"
694 fi
d5d9de1b 695 test_failure=$(($test_failure + 1))
633fe50a 696 say_color error "not ok $test_count - $1"
bf0dd8a8 697 shift
cb1aefda 698 printf '%s\n' "$*" | sed -e 's/^/# /'
6e7b5aaf 699 test "$immediate" = "" || { GIT_EXIT_OK=t; exit 1; }
886856ab
JH
700}
701
41ac414e 702test_known_broken_ok_ () {
22231908
JS
703 if test -n "$write_junit_xml"
704 then
705 write_junit_xml_testcase "$* (breakage fixed)"
706 fi
41ac414e 707 test_fixed=$(($test_fixed+1))
633fe50a 708 say_color error "ok $test_count - $@ # TODO known breakage vanished"
41ac414e
JH
709}
710
711test_known_broken_failure_ () {
22231908
JS
712 if test -n "$write_junit_xml"
713 then
714 write_junit_xml_testcase "$* (known breakage)"
715 fi
41ac414e 716 test_broken=$(($test_broken+1))
633fe50a 717 say_color warn "not ok $test_count - $@ # TODO known breakage"
41ac414e 718}
886856ab
JH
719
720test_debug () {
8e832ebc 721 test "$debug" = "" || eval "$1"
e1970ce4
JH
722}
723
e6a6ddc9
TR
724match_pattern_list () {
725 arg="$1"
726 shift
727 test -z "$*" && return 1
728 for pattern_
729 do
730 case "$arg" in
731 $pattern_)
732 return 0
733 esac
734 done
735 return 1
736}
737
0445e6f0
IB
738match_test_selector_list () {
739 title="$1"
740 shift
741 arg="$1"
742 shift
743 test -z "$1" && return 0
744
745 # Both commas and whitespace are accepted as separators.
746 OLDIFS=$IFS
747 IFS=' ,'
748 set -- $1
749 IFS=$OLDIFS
750
751 # If the first selector is negative we include by default.
752 include=
753 case "$1" in
754 !*) include=t ;;
755 esac
756
757 for selector
758 do
759 orig_selector=$selector
760
761 positive=t
762 case "$selector" in
763 !*)
764 positive=
765 selector=${selector##?}
766 ;;
767 esac
768
769 test -z "$selector" && continue
770
771 case "$selector" in
772 *-*)
773 if expr "z${selector%%-*}" : "z[0-9]*[^0-9]" >/dev/null
774 then
775 echo "error: $title: invalid non-numeric in range" \
776 "start: '$orig_selector'" >&2
777 exit 1
778 fi
779 if expr "z${selector#*-}" : "z[0-9]*[^0-9]" >/dev/null
780 then
781 echo "error: $title: invalid non-numeric in range" \
782 "end: '$orig_selector'" >&2
783 exit 1
784 fi
785 ;;
786 *)
787 if expr "z$selector" : "z[0-9]*[^0-9]" >/dev/null
788 then
789 echo "error: $title: invalid non-numeric in test" \
790 "selector: '$orig_selector'" >&2
791 exit 1
792 fi
793 esac
794
795 # Short cut for "obvious" cases
796 test -z "$include" && test -z "$positive" && continue
797 test -n "$include" && test -n "$positive" && continue
798
799 case "$selector" in
800 -*)
801 if test $arg -le ${selector#-}
802 then
803 include=$positive
804 fi
805 ;;
806 *-)
807 if test $arg -ge ${selector%-}
808 then
809 include=$positive
810 fi
811 ;;
812 *-*)
813 if test ${selector%%-*} -le $arg \
814 && test $arg -le ${selector#*-}
815 then
816 include=$positive
817 fi
818 ;;
819 *)
820 if test $arg -eq $selector
821 then
822 include=$positive
823 fi
824 ;;
825 esac
826 done
827
828 test -n "$include"
829}
830
ff09af3f
TR
831maybe_teardown_verbose () {
832 test -z "$verbose_only" && return
833 exec 4>/dev/null 3>/dev/null
834 verbose=
835}
836
837last_verbose=t
838maybe_setup_verbose () {
839 test -z "$verbose_only" && return
26a07309 840 if match_pattern_list $test_count $verbose_only
ff09af3f
TR
841 then
842 exec 4>&2 3>&1
843 # Emit a delimiting blank line when going from
844 # non-verbose to verbose. Within verbose mode the
845 # delimiter is printed by test_expect_*. The choice
846 # of the initial $last_verbose is such that before
847 # test 1, we do not print it.
848 test -z "$last_verbose" && echo >&3 ""
849 verbose=t
850 else
851 exec 4>/dev/null 3>/dev/null
852 verbose=
853 fi
854 last_verbose=$verbose
855}
856
5dfc368f
TR
857maybe_teardown_valgrind () {
858 test -z "$GIT_VALGRIND" && return
859 GIT_VALGRIND_ENABLED=
860}
861
862maybe_setup_valgrind () {
863 test -z "$GIT_VALGRIND" && return
26a07309 864 if test -z "$valgrind_only"
5dfc368f
TR
865 then
866 GIT_VALGRIND_ENABLED=t
867 return
868 fi
869 GIT_VALGRIND_ENABLED=
870 if match_pattern_list $test_count $valgrind_only
871 then
872 GIT_VALGRIND_ENABLED=t
873 fi
874}
875
9b5fe78b 876want_trace () {
f5ba2de6
JK
877 test "$trace" = t && {
878 test "$verbose" = t || test "$verbose_log" = t
879 }
9b5fe78b
JK
880}
881
a136f6d8
JK
882# This is a separate function because some tests use
883# "return" to end a test_expect_success block early
884# (and we want to make sure we run any cleanup like
885# "set +x").
886test_eval_inner_ () {
887 # Do not add anything extra (including LF) after '$*'
888 eval "
9b5fe78b 889 want_trace && set -x
a136f6d8
JK
890 $*"
891}
892
a7c58f28 893test_eval_ () {
90c8a1db
JK
894 # If "-x" tracing is in effect, then we want to avoid polluting stderr
895 # with non-test commands. But once in "set -x" mode, we cannot prevent
a136f6d8
JK
896 # the shell from printing the "set +x" to turn it off (nor the saving
897 # of $? before that). But we can make sure that the output goes to
898 # /dev/null.
899 #
90c8a1db
JK
900 # There are a few subtleties here:
901 #
902 # - we have to redirect descriptor 4 in addition to 2, to cover
903 # BASH_XTRACEFD
904 #
905 # - the actual eval has to come before the redirection block (since
906 # it needs to see descriptor 4 to set up its stderr)
907 #
908 # - likewise, any error message we print must be outside the block to
909 # access descriptor 4
910 #
911 # - checking $? has to come immediately after the eval, but it must
912 # be _inside_ the block to avoid polluting the "set -x" output
913 #
914
915 test_eval_inner_ "$@" </dev/null >&3 2>&4
a136f6d8 916 {
a136f6d8 917 test_eval_ret_=$?
9b5fe78b 918 if want_trace
a136f6d8
JK
919 then
920 set +x
a136f6d8 921 fi
90c8a1db
JK
922 } 2>/dev/null 4>&2
923
924 if test "$test_eval_ret_" != 0 && want_trace
925 then
926 say_color error >&4 "error: last command exited with \$?=$test_eval_ret_"
927 fi
a136f6d8 928 return $test_eval_ret_
a7c58f28
JN
929}
930
4d9d62fa 931test_run_ () {
b6b0afdc 932 test_cleanup=:
b586744a 933 expecting_failure=$2
bb79af9d 934
92b269f5 935 if test "${GIT_TEST_CHAIN_LINT:-1}" != 0; then
2a01ef8c
JK
936 # turn off tracing for this test-eval, as it simply creates
937 # confusing noise in the "-x" output
938 trace_tmp=$trace
939 trace=
bb79af9d
JK
940 # 117 is magic because it is unlikely to match the exit
941 # code of other programs
878f9883
ES
942 if $(printf '%s\n' "$1" | sed -f "$GIT_BUILD_DIR/t/chainlint.sed" | grep -q '?![A-Z][A-Z]*?!') ||
943 test "OK-117" != "$(test_eval_ "(exit 117) && $1${LF}${LF}echo OK-\$?" 3>&1)"
99a64e4b 944 then
165293af 945 BUG "broken &&-chain or run-away HERE-DOC: $1"
bb79af9d 946 fi
2a01ef8c 947 trace=$trace_tmp
bb79af9d
JK
948 fi
949
a57397b0 950 setup_malloc_check
a7c58f28 951 test_eval_ "$1"
b6b0afdc 952 eval_ret=$?
a57397b0 953 teardown_malloc_check
b586744a 954
a136f6d8
JK
955 if test -z "$immediate" || test $eval_ret = 0 ||
956 test -n "$expecting_failure" && test "$test_cleanup" != ":"
b586744a 957 then
1b3185fc 958 setup_malloc_check
a7c58f28 959 test_eval_ "$test_cleanup"
1b3185fc 960 teardown_malloc_check
b586744a 961 fi
1c0cc756
RJ
962 if test "$verbose" = "t" && test -n "$HARNESS_ACTIVE"
963 then
57e1538a
ÆAB
964 echo ""
965 fi
aa0bcf96 966 return "$eval_ret"
4d9d62fa
PR
967}
968
ae75342c 969test_start_ () {
8586f98b 970 test_count=$(($test_count+1))
ff09af3f 971 maybe_setup_verbose
5dfc368f 972 maybe_setup_valgrind
22231908
JS
973 if test -n "$write_junit_xml"
974 then
975 junit_start=$(test-tool date getnanos)
976 fi
ae75342c
TR
977}
978
979test_finish_ () {
980 echo >&3 ""
5dfc368f 981 maybe_teardown_valgrind
ff09af3f 982 maybe_teardown_verbose
af9912ef
JS
983 if test -n "$GIT_TEST_TEE_OFFSET"
984 then
985 GIT_TEST_TEE_OFFSET=$(test-tool path-utils file-size \
986 "$GIT_TEST_TEE_OUTPUT_FILE")
987 fi
ae75342c
TR
988}
989
990test_skip () {
04ece593 991 to_skip=
ef2ac68d 992 skipped_reason=
e6a6ddc9
TR
993 if match_pattern_list $this_test.$test_count $GIT_SKIP_TESTS
994 then
995 to_skip=t
ef2ac68d 996 skipped_reason="GIT_SKIP_TESTS"
e6a6ddc9 997 fi
05236a5e
JN
998 if test -z "$to_skip" && test -n "$test_prereq" &&
999 ! test_have_prereq "$test_prereq"
a7bb3940
JS
1000 then
1001 to_skip=t
ef2ac68d 1002
07431fc8 1003 of_prereq=
05236a5e 1004 if test "$missing_prereq" != "$test_prereq"
07431fc8 1005 then
05236a5e 1006 of_prereq=" of $test_prereq"
07431fc8 1007 fi
ef2ac68d
IB
1008 skipped_reason="missing $missing_prereq${of_prereq}"
1009 fi
0445e6f0
IB
1010 if test -z "$to_skip" && test -n "$run_list" &&
1011 ! match_test_selector_list '--run' $test_count "$run_list"
1012 then
1013 to_skip=t
1014 skipped_reason="--run"
1015 fi
07431fc8 1016
ef2ac68d
IB
1017 case "$to_skip" in
1018 t)
22231908
JS
1019 if test -n "$write_junit_xml"
1020 then
1021 message="$(xml_attr_encode "$skipped_reason")"
1022 write_junit_xml_testcase "$1" \
1023 " <skipped message=\"$message\" />"
1024 fi
1025
633fe50a 1026 say_color skip >&3 "skipping test: $@"
ef2ac68d 1027 say_color skip "ok $test_count # skip $1 ($skipped_reason)"
04ece593
JH
1028 : true
1029 ;;
1030 *)
1031 false
1032 ;;
1033 esac
1034}
1035
342e9ef2
TR
1036# stub; perf-lib overrides it
1037test_at_end_hook_ () {
1038 :
1039}
1040
22231908
JS
1041write_junit_xml () {
1042 case "$1" in
1043 --truncate)
1044 >"$junit_xml_path"
1045 junit_have_testcase=
1046 shift
1047 ;;
1048 esac
1049 printf '%s\n' "$@" >>"$junit_xml_path"
1050}
1051
1052xml_attr_encode () {
1053 printf '%s\n' "$@" | test-tool xml-encode
1054}
1055
1056write_junit_xml_testcase () {
1057 junit_attrs="name=\"$(xml_attr_encode "$this_test.$test_count $1")\""
1058 shift
1059 junit_attrs="$junit_attrs classname=\"$this_test\""
1060 junit_attrs="$junit_attrs time=\"$(test-tool \
1061 date getnanos $junit_start)\""
1062 write_junit_xml "$(printf '%s\n' \
1063 " <testcase $junit_attrs>" "$@" " </testcase>")"
1064 junit_have_testcase=t
1065}
1066
900721e1
JS
1067test_atexit_cleanup=:
1068test_atexit_handler () {
1069 # In a succeeding test script 'test_atexit_handler' is invoked
1070 # twice: first from 'test_done', then from 'die' in the trap on
1071 # EXIT.
1072 # This condition and resetting 'test_atexit_cleanup' below makes
1073 # sure that the registered cleanup commands are run only once.
1074 test : != "$test_atexit_cleanup" || return 0
1075
1076 setup_malloc_check
1077 test_eval_ "$test_atexit_cleanup"
1078 test_atexit_cleanup=:
1079 teardown_malloc_check
1080}
1081
e1970ce4 1082test_done () {
6e7b5aaf 1083 GIT_EXIT_OK=t
2d84e9fb 1084
900721e1
JS
1085 # Run the atexit commands _before_ the trash directory is
1086 # removed, so the commands can access pidfiles and socket files.
1087 test_atexit_handler
1088
22231908
JS
1089 if test -n "$write_junit_xml" && test -n "$junit_xml_path"
1090 then
1091 test -n "$junit_have_testcase" || {
1092 junit_start=$(test-tool date getnanos)
1093 write_junit_xml_testcase "all tests skipped"
1094 }
1095
1096 # adjust the overall time
1097 junit_time=$(test-tool date getnanos $junit_suite_start)
1098 sed "s/<testsuite [^>]*/& time=\"$junit_time\"/" \
1099 <"$junit_xml_path" >"$junit_xml_path.new"
1100 mv "$junit_xml_path.new" "$junit_xml_path"
1101
1102 write_junit_xml " </testsuite>" "</testsuites>"
1103 fi
1104
1c0cc756
RJ
1105 if test -z "$HARNESS_ACTIVE"
1106 then
62c379b8 1107 mkdir -p "$TEST_RESULTS_DIR"
8ef1abe5 1108
62c379b8 1109 cat >"$TEST_RESULTS_BASE.counts" <<-EOF
c54e6be7
ML
1110 total $test_count
1111 success $test_success
1112 fixed $test_fixed
1113 broken $test_broken
1114 failed $test_failure
1115
1116 EOF
8ef1abe5 1117 fi
41ac414e
JH
1118
1119 if test "$test_fixed" != 0
1120 then
633fe50a 1121 say_color error "# $test_fixed known breakage(s) vanished; please update test(s)"
41ac414e
JH
1122 fi
1123 if test "$test_broken" != 0
1124 then
633fe50a 1125 say_color warn "# still have $test_broken known breakage(s)"
b73d9a23
AS
1126 fi
1127 if test "$test_broken" != 0 || test "$test_fixed" != 0
1128 then
1129 test_remaining=$(( $test_count - $test_broken - $test_fixed ))
1130 msg="remaining $test_remaining test(s)"
11d54b8b 1131 else
b73d9a23 1132 test_remaining=$test_count
11d54b8b 1133 msg="$test_count test(s)"
41ac414e 1134 fi
e1970ce4 1135 case "$test_failure" in
10b94e28 1136 0)
1c0cc756
RJ
1137 if test $test_external_has_tap -eq 0
1138 then
b73d9a23 1139 if test $test_remaining -gt 0
d87bd7c1 1140 then
633fe50a 1141 say_color pass "# passed all $msg"
d87bd7c1 1142 fi
c7018be5
JH
1143
1144 # Maybe print SKIP message
1145 test -z "$skip_all" || skip_all="# SKIP $skip_all"
1146 case "$test_count" in
1147 0)
1148 say "1..$test_count${skip_all:+ $skip_all}"
1149 ;;
1150 *)
1151 test -z "$skip_all" ||
1152 say_color warn "$skip_all"
1153 say "1..$test_count"
1154 ;;
1155 esac
d998bd4a 1156 fi
abc5d372 1157
06478dab 1158 if test -z "$debug"
4d0912a2 1159 then
06478dab 1160 test -d "$TRASH_DIRECTORY" ||
4d0912a2 1161 error "Tests passed but trash directory already removed before test cleanup; aborting"
abc5d372 1162
06478dab 1163 cd "$TRASH_DIRECTORY/.." &&
046e90d1
JS
1164 rm -fr "$TRASH_DIRECTORY" || {
1165 # try again in a bit
1166 sleep 5;
1167 rm -fr "$TRASH_DIRECTORY"
1168 } ||
4d0912a2 1169 error "Tests passed but test cleanup failed; aborting"
4d0912a2 1170 fi
342e9ef2
TR
1171 test_at_end_hook_
1172
e1970ce4
JH
1173 exit 0 ;;
1174
1175 *)
1c0cc756
RJ
1176 if test $test_external_has_tap -eq 0
1177 then
633fe50a
TR
1178 say_color error "# failed $test_failure among $msg"
1179 say "1..$test_count"
d998bd4a 1180 fi
5099b99d 1181
e1970ce4
JH
1182 exit 1 ;;
1183
1184 esac
1185}
1186
e4597aae 1187if test -n "$valgrind"
4e1be63c 1188then
4e1be63c
JS
1189 make_symlink () {
1190 test -h "$2" &&
1191 test "$1" = "$(readlink "$2")" || {
1192 # be super paranoid
1193 if mkdir "$2".lock
1194 then
1195 rm -f "$2" &&
1196 ln -s "$1" "$2" &&
1197 rm -r "$2".lock
1198 else
1199 while test -d "$2".lock
1200 do
1201 say "Waiting for lock on $2."
1202 sleep 1
1203 done
1204 fi
1205 }
1206 }
1207
1208 make_valgrind_symlink () {
36bfb0e5 1209 # handle only executables, unless they are shell libraries that
11d62145 1210 # need to be in the exec-path.
36bfb0e5 1211 test -x "$1" ||
2a59a6ef 1212 test "# " = "$(test_copy_bytes 2 <"$1")" ||
36bfb0e5 1213 return;
4e1be63c
JS
1214
1215 base=$(basename "$1")
28fab7b2
RS
1216 case "$base" in
1217 test-*)
1218 symlink_target="$GIT_BUILD_DIR/t/helper/$base"
1219 ;;
1220 *)
1221 symlink_target="$GIT_BUILD_DIR/$base"
1222 ;;
1223 esac
4e1be63c
JS
1224 # do not override scripts
1225 if test -x "$symlink_target" &&
1226 test ! -d "$symlink_target" &&
2a59a6ef 1227 test "#!" != "$(test_copy_bytes 2 <"$symlink_target")"
4e1be63c
JS
1228 then
1229 symlink_target=../valgrind.sh
1230 fi
efd92ffd
JS
1231 case "$base" in
1232 *.sh|*.perl)
1233 symlink_target=../unprocessed-script
1234 esac
4e1be63c
JS
1235 # create the link, or replace it if it is out of date
1236 make_symlink "$symlink_target" "$GIT_VALGRIND/bin/$base" || exit
1237 }
1238
26a07309
TR
1239 # override all git executables in TEST_DIRECTORY/..
1240 GIT_VALGRIND=$TEST_DIRECTORY/valgrind
1241 mkdir -p "$GIT_VALGRIND"/bin
503e2241 1242 for file in $GIT_BUILD_DIR/git* $GIT_BUILD_DIR/t/helper/test-*
26a07309
TR
1243 do
1244 make_valgrind_symlink $file
1245 done
1246 # special-case the mergetools loadables
1247 make_symlink "$GIT_BUILD_DIR"/mergetools "$GIT_VALGRIND/bin/mergetools"
1248 OLDIFS=$IFS
1249 IFS=:
1250 for path in $PATH
1251 do
1252 ls "$path"/git-* 2> /dev/null |
1253 while read file
ad0e6233 1254 do
26a07309 1255 make_valgrind_symlink "$file"
ad0e6233 1256 done
26a07309
TR
1257 done
1258 IFS=$OLDIFS
4e1be63c
JS
1259 PATH=$GIT_VALGRIND/bin:$PATH
1260 GIT_EXEC_PATH=$GIT_VALGRIND/bin
1261 export GIT_VALGRIND
952af351
TR
1262 GIT_VALGRIND_MODE="$valgrind"
1263 export GIT_VALGRIND_MODE
5dfc368f 1264 GIT_VALGRIND_ENABLED=t
26a07309 1265 test -n "$valgrind_only" && GIT_VALGRIND_ENABLED=
5dfc368f 1266 export GIT_VALGRIND_ENABLED
1c0cc756
RJ
1267elif test -n "$GIT_TEST_INSTALLED"
1268then
e4597aae
MO
1269 GIT_EXEC_PATH=$($GIT_TEST_INSTALLED/git --exec-path) ||
1270 error "Cannot run git from $GIT_TEST_INSTALLED."
16df35cb 1271 PATH=$GIT_TEST_INSTALLED:$GIT_BUILD_DIR/t/helper:$PATH
e4597aae
MO
1272 GIT_EXEC_PATH=${GIT_TEST_EXEC_PATH:-$GIT_EXEC_PATH}
1273else # normal case, use ../bin-wrappers only unless $with_dashes:
dd167a30 1274 if test -n "$no_bin_wrappers"
1c0cc756 1275 then
dd167a30
JS
1276 with_dashes=t
1277 else
1278 git_bin_dir="$GIT_BUILD_DIR/bin-wrappers"
1279 if ! test -x "$git_bin_dir/git"
1c0cc756 1280 then
dd167a30
JS
1281 if test -z "$with_dashes"
1282 then
1283 say "$git_bin_dir/git is not executable; using GIT_EXEC_PATH"
1284 fi
1285 with_dashes=t
e4597aae 1286 fi
dd167a30 1287 PATH="$git_bin_dir:$PATH"
e4597aae 1288 fi
6cec5c68 1289 GIT_EXEC_PATH=$GIT_BUILD_DIR
1c0cc756
RJ
1290 if test -n "$with_dashes"
1291 then
ca7312d3 1292 PATH="$GIT_BUILD_DIR:$GIT_BUILD_DIR/t/helper:$PATH"
e4597aae 1293 fi
4e1be63c 1294fi
6cec5c68 1295GIT_TEMPLATE_DIR="$GIT_BUILD_DIR"/templates/blt
8bfa6bd6 1296GIT_CONFIG_NOSYSTEM=1
3c995beb 1297GIT_ATTR_NOSYSTEM=1
8f323c00 1298export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG_NOSYSTEM GIT_ATTR_NOSYSTEM
49ccb087 1299
5e87eae9
JH
1300if test -z "$GIT_TEST_CMP"
1301then
1302 if test -n "$GIT_TEST_CMP_USE_COPIED_CONTEXT"
1303 then
1304 GIT_TEST_CMP="$DIFF -c"
1305 else
1306 GIT_TEST_CMP="$DIFF -u"
1307 fi
1308fi
1309
20d2a30f 1310GITPERLLIB="$GIT_BUILD_DIR"/perl/build/lib
6fcca938 1311export GITPERLLIB
6cec5c68 1312test -d "$GIT_BUILD_DIR"/templates/blt || {
eea42069
JH
1313 error "You haven't built things yet, have you?"
1314}
e1970ce4 1315
d609615f 1316if ! test -x "$GIT_BUILD_DIR"/t/helper/test-tool$X
1c0cc756 1317then
0e496492
NTND
1318 echo >&2 'You need to build test-tool:'
1319 echo >&2 'Run "make t/helper/test-tool" in the source (toplevel) directory'
56cf9806
EW
1320 exit 1
1321fi
1322
e1970ce4 1323# Test repository
38b074de 1324rm -fr "$TRASH_DIRECTORY" || {
6e7b5aaf 1325 GIT_EXIT_OK=t
8d14ac94
JH
1326 echo >&5 "FATAL: Cannot prepare test area"
1327 exit 1
1328}
1329
90cff968 1330HOME="$TRASH_DIRECTORY"
0ea47f9d
JH
1331GNUPGHOME="$HOME/gnupg-home-not-used"
1332export HOME GNUPGHOME
90cff968 1333
1c0cc756
RJ
1334if test -z "$TEST_NO_CREATE_REPO"
1335then
38b074de 1336 test_create_repo "$TRASH_DIRECTORY"
342e9ef2 1337else
38b074de 1338 mkdir -p "$TRASH_DIRECTORY"
342e9ef2 1339fi
22231908 1340
1bd9c648
LW
1341# Use -P to resolve symlinks in our working directory so that the cwd
1342# in subprocesses like git equals our $PWD (for pathname comparisons).
38b074de 1343cd -P "$TRASH_DIRECTORY" || exit 1
04ece593 1344
d5d9de1b
JS
1345this_test=${0##*/}
1346this_test=${this_test%%-*}
e6a6ddc9
TR
1347if match_pattern_list "$this_test" $GIT_SKIP_TESTS
1348then
1349 say_color info >&3 "skipping test $this_test altogether"
1350 skip_all="skip all tests in $this_test"
1351 test_done
1352fi
f17e9fbb 1353
22231908
JS
1354if test -n "$write_junit_xml"
1355then
1356 junit_xml_dir="$TEST_OUTPUT_DIRECTORY/out"
1357 mkdir -p "$junit_xml_dir"
1358 junit_xml_base=${0##*/}
1359 junit_xml_path="$junit_xml_dir/TEST-${junit_xml_base%.sh}.xml"
1360 junit_attrs="name=\"${junit_xml_base%.sh}\""
1361 junit_attrs="$junit_attrs timestamp=\"$(TZ=UTC \
1362 date +%Y-%m-%dT%H:%M:%S)\""
1363 write_junit_xml --truncate "<testsuites>" " <testsuite $junit_attrs>"
1364 junit_suite_start=$(test-tool date getnanos)
af9912ef
JS
1365 if test -n "$GIT_TEST_TEE_OUTPUT_FILE"
1366 then
1367 GIT_TEST_TEE_OFFSET=0
1368 fi
22231908
JS
1369fi
1370
11f470ae
JH
1371# Provide an implementation of the 'yes' utility; the upper bound
1372# limit is there to help Windows that cannot stop this loop from
1373# wasting cycles when the downstream stops reading, so do not be
1374# tempted to turn it into an infinite loop. cf. 6129c930 ("test-lib:
1375# limit the output of the yes utility", 2016-02-02)
8648732e
BC
1376yes () {
1377 if test $# = 0
1378 then
1379 y=y
1380 else
1381 y="$*"
1382 fi
1383
6129c930
JS
1384 i=0
1385 while test $i -lt 99
8648732e 1386 do
6129c930
JS
1387 echo "$y"
1388 i=$(($i+1))
8648732e
BC
1389 done
1390}
1391
f17e9fbb 1392# Fix some commands on Windows
d98b2c5f
JS
1393uname_s=$(uname -s)
1394case $uname_s in
f17e9fbb
JS
1395*MINGW*)
1396 # Windows has its own (incompatible) sort and find
1397 sort () {
1398 /usr/bin/sort "$@"
1399 }
1400 find () {
1401 /usr/bin/find "$@"
1402 }
4114156a
JS
1403 # git sees Windows-style pwd
1404 pwd () {
1405 builtin pwd -W
1406 }
ee9fb68c 1407 # no POSIX permissions
6fd1106a 1408 # backslashes in pathspec are converted to '/'
fb9a2bea 1409 # exec does not inherit the PID
a94114ad 1410 test_set_prereq MINGW
5f4e02e5 1411 test_set_prereq NATIVE_CRLF
a31d0665 1412 test_set_prereq SED_STRIPS_CR
97669eed 1413 test_set_prereq GREP_STRIPS_CR
4d715ac0 1414 GIT_TEST_CMP=mingw_test_cmp
a31d0665
RJ
1415 ;;
1416*CYGWIN*)
1417 test_set_prereq POSIXPERM
a31d0665 1418 test_set_prereq EXECKEEPSPID
cfa96496 1419 test_set_prereq CYGWIN
a31d0665 1420 test_set_prereq SED_STRIPS_CR
97669eed 1421 test_set_prereq GREP_STRIPS_CR
ee9fb68c
JS
1422 ;;
1423*)
1424 test_set_prereq POSIXPERM
6fd1106a 1425 test_set_prereq BSLASHPSPEC
fb9a2bea 1426 test_set_prereq EXECKEEPSPID
f17e9fbb
JS
1427 ;;
1428esac
704a3143 1429
b082687c 1430( COLUMNS=1 && test $COLUMNS = 1 ) && test_set_prereq COLUMNS_CAN_BE_1
1b19ccd2 1431test -z "$NO_PERL" && test_set_prereq PERL
68c7d276 1432test -z "$NO_PTHREADS" && test_set_prereq PTHREADS
d4e1b47a 1433test -z "$NO_PYTHON" && test_set_prereq PYTHON
94da9193 1434test -n "$USE_LIBPCRE1$USE_LIBPCRE2" && test_set_prereq PCRE
ce9a2570
ÆAB
1435test -n "$USE_LIBPCRE1" && test_set_prereq LIBPCRE1
1436test -n "$USE_LIBPCRE2" && test_set_prereq LIBPCRE2
5e9637c6 1437test -z "$NO_GETTEXT" && test_set_prereq GETTEXT
1b19ccd2 1438
6cdccfce
ÆAB
1439if test -n "$GIT_TEST_GETTEXT_POISON_ORIG"
1440then
1441 GIT_TEST_GETTEXT_POISON=$GIT_TEST_GETTEXT_POISON_ORIG
f88b9cb6 1442 export GIT_TEST_GETTEXT_POISON
6cdccfce
ÆAB
1443 unset GIT_TEST_GETTEXT_POISON_ORIG
1444fi
1445
bb946bba 1446# Can we rely on git's output in the C locale?
6cdccfce 1447if test -z "$GIT_TEST_GETTEXT_POISON"
30955229 1448then
30955229
JN
1449 test_set_prereq C_LOCALE_OUTPUT
1450fi
bb946bba 1451
4592e608
NTND
1452if test -z "$GIT_TEST_CHECK_CACHE_TREE"
1453then
1454 GIT_TEST_CHECK_CACHE_TREE=true
1455 export GIT_TEST_CHECK_CACHE_TREE
1456fi
1457
20073274
AS
1458test_lazy_prereq PIPE '
1459 # test whether the filesystem supports FIFOs
7b7bea23
RJ
1460 test_have_prereq !MINGW,!CYGWIN &&
1461 rm -f testfifo && mkfifo testfifo
20073274
AS
1462'
1463
04083f27
JH
1464test_lazy_prereq SYMLINKS '
1465 # test whether the filesystem supports symbolic links
1466 ln -s x y && test -h y
1467'
c91cfd19 1468
b018c735
JN
1469test_lazy_prereq FILEMODE '
1470 test "$(git config --bool core.filemode)" = true
1471'
1472
ac39aa61
MG
1473test_lazy_prereq CASE_INSENSITIVE_FS '
1474 echo good >CamelCase &&
1475 echo bad >camelcase &&
1476 test "$(cat CamelCase)" != good
1477'
1478
6ec63305
WC
1479test_lazy_prereq FUNNYNAMES '
1480 test_have_prereq !MINGW &&
1481 touch -- \
1482 "FUNNYNAMES tab embedded" \
1483 "FUNNYNAMES \"quote embedded\"" \
1484 "FUNNYNAMES newline
1485embedded" 2>/dev/null &&
1486 rm -- \
1487 "FUNNYNAMES tab embedded" \
1488 "FUNNYNAMES \"quote embedded\"" \
1489 "FUNNYNAMES newline
1490embedded" 2>/dev/null
1491'
1492
5b0b5dd4
MG
1493test_lazy_prereq UTF8_NFD_TO_NFC '
1494 # check whether FS converts nfd unicode to nfc
1495 auml=$(printf "\303\244")
1496 aumlcdiar=$(printf "\141\314\210")
1497 >"$auml" &&
742ae10e 1498 test -f "$aumlcdiar"
5b0b5dd4
MG
1499'
1500
09feffb6
JK
1501test_lazy_prereq AUTOIDENT '
1502 sane_unset GIT_AUTHOR_NAME &&
1503 sane_unset GIT_AUTHOR_EMAIL &&
1504 git var GIT_AUTHOR_IDENT
1505'
1506
6219bb22
JH
1507test_lazy_prereq EXPENSIVE '
1508 test -n "$GIT_TEST_LONG"
1509'
1510
5b1fe6eb
ÆAB
1511test_lazy_prereq EXPENSIVE_ON_WINDOWS '
1512 test_have_prereq EXPENSIVE || test_have_prereq !MINGW,!CYGWIN
1513'
1514
e1ecd9e3
JH
1515test_lazy_prereq USR_BIN_TIME '
1516 test -x /usr/bin/time
1517'
1518
1767c517
JK
1519test_lazy_prereq NOT_ROOT '
1520 uid=$(id -u) &&
1521 test "$uid" != 0
1522'
1523
63b747ce 1524test_lazy_prereq JGIT '
abd0f289 1525 jgit --version
63b747ce
JT
1526'
1527
719c3da2
JH
1528# SANITY is about "can you correctly predict what the filesystem would
1529# do by only looking at the permission bits of the files and
1530# directories?" A typical example of !SANITY is running the test
1531# suite as root, where a test may expect "chmod -r file && cat file"
1532# to fail because file is supposed to be unreadable after a successful
1533# chmod. In an environment (i.e. combination of what filesystem is
1534# being used and who is running the tests) that lacks SANITY, you may
1535# be able to delete or create a file when the containing directory
1536# doesn't have write permissions, or access a file even if the
1537# containing directory doesn't have read or execute permissions.
1538
f400e51c
TB
1539test_lazy_prereq SANITY '
1540 mkdir SANETESTD.1 SANETESTD.2 &&
1541
1542 chmod +w SANETESTD.1 SANETESTD.2 &&
1543 >SANETESTD.1/x 2>SANETESTD.2/x &&
1544 chmod -w SANETESTD.1 &&
719c3da2 1545 chmod -r SANETESTD.1/x &&
f400e51c 1546 chmod -rx SANETESTD.2 ||
165293af 1547 BUG "cannot prepare SANETESTD"
f400e51c 1548
719c3da2 1549 ! test -r SANETESTD.1/x &&
f400e51c
TB
1550 ! rm SANETESTD.1/x && ! test -f SANETESTD.2/x
1551 status=$?
1552
1553 chmod +rwx SANETESTD.1 SANETESTD.2 &&
1554 rm -rf SANETESTD.1 SANETESTD.2 ||
165293af 1555 BUG "cannot clean SANETESTD"
f400e51c
TB
1556 return $status
1557'
f838ce58 1558
d98b2c5f 1559test FreeBSD != $uname_s || GIT_UNZIP=${GIT_UNZIP:-/usr/local/bin/unzip}
f838ce58
JK
1560GIT_UNZIP=${GIT_UNZIP:-unzip}
1561test_lazy_prereq UNZIP '
1562 "$GIT_UNZIP" -v
1563 test $? -ne 127
1564'
9a308de3
JK
1565
1566run_with_limited_cmdline () {
1567 (ulimit -s 128 && "$@")
1568}
1569
21dac1de
RJ
1570test_lazy_prereq CMDLINE_LIMIT '
1571 test_have_prereq !MINGW,!CYGWIN &&
1572 run_with_limited_cmdline true
1573'
6b9c38e1 1574
4db464f8
MG
1575run_with_limited_stack () {
1576 (ulimit -s 128 && "$@")
1577}
1578
21dac1de
RJ
1579test_lazy_prereq ULIMIT_STACK_SIZE '
1580 test_have_prereq !MINGW,!CYGWIN &&
1581 run_with_limited_stack true
1582'
4db464f8 1583
6b9c38e1
JK
1584build_option () {
1585 git version --build-options |
1586 sed -ne "s/^$1: //p"
1587}
1588
1589test_lazy_prereq LONG_IS_64BIT '
1590 test 8 -le "$(build_option sizeof-long)"
1591'
a07fb050 1592
a801a7cf
NTND
1593test_lazy_prereq TIME_IS_64BIT 'test-tool date is64bit'
1594test_lazy_prereq TIME_T_IS_64BIT 'test-tool date time_t-is64bit'
e9184b07
JK
1595
1596test_lazy_prereq CURL '
1597 curl --version
1598'
d16ab634 1599
1600# SHA1 is a test if the hash algorithm in use is SHA-1. This is both for tests
1601# which will not work with other hash algorithms and tests that work but don't
1602# test anything meaningful (e.g. special values which cause short collisions).
1603test_lazy_prereq SHA1 '
1604 test $(git hash-object /dev/null) = e69de29bb2d1d6434b8b29ae775ad8c2e48c5391
1605'
11aad464
JS
1606
1607test_lazy_prereq REBASE_P '
1608 test -z "$GIT_TEST_SKIP_REBASE_P"
1609'
dfe1a17d
ÆAB
1610
1611test_lazy_prereq FAIL_PREREQS '
1612 test -n "$GIT_TEST_FAIL_PREREQS"
1613'