Documentation/git-merge.txt: fix reference to synopsis
[git/gitster.git] / t / test-lib.sh
blob1656c9eed006bdce115ed6e7673246847319783a
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 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_TEST_MERGE_ALGORITHM="${GIT_TEST_MERGE_ALGORITHM:-ort}"
546 export GIT_TEST_MERGE_ALGORITHM
548 # Tests using GIT_TRACE typically don't want <timestamp> <file>:<line> output
549 GIT_TRACE_BARE=1
550 export GIT_TRACE_BARE
552 # Some tests scan the GIT_TRACE2_EVENT feed for events, but the
553 # default depth is 2, which frequently causes issues when the
554 # events are wrapped in new regions. Set it to a sufficiently
555 # large depth to avoid custom changes in the test suite.
556 GIT_TRACE2_EVENT_NESTING=100
557 export GIT_TRACE2_EVENT_NESTING
559 # Use specific version of the index file format
560 if test -n "${GIT_TEST_INDEX_VERSION:+isset}"
561 then
562 GIT_INDEX_VERSION="$GIT_TEST_INDEX_VERSION"
563 export GIT_INDEX_VERSION
566 if test -n "$GIT_TEST_PERL_FATAL_WARNINGS"
567 then
568 GIT_PERL_FATAL_WARNINGS=1
569 export GIT_PERL_FATAL_WARNINGS
572 case $GIT_TEST_FSYNC in
574 GIT_TEST_FSYNC=0
575 export GIT_TEST_FSYNC
577 esac
579 # Add libc MALLOC and MALLOC_PERTURB test only if we are not executing
580 # the test with valgrind and have not compiled with conflict SANITIZE
581 # options.
582 if test -n "$valgrind" ||
583 test -n "$SANITIZE_ADDRESS" ||
584 test -n "$SANITIZE_LEAK" ||
585 test -n "$TEST_NO_MALLOC_CHECK"
586 then
587 setup_malloc_check () {
588 : nothing
590 teardown_malloc_check () {
591 : nothing
593 else
594 _USE_GLIBC_TUNABLES=
595 if _GLIBC_VERSION=$(getconf GNU_LIBC_VERSION 2>/dev/null) &&
596 _GLIBC_VERSION=${_GLIBC_VERSION#"glibc "} &&
597 expr 2.34 \<= "$_GLIBC_VERSION" >/dev/null
598 then
599 _USE_GLIBC_TUNABLES=YesPlease
601 setup_malloc_check () {
602 local g
603 local t
604 MALLOC_CHECK_=3 MALLOC_PERTURB_=165
605 export MALLOC_CHECK_ MALLOC_PERTURB_
606 if test -n "$_USE_GLIBC_TUNABLES"
607 then
609 LD_PRELOAD="libc_malloc_debug.so.0"
610 for t in \
611 glibc.malloc.check=1 \
612 glibc.malloc.perturb=165
614 g="${g#:}:$t"
615 done
616 GLIBC_TUNABLES=$g
617 export LD_PRELOAD GLIBC_TUNABLES
620 teardown_malloc_check () {
621 unset MALLOC_CHECK_ MALLOC_PERTURB_
622 unset LD_PRELOAD GLIBC_TUNABLES
626 # Protect ourselves from common misconfiguration to export
627 # CDPATH into the environment
628 unset CDPATH
630 unset GREP_OPTIONS
631 unset UNZIP
633 case $(echo $GIT_TRACE |tr "[A-Z]" "[a-z]") in
634 1|2|true)
635 GIT_TRACE=4
637 esac
639 # Line feed
640 LF='
643 # Single quote
644 SQ=\'
646 # UTF-8 ZERO WIDTH NON-JOINER, which HFS+ ignores
647 # when case-folding filenames
648 u200c=$(printf '\342\200\214')
650 export _x05 _x35 LF u200c EMPTY_TREE EMPTY_BLOB ZERO_OID OID_REGEX
652 test "x$TERM" != "xdumb" && (
653 test -t 1 &&
654 tput bold >/dev/null 2>&1 &&
655 tput setaf 1 >/dev/null 2>&1 &&
656 tput sgr0 >/dev/null 2>&1
657 ) &&
658 color=t
660 if test -n "$color"
661 then
662 # Save the color control sequences now rather than run tput
663 # each time say_color() is called. This is done for two
664 # reasons:
665 # * TERM will be changed to dumb
666 # * HOME will be changed to a temporary directory and tput
667 # might need to read ~/.terminfo from the original HOME
668 # directory to get the control sequences
669 # Note: This approach assumes the control sequences don't end
670 # in a newline for any terminal of interest (command
671 # substitutions strip trailing newlines). Given that most
672 # (all?) terminals in common use are related to ECMA-48, this
673 # shouldn't be a problem.
674 say_color_error=$(tput bold; tput setaf 1) # bold red
675 say_color_skip=$(tput setaf 4) # blue
676 say_color_warn=$(tput setaf 3) # brown/yellow
677 say_color_pass=$(tput setaf 2) # green
678 say_color_info=$(tput setaf 6) # cyan
679 say_color_reset=$(tput sgr0)
680 say_color_="" # no formatting for normal text
681 say_color () {
682 test -z "$1" && test -n "$quiet" && return
683 eval "say_color_color=\$say_color_$1"
684 shift
685 printf "%s\\n" "$say_color_color$*$say_color_reset"
687 else
688 say_color() {
689 test -z "$1" && test -n "$quiet" && return
690 shift
691 printf "%s\n" "$*"
695 USER_TERM="$TERM"
696 TERM=dumb
697 export TERM USER_TERM
699 # What is written by tests to stdout and stderr is sent to different places
700 # depending on the test mode (e.g. /dev/null in non-verbose mode, piped to tee
701 # with --tee option, etc.). We save the original stdin to FD #6 and stdout and
702 # stderr to #5 and #7, so that the test framework can use them (e.g. for
703 # printing errors within the test framework) independently of the test mode.
704 exec 5>&1
705 exec 6<&0
706 exec 7>&2
708 _error_exit () {
709 finalize_test_output
710 GIT_EXIT_OK=t
711 exit 1
714 error () {
715 say_color error "error: $*"
716 _error_exit
719 BUG () {
720 error >&7 "bug in the test script: $*"
723 BAIL_OUT () {
724 test $# -ne 1 && BUG "1 param"
726 # Do not change "Bail out! " string. It's part of TAP syntax:
727 # https://testanything.org/tap-specification.html
728 local bail_out="Bail out! "
729 local message="$1"
731 say_color >&5 error $bail_out "$message"
732 _error_exit
735 say () {
736 say_color info "$*"
739 if test -n "$HARNESS_ACTIVE"
740 then
741 if test "$verbose" = t || test -n "$verbose_only"
742 then
743 BAIL_OUT 'verbose mode forbidden under TAP harness; try --verbose-log'
747 test "${test_description}" != "" ||
748 error "Test script did not set test_description."
750 if test "$help" = "t"
751 then
752 printf '%s\n' "$test_description"
753 exit 0
756 if test "$verbose_log" = "t"
757 then
758 exec 3>>"$GIT_TEST_TEE_OUTPUT_FILE" 4>&3
759 elif test "$verbose" = "t"
760 then
761 exec 4>&2 3>&1
762 else
763 exec 4>/dev/null 3>/dev/null
766 # Send any "-x" output directly to stderr to avoid polluting tests
767 # which capture stderr. We can do this unconditionally since it
768 # has no effect if tracing isn't turned on.
770 # Note that this sets up the trace fd as soon as we assign the variable, so it
771 # must come after the creation of descriptor 4 above. Likewise, we must never
772 # unset this, as it has the side effect of closing descriptor 4, which we
773 # use to show verbose tests to the user.
775 # Note also that we don't need or want to export it. The tracing is local to
776 # this shell, and we would not want to influence any shells we exec.
777 BASH_XTRACEFD=4
779 test_failure=0
780 test_count=0
781 test_fixed=0
782 test_broken=0
783 test_success=0
785 test_missing_prereq=
787 test_external_has_tap=0
789 die () {
790 code=$?
791 # This is responsible for running the atexit commands even when a
792 # test script run with '--immediate' fails, or when the user hits
793 # ctrl-C, i.e. when 'test_done' is not invoked at all.
794 test_atexit_handler || code=$?
795 if test -n "$GIT_EXIT_OK"
796 then
797 exit $code
798 else
799 echo >&5 "FATAL: Unexpected exit with code $code"
800 exit 1
804 GIT_EXIT_OK=
805 trap 'die' EXIT
806 # Disable '-x' tracing, because with some shells, notably dash, it
807 # prevents running the cleanup commands when a test script run with
808 # '--verbose-log -x' is interrupted.
809 trap '{ code=$?; set +x; } 2>/dev/null; exit $code' INT TERM HUP
811 # The user-facing functions are loaded from a separate file so that
812 # test_perf subshells can have them too
813 . "$TEST_DIRECTORY/test-lib-functions.sh"
815 # You are not expected to call test_ok_ and test_failure_ directly, use
816 # the test_expect_* functions instead.
818 test_ok_ () {
819 test_success=$(($test_success + 1))
820 say_color "" "ok $test_count - $@"
821 finalize_test_case_output ok "$@"
824 _invert_exit_code_failure_end_blurb () {
825 say_color warn "# faked up failures as TODO & now exiting with 0 due to --invert-exit-code"
828 test_failure_ () {
829 failure_label=$1
830 test_failure=$(($test_failure + 1))
831 local pfx=""
832 if test -n "$invert_exit_code" # && test -n "$HARNESS_ACTIVE"
833 then
834 pfx="# TODO induced breakage (--invert-exit-code):"
836 say_color error "not ok $test_count - ${pfx:+$pfx }$1"
837 shift
838 printf '%s\n' "$*" | sed -e 's/^/# /'
839 if test -n "$immediate"
840 then
841 say_color error "1..$test_count"
842 if test -n "$invert_exit_code"
843 then
844 finalize_test_output
845 _invert_exit_code_failure_end_blurb
846 GIT_EXIT_OK=t
847 exit 0
849 _error_exit
851 finalize_test_case_output failure "$failure_label" "$@"
854 test_known_broken_ok_ () {
855 test_fixed=$(($test_fixed+1))
856 say_color error "ok $test_count - $1 # TODO known breakage vanished"
857 finalize_test_case_output fixed "$1"
860 test_known_broken_failure_ () {
861 test_broken=$(($test_broken+1))
862 say_color warn "not ok $test_count - $1 # TODO known breakage"
863 finalize_test_case_output broken "$1"
866 test_debug () {
867 test "$debug" = "" || eval "$1"
870 match_pattern_list () {
871 arg="$1"
872 shift
873 test -z "$*" && return 1
874 # We need to use "$*" to get field-splitting, but we want to
875 # disable globbing, since we are matching against an arbitrary
876 # $arg, not what's in the filesystem. Using "set -f" accomplishes
877 # that, but we must do it in a subshell to avoid impacting the
878 # rest of the script. The exit value of the subshell becomes
879 # the function's return value.
881 set -f
882 for pattern_ in $*
884 case "$arg" in
885 $pattern_)
886 exit 0
888 esac
889 done
890 exit 1
894 match_test_selector_list () {
895 operation="$1"
896 shift
897 title="$1"
898 shift
899 arg="$1"
900 shift
901 test -z "$1" && return 0
903 # Commas are accepted as separators.
904 OLDIFS=$IFS
905 IFS=','
906 set -- $1
907 IFS=$OLDIFS
909 # If the first selector is negative we include by default.
910 include=
911 case "$1" in
912 !*) include=t ;;
913 esac
915 for selector
917 orig_selector=$selector
919 positive=t
920 case "$selector" in
922 positive=
923 selector=${selector##?}
925 esac
927 test -z "$selector" && continue
929 case "$selector" in
930 *-*)
931 if expr "z${selector%%-*}" : "z[0-9]*[^0-9]" >/dev/null
932 then
933 echo "error: $operation: invalid non-numeric in range" \
934 "start: '$orig_selector'" >&2
935 exit 1
937 if expr "z${selector#*-}" : "z[0-9]*[^0-9]" >/dev/null
938 then
939 echo "error: $operation: invalid non-numeric in range" \
940 "end: '$orig_selector'" >&2
941 exit 1
945 if expr "z$selector" : "z[0-9]*[^0-9]" >/dev/null
946 then
947 case "$title" in *${selector}*)
948 include=$positive
950 esac
951 continue
953 esac
955 # Short cut for "obvious" cases
956 test -z "$include" && test -z "$positive" && continue
957 test -n "$include" && test -n "$positive" && continue
959 case "$selector" in
961 if test $arg -le ${selector#-}
962 then
963 include=$positive
967 if test $arg -ge ${selector%-}
968 then
969 include=$positive
972 *-*)
973 if test ${selector%%-*} -le $arg \
974 && test $arg -le ${selector#*-}
975 then
976 include=$positive
980 if test $arg -eq $selector
981 then
982 include=$positive
985 esac
986 done
988 test -n "$include"
991 maybe_teardown_verbose () {
992 test -z "$verbose_only" && return
993 exec 4>/dev/null 3>/dev/null
994 verbose=
997 last_verbose=t
998 maybe_setup_verbose () {
999 test -z "$verbose_only" && return
1000 if match_pattern_list $test_count "$verbose_only"
1001 then
1002 exec 4>&2 3>&1
1003 # Emit a delimiting blank line when going from
1004 # non-verbose to verbose. Within verbose mode the
1005 # delimiter is printed by test_expect_*. The choice
1006 # of the initial $last_verbose is such that before
1007 # test 1, we do not print it.
1008 test -z "$last_verbose" && echo >&3 ""
1009 verbose=t
1010 else
1011 exec 4>/dev/null 3>/dev/null
1012 verbose=
1014 last_verbose=$verbose
1017 maybe_teardown_valgrind () {
1018 test -z "$GIT_VALGRIND" && return
1019 GIT_VALGRIND_ENABLED=
1022 maybe_setup_valgrind () {
1023 test -z "$GIT_VALGRIND" && return
1024 if test -z "$valgrind_only"
1025 then
1026 GIT_VALGRIND_ENABLED=t
1027 return
1029 GIT_VALGRIND_ENABLED=
1030 if match_pattern_list $test_count "$valgrind_only"
1031 then
1032 GIT_VALGRIND_ENABLED=t
1036 trace_level_=0
1037 want_trace () {
1038 test "$trace" = t && {
1039 test "$verbose" = t || test "$verbose_log" = t
1043 # This is a separate function because some tests use
1044 # "return" to end a test_expect_success block early
1045 # (and we want to make sure we run any cleanup like
1046 # "set +x").
1047 test_eval_inner_ () {
1048 eval "$*"
1051 test_eval_ () {
1052 # If "-x" tracing is in effect, then we want to avoid polluting stderr
1053 # with non-test commands. But once in "set -x" mode, we cannot prevent
1054 # the shell from printing the "set +x" to turn it off (nor the saving
1055 # of $? before that). But we can make sure that the output goes to
1056 # /dev/null.
1058 # There are a few subtleties here:
1060 # - we have to redirect descriptor 4 in addition to 2, to cover
1061 # BASH_XTRACEFD
1063 # - the actual eval has to come before the redirection block (since
1064 # it needs to see descriptor 4 to set up its stderr)
1066 # - likewise, any error message we print must be outside the block to
1067 # access descriptor 4
1069 # - checking $? has to come immediately after the eval, but it must
1070 # be _inside_ the block to avoid polluting the "set -x" output
1073 # Do not add anything extra (including LF) after '$*'
1074 test_eval_inner_ </dev/null >&3 2>&4 "
1075 want_trace && trace_level_=$(($trace_level_+1)) && set -x
1078 test_eval_ret_=$?
1079 if want_trace
1080 then
1081 test 1 = $trace_level_ && set +x
1082 trace_level_=$(($trace_level_-1))
1084 } 2>/dev/null 4>&2
1086 if test "$test_eval_ret_" != 0 && want_trace
1087 then
1088 say_color error >&4 "error: last command exited with \$?=$test_eval_ret_"
1090 return $test_eval_ret_
1093 fail_117 () {
1094 return 117
1097 test_run_ () {
1098 test_cleanup=:
1099 expecting_failure=$2
1101 if test "${GIT_TEST_CHAIN_LINT:-1}" != 0; then
1102 # 117 is magic because it is unlikely to match the exit
1103 # code of other programs
1104 test_eval_inner_ "fail_117 && $1" </dev/null >&3 2>&4
1105 if test $? != 117
1106 then
1107 BUG "broken &&-chain: $1"
1111 setup_malloc_check
1112 test_eval_ "$1"
1113 eval_ret=$?
1114 teardown_malloc_check
1116 if test -z "$immediate" || test $eval_ret = 0 ||
1117 test -n "$expecting_failure" && test "$test_cleanup" != ":"
1118 then
1119 setup_malloc_check
1120 test_eval_ "$test_cleanup"
1121 teardown_malloc_check
1123 if test "$verbose" = "t" && test -n "$HARNESS_ACTIVE"
1124 then
1125 echo ""
1127 return "$eval_ret"
1130 test_start_ () {
1131 test_count=$(($test_count+1))
1132 maybe_setup_verbose
1133 maybe_setup_valgrind
1134 start_test_case_output "$@"
1137 test_finish_ () {
1138 echo >&3 ""
1139 maybe_teardown_valgrind
1140 maybe_teardown_verbose
1141 if test -n "$GIT_TEST_TEE_OFFSET"
1142 then
1143 GIT_TEST_TEE_OFFSET=$(test-tool path-utils file-size \
1144 "$GIT_TEST_TEE_OUTPUT_FILE")
1148 test_skip () {
1149 to_skip=
1150 skipped_reason=
1151 if match_pattern_list $this_test.$test_count "$GIT_SKIP_TESTS"
1152 then
1153 to_skip=t
1154 skipped_reason="GIT_SKIP_TESTS"
1156 if test -z "$to_skip" && test -n "$run_list" &&
1157 ! match_test_selector_list '--run' "$1" $test_count "$run_list"
1158 then
1159 to_skip=t
1160 skipped_reason="--run"
1162 if test -z "$to_skip" && test -n "$test_prereq" &&
1163 ! test_have_prereq "$test_prereq"
1164 then
1165 to_skip=t
1167 of_prereq=
1168 if test "$missing_prereq" != "$test_prereq"
1169 then
1170 of_prereq=" of $test_prereq"
1172 skipped_reason="missing $missing_prereq${of_prereq}"
1174 # Keep a list of all the missing prereq for result aggregation
1175 if test -z "$missing_prereq"
1176 then
1177 test_missing_prereq=$missing_prereq
1178 else
1179 test_missing_prereq="$test_missing_prereq,$missing_prereq"
1183 case "$to_skip" in
1186 say_color skip "ok $test_count # skip $1 ($skipped_reason)"
1187 : true
1188 finalize_test_case_output skip "$@"
1191 false
1193 esac
1196 # stub; perf-lib overrides it
1197 test_at_end_hook_ () {
1201 test_atexit_cleanup=:
1202 test_atexit_handler () {
1203 # In a succeeding test script 'test_atexit_handler' is invoked
1204 # twice: first from 'test_done', then from 'die' in the trap on
1205 # EXIT.
1206 # This condition and resetting 'test_atexit_cleanup' below makes
1207 # sure that the registered cleanup commands are run only once.
1208 test : != "$test_atexit_cleanup" || return 0
1210 setup_malloc_check
1211 test_eval_ "$test_atexit_cleanup"
1212 test_atexit_cleanup=:
1213 teardown_malloc_check
1216 sanitize_leak_log_message_ () {
1217 local new="$1" &&
1218 local old="$2" &&
1219 local file="$3" &&
1221 printf "With SANITIZE=leak at exit we have %d leak logs, but started with %d
1223 This means that we have a blindspot where git is leaking but we're
1224 losing the exit code somewhere, or not propagating it appropriately
1225 upwards!
1227 See the logs at \"%s.*\";
1228 those logs are reproduced below." \
1229 "$new" "$old" "$file"
1232 check_test_results_san_file_ () {
1233 if test -z "$TEST_RESULTS_SAN_FILE"
1234 then
1235 return
1236 fi &&
1237 local old="$TEST_RESULTS_SAN_DIR_NR_LEAKS_STARTUP" &&
1238 local new="$(nr_san_dir_leaks_)" &&
1240 if test $new -le $old
1241 then
1242 return
1243 fi &&
1244 local out="$(sanitize_leak_log_message_ "$new" "$old" "$TEST_RESULTS_SAN_FILE")" &&
1245 say_color error "$out" &&
1246 if test "$old" != 0
1247 then
1248 echo &&
1249 say_color error "The logs include output from past runs to avoid" &&
1250 say_color error "that remove 'test-results' between runs."
1251 fi &&
1252 say_color error "$(cat "$TEST_RESULTS_SAN_FILE".*)" &&
1254 if test -n "$passes_sanitize_leak" && test "$test_failure" = 0
1255 then
1256 say "As TEST_PASSES_SANITIZE_LEAK=true and our logs show we're leaking, exit non-zero!" &&
1257 invert_exit_code=t
1258 elif test -n "$passes_sanitize_leak"
1259 then
1260 say "As TEST_PASSES_SANITIZE_LEAK=true and our logs show we're leaking, and we're failing for other reasons too..." &&
1261 invert_exit_code=
1262 elif test -n "$sanitize_leak_check" && test "$test_failure" = 0
1263 then
1264 say "As TEST_PASSES_SANITIZE_LEAK=true isn't set the above leak is 'ok' with GIT_TEST_PASSING_SANITIZE_LEAK=check" &&
1265 invert_exit_code=
1266 elif test -n "$sanitize_leak_check"
1267 then
1268 say "As TEST_PASSES_SANITIZE_LEAK=true isn't set the above leak is 'ok' with GIT_TEST_PASSING_SANITIZE_LEAK=check" &&
1269 invert_exit_code=t
1270 else
1271 say "With GIT_TEST_SANITIZE_LEAK_LOG=true our logs revealed a memory leak, exit non-zero!" &&
1272 invert_exit_code=t
1276 test_done () {
1277 # Run the atexit commands _before_ the trash directory is
1278 # removed, so the commands can access pidfiles and socket files.
1279 test_atexit_handler
1281 finalize_test_output
1283 if test -z "$HARNESS_ACTIVE"
1284 then
1285 mkdir -p "$TEST_RESULTS_DIR"
1287 cat >"$TEST_RESULTS_BASE.counts" <<-EOF
1288 total $test_count
1289 success $test_success
1290 fixed $test_fixed
1291 broken $test_broken
1292 failed $test_failure
1293 missing_prereq $test_missing_prereq
1298 if test "$test_fixed" != 0
1299 then
1300 say_color error "# $test_fixed known breakage(s) vanished; please update test(s)"
1302 if test "$test_broken" != 0
1303 then
1304 say_color warn "# still have $test_broken known breakage(s)"
1306 if test "$test_broken" != 0 || test "$test_fixed" != 0
1307 then
1308 test_remaining=$(( $test_count - $test_broken - $test_fixed ))
1309 msg="remaining $test_remaining test(s)"
1310 else
1311 test_remaining=$test_count
1312 msg="$test_count test(s)"
1314 case "$test_failure" in
1316 if test $test_remaining -gt 0
1317 then
1318 say_color pass "# passed all $msg"
1321 # Maybe print SKIP message
1322 test -z "$skip_all" || skip_all="# SKIP $skip_all"
1323 case "$test_count" in
1325 say "1..$test_count${skip_all:+ $skip_all}"
1328 test -z "$skip_all" ||
1329 say_color warn "$skip_all"
1330 say "1..$test_count"
1332 esac
1334 if test -n "$stress" && test -n "$invert_exit_code"
1335 then
1336 # We're about to move our "$TRASH_DIRECTORY"
1337 # to "$TRASH_DIRECTORY.stress-failed" if
1338 # --stress is combined with
1339 # --invert-exit-code.
1340 say "with --stress and --invert-exit-code we're not removing '$TRASH_DIRECTORY'"
1341 elif test -z "$debug" && test -n "$remove_trash"
1342 then
1343 test -d "$TRASH_DIRECTORY" ||
1344 error "Tests passed but trash directory already removed before test cleanup; aborting"
1346 cd "$TRASH_DIRECTORY/.." &&
1347 rm -fr "$TRASH_DIRECTORY" || {
1348 # try again in a bit
1349 sleep 5;
1350 rm -fr "$TRASH_DIRECTORY"
1351 } ||
1352 error "Tests passed but test cleanup failed; aborting"
1355 check_test_results_san_file_ "$test_failure"
1357 if test -z "$skip_all" && test -n "$invert_exit_code"
1358 then
1359 say_color warn "# faking up non-zero exit with --invert-exit-code"
1360 GIT_EXIT_OK=t
1361 exit 1
1364 test_at_end_hook_
1366 GIT_EXIT_OK=t
1367 exit 0 ;;
1370 say_color error "# failed $test_failure among $msg"
1371 say "1..$test_count"
1373 check_test_results_san_file_ "$test_failure"
1375 if test -n "$invert_exit_code"
1376 then
1377 _invert_exit_code_failure_end_blurb
1378 GIT_EXIT_OK=t
1379 exit 0
1382 GIT_EXIT_OK=t
1383 exit 1 ;;
1385 esac
1388 if test -n "$valgrind"
1389 then
1390 make_symlink () {
1391 test -h "$2" &&
1392 test "$1" = "$(readlink "$2")" || {
1393 # be super paranoid
1394 if mkdir "$2".lock
1395 then
1396 rm -f "$2" &&
1397 ln -s "$1" "$2" &&
1398 rm -r "$2".lock
1399 else
1400 while test -d "$2".lock
1402 say "Waiting for lock on $2."
1403 sleep 1
1404 done
1409 make_valgrind_symlink () {
1410 # handle only executables, unless they are shell libraries that
1411 # need to be in the exec-path.
1412 test -x "$1" ||
1413 test "# " = "$(test_copy_bytes 2 <"$1")" ||
1414 return;
1416 base=$(basename "$1")
1417 case "$base" in
1418 test-*)
1419 symlink_target="$GIT_BUILD_DIR/t/helper/$base"
1422 symlink_target="$GIT_BUILD_DIR/$base"
1424 esac
1425 # do not override scripts
1426 if test -x "$symlink_target" &&
1427 test ! -d "$symlink_target" &&
1428 test "#!" != "$(test_copy_bytes 2 <"$symlink_target")"
1429 then
1430 symlink_target=../valgrind.sh
1432 case "$base" in
1433 *.sh|*.perl)
1434 symlink_target=../unprocessed-script
1435 esac
1436 # create the link, or replace it if it is out of date
1437 make_symlink "$symlink_target" "$GIT_VALGRIND/bin/$base" || exit
1440 # override all git executables in TEST_DIRECTORY/..
1441 GIT_VALGRIND=$TEST_DIRECTORY/valgrind
1442 mkdir -p "$GIT_VALGRIND"/bin
1443 for file in $GIT_BUILD_DIR/git* $GIT_BUILD_DIR/t/helper/test-*
1445 make_valgrind_symlink $file
1446 done
1447 # special-case the mergetools loadables
1448 make_symlink "$GIT_BUILD_DIR"/mergetools "$GIT_VALGRIND/bin/mergetools"
1449 OLDIFS=$IFS
1450 IFS=:
1451 for path in $PATH
1453 ls "$path"/git-* 2> /dev/null |
1454 while read file
1456 make_valgrind_symlink "$file"
1457 done
1458 done
1459 IFS=$OLDIFS
1460 PATH=$GIT_VALGRIND/bin:$PATH
1461 GIT_EXEC_PATH=$GIT_VALGRIND/bin
1462 export GIT_VALGRIND
1463 GIT_VALGRIND_MODE="$valgrind"
1464 export GIT_VALGRIND_MODE
1465 GIT_VALGRIND_ENABLED=t
1466 test -n "$valgrind_only" && GIT_VALGRIND_ENABLED=
1467 export GIT_VALGRIND_ENABLED
1468 elif test -n "$GIT_TEST_INSTALLED"
1469 then
1470 GIT_EXEC_PATH=$($GIT_TEST_INSTALLED/git --exec-path) ||
1471 error "Cannot run git from $GIT_TEST_INSTALLED."
1472 PATH=$GIT_TEST_INSTALLED:$GIT_BUILD_DIR/t/helper:$PATH
1473 GIT_EXEC_PATH=${GIT_TEST_EXEC_PATH:-$GIT_EXEC_PATH}
1474 else # normal case, use ../bin-wrappers only unless $with_dashes:
1475 if test -n "$no_bin_wrappers"
1476 then
1477 with_dashes=t
1478 else
1479 git_bin_dir="$GIT_BUILD_DIR/bin-wrappers"
1480 if ! test -x "$git_bin_dir/git"
1481 then
1482 if test -z "$with_dashes"
1483 then
1484 say "$git_bin_dir/git is not executable; using GIT_EXEC_PATH"
1486 with_dashes=t
1488 PATH="$git_bin_dir:$PATH"
1490 GIT_EXEC_PATH=$GIT_BUILD_DIR
1491 if test -n "$with_dashes"
1492 then
1493 PATH="$GIT_BUILD_DIR:$GIT_BUILD_DIR/t/helper:$PATH"
1496 GIT_TEMPLATE_DIR="$GIT_BUILD_DIR"/templates/blt
1497 GIT_CONFIG_NOSYSTEM=1
1498 GIT_ATTR_NOSYSTEM=1
1499 GIT_CEILING_DIRECTORIES="$TRASH_DIRECTORY/.."
1500 export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG_NOSYSTEM GIT_ATTR_NOSYSTEM GIT_CEILING_DIRECTORIES
1502 if test -z "$GIT_TEST_CMP"
1503 then
1504 if test -n "$GIT_TEST_CMP_USE_COPIED_CONTEXT"
1505 then
1506 GIT_TEST_CMP="$DIFF -c"
1507 else
1508 GIT_TEST_CMP="$DIFF -u"
1512 GITPERLLIB="$GIT_BUILD_DIR"/perl/build/lib
1513 export GITPERLLIB
1514 test -d "$GIT_BUILD_DIR"/templates/blt || {
1515 BAIL_OUT "You haven't built things yet, have you?"
1518 if ! test -x "$GIT_BUILD_DIR"/t/helper/test-tool$X
1519 then
1520 BAIL_OUT 'You need to build test-tool; Run "make t/helper/test-tool" in the source (toplevel) directory'
1523 # Are we running this test at all?
1524 remove_trash=
1525 this_test=${0##*/}
1526 this_test=${this_test%%-*}
1527 if match_pattern_list "$this_test" "$GIT_SKIP_TESTS"
1528 then
1529 say_color info >&3 "skipping test $this_test altogether"
1530 skip_all="skip all tests in $this_test"
1531 test_done
1534 BAIL_OUT_ENV_NEEDS_SANITIZE_LEAK () {
1535 BAIL_OUT "$1 has no effect except when compiled with SANITIZE=leak"
1538 if test -n "$SANITIZE_LEAK"
1539 then
1540 # Normalize with test_bool_env
1541 passes_sanitize_leak=
1543 # We need to see TEST_PASSES_SANITIZE_LEAK in "test-tool
1544 # env-helper" (via test_bool_env)
1545 export TEST_PASSES_SANITIZE_LEAK
1546 if test_bool_env TEST_PASSES_SANITIZE_LEAK false
1547 then
1548 passes_sanitize_leak=t
1551 if test "$GIT_TEST_PASSING_SANITIZE_LEAK" = "check"
1552 then
1553 sanitize_leak_check=t
1554 if test -n "$invert_exit_code"
1555 then
1556 BAIL_OUT "cannot use --invert-exit-code under GIT_TEST_PASSING_SANITIZE_LEAK=check"
1559 if test -z "$passes_sanitize_leak"
1560 then
1561 say "in GIT_TEST_PASSING_SANITIZE_LEAK=check mode, setting --invert-exit-code for TEST_PASSES_SANITIZE_LEAK != true"
1562 invert_exit_code=t
1564 elif test -z "$passes_sanitize_leak" &&
1565 test_bool_env GIT_TEST_PASSING_SANITIZE_LEAK false
1566 then
1567 skip_all="skipping $this_test under GIT_TEST_PASSING_SANITIZE_LEAK=true"
1568 test_done
1571 if test_bool_env GIT_TEST_SANITIZE_LEAK_LOG false
1572 then
1573 if ! mkdir -p "$TEST_RESULTS_SAN_DIR"
1574 then
1575 BAIL_OUT "cannot create $TEST_RESULTS_SAN_DIR"
1576 fi &&
1577 TEST_RESULTS_SAN_FILE="$TEST_RESULTS_SAN_DIR/$TEST_RESULTS_SAN_FILE_PFX"
1579 # In case "test-results" is left over from a previous
1580 # run: Only report if new leaks show up.
1581 TEST_RESULTS_SAN_DIR_NR_LEAKS_STARTUP=$(nr_san_dir_leaks_)
1583 # Don't litter *.leak dirs if there was nothing to report
1584 test_atexit "rmdir \"$TEST_RESULTS_SAN_DIR\" 2>/dev/null || :"
1586 prepend_var LSAN_OPTIONS : dedup_token_length=9999
1587 prepend_var LSAN_OPTIONS : log_exe_name=1
1588 prepend_var LSAN_OPTIONS : log_path=\"$TEST_RESULTS_SAN_FILE\"
1589 export LSAN_OPTIONS
1591 elif test "$GIT_TEST_PASSING_SANITIZE_LEAK" = "check" ||
1592 test_bool_env GIT_TEST_PASSING_SANITIZE_LEAK false
1593 then
1594 BAIL_OUT_ENV_NEEDS_SANITIZE_LEAK "GIT_TEST_PASSING_SANITIZE_LEAK=true"
1595 elif test_bool_env GIT_TEST_SANITIZE_LEAK_LOG false
1596 then
1597 BAIL_OUT_ENV_NEEDS_SANITIZE_LEAK "GIT_TEST_SANITIZE_LEAK_LOG=true"
1600 if test "${GIT_TEST_CHAIN_LINT:-1}" != 0 &&
1601 test "${GIT_TEST_EXT_CHAIN_LINT:-1}" != 0
1602 then
1603 "$PERL_PATH" "$TEST_DIRECTORY/chainlint.pl" "$0" ||
1604 BUG "lint error (see '?!...!? annotations above)"
1607 # Last-minute variable setup
1608 USER_HOME="$HOME"
1609 HOME="$TRASH_DIRECTORY"
1610 GNUPGHOME="$HOME/gnupg-home-not-used"
1611 export HOME GNUPGHOME USER_HOME
1613 # "rm -rf" existing trash directory, even if a previous run left it
1614 # with bad permissions.
1615 remove_trash_directory () {
1616 dir="$1"
1617 if ! rm -rf "$dir" 2>/dev/null
1618 then
1619 chmod -R u+rwx "$dir"
1620 rm -rf "$dir"
1622 ! test -d "$dir"
1625 # Test repository
1626 remove_trash_directory "$TRASH_DIRECTORY" || {
1627 BAIL_OUT 'cannot prepare test area'
1630 remove_trash=t
1631 if test -z "$TEST_NO_CREATE_REPO"
1632 then
1633 git init \
1634 ${TEST_CREATE_REPO_NO_TEMPLATE:+--template=} \
1635 "$TRASH_DIRECTORY" >&3 2>&4 ||
1636 error "cannot run git init"
1637 else
1638 mkdir -p "$TRASH_DIRECTORY"
1641 # Use -P to resolve symlinks in our working directory so that the cwd
1642 # in subprocesses like git equals our $PWD (for pathname comparisons).
1643 cd -P "$TRASH_DIRECTORY" || BAIL_OUT "cannot cd -P to \"$TRASH_DIRECTORY\""
1645 start_test_output "$0"
1647 # Convenience
1648 # A regexp to match 5 and 35 hexdigits
1649 _x05='[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
1650 _x35="$_x05$_x05$_x05$_x05$_x05$_x05$_x05"
1652 test_oid_init
1654 ZERO_OID=$(test_oid zero)
1655 OID_REGEX=$(echo $ZERO_OID | sed -e 's/0/[0-9a-f]/g')
1656 OIDPATH_REGEX=$(test_oid_to_path $ZERO_OID | sed -e 's/0/[0-9a-f]/g')
1657 EMPTY_TREE=$(test_oid empty_tree)
1658 EMPTY_BLOB=$(test_oid empty_blob)
1660 # Provide an implementation of the 'yes' utility; the upper bound
1661 # limit is there to help Windows that cannot stop this loop from
1662 # wasting cycles when the downstream stops reading, so do not be
1663 # tempted to turn it into an infinite loop. cf. 6129c930 ("test-lib:
1664 # limit the output of the yes utility", 2016-02-02)
1665 yes () {
1666 if test $# = 0
1667 then
1669 else
1670 y="$*"
1674 while test $i -lt 99
1676 echo "$y"
1677 i=$(($i+1))
1678 done
1681 # The GIT_TEST_FAIL_PREREQS code hooks into test_set_prereq(), and
1682 # thus needs to be set up really early, and set an internal variable
1683 # for convenience so the hot test_set_prereq() codepath doesn't need
1684 # to call "test-tool env-helper" (via test_bool_env). Only do that work
1685 # if needed by seeing if GIT_TEST_FAIL_PREREQS is set at all.
1686 GIT_TEST_FAIL_PREREQS_INTERNAL=
1687 if test -n "$GIT_TEST_FAIL_PREREQS"
1688 then
1689 if test_bool_env GIT_TEST_FAIL_PREREQS false
1690 then
1691 GIT_TEST_FAIL_PREREQS_INTERNAL=true
1692 test_set_prereq FAIL_PREREQS
1694 else
1695 test_lazy_prereq FAIL_PREREQS '
1696 test_bool_env GIT_TEST_FAIL_PREREQS false
1700 # Fix some commands on Windows, and other OS-specific things
1701 uname_s=$(uname -s)
1702 case $uname_s in
1703 *MINGW*)
1704 # Windows has its own (incompatible) sort and find
1705 sort () {
1706 /usr/bin/sort "$@"
1708 find () {
1709 /usr/bin/find "$@"
1711 # git sees Windows-style pwd
1712 pwd () {
1713 builtin pwd -W
1715 # no POSIX permissions
1716 # backslashes in pathspec are converted to '/'
1717 # exec does not inherit the PID
1718 test_set_prereq MINGW
1719 test_set_prereq NATIVE_CRLF
1720 test_set_prereq SED_STRIPS_CR
1721 test_set_prereq GREP_STRIPS_CR
1722 test_set_prereq WINDOWS
1723 GIT_TEST_CMP="GIT_DIR=/dev/null git diff --no-index --ignore-cr-at-eol --"
1725 *CYGWIN*)
1726 test_set_prereq POSIXPERM
1727 test_set_prereq EXECKEEPSPID
1728 test_set_prereq CYGWIN
1729 test_set_prereq SED_STRIPS_CR
1730 test_set_prereq GREP_STRIPS_CR
1731 test_set_prereq WINDOWS
1734 test_set_prereq POSIXPERM
1735 test_set_prereq BSLASHPSPEC
1736 test_set_prereq EXECKEEPSPID
1738 esac
1740 # Detect arches where a few things don't work
1741 uname_m=$(uname -m)
1742 case $uname_m in
1743 parisc* | hppa*)
1744 test_set_prereq HPPA
1746 esac
1748 test_set_prereq REFFILES
1750 ( COLUMNS=1 && test $COLUMNS = 1 ) && test_set_prereq COLUMNS_CAN_BE_1
1751 test -z "$NO_CURL" && test_set_prereq LIBCURL
1752 test -z "$NO_PERL" && test_set_prereq PERL
1753 test -z "$NO_PTHREADS" && test_set_prereq PTHREADS
1754 test -z "$NO_PYTHON" && test_set_prereq PYTHON
1755 test -n "$USE_LIBPCRE2" && test_set_prereq PCRE
1756 test -n "$USE_LIBPCRE2" && test_set_prereq LIBPCRE2
1757 test -z "$NO_GETTEXT" && test_set_prereq GETTEXT
1758 test -n "$SANITIZE_LEAK" && test_set_prereq SANITIZE_LEAK
1759 test -n "$GIT_VALGRIND_ENABLED" && test_set_prereq VALGRIND
1761 if test -z "$GIT_TEST_CHECK_CACHE_TREE"
1762 then
1763 GIT_TEST_CHECK_CACHE_TREE=true
1764 export GIT_TEST_CHECK_CACHE_TREE
1767 test_lazy_prereq PIPE '
1768 # test whether the filesystem supports FIFOs
1769 test_have_prereq !MINGW,!CYGWIN &&
1770 rm -f testfifo && mkfifo testfifo
1773 test_lazy_prereq SYMLINKS '
1774 # test whether the filesystem supports symbolic links
1775 ln -s x y && test -h y
1778 test_lazy_prereq SYMLINKS_WINDOWS '
1779 # test whether symbolic links are enabled on Windows
1780 test_have_prereq MINGW &&
1781 cmd //c "mklink y x" &> /dev/null && test -h y
1784 test_lazy_prereq FILEMODE '
1785 test "$(git config --bool core.filemode)" = true
1788 test_lazy_prereq CASE_INSENSITIVE_FS '
1789 echo good >CamelCase &&
1790 echo bad >camelcase &&
1791 test "$(cat CamelCase)" != good
1794 test_lazy_prereq FUNNYNAMES '
1795 test_have_prereq !MINGW &&
1796 touch -- \
1797 "FUNNYNAMES tab embedded" \
1798 "FUNNYNAMES \"quote embedded\"" \
1799 "FUNNYNAMES newline
1800 embedded" 2>/dev/null &&
1801 rm -- \
1802 "FUNNYNAMES tab embedded" \
1803 "FUNNYNAMES \"quote embedded\"" \
1804 "FUNNYNAMES newline
1805 embedded" 2>/dev/null
1808 test_lazy_prereq UTF8_NFD_TO_NFC '
1809 # check whether FS converts nfd unicode to nfc
1810 auml=$(printf "\303\244")
1811 aumlcdiar=$(printf "\141\314\210")
1812 >"$auml" &&
1813 test -f "$aumlcdiar"
1816 test_lazy_prereq AUTOIDENT '
1817 sane_unset GIT_AUTHOR_NAME &&
1818 sane_unset GIT_AUTHOR_EMAIL &&
1819 git var GIT_AUTHOR_IDENT
1822 test_lazy_prereq EXPENSIVE '
1823 test -n "$GIT_TEST_LONG"
1826 test_lazy_prereq EXPENSIVE_ON_WINDOWS '
1827 test_have_prereq EXPENSIVE || test_have_prereq !MINGW,!CYGWIN
1830 test_lazy_prereq USR_BIN_TIME '
1831 test -x /usr/bin/time
1834 test_lazy_prereq NOT_ROOT '
1835 uid=$(id -u) &&
1836 test "$uid" != 0
1839 test_lazy_prereq JGIT '
1840 jgit --version
1843 # SANITY is about "can you correctly predict what the filesystem would
1844 # do by only looking at the permission bits of the files and
1845 # directories?" A typical example of !SANITY is running the test
1846 # suite as root, where a test may expect "chmod -r file && cat file"
1847 # to fail because file is supposed to be unreadable after a successful
1848 # chmod. In an environment (i.e. combination of what filesystem is
1849 # being used and who is running the tests) that lacks SANITY, you may
1850 # be able to delete or create a file when the containing directory
1851 # doesn't have write permissions, or access a file even if the
1852 # containing directory doesn't have read or execute permissions.
1854 test_lazy_prereq SANITY '
1855 mkdir SANETESTD.1 SANETESTD.2 &&
1857 chmod +w SANETESTD.1 SANETESTD.2 &&
1858 >SANETESTD.1/x 2>SANETESTD.2/x &&
1859 chmod -w SANETESTD.1 &&
1860 chmod -r SANETESTD.1/x &&
1861 chmod -rx SANETESTD.2 ||
1862 BUG "cannot prepare SANETESTD"
1864 ! test -r SANETESTD.1/x &&
1865 ! rm SANETESTD.1/x && ! test -f SANETESTD.2/x
1866 status=$?
1868 chmod +rwx SANETESTD.1 SANETESTD.2 &&
1869 rm -rf SANETESTD.1 SANETESTD.2 ||
1870 BUG "cannot clean SANETESTD"
1871 return $status
1874 test FreeBSD != $uname_s || GIT_UNZIP=${GIT_UNZIP:-/usr/local/bin/unzip}
1875 GIT_UNZIP=${GIT_UNZIP:-unzip}
1876 test_lazy_prereq UNZIP '
1877 "$GIT_UNZIP" -v
1878 test $? -ne 127
1881 run_with_limited_cmdline () {
1882 (ulimit -s 128 && "$@")
1885 test_lazy_prereq CMDLINE_LIMIT '
1886 test_have_prereq !HPPA,!MINGW,!CYGWIN &&
1887 run_with_limited_cmdline true
1890 run_with_limited_stack () {
1891 (ulimit -s 128 && "$@")
1894 test_lazy_prereq ULIMIT_STACK_SIZE '
1895 test_have_prereq !HPPA,!MINGW,!CYGWIN &&
1896 run_with_limited_stack true
1899 run_with_limited_open_files () {
1900 (ulimit -n 32 && "$@")
1903 test_lazy_prereq ULIMIT_FILE_DESCRIPTORS '
1904 test_have_prereq !MINGW,!CYGWIN &&
1905 run_with_limited_open_files true
1908 build_option () {
1909 git version --build-options |
1910 sed -ne "s/^$1: //p"
1913 test_lazy_prereq SIZE_T_IS_64BIT '
1914 test 8 -eq "$(build_option sizeof-size_t)"
1917 test_lazy_prereq LONG_IS_64BIT '
1918 test 8 -le "$(build_option sizeof-long)"
1921 test_lazy_prereq TIME_IS_64BIT 'test-tool date is64bit'
1922 test_lazy_prereq TIME_T_IS_64BIT 'test-tool date time_t-is64bit'
1924 test_lazy_prereq CURL '
1925 curl --version
1928 # SHA1 is a test if the hash algorithm in use is SHA-1. This is both for tests
1929 # which will not work with other hash algorithms and tests that work but don't
1930 # test anything meaningful (e.g. special values which cause short collisions).
1931 test_lazy_prereq SHA1 '
1932 case "$GIT_DEFAULT_HASH" in
1933 sha1) true ;;
1934 "") test $(git hash-object /dev/null) = e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 ;;
1935 *) false ;;
1936 esac
1939 # Ensure that no test accidentally triggers a Git command
1940 # that runs the actual maintenance scheduler, affecting a user's
1941 # system permanently.
1942 # Tests that verify the scheduler integration must set this locally
1943 # to avoid errors.
1944 GIT_TEST_MAINT_SCHEDULER="none:exit 1"
1946 # Does this platform support `git fsmonitor--daemon`
1948 test_lazy_prereq FSMONITOR_DAEMON '
1949 git version --build-options >output &&
1950 grep "feature: fsmonitor--daemon" output