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 # Keep the original TERM for say_color
21 # Test the binaries we have just built. The tests are kept in
22 # t/ subdirectory and are run in 'trash directory' subdirectory.
23 if test -z "$TEST_DIRECTORY"
25 # We allow tests to override this, in case they want to run tests
26 # outside of t/, e.g. for running tests on the test library
30 # ensure that TEST_DIRECTORY is an absolute path so that it
31 # is valid even if the current working directory is changed
32 TEST_DIRECTORY
=$
(cd "$TEST_DIRECTORY" && pwd) ||
exit 1
34 if test -z "$TEST_OUTPUT_DIRECTORY"
36 # Similarly, override this to store the test-results subdir
38 TEST_OUTPUT_DIRECTORY
=$TEST_DIRECTORY
40 GIT_BUILD_DIR
="$TEST_DIRECTORY"/..
42 ################################################################
43 # It appears that people try to run tests without building...
44 "$GIT_BUILD_DIR/git" >/dev
/null
47 echo >&2 'error: you do not seem to have built git yet.'
51 .
"$GIT_BUILD_DIR"/GIT-BUILD-OPTIONS
52 export PERL_PATH SHELL_PATH
54 # if --tee was passed, write the output not only to the terminal, but
55 # additionally to the file test-results/$BASENAME.out, too.
56 case "$GIT_TEST_TEE_STARTED, $* " in
58 # do not redirect again
60 *' --tee '*|
*' --va'*)
61 mkdir
-p "$TEST_OUTPUT_DIRECTORY/test-results"
62 BASE
="$TEST_OUTPUT_DIRECTORY/test-results/$(basename "$0" .sh)"
63 (GIT_TEST_TEE_STARTED
=done ${SHELL_PATH} "$0" "$@" 2>&1;
64 echo $?
> $BASE.
exit) |
tee $BASE.out
65 test "$(cat $BASE.exit)" = 0
70 # For repeatability, reset the environment to known value.
76 export LANG LC_ALL PAGER TERM TZ
78 # A call to "unset" with no arguments causes at least Solaris 10
79 # /usr/xpg4/bin/sh and /bin/ksh to bail out. So keep the unsets
80 # deriving from the command substitution clustered with the other
82 unset VISUAL EMAIL LANGUAGE COLUMNS $
("$PERL_PATH" -e '
84 my $ok = join("|", qw(
96 my @vars = grep(/^GIT_/ && !/^GIT_($ok)/o, @env);
97 print join("\n", @vars);
101 GIT_AUTHOR_EMAIL
=author@example.com
102 GIT_AUTHOR_NAME
='A U Thor'
103 GIT_COMMITTER_EMAIL
=committer@example.com
104 GIT_COMMITTER_NAME
='C O Mitter'
105 GIT_MERGE_VERBOSITY
=5
106 GIT_MERGE_AUTOEDIT
=no
107 export GIT_MERGE_VERBOSITY GIT_MERGE_AUTOEDIT
108 export GIT_AUTHOR_EMAIL GIT_AUTHOR_NAME
109 export GIT_COMMITTER_EMAIL GIT_COMMITTER_NAME
112 # Tests using GIT_TRACE typically don't want <timestamp> <file>:<line> output
114 export GIT_TRACE_BARE
116 if test -n "${TEST_GIT_INDEX_VERSION:+isset}"
118 GIT_INDEX_VERSION
="$TEST_GIT_INDEX_VERSION"
119 export GIT_INDEX_VERSION
122 # Add libc MALLOC and MALLOC_PERTURB test
123 # only if we are not executing the test with valgrind
124 if expr " $GIT_TEST_OPTS " : ".* --valgrind " >/dev
/null ||
125 test -n "$TEST_NO_MALLOC_CHECK"
127 setup_malloc_check
() {
130 teardown_malloc_check
() {
134 setup_malloc_check
() {
135 MALLOC_CHECK_
=3 MALLOC_PERTURB_
=165
136 export MALLOC_CHECK_ MALLOC_PERTURB_
138 teardown_malloc_check
() {
139 unset MALLOC_CHECK_ MALLOC_PERTURB_
143 : ${ASAN_OPTIONS=detect_leaks=0}
146 # Protect ourselves from common misconfiguration to export
147 # CDPATH into the environment
153 case $
(echo $GIT_TRACE |
tr "[A-Z]" "[a-z]") in
155 echo "* warning: Some tests will not work if GIT_TRACE" \
156 "is set as to trace on STDERR ! *"
157 echo "* warning: Please set GIT_TRACE to something" \
158 "other than 1, 2 or true ! *"
164 # A regexp to match 5 and 40 hexdigits
165 _x05
='[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
166 _x40
="$_x05$_x05$_x05$_x05$_x05$_x05$_x05$_x05"
169 _z40
=0000000000000000000000000000000000000000
175 export _x05 _x40 _z40 LF
177 # Each test should start with something like this, after copyright notices:
179 # test_description='Description of this test...
180 # This test checks if command xyzzy does the right thing...
183 [ "x$ORIGINAL_TERM" != "xdumb" ] && (
184 TERM
=$ORIGINAL_TERM &&
187 tput bold
>/dev
/null
2>&1 &&
188 tput setaf
1 >/dev
/null
2>&1 &&
189 tput sgr0
>/dev
/null
2>&1
193 while test "$#" -ne 0
196 -d|
--d|
--de|
--deb|
--debu|
--debug)
198 -i|
--i|
--im|
--imm|
--imme|
--immed|
--immedi|
--immedia|
--immediat|
--immediate)
199 immediate
=t
; shift ;;
200 -l|
--l|
--lo|
--lon|
--long|
--long-|
--long-t|
--long-te|
--long-tes|
--long-test|
--long-tests)
201 GIT_TEST_LONG
=t
; export GIT_TEST_LONG
; shift ;;
203 shift; test "$#" -ne 0 ||
{
204 echo 'error: -r requires an argument' >&2;
207 run_list
=$1; shift ;;
209 run_list
=$
(expr "z$1" : 'z[^=]*=\(.*\)'); shift ;;
210 -h|
--h|
--he|
--hel|
--help)
212 -v|
--v|
--ve|
--ver|
--verb|
--verbo|
--verbos|
--verbose)
215 verbose_only
=$
(expr "z$1" : 'z[^=]*=\(.*\)')
217 -q|
--q|
--qu|
--qui|
--quie|
--quiet)
218 # Ignore --quiet under a TAP::Harness. Saying how many tests
219 # passed without the ok/not ok details is always an error.
220 test -z "$HARNESS_ACTIVE" && quiet
=t
; shift ;;
222 with_dashes
=t
; shift ;;
225 --va|
--val|
--valg|
--valgr|
--valgri|
--valgrin|
--valgrind)
229 valgrind
=$
(expr "z$1" : 'z[^=]*=\(.*\)')
232 valgrind_only
=$
(expr "z$1" : 'z[^=]*=\(.*\)')
235 shift ;; # was handled already
237 root
=$
(expr "z$1" : 'z[^=]*=\(.*\)')
244 echo "error: unknown test option '$1'" >&2; exit 1 ;;
248 if test -n "$valgrind_only"
250 test -z "$valgrind" && valgrind
=memcheck
251 test -z "$verbose" && verbose_only
="$valgrind_only"
252 elif test -n "$valgrind"
265 tput bold
; tput setaf
1;; # bold red
267 tput setaf
4;; # blue
269 tput setaf
3;; # brown/yellow
271 tput setaf
2;; # green
273 tput setaf
6;; # cyan
275 test -n "$quiet" && return;;
285 test -z "$1" && test -n "$quiet" && return
292 say_color error
"error: $*"
301 test "${test_description}" != "" ||
302 error
"Test script did not set test_description."
304 if test "$help" = "t"
306 printf '%s\n' "$test_description"
312 if test "$verbose" = "t"
316 exec 4>/dev
/null
3>/dev
/null
325 test_external_has_tap
=0
329 if test -n "$GIT_EXIT_OK"
333 echo >&5 "FATAL: Unexpected exit with code $code"
341 # The user-facing functions are loaded from a separate file so that
342 # test_perf subshells can have them too
343 .
"$TEST_DIRECTORY/test-lib-functions.sh"
345 # You are not expected to call test_ok_ and test_failure_ directly, use
346 # the test_expect_* functions instead.
349 test_success
=$
(($test_success + 1))
350 say_color
"" "ok $test_count - $@"
354 test_failure
=$
(($test_failure + 1))
355 say_color error
"not ok $test_count - $1"
357 printf '%s\n' "$*" |
sed -e 's/^/# /'
358 test "$immediate" = "" ||
{ GIT_EXIT_OK
=t
; exit 1; }
361 test_known_broken_ok_
() {
362 test_fixed
=$
(($test_fixed+1))
363 say_color error
"ok $test_count - $@ # TODO known breakage vanished"
366 test_known_broken_failure_
() {
367 test_broken
=$
(($test_broken+1))
368 say_color warn
"not ok $test_count - $@ # TODO known breakage"
372 test "$debug" = "" ||
eval "$1"
375 match_pattern_list
() {
378 test -z "$*" && return 1
389 match_test_selector_list
() {
394 test -z "$1" && return 0
396 # Both commas and whitespace are accepted as separators.
402 # If the first selector is negative we include by default.
410 orig_selector
=$selector
416 selector
=${selector##?}
420 test -z "$selector" && continue
424 if expr "z${selector%%-*}" : "z[0-9]*[^0-9]" >/dev
/null
426 echo "error: $title: invalid non-numeric in range" \
427 "start: '$orig_selector'" >&2
430 if expr "z${selector#*-}" : "z[0-9]*[^0-9]" >/dev
/null
432 echo "error: $title: invalid non-numeric in range" \
433 "end: '$orig_selector'" >&2
438 if expr "z$selector" : "z[0-9]*[^0-9]" >/dev
/null
440 echo "error: $title: invalid non-numeric in test" \
441 "selector: '$orig_selector'" >&2
446 # Short cut for "obvious" cases
447 test -z "$include" && test -z "$positive" && continue
448 test -n "$include" && test -n "$positive" && continue
452 if test $arg -le ${selector#-}
458 if test $arg -ge ${selector%-}
464 if test ${selector%%-*} -le $arg \
465 && test $arg -le ${selector#*-}
471 if test $arg -eq $selector
482 maybe_teardown_verbose
() {
483 test -z "$verbose_only" && return
484 exec 4>/dev
/null
3>/dev
/null
489 maybe_setup_verbose
() {
490 test -z "$verbose_only" && return
491 if match_pattern_list
$test_count $verbose_only
494 # Emit a delimiting blank line when going from
495 # non-verbose to verbose. Within verbose mode the
496 # delimiter is printed by test_expect_*. The choice
497 # of the initial $last_verbose is such that before
498 # test 1, we do not print it.
499 test -z "$last_verbose" && echo >&3 ""
502 exec 4>/dev
/null
3>/dev
/null
505 last_verbose
=$verbose
508 maybe_teardown_valgrind
() {
509 test -z "$GIT_VALGRIND" && return
510 GIT_VALGRIND_ENABLED
=
513 maybe_setup_valgrind
() {
514 test -z "$GIT_VALGRIND" && return
515 if test -z "$valgrind_only"
517 GIT_VALGRIND_ENABLED
=t
520 GIT_VALGRIND_ENABLED
=
521 if match_pattern_list
$test_count $valgrind_only
523 GIT_VALGRIND_ENABLED
=t
527 # This is a separate function because some tests use
528 # "return" to end a test_expect_success block early
529 # (and we want to make sure we run any cleanup like
531 test_eval_inner_
() {
532 # Do not add anything extra (including LF) after '$*'
534 test \"$trace\" = t && set -x
539 # We run this block with stderr redirected to avoid extra cruft
540 # during a "-x" trace. Once in "set -x" mode, we cannot prevent
541 # the shell from printing the "set +x" to turn it off (nor the saving
542 # of $? before that). But we can make sure that the output goes to
545 # The test itself is run with stderr put back to &4 (so either to
546 # /dev/null, or to the original stderr if --verbose was used).
548 test_eval_inner_
"$@" </dev
/null
>&3 2>&4
553 if test "$test_eval_ret_" != 0
555 say_color error
>&4 "error: last command exited with \$?=$test_eval_ret_"
559 return $test_eval_ret_
568 teardown_malloc_check
570 if test -z "$immediate" ||
test $eval_ret = 0 ||
571 test -n "$expecting_failure" && test "$test_cleanup" != ":"
574 test_eval_
"$test_cleanup"
575 teardown_malloc_check
577 if test "$verbose" = "t" && test -n "$HARNESS_ACTIVE"
585 test_count
=$
(($test_count+1))
592 maybe_teardown_valgrind
593 maybe_teardown_verbose
599 if match_pattern_list
$this_test.
$test_count $GIT_SKIP_TESTS
602 skipped_reason
="GIT_SKIP_TESTS"
604 if test -z "$to_skip" && test -n "$test_prereq" &&
605 ! test_have_prereq
"$test_prereq"
610 if test "$missing_prereq" != "$test_prereq"
612 of_prereq
=" of $test_prereq"
614 skipped_reason
="missing $missing_prereq${of_prereq}"
616 if test -z "$to_skip" && test -n "$run_list" &&
617 ! match_test_selector_list
'--run' $test_count "$run_list"
620 skipped_reason
="--run"
625 say_color skip
>&3 "skipping test: $@"
626 say_color skip
"ok $test_count # skip $1 ($skipped_reason)"
635 # stub; perf-lib overrides it
636 test_at_end_hook_
() {
643 if test -z "$HARNESS_ACTIVE"
645 test_results_dir
="$TEST_OUTPUT_DIRECTORY/test-results"
646 mkdir
-p "$test_results_dir"
648 test_results_path
="$test_results_dir/${base%.sh}-$$.counts"
650 cat >>"$test_results_path" <<-EOF
652 success $test_success
660 if test "$test_fixed" != 0
662 say_color error
"# $test_fixed known breakage(s) vanished; please update test(s)"
664 if test "$test_broken" != 0
666 say_color warn
"# still have $test_broken known breakage(s)"
668 if test "$test_broken" != 0 ||
test "$test_fixed" != 0
670 test_remaining
=$
(( $test_count - $test_broken - $test_fixed ))
671 msg
="remaining $test_remaining test(s)"
673 test_remaining
=$test_count
674 msg
="$test_count test(s)"
676 case "$test_failure" in
678 # Maybe print SKIP message
679 if test -n "$skip_all" && test $test_count -gt 0
681 error
"Can't use skip_all after running some tests"
683 [ -z "$skip_all" ] || skip_all
=" # SKIP $skip_all"
685 if test $test_external_has_tap -eq 0
687 if test $test_remaining -gt 0
689 say_color pass
"# passed all $msg"
691 say
"1..$test_count$skip_all"
694 test -d "$remove_trash" &&
695 cd "$(dirname "$remove_trash")" &&
696 rm -rf "$(basename "$remove_trash")"
703 if test $test_external_has_tap -eq 0
705 say_color error
"# failed $test_failure among $msg"
714 if test -n "$valgrind"
718 test "$1" = "$(readlink "$2")" ||
{
726 while test -d "$2".lock
728 say
"Waiting for lock on $2."
735 make_valgrind_symlink
() {
736 # handle only executables, unless they are shell libraries that
737 # need to be in the exec-path.
739 test "# " = "$(head -c 2 <"$1")" ||
742 base
=$
(basename "$1")
743 symlink_target
=$GIT_BUILD_DIR/$base
744 # do not override scripts
745 if test -x "$symlink_target" &&
746 test ! -d "$symlink_target" &&
747 test "#!" != "$(head -c 2 < "$symlink_target")"
749 symlink_target
=..
/valgrind.sh
753 symlink_target
=..
/unprocessed-script
755 # create the link, or replace it if it is out of date
756 make_symlink
"$symlink_target" "$GIT_VALGRIND/bin/$base" ||
exit
759 # override all git executables in TEST_DIRECTORY/..
760 GIT_VALGRIND
=$TEST_DIRECTORY/valgrind
761 mkdir
-p "$GIT_VALGRIND"/bin
762 for file in $GIT_BUILD_DIR/git
* $GIT_BUILD_DIR/test-
*
764 make_valgrind_symlink
$file
766 # special-case the mergetools loadables
767 make_symlink
"$GIT_BUILD_DIR"/mergetools
"$GIT_VALGRIND/bin/mergetools"
772 ls "$path"/git-
* 2> /dev
/null |
775 make_valgrind_symlink
"$file"
779 PATH
=$GIT_VALGRIND/bin
:$PATH
780 GIT_EXEC_PATH
=$GIT_VALGRIND/bin
782 GIT_VALGRIND_MODE
="$valgrind"
783 export GIT_VALGRIND_MODE
784 GIT_VALGRIND_ENABLED
=t
785 test -n "$valgrind_only" && GIT_VALGRIND_ENABLED
=
786 export GIT_VALGRIND_ENABLED
787 elif test -n "$GIT_TEST_INSTALLED"
789 GIT_EXEC_PATH
=$
($GIT_TEST_INSTALLED/git
--exec-path) ||
790 error
"Cannot run git from $GIT_TEST_INSTALLED."
791 PATH
=$GIT_TEST_INSTALLED:$GIT_BUILD_DIR:$PATH
792 GIT_EXEC_PATH
=${GIT_TEST_EXEC_PATH:-$GIT_EXEC_PATH}
793 else # normal case, use ../bin-wrappers only unless $with_dashes:
794 git_bin_dir
="$GIT_BUILD_DIR/bin-wrappers"
795 if ! test -x "$git_bin_dir/git"
797 if test -z "$with_dashes"
799 say
"$git_bin_dir/git is not executable; using GIT_EXEC_PATH"
803 PATH
="$git_bin_dir:$PATH"
804 GIT_EXEC_PATH
=$GIT_BUILD_DIR
805 if test -n "$with_dashes"
807 PATH
="$GIT_BUILD_DIR:$PATH"
810 GIT_TEMPLATE_DIR
="$GIT_BUILD_DIR"/templates
/blt
811 GIT_CONFIG_NOSYSTEM
=1
813 export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG_NOSYSTEM GIT_ATTR_NOSYSTEM
815 if test -z "$GIT_TEST_CMP"
817 if test -n "$GIT_TEST_CMP_USE_COPIED_CONTEXT"
819 GIT_TEST_CMP
="$DIFF -c"
821 GIT_TEST_CMP
="$DIFF -u"
825 GITPERLLIB
="$GIT_BUILD_DIR"/perl
/blib
/lib
:"$GIT_BUILD_DIR"/perl
/blib
/arch
/auto
/Git
827 test -d "$GIT_BUILD_DIR"/templates
/blt ||
{
828 error
"You haven't built things yet, have you?"
831 if ! test -x "$GIT_BUILD_DIR"/test-chmtime
833 echo >&2 'You need to build test-chmtime:'
834 echo >&2 'Run "make test-chmtime" in the source (toplevel) directory'
839 TRASH_DIRECTORY
="trash directory.$(basename "$0" .sh)"
840 test -n "$root" && TRASH_DIRECTORY
="$root/$TRASH_DIRECTORY"
841 case "$TRASH_DIRECTORY" in
842 /*) ;; # absolute path is good
843 *) TRASH_DIRECTORY
="$TEST_OUTPUT_DIRECTORY/$TRASH_DIRECTORY" ;;
845 test ! -z "$debug" || remove_trash
=$TRASH_DIRECTORY
846 rm -fr "$TRASH_DIRECTORY" ||
{
848 echo >&5 "FATAL: Cannot prepare test area"
852 HOME
="$TRASH_DIRECTORY"
853 GNUPGHOME
="$HOME/gnupg-home-not-used"
854 export HOME GNUPGHOME
856 if test -z "$TEST_NO_CREATE_REPO"
858 test_create_repo
"$TRASH_DIRECTORY"
860 mkdir
-p "$TRASH_DIRECTORY"
862 # Use -P to resolve symlinks in our working directory so that the cwd
863 # in subprocesses like git equals our $PWD (for pathname comparisons).
864 cd -P "$TRASH_DIRECTORY" ||
exit 1
867 this_test
=${this_test%%-*}
868 if match_pattern_list
"$this_test" $GIT_SKIP_TESTS
870 say_color info
>&3 "skipping test $this_test altogether"
871 skip_all
="skip all tests in $this_test"
875 # Provide an implementation of the 'yes' utility
890 # Fix some commands on Windows
893 # Windows has its own (incompatible) sort and find
903 # git sees Windows-style pwd
907 # no POSIX permissions
908 # backslashes in pathspec are converted to '/'
909 # exec does not inherit the PID
910 test_set_prereq MINGW
911 test_set_prereq NATIVE_CRLF
912 test_set_prereq SED_STRIPS_CR
913 test_set_prereq GREP_STRIPS_CR
914 GIT_TEST_CMP
=mingw_test_cmp
917 test_set_prereq POSIXPERM
918 test_set_prereq EXECKEEPSPID
919 test_set_prereq CYGWIN
920 test_set_prereq SED_STRIPS_CR
921 test_set_prereq GREP_STRIPS_CR
924 test_set_prereq POSIXPERM
925 test_set_prereq BSLASHPSPEC
926 test_set_prereq EXECKEEPSPID
930 ( COLUMNS
=1 && test $COLUMNS = 1 ) && test_set_prereq COLUMNS_CAN_BE_1
931 test -z "$NO_PERL" && test_set_prereq PERL
932 test -z "$NO_PYTHON" && test_set_prereq PYTHON
933 test -n "$USE_LIBPCRE" && test_set_prereq LIBPCRE
934 test -z "$NO_GETTEXT" && test_set_prereq GETTEXT
936 # Can we rely on git's output in the C locale?
937 if test -n "$GETTEXT_POISON"
939 GIT_GETTEXT_POISON
=YesPlease
940 export GIT_GETTEXT_POISON
941 test_set_prereq GETTEXT_POISON
943 test_set_prereq C_LOCALE_OUTPUT
946 # Use this instead of test_cmp to compare files that contain expected and
947 # actual output from git commands that can be translated. When running
948 # under GETTEXT_POISON this pretends that the command produced expected
951 test -n "$GETTEXT_POISON" || test_cmp
"$@"
954 # Use this instead of "grep expected-string actual" to see if the
955 # output from a git command that can be translated either contains an
956 # expected string, or does not contain an unwanted one. When running
957 # under GETTEXT_POISON this pretends that the command produced expected
960 if test -n "$GETTEXT_POISON"
963 elif test "x!" = "x$1"
972 test_lazy_prereq PIPE
'
973 # test whether the filesystem supports FIFOs
979 rm -f testfifo && mkfifo testfifo
984 test_lazy_prereq SYMLINKS
'
985 # test whether the filesystem supports symbolic links
986 ln -s x y && test -h y
989 test_lazy_prereq FILEMODE
'
990 test "$(git config --bool core.filemode)" = true
993 test_lazy_prereq CASE_INSENSITIVE_FS
'
994 echo good >CamelCase &&
995 echo bad >camelcase &&
996 test "$(cat CamelCase)" != good
999 test_lazy_prereq UTF8_NFD_TO_NFC
'
1000 # check whether FS converts nfd unicode to nfc
1001 auml=$(printf "\303\244")
1002 aumlcdiar=$(printf "\141\314\210")
1012 test_lazy_prereq AUTOIDENT
'
1013 sane_unset GIT_AUTHOR_NAME &&
1014 sane_unset GIT_AUTHOR_EMAIL &&
1015 git var GIT_AUTHOR_IDENT
1018 test_lazy_prereq EXPENSIVE
'
1019 test -n "$GIT_TEST_LONG"
1022 test_lazy_prereq USR_BIN_TIME
'
1023 test -x /usr/bin/time
1026 # When the tests are run as root, permission tests will report that
1027 # things are writable when they shouldn't be.
1028 test -w / || test_set_prereq SANITY
1030 GIT_UNZIP
=${GIT_UNZIP:-unzip}
1031 test_lazy_prereq UNZIP
'