clone_submodule: avoid using `access()` on directories
[git.git] / t / test-lib.sh
blob251b22ba5a8d85820f532b8fb4d78276321fde17
1 # Test framework for git. See t/README for usage.
3 # Copyright (c) 2005 Junio C Hamano
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.
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.
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/ .
18 # Test the binaries we have just built. The tests are kept in
19 # t/ subdirectory and are run in 'trash directory' subdirectory.
20 if test -z "$TEST_DIRECTORY"
21 then
22 # ensure that TEST_DIRECTORY is an absolute path so that it
23 # is valid even if the current working directory is changed
24 TEST_DIRECTORY=$(pwd)
25 else
26 # The TEST_DIRECTORY will always be the path to the "t"
27 # directory in the git.git checkout. This is overridden by
28 # e.g. t/lib-subtest.sh, but only because its $(pwd) is
29 # different. Those tests still set "$TEST_DIRECTORY" to the
30 # same path.
32 # See use of "$GIT_BUILD_DIR" and "$TEST_DIRECTORY" below for
33 # hard assumptions about "$GIT_BUILD_DIR/t" existing and being
34 # the "$TEST_DIRECTORY", and e.g. "$TEST_DIRECTORY/helper"
35 # needing to exist.
36 TEST_DIRECTORY=$(cd "$TEST_DIRECTORY" && pwd) || exit 1
38 if test -z "$TEST_OUTPUT_DIRECTORY"
39 then
40 # Similarly, override this to store the test-results subdir
41 # elsewhere
42 TEST_OUTPUT_DIRECTORY=$TEST_DIRECTORY
44 GIT_BUILD_DIR="${TEST_DIRECTORY%/t}"
45 if test "$TEST_DIRECTORY" = "$GIT_BUILD_DIR"
46 then
47 echo "PANIC: Running in a $TEST_DIRECTORY that doesn't end in '/t'?" >&2
48 exit 1
50 if test -f "$GIT_BUILD_DIR/GIT-BUILD-DIR"
51 then
52 GIT_BUILD_DIR="$(cat "$GIT_BUILD_DIR/GIT-BUILD-DIR")" || exit 1
53 # On Windows, we must convert Windows paths lest they contain a colon
54 case "$(uname -s)" in
55 *MINGW*)
56 GIT_BUILD_DIR="$(cygpath -au "$GIT_BUILD_DIR")"
58 esac
61 # Prepend a string to a VAR using an arbitrary ":" delimiter, not
62 # adding the delimiter if VAR or VALUE is empty. I.e. a generalized:
64 # VAR=$1${VAR:+${1:+$2}$VAR}
66 # Usage (using ":" as the $2 delimiter):
68 # prepend_var VAR : VALUE
69 prepend_var () {
70 eval "$1=\"$3\${$1:+${3:+$2}\$$1}\""
73 # If [AL]SAN is in effect we want to abort so that we notice
74 # problems. The GIT_SAN_OPTIONS variable can be used to set common
75 # defaults shared between [AL]SAN_OPTIONS.
76 prepend_var GIT_SAN_OPTIONS : abort_on_error=1
77 prepend_var GIT_SAN_OPTIONS : strip_path_prefix="$GIT_BUILD_DIR/"
79 # If we were built with ASAN, it may complain about leaks
80 # of program-lifetime variables. Disable it by default to lower
81 # the noise level. This needs to happen at the start of the script,
82 # before we even do our "did we build git yet" check (since we don't
83 # want that one to complain to stderr).
84 prepend_var ASAN_OPTIONS : $GIT_SAN_OPTIONS
85 prepend_var ASAN_OPTIONS : detect_leaks=0
86 export ASAN_OPTIONS
88 prepend_var LSAN_OPTIONS : $GIT_SAN_OPTIONS
89 prepend_var LSAN_OPTIONS : fast_unwind_on_malloc=0
90 export LSAN_OPTIONS
92 if test ! -f "$GIT_BUILD_DIR"/GIT-BUILD-OPTIONS
93 then
94 echo >&2 'error: GIT-BUILD-OPTIONS missing (has Git been built?).'
95 exit 1
97 . "$GIT_BUILD_DIR"/GIT-BUILD-OPTIONS
98 export PERL_PATH SHELL_PATH
100 # In t0000, we need to override test directories of nested testcases. In case
101 # the developer has TEST_OUTPUT_DIRECTORY part of his build options, then we'd
102 # reset this value to instead contain what the developer has specified. We thus
103 # have this knob to allow overriding the directory.
104 if test -n "${TEST_OUTPUT_DIRECTORY_OVERRIDE}"
105 then
106 TEST_OUTPUT_DIRECTORY="${TEST_OUTPUT_DIRECTORY_OVERRIDE}"
109 # Disallow the use of abbreviated options in the test suite by default
110 if test -z "${GIT_TEST_DISALLOW_ABBREVIATED_OPTIONS}"
111 then
112 GIT_TEST_DISALLOW_ABBREVIATED_OPTIONS=true
113 export GIT_TEST_DISALLOW_ABBREVIATED_OPTIONS
116 # Explicitly set the default branch name for testing, to avoid the
117 # transitory "git init" warning under --verbose.
118 : ${GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME:=master}
119 export GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME
121 ################################################################
122 # It appears that people try to run tests without building...
123 "${GIT_TEST_INSTALLED:-$GIT_BUILD_DIR}/git$X" >/dev/null
124 if test $? != 1
125 then
126 if test -n "$GIT_TEST_INSTALLED"
127 then
128 echo >&2 "error: there is no working Git at '$GIT_TEST_INSTALLED'"
129 else
130 echo >&2 'error: you do not seem to have built git yet.'
132 exit 1
135 store_arg_to=
136 opt_required_arg=
137 # $1: option string
138 # $2: name of the var where the arg will be stored
139 mark_option_requires_arg () {
140 if test -n "$opt_required_arg"
141 then
142 echo "error: options that require args cannot be bundled" \
143 "together: '$opt_required_arg' and '$1'" >&2
144 exit 1
146 opt_required_arg=$1
147 store_arg_to=$2
150 # These functions can be overridden e.g. to output JUnit XML
151 start_test_output () { :; }
152 start_test_case_output () { :; }
153 finalize_test_case_output () { :; }
154 finalize_test_output () { :; }
156 parse_option () {
157 local opt="$1"
159 case "$opt" in
160 -d|--d|--de|--deb|--debu|--debug)
161 debug=t ;;
162 -i|--i|--im|--imm|--imme|--immed|--immedi|--immedia|--immediat|--immediate)
163 immediate=t ;;
164 -l|--l|--lo|--lon|--long|--long-|--long-t|--long-te|--long-tes|--long-test|--long-tests)
165 GIT_TEST_LONG=t; export GIT_TEST_LONG ;;
167 mark_option_requires_arg "$opt" run_list
169 --run=*)
170 run_list=${opt#--*=} ;;
171 -h|--h|--he|--hel|--help)
172 help=t ;;
173 -v|--v|--ve|--ver|--verb|--verbo|--verbos|--verbose)
174 verbose=t ;;
175 --verbose-only=*)
176 verbose_only=${opt#--*=}
178 -q|--q|--qu|--qui|--quie|--quiet)
179 # Ignore --quiet under a TAP::Harness. Saying how many tests
180 # passed without the ok/not ok details is always an error.
181 test -z "$HARNESS_ACTIVE" && quiet=t ;;
182 --with-dashes)
183 with_dashes=t ;;
184 --no-bin-wrappers)
185 no_bin_wrappers=t ;;
186 --no-color)
187 color= ;;
188 --va|--val|--valg|--valgr|--valgri|--valgrin|--valgrind)
189 valgrind=memcheck
190 tee=t
192 --valgrind=*)
193 valgrind=${opt#--*=}
194 tee=t
196 --valgrind-only=*)
197 valgrind_only=${opt#--*=}
198 tee=t
200 --tee)
201 tee=t ;;
202 --root=*)
203 root=${opt#--*=} ;;
204 --chain-lint)
205 GIT_TEST_CHAIN_LINT=1 ;;
206 --no-chain-lint)
207 GIT_TEST_CHAIN_LINT=0 ;;
209 trace=t ;;
210 -V|--verbose-log)
211 verbose_log=t
212 tee=t
214 --write-junit-xml)
215 . "$TEST_DIRECTORY/test-lib-junit.sh"
217 --github-workflow-markup)
218 . "$TEST_DIRECTORY/test-lib-github-workflow-markup.sh"
220 --stress)
221 stress=t ;;
222 --stress=*)
223 echo "error: --stress does not accept an argument: '$opt'" >&2
224 echo "did you mean --stress-jobs=${opt#*=} or --stress-limit=${opt#*=}?" >&2
225 exit 1
227 --stress-jobs=*)
228 stress=t;
229 stress_jobs=${opt#--*=}
230 case "$stress_jobs" in
231 *[!0-9]*|0*|"")
232 echo "error: --stress-jobs=<N> requires the number of jobs to run" >&2
233 exit 1
235 *) # Good.
237 esac
239 --stress-limit=*)
240 stress=t;
241 stress_limit=${opt#--*=}
242 case "$stress_limit" in
243 *[!0-9]*|0*|"")
244 echo "error: --stress-limit=<N> requires the number of repetitions" >&2
245 exit 1
247 *) # Good.
249 esac
251 --invert-exit-code)
252 invert_exit_code=t
255 echo "error: unknown test option '$opt'" >&2; exit 1 ;;
256 esac
259 # Parse options while taking care to leave $@ intact, so we will still
260 # have all the original command line options when executing the test
261 # script again for '--tee' and '--verbose-log' later.
262 for opt
264 if test -n "$store_arg_to"
265 then
266 eval $store_arg_to=\$opt
267 store_arg_to=
268 opt_required_arg=
269 continue
272 case "$opt" in
273 --*|-?)
274 parse_option "$opt" ;;
275 -?*)
276 # bundled short options must be fed separately to parse_option
277 opt=${opt#-}
278 while test -n "$opt"
280 extra=${opt#?}
281 this=${opt%$extra}
282 opt=$extra
283 parse_option "-$this"
284 done
287 echo "error: unknown test option '$opt'" >&2; exit 1 ;;
288 esac
289 done
290 if test -n "$store_arg_to"
291 then
292 echo "error: $opt_required_arg requires an argument" >&2
293 exit 1
296 if test -n "$valgrind_only"
297 then
298 test -z "$valgrind" && valgrind=memcheck
299 test -z "$verbose" && verbose_only="$valgrind_only"
300 elif test -n "$valgrind"
301 then
302 test -z "$verbose_log" && verbose=t
305 if test -n "$stress"
306 then
307 verbose=t
308 trace=t
309 immediate=t
312 TEST_STRESS_JOB_SFX="${GIT_TEST_STRESS_JOB_NR:+.stress-$GIT_TEST_STRESS_JOB_NR}"
313 TEST_NAME="$(basename "$0" .sh)"
314 TEST_NUMBER="${TEST_NAME%%-*}"
315 TEST_NUMBER="${TEST_NUMBER#t}"
316 TEST_RESULTS_DIR="$TEST_OUTPUT_DIRECTORY/test-results"
317 TEST_RESULTS_BASE="$TEST_RESULTS_DIR/$TEST_NAME$TEST_STRESS_JOB_SFX"
318 TEST_RESULTS_SAN_FILE_PFX=trace
319 TEST_RESULTS_SAN_DIR_SFX=leak
320 TEST_RESULTS_SAN_FILE=
321 TEST_RESULTS_SAN_DIR="$TEST_RESULTS_DIR/$TEST_NAME.$TEST_RESULTS_SAN_DIR_SFX"
322 TEST_RESULTS_SAN_DIR_NR_LEAKS_STARTUP=
323 TRASH_DIRECTORY="trash directory.$TEST_NAME$TEST_STRESS_JOB_SFX"
324 test -n "$root" && TRASH_DIRECTORY="$root/$TRASH_DIRECTORY"
325 case "$TRASH_DIRECTORY" in
326 /*) ;; # absolute path is good
327 *) TRASH_DIRECTORY="$TEST_OUTPUT_DIRECTORY/$TRASH_DIRECTORY" ;;
328 esac
330 # Utility functions using $TEST_RESULTS_* variables
331 nr_san_dir_leaks_ () {
332 # stderr piped to /dev/null because the directory may have
333 # been "rmdir"'d already.
334 find "$TEST_RESULTS_SAN_DIR" \
335 -type f \
336 -name "$TEST_RESULTS_SAN_FILE_PFX.*" 2>/dev/null |
337 xargs grep -lv "Unable to get registers from thread" |
338 wc -l
341 # If --stress was passed, run this test repeatedly in several parallel loops.
342 if test "$GIT_TEST_STRESS_STARTED" = "done"
343 then
344 : # Don't stress test again.
345 elif test -n "$stress"
346 then
347 if test -n "$stress_jobs"
348 then
349 job_count=$stress_jobs
350 elif test -n "$GIT_TEST_STRESS_LOAD"
351 then
352 job_count="$GIT_TEST_STRESS_LOAD"
353 elif job_count=$(getconf _NPROCESSORS_ONLN 2>/dev/null) &&
354 test -n "$job_count"
355 then
356 job_count=$((2 * $job_count))
357 else
358 job_count=8
361 mkdir -p "$TEST_RESULTS_DIR"
362 stressfail="$TEST_RESULTS_BASE.stress-failed"
363 rm -f "$stressfail"
365 stress_exit=0
366 trap '
367 kill $job_pids 2>/dev/null
368 wait
369 stress_exit=1
370 ' TERM INT HUP
372 job_pids=
373 job_nr=0
374 while test $job_nr -lt "$job_count"
377 GIT_TEST_STRESS_STARTED=done
378 GIT_TEST_STRESS_JOB_NR=$job_nr
379 export GIT_TEST_STRESS_STARTED GIT_TEST_STRESS_JOB_NR
381 trap '
382 kill $test_pid 2>/dev/null
383 wait
384 exit 1
385 ' TERM INT
387 cnt=1
388 while ! test -e "$stressfail" &&
389 { test -z "$stress_limit" ||
390 test $cnt -le $stress_limit ; }
392 $TEST_SHELL_PATH "$0" "$@" >"$TEST_RESULTS_BASE.stress-$job_nr.out" 2>&1 &
393 test_pid=$!
395 if wait $test_pid
396 then
397 printf "OK %2d.%d\n" $GIT_TEST_STRESS_JOB_NR $cnt
398 else
399 echo $GIT_TEST_STRESS_JOB_NR >>"$stressfail"
400 printf "FAIL %2d.%d\n" $GIT_TEST_STRESS_JOB_NR $cnt
402 cnt=$(($cnt + 1))
403 done
405 job_pids="$job_pids $!"
406 job_nr=$(($job_nr + 1))
407 done
409 wait
411 if test -f "$stressfail"
412 then
413 stress_exit=1
414 echo "Log(s) of failed test run(s):"
415 for failed_job_nr in $(sort -n "$stressfail")
417 echo "Contents of '$TEST_RESULTS_BASE.stress-$failed_job_nr.out':"
418 cat "$TEST_RESULTS_BASE.stress-$failed_job_nr.out"
419 done
420 rm -rf "$TRASH_DIRECTORY.stress-failed"
421 # Move the last one.
422 mv "$TRASH_DIRECTORY.stress-$failed_job_nr" "$TRASH_DIRECTORY.stress-failed"
425 exit $stress_exit
428 # if --tee was passed, write the output not only to the terminal, but
429 # additionally to the file test-results/$BASENAME.out, too.
430 if test "$GIT_TEST_TEE_STARTED" = "done"
431 then
432 : # do not redirect again
433 elif test -n "$tee"
434 then
435 mkdir -p "$TEST_RESULTS_DIR"
437 # Make this filename available to the sub-process in case it is using
438 # --verbose-log.
439 GIT_TEST_TEE_OUTPUT_FILE=$TEST_RESULTS_BASE.out
440 export GIT_TEST_TEE_OUTPUT_FILE
442 # Truncate before calling "tee -a" to get rid of the results
443 # from any previous runs.
444 >"$GIT_TEST_TEE_OUTPUT_FILE"
446 (GIT_TEST_TEE_STARTED=done ${TEST_SHELL_PATH} "$0" "$@" 2>&1;
447 echo $? >"$TEST_RESULTS_BASE.exit") | tee -a "$GIT_TEST_TEE_OUTPUT_FILE"
448 test "$(cat "$TEST_RESULTS_BASE.exit")" = 0
449 exit
452 if test -n "$trace" && test -n "$test_untraceable"
453 then
454 # '-x' tracing requested, but this test script can't be reliably
455 # traced, unless it is run with a Bash version supporting
456 # BASH_XTRACEFD (introduced in Bash v4.1).
458 # Perform this version check _after_ the test script was
459 # potentially re-executed with $TEST_SHELL_PATH for '--tee' or
460 # '--verbose-log', so the right shell is checked and the
461 # warning is issued only once.
462 if test -n "$BASH_VERSION" && eval '
463 test ${BASH_VERSINFO[0]} -gt 4 || {
464 test ${BASH_VERSINFO[0]} -eq 4 &&
465 test ${BASH_VERSINFO[1]} -ge 1
468 then
469 : Executed by a Bash version supporting BASH_XTRACEFD. Good.
470 else
471 echo >&2 "warning: ignoring -x; '$0' is untraceable without BASH_XTRACEFD"
472 trace=
475 if test -n "$trace" && test -z "$verbose_log"
476 then
477 verbose=t
480 # Since bash 5.0, checkwinsize is enabled by default which does
481 # update the COLUMNS variable every time a non-builtin command
482 # completes, even for non-interactive shells.
483 # Disable that since we are aiming for repeatability.
484 test -n "$BASH_VERSION" && shopt -u checkwinsize 2>/dev/null
486 # For repeatability, reset the environment to known value.
487 # TERM is sanitized below, after saving color control sequences.
488 LANG=C
489 LC_ALL=C
490 PAGER=cat
491 TZ=UTC
492 COLUMNS=80
493 export LANG LC_ALL PAGER TZ COLUMNS
494 EDITOR=:
496 # A call to "unset" with no arguments causes at least Solaris 10
497 # /usr/xpg4/bin/sh and /bin/ksh to bail out. So keep the unsets
498 # deriving from the command substitution clustered with the other
499 # ones.
500 unset VISUAL EMAIL LANGUAGE $("$PERL_PATH" -e '
501 my @env = keys %ENV;
502 my $ok = join("|", qw(
503 TRACE
504 DEBUG
505 TEST
506 .*_TEST
507 PROVE
508 VALGRIND
509 UNZIP
510 PERF_
511 CURL_VERBOSE
512 TRACE_CURL
514 my @vars = grep(/^GIT_/ && !/^GIT_($ok)/o, @env);
515 print join("\n", @vars);
517 unset XDG_CACHE_HOME
518 unset XDG_CONFIG_HOME
519 unset GITPERLLIB
520 unset GIT_TRACE2_PARENT_NAME
521 unset GIT_TRACE2_PARENT_SID
522 TEST_AUTHOR_LOCALNAME=author
523 TEST_AUTHOR_DOMAIN=example.com
524 GIT_AUTHOR_EMAIL=${TEST_AUTHOR_LOCALNAME}@${TEST_AUTHOR_DOMAIN}
525 GIT_AUTHOR_NAME='A U Thor'
526 GIT_AUTHOR_DATE='1112354055 +0200'
527 TEST_COMMITTER_LOCALNAME=committer
528 TEST_COMMITTER_DOMAIN=example.com
529 GIT_COMMITTER_EMAIL=${TEST_COMMITTER_LOCALNAME}@${TEST_COMMITTER_DOMAIN}
530 GIT_COMMITTER_NAME='C O Mitter'
531 GIT_COMMITTER_DATE='1112354055 +0200'
532 GIT_MERGE_VERBOSITY=5
533 GIT_MERGE_AUTOEDIT=no
534 export GIT_MERGE_VERBOSITY GIT_MERGE_AUTOEDIT
535 export GIT_AUTHOR_EMAIL GIT_AUTHOR_NAME
536 export GIT_COMMITTER_EMAIL GIT_COMMITTER_NAME
537 export GIT_COMMITTER_DATE GIT_AUTHOR_DATE
538 export EDITOR
540 GIT_DEFAULT_HASH="${GIT_TEST_DEFAULT_HASH:-sha1}"
541 export GIT_DEFAULT_HASH
542 GIT_TEST_MERGE_ALGORITHM="${GIT_TEST_MERGE_ALGORITHM:-ort}"
543 export GIT_TEST_MERGE_ALGORITHM
545 # Tests using GIT_TRACE typically don't want <timestamp> <file>:<line> output
546 GIT_TRACE_BARE=1
547 export GIT_TRACE_BARE
549 # Some tests scan the GIT_TRACE2_EVENT feed for events, but the
550 # default depth is 2, which frequently causes issues when the
551 # events are wrapped in new regions. Set it to a sufficiently
552 # large depth to avoid custom changes in the test suite.
553 GIT_TRACE2_EVENT_NESTING=100
554 export GIT_TRACE2_EVENT_NESTING
556 # Use specific version of the index file format
557 if test -n "${GIT_TEST_INDEX_VERSION:+isset}"
558 then
559 GIT_INDEX_VERSION="$GIT_TEST_INDEX_VERSION"
560 export GIT_INDEX_VERSION
563 if test -n "$GIT_TEST_PERL_FATAL_WARNINGS"
564 then
565 GIT_PERL_FATAL_WARNINGS=1
566 export GIT_PERL_FATAL_WARNINGS
569 case $GIT_TEST_FSYNC in
571 GIT_TEST_FSYNC=0
572 export GIT_TEST_FSYNC
574 esac
576 # Add libc MALLOC and MALLOC_PERTURB test only if we are not executing
577 # the test with valgrind and have not compiled with conflict SANITIZE
578 # options.
579 if test -n "$valgrind" ||
580 test -n "$SANITIZE_ADDRESS" ||
581 test -n "$SANITIZE_LEAK" ||
582 test -n "$TEST_NO_MALLOC_CHECK"
583 then
584 setup_malloc_check () {
585 : nothing
587 teardown_malloc_check () {
588 : nothing
590 else
591 _USE_GLIBC_TUNABLES=
592 if _GLIBC_VERSION=$(getconf GNU_LIBC_VERSION 2>/dev/null) &&
593 _GLIBC_VERSION=${_GLIBC_VERSION#"glibc "} &&
594 expr 2.34 \<= "$_GLIBC_VERSION" >/dev/null
595 then
596 _USE_GLIBC_TUNABLES=YesPlease
598 setup_malloc_check () {
599 local g
600 local t
601 MALLOC_CHECK_=3 MALLOC_PERTURB_=165
602 export MALLOC_CHECK_ MALLOC_PERTURB_
603 if test -n "$_USE_GLIBC_TUNABLES"
604 then
606 LD_PRELOAD="libc_malloc_debug.so.0"
607 for t in \
608 glibc.malloc.check=1 \
609 glibc.malloc.perturb=165
611 g="${g#:}:$t"
612 done
613 GLIBC_TUNABLES=$g
614 export LD_PRELOAD GLIBC_TUNABLES
617 teardown_malloc_check () {
618 unset MALLOC_CHECK_ MALLOC_PERTURB_
619 unset LD_PRELOAD GLIBC_TUNABLES
623 # Protect ourselves from common misconfiguration to export
624 # CDPATH into the environment
625 unset CDPATH
627 unset GREP_OPTIONS
628 unset UNZIP
630 case $(echo $GIT_TRACE |tr "[A-Z]" "[a-z]") in
631 1|2|true)
632 GIT_TRACE=4
634 esac
636 # Line feed
637 LF='
640 # Single quote
641 SQ=\'
643 # UTF-8 ZERO WIDTH NON-JOINER, which HFS+ ignores
644 # when case-folding filenames
645 u200c=$(printf '\342\200\214')
647 export _x05 _x35 LF u200c EMPTY_TREE EMPTY_BLOB ZERO_OID OID_REGEX
649 # Each test should start with something like this, after copyright notices:
651 # test_description='Description of this test...
652 # This test checks if command xyzzy does the right thing...
654 # . ./test-lib.sh
655 test "x$TERM" != "xdumb" && (
656 test -t 1 &&
657 tput bold >/dev/null 2>&1 &&
658 tput setaf 1 >/dev/null 2>&1 &&
659 tput sgr0 >/dev/null 2>&1
660 ) &&
661 color=t
663 if test -n "$color"
664 then
665 # Save the color control sequences now rather than run tput
666 # each time say_color() is called. This is done for two
667 # reasons:
668 # * TERM will be changed to dumb
669 # * HOME will be changed to a temporary directory and tput
670 # might need to read ~/.terminfo from the original HOME
671 # directory to get the control sequences
672 # Note: This approach assumes the control sequences don't end
673 # in a newline for any terminal of interest (command
674 # substitutions strip trailing newlines). Given that most
675 # (all?) terminals in common use are related to ECMA-48, this
676 # shouldn't be a problem.
677 say_color_error=$(tput bold; tput setaf 1) # bold red
678 say_color_skip=$(tput setaf 4) # blue
679 say_color_warn=$(tput setaf 3) # brown/yellow
680 say_color_pass=$(tput setaf 2) # green
681 say_color_info=$(tput setaf 6) # cyan
682 say_color_reset=$(tput sgr0)
683 say_color_="" # no formatting for normal text
684 say_color () {
685 test -z "$1" && test -n "$quiet" && return
686 eval "say_color_color=\$say_color_$1"
687 shift
688 printf "%s\\n" "$say_color_color$*$say_color_reset"
690 else
691 say_color() {
692 test -z "$1" && test -n "$quiet" && return
693 shift
694 printf "%s\n" "$*"
698 USER_TERM="$TERM"
699 TERM=dumb
700 export TERM USER_TERM
702 # What is written by tests to stdout and stderr is sent to different places
703 # depending on the test mode (e.g. /dev/null in non-verbose mode, piped to tee
704 # with --tee option, etc.). We save the original stdin to FD #6 and stdout and
705 # stderr to #5 and #7, so that the test framework can use them (e.g. for
706 # printing errors within the test framework) independently of the test mode.
707 exec 5>&1
708 exec 6<&0
709 exec 7>&2
711 _error_exit () {
712 finalize_test_output
713 GIT_EXIT_OK=t
714 exit 1
717 error () {
718 say_color error "error: $*"
719 _error_exit
722 BUG () {
723 error >&7 "bug in the test script: $*"
726 BAIL_OUT () {
727 test $# -ne 1 && BUG "1 param"
729 # Do not change "Bail out! " string. It's part of TAP syntax:
730 # https://testanything.org/tap-specification.html
731 local bail_out="Bail out! "
732 local message="$1"
734 say_color >&5 error $bail_out "$message"
735 _error_exit
738 say () {
739 say_color info "$*"
742 if test -n "$HARNESS_ACTIVE"
743 then
744 if test "$verbose" = t || test -n "$verbose_only"
745 then
746 BAIL_OUT 'verbose mode forbidden under TAP harness; try --verbose-log'
750 test "${test_description}" != "" ||
751 error "Test script did not set test_description."
753 if test "$help" = "t"
754 then
755 printf '%s\n' "$test_description"
756 exit 0
759 if test "$verbose_log" = "t"
760 then
761 exec 3>>"$GIT_TEST_TEE_OUTPUT_FILE" 4>&3
762 elif test "$verbose" = "t"
763 then
764 exec 4>&2 3>&1
765 else
766 exec 4>/dev/null 3>/dev/null
769 # Send any "-x" output directly to stderr to avoid polluting tests
770 # which capture stderr. We can do this unconditionally since it
771 # has no effect if tracing isn't turned on.
773 # Note that this sets up the trace fd as soon as we assign the variable, so it
774 # must come after the creation of descriptor 4 above. Likewise, we must never
775 # unset this, as it has the side effect of closing descriptor 4, which we
776 # use to show verbose tests to the user.
778 # Note also that we don't need or want to export it. The tracing is local to
779 # this shell, and we would not want to influence any shells we exec.
780 BASH_XTRACEFD=4
782 test_failure=0
783 test_count=0
784 test_fixed=0
785 test_broken=0
786 test_success=0
788 test_missing_prereq=
790 test_external_has_tap=0
792 die () {
793 code=$?
794 # This is responsible for running the atexit commands even when a
795 # test script run with '--immediate' fails, or when the user hits
796 # ctrl-C, i.e. when 'test_done' is not invoked at all.
797 test_atexit_handler || code=$?
798 if test -n "$GIT_EXIT_OK"
799 then
800 exit $code
801 else
802 echo >&5 "FATAL: Unexpected exit with code $code"
803 exit 1
807 GIT_EXIT_OK=
808 trap 'die' EXIT
809 # Disable '-x' tracing, because with some shells, notably dash, it
810 # prevents running the cleanup commands when a test script run with
811 # '--verbose-log -x' is interrupted.
812 trap '{ code=$?; set +x; } 2>/dev/null; exit $code' INT TERM HUP
814 # The user-facing functions are loaded from a separate file so that
815 # test_perf subshells can have them too
816 . "$TEST_DIRECTORY/test-lib-functions.sh"
818 # You are not expected to call test_ok_ and test_failure_ directly, use
819 # the test_expect_* functions instead.
821 test_ok_ () {
822 test_success=$(($test_success + 1))
823 say_color "" "ok $test_count - $@"
824 finalize_test_case_output ok "$@"
827 _invert_exit_code_failure_end_blurb () {
828 say_color warn "# faked up failures as TODO & now exiting with 0 due to --invert-exit-code"
831 test_failure_ () {
832 failure_label=$1
833 test_failure=$(($test_failure + 1))
834 local pfx=""
835 if test -n "$invert_exit_code" # && test -n "$HARNESS_ACTIVE"
836 then
837 pfx="# TODO induced breakage (--invert-exit-code):"
839 say_color error "not ok $test_count - ${pfx:+$pfx }$1"
840 shift
841 printf '%s\n' "$*" | sed -e 's/^/# /'
842 if test -n "$immediate"
843 then
844 say_color error "1..$test_count"
845 if test -n "$invert_exit_code"
846 then
847 finalize_test_output
848 _invert_exit_code_failure_end_blurb
849 GIT_EXIT_OK=t
850 exit 0
852 _error_exit
854 finalize_test_case_output failure "$failure_label" "$@"
857 test_known_broken_ok_ () {
858 test_fixed=$(($test_fixed+1))
859 say_color error "ok $test_count - $1 # TODO known breakage vanished"
860 finalize_test_case_output fixed "$1"
863 test_known_broken_failure_ () {
864 test_broken=$(($test_broken+1))
865 say_color warn "not ok $test_count - $1 # TODO known breakage"
866 finalize_test_case_output broken "$1"
869 test_debug () {
870 test "$debug" = "" || eval "$1"
873 match_pattern_list () {
874 arg="$1"
875 shift
876 test -z "$*" && return 1
877 # We need to use "$*" to get field-splitting, but we want to
878 # disable globbing, since we are matching against an arbitrary
879 # $arg, not what's in the filesystem. Using "set -f" accomplishes
880 # that, but we must do it in a subshell to avoid impacting the
881 # rest of the script. The exit value of the subshell becomes
882 # the function's return value.
884 set -f
885 for pattern_ in $*
887 case "$arg" in
888 $pattern_)
889 exit 0
891 esac
892 done
893 exit 1
897 match_test_selector_list () {
898 operation="$1"
899 shift
900 title="$1"
901 shift
902 arg="$1"
903 shift
904 test -z "$1" && return 0
906 # Commas are accepted as separators.
907 OLDIFS=$IFS
908 IFS=','
909 set -- $1
910 IFS=$OLDIFS
912 # If the first selector is negative we include by default.
913 include=
914 case "$1" in
915 !*) include=t ;;
916 esac
918 for selector
920 orig_selector=$selector
922 positive=t
923 case "$selector" in
925 positive=
926 selector=${selector##?}
928 esac
930 test -z "$selector" && continue
932 case "$selector" in
933 *-*)
934 if expr "z${selector%%-*}" : "z[0-9]*[^0-9]" >/dev/null
935 then
936 echo "error: $operation: invalid non-numeric in range" \
937 "start: '$orig_selector'" >&2
938 exit 1
940 if expr "z${selector#*-}" : "z[0-9]*[^0-9]" >/dev/null
941 then
942 echo "error: $operation: invalid non-numeric in range" \
943 "end: '$orig_selector'" >&2
944 exit 1
948 if expr "z$selector" : "z[0-9]*[^0-9]" >/dev/null
949 then
950 case "$title" in *${selector}*)
951 include=$positive
953 esac
954 continue
956 esac
958 # Short cut for "obvious" cases
959 test -z "$include" && test -z "$positive" && continue
960 test -n "$include" && test -n "$positive" && continue
962 case "$selector" in
964 if test $arg -le ${selector#-}
965 then
966 include=$positive
970 if test $arg -ge ${selector%-}
971 then
972 include=$positive
975 *-*)
976 if test ${selector%%-*} -le $arg \
977 && test $arg -le ${selector#*-}
978 then
979 include=$positive
983 if test $arg -eq $selector
984 then
985 include=$positive
988 esac
989 done
991 test -n "$include"
994 maybe_teardown_verbose () {
995 test -z "$verbose_only" && return
996 exec 4>/dev/null 3>/dev/null
997 verbose=
1000 last_verbose=t
1001 maybe_setup_verbose () {
1002 test -z "$verbose_only" && return
1003 if match_pattern_list $test_count "$verbose_only"
1004 then
1005 exec 4>&2 3>&1
1006 # Emit a delimiting blank line when going from
1007 # non-verbose to verbose. Within verbose mode the
1008 # delimiter is printed by test_expect_*. The choice
1009 # of the initial $last_verbose is such that before
1010 # test 1, we do not print it.
1011 test -z "$last_verbose" && echo >&3 ""
1012 verbose=t
1013 else
1014 exec 4>/dev/null 3>/dev/null
1015 verbose=
1017 last_verbose=$verbose
1020 maybe_teardown_valgrind () {
1021 test -z "$GIT_VALGRIND" && return
1022 GIT_VALGRIND_ENABLED=
1025 maybe_setup_valgrind () {
1026 test -z "$GIT_VALGRIND" && return
1027 if test -z "$valgrind_only"
1028 then
1029 GIT_VALGRIND_ENABLED=t
1030 return
1032 GIT_VALGRIND_ENABLED=
1033 if match_pattern_list $test_count "$valgrind_only"
1034 then
1035 GIT_VALGRIND_ENABLED=t
1039 trace_level_=0
1040 want_trace () {
1041 test "$trace" = t && {
1042 test "$verbose" = t || test "$verbose_log" = t
1046 # This is a separate function because some tests use
1047 # "return" to end a test_expect_success block early
1048 # (and we want to make sure we run any cleanup like
1049 # "set +x").
1050 test_eval_inner_ () {
1051 # Do not add anything extra (including LF) after '$*'
1052 eval "
1053 want_trace && trace_level_=$(($trace_level_+1)) && set -x
1057 test_eval_ () {
1058 # If "-x" tracing is in effect, then we want to avoid polluting stderr
1059 # with non-test commands. But once in "set -x" mode, we cannot prevent
1060 # the shell from printing the "set +x" to turn it off (nor the saving
1061 # of $? before that). But we can make sure that the output goes to
1062 # /dev/null.
1064 # There are a few subtleties here:
1066 # - we have to redirect descriptor 4 in addition to 2, to cover
1067 # BASH_XTRACEFD
1069 # - the actual eval has to come before the redirection block (since
1070 # it needs to see descriptor 4 to set up its stderr)
1072 # - likewise, any error message we print must be outside the block to
1073 # access descriptor 4
1075 # - checking $? has to come immediately after the eval, but it must
1076 # be _inside_ the block to avoid polluting the "set -x" output
1079 test_eval_inner_ "$@" </dev/null >&3 2>&4
1081 test_eval_ret_=$?
1082 if want_trace
1083 then
1084 test 1 = $trace_level_ && set +x
1085 trace_level_=$(($trace_level_-1))
1087 } 2>/dev/null 4>&2
1089 if test "$test_eval_ret_" != 0 && want_trace
1090 then
1091 say_color error >&4 "error: last command exited with \$?=$test_eval_ret_"
1093 return $test_eval_ret_
1096 test_run_ () {
1097 test_cleanup=:
1098 expecting_failure=$2
1100 if test "${GIT_TEST_CHAIN_LINT:-1}" != 0; then
1101 # turn off tracing for this test-eval, as it simply creates
1102 # confusing noise in the "-x" output
1103 trace_tmp=$trace
1104 trace=
1105 # 117 is magic because it is unlikely to match the exit
1106 # code of other programs
1107 if test "OK-117" != "$(test_eval_ "(exit 117) && $1${LF}${LF}echo OK-\$?" 3>&1)"
1108 then
1109 BUG "broken &&-chain or run-away HERE-DOC: $1"
1111 trace=$trace_tmp
1114 setup_malloc_check
1115 test_eval_ "$1"
1116 eval_ret=$?
1117 teardown_malloc_check
1119 if test -z "$immediate" || test $eval_ret = 0 ||
1120 test -n "$expecting_failure" && test "$test_cleanup" != ":"
1121 then
1122 setup_malloc_check
1123 test_eval_ "$test_cleanup"
1124 teardown_malloc_check
1126 if test "$verbose" = "t" && test -n "$HARNESS_ACTIVE"
1127 then
1128 echo ""
1130 return "$eval_ret"
1133 test_start_ () {
1134 test_count=$(($test_count+1))
1135 maybe_setup_verbose
1136 maybe_setup_valgrind
1137 start_test_case_output "$@"
1140 test_finish_ () {
1141 echo >&3 ""
1142 maybe_teardown_valgrind
1143 maybe_teardown_verbose
1144 if test -n "$GIT_TEST_TEE_OFFSET"
1145 then
1146 GIT_TEST_TEE_OFFSET=$(test-tool path-utils file-size \
1147 "$GIT_TEST_TEE_OUTPUT_FILE")
1151 test_skip () {
1152 to_skip=
1153 skipped_reason=
1154 if match_pattern_list $this_test.$test_count "$GIT_SKIP_TESTS"
1155 then
1156 to_skip=t
1157 skipped_reason="GIT_SKIP_TESTS"
1159 if test -z "$to_skip" && test -n "$run_list" &&
1160 ! match_test_selector_list '--run' "$1" $test_count "$run_list"
1161 then
1162 to_skip=t
1163 skipped_reason="--run"
1165 if test -z "$to_skip" && test -n "$test_prereq" &&
1166 ! test_have_prereq "$test_prereq"
1167 then
1168 to_skip=t
1170 of_prereq=
1171 if test "$missing_prereq" != "$test_prereq"
1172 then
1173 of_prereq=" of $test_prereq"
1175 skipped_reason="missing $missing_prereq${of_prereq}"
1177 # Keep a list of all the missing prereq for result aggregation
1178 if test -z "$missing_prereq"
1179 then
1180 test_missing_prereq=$missing_prereq
1181 else
1182 test_missing_prereq="$test_missing_prereq,$missing_prereq"
1186 case "$to_skip" in
1189 say_color skip "ok $test_count # skip $1 ($skipped_reason)"
1190 : true
1191 finalize_test_case_output skip "$@"
1194 false
1196 esac
1199 # stub; perf-lib overrides it
1200 test_at_end_hook_ () {
1204 test_atexit_cleanup=:
1205 test_atexit_handler () {
1206 # In a succeeding test script 'test_atexit_handler' is invoked
1207 # twice: first from 'test_done', then from 'die' in the trap on
1208 # EXIT.
1209 # This condition and resetting 'test_atexit_cleanup' below makes
1210 # sure that the registered cleanup commands are run only once.
1211 test : != "$test_atexit_cleanup" || return 0
1213 setup_malloc_check
1214 test_eval_ "$test_atexit_cleanup"
1215 test_atexit_cleanup=:
1216 teardown_malloc_check
1219 sanitize_leak_log_message_ () {
1220 local new="$1" &&
1221 local old="$2" &&
1222 local file="$3" &&
1224 printf "With SANITIZE=leak at exit we have %d leak logs, but started with %d
1226 This means that we have a blindspot where git is leaking but we're
1227 losing the exit code somewhere, or not propagating it appropriately
1228 upwards!
1230 See the logs at \"%s.*\";
1231 those logs are reproduced below." \
1232 "$new" "$old" "$file"
1235 check_test_results_san_file_ () {
1236 if test -z "$TEST_RESULTS_SAN_FILE"
1237 then
1238 return
1239 fi &&
1240 local old="$TEST_RESULTS_SAN_DIR_NR_LEAKS_STARTUP" &&
1241 local new="$(nr_san_dir_leaks_)" &&
1243 if test $new -le $old
1244 then
1245 return
1246 fi &&
1247 local out="$(sanitize_leak_log_message_ "$new" "$old" "$TEST_RESULTS_SAN_FILE")" &&
1248 say_color error "$out" &&
1249 if test "$old" != 0
1250 then
1251 echo &&
1252 say_color error "The logs include output from past runs to avoid" &&
1253 say_color error "that remove 'test-results' between runs."
1254 fi &&
1255 say_color error "$(cat "$TEST_RESULTS_SAN_FILE".*)" &&
1257 if test -n "$passes_sanitize_leak" && test "$test_failure" = 0
1258 then
1259 say "As TEST_PASSES_SANITIZE_LEAK=true and our logs show we're leaking, exit non-zero!" &&
1260 invert_exit_code=t
1261 elif test -n "$passes_sanitize_leak"
1262 then
1263 say "As TEST_PASSES_SANITIZE_LEAK=true and our logs show we're leaking, and we're failing for other reasons too..." &&
1264 invert_exit_code=
1265 elif test -n "$sanitize_leak_check" && test "$test_failure" = 0
1266 then
1267 say "As TEST_PASSES_SANITIZE_LEAK=true isn't set the above leak is 'ok' with GIT_TEST_PASSING_SANITIZE_LEAK=check" &&
1268 invert_exit_code=
1269 elif test -n "$sanitize_leak_check"
1270 then
1271 say "As TEST_PASSES_SANITIZE_LEAK=true isn't set the above leak is 'ok' with GIT_TEST_PASSING_SANITIZE_LEAK=check" &&
1272 invert_exit_code=t
1273 else
1274 say "With GIT_TEST_SANITIZE_LEAK_LOG=true our logs revealed a memory leak, exit non-zero!" &&
1275 invert_exit_code=t
1279 test_done () {
1280 # Run the atexit commands _before_ the trash directory is
1281 # removed, so the commands can access pidfiles and socket files.
1282 test_atexit_handler
1284 finalize_test_output
1286 if test -z "$HARNESS_ACTIVE"
1287 then
1288 mkdir -p "$TEST_RESULTS_DIR"
1290 cat >"$TEST_RESULTS_BASE.counts" <<-EOF
1291 total $test_count
1292 success $test_success
1293 fixed $test_fixed
1294 broken $test_broken
1295 failed $test_failure
1296 missing_prereq $test_missing_prereq
1301 if test "$test_fixed" != 0
1302 then
1303 say_color error "# $test_fixed known breakage(s) vanished; please update test(s)"
1305 if test "$test_broken" != 0
1306 then
1307 say_color warn "# still have $test_broken known breakage(s)"
1309 if test "$test_broken" != 0 || test "$test_fixed" != 0
1310 then
1311 test_remaining=$(( $test_count - $test_broken - $test_fixed ))
1312 msg="remaining $test_remaining test(s)"
1313 else
1314 test_remaining=$test_count
1315 msg="$test_count test(s)"
1317 case "$test_failure" in
1319 if test $test_remaining -gt 0
1320 then
1321 say_color pass "# passed all $msg"
1324 # Maybe print SKIP message
1325 test -z "$skip_all" || skip_all="# SKIP $skip_all"
1326 case "$test_count" in
1328 say "1..$test_count${skip_all:+ $skip_all}"
1331 test -z "$skip_all" ||
1332 say_color warn "$skip_all"
1333 say "1..$test_count"
1335 esac
1337 if test -n "$stress" && test -n "$invert_exit_code"
1338 then
1339 # We're about to move our "$TRASH_DIRECTORY"
1340 # to "$TRASH_DIRECTORY.stress-failed" if
1341 # --stress is combined with
1342 # --invert-exit-code.
1343 say "with --stress and --invert-exit-code we're not removing '$TRASH_DIRECTORY'"
1344 elif test -z "$debug" && test -n "$remove_trash"
1345 then
1346 test -d "$TRASH_DIRECTORY" ||
1347 error "Tests passed but trash directory already removed before test cleanup; aborting"
1349 cd "$TRASH_DIRECTORY/.." &&
1350 rm -fr "$TRASH_DIRECTORY" || {
1351 # try again in a bit
1352 sleep 5;
1353 rm -fr "$TRASH_DIRECTORY"
1354 } ||
1355 error "Tests passed but test cleanup failed; aborting"
1358 check_test_results_san_file_ "$test_failure"
1360 if test -z "$skip_all" && test -n "$invert_exit_code"
1361 then
1362 say_color warn "# faking up non-zero exit with --invert-exit-code"
1363 GIT_EXIT_OK=t
1364 exit 1
1367 test_at_end_hook_
1369 GIT_EXIT_OK=t
1370 exit 0 ;;
1373 say_color error "# failed $test_failure among $msg"
1374 say "1..$test_count"
1376 check_test_results_san_file_ "$test_failure"
1378 if test -n "$invert_exit_code"
1379 then
1380 _invert_exit_code_failure_end_blurb
1381 GIT_EXIT_OK=t
1382 exit 0
1385 GIT_EXIT_OK=t
1386 exit 1 ;;
1388 esac
1391 if test -n "$valgrind"
1392 then
1393 make_symlink () {
1394 test -h "$2" &&
1395 test "$1" = "$(readlink "$2")" || {
1396 # be super paranoid
1397 if mkdir "$2".lock
1398 then
1399 rm -f "$2" &&
1400 ln -s "$1" "$2" &&
1401 rm -r "$2".lock
1402 else
1403 while test -d "$2".lock
1405 say "Waiting for lock on $2."
1406 sleep 1
1407 done
1412 make_valgrind_symlink () {
1413 # handle only executables, unless they are shell libraries that
1414 # need to be in the exec-path.
1415 test -x "$1" ||
1416 test "# " = "$(test_copy_bytes 2 <"$1")" ||
1417 return;
1419 base=$(basename "$1")
1420 case "$base" in
1421 test-*)
1422 symlink_target="$GIT_BUILD_DIR/t/helper/$base"
1425 symlink_target="$GIT_BUILD_DIR/$base"
1427 esac
1428 # do not override scripts
1429 if test -x "$symlink_target" &&
1430 test ! -d "$symlink_target" &&
1431 test "#!" != "$(test_copy_bytes 2 <"$symlink_target")"
1432 then
1433 symlink_target=../valgrind.sh
1435 case "$base" in
1436 *.sh|*.perl)
1437 symlink_target=../unprocessed-script
1438 esac
1439 # create the link, or replace it if it is out of date
1440 make_symlink "$symlink_target" "$GIT_VALGRIND/bin/$base" || exit
1443 # override all git executables in TEST_DIRECTORY/..
1444 GIT_VALGRIND=$TEST_DIRECTORY/valgrind
1445 mkdir -p "$GIT_VALGRIND"/bin
1446 for file in $GIT_BUILD_DIR/git* $GIT_BUILD_DIR/t/helper/test-*
1448 make_valgrind_symlink $file
1449 done
1450 # special-case the mergetools loadables
1451 make_symlink "$GIT_BUILD_DIR"/mergetools "$GIT_VALGRIND/bin/mergetools"
1452 OLDIFS=$IFS
1453 IFS=:
1454 for path in $PATH
1456 ls "$path"/git-* 2> /dev/null |
1457 while read file
1459 make_valgrind_symlink "$file"
1460 done
1461 done
1462 IFS=$OLDIFS
1463 PATH=$GIT_VALGRIND/bin:$PATH
1464 GIT_EXEC_PATH=$GIT_VALGRIND/bin
1465 export GIT_VALGRIND
1466 GIT_VALGRIND_MODE="$valgrind"
1467 export GIT_VALGRIND_MODE
1468 GIT_VALGRIND_ENABLED=t
1469 test -n "$valgrind_only" && GIT_VALGRIND_ENABLED=
1470 export GIT_VALGRIND_ENABLED
1471 elif test -n "$GIT_TEST_INSTALLED"
1472 then
1473 GIT_EXEC_PATH=$($GIT_TEST_INSTALLED/git --exec-path) ||
1474 error "Cannot run git from $GIT_TEST_INSTALLED."
1475 PATH=$GIT_TEST_INSTALLED:$GIT_BUILD_DIR/t/helper:$PATH
1476 GIT_EXEC_PATH=${GIT_TEST_EXEC_PATH:-$GIT_EXEC_PATH}
1477 else # normal case, use ../bin-wrappers only unless $with_dashes:
1478 if test -n "$no_bin_wrappers"
1479 then
1480 with_dashes=t
1481 else
1482 git_bin_dir="$GIT_BUILD_DIR/bin-wrappers"
1483 if ! test -x "$git_bin_dir/git"
1484 then
1485 if test -z "$with_dashes"
1486 then
1487 say "$git_bin_dir/git is not executable; using GIT_EXEC_PATH"
1489 with_dashes=t
1491 PATH="$git_bin_dir:$PATH"
1493 GIT_EXEC_PATH=$GIT_BUILD_DIR
1494 if test -n "$with_dashes"
1495 then
1496 PATH="$GIT_BUILD_DIR:$GIT_BUILD_DIR/t/helper:$PATH"
1499 GIT_TEMPLATE_DIR="$GIT_BUILD_DIR"/templates/blt
1500 GIT_CONFIG_NOSYSTEM=1
1501 GIT_ATTR_NOSYSTEM=1
1502 GIT_CEILING_DIRECTORIES="$TRASH_DIRECTORY/.."
1503 export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG_NOSYSTEM GIT_ATTR_NOSYSTEM GIT_CEILING_DIRECTORIES
1505 if test -z "$GIT_TEST_CMP"
1506 then
1507 if test -n "$GIT_TEST_CMP_USE_COPIED_CONTEXT"
1508 then
1509 GIT_TEST_CMP="$DIFF -c"
1510 else
1511 GIT_TEST_CMP="$DIFF -u"
1515 GITPERLLIB="$GIT_BUILD_DIR"/perl/build/lib
1516 export GITPERLLIB
1517 test -d "$GIT_BUILD_DIR"/templates/blt || {
1518 BAIL_OUT "You haven't built things yet, have you?"
1521 if ! test -x "$GIT_BUILD_DIR"/t/helper/test-tool$X
1522 then
1523 BAIL_OUT 'You need to build test-tool; Run "make t/helper/test-tool" in the source (toplevel) directory'
1526 # Are we running this test at all?
1527 remove_trash=
1528 this_test=${0##*/}
1529 this_test=${this_test%%-*}
1530 if match_pattern_list "$this_test" "$GIT_SKIP_TESTS"
1531 then
1532 say_color info >&3 "skipping test $this_test altogether"
1533 skip_all="skip all tests in $this_test"
1534 test_done
1537 BAIL_OUT_ENV_NEEDS_SANITIZE_LEAK () {
1538 BAIL_OUT "$1 has no effect except when compiled with SANITIZE=leak"
1541 if test -n "$SANITIZE_LEAK"
1542 then
1543 # Normalize with test_bool_env
1544 passes_sanitize_leak=
1546 # We need to see TEST_PASSES_SANITIZE_LEAK in "git
1547 # env--helper" (via test_bool_env)
1548 export TEST_PASSES_SANITIZE_LEAK
1549 if test_bool_env TEST_PASSES_SANITIZE_LEAK false
1550 then
1551 passes_sanitize_leak=t
1554 if test "$GIT_TEST_PASSING_SANITIZE_LEAK" = "check"
1555 then
1556 sanitize_leak_check=t
1557 if test -n "$invert_exit_code"
1558 then
1559 BAIL_OUT "cannot use --invert-exit-code under GIT_TEST_PASSING_SANITIZE_LEAK=check"
1562 if test -z "$passes_sanitize_leak"
1563 then
1564 say "in GIT_TEST_PASSING_SANITIZE_LEAK=check mode, setting --invert-exit-code for TEST_PASSES_SANITIZE_LEAK != true"
1565 invert_exit_code=t
1567 elif test -z "$passes_sanitize_leak" &&
1568 test_bool_env GIT_TEST_PASSING_SANITIZE_LEAK false
1569 then
1570 skip_all="skipping $this_test under GIT_TEST_PASSING_SANITIZE_LEAK=true"
1571 test_done
1574 if test_bool_env GIT_TEST_SANITIZE_LEAK_LOG false
1575 then
1576 if ! mkdir -p "$TEST_RESULTS_SAN_DIR"
1577 then
1578 BAIL_OUT "cannot create $TEST_RESULTS_SAN_DIR"
1579 fi &&
1580 TEST_RESULTS_SAN_FILE="$TEST_RESULTS_SAN_DIR/$TEST_RESULTS_SAN_FILE_PFX"
1582 # In case "test-results" is left over from a previous
1583 # run: Only report if new leaks show up.
1584 TEST_RESULTS_SAN_DIR_NR_LEAKS_STARTUP=$(nr_san_dir_leaks_)
1586 # Don't litter *.leak dirs if there was nothing to report
1587 test_atexit "rmdir \"$TEST_RESULTS_SAN_DIR\" 2>/dev/null || :"
1589 prepend_var LSAN_OPTIONS : dedup_token_length=9999
1590 prepend_var LSAN_OPTIONS : log_exe_name=1
1591 prepend_var LSAN_OPTIONS : log_path=\"$TEST_RESULTS_SAN_FILE\"
1592 export LSAN_OPTIONS
1594 elif test "$GIT_TEST_PASSING_SANITIZE_LEAK" = "check" ||
1595 test_bool_env GIT_TEST_PASSING_SANITIZE_LEAK false
1596 then
1597 BAIL_OUT_ENV_NEEDS_SANITIZE_LEAK "GIT_TEST_PASSING_SANITIZE_LEAK=true"
1598 elif test_bool_env GIT_TEST_SANITIZE_LEAK_LOG false
1599 then
1600 BAIL_OUT_ENV_NEEDS_SANITIZE_LEAK "GIT_TEST_SANITIZE_LEAK_LOG=true"
1603 if test "${GIT_TEST_CHAIN_LINT:-1}" != 0
1604 then
1605 "$PERL_PATH" "$TEST_DIRECTORY/chainlint.pl" "$0" ||
1606 BUG "lint error (see '?!...!? annotations above)"
1609 # Last-minute variable setup
1610 USER_HOME="$HOME"
1611 HOME="$TRASH_DIRECTORY"
1612 GNUPGHOME="$HOME/gnupg-home-not-used"
1613 export HOME GNUPGHOME USER_HOME
1615 # "rm -rf" existing trash directory, even if a previous run left it
1616 # with bad permissions.
1617 remove_trash_directory () {
1618 dir="$1"
1619 if ! rm -rf "$dir" 2>/dev/null
1620 then
1621 chmod -R u+rwx "$dir"
1622 rm -rf "$dir"
1624 ! test -d "$dir"
1627 # Test repository
1628 remove_trash_directory "$TRASH_DIRECTORY" || {
1629 BAIL_OUT 'cannot prepare test area'
1632 remove_trash=t
1633 if test -z "$TEST_NO_CREATE_REPO"
1634 then
1635 git init \
1636 ${TEST_CREATE_REPO_NO_TEMPLATE:+--template=} \
1637 "$TRASH_DIRECTORY" >&3 2>&4 ||
1638 error "cannot run git init"
1639 else
1640 mkdir -p "$TRASH_DIRECTORY"
1643 # Use -P to resolve symlinks in our working directory so that the cwd
1644 # in subprocesses like git equals our $PWD (for pathname comparisons).
1645 cd -P "$TRASH_DIRECTORY" || BAIL_OUT "cannot cd -P to \"$TRASH_DIRECTORY\""
1647 start_test_output "$0"
1649 # Convenience
1650 # A regexp to match 5 and 35 hexdigits
1651 _x05='[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
1652 _x35="$_x05$_x05$_x05$_x05$_x05$_x05$_x05"
1654 test_oid_init
1656 ZERO_OID=$(test_oid zero)
1657 OID_REGEX=$(echo $ZERO_OID | sed -e 's/0/[0-9a-f]/g')
1658 OIDPATH_REGEX=$(test_oid_to_path $ZERO_OID | sed -e 's/0/[0-9a-f]/g')
1659 EMPTY_TREE=$(test_oid empty_tree)
1660 EMPTY_BLOB=$(test_oid empty_blob)
1662 # Provide an implementation of the 'yes' utility; the upper bound
1663 # limit is there to help Windows that cannot stop this loop from
1664 # wasting cycles when the downstream stops reading, so do not be
1665 # tempted to turn it into an infinite loop. cf. 6129c930 ("test-lib:
1666 # limit the output of the yes utility", 2016-02-02)
1667 yes () {
1668 if test $# = 0
1669 then
1671 else
1672 y="$*"
1676 while test $i -lt 99
1678 echo "$y"
1679 i=$(($i+1))
1680 done
1683 # The GIT_TEST_FAIL_PREREQS code hooks into test_set_prereq(), and
1684 # thus needs to be set up really early, and set an internal variable
1685 # for convenience so the hot test_set_prereq() codepath doesn't need
1686 # to call "git env--helper" (via test_bool_env). Only do that work
1687 # if needed by seeing if GIT_TEST_FAIL_PREREQS is set at all.
1688 GIT_TEST_FAIL_PREREQS_INTERNAL=
1689 if test -n "$GIT_TEST_FAIL_PREREQS"
1690 then
1691 if test_bool_env GIT_TEST_FAIL_PREREQS false
1692 then
1693 GIT_TEST_FAIL_PREREQS_INTERNAL=true
1694 test_set_prereq FAIL_PREREQS
1696 else
1697 test_lazy_prereq FAIL_PREREQS '
1698 test_bool_env GIT_TEST_FAIL_PREREQS false
1702 # Fix some commands on Windows, and other OS-specific things
1703 uname_s=$(uname -s)
1704 case $uname_s in
1705 *MINGW*)
1706 # Windows has its own (incompatible) sort and find
1707 sort () {
1708 /usr/bin/sort "$@"
1710 find () {
1711 /usr/bin/find "$@"
1713 # git sees Windows-style pwd
1714 pwd () {
1715 builtin pwd -W
1717 # no POSIX permissions
1718 # backslashes in pathspec are converted to '/'
1719 # exec does not inherit the PID
1720 test_set_prereq MINGW
1721 test_set_prereq NATIVE_CRLF
1722 test_set_prereq SED_STRIPS_CR
1723 test_set_prereq GREP_STRIPS_CR
1724 test_set_prereq WINDOWS
1725 GIT_TEST_CMP=mingw_test_cmp
1727 *CYGWIN*)
1728 test_set_prereq POSIXPERM
1729 test_set_prereq EXECKEEPSPID
1730 test_set_prereq CYGWIN
1731 test_set_prereq SED_STRIPS_CR
1732 test_set_prereq GREP_STRIPS_CR
1733 test_set_prereq WINDOWS
1736 test_set_prereq POSIXPERM
1737 test_set_prereq BSLASHPSPEC
1738 test_set_prereq EXECKEEPSPID
1740 esac
1742 # Detect arches where a few things don't work
1743 uname_m=$(uname -m)
1744 case $uname_m in
1745 parisc* | hppa*)
1746 test_set_prereq HPPA
1748 esac
1750 test_set_prereq REFFILES
1752 ( COLUMNS=1 && test $COLUMNS = 1 ) && test_set_prereq COLUMNS_CAN_BE_1
1753 test -z "$NO_CURL" && test_set_prereq LIBCURL
1754 test -z "$NO_PERL" && test_set_prereq PERL
1755 test -z "$NO_PTHREADS" && test_set_prereq PTHREADS
1756 test -z "$NO_PYTHON" && test_set_prereq PYTHON
1757 test -n "$USE_LIBPCRE2" && test_set_prereq PCRE
1758 test -n "$USE_LIBPCRE2" && test_set_prereq LIBPCRE2
1759 test -z "$NO_GETTEXT" && test_set_prereq GETTEXT
1760 test -n "$SANITIZE_LEAK" && test_set_prereq SANITIZE_LEAK
1761 test -n "$GIT_VALGRIND_ENABLED" && test_set_prereq VALGRIND
1763 if test -z "$GIT_TEST_CHECK_CACHE_TREE"
1764 then
1765 GIT_TEST_CHECK_CACHE_TREE=true
1766 export GIT_TEST_CHECK_CACHE_TREE
1769 test_lazy_prereq PIPE '
1770 # test whether the filesystem supports FIFOs
1771 test_have_prereq !MINGW,!CYGWIN &&
1772 rm -f testfifo && mkfifo testfifo
1775 test_lazy_prereq SYMLINKS '
1776 # test whether the filesystem supports symbolic links
1777 ln -s x y && test -h y
1780 test_lazy_prereq SYMLINKS_WINDOWS '
1781 # test whether symbolic links are enabled on Windows
1782 test_have_prereq MINGW &&
1783 cmd //c "mklink y x" &> /dev/null && test -h y
1786 test_lazy_prereq FILEMODE '
1787 test "$(git config --bool core.filemode)" = true
1790 test_lazy_prereq CASE_INSENSITIVE_FS '
1791 echo good >CamelCase &&
1792 echo bad >camelcase &&
1793 test "$(cat CamelCase)" != good
1796 test_lazy_prereq FUNNYNAMES '
1797 test_have_prereq !MINGW &&
1798 touch -- \
1799 "FUNNYNAMES tab embedded" \
1800 "FUNNYNAMES \"quote embedded\"" \
1801 "FUNNYNAMES newline
1802 embedded" 2>/dev/null &&
1803 rm -- \
1804 "FUNNYNAMES tab embedded" \
1805 "FUNNYNAMES \"quote embedded\"" \
1806 "FUNNYNAMES newline
1807 embedded" 2>/dev/null
1810 test_lazy_prereq UTF8_NFD_TO_NFC '
1811 # check whether FS converts nfd unicode to nfc
1812 auml=$(printf "\303\244")
1813 aumlcdiar=$(printf "\141\314\210")
1814 >"$auml" &&
1815 test -f "$aumlcdiar"
1818 test_lazy_prereq AUTOIDENT '
1819 sane_unset GIT_AUTHOR_NAME &&
1820 sane_unset GIT_AUTHOR_EMAIL &&
1821 git var GIT_AUTHOR_IDENT
1824 test_lazy_prereq EXPENSIVE '
1825 test -n "$GIT_TEST_LONG"
1828 test_lazy_prereq EXPENSIVE_ON_WINDOWS '
1829 test_have_prereq EXPENSIVE || test_have_prereq !MINGW,!CYGWIN
1832 test_lazy_prereq USR_BIN_TIME '
1833 test -x /usr/bin/time
1836 test_lazy_prereq NOT_ROOT '
1837 uid=$(id -u) &&
1838 test "$uid" != 0
1841 test_lazy_prereq JGIT '
1842 jgit --version
1845 # SANITY is about "can you correctly predict what the filesystem would
1846 # do by only looking at the permission bits of the files and
1847 # directories?" A typical example of !SANITY is running the test
1848 # suite as root, where a test may expect "chmod -r file && cat file"
1849 # to fail because file is supposed to be unreadable after a successful
1850 # chmod. In an environment (i.e. combination of what filesystem is
1851 # being used and who is running the tests) that lacks SANITY, you may
1852 # be able to delete or create a file when the containing directory
1853 # doesn't have write permissions, or access a file even if the
1854 # containing directory doesn't have read or execute permissions.
1856 test_lazy_prereq SANITY '
1857 mkdir SANETESTD.1 SANETESTD.2 &&
1859 chmod +w SANETESTD.1 SANETESTD.2 &&
1860 >SANETESTD.1/x 2>SANETESTD.2/x &&
1861 chmod -w SANETESTD.1 &&
1862 chmod -r SANETESTD.1/x &&
1863 chmod -rx SANETESTD.2 ||
1864 BUG "cannot prepare SANETESTD"
1866 ! test -r SANETESTD.1/x &&
1867 ! rm SANETESTD.1/x && ! test -f SANETESTD.2/x
1868 status=$?
1870 chmod +rwx SANETESTD.1 SANETESTD.2 &&
1871 rm -rf SANETESTD.1 SANETESTD.2 ||
1872 BUG "cannot clean SANETESTD"
1873 return $status
1876 test FreeBSD != $uname_s || GIT_UNZIP=${GIT_UNZIP:-/usr/local/bin/unzip}
1877 GIT_UNZIP=${GIT_UNZIP:-unzip}
1878 test_lazy_prereq UNZIP '
1879 "$GIT_UNZIP" -v
1880 test $? -ne 127
1883 run_with_limited_cmdline () {
1884 (ulimit -s 128 && "$@")
1887 test_lazy_prereq CMDLINE_LIMIT '
1888 test_have_prereq !HPPA,!MINGW,!CYGWIN &&
1889 run_with_limited_cmdline true
1892 run_with_limited_stack () {
1893 (ulimit -s 128 && "$@")
1896 test_lazy_prereq ULIMIT_STACK_SIZE '
1897 test_have_prereq !HPPA,!MINGW,!CYGWIN &&
1898 run_with_limited_stack true
1901 run_with_limited_open_files () {
1902 (ulimit -n 32 && "$@")
1905 test_lazy_prereq ULIMIT_FILE_DESCRIPTORS '
1906 test_have_prereq !MINGW,!CYGWIN &&
1907 run_with_limited_open_files true
1910 build_option () {
1911 git version --build-options |
1912 sed -ne "s/^$1: //p"
1915 test_lazy_prereq SIZE_T_IS_64BIT '
1916 test 8 -eq "$(build_option sizeof-size_t)"
1919 test_lazy_prereq LONG_IS_64BIT '
1920 test 8 -le "$(build_option sizeof-long)"
1923 test_lazy_prereq TIME_IS_64BIT 'test-tool date is64bit'
1924 test_lazy_prereq TIME_T_IS_64BIT 'test-tool date time_t-is64bit'
1926 test_lazy_prereq CURL '
1927 curl --version
1930 # SHA1 is a test if the hash algorithm in use is SHA-1. This is both for tests
1931 # which will not work with other hash algorithms and tests that work but don't
1932 # test anything meaningful (e.g. special values which cause short collisions).
1933 test_lazy_prereq SHA1 '
1934 case "$GIT_DEFAULT_HASH" in
1935 sha1) true ;;
1936 "") test $(git hash-object /dev/null) = e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 ;;
1937 *) false ;;
1938 esac
1941 test_lazy_prereq ADD_I_USE_BUILTIN '
1942 test_bool_env GIT_TEST_ADD_I_USE_BUILTIN true
1945 # Ensure that no test accidentally triggers a Git command
1946 # that runs the actual maintenance scheduler, affecting a user's
1947 # system permanently.
1948 # Tests that verify the scheduler integration must set this locally
1949 # to avoid errors.
1950 GIT_TEST_MAINT_SCHEDULER="none:exit 1"
1952 # Does this platform support `git fsmonitor--daemon`
1954 test_lazy_prereq FSMONITOR_DAEMON '
1955 git version --build-options >output &&
1956 grep "feature: fsmonitor--daemon" output