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"
22 # We allow tests to override this, in case they want to run tests
23 # outside of t/, e.g. for running tests on the test library
27 # ensure that TEST_DIRECTORY is an absolute path so that it
28 # is valid even if the current working directory is changed
29 TEST_DIRECTORY
=$
(cd "$TEST_DIRECTORY" && pwd) ||
exit 1
31 if test -z "$TEST_OUTPUT_DIRECTORY"
33 # Similarly, override this to store the test-results subdir
35 TEST_OUTPUT_DIRECTORY
=$TEST_DIRECTORY
37 GIT_BUILD_DIR
="$TEST_DIRECTORY"/..
39 # If we were built with ASAN, it may complain about leaks
40 # of program-lifetime variables. Disable it by default to lower
41 # the noise level. This needs to happen at the start of the script,
42 # before we even do our "did we build git yet" check (since we don't
43 # want that one to complain to stderr).
44 : ${ASAN_OPTIONS=detect_leaks=0:abort_on_error=1}
47 # If LSAN is in effect we _do_ want leak checking, but we still
48 # want to abort so that we notice the problems.
49 : ${LSAN_OPTIONS=abort_on_error=1}
52 if test ! -f "$GIT_BUILD_DIR"/GIT-BUILD-OPTIONS
54 echo >&2 'error: GIT-BUILD-OPTIONS missing (has Git been built?).'
57 .
"$GIT_BUILD_DIR"/GIT-BUILD-OPTIONS
58 export PERL_PATH SHELL_PATH
60 # In t0000, we need to override test directories of nested testcases. In case
61 # the developer has TEST_OUTPUT_DIRECTORY part of his build options, then we'd
62 # reset this value to instead contain what the developer has specified. We thus
63 # have this knob to allow overriding the directory.
64 if test -n "${TEST_OUTPUT_DIRECTORY_OVERRIDE}"
66 TEST_OUTPUT_DIRECTORY
="${TEST_OUTPUT_DIRECTORY_OVERRIDE}"
69 # Disallow the use of abbreviated options in the test suite by default
70 if test -z "${GIT_TEST_DISALLOW_ABBREVIATED_OPTIONS}"
72 GIT_TEST_DISALLOW_ABBREVIATED_OPTIONS
=true
73 export GIT_TEST_DISALLOW_ABBREVIATED_OPTIONS
76 # Explicitly set the default branch name for testing, to avoid the
77 # transitory "git init" warning under --verbose.
78 : ${GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME:=master}
79 export GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME
81 ################################################################
82 # It appears that people try to run tests without building...
83 "${GIT_TEST_INSTALLED:-$GIT_BUILD_DIR}/git$X" >/dev
/null
86 if test -n "$GIT_TEST_INSTALLED"
88 echo >&2 "error: there is no working Git at '$GIT_TEST_INSTALLED'"
90 echo >&2 'error: you do not seem to have built git yet.'
98 # $2: name of the var where the arg will be stored
99 mark_option_requires_arg
() {
100 if test -n "$opt_required_arg"
102 echo "error: options that require args cannot be bundled" \
103 "together: '$opt_required_arg' and '$1'" >&2
114 -d|
--d|
--de|
--deb|
--debu|
--debug)
116 -i|
--i|
--im|
--imm|
--imme|
--immed|
--immedi|
--immedia|
--immediat|
--immediate)
118 -l|
--l|
--lo|
--lon|
--long|
--long-|
--long-t|
--long-te|
--long-tes|
--long-test|
--long-tests)
119 GIT_TEST_LONG
=t
; export GIT_TEST_LONG
;;
121 mark_option_requires_arg
"$opt" run_list
124 run_list
=${opt#--*=} ;;
125 -h|
--h|
--he|
--hel|
--help)
127 -v|
--v|
--ve|
--ver|
--verb|
--verbo|
--verbos|
--verbose)
130 verbose_only
=${opt#--*=}
132 -q|
--q|
--qu|
--qui|
--quie|
--quiet)
133 # Ignore --quiet under a TAP::Harness. Saying how many tests
134 # passed without the ok/not ok details is always an error.
135 test -z "$HARNESS_ACTIVE" && quiet
=t
;;
142 --va|
--val|
--valg|
--valgr|
--valgri|
--valgrin|
--valgrind)
151 valgrind_only
=${opt#--*=}
159 GIT_TEST_CHAIN_LINT
=1 ;;
161 GIT_TEST_CHAIN_LINT
=0 ;;
174 echo "error: --stress does not accept an argument: '$opt'" >&2
175 echo "did you mean --stress-jobs=${opt#*=} or --stress-limit=${opt#*=}?" >&2
180 stress_jobs
=${opt#--*=}
181 case "$stress_jobs" in
183 echo "error: --stress-jobs=<N> requires the number of jobs to run" >&2
192 stress_limit
=${opt#--*=}
193 case "$stress_limit" in
195 echo "error: --stress-limit=<N> requires the number of repetitions" >&2
203 echo "error: unknown test option '$opt'" >&2; exit 1 ;;
207 # Parse options while taking care to leave $@ intact, so we will still
208 # have all the original command line options when executing the test
209 # script again for '--tee' and '--verbose-log' later.
212 if test -n "$store_arg_to"
214 eval $store_arg_to=\
$opt
222 parse_option
"$opt" ;;
224 # bundled short options must be fed separately to parse_option
231 parse_option
"-$this"
235 echo "error: unknown test option '$opt'" >&2; exit 1 ;;
238 if test -n "$store_arg_to"
240 echo "error: $opt_required_arg requires an argument" >&2
244 if test -n "$valgrind_only"
246 test -z "$valgrind" && valgrind
=memcheck
247 test -z "$verbose" && verbose_only
="$valgrind_only"
248 elif test -n "$valgrind"
250 test -z "$verbose_log" && verbose
=t
260 TEST_STRESS_JOB_SFX
="${GIT_TEST_STRESS_JOB_NR:+.stress-$GIT_TEST_STRESS_JOB_NR}"
261 TEST_NAME
="$(basename "$0" .sh)"
262 TEST_NUMBER
="${TEST_NAME%%-*}"
263 TEST_NUMBER
="${TEST_NUMBER#t}"
264 TEST_RESULTS_DIR
="$TEST_OUTPUT_DIRECTORY/test-results"
265 TEST_RESULTS_BASE
="$TEST_RESULTS_DIR/$TEST_NAME$TEST_STRESS_JOB_SFX"
266 TRASH_DIRECTORY
="trash directory.$TEST_NAME$TEST_STRESS_JOB_SFX"
267 test -n "$root" && TRASH_DIRECTORY
="$root/$TRASH_DIRECTORY"
268 case "$TRASH_DIRECTORY" in
269 /*) ;; # absolute path is good
270 *) TRASH_DIRECTORY
="$TEST_OUTPUT_DIRECTORY/$TRASH_DIRECTORY" ;;
273 # If --stress was passed, run this test repeatedly in several parallel loops.
274 if test "$GIT_TEST_STRESS_STARTED" = "done"
276 : # Don't stress test again.
277 elif test -n "$stress"
279 if test -n "$stress_jobs"
281 job_count
=$stress_jobs
282 elif test -n "$GIT_TEST_STRESS_LOAD"
284 job_count
="$GIT_TEST_STRESS_LOAD"
285 elif job_count
=$
(getconf _NPROCESSORS_ONLN
2>/dev
/null
) &&
288 job_count
=$
((2 * $job_count))
293 mkdir
-p "$TEST_RESULTS_DIR"
294 stressfail
="$TEST_RESULTS_BASE.stress-failed"
299 kill $job_pids 2>/dev/null
306 while test $job_nr -lt "$job_count"
309 GIT_TEST_STRESS_STARTED
=done
310 GIT_TEST_STRESS_JOB_NR
=$job_nr
311 export GIT_TEST_STRESS_STARTED GIT_TEST_STRESS_JOB_NR
314 kill $test_pid 2>/dev/null
320 while ! test -e "$stressfail" &&
321 { test -z "$stress_limit" ||
322 test $cnt -le $stress_limit ; }
324 $TEST_SHELL_PATH "$0" "$@" >"$TEST_RESULTS_BASE.stress-$job_nr.out" 2>&1 &
329 printf "OK %2d.%d\n" $GIT_TEST_STRESS_JOB_NR $cnt
331 echo $GIT_TEST_STRESS_JOB_NR >>"$stressfail"
332 printf "FAIL %2d.%d\n" $GIT_TEST_STRESS_JOB_NR $cnt
337 job_pids
="$job_pids $!"
338 job_nr
=$
(($job_nr + 1))
343 if test -f "$stressfail"
346 echo "Log(s) of failed test run(s):"
347 for failed_job_nr
in $
(sort -n "$stressfail")
349 echo "Contents of '$TEST_RESULTS_BASE.stress-$failed_job_nr.out':"
350 cat "$TEST_RESULTS_BASE.stress-$failed_job_nr.out"
352 rm -rf "$TRASH_DIRECTORY.stress-failed"
354 mv "$TRASH_DIRECTORY.stress-$failed_job_nr" "$TRASH_DIRECTORY.stress-failed"
360 # if --tee was passed, write the output not only to the terminal, but
361 # additionally to the file test-results/$BASENAME.out, too.
362 if test "$GIT_TEST_TEE_STARTED" = "done"
364 : # do not redirect again
367 mkdir
-p "$TEST_RESULTS_DIR"
369 # Make this filename available to the sub-process in case it is using
371 GIT_TEST_TEE_OUTPUT_FILE
=$TEST_RESULTS_BASE.out
372 export GIT_TEST_TEE_OUTPUT_FILE
374 # Truncate before calling "tee -a" to get rid of the results
375 # from any previous runs.
376 >"$GIT_TEST_TEE_OUTPUT_FILE"
378 (GIT_TEST_TEE_STARTED
=done ${TEST_SHELL_PATH} "$0" "$@" 2>&1;
379 echo $?
>"$TEST_RESULTS_BASE.exit") |
tee -a "$GIT_TEST_TEE_OUTPUT_FILE"
380 test "$(cat "$TEST_RESULTS_BASE.
exit")" = 0
384 if test -n "$trace" && test -n "$test_untraceable"
386 # '-x' tracing requested, but this test script can't be reliably
387 # traced, unless it is run with a Bash version supporting
388 # BASH_XTRACEFD (introduced in Bash v4.1).
390 # Perform this version check _after_ the test script was
391 # potentially re-executed with $TEST_SHELL_PATH for '--tee' or
392 # '--verbose-log', so the right shell is checked and the
393 # warning is issued only once.
394 if test -n "$BASH_VERSION" && eval '
395 test ${BASH_VERSINFO[0]} -gt 4 || {
396 test ${BASH_VERSINFO[0]} -eq 4 &&
397 test ${BASH_VERSINFO[1]} -ge 1
401 : Executed by a Bash version supporting BASH_XTRACEFD. Good.
403 echo >&2 "warning: ignoring -x; '$0' is untraceable without BASH_XTRACEFD"
407 if test -n "$trace" && test -z "$verbose_log"
412 # Since bash 5.0, checkwinsize is enabled by default which does
413 # update the COLUMNS variable every time a non-builtin command
414 # completes, even for non-interactive shells.
415 # Disable that since we are aiming for repeatability.
416 test -n "$BASH_VERSION" && shopt -u checkwinsize
2>/dev
/null
418 # For repeatability, reset the environment to known value.
419 # TERM is sanitized below, after saving color control sequences.
425 export LANG LC_ALL PAGER TZ COLUMNS
428 # A call to "unset" with no arguments causes at least Solaris 10
429 # /usr/xpg4/bin/sh and /bin/ksh to bail out. So keep the unsets
430 # deriving from the command substitution clustered with the other
432 unset VISUAL EMAIL LANGUAGE $
("$PERL_PATH" -e '
434 my $ok = join("|", qw(
446 my @vars = grep(/^GIT_/ && !/^GIT_($ok)/o, @env);
447 print join("\n", @vars);
450 unset XDG_CONFIG_HOME
452 TEST_AUTHOR_LOCALNAME
=author
453 TEST_AUTHOR_DOMAIN
=example.com
454 GIT_AUTHOR_EMAIL
=${TEST_AUTHOR_LOCALNAME}@
${TEST_AUTHOR_DOMAIN}
455 GIT_AUTHOR_NAME
='A U Thor'
456 GIT_AUTHOR_DATE
='1112354055 +0200'
457 TEST_COMMITTER_LOCALNAME
=committer
458 TEST_COMMITTER_DOMAIN
=example.com
459 GIT_COMMITTER_EMAIL
=${TEST_COMMITTER_LOCALNAME}@
${TEST_COMMITTER_DOMAIN}
460 GIT_COMMITTER_NAME
='C O Mitter'
461 GIT_COMMITTER_DATE
='1112354055 +0200'
462 GIT_MERGE_VERBOSITY
=5
463 GIT_MERGE_AUTOEDIT
=no
464 export GIT_MERGE_VERBOSITY GIT_MERGE_AUTOEDIT
465 export GIT_AUTHOR_EMAIL GIT_AUTHOR_NAME
466 export GIT_COMMITTER_EMAIL GIT_COMMITTER_NAME
467 export GIT_COMMITTER_DATE GIT_AUTHOR_DATE
470 GIT_DEFAULT_HASH
="${GIT_TEST_DEFAULT_HASH:-sha1}"
471 export GIT_DEFAULT_HASH
472 GIT_TEST_MERGE_ALGORITHM
="${GIT_TEST_MERGE_ALGORITHM:-ort}"
473 export GIT_TEST_MERGE_ALGORITHM
475 # Tests using GIT_TRACE typically don't want <timestamp> <file>:<line> output
477 export GIT_TRACE_BARE
479 # Use specific version of the index file format
480 if test -n "${GIT_TEST_INDEX_VERSION:+isset}"
482 GIT_INDEX_VERSION
="$GIT_TEST_INDEX_VERSION"
483 export GIT_INDEX_VERSION
486 if test -n "$GIT_TEST_PERL_FATAL_WARNINGS"
488 GIT_PERL_FATAL_WARNINGS
=1
489 export GIT_PERL_FATAL_WARNINGS
492 # Add libc MALLOC and MALLOC_PERTURB test
493 # only if we are not executing the test with valgrind
494 if test -n "$valgrind" ||
495 test -n "$TEST_NO_MALLOC_CHECK"
497 setup_malloc_check
() {
500 teardown_malloc_check
() {
504 setup_malloc_check
() {
505 MALLOC_CHECK_
=3 MALLOC_PERTURB_
=165
506 export MALLOC_CHECK_ MALLOC_PERTURB_
508 teardown_malloc_check
() {
509 unset MALLOC_CHECK_ MALLOC_PERTURB_
513 # Protect ourselves from common misconfiguration to export
514 # CDPATH into the environment
520 case $
(echo $GIT_TRACE |
tr "[A-Z]" "[a-z]") in
533 # UTF-8 ZERO WIDTH NON-JOINER, which HFS+ ignores
534 # when case-folding filenames
535 u200c
=$
(printf '\342\200\214')
537 export _x05 _x35 _x40 _z40 LF u200c EMPTY_TREE EMPTY_BLOB ZERO_OID OID_REGEX
539 # Each test should start with something like this, after copyright notices:
541 # test_description='Description of this test...
542 # This test checks if command xyzzy does the right thing...
545 test "x$TERM" != "xdumb" && (
547 tput bold
>/dev
/null
2>&1 &&
548 tput setaf
1 >/dev
/null
2>&1 &&
549 tput sgr0
>/dev
/null
2>&1
555 # Save the color control sequences now rather than run tput
556 # each time say_color() is called. This is done for two
558 # * TERM will be changed to dumb
559 # * HOME will be changed to a temporary directory and tput
560 # might need to read ~/.terminfo from the original HOME
561 # directory to get the control sequences
562 # Note: This approach assumes the control sequences don't end
563 # in a newline for any terminal of interest (command
564 # substitutions strip trailing newlines). Given that most
565 # (all?) terminals in common use are related to ECMA-48, this
566 # shouldn't be a problem.
567 say_color_error
=$
(tput bold
; tput setaf
1) # bold red
568 say_color_skip
=$
(tput setaf
4) # blue
569 say_color_warn
=$
(tput setaf
3) # brown/yellow
570 say_color_pass
=$
(tput setaf
2) # green
571 say_color_info
=$
(tput setaf
6) # cyan
572 say_color_reset
=$
(tput sgr0
)
573 say_color_
="" # no formatting for normal text
575 test -z "$1" && test -n "$quiet" && return
576 eval "say_color_color=\$say_color_$1"
578 printf "%s\\n" "$say_color_color$*$say_color_reset"
582 test -z "$1" && test -n "$quiet" && return
592 say_color error
"error: $*"
599 error
>&7 "bug in the test script: $*"
606 if test -n "$HARNESS_ACTIVE"
608 if test "$verbose" = t ||
test -n "$verbose_only"
610 printf 'Bail out! %s\n' \
611 'verbose mode forbidden under TAP harness; try --verbose-log'
616 test "${test_description}" != "" ||
617 error
"Test script did not set test_description."
619 if test "$help" = "t"
621 printf '%s\n' "$test_description"
628 if test "$verbose_log" = "t"
630 exec 3>>"$GIT_TEST_TEE_OUTPUT_FILE" 4>&3
631 elif test "$verbose" = "t"
635 exec 4>/dev
/null
3>/dev
/null
638 # Send any "-x" output directly to stderr to avoid polluting tests
639 # which capture stderr. We can do this unconditionally since it
640 # has no effect if tracing isn't turned on.
642 # Note that this sets up the trace fd as soon as we assign the variable, so it
643 # must come after the creation of descriptor 4 above. Likewise, we must never
644 # unset this, as it has the side effect of closing descriptor 4, which we
645 # use to show verbose tests to the user.
647 # Note also that we don't need or want to export it. The tracing is local to
648 # this shell, and we would not want to influence any shells we exec.
657 test_external_has_tap
=0
661 # This is responsible for running the atexit commands even when a
662 # test script run with '--immediate' fails, or when the user hits
663 # ctrl-C, i.e. when 'test_done' is not invoked at all.
664 test_atexit_handler || code
=$?
665 if test -n "$GIT_EXIT_OK"
669 echo >&5 "FATAL: Unexpected exit with code $code"
676 # Disable '-x' tracing, because with some shells, notably dash, it
677 # prevents running the cleanup commands when a test script run with
678 # '--verbose-log -x' is interrupted.
679 trap '{ code=$?; set +x; } 2>/dev/null; exit $code' INT TERM HUP
681 # The user-facing functions are loaded from a separate file so that
682 # test_perf subshells can have them too
683 .
"$TEST_DIRECTORY/test-lib-functions.sh"
685 # You are not expected to call test_ok_ and test_failure_ directly, use
686 # the test_expect_* functions instead.
689 if test -n "$write_junit_xml"
691 write_junit_xml_testcase
"$*"
693 test_success
=$
(($test_success + 1))
694 say_color
"" "ok $test_count - $@"
698 if test -n "$write_junit_xml"
700 junit_insert
="<failure message=\"not ok $test_count -"
701 junit_insert
="$junit_insert $(xml_attr_encode "$1")\">"
702 junit_insert
="$junit_insert $(xml_attr_encode \
703 "$
(if test -n "$GIT_TEST_TEE_OUTPUT_FILE"
705 test-tool path-utils skip-n-bytes \
706 "$GIT_TEST_TEE_OUTPUT_FILE" $GIT_TEST_TEE_OFFSET
708 printf '%s\n' "$@" |
sed 1d
710 junit_insert
="$junit_insert</failure>"
711 if test -n "$GIT_TEST_TEE_OUTPUT_FILE"
713 junit_insert
="$junit_insert<system-err>$(xml_attr_encode \
714 "$
(cat "$GIT_TEST_TEE_OUTPUT_FILE")")</system-err>"
716 write_junit_xml_testcase
"$1" " $junit_insert"
718 test_failure
=$
(($test_failure + 1))
719 say_color error
"not ok $test_count - $1"
721 printf '%s\n' "$*" |
sed -e 's/^/# /'
722 test "$immediate" = "" ||
{ finalize_junit_xml
; GIT_EXIT_OK
=t
; exit 1; }
725 test_known_broken_ok_
() {
726 if test -n "$write_junit_xml"
728 write_junit_xml_testcase
"$* (breakage fixed)"
730 test_fixed
=$
(($test_fixed+1))
731 say_color error
"ok $test_count - $@ # TODO known breakage vanished"
734 test_known_broken_failure_
() {
735 if test -n "$write_junit_xml"
737 write_junit_xml_testcase
"$* (known breakage)"
739 test_broken
=$
(($test_broken+1))
740 say_color warn
"not ok $test_count - $@ # TODO known breakage"
744 test "$debug" = "" ||
eval "$1"
747 match_pattern_list
() {
750 test -z "$*" && return 1
751 # We need to use "$*" to get field-splitting, but we want to
752 # disable globbing, since we are matching against an arbitrary
753 # $arg, not what's in the filesystem. Using "set -f" accomplishes
754 # that, but we must do it in a subshell to avoid impacting the
755 # rest of the script. The exit value of the subshell becomes
756 # the function's return value.
771 match_test_selector_list
() {
778 test -z "$1" && return 0
780 # Commas are accepted as separators.
786 # If the first selector is negative we include by default.
794 orig_selector
=$selector
800 selector
=${selector##?}
804 test -z "$selector" && continue
808 if expr "z${selector%%-*}" : "z[0-9]*[^0-9]" >/dev
/null
810 echo "error: $operation: invalid non-numeric in range" \
811 "start: '$orig_selector'" >&2
814 if expr "z${selector#*-}" : "z[0-9]*[^0-9]" >/dev
/null
816 echo "error: $operation: invalid non-numeric in range" \
817 "end: '$orig_selector'" >&2
822 if expr "z$selector" : "z[0-9]*[^0-9]" >/dev
/null
824 case "$title" in *${selector}*)
832 # Short cut for "obvious" cases
833 test -z "$include" && test -z "$positive" && continue
834 test -n "$include" && test -n "$positive" && continue
838 if test $arg -le ${selector#-}
844 if test $arg -ge ${selector%-}
850 if test ${selector%%-*} -le $arg \
851 && test $arg -le ${selector#*-}
857 if test $arg -eq $selector
868 maybe_teardown_verbose
() {
869 test -z "$verbose_only" && return
870 exec 4>/dev
/null
3>/dev
/null
875 maybe_setup_verbose
() {
876 test -z "$verbose_only" && return
877 if match_pattern_list
$test_count "$verbose_only"
880 # Emit a delimiting blank line when going from
881 # non-verbose to verbose. Within verbose mode the
882 # delimiter is printed by test_expect_*. The choice
883 # of the initial $last_verbose is such that before
884 # test 1, we do not print it.
885 test -z "$last_verbose" && echo >&3 ""
888 exec 4>/dev
/null
3>/dev
/null
891 last_verbose
=$verbose
894 maybe_teardown_valgrind
() {
895 test -z "$GIT_VALGRIND" && return
896 GIT_VALGRIND_ENABLED
=
899 maybe_setup_valgrind
() {
900 test -z "$GIT_VALGRIND" && return
901 if test -z "$valgrind_only"
903 GIT_VALGRIND_ENABLED
=t
906 GIT_VALGRIND_ENABLED
=
907 if match_pattern_list
$test_count "$valgrind_only"
909 GIT_VALGRIND_ENABLED
=t
915 test "$trace" = t
&& {
916 test "$verbose" = t ||
test "$verbose_log" = t
920 # This is a separate function because some tests use
921 # "return" to end a test_expect_success block early
922 # (and we want to make sure we run any cleanup like
924 test_eval_inner_
() {
925 # Do not add anything extra (including LF) after '$*'
927 want_trace && trace_level_=$(($trace_level_+1)) && set -x
932 # If "-x" tracing is in effect, then we want to avoid polluting stderr
933 # with non-test commands. But once in "set -x" mode, we cannot prevent
934 # the shell from printing the "set +x" to turn it off (nor the saving
935 # of $? before that). But we can make sure that the output goes to
938 # There are a few subtleties here:
940 # - we have to redirect descriptor 4 in addition to 2, to cover
943 # - the actual eval has to come before the redirection block (since
944 # it needs to see descriptor 4 to set up its stderr)
946 # - likewise, any error message we print must be outside the block to
947 # access descriptor 4
949 # - checking $? has to come immediately after the eval, but it must
950 # be _inside_ the block to avoid polluting the "set -x" output
953 test_eval_inner_
"$@" </dev
/null
>&3 2>&4
958 test 1 = $trace_level_ && set +x
959 trace_level_
=$
(($trace_level_-1))
963 if test "$test_eval_ret_" != 0 && want_trace
965 say_color error
>&4 "error: last command exited with \$?=$test_eval_ret_"
967 return $test_eval_ret_
974 if test "${GIT_TEST_CHAIN_LINT:-1}" != 0; then
975 # turn off tracing for this test-eval, as it simply creates
976 # confusing noise in the "-x" output
979 # 117 is magic because it is unlikely to match the exit
980 # code of other programs
981 if test "OK-117" != "$(test_eval_ "(exit 117) && $1${LF}${LF}echo OK-\$?
" 3>&1)" ||
983 test "${GIT_TEST_CHAIN_LINT_HARDER:-${GIT_TEST_CHAIN_LINT_HARDER_DEFAULT:-1}}" != 0 &&
984 $
(printf '%s\n' "$1" |
sed -f "$GIT_BUILD_DIR/t/chainlint.sed" |
grep -q '?![A-Z][A-Z]*?!')
987 BUG
"broken &&-chain or run-away HERE-DOC: $1"
995 teardown_malloc_check
997 if test -z "$immediate" ||
test $eval_ret = 0 ||
998 test -n "$expecting_failure" && test "$test_cleanup" != ":"
1001 test_eval_
"$test_cleanup"
1002 teardown_malloc_check
1004 if test "$verbose" = "t" && test -n "$HARNESS_ACTIVE"
1012 test_count
=$
(($test_count+1))
1014 maybe_setup_valgrind
1015 if test -n "$write_junit_xml"
1017 junit_start
=$
(test-tool
date getnanos
)
1023 maybe_teardown_valgrind
1024 maybe_teardown_verbose
1025 if test -n "$GIT_TEST_TEE_OFFSET"
1027 GIT_TEST_TEE_OFFSET
=$
(test-tool path-utils file-size \
1028 "$GIT_TEST_TEE_OUTPUT_FILE")
1035 if match_pattern_list
$this_test.
$test_count "$GIT_SKIP_TESTS"
1038 skipped_reason
="GIT_SKIP_TESTS"
1040 if test -z "$to_skip" && test -n "$run_list" &&
1041 ! match_test_selector_list
'--run' "$1" $test_count "$run_list"
1044 skipped_reason
="--run"
1046 if test -z "$to_skip" && test -n "$test_prereq" &&
1047 ! test_have_prereq
"$test_prereq"
1052 if test "$missing_prereq" != "$test_prereq"
1054 of_prereq
=" of $test_prereq"
1056 skipped_reason
="missing $missing_prereq${of_prereq}"
1061 if test -n "$write_junit_xml"
1063 message
="$(xml_attr_encode "$skipped_reason")"
1064 write_junit_xml_testcase
"$1" \
1065 " <skipped message=\"$message\" />"
1068 say_color skip
"ok $test_count # skip $1 ($skipped_reason)"
1077 # stub; perf-lib overrides it
1078 test_at_end_hook_
() {
1082 write_junit_xml
() {
1086 junit_have_testcase
=
1090 printf '%s\n' "$@" >>"$junit_xml_path"
1093 xml_attr_encode
() {
1094 printf '%s\n' "$@" | test-tool xml-encode
1097 write_junit_xml_testcase
() {
1098 junit_attrs
="name=\"$(xml_attr_encode "$this_test.
$test_count $1")\""
1100 junit_attrs
="$junit_attrs classname=\"$this_test\""
1101 junit_attrs
="$junit_attrs time=\"$(test-tool \
1102 date getnanos $junit_start)\""
1103 write_junit_xml
"$(printf '%s\n' \
1104 " <testcase
$junit_attrs>" "$@
" " </testcase
>")"
1105 junit_have_testcase
=t
1108 finalize_junit_xml
() {
1109 if test -n "$write_junit_xml" && test -n "$junit_xml_path"
1111 test -n "$junit_have_testcase" ||
{
1112 junit_start
=$
(test-tool
date getnanos
)
1113 write_junit_xml_testcase
"all tests skipped"
1116 # adjust the overall time
1117 junit_time
=$
(test-tool
date getnanos
$junit_suite_start)
1118 sed -e "s/\(<testsuite.*\) time=\"[^\"]*\"/\1/" \
1119 -e "s/<testsuite [^>]*/& time=\"$junit_time\"/" \
1120 -e '/^ *<\/testsuite/d' \
1121 <"$junit_xml_path" >"$junit_xml_path.new"
1122 mv "$junit_xml_path.new" "$junit_xml_path"
1124 write_junit_xml
" </testsuite>" "</testsuites>"
1129 test_atexit_cleanup
=:
1130 test_atexit_handler
() {
1131 # In a succeeding test script 'test_atexit_handler' is invoked
1132 # twice: first from 'test_done', then from 'die' in the trap on
1134 # This condition and resetting 'test_atexit_cleanup' below makes
1135 # sure that the registered cleanup commands are run only once.
1136 test : != "$test_atexit_cleanup" ||
return 0
1139 test_eval_
"$test_atexit_cleanup"
1140 test_atexit_cleanup
=:
1141 teardown_malloc_check
1147 # Run the atexit commands _before_ the trash directory is
1148 # removed, so the commands can access pidfiles and socket files.
1153 if test -z "$HARNESS_ACTIVE"
1155 mkdir
-p "$TEST_RESULTS_DIR"
1157 cat >"$TEST_RESULTS_BASE.counts" <<-EOF
1159 success $test_success
1162 failed $test_failure
1167 if test "$test_fixed" != 0
1169 say_color error
"# $test_fixed known breakage(s) vanished; please update test(s)"
1171 if test "$test_broken" != 0
1173 say_color warn
"# still have $test_broken known breakage(s)"
1175 if test "$test_broken" != 0 ||
test "$test_fixed" != 0
1177 test_remaining
=$
(( $test_count - $test_broken - $test_fixed ))
1178 msg
="remaining $test_remaining test(s)"
1180 test_remaining
=$test_count
1181 msg
="$test_count test(s)"
1183 case "$test_failure" in
1185 if test $test_external_has_tap -eq 0
1187 if test $test_remaining -gt 0
1189 say_color pass
"# passed all $msg"
1192 # Maybe print SKIP message
1193 test -z "$skip_all" || skip_all
="# SKIP $skip_all"
1194 case "$test_count" in
1196 say
"1..$test_count${skip_all:+ $skip_all}"
1199 test -z "$skip_all" ||
1200 say_color warn
"$skip_all"
1201 say
"1..$test_count"
1206 if test -z "$debug" && test -n "$remove_trash"
1208 test -d "$TRASH_DIRECTORY" ||
1209 error
"Tests passed but trash directory already removed before test cleanup; aborting"
1211 cd "$TRASH_DIRECTORY/.." &&
1212 rm -fr "$TRASH_DIRECTORY" ||
{
1213 # try again in a bit
1215 rm -fr "$TRASH_DIRECTORY"
1217 error
"Tests passed but test cleanup failed; aborting"
1224 if test $test_external_has_tap -eq 0
1226 say_color error
"# failed $test_failure among $msg"
1227 say
"1..$test_count"
1235 if test -n "$valgrind"
1239 test "$1" = "$(readlink "$2")" ||
{
1247 while test -d "$2".lock
1249 say
"Waiting for lock on $2."
1256 make_valgrind_symlink
() {
1257 # handle only executables, unless they are shell libraries that
1258 # need to be in the exec-path.
1260 test "# " = "$(test_copy_bytes 2 <"$1")" ||
1263 base
=$
(basename "$1")
1266 symlink_target
="$GIT_BUILD_DIR/t/helper/$base"
1269 symlink_target
="$GIT_BUILD_DIR/$base"
1272 # do not override scripts
1273 if test -x "$symlink_target" &&
1274 test ! -d "$symlink_target" &&
1275 test "#!" != "$(test_copy_bytes 2 <"$symlink_target")"
1277 symlink_target
=..
/valgrind.sh
1281 symlink_target
=..
/unprocessed-script
1283 # create the link, or replace it if it is out of date
1284 make_symlink
"$symlink_target" "$GIT_VALGRIND/bin/$base" ||
exit
1287 # override all git executables in TEST_DIRECTORY/..
1288 GIT_VALGRIND
=$TEST_DIRECTORY/valgrind
1289 mkdir
-p "$GIT_VALGRIND"/bin
1290 for file in $GIT_BUILD_DIR/git
* $GIT_BUILD_DIR/t
/helper
/test-
*
1292 make_valgrind_symlink
$file
1294 # special-case the mergetools loadables
1295 make_symlink
"$GIT_BUILD_DIR"/mergetools
"$GIT_VALGRIND/bin/mergetools"
1300 ls "$path"/git-
* 2> /dev
/null |
1303 make_valgrind_symlink
"$file"
1307 PATH
=$GIT_VALGRIND/bin
:$PATH
1308 GIT_EXEC_PATH
=$GIT_VALGRIND/bin
1310 GIT_VALGRIND_MODE
="$valgrind"
1311 export GIT_VALGRIND_MODE
1312 GIT_VALGRIND_ENABLED
=t
1313 test -n "$valgrind_only" && GIT_VALGRIND_ENABLED
=
1314 export GIT_VALGRIND_ENABLED
1315 elif test -n "$GIT_TEST_INSTALLED"
1317 GIT_EXEC_PATH
=$
($GIT_TEST_INSTALLED/git
--exec-path) ||
1318 error
"Cannot run git from $GIT_TEST_INSTALLED."
1319 PATH
=$GIT_TEST_INSTALLED:$GIT_BUILD_DIR/t
/helper
:$PATH
1320 GIT_EXEC_PATH
=${GIT_TEST_EXEC_PATH:-$GIT_EXEC_PATH}
1321 else # normal case, use ../bin-wrappers only unless $with_dashes:
1322 if test -n "$no_bin_wrappers"
1326 git_bin_dir
="$GIT_BUILD_DIR/bin-wrappers"
1327 if ! test -x "$git_bin_dir/git"
1329 if test -z "$with_dashes"
1331 say
"$git_bin_dir/git is not executable; using GIT_EXEC_PATH"
1335 PATH
="$git_bin_dir:$PATH"
1337 GIT_EXEC_PATH
=$GIT_BUILD_DIR
1338 if test -n "$with_dashes"
1340 PATH
="$GIT_BUILD_DIR:$GIT_BUILD_DIR/t/helper:$PATH"
1343 GIT_TEMPLATE_DIR
="$GIT_BUILD_DIR"/templates
/blt
1344 GIT_CONFIG_NOSYSTEM
=1
1346 GIT_CEILING_DIRECTORIES
="$TRASH_DIRECTORY/.."
1347 export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG_NOSYSTEM GIT_ATTR_NOSYSTEM GIT_CEILING_DIRECTORIES
1349 if test -z "$GIT_TEST_CMP"
1351 if test -n "$GIT_TEST_CMP_USE_COPIED_CONTEXT"
1353 GIT_TEST_CMP
="$DIFF -c"
1355 GIT_TEST_CMP
="$DIFF -u"
1359 GITPERLLIB
="$GIT_BUILD_DIR"/perl
/build
/lib
1361 test -d "$GIT_BUILD_DIR"/templates
/blt ||
{
1362 error
"You haven't built things yet, have you?"
1365 if ! test -x "$GIT_BUILD_DIR"/t
/helper
/test-tool
$X
1367 echo >&2 'You need to build test-tool:'
1368 echo >&2 'Run "make t/helper/test-tool" in the source (toplevel) directory'
1372 # Are we running this test at all?
1375 this_test
=${this_test%%-*}
1376 if match_pattern_list
"$this_test" "$GIT_SKIP_TESTS"
1378 say_color info
>&3 "skipping test $this_test altogether"
1379 skip_all
="skip all tests in $this_test"
1383 # Last-minute variable setup
1384 HOME
="$TRASH_DIRECTORY"
1385 GNUPGHOME
="$HOME/gnupg-home-not-used"
1386 export HOME GNUPGHOME
1389 rm -fr "$TRASH_DIRECTORY" ||
{
1391 echo >&5 "FATAL: Cannot prepare test area"
1396 if test -z "$TEST_NO_CREATE_REPO"
1398 git init
"$TRASH_DIRECTORY" >&3 2>&4 ||
1399 error
"cannot run git init"
1401 mkdir
-p "$TRASH_DIRECTORY"
1404 # Use -P to resolve symlinks in our working directory so that the cwd
1405 # in subprocesses like git equals our $PWD (for pathname comparisons).
1406 cd -P "$TRASH_DIRECTORY" ||
exit 1
1408 if test -n "$write_junit_xml"
1410 junit_xml_dir
="$TEST_OUTPUT_DIRECTORY/out"
1411 mkdir
-p "$junit_xml_dir"
1412 junit_xml_base
=${0##*/}
1413 junit_xml_path
="$junit_xml_dir/TEST-${junit_xml_base%.sh}.xml"
1414 junit_attrs
="name=\"${junit_xml_base%.sh}\""
1415 junit_attrs
="$junit_attrs timestamp=\"$(TZ=UTC \
1416 date +%Y-%m-%dT%H:%M:%S)\""
1417 write_junit_xml
--truncate "<testsuites>" " <testsuite $junit_attrs>"
1418 junit_suite_start
=$
(test-tool
date getnanos
)
1419 if test -n "$GIT_TEST_TEE_OUTPUT_FILE"
1421 GIT_TEST_TEE_OFFSET
=0
1426 # A regexp to match 5, 35 and 40 hexdigits
1427 _x05
='[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
1428 _x35
="$_x05$_x05$_x05$_x05$_x05$_x05$_x05"
1433 ZERO_OID
=$
(test_oid zero
)
1434 OID_REGEX
=$
(echo $ZERO_OID |
sed -e 's/0/[0-9a-f]/g')
1435 OIDPATH_REGEX
=$
(test_oid_to_path
$ZERO_OID |
sed -e 's/0/[0-9a-f]/g')
1436 EMPTY_TREE
=$
(test_oid empty_tree
)
1437 EMPTY_BLOB
=$
(test_oid empty_blob
)
1440 # Provide an implementation of the 'yes' utility; the upper bound
1441 # limit is there to help Windows that cannot stop this loop from
1442 # wasting cycles when the downstream stops reading, so do not be
1443 # tempted to turn it into an infinite loop. cf. 6129c930 ("test-lib:
1444 # limit the output of the yes utility", 2016-02-02)
1454 while test $i -lt 99
1461 # The GIT_TEST_FAIL_PREREQS code hooks into test_set_prereq(), and
1462 # thus needs to be set up really early, and set an internal variable
1463 # for convenience so the hot test_set_prereq() codepath doesn't need
1464 # to call "git env--helper" (via test_bool_env). Only do that work
1465 # if needed by seeing if GIT_TEST_FAIL_PREREQS is set at all.
1466 GIT_TEST_FAIL_PREREQS_INTERNAL
=
1467 if test -n "$GIT_TEST_FAIL_PREREQS"
1469 if test_bool_env GIT_TEST_FAIL_PREREQS false
1471 GIT_TEST_FAIL_PREREQS_INTERNAL
=true
1472 test_set_prereq FAIL_PREREQS
1475 test_lazy_prereq FAIL_PREREQS
'
1476 test_bool_env GIT_TEST_FAIL_PREREQS false
1480 # Fix some commands on Windows, and other OS-specific things
1484 # Windows has its own (incompatible) sort and find
1491 # git sees Windows-style pwd
1495 # no POSIX permissions
1496 # backslashes in pathspec are converted to '/'
1497 # exec does not inherit the PID
1498 test_set_prereq MINGW
1499 test_set_prereq NATIVE_CRLF
1500 test_set_prereq SED_STRIPS_CR
1501 test_set_prereq GREP_STRIPS_CR
1502 test_set_prereq WINDOWS
1503 GIT_TEST_CMP
=mingw_test_cmp
1506 test_set_prereq POSIXPERM
1507 test_set_prereq EXECKEEPSPID
1508 test_set_prereq CYGWIN
1509 test_set_prereq SED_STRIPS_CR
1510 test_set_prereq GREP_STRIPS_CR
1511 test_set_prereq WINDOWS
1514 test_set_prereq POSIXPERM
1515 test_set_prereq BSLASHPSPEC
1516 test_set_prereq EXECKEEPSPID
1520 # Detect arches where a few things don't work
1524 test_set_prereq HPPA
1528 test_set_prereq REFFILES
1530 ( COLUMNS
=1 && test $COLUMNS = 1 ) && test_set_prereq COLUMNS_CAN_BE_1
1531 test -z "$NO_PERL" && test_set_prereq PERL
1532 test -z "$NO_PTHREADS" && test_set_prereq PTHREADS
1533 test -z "$NO_PYTHON" && test_set_prereq PYTHON
1534 test -n "$USE_LIBPCRE2" && test_set_prereq PCRE
1535 test -n "$USE_LIBPCRE2" && test_set_prereq LIBPCRE2
1536 test -z "$NO_GETTEXT" && test_set_prereq GETTEXT
1538 if test -z "$GIT_TEST_CHECK_CACHE_TREE"
1540 GIT_TEST_CHECK_CACHE_TREE
=true
1541 export GIT_TEST_CHECK_CACHE_TREE
1544 test_lazy_prereq PIPE
'
1545 # test whether the filesystem supports FIFOs
1546 test_have_prereq !MINGW,!CYGWIN &&
1547 rm -f testfifo && mkfifo testfifo
1550 test_lazy_prereq SYMLINKS
'
1551 # test whether the filesystem supports symbolic links
1552 ln -s x y && test -h y
1555 test_lazy_prereq SYMLINKS_WINDOWS
'
1556 # test whether symbolic links are enabled on Windows
1557 test_have_prereq MINGW &&
1558 cmd //c "mklink y x" &> /dev/null && test -h y
1561 test_lazy_prereq FILEMODE
'
1562 test "$(git config --bool core.filemode)" = true
1565 test_lazy_prereq CASE_INSENSITIVE_FS
'
1566 echo good >CamelCase &&
1567 echo bad >camelcase &&
1568 test "$(cat CamelCase)" != good
1571 test_lazy_prereq FUNNYNAMES
'
1572 test_have_prereq !MINGW &&
1574 "FUNNYNAMES tab embedded" \
1575 "FUNNYNAMES \"quote embedded\"" \
1577 embedded" 2>/dev/null &&
1579 "FUNNYNAMES tab embedded" \
1580 "FUNNYNAMES \"quote embedded\"" \
1582 embedded" 2>/dev/null
1585 test_lazy_prereq UTF8_NFD_TO_NFC
'
1586 # check whether FS converts nfd unicode to nfc
1587 auml=$(printf "\303\244")
1588 aumlcdiar=$(printf "\141\314\210")
1590 test -f "$aumlcdiar"
1593 test_lazy_prereq AUTOIDENT
'
1594 sane_unset GIT_AUTHOR_NAME &&
1595 sane_unset GIT_AUTHOR_EMAIL &&
1596 git var GIT_AUTHOR_IDENT
1599 test_lazy_prereq EXPENSIVE
'
1600 test -n "$GIT_TEST_LONG"
1603 test_lazy_prereq EXPENSIVE_ON_WINDOWS
'
1604 test_have_prereq EXPENSIVE || test_have_prereq !MINGW,!CYGWIN
1607 test_lazy_prereq USR_BIN_TIME
'
1608 test -x /usr/bin/time
1611 test_lazy_prereq NOT_ROOT
'
1616 test_lazy_prereq JGIT
'
1620 # SANITY is about "can you correctly predict what the filesystem would
1621 # do by only looking at the permission bits of the files and
1622 # directories?" A typical example of !SANITY is running the test
1623 # suite as root, where a test may expect "chmod -r file && cat file"
1624 # to fail because file is supposed to be unreadable after a successful
1625 # chmod. In an environment (i.e. combination of what filesystem is
1626 # being used and who is running the tests) that lacks SANITY, you may
1627 # be able to delete or create a file when the containing directory
1628 # doesn't have write permissions, or access a file even if the
1629 # containing directory doesn't have read or execute permissions.
1631 test_lazy_prereq SANITY
'
1632 mkdir SANETESTD.1 SANETESTD.2 &&
1634 chmod +w SANETESTD.1 SANETESTD.2 &&
1635 >SANETESTD.1/x 2>SANETESTD.2/x &&
1636 chmod -w SANETESTD.1 &&
1637 chmod -r SANETESTD.1/x &&
1638 chmod -rx SANETESTD.2 ||
1639 BUG "cannot prepare SANETESTD"
1641 ! test -r SANETESTD.1/x &&
1642 ! rm SANETESTD.1/x && ! test -f SANETESTD.2/x
1645 chmod +rwx SANETESTD.1 SANETESTD.2 &&
1646 rm -rf SANETESTD.1 SANETESTD.2 ||
1647 BUG "cannot clean SANETESTD"
1651 test FreeBSD
!= $uname_s || GIT_UNZIP
=${GIT_UNZIP:-/usr/local/bin/unzip}
1652 GIT_UNZIP
=${GIT_UNZIP:-unzip}
1653 test_lazy_prereq UNZIP
'
1658 run_with_limited_cmdline
() {
1659 (ulimit -s 128 && "$@")
1662 test_lazy_prereq CMDLINE_LIMIT
'
1663 test_have_prereq !HPPA,!MINGW,!CYGWIN &&
1664 run_with_limited_cmdline true
1667 run_with_limited_stack
() {
1668 (ulimit -s 128 && "$@")
1671 test_lazy_prereq ULIMIT_STACK_SIZE
'
1672 test_have_prereq !HPPA,!MINGW,!CYGWIN &&
1673 run_with_limited_stack true
1676 run_with_limited_open_files
() {
1677 (ulimit -n 32 && "$@")
1680 test_lazy_prereq ULIMIT_FILE_DESCRIPTORS
'
1681 test_have_prereq !MINGW,!CYGWIN &&
1682 run_with_limited_open_files true
1686 git version
--build-options |
1687 sed -ne "s/^$1: //p"
1690 test_lazy_prereq LONG_IS_64BIT
'
1691 test 8 -le "$(build_option sizeof-long)"
1694 test_lazy_prereq TIME_IS_64BIT
'test-tool date is64bit'
1695 test_lazy_prereq TIME_T_IS_64BIT
'test-tool date time_t-is64bit'
1697 test_lazy_prereq CURL
'
1701 # SHA1 is a test if the hash algorithm in use is SHA-1. This is both for tests
1702 # which will not work with other hash algorithms and tests that work but don't
1703 # test anything meaningful (e.g. special values which cause short collisions).
1704 test_lazy_prereq SHA1
'
1705 case "$GIT_DEFAULT_HASH" in
1707 "") test $(git hash-object /dev/null) = e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 ;;
1712 test_lazy_prereq REBASE_P
'
1713 test -z "$GIT_TEST_SKIP_REBASE_P"
1716 # Ensure that no test accidentally triggers a Git command
1717 # that runs the actual maintenance scheduler, affecting a user's
1718 # system permanently.
1719 # Tests that verify the scheduler integration must set this locally
1721 GIT_TEST_MAINT_SCHEDULER
="none:exit 1"