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(
95 my @vars = grep(/^GIT_/ && !/^GIT_($ok)/o, @env);
96 print join("\n", @vars);
100 GIT_AUTHOR_EMAIL
=author@example.com
101 GIT_AUTHOR_NAME
='A U Thor'
102 GIT_COMMITTER_EMAIL
=committer@example.com
103 GIT_COMMITTER_NAME
='C O Mitter'
104 GIT_MERGE_VERBOSITY
=5
105 GIT_MERGE_AUTOEDIT
=no
106 export GIT_MERGE_VERBOSITY GIT_MERGE_AUTOEDIT
107 export GIT_AUTHOR_EMAIL GIT_AUTHOR_NAME
108 export GIT_COMMITTER_EMAIL GIT_COMMITTER_NAME
111 if test -n "${TEST_GIT_INDEX_VERSION:+isset}"
113 GIT_INDEX_VERSION
="$TEST_GIT_INDEX_VERSION"
114 export GIT_INDEX_VERSION
117 # Add libc MALLOC and MALLOC_PERTURB test
118 # only if we are not executing the test with valgrind
119 if expr " $GIT_TEST_OPTS " : ".* --valgrind " >/dev
/null ||
120 test -n "$TEST_NO_MALLOC_CHECK"
122 setup_malloc_check
() {
125 teardown_malloc_check
() {
129 setup_malloc_check
() {
130 MALLOC_CHECK_
=3 MALLOC_PERTURB_
=165
131 export MALLOC_CHECK_ MALLOC_PERTURB_
133 teardown_malloc_check
() {
134 unset MALLOC_CHECK_ MALLOC_PERTURB_
138 # Protect ourselves from common misconfiguration to export
139 # CDPATH into the environment
145 case $
(echo $GIT_TRACE |
tr "[A-Z]" "[a-z]") in
147 echo "* warning: Some tests will not work if GIT_TRACE" \
148 "is set as to trace on STDERR ! *"
149 echo "* warning: Please set GIT_TRACE to something" \
150 "other than 1, 2 or true ! *"
156 # A regexp to match 5 and 40 hexdigits
157 _x05
='[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
158 _x40
="$_x05$_x05$_x05$_x05$_x05$_x05$_x05$_x05"
161 _z40
=0000000000000000000000000000000000000000
167 # UTF-8 ZERO WIDTH NON-JOINER, which HFS+ ignores
168 # when case-folding filenames
169 u200c
=$
(printf '\342\200\214')
171 export _x05 _x40 _z40 LF u200c
173 # Each test should start with something like this, after copyright notices:
175 # test_description='Description of this test...
176 # This test checks if command xyzzy does the right thing...
179 [ "x$ORIGINAL_TERM" != "xdumb" ] && (
180 TERM
=$ORIGINAL_TERM &&
183 tput bold
>/dev
/null
2>&1 &&
184 tput setaf
1 >/dev
/null
2>&1 &&
185 tput sgr0
>/dev
/null
2>&1
189 while test "$#" -ne 0
192 -d|
--d|
--de|
--deb|
--debu|
--debug)
194 -i|
--i|
--im|
--imm|
--imme|
--immed|
--immedi|
--immedia|
--immediat|
--immediate)
195 immediate
=t
; shift ;;
196 -l|
--l|
--lo|
--lon|
--long|
--long-|
--long-t|
--long-te|
--long-tes|
--long-test|
--long-tests)
197 GIT_TEST_LONG
=t
; export GIT_TEST_LONG
; shift ;;
198 -h|
--h|
--he|
--hel|
--help)
200 -v|
--v|
--ve|
--ver|
--verb|
--verbo|
--verbos|
--verbose)
203 verbose_only
=$
(expr "z$1" : 'z[^=]*=\(.*\)')
205 -q|
--q|
--qu|
--qui|
--quie|
--quiet)
206 # Ignore --quiet under a TAP::Harness. Saying how many tests
207 # passed without the ok/not ok details is always an error.
208 test -z "$HARNESS_ACTIVE" && quiet
=t
; shift ;;
210 with_dashes
=t
; shift ;;
213 --va|
--val|
--valg|
--valgr|
--valgri|
--valgrin|
--valgrind)
217 valgrind
=$
(expr "z$1" : 'z[^=]*=\(.*\)')
220 valgrind_only
=$
(expr "z$1" : 'z[^=]*=\(.*\)')
223 shift ;; # was handled already
225 root
=$
(expr "z$1" : 'z[^=]*=\(.*\)')
228 echo "error: unknown test option '$1'" >&2; exit 1 ;;
232 if test -n "$valgrind_only"
234 test -z "$valgrind" && valgrind
=memcheck
235 test -z "$verbose" && verbose_only
="$valgrind_only"
236 elif test -n "$valgrind"
249 tput bold
; tput setaf
1;; # bold red
251 tput setaf
4;; # blue
253 tput setaf
3;; # brown/yellow
255 tput setaf
2;; # green
257 tput setaf
6;; # cyan
259 test -n "$quiet" && return;;
269 test -z "$1" && test -n "$quiet" && return
276 say_color error
"error: $*"
285 test "${test_description}" != "" ||
286 error
"Test script did not set test_description."
288 if test "$help" = "t"
290 printf '%s\n' "$test_description"
296 if test "$verbose" = "t"
300 exec 4>/dev
/null
3>/dev
/null
309 test_external_has_tap
=0
313 if test -n "$GIT_EXIT_OK"
317 echo >&5 "FATAL: Unexpected exit with code $code"
325 # The user-facing functions are loaded from a separate file so that
326 # test_perf subshells can have them too
327 .
"$TEST_DIRECTORY/test-lib-functions.sh"
329 # You are not expected to call test_ok_ and test_failure_ directly, use
330 # the test_expect_* functions instead.
333 test_success
=$
(($test_success + 1))
334 say_color
"" "ok $test_count - $@"
338 test_failure
=$
(($test_failure + 1))
339 say_color error
"not ok $test_count - $1"
341 printf '%s\n' "$*" |
sed -e 's/^/# /'
342 test "$immediate" = "" ||
{ GIT_EXIT_OK
=t
; exit 1; }
345 test_known_broken_ok_
() {
346 test_fixed
=$
(($test_fixed+1))
347 say_color error
"ok $test_count - $@ # TODO known breakage vanished"
350 test_known_broken_failure_
() {
351 test_broken
=$
(($test_broken+1))
352 say_color warn
"not ok $test_count - $@ # TODO known breakage"
356 test "$debug" = "" ||
eval "$1"
359 match_pattern_list
() {
362 test -z "$*" && return 1
373 maybe_teardown_verbose
() {
374 test -z "$verbose_only" && return
375 exec 4>/dev
/null
3>/dev
/null
380 maybe_setup_verbose
() {
381 test -z "$verbose_only" && return
382 if match_pattern_list
$test_count $verbose_only
385 # Emit a delimiting blank line when going from
386 # non-verbose to verbose. Within verbose mode the
387 # delimiter is printed by test_expect_*. The choice
388 # of the initial $last_verbose is such that before
389 # test 1, we do not print it.
390 test -z "$last_verbose" && echo >&3 ""
393 exec 4>/dev
/null
3>/dev
/null
396 last_verbose
=$verbose
399 maybe_teardown_valgrind
() {
400 test -z "$GIT_VALGRIND" && return
401 GIT_VALGRIND_ENABLED
=
404 maybe_setup_valgrind
() {
405 test -z "$GIT_VALGRIND" && return
406 if test -z "$valgrind_only"
408 GIT_VALGRIND_ENABLED
=t
411 GIT_VALGRIND_ENABLED
=
412 if match_pattern_list
$test_count $valgrind_only
414 GIT_VALGRIND_ENABLED
=t
419 # This is a separate function because some tests use
420 # "return" to end a test_expect_success block early.
421 eval </dev
/null
>&3 2>&4 "$*"
430 teardown_malloc_check
432 if test -z "$immediate" ||
test $eval_ret = 0 ||
test -n "$expecting_failure"
435 test_eval_
"$test_cleanup"
436 teardown_malloc_check
438 if test "$verbose" = "t" && test -n "$HARNESS_ACTIVE"
446 test_count
=$
(($test_count+1))
453 maybe_teardown_valgrind
454 maybe_teardown_verbose
459 if match_pattern_list
$this_test.
$test_count $GIT_SKIP_TESTS
463 if test -z "$to_skip" && test -n "$test_prereq" &&
464 ! test_have_prereq
"$test_prereq"
471 if test "$missing_prereq" != "$test_prereq"
473 of_prereq
=" of $test_prereq"
476 say_color skip
>&3 "skipping test: $@"
477 say_color skip
"ok $test_count # skip $1 (missing $missing_prereq${of_prereq})"
486 # stub; perf-lib overrides it
487 test_at_end_hook_
() {
494 if test -z "$HARNESS_ACTIVE"
496 test_results_dir
="$TEST_OUTPUT_DIRECTORY/test-results"
497 mkdir
-p "$test_results_dir"
499 test_results_path
="$test_results_dir/${base%.sh}-$$.counts"
501 cat >>"$test_results_path" <<-EOF
503 success $test_success
511 if test "$test_fixed" != 0
513 say_color error
"# $test_fixed known breakage(s) vanished; please update test(s)"
515 if test "$test_broken" != 0
517 say_color warn
"# still have $test_broken known breakage(s)"
519 if test "$test_broken" != 0 ||
test "$test_fixed" != 0
521 test_remaining
=$
(( $test_count - $test_broken - $test_fixed ))
522 msg
="remaining $test_remaining test(s)"
524 test_remaining
=$test_count
525 msg
="$test_count test(s)"
527 case "$test_failure" in
529 # Maybe print SKIP message
530 if test -n "$skip_all" && test $test_count -gt 0
532 error
"Can't use skip_all after running some tests"
534 [ -z "$skip_all" ] || skip_all
=" # SKIP $skip_all"
536 if test $test_external_has_tap -eq 0
538 if test $test_remaining -gt 0
540 say_color pass
"# passed all $msg"
542 say
"1..$test_count$skip_all"
545 test -d "$remove_trash" &&
546 cd "$(dirname "$remove_trash")" &&
547 rm -rf "$(basename "$remove_trash")"
554 if test $test_external_has_tap -eq 0
556 say_color error
"# failed $test_failure among $msg"
565 if test -n "$valgrind"
569 test "$1" = "$(readlink "$2")" ||
{
577 while test -d "$2".lock
579 say
"Waiting for lock on $2."
586 make_valgrind_symlink
() {
587 # handle only executables, unless they are shell libraries that
588 # need to be in the exec-path.
590 test "# " = "$(head -c 2 <"$1")" ||
593 base
=$
(basename "$1")
594 symlink_target
=$GIT_BUILD_DIR/$base
595 # do not override scripts
596 if test -x "$symlink_target" &&
597 test ! -d "$symlink_target" &&
598 test "#!" != "$(head -c 2 < "$symlink_target")"
600 symlink_target
=..
/valgrind.sh
604 symlink_target
=..
/unprocessed-script
606 # create the link, or replace it if it is out of date
607 make_symlink
"$symlink_target" "$GIT_VALGRIND/bin/$base" ||
exit
610 # override all git executables in TEST_DIRECTORY/..
611 GIT_VALGRIND
=$TEST_DIRECTORY/valgrind
612 mkdir
-p "$GIT_VALGRIND"/bin
613 for file in $GIT_BUILD_DIR/git
* $GIT_BUILD_DIR/test-
*
615 make_valgrind_symlink
$file
617 # special-case the mergetools loadables
618 make_symlink
"$GIT_BUILD_DIR"/mergetools
"$GIT_VALGRIND/bin/mergetools"
623 ls "$path"/git-
* 2> /dev
/null |
626 make_valgrind_symlink
"$file"
630 PATH
=$GIT_VALGRIND/bin
:$PATH
631 GIT_EXEC_PATH
=$GIT_VALGRIND/bin
633 GIT_VALGRIND_MODE
="$valgrind"
634 export GIT_VALGRIND_MODE
635 GIT_VALGRIND_ENABLED
=t
636 test -n "$valgrind_only" && GIT_VALGRIND_ENABLED
=
637 export GIT_VALGRIND_ENABLED
638 elif test -n "$GIT_TEST_INSTALLED"
640 GIT_EXEC_PATH
=$
($GIT_TEST_INSTALLED/git
--exec-path) ||
641 error
"Cannot run git from $GIT_TEST_INSTALLED."
642 PATH
=$GIT_TEST_INSTALLED:$GIT_BUILD_DIR:$PATH
643 GIT_EXEC_PATH
=${GIT_TEST_EXEC_PATH:-$GIT_EXEC_PATH}
644 else # normal case, use ../bin-wrappers only unless $with_dashes:
645 git_bin_dir
="$GIT_BUILD_DIR/bin-wrappers"
646 if ! test -x "$git_bin_dir/git"
648 if test -z "$with_dashes"
650 say
"$git_bin_dir/git is not executable; using GIT_EXEC_PATH"
654 PATH
="$git_bin_dir:$PATH"
655 GIT_EXEC_PATH
=$GIT_BUILD_DIR
656 if test -n "$with_dashes"
658 PATH
="$GIT_BUILD_DIR:$PATH"
661 GIT_TEMPLATE_DIR
="$GIT_BUILD_DIR"/templates
/blt
662 GIT_CONFIG_NOSYSTEM
=1
664 export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG_NOSYSTEM GIT_ATTR_NOSYSTEM
666 if test -z "$GIT_TEST_CMP"
668 if test -n "$GIT_TEST_CMP_USE_COPIED_CONTEXT"
670 GIT_TEST_CMP
="$DIFF -c"
672 GIT_TEST_CMP
="$DIFF -u"
676 GITPERLLIB
="$GIT_BUILD_DIR"/perl
/blib
/lib
:"$GIT_BUILD_DIR"/perl
/blib
/arch
/auto
/Git
678 test -d "$GIT_BUILD_DIR"/templates
/blt ||
{
679 error
"You haven't built things yet, have you?"
682 if ! test -x "$GIT_BUILD_DIR"/test-chmtime
684 echo >&2 'You need to build test-chmtime:'
685 echo >&2 'Run "make test-chmtime" in the source (toplevel) directory'
690 TRASH_DIRECTORY
="trash directory.$(basename "$0" .sh)"
691 test -n "$root" && TRASH_DIRECTORY
="$root/$TRASH_DIRECTORY"
692 case "$TRASH_DIRECTORY" in
693 /*) ;; # absolute path is good
694 *) TRASH_DIRECTORY
="$TEST_OUTPUT_DIRECTORY/$TRASH_DIRECTORY" ;;
696 test ! -z "$debug" || remove_trash
=$TRASH_DIRECTORY
697 rm -fr "$TRASH_DIRECTORY" ||
{
699 echo >&5 "FATAL: Cannot prepare test area"
703 HOME
="$TRASH_DIRECTORY"
706 if test -z "$TEST_NO_CREATE_REPO"
708 test_create_repo
"$TRASH_DIRECTORY"
710 mkdir
-p "$TRASH_DIRECTORY"
712 # Use -P to resolve symlinks in our working directory so that the cwd
713 # in subprocesses like git equals our $PWD (for pathname comparisons).
714 cd -P "$TRASH_DIRECTORY" ||
exit 1
717 this_test
=${this_test%%-*}
718 if match_pattern_list
"$this_test" $GIT_SKIP_TESTS
720 say_color info
>&3 "skipping test $this_test altogether"
721 skip_all
="skip all tests in $this_test"
725 # Provide an implementation of the 'yes' utility
740 # Fix some commands on Windows
743 # Windows has its own (incompatible) sort and find
753 # git sees Windows-style pwd
757 # no POSIX permissions
758 # backslashes in pathspec are converted to '/'
759 # exec does not inherit the PID
760 test_set_prereq MINGW
761 test_set_prereq NOT_CYGWIN
762 test_set_prereq SED_STRIPS_CR
763 test_set_prereq GREP_STRIPS_CR
764 GIT_TEST_CMP
=mingw_test_cmp
767 test_set_prereq POSIXPERM
768 test_set_prereq EXECKEEPSPID
769 test_set_prereq NOT_MINGW
770 test_set_prereq CYGWIN
771 test_set_prereq SED_STRIPS_CR
772 test_set_prereq GREP_STRIPS_CR
775 test_set_prereq POSIXPERM
776 test_set_prereq BSLASHPSPEC
777 test_set_prereq EXECKEEPSPID
778 test_set_prereq NOT_MINGW
779 test_set_prereq NOT_CYGWIN
783 ( COLUMNS
=1 && test $COLUMNS = 1 ) && test_set_prereq COLUMNS_CAN_BE_1
784 test -z "$NO_PERL" && test_set_prereq PERL
785 test -z "$NO_PYTHON" && test_set_prereq PYTHON
786 test -n "$USE_LIBPCRE" && test_set_prereq LIBPCRE
787 test -z "$NO_GETTEXT" && test_set_prereq GETTEXT
789 # Can we rely on git's output in the C locale?
790 if test -n "$GETTEXT_POISON"
792 GIT_GETTEXT_POISON
=YesPlease
793 export GIT_GETTEXT_POISON
794 test_set_prereq GETTEXT_POISON
796 test_set_prereq C_LOCALE_OUTPUT
799 # Use this instead of test_cmp to compare files that contain expected and
800 # actual output from git commands that can be translated. When running
801 # under GETTEXT_POISON this pretends that the command produced expected
804 test -n "$GETTEXT_POISON" || test_cmp
"$@"
807 # Use this instead of "grep expected-string actual" to see if the
808 # output from a git command that can be translated either contains an
809 # expected string, or does not contain an unwanted one. When running
810 # under GETTEXT_POISON this pretends that the command produced expected
813 if test -n "$GETTEXT_POISON"
816 elif test "x!" = "x$1"
825 test_lazy_prereq PIPE
'
826 # test whether the filesystem supports FIFOs
832 rm -f testfifo && mkfifo testfifo
837 test_lazy_prereq SYMLINKS
'
838 # test whether the filesystem supports symbolic links
839 ln -s x y && test -h y
842 test_lazy_prereq FILEMODE
'
843 test "$(git config --bool core.filemode)" = true
846 test_lazy_prereq CASE_INSENSITIVE_FS
'
847 echo good >CamelCase &&
848 echo bad >camelcase &&
849 test "$(cat CamelCase)" != good
852 test_lazy_prereq UTF8_NFD_TO_NFC
'
853 # check whether FS converts nfd unicode to nfc
854 auml=$(printf "\303\244")
855 aumlcdiar=$(printf "\141\314\210")
865 test_lazy_prereq AUTOIDENT
'
866 sane_unset GIT_AUTHOR_NAME &&
867 sane_unset GIT_AUTHOR_EMAIL &&
868 git var GIT_AUTHOR_IDENT
871 # When the tests are run as root, permission tests will report that
872 # things are writable when they shouldn't be.
873 test -w / || test_set_prereq SANITY
875 GIT_UNZIP
=${GIT_UNZIP:-unzip}
876 test_lazy_prereq UNZIP
'