Merge branch 'rj/add-i-leak-fix'
[git.git] / t / test-lib.sh
blob79d3e0e7d9b32dd2938e635dc94acc6b49000569
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 https://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 prepend_var UBSAN_OPTIONS : $GIT_SAN_OPTIONS
93 export UBSAN_OPTIONS
95 if test ! -f "$GIT_BUILD_DIR"/GIT-BUILD-OPTIONS
96 then
97 echo >&2 'error: GIT-BUILD-OPTIONS missing (has Git been built?).'
98 exit 1
100 . "$GIT_BUILD_DIR"/GIT-BUILD-OPTIONS
101 export PERL_PATH SHELL_PATH
103 # In t0000, we need to override test directories of nested testcases. In case
104 # the developer has TEST_OUTPUT_DIRECTORY part of his build options, then we'd
105 # reset this value to instead contain what the developer has specified. We thus
106 # have this knob to allow overriding the directory.
107 if test -n "${TEST_OUTPUT_DIRECTORY_OVERRIDE}"
108 then
109 TEST_OUTPUT_DIRECTORY="${TEST_OUTPUT_DIRECTORY_OVERRIDE}"
112 # Disallow the use of abbreviated options in the test suite by default
113 if test -z "${GIT_TEST_DISALLOW_ABBREVIATED_OPTIONS}"
114 then
115 GIT_TEST_DISALLOW_ABBREVIATED_OPTIONS=true
116 export GIT_TEST_DISALLOW_ABBREVIATED_OPTIONS
119 # Explicitly set the default branch name for testing, to avoid the
120 # transitory "git init" warning under --verbose.
121 : ${GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME:=master}
122 export GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME
124 ################################################################
125 # It appears that people try to run tests without building...
126 "${GIT_TEST_INSTALLED:-$GIT_BUILD_DIR}/git$X" >/dev/null
127 if test $? != 1
128 then
129 if test -n "$GIT_TEST_INSTALLED"
130 then
131 echo >&2 "error: there is no working Git at '$GIT_TEST_INSTALLED'"
132 else
133 echo >&2 'error: you do not seem to have built git yet.'
135 exit 1
138 store_arg_to=
139 opt_required_arg=
140 # $1: option string
141 # $2: name of the var where the arg will be stored
142 mark_option_requires_arg () {
143 if test -n "$opt_required_arg"
144 then
145 echo "error: options that require args cannot be bundled" \
146 "together: '$opt_required_arg' and '$1'" >&2
147 exit 1
149 opt_required_arg=$1
150 store_arg_to=$2
153 # These functions can be overridden e.g. to output JUnit XML
154 start_test_output () { :; }
155 start_test_case_output () { :; }
156 finalize_test_case_output () { :; }
157 finalize_test_output () { :; }
159 parse_option () {
160 local opt="$1"
162 case "$opt" in
163 -d|--d|--de|--deb|--debu|--debug)
164 debug=t ;;
165 -i|--i|--im|--imm|--imme|--immed|--immedi|--immedia|--immediat|--immediate)
166 immediate=t ;;
167 -l|--l|--lo|--lon|--long|--long-|--long-t|--long-te|--long-tes|--long-test|--long-tests)
168 GIT_TEST_LONG=t; export GIT_TEST_LONG ;;
170 mark_option_requires_arg "$opt" run_list
172 --run=*)
173 run_list=${opt#--*=} ;;
174 -h|--h|--he|--hel|--help)
175 help=t ;;
176 -v|--v|--ve|--ver|--verb|--verbo|--verbos|--verbose)
177 verbose=t ;;
178 --verbose-only=*)
179 verbose_only=${opt#--*=}
181 -q|--q|--qu|--qui|--quie|--quiet)
182 # Ignore --quiet under a TAP::Harness. Saying how many tests
183 # passed without the ok/not ok details is always an error.
184 test -z "$HARNESS_ACTIVE" && quiet=t ;;
185 --with-dashes)
186 with_dashes=t ;;
187 --no-bin-wrappers)
188 no_bin_wrappers=t ;;
189 --no-color)
190 color= ;;
191 --va|--val|--valg|--valgr|--valgri|--valgrin|--valgrind)
192 valgrind=memcheck
193 tee=t
195 --valgrind=*)
196 valgrind=${opt#--*=}
197 tee=t
199 --valgrind-only=*)
200 valgrind_only=${opt#--*=}
201 tee=t
203 --tee)
204 tee=t ;;
205 --root=*)
206 root=${opt#--*=} ;;
207 --chain-lint)
208 GIT_TEST_CHAIN_LINT=1 ;;
209 --no-chain-lint)
210 GIT_TEST_CHAIN_LINT=0 ;;
212 trace=t ;;
213 -V|--verbose-log)
214 verbose_log=t
215 tee=t
217 --write-junit-xml)
218 . "$TEST_DIRECTORY/test-lib-junit.sh"
220 --github-workflow-markup)
221 . "$TEST_DIRECTORY/test-lib-github-workflow-markup.sh"
223 --stress)
224 stress=t ;;
225 --stress=*)
226 echo "error: --stress does not accept an argument: '$opt'" >&2
227 echo "did you mean --stress-jobs=${opt#*=} or --stress-limit=${opt#*=}?" >&2
228 exit 1
230 --stress-jobs=*)
231 stress=t;
232 stress_jobs=${opt#--*=}
233 case "$stress_jobs" in
234 *[!0-9]*|0*|"")
235 echo "error: --stress-jobs=<N> requires the number of jobs to run" >&2
236 exit 1
238 *) # Good.
240 esac
242 --stress-limit=*)
243 stress=t;
244 stress_limit=${opt#--*=}
245 case "$stress_limit" in
246 *[!0-9]*|0*|"")
247 echo "error: --stress-limit=<N> requires the number of repetitions" >&2
248 exit 1
250 *) # Good.
252 esac
254 --invert-exit-code)
255 invert_exit_code=t
258 echo "error: unknown test option '$opt'" >&2; exit 1 ;;
259 esac
262 # Parse options while taking care to leave $@ intact, so we will still
263 # have all the original command line options when executing the test
264 # script again for '--tee' and '--verbose-log' later.
265 for opt
267 if test -n "$store_arg_to"
268 then
269 eval $store_arg_to=\$opt
270 store_arg_to=
271 opt_required_arg=
272 continue
275 case "$opt" in
276 --*|-?)
277 parse_option "$opt" ;;
278 -?*)
279 # bundled short options must be fed separately to parse_option
280 opt=${opt#-}
281 while test -n "$opt"
283 extra=${opt#?}
284 this=${opt%$extra}
285 opt=$extra
286 parse_option "-$this"
287 done
290 echo "error: unknown test option '$opt'" >&2; exit 1 ;;
291 esac
292 done
293 if test -n "$store_arg_to"
294 then
295 echo "error: $opt_required_arg requires an argument" >&2
296 exit 1
299 if test -n "$valgrind_only"
300 then
301 test -z "$valgrind" && valgrind=memcheck
302 test -z "$verbose" && verbose_only="$valgrind_only"
303 elif test -n "$valgrind"
304 then
305 test -z "$verbose_log" && verbose=t
308 if test -n "$stress"
309 then
310 verbose=t
311 trace=t
312 immediate=t
315 TEST_STRESS_JOB_SFX="${GIT_TEST_STRESS_JOB_NR:+.stress-$GIT_TEST_STRESS_JOB_NR}"
316 TEST_NAME="$(basename "$0" .sh)"
317 TEST_NUMBER="${TEST_NAME%%-*}"
318 TEST_NUMBER="${TEST_NUMBER#t}"
319 TEST_RESULTS_DIR="$TEST_OUTPUT_DIRECTORY/test-results"
320 TEST_RESULTS_BASE="$TEST_RESULTS_DIR/$TEST_NAME$TEST_STRESS_JOB_SFX"
321 TEST_RESULTS_SAN_FILE_PFX=trace
322 TEST_RESULTS_SAN_DIR_SFX=leak
323 TEST_RESULTS_SAN_FILE=
324 TEST_RESULTS_SAN_DIR="$TEST_RESULTS_DIR/$TEST_NAME.$TEST_RESULTS_SAN_DIR_SFX"
325 TEST_RESULTS_SAN_DIR_NR_LEAKS_STARTUP=
326 TRASH_DIRECTORY="trash directory.$TEST_NAME$TEST_STRESS_JOB_SFX"
327 test -n "$root" && TRASH_DIRECTORY="$root/$TRASH_DIRECTORY"
328 case "$TRASH_DIRECTORY" in
329 /*) ;; # absolute path is good
330 *) TRASH_DIRECTORY="$TEST_OUTPUT_DIRECTORY/$TRASH_DIRECTORY" ;;
331 esac
333 # Utility functions using $TEST_RESULTS_* variables
334 nr_san_dir_leaks_ () {
335 # stderr piped to /dev/null because the directory may have
336 # been "rmdir"'d already.
337 find "$TEST_RESULTS_SAN_DIR" \
338 -type f \
339 -name "$TEST_RESULTS_SAN_FILE_PFX.*" 2>/dev/null |
340 xargs grep -lv "Unable to get registers from thread" |
341 wc -l
344 # If --stress was passed, run this test repeatedly in several parallel loops.
345 if test "$GIT_TEST_STRESS_STARTED" = "done"
346 then
347 : # Don't stress test again.
348 elif test -n "$stress"
349 then
350 if test -n "$stress_jobs"
351 then
352 job_count=$stress_jobs
353 elif test -n "$GIT_TEST_STRESS_LOAD"
354 then
355 job_count="$GIT_TEST_STRESS_LOAD"
356 elif job_count=$(getconf _NPROCESSORS_ONLN 2>/dev/null) &&
357 test -n "$job_count"
358 then
359 job_count=$((2 * $job_count))
360 else
361 job_count=8
364 mkdir -p "$TEST_RESULTS_DIR"
365 stressfail="$TEST_RESULTS_BASE.stress-failed"
366 rm -f "$stressfail"
368 stress_exit=0
369 trap '
370 kill $job_pids 2>/dev/null
371 wait
372 stress_exit=1
373 ' TERM INT HUP
375 job_pids=
376 job_nr=0
377 while test $job_nr -lt "$job_count"
380 GIT_TEST_STRESS_STARTED=done
381 GIT_TEST_STRESS_JOB_NR=$job_nr
382 export GIT_TEST_STRESS_STARTED GIT_TEST_STRESS_JOB_NR
384 trap '
385 kill $test_pid 2>/dev/null
386 wait
387 exit 1
388 ' TERM INT
390 cnt=1
391 while ! test -e "$stressfail" &&
392 { test -z "$stress_limit" ||
393 test $cnt -le $stress_limit ; }
395 $TEST_SHELL_PATH "$0" "$@" >"$TEST_RESULTS_BASE.stress-$job_nr.out" 2>&1 &
396 test_pid=$!
398 if wait $test_pid
399 then
400 printf "OK %2d.%d\n" $GIT_TEST_STRESS_JOB_NR $cnt
401 else
402 echo $GIT_TEST_STRESS_JOB_NR >>"$stressfail"
403 printf "FAIL %2d.%d\n" $GIT_TEST_STRESS_JOB_NR $cnt
405 cnt=$(($cnt + 1))
406 done
408 job_pids="$job_pids $!"
409 job_nr=$(($job_nr + 1))
410 done
412 wait
414 if test -f "$stressfail"
415 then
416 stress_exit=1
417 echo "Log(s) of failed test run(s):"
418 for failed_job_nr in $(sort -n "$stressfail")
420 echo "Contents of '$TEST_RESULTS_BASE.stress-$failed_job_nr.out':"
421 cat "$TEST_RESULTS_BASE.stress-$failed_job_nr.out"
422 done
423 rm -rf "$TRASH_DIRECTORY.stress-failed"
424 # Move the last one.
425 mv "$TRASH_DIRECTORY.stress-$failed_job_nr" "$TRASH_DIRECTORY.stress-failed"
428 exit $stress_exit
431 # if --tee was passed, write the output not only to the terminal, but
432 # additionally to the file test-results/$BASENAME.out, too.
433 if test "$GIT_TEST_TEE_STARTED" = "done"
434 then
435 : # do not redirect again
436 elif test -n "$tee"
437 then
438 mkdir -p "$TEST_RESULTS_DIR"
440 # Make this filename available to the sub-process in case it is using
441 # --verbose-log.
442 GIT_TEST_TEE_OUTPUT_FILE=$TEST_RESULTS_BASE.out
443 export GIT_TEST_TEE_OUTPUT_FILE
445 # Truncate before calling "tee -a" to get rid of the results
446 # from any previous runs.
447 >"$GIT_TEST_TEE_OUTPUT_FILE"
449 (GIT_TEST_TEE_STARTED=done ${TEST_SHELL_PATH} "$0" "$@" 2>&1;
450 echo $? >"$TEST_RESULTS_BASE.exit") | tee -a "$GIT_TEST_TEE_OUTPUT_FILE"
451 test "$(cat "$TEST_RESULTS_BASE.exit")" = 0
452 exit
455 if test -n "$trace" && test -n "$test_untraceable"
456 then
457 # '-x' tracing requested, but this test script can't be reliably
458 # traced, unless it is run with a Bash version supporting
459 # BASH_XTRACEFD (introduced in Bash v4.1).
461 # Perform this version check _after_ the test script was
462 # potentially re-executed with $TEST_SHELL_PATH for '--tee' or
463 # '--verbose-log', so the right shell is checked and the
464 # warning is issued only once.
465 if test -n "$BASH_VERSION" && eval '
466 test ${BASH_VERSINFO[0]} -gt 4 || {
467 test ${BASH_VERSINFO[0]} -eq 4 &&
468 test ${BASH_VERSINFO[1]} -ge 1
471 then
472 : Executed by a Bash version supporting BASH_XTRACEFD. Good.
473 else
474 echo >&2 "warning: ignoring -x; '$0' is untraceable without BASH_XTRACEFD"
475 trace=
478 if test -n "$trace" && test -z "$verbose_log"
479 then
480 verbose=t
483 # Since bash 5.0, checkwinsize is enabled by default which does
484 # update the COLUMNS variable every time a non-builtin command
485 # completes, even for non-interactive shells.
486 # Disable that since we are aiming for repeatability.
487 test -n "$BASH_VERSION" && shopt -u checkwinsize 2>/dev/null
489 # For repeatability, reset the environment to known value.
490 # TERM is sanitized below, after saving color control sequences.
491 LANG=C
492 LC_ALL=C
493 PAGER=cat
494 TZ=UTC
495 COLUMNS=80
496 export LANG LC_ALL PAGER TZ COLUMNS
497 EDITOR=:
499 # A call to "unset" with no arguments causes at least Solaris 10
500 # /usr/xpg4/bin/sh and /bin/ksh to bail out. So keep the unsets
501 # deriving from the command substitution clustered with the other
502 # ones.
503 unset VISUAL EMAIL LANGUAGE $("$PERL_PATH" -e '
504 my @env = keys %ENV;
505 my $ok = join("|", qw(
506 TRACE
507 DEBUG
508 TEST
509 .*_TEST
510 PROVE
511 VALGRIND
512 UNZIP
513 PERF_
514 CURL_VERBOSE
515 TRACE_CURL
517 my @vars = grep(/^GIT_/ && !/^GIT_($ok)/o, @env);
518 print join("\n", @vars);
520 unset XDG_CACHE_HOME
521 unset XDG_CONFIG_HOME
522 unset GITPERLLIB
523 unset GIT_TRACE2_PARENT_NAME
524 unset GIT_TRACE2_PARENT_SID
525 TEST_AUTHOR_LOCALNAME=author
526 TEST_AUTHOR_DOMAIN=example.com
527 GIT_AUTHOR_EMAIL=${TEST_AUTHOR_LOCALNAME}@${TEST_AUTHOR_DOMAIN}
528 GIT_AUTHOR_NAME='A U Thor'
529 GIT_AUTHOR_DATE='1112354055 +0200'
530 TEST_COMMITTER_LOCALNAME=committer
531 TEST_COMMITTER_DOMAIN=example.com
532 GIT_COMMITTER_EMAIL=${TEST_COMMITTER_LOCALNAME}@${TEST_COMMITTER_DOMAIN}
533 GIT_COMMITTER_NAME='C O Mitter'
534 GIT_COMMITTER_DATE='1112354055 +0200'
535 GIT_MERGE_VERBOSITY=5
536 GIT_MERGE_AUTOEDIT=no
537 export GIT_MERGE_VERBOSITY GIT_MERGE_AUTOEDIT
538 export GIT_AUTHOR_EMAIL GIT_AUTHOR_NAME
539 export GIT_COMMITTER_EMAIL GIT_COMMITTER_NAME
540 export GIT_COMMITTER_DATE GIT_AUTHOR_DATE
541 export EDITOR
543 GIT_DEFAULT_HASH="${GIT_TEST_DEFAULT_HASH:-sha1}"
544 export GIT_DEFAULT_HASH
545 GIT_DEFAULT_REF_FORMAT="${GIT_TEST_DEFAULT_REF_FORMAT:-files}"
546 export GIT_DEFAULT_REF_FORMAT
547 GIT_TEST_MERGE_ALGORITHM="${GIT_TEST_MERGE_ALGORITHM:-ort}"
548 export GIT_TEST_MERGE_ALGORITHM
550 # Tests using GIT_TRACE typically don't want <timestamp> <file>:<line> output
551 GIT_TRACE_BARE=1
552 export GIT_TRACE_BARE
554 # Some tests scan the GIT_TRACE2_EVENT feed for events, but the
555 # default depth is 2, which frequently causes issues when the
556 # events are wrapped in new regions. Set it to a sufficiently
557 # large depth to avoid custom changes in the test suite.
558 GIT_TRACE2_EVENT_NESTING=100
559 export GIT_TRACE2_EVENT_NESTING
561 # Use specific version of the index file format
562 if test -n "${GIT_TEST_INDEX_VERSION:+isset}"
563 then
564 GIT_INDEX_VERSION="$GIT_TEST_INDEX_VERSION"
565 export GIT_INDEX_VERSION
568 if test -n "$GIT_TEST_PERL_FATAL_WARNINGS"
569 then
570 GIT_PERL_FATAL_WARNINGS=1
571 export GIT_PERL_FATAL_WARNINGS
574 case $GIT_TEST_FSYNC in
576 GIT_TEST_FSYNC=0
577 export GIT_TEST_FSYNC
579 esac
581 # Add libc MALLOC and MALLOC_PERTURB test only if we are not executing
582 # the test with valgrind and have not compiled with conflict SANITIZE
583 # options.
584 if test -n "$valgrind" ||
585 test -n "$SANITIZE_ADDRESS" ||
586 test -n "$SANITIZE_LEAK" ||
587 test -n "$TEST_NO_MALLOC_CHECK"
588 then
589 setup_malloc_check () {
590 : nothing
592 teardown_malloc_check () {
593 : nothing
595 else
596 _USE_GLIBC_TUNABLES=
597 if _GLIBC_VERSION=$(getconf GNU_LIBC_VERSION 2>/dev/null) &&
598 _GLIBC_VERSION=${_GLIBC_VERSION#"glibc "} &&
599 expr 2.34 \<= "$_GLIBC_VERSION" >/dev/null
600 then
601 _USE_GLIBC_TUNABLES=YesPlease
603 setup_malloc_check () {
604 local g
605 local t
606 MALLOC_CHECK_=3 MALLOC_PERTURB_=165
607 export MALLOC_CHECK_ MALLOC_PERTURB_
608 if test -n "$_USE_GLIBC_TUNABLES"
609 then
611 LD_PRELOAD="libc_malloc_debug.so.0"
612 for t in \
613 glibc.malloc.check=1 \
614 glibc.malloc.perturb=165
616 g="${g#:}:$t"
617 done
618 GLIBC_TUNABLES=$g
619 export LD_PRELOAD GLIBC_TUNABLES
622 teardown_malloc_check () {
623 unset MALLOC_CHECK_ MALLOC_PERTURB_
624 unset LD_PRELOAD GLIBC_TUNABLES
628 # Protect ourselves from common misconfiguration to export
629 # CDPATH into the environment
630 unset CDPATH
632 unset GREP_OPTIONS
633 unset UNZIP
635 case $(echo $GIT_TRACE |tr "[A-Z]" "[a-z]") in
636 1|2|true)
637 GIT_TRACE=4
639 esac
641 # Line feed
642 LF='
645 # Single quote
646 SQ=\'
648 # UTF-8 ZERO WIDTH NON-JOINER, which HFS+ ignores
649 # when case-folding filenames
650 u200c=$(printf '\342\200\214')
652 export _x05 _x35 LF u200c EMPTY_TREE EMPTY_BLOB ZERO_OID OID_REGEX
654 test "x$TERM" != "xdumb" && (
655 test -t 1 &&
656 tput bold >/dev/null 2>&1 &&
657 tput setaf 1 >/dev/null 2>&1 &&
658 tput sgr0 >/dev/null 2>&1
659 ) &&
660 color=t
662 if test -n "$color"
663 then
664 # Save the color control sequences now rather than run tput
665 # each time say_color() is called. This is done for two
666 # reasons:
667 # * TERM will be changed to dumb
668 # * HOME will be changed to a temporary directory and tput
669 # might need to read ~/.terminfo from the original HOME
670 # directory to get the control sequences
671 # Note: This approach assumes the control sequences don't end
672 # in a newline for any terminal of interest (command
673 # substitutions strip trailing newlines). Given that most
674 # (all?) terminals in common use are related to ECMA-48, this
675 # shouldn't be a problem.
676 say_color_error=$(tput bold; tput setaf 1) # bold red
677 say_color_skip=$(tput setaf 4) # blue
678 say_color_warn=$(tput setaf 3) # brown/yellow
679 say_color_pass=$(tput setaf 2) # green
680 say_color_info=$(tput setaf 6) # cyan
681 say_color_reset=$(tput sgr0)
682 say_color_="" # no formatting for normal text
683 say_color () {
684 test -z "$1" && test -n "$quiet" && return
685 eval "say_color_color=\$say_color_$1"
686 shift
687 printf "%s\\n" "$say_color_color$*$say_color_reset"
689 else
690 say_color() {
691 test -z "$1" && test -n "$quiet" && return
692 shift
693 printf "%s\n" "$*"
697 USER_TERM="$TERM"
698 TERM=dumb
699 export TERM USER_TERM
701 # What is written by tests to stdout and stderr is sent to different places
702 # depending on the test mode (e.g. /dev/null in non-verbose mode, piped to tee
703 # with --tee option, etc.). We save the original stdin to FD #6 and stdout and
704 # stderr to #5 and #7, so that the test framework can use them (e.g. for
705 # printing errors within the test framework) independently of the test mode.
706 exec 5>&1
707 exec 6<&0
708 exec 7>&2
710 _error_exit () {
711 finalize_test_output
712 GIT_EXIT_OK=t
713 exit 1
716 error () {
717 say_color error "error: $*"
718 _error_exit
721 BUG () {
722 error >&7 "bug in the test script: $*"
725 BAIL_OUT () {
726 test $# -ne 1 && BUG "1 param"
728 # Do not change "Bail out! " string. It's part of TAP syntax:
729 # https://testanything.org/tap-specification.html
730 local bail_out="Bail out! "
731 local message="$1"
733 say_color >&5 error $bail_out "$message"
734 _error_exit
737 say () {
738 say_color info "$*"
741 if test -n "$HARNESS_ACTIVE"
742 then
743 if test "$verbose" = t || test -n "$verbose_only"
744 then
745 BAIL_OUT 'verbose mode forbidden under TAP harness; try --verbose-log'
749 test "${test_description}" != "" ||
750 error "Test script did not set test_description."
752 if test "$help" = "t"
753 then
754 printf '%s\n' "$test_description"
755 exit 0
758 if test "$verbose_log" = "t"
759 then
760 exec 3>>"$GIT_TEST_TEE_OUTPUT_FILE" 4>&3
761 elif test "$verbose" = "t"
762 then
763 exec 4>&2 3>&1
764 else
765 exec 4>/dev/null 3>/dev/null
768 # Send any "-x" output directly to stderr to avoid polluting tests
769 # which capture stderr. We can do this unconditionally since it
770 # has no effect if tracing isn't turned on.
772 # Note that this sets up the trace fd as soon as we assign the variable, so it
773 # must come after the creation of descriptor 4 above. Likewise, we must never
774 # unset this, as it has the side effect of closing descriptor 4, which we
775 # use to show verbose tests to the user.
777 # Note also that we don't need or want to export it. The tracing is local to
778 # this shell, and we would not want to influence any shells we exec.
779 BASH_XTRACEFD=4
781 test_failure=0
782 test_count=0
783 test_fixed=0
784 test_broken=0
785 test_success=0
787 test_missing_prereq=
789 test_external_has_tap=0
791 die () {
792 code=$?
793 # This is responsible for running the atexit commands even when a
794 # test script run with '--immediate' fails, or when the user hits
795 # ctrl-C, i.e. when 'test_done' is not invoked at all.
796 test_atexit_handler || code=$?
797 if test -n "$GIT_EXIT_OK"
798 then
799 exit $code
800 else
801 echo >&5 "FATAL: Unexpected exit with code $code"
802 exit 1
806 GIT_EXIT_OK=
807 trap 'die' EXIT
808 # Disable '-x' tracing, because with some shells, notably dash, it
809 # prevents running the cleanup commands when a test script run with
810 # '--verbose-log -x' is interrupted.
811 trap '{ code=$?; set +x; } 2>/dev/null; exit $code' INT TERM HUP
813 # The user-facing functions are loaded from a separate file so that
814 # test_perf subshells can have them too
815 . "$TEST_DIRECTORY/test-lib-functions.sh"
817 # You are not expected to call test_ok_ and test_failure_ directly, use
818 # the test_expect_* functions instead.
820 test_ok_ () {
821 test_success=$(($test_success + 1))
822 say_color "" "ok $test_count - $@"
823 finalize_test_case_output ok "$@"
826 _invert_exit_code_failure_end_blurb () {
827 say_color warn "# faked up failures as TODO & now exiting with 0 due to --invert-exit-code"
830 test_failure_ () {
831 failure_label=$1
832 test_failure=$(($test_failure + 1))
833 local pfx=""
834 if test -n "$invert_exit_code" # && test -n "$HARNESS_ACTIVE"
835 then
836 pfx="# TODO induced breakage (--invert-exit-code):"
838 say_color error "not ok $test_count - ${pfx:+$pfx }$1"
839 shift
840 printf '%s\n' "$*" | sed -e 's/^/# /'
841 if test -n "$immediate"
842 then
843 say_color error "1..$test_count"
844 if test -n "$invert_exit_code"
845 then
846 finalize_test_output
847 _invert_exit_code_failure_end_blurb
848 GIT_EXIT_OK=t
849 exit 0
851 _error_exit
853 finalize_test_case_output failure "$failure_label" "$@"
856 test_known_broken_ok_ () {
857 test_fixed=$(($test_fixed+1))
858 say_color error "ok $test_count - $1 # TODO known breakage vanished"
859 finalize_test_case_output fixed "$1"
862 test_known_broken_failure_ () {
863 test_broken=$(($test_broken+1))
864 say_color warn "not ok $test_count - $1 # TODO known breakage"
865 finalize_test_case_output broken "$1"
868 test_debug () {
869 test "$debug" = "" || eval "$1"
872 match_pattern_list () {
873 arg="$1"
874 shift
875 test -z "$*" && return 1
876 # We need to use "$*" to get field-splitting, but we want to
877 # disable globbing, since we are matching against an arbitrary
878 # $arg, not what's in the filesystem. Using "set -f" accomplishes
879 # that, but we must do it in a subshell to avoid impacting the
880 # rest of the script. The exit value of the subshell becomes
881 # the function's return value.
883 set -f
884 for pattern_ in $*
886 case "$arg" in
887 $pattern_)
888 exit 0
890 esac
891 done
892 exit 1
896 match_test_selector_list () {
897 operation="$1"
898 shift
899 title="$1"
900 shift
901 arg="$1"
902 shift
903 test -z "$1" && return 0
905 # Commas are accepted as separators.
906 OLDIFS=$IFS
907 IFS=','
908 set -- $1
909 IFS=$OLDIFS
911 # If the first selector is negative we include by default.
912 include=
913 case "$1" in
914 !*) include=t ;;
915 esac
917 for selector
919 orig_selector=$selector
921 positive=t
922 case "$selector" in
924 positive=
925 selector=${selector##?}
927 esac
929 test -z "$selector" && continue
931 case "$selector" in
932 *-*)
933 if expr "z${selector%%-*}" : "z[0-9]*[^0-9]" >/dev/null
934 then
935 echo "error: $operation: invalid non-numeric in range" \
936 "start: '$orig_selector'" >&2
937 exit 1
939 if expr "z${selector#*-}" : "z[0-9]*[^0-9]" >/dev/null
940 then
941 echo "error: $operation: invalid non-numeric in range" \
942 "end: '$orig_selector'" >&2
943 exit 1
947 if expr "z$selector" : "z[0-9]*[^0-9]" >/dev/null
948 then
949 case "$title" in *${selector}*)
950 include=$positive
952 esac
953 continue
955 esac
957 # Short cut for "obvious" cases
958 test -z "$include" && test -z "$positive" && continue
959 test -n "$include" && test -n "$positive" && continue
961 case "$selector" in
963 if test $arg -le ${selector#-}
964 then
965 include=$positive
969 if test $arg -ge ${selector%-}
970 then
971 include=$positive
974 *-*)
975 if test ${selector%%-*} -le $arg \
976 && test $arg -le ${selector#*-}
977 then
978 include=$positive
982 if test $arg -eq $selector
983 then
984 include=$positive
987 esac
988 done
990 test -n "$include"
993 maybe_teardown_verbose () {
994 test -z "$verbose_only" && return
995 exec 4>/dev/null 3>/dev/null
996 verbose=
999 last_verbose=t
1000 maybe_setup_verbose () {
1001 test -z "$verbose_only" && return
1002 if match_pattern_list $test_count "$verbose_only"
1003 then
1004 exec 4>&2 3>&1
1005 # Emit a delimiting blank line when going from
1006 # non-verbose to verbose. Within verbose mode the
1007 # delimiter is printed by test_expect_*. The choice
1008 # of the initial $last_verbose is such that before
1009 # test 1, we do not print it.
1010 test -z "$last_verbose" && echo >&3 ""
1011 verbose=t
1012 else
1013 exec 4>/dev/null 3>/dev/null
1014 verbose=
1016 last_verbose=$verbose
1019 maybe_teardown_valgrind () {
1020 test -z "$GIT_VALGRIND" && return
1021 GIT_VALGRIND_ENABLED=
1024 maybe_setup_valgrind () {
1025 test -z "$GIT_VALGRIND" && return
1026 if test -z "$valgrind_only"
1027 then
1028 GIT_VALGRIND_ENABLED=t
1029 return
1031 GIT_VALGRIND_ENABLED=
1032 if match_pattern_list $test_count "$valgrind_only"
1033 then
1034 GIT_VALGRIND_ENABLED=t
1038 trace_level_=0
1039 want_trace () {
1040 test "$trace" = t && {
1041 test "$verbose" = t || test "$verbose_log" = t
1045 # This is a separate function because some tests use
1046 # "return" to end a test_expect_success block early
1047 # (and we want to make sure we run any cleanup like
1048 # "set +x").
1049 test_eval_inner_ () {
1050 eval "$*"
1053 test_eval_ () {
1054 # If "-x" tracing is in effect, then we want to avoid polluting stderr
1055 # with non-test commands. But once in "set -x" mode, we cannot prevent
1056 # the shell from printing the "set +x" to turn it off (nor the saving
1057 # of $? before that). But we can make sure that the output goes to
1058 # /dev/null.
1060 # There are a few subtleties here:
1062 # - we have to redirect descriptor 4 in addition to 2, to cover
1063 # BASH_XTRACEFD
1065 # - the actual eval has to come before the redirection block (since
1066 # it needs to see descriptor 4 to set up its stderr)
1068 # - likewise, any error message we print must be outside the block to
1069 # access descriptor 4
1071 # - checking $? has to come immediately after the eval, but it must
1072 # be _inside_ the block to avoid polluting the "set -x" output
1075 # Do not add anything extra (including LF) after '$*'
1076 test_eval_inner_ </dev/null >&3 2>&4 "
1077 want_trace && trace_level_=$(($trace_level_+1)) && set -x
1080 test_eval_ret_=$?
1081 if want_trace
1082 then
1083 test 1 = $trace_level_ && set +x
1084 trace_level_=$(($trace_level_-1))
1086 } 2>/dev/null 4>&2
1088 if test "$test_eval_ret_" != 0 && want_trace
1089 then
1090 say_color error >&4 "error: last command exited with \$?=$test_eval_ret_"
1092 return $test_eval_ret_
1095 fail_117 () {
1096 return 117
1099 test_run_ () {
1100 test_cleanup=:
1101 expecting_failure=$2
1103 if test "${GIT_TEST_CHAIN_LINT:-1}" != 0; then
1104 # 117 is magic because it is unlikely to match the exit
1105 # code of other programs
1106 test_eval_inner_ "fail_117 && $1" </dev/null >&3 2>&4
1107 if test $? != 117
1108 then
1109 BUG "broken &&-chain: $1"
1113 setup_malloc_check
1114 test_eval_ "$1"
1115 eval_ret=$?
1116 teardown_malloc_check
1118 if test -z "$immediate" || test $eval_ret = 0 ||
1119 test -n "$expecting_failure" && test "$test_cleanup" != ":"
1120 then
1121 setup_malloc_check
1122 test_eval_ "$test_cleanup"
1123 teardown_malloc_check
1125 if test "$verbose" = "t" && test -n "$HARNESS_ACTIVE"
1126 then
1127 echo ""
1129 return "$eval_ret"
1132 test_start_ () {
1133 test_count=$(($test_count+1))
1134 maybe_setup_verbose
1135 maybe_setup_valgrind
1136 start_test_case_output "$@"
1139 test_finish_ () {
1140 echo >&3 ""
1141 maybe_teardown_valgrind
1142 maybe_teardown_verbose
1143 if test -n "$GIT_TEST_TEE_OFFSET"
1144 then
1145 GIT_TEST_TEE_OFFSET=$(test-tool path-utils file-size \
1146 "$GIT_TEST_TEE_OUTPUT_FILE")
1150 test_skip () {
1151 to_skip=
1152 skipped_reason=
1153 if match_pattern_list $this_test.$test_count "$GIT_SKIP_TESTS"
1154 then
1155 to_skip=t
1156 skipped_reason="GIT_SKIP_TESTS"
1158 if test -z "$to_skip" && test -n "$run_list" &&
1159 ! match_test_selector_list '--run' "$1" $test_count "$run_list"
1160 then
1161 to_skip=t
1162 skipped_reason="--run"
1164 if test -z "$to_skip" && test -n "$test_prereq" &&
1165 ! test_have_prereq "$test_prereq"
1166 then
1167 to_skip=t
1169 of_prereq=
1170 if test "$missing_prereq" != "$test_prereq"
1171 then
1172 of_prereq=" of $test_prereq"
1174 skipped_reason="missing $missing_prereq${of_prereq}"
1176 # Keep a list of all the missing prereq for result aggregation
1177 if test -z "$missing_prereq"
1178 then
1179 test_missing_prereq=$missing_prereq
1180 else
1181 test_missing_prereq="$test_missing_prereq,$missing_prereq"
1185 case "$to_skip" in
1188 say_color skip "ok $test_count # skip $1 ($skipped_reason)"
1189 : true
1190 finalize_test_case_output skip "$@"
1193 false
1195 esac
1198 # stub; perf-lib overrides it
1199 test_at_end_hook_ () {
1203 test_atexit_cleanup=:
1204 test_atexit_handler () {
1205 # In a succeeding test script 'test_atexit_handler' is invoked
1206 # twice: first from 'test_done', then from 'die' in the trap on
1207 # EXIT.
1208 # This condition and resetting 'test_atexit_cleanup' below makes
1209 # sure that the registered cleanup commands are run only once.
1210 test : != "$test_atexit_cleanup" || return 0
1212 setup_malloc_check
1213 test_eval_ "$test_atexit_cleanup"
1214 test_atexit_cleanup=:
1215 teardown_malloc_check
1218 sanitize_leak_log_message_ () {
1219 local new="$1" &&
1220 local old="$2" &&
1221 local file="$3" &&
1223 printf "With SANITIZE=leak at exit we have %d leak logs, but started with %d
1225 This means that we have a blindspot where git is leaking but we're
1226 losing the exit code somewhere, or not propagating it appropriately
1227 upwards!
1229 See the logs at \"%s.*\";
1230 those logs are reproduced below." \
1231 "$new" "$old" "$file"
1234 check_test_results_san_file_ () {
1235 if test -z "$TEST_RESULTS_SAN_FILE"
1236 then
1237 return
1238 fi &&
1239 local old="$TEST_RESULTS_SAN_DIR_NR_LEAKS_STARTUP" &&
1240 local new="$(nr_san_dir_leaks_)" &&
1242 if test $new -le $old
1243 then
1244 return
1245 fi &&
1246 local out="$(sanitize_leak_log_message_ "$new" "$old" "$TEST_RESULTS_SAN_FILE")" &&
1247 say_color error "$out" &&
1248 if test "$old" != 0
1249 then
1250 echo &&
1251 say_color error "The logs include output from past runs to avoid" &&
1252 say_color error "that remove 'test-results' between runs."
1253 fi &&
1254 say_color error "$(cat "$TEST_RESULTS_SAN_FILE".*)" &&
1256 if test -n "$passes_sanitize_leak" && test "$test_failure" = 0
1257 then
1258 say "As TEST_PASSES_SANITIZE_LEAK=true and our logs show we're leaking, exit non-zero!" &&
1259 invert_exit_code=t
1260 elif test -n "$passes_sanitize_leak"
1261 then
1262 say "As TEST_PASSES_SANITIZE_LEAK=true and our logs show we're leaking, and we're failing for other reasons too..." &&
1263 invert_exit_code=
1264 elif test -n "$sanitize_leak_check" && test "$test_failure" = 0
1265 then
1266 say "As TEST_PASSES_SANITIZE_LEAK=true isn't set the above leak is 'ok' with GIT_TEST_PASSING_SANITIZE_LEAK=check" &&
1267 invert_exit_code=
1268 elif test -n "$sanitize_leak_check"
1269 then
1270 say "As TEST_PASSES_SANITIZE_LEAK=true isn't set the above leak is 'ok' with GIT_TEST_PASSING_SANITIZE_LEAK=check" &&
1271 invert_exit_code=t
1272 else
1273 say "With GIT_TEST_SANITIZE_LEAK_LOG=true our logs revealed a memory leak, exit non-zero!" &&
1274 invert_exit_code=t
1278 test_done () {
1279 # Run the atexit commands _before_ the trash directory is
1280 # removed, so the commands can access pidfiles and socket files.
1281 test_atexit_handler
1283 finalize_test_output
1285 if test -z "$HARNESS_ACTIVE"
1286 then
1287 mkdir -p "$TEST_RESULTS_DIR"
1289 cat >"$TEST_RESULTS_BASE.counts" <<-EOF
1290 total $test_count
1291 success $test_success
1292 fixed $test_fixed
1293 broken $test_broken
1294 failed $test_failure
1295 missing_prereq $test_missing_prereq
1300 if test -z "$passes_sanitize_leak" && test_bool_env TEST_PASSES_SANITIZE_LEAK false
1301 then
1302 BAIL_OUT "Please, set TEST_PASSES_SANITIZE_LEAK before sourcing test-lib.sh"
1305 if test "$test_fixed" != 0
1306 then
1307 say_color error "# $test_fixed known breakage(s) vanished; please update test(s)"
1309 if test "$test_broken" != 0
1310 then
1311 say_color warn "# still have $test_broken known breakage(s)"
1313 if test "$test_broken" != 0 || test "$test_fixed" != 0
1314 then
1315 test_remaining=$(( $test_count - $test_broken - $test_fixed ))
1316 msg="remaining $test_remaining test(s)"
1317 else
1318 test_remaining=$test_count
1319 msg="$test_count test(s)"
1321 case "$test_failure" in
1323 if test $test_remaining -gt 0
1324 then
1325 say_color pass "# passed all $msg"
1328 # Maybe print SKIP message
1329 test -z "$skip_all" || skip_all="# SKIP $skip_all"
1330 case "$test_count" in
1332 say "1..$test_count${skip_all:+ $skip_all}"
1335 test -z "$skip_all" ||
1336 say_color warn "$skip_all"
1337 say "1..$test_count"
1339 esac
1341 if test -n "$stress" && test -n "$invert_exit_code"
1342 then
1343 # We're about to move our "$TRASH_DIRECTORY"
1344 # to "$TRASH_DIRECTORY.stress-failed" if
1345 # --stress is combined with
1346 # --invert-exit-code.
1347 say "with --stress and --invert-exit-code we're not removing '$TRASH_DIRECTORY'"
1348 elif test -z "$debug" && test -n "$remove_trash"
1349 then
1350 test -d "$TRASH_DIRECTORY" ||
1351 error "Tests passed but trash directory already removed before test cleanup; aborting"
1353 cd "$TRASH_DIRECTORY/.." &&
1354 rm -fr "$TRASH_DIRECTORY" || {
1355 # try again in a bit
1356 sleep 5;
1357 rm -fr "$TRASH_DIRECTORY"
1358 } ||
1359 error "Tests passed but test cleanup failed; aborting"
1362 check_test_results_san_file_ "$test_failure"
1364 if test -z "$skip_all" && test -n "$invert_exit_code"
1365 then
1366 say_color warn "# faking up non-zero exit with --invert-exit-code"
1367 GIT_EXIT_OK=t
1368 exit 1
1371 test_at_end_hook_
1373 GIT_EXIT_OK=t
1374 exit 0 ;;
1377 say_color error "# failed $test_failure among $msg"
1378 say "1..$test_count"
1380 check_test_results_san_file_ "$test_failure"
1382 if test -n "$invert_exit_code"
1383 then
1384 _invert_exit_code_failure_end_blurb
1385 GIT_EXIT_OK=t
1386 exit 0
1389 GIT_EXIT_OK=t
1390 exit 1 ;;
1392 esac
1395 if test -n "$valgrind"
1396 then
1397 make_symlink () {
1398 test -h "$2" &&
1399 test "$1" = "$(readlink "$2")" || {
1400 # be super paranoid
1401 if mkdir "$2".lock
1402 then
1403 rm -f "$2" &&
1404 ln -s "$1" "$2" &&
1405 rm -r "$2".lock
1406 else
1407 while test -d "$2".lock
1409 say "Waiting for lock on $2."
1410 sleep 1
1411 done
1416 make_valgrind_symlink () {
1417 # handle only executables, unless they are shell libraries that
1418 # need to be in the exec-path.
1419 test -x "$1" ||
1420 test "# " = "$(test_copy_bytes 2 <"$1")" ||
1421 return;
1423 base=$(basename "$1")
1424 case "$base" in
1425 test-*)
1426 symlink_target="$GIT_BUILD_DIR/t/helper/$base"
1429 symlink_target="$GIT_BUILD_DIR/$base"
1431 esac
1432 # do not override scripts
1433 if test -x "$symlink_target" &&
1434 test ! -d "$symlink_target" &&
1435 test "#!" != "$(test_copy_bytes 2 <"$symlink_target")"
1436 then
1437 symlink_target=../valgrind.sh
1439 case "$base" in
1440 *.sh|*.perl)
1441 symlink_target=../unprocessed-script
1442 esac
1443 # create the link, or replace it if it is out of date
1444 make_symlink "$symlink_target" "$GIT_VALGRIND/bin/$base" || exit
1447 # override all git executables in TEST_DIRECTORY/..
1448 GIT_VALGRIND=$TEST_DIRECTORY/valgrind
1449 mkdir -p "$GIT_VALGRIND"/bin
1450 for file in $GIT_BUILD_DIR/git* $GIT_BUILD_DIR/t/helper/test-*
1452 make_valgrind_symlink $file
1453 done
1454 # special-case the mergetools loadables
1455 make_symlink "$GIT_BUILD_DIR"/mergetools "$GIT_VALGRIND/bin/mergetools"
1456 OLDIFS=$IFS
1457 IFS=:
1458 for path in $PATH
1460 ls "$path"/git-* 2> /dev/null |
1461 while read file
1463 make_valgrind_symlink "$file"
1464 done
1465 done
1466 IFS=$OLDIFS
1467 PATH=$GIT_VALGRIND/bin:$PATH
1468 GIT_EXEC_PATH=$GIT_VALGRIND/bin
1469 export GIT_VALGRIND
1470 GIT_VALGRIND_MODE="$valgrind"
1471 export GIT_VALGRIND_MODE
1472 GIT_VALGRIND_ENABLED=t
1473 test -n "$valgrind_only" && GIT_VALGRIND_ENABLED=
1474 export GIT_VALGRIND_ENABLED
1475 elif test -n "$GIT_TEST_INSTALLED"
1476 then
1477 GIT_EXEC_PATH=$($GIT_TEST_INSTALLED/git --exec-path) ||
1478 error "Cannot run git from $GIT_TEST_INSTALLED."
1479 PATH=$GIT_TEST_INSTALLED:$GIT_BUILD_DIR/t/helper:$PATH
1480 GIT_EXEC_PATH=${GIT_TEST_EXEC_PATH:-$GIT_EXEC_PATH}
1481 else # normal case, use ../bin-wrappers only unless $with_dashes:
1482 if test -n "$no_bin_wrappers"
1483 then
1484 with_dashes=t
1485 else
1486 git_bin_dir="$GIT_BUILD_DIR/bin-wrappers"
1487 if ! test -x "$git_bin_dir/git"
1488 then
1489 if test -z "$with_dashes"
1490 then
1491 say "$git_bin_dir/git is not executable; using GIT_EXEC_PATH"
1493 with_dashes=t
1495 PATH="$git_bin_dir:$PATH"
1497 GIT_EXEC_PATH=$GIT_BUILD_DIR
1498 if test -n "$with_dashes"
1499 then
1500 PATH="$GIT_BUILD_DIR:$GIT_BUILD_DIR/t/helper:$PATH"
1503 GIT_TEMPLATE_DIR="$GIT_BUILD_DIR"/templates/blt
1504 GIT_CONFIG_NOSYSTEM=1
1505 GIT_ATTR_NOSYSTEM=1
1506 GIT_CEILING_DIRECTORIES="$TRASH_DIRECTORY/.."
1507 export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG_NOSYSTEM GIT_ATTR_NOSYSTEM GIT_CEILING_DIRECTORIES
1509 if test -z "$GIT_TEST_CMP"
1510 then
1511 if test -n "$GIT_TEST_CMP_USE_COPIED_CONTEXT"
1512 then
1513 GIT_TEST_CMP="$DIFF -c"
1514 else
1515 GIT_TEST_CMP="$DIFF -u"
1519 GITPERLLIB="$GIT_BUILD_DIR"/perl/build/lib
1520 export GITPERLLIB
1521 test -d "$GIT_BUILD_DIR"/templates/blt || {
1522 BAIL_OUT "You haven't built things yet, have you?"
1525 if ! test -x "$GIT_BUILD_DIR"/t/helper/test-tool$X
1526 then
1527 BAIL_OUT 'You need to build test-tool; Run "make t/helper/test-tool" in the source (toplevel) directory'
1530 # Are we running this test at all?
1531 remove_trash=
1532 this_test=${0##*/}
1533 this_test=${this_test%%-*}
1534 if match_pattern_list "$this_test" "$GIT_SKIP_TESTS"
1535 then
1536 say_color info >&3 "skipping test $this_test altogether"
1537 skip_all="skip all tests in $this_test"
1538 test_done
1541 BAIL_OUT_ENV_NEEDS_SANITIZE_LEAK () {
1542 BAIL_OUT "$1 has no effect except when compiled with SANITIZE=leak"
1545 if test -n "$SANITIZE_LEAK"
1546 then
1547 # Normalize with test_bool_env
1548 passes_sanitize_leak=
1550 # We need to see TEST_PASSES_SANITIZE_LEAK in "test-tool
1551 # env-helper" (via test_bool_env)
1552 export TEST_PASSES_SANITIZE_LEAK
1553 if test_bool_env TEST_PASSES_SANITIZE_LEAK false
1554 then
1555 passes_sanitize_leak=t
1558 if test "$GIT_TEST_PASSING_SANITIZE_LEAK" = "check"
1559 then
1560 sanitize_leak_check=t
1561 if test -n "$invert_exit_code"
1562 then
1563 BAIL_OUT "cannot use --invert-exit-code under GIT_TEST_PASSING_SANITIZE_LEAK=check"
1566 if test -z "$passes_sanitize_leak"
1567 then
1568 say "in GIT_TEST_PASSING_SANITIZE_LEAK=check mode, setting --invert-exit-code for TEST_PASSES_SANITIZE_LEAK != true"
1569 invert_exit_code=t
1571 elif test -z "$passes_sanitize_leak" &&
1572 test_bool_env GIT_TEST_PASSING_SANITIZE_LEAK false
1573 then
1574 skip_all="skipping $this_test under GIT_TEST_PASSING_SANITIZE_LEAK=true"
1575 test_done
1578 if test_bool_env GIT_TEST_SANITIZE_LEAK_LOG false
1579 then
1580 if ! mkdir -p "$TEST_RESULTS_SAN_DIR"
1581 then
1582 BAIL_OUT "cannot create $TEST_RESULTS_SAN_DIR"
1583 fi &&
1584 TEST_RESULTS_SAN_FILE="$TEST_RESULTS_SAN_DIR/$TEST_RESULTS_SAN_FILE_PFX"
1586 # In case "test-results" is left over from a previous
1587 # run: Only report if new leaks show up.
1588 TEST_RESULTS_SAN_DIR_NR_LEAKS_STARTUP=$(nr_san_dir_leaks_)
1590 # Don't litter *.leak dirs if there was nothing to report
1591 test_atexit "rmdir \"$TEST_RESULTS_SAN_DIR\" 2>/dev/null || :"
1593 prepend_var LSAN_OPTIONS : dedup_token_length=9999
1594 prepend_var LSAN_OPTIONS : log_exe_name=1
1595 prepend_var LSAN_OPTIONS : log_path=\"$TEST_RESULTS_SAN_FILE\"
1596 export LSAN_OPTIONS
1598 elif test "$GIT_TEST_PASSING_SANITIZE_LEAK" = "check" ||
1599 test_bool_env GIT_TEST_PASSING_SANITIZE_LEAK false
1600 then
1601 BAIL_OUT_ENV_NEEDS_SANITIZE_LEAK "GIT_TEST_PASSING_SANITIZE_LEAK=true"
1602 elif test_bool_env GIT_TEST_SANITIZE_LEAK_LOG false
1603 then
1604 BAIL_OUT_ENV_NEEDS_SANITIZE_LEAK "GIT_TEST_SANITIZE_LEAK_LOG=true"
1607 if test "${GIT_TEST_CHAIN_LINT:-1}" != 0 &&
1608 test "${GIT_TEST_EXT_CHAIN_LINT:-1}" != 0
1609 then
1610 "$PERL_PATH" "$TEST_DIRECTORY/chainlint.pl" "$0" ||
1611 BUG "lint error (see '?!...!? annotations above)"
1614 # Last-minute variable setup
1615 USER_HOME="$HOME"
1616 HOME="$TRASH_DIRECTORY"
1617 GNUPGHOME="$HOME/gnupg-home-not-used"
1618 export HOME GNUPGHOME USER_HOME
1620 # "rm -rf" existing trash directory, even if a previous run left it
1621 # with bad permissions.
1622 remove_trash_directory () {
1623 dir="$1"
1624 if ! rm -rf "$dir" 2>/dev/null
1625 then
1626 chmod -R u+rwx "$dir"
1627 rm -rf "$dir"
1629 ! test -d "$dir"
1632 # Test repository
1633 remove_trash_directory "$TRASH_DIRECTORY" || {
1634 BAIL_OUT 'cannot prepare test area'
1637 remove_trash=t
1638 if test -z "$TEST_NO_CREATE_REPO"
1639 then
1640 git init \
1641 ${TEST_CREATE_REPO_NO_TEMPLATE:+--template=} \
1642 "$TRASH_DIRECTORY" >&3 2>&4 ||
1643 error "cannot run git init"
1644 else
1645 mkdir -p "$TRASH_DIRECTORY"
1648 # Use -P to resolve symlinks in our working directory so that the cwd
1649 # in subprocesses like git equals our $PWD (for pathname comparisons).
1650 cd -P "$TRASH_DIRECTORY" || BAIL_OUT "cannot cd -P to \"$TRASH_DIRECTORY\""
1652 start_test_output "$0"
1654 # Convenience
1655 # A regexp to match 5 and 35 hexdigits
1656 _x05='[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
1657 _x35="$_x05$_x05$_x05$_x05$_x05$_x05$_x05"
1659 test_oid_init
1661 ZERO_OID=$(test_oid zero)
1662 OID_REGEX=$(echo $ZERO_OID | sed -e 's/0/[0-9a-f]/g')
1663 OIDPATH_REGEX=$(test_oid_to_path $ZERO_OID | sed -e 's/0/[0-9a-f]/g')
1664 EMPTY_TREE=$(test_oid empty_tree)
1665 EMPTY_BLOB=$(test_oid empty_blob)
1667 # Provide an implementation of the 'yes' utility; the upper bound
1668 # limit is there to help Windows that cannot stop this loop from
1669 # wasting cycles when the downstream stops reading, so do not be
1670 # tempted to turn it into an infinite loop. cf. 6129c930 ("test-lib:
1671 # limit the output of the yes utility", 2016-02-02)
1672 yes () {
1673 if test $# = 0
1674 then
1676 else
1677 y="$*"
1681 while test $i -lt 99
1683 echo "$y"
1684 i=$(($i+1))
1685 done
1688 # The GIT_TEST_FAIL_PREREQS code hooks into test_set_prereq(), and
1689 # thus needs to be set up really early, and set an internal variable
1690 # for convenience so the hot test_set_prereq() codepath doesn't need
1691 # to call "test-tool env-helper" (via test_bool_env). Only do that work
1692 # if needed by seeing if GIT_TEST_FAIL_PREREQS is set at all.
1693 GIT_TEST_FAIL_PREREQS_INTERNAL=
1694 if test -n "$GIT_TEST_FAIL_PREREQS"
1695 then
1696 if test_bool_env GIT_TEST_FAIL_PREREQS false
1697 then
1698 GIT_TEST_FAIL_PREREQS_INTERNAL=true
1699 test_set_prereq FAIL_PREREQS
1701 else
1702 test_lazy_prereq FAIL_PREREQS '
1703 test_bool_env GIT_TEST_FAIL_PREREQS false
1707 # Fix some commands on Windows, and other OS-specific things
1708 uname_s=$(uname -s)
1709 case $uname_s in
1710 *MINGW*)
1711 # Windows has its own (incompatible) sort and find
1712 sort () {
1713 /usr/bin/sort "$@"
1715 find () {
1716 /usr/bin/find "$@"
1718 # git sees Windows-style pwd
1719 pwd () {
1720 builtin pwd -W
1722 # no POSIX permissions
1723 # backslashes in pathspec are converted to '/'
1724 # exec does not inherit the PID
1725 test_set_prereq MINGW
1726 test_set_prereq NATIVE_CRLF
1727 test_set_prereq SED_STRIPS_CR
1728 test_set_prereq GREP_STRIPS_CR
1729 test_set_prereq WINDOWS
1730 GIT_TEST_CMP="GIT_DIR=/dev/null git diff --no-index --ignore-cr-at-eol --"
1732 *CYGWIN*)
1733 test_set_prereq POSIXPERM
1734 test_set_prereq EXECKEEPSPID
1735 test_set_prereq CYGWIN
1736 test_set_prereq SED_STRIPS_CR
1737 test_set_prereq GREP_STRIPS_CR
1738 test_set_prereq WINDOWS
1741 test_set_prereq POSIXPERM
1742 test_set_prereq BSLASHPSPEC
1743 test_set_prereq EXECKEEPSPID
1745 esac
1747 # Detect arches where a few things don't work
1748 uname_m=$(uname -m)
1749 case $uname_m in
1750 parisc* | hppa*)
1751 test_set_prereq HPPA
1753 esac
1755 case "$GIT_DEFAULT_REF_FORMAT" in
1756 files)
1757 test_set_prereq REFFILES;;
1758 reftable)
1759 test_set_prereq REFTABLE;;
1761 echo 2>&1 "error: unknown ref format $GIT_DEFAULT_REF_FORMAT"
1762 exit 1
1764 esac
1766 ( COLUMNS=1 && test $COLUMNS = 1 ) && test_set_prereq COLUMNS_CAN_BE_1
1767 test -z "$NO_CURL" && test_set_prereq LIBCURL
1768 test -z "$NO_PERL" && test_set_prereq PERL
1769 test -z "$NO_PTHREADS" && test_set_prereq PTHREADS
1770 test -z "$NO_PYTHON" && test_set_prereq PYTHON
1771 test -n "$USE_LIBPCRE2" && test_set_prereq PCRE
1772 test -n "$USE_LIBPCRE2" && test_set_prereq LIBPCRE2
1773 test -z "$NO_GETTEXT" && test_set_prereq GETTEXT
1774 test -n "$SANITIZE_LEAK" && test_set_prereq SANITIZE_LEAK
1775 test -n "$GIT_VALGRIND_ENABLED" && test_set_prereq VALGRIND
1777 if test -z "$GIT_TEST_CHECK_CACHE_TREE"
1778 then
1779 GIT_TEST_CHECK_CACHE_TREE=true
1780 export GIT_TEST_CHECK_CACHE_TREE
1783 test_lazy_prereq PIPE '
1784 # test whether the filesystem supports FIFOs
1785 test_have_prereq !MINGW,!CYGWIN &&
1786 rm -f testfifo && mkfifo testfifo
1789 test_lazy_prereq SYMLINKS '
1790 # test whether the filesystem supports symbolic links
1791 ln -s x y && test -h y
1794 test_lazy_prereq SYMLINKS_WINDOWS '
1795 # test whether symbolic links are enabled on Windows
1796 test_have_prereq MINGW &&
1797 cmd //c "mklink y x" &> /dev/null && test -h y
1800 test_lazy_prereq FILEMODE '
1801 test "$(git config --bool core.filemode)" = true
1804 test_lazy_prereq CASE_INSENSITIVE_FS '
1805 echo good >CamelCase &&
1806 echo bad >camelcase &&
1807 test "$(cat CamelCase)" != good
1810 test_lazy_prereq FUNNYNAMES '
1811 test_have_prereq !MINGW &&
1812 touch -- \
1813 "FUNNYNAMES tab embedded" \
1814 "FUNNYNAMES \"quote embedded\"" \
1815 "FUNNYNAMES newline
1816 embedded" 2>/dev/null &&
1817 rm -- \
1818 "FUNNYNAMES tab embedded" \
1819 "FUNNYNAMES \"quote embedded\"" \
1820 "FUNNYNAMES newline
1821 embedded" 2>/dev/null
1824 test_lazy_prereq UTF8_NFD_TO_NFC '
1825 # check whether FS converts nfd unicode to nfc
1826 auml=$(printf "\303\244")
1827 aumlcdiar=$(printf "\141\314\210")
1828 >"$auml" &&
1829 test -f "$aumlcdiar"
1832 test_lazy_prereq AUTOIDENT '
1833 sane_unset GIT_AUTHOR_NAME &&
1834 sane_unset GIT_AUTHOR_EMAIL &&
1835 git var GIT_AUTHOR_IDENT
1838 test_lazy_prereq EXPENSIVE '
1839 test -n "$GIT_TEST_LONG"
1842 test_lazy_prereq EXPENSIVE_ON_WINDOWS '
1843 test_have_prereq EXPENSIVE || test_have_prereq !MINGW,!CYGWIN
1846 test_lazy_prereq USR_BIN_TIME '
1847 test -x /usr/bin/time
1850 test_lazy_prereq NOT_ROOT '
1851 uid=$(id -u) &&
1852 test "$uid" != 0
1855 test_lazy_prereq JGIT '
1856 jgit --version
1859 # SANITY is about "can you correctly predict what the filesystem would
1860 # do by only looking at the permission bits of the files and
1861 # directories?" A typical example of !SANITY is running the test
1862 # suite as root, where a test may expect "chmod -r file && cat file"
1863 # to fail because file is supposed to be unreadable after a successful
1864 # chmod. In an environment (i.e. combination of what filesystem is
1865 # being used and who is running the tests) that lacks SANITY, you may
1866 # be able to delete or create a file when the containing directory
1867 # doesn't have write permissions, or access a file even if the
1868 # containing directory doesn't have read or execute permissions.
1870 test_lazy_prereq SANITY '
1871 mkdir SANETESTD.1 SANETESTD.2 &&
1873 chmod +w SANETESTD.1 SANETESTD.2 &&
1874 >SANETESTD.1/x 2>SANETESTD.2/x &&
1875 chmod -w SANETESTD.1 &&
1876 chmod -r SANETESTD.1/x &&
1877 chmod -rx SANETESTD.2 ||
1878 BUG "cannot prepare SANETESTD"
1880 ! test -r SANETESTD.1/x &&
1881 ! rm SANETESTD.1/x && ! test -f SANETESTD.2/x
1882 status=$?
1884 chmod +rwx SANETESTD.1 SANETESTD.2 &&
1885 rm -rf SANETESTD.1 SANETESTD.2 ||
1886 BUG "cannot clean SANETESTD"
1887 return $status
1890 test FreeBSD != $uname_s || GIT_UNZIP=${GIT_UNZIP:-/usr/local/bin/unzip}
1891 GIT_UNZIP=${GIT_UNZIP:-unzip}
1892 test_lazy_prereq UNZIP '
1893 "$GIT_UNZIP" -v
1894 test $? -ne 127
1897 run_with_limited_cmdline () {
1898 (ulimit -s 128 && "$@")
1901 test_lazy_prereq CMDLINE_LIMIT '
1902 test_have_prereq !HPPA,!MINGW,!CYGWIN &&
1903 run_with_limited_cmdline true
1906 run_with_limited_stack () {
1907 (ulimit -s 128 && "$@")
1910 test_lazy_prereq ULIMIT_STACK_SIZE '
1911 test_have_prereq !HPPA,!MINGW,!CYGWIN &&
1912 run_with_limited_stack true
1915 run_with_limited_open_files () {
1916 (ulimit -n 32 && "$@")
1919 test_lazy_prereq ULIMIT_FILE_DESCRIPTORS '
1920 test_have_prereq !MINGW,!CYGWIN &&
1921 run_with_limited_open_files true
1924 build_option () {
1925 git version --build-options |
1926 sed -ne "s/^$1: //p"
1929 test_lazy_prereq SIZE_T_IS_64BIT '
1930 test 8 -eq "$(build_option sizeof-size_t)"
1933 test_lazy_prereq LONG_IS_64BIT '
1934 test 8 -le "$(build_option sizeof-long)"
1937 test_lazy_prereq TIME_IS_64BIT 'test-tool date is64bit'
1938 test_lazy_prereq TIME_T_IS_64BIT 'test-tool date time_t-is64bit'
1940 test_lazy_prereq CURL '
1941 curl --version
1944 # SHA1 is a test if the hash algorithm in use is SHA-1. This is both for tests
1945 # which will not work with other hash algorithms and tests that work but don't
1946 # test anything meaningful (e.g. special values which cause short collisions).
1947 test_lazy_prereq SHA1 '
1948 case "$GIT_DEFAULT_HASH" in
1949 sha1) true ;;
1950 "") test $(git hash-object /dev/null) = e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 ;;
1951 *) false ;;
1952 esac
1955 test_lazy_prereq DEFAULT_REPO_FORMAT '
1956 test_have_prereq SHA1,REFFILES
1959 # Ensure that no test accidentally triggers a Git command
1960 # that runs the actual maintenance scheduler, affecting a user's
1961 # system permanently.
1962 # Tests that verify the scheduler integration must set this locally
1963 # to avoid errors.
1964 GIT_TEST_MAINT_SCHEDULER="none:exit 1"
1965 export GIT_TEST_MAINT_SCHEDULER
1967 # Does this platform support `git fsmonitor--daemon`
1969 test_lazy_prereq FSMONITOR_DAEMON '
1970 git version --build-options >output &&
1971 grep "feature: fsmonitor--daemon" output