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