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