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