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 if test -z "$TEST_OUTPUT_DIRECTORY"
32 # Similarly, override this to store the test-results subdir
34 TEST_OUTPUT_DIRECTORY=$TEST_DIRECTORY
36 GIT_BUILD_DIR="$TEST_DIRECTORY"/..
38 ################################################################
39 # It appears that people try to run tests without building...
40 "$GIT_BUILD_DIR/git" >/dev/null
43 echo >&2 'error: you do not seem to have built git yet.'
47 . "$GIT_BUILD_DIR"/GIT-BUILD-OPTIONS
48 export PERL_PATH SHELL_PATH
50 # if --tee was passed, write the output not only to the terminal, but
51 # additionally to the file test-results/$BASENAME.out, too.
52 case "$GIT_TEST_TEE_STARTED, $* " in
54 # do not redirect again
56 *' --tee '*|*' --va'*)
57 mkdir -p "$TEST_OUTPUT_DIRECTORY/test-results"
58 BASE="$TEST_OUTPUT_DIRECTORY/test-results/$(basename "$0" .sh)"
59 (GIT_TEST_TEE_STARTED=done ${SHELL_PATH} "$0" "$@" 2>&1;
60 echo $? > $BASE.exit) | tee $BASE.out
61 test "$(cat $BASE.exit)" = 0
66 # For repeatability, reset the environment to known value.
72 export LANG LC_ALL PAGER TERM TZ
74 # A call to "unset" with no arguments causes at least Solaris 10
75 # /usr/xpg4/bin/sh and /bin/ksh to bail out. So keep the unsets
76 # deriving from the command substitution clustered with the other
78 unset VISUAL EMAIL LANGUAGE COLUMNS $("$PERL_PATH" -e '
80 my $ok = join("|", qw(
91 my @vars = grep(/^GIT_/ && !/^GIT_($ok)/o, @env);
92 print join("\n", @vars);
95 GIT_AUTHOR_EMAIL=author@example.com
96 GIT_AUTHOR_NAME='A U Thor'
97 GIT_COMMITTER_EMAIL=committer@example.com
98 GIT_COMMITTER_NAME='C O Mitter'
100 GIT_MERGE_AUTOEDIT=no
101 export GIT_MERGE_VERBOSITY GIT_MERGE_AUTOEDIT
102 export GIT_AUTHOR_EMAIL GIT_AUTHOR_NAME
103 export GIT_COMMITTER_EMAIL GIT_COMMITTER_NAME
106 # Add libc MALLOC and MALLOC_PERTURB test
107 # only if we are not executing the test with valgrind
108 if expr " $GIT_TEST_OPTS " : ".* --valgrind " >/dev/null ||
109 test -n "$TEST_NO_MALLOC_CHECK"
111 setup_malloc_check () {
114 teardown_malloc_check () {
118 setup_malloc_check () {
119 MALLOC_CHECK_=3 MALLOC_PERTURB_=165
120 export MALLOC_CHECK_ MALLOC_PERTURB_
122 teardown_malloc_check () {
123 unset MALLOC_CHECK_ MALLOC_PERTURB_
127 # Protect ourselves from common misconfiguration to export
128 # CDPATH into the environment
134 case $(echo $GIT_TRACE |tr "[A-Z]" "[a-z]") in
136 echo "* warning: Some tests will not work if GIT_TRACE" \
137 "is set as to trace on STDERR ! *"
138 echo "* warning: Please set GIT_TRACE to something" \
139 "other than 1, 2 or true ! *"
145 # A regexp to match 5 and 40 hexdigits
146 _x05='[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
147 _x40="$_x05$_x05$_x05$_x05$_x05$_x05$_x05$_x05"
150 _z40=0000000000000000000000000000000000000000
156 export _x05 _x40 _z40 LF
158 # Each test should start with something like this, after copyright notices:
160 # test_description='Description of this test...
161 # This test checks if command xyzzy does the right thing...
164 [ "x$ORIGINAL_TERM" != "xdumb" ] && (
165 TERM=$ORIGINAL_TERM &&
168 tput bold >/dev/null 2>&1 &&
169 tput setaf 1 >/dev/null 2>&1 &&
170 tput sgr0 >/dev/null 2>&1
174 while test "$#" -ne 0
177 -d|--d|--de|--deb|--debu|--debug)
179 -i|--i|--im|--imm|--imme|--immed|--immedi|--immedia|--immediat|--immediate)
180 immediate=t; shift ;;
181 -l|--l|--lo|--lon|--long|--long-|--long-t|--long-te|--long-tes|--long-test|--long-tests)
182 GIT_TEST_LONG=t; export GIT_TEST_LONG; shift ;;
183 -h|--h|--he|--hel|--help)
185 -v|--v|--ve|--ver|--verb|--verbo|--verbos|--verbose)
188 verbose_only=$(expr "z$1" : 'z[^=]*=\(.*\)')
190 -q|--q|--qu|--qui|--quie|--quiet)
191 # Ignore --quiet under a TAP::Harness. Saying how many tests
192 # passed without the ok/not ok details is always an error.
193 test -z "$HARNESS_ACTIVE" && quiet=t; shift ;;
195 with_dashes=t; shift ;;
198 --va|--val|--valg|--valgr|--valgri|--valgrin|--valgrind)
202 valgrind=$(expr "z$1" : 'z[^=]*=\(.*\)')
205 valgrind_only=$(expr "z$1" : 'z[^=]*=\(.*\)')
207 --valgrind-parallel=*)
208 valgrind_parallel=$(expr "z$1" : 'z[^=]*=\(.*\)')
210 --valgrind-only-stride=*)
211 valgrind_only_stride=$(expr "z$1" : 'z[^=]*=\(.*\)')
213 --valgrind-only-offset=*)
214 valgrind_only_offset=$(expr "z$1" : 'z[^=]*=\(.*\)')
217 shift ;; # was handled already
219 root=$(expr "z$1" : 'z[^=]*=\(.*\)')
222 statusprefix=$(expr "z$1" : 'z[^=]*=\(.*\)')
225 echo "error: unknown test option '$1'" >&2; exit 1 ;;
229 if test -n "$valgrind_only" || test -n "$valgrind_only_stride"
231 test -z "$valgrind" && valgrind=memcheck
232 test -z "$verbose" && verbose_only="$valgrind_only"
233 elif test -n "$valgrind"
246 tput bold; tput setaf 1;; # bold red
248 tput setaf 4;; # blue
250 tput setaf 3;; # brown/yellow
252 tput setaf 2;; # green
254 tput setaf 6;; # cyan
256 test -n "$quiet" && return;;
266 test -z "$1" && test -n "$quiet" && return
273 say_color error "error: $*"
282 test "${test_description}" != "" ||
283 error "Test script did not set test_description."
285 if test "$help" = "t"
287 echo "$test_description"
293 if test "$verbose" = "t"
297 exec 4>/dev/null 3>/dev/null
306 test_external_has_tap=0
310 if test -n "$GIT_EXIT_OK"
314 echo >&5 "FATAL: Unexpected exit with code $code"
322 # The user-facing functions are loaded from a separate file so that
323 # test_perf subshells can have them too
324 . "$TEST_DIRECTORY/test-lib-functions.sh"
326 # You are not expected to call test_ok_ and test_failure_ directly, use
327 # the text_expect_* functions instead.
330 test_success=$(($test_success + 1))
331 say_color "" "${statusprefix}ok $test_count - $@"
335 test_failure=$(($test_failure + 1))
336 say_color error "${statusprefix}not ok $test_count - $1"
338 echo "$@" | sed -e 's/^/# /'
339 test "$immediate" = "" || { GIT_EXIT_OK=t; exit 1; }
342 test_known_broken_ok_ () {
343 test_fixed=$(($test_fixed+1))
344 say_color error "${statusprefix}ok $test_count - $@ # TODO known breakage vanished"
347 test_known_broken_failure_ () {
348 test_broken=$(($test_broken+1))
349 say_color warn "${statusprefix}not ok $test_count - $@ # TODO known breakage"
353 test "$debug" = "" || eval "$1"
356 match_pattern_list () {
359 test -z "$*" && return 1
370 maybe_teardown_verbose () {
371 test -z "$verbose_only" && return
372 exec 4>/dev/null 3>/dev/null
377 maybe_setup_verbose () {
378 test -z "$verbose_only" && return
379 if match_pattern_list $test_count $verbose_only ||
380 { test -n "$valgrind_only_stride" &&
381 expr $test_count "%" $valgrind_only_stride - $valgrind_only_offset = 0 >/dev/null; }
384 # Emit a delimiting blank line when going from
385 # non-verbose to verbose. Within verbose mode the
386 # delimiter is printed by test_expect_*. The choice
387 # of the initial $last_verbose is such that before
388 # test 1, we do not print it.
389 test -z "$last_verbose" && echo >&3 ""
392 exec 4>/dev/null 3>/dev/null
395 last_verbose=$verbose
398 maybe_teardown_valgrind () {
399 test -z "$GIT_VALGRIND" && return
400 GIT_VALGRIND_ENABLED=
403 maybe_setup_valgrind () {
404 test -z "$GIT_VALGRIND" && return
405 if test -z "$valgrind_only" && test -z "$valgrind_only_stride"
407 GIT_VALGRIND_ENABLED=t
410 GIT_VALGRIND_ENABLED=
411 if match_pattern_list $test_count $valgrind_only
413 GIT_VALGRIND_ENABLED=t
414 elif test -n "$valgrind_only_stride" &&
415 expr $test_count "%" $valgrind_only_stride - $valgrind_only_offset = 0 >/dev/null
417 GIT_VALGRIND_ENABLED=t
422 # This is a separate function because some tests use
423 # "return" to end a test_expect_success block early.
424 eval </dev/null >&3 2>&4 "$*"
433 teardown_malloc_check
435 if test -z "$immediate" || test $eval_ret = 0 || test -n "$expecting_failure"
438 test_eval_ "$test_cleanup"
439 teardown_malloc_check
441 if test "$verbose" = "t" && test -n "$HARNESS_ACTIVE"
449 test_count=$(($test_count+1))
456 maybe_teardown_valgrind
457 maybe_teardown_verbose
462 if match_pattern_list $this_test.$test_count $GIT_SKIP_TESTS
466 if test -z "$to_skip" && test -n "$test_prereq" &&
467 ! test_have_prereq "$test_prereq"
474 if test "$missing_prereq" != "$test_prereq"
476 of_prereq=" of $test_prereq"
479 say_color skip >&3 "${statusprefix}skipping test: $@"
480 say_color skip "${statusprefix}ok $test_count # skip $1 (missing $missing_prereq${of_prereq})"
489 # stub; perf-lib overrides it
490 test_at_end_hook_ () {
497 # Note: t0000 relies on $HARNESS_ACTIVE disabling the .counts
499 if test -z "$HARNESS_ACTIVE"
501 test_results_dir="$TEST_OUTPUT_DIRECTORY/test-results"
502 mkdir -p "$test_results_dir"
504 test_results_path="$test_results_dir/${base%.sh}-$$.counts"
506 cat >>"$test_results_path" <<-EOF
508 success $test_success
516 if test "$test_fixed" != 0
518 say_color error "${statusprefix}# $test_fixed known breakage(s) vanished; please update test(s)"
520 if test "$test_broken" != 0
522 say_color warn "${statusprefix}# still have $test_broken known breakage(s)"
524 if test "$test_broken" != 0 || test "$test_fixed" != 0
526 test_remaining=$(( $test_count - $test_broken - $test_fixed ))
527 msg="remaining $test_remaining test(s)"
529 test_remaining=$test_count
530 msg="$test_count test(s)"
532 case "$test_failure" in
534 # Maybe print SKIP message
535 if test -n "$skip_all" && test $test_count -gt 0
537 error "Can't use skip_all after running some tests"
539 [ -z "$skip_all" ] || skip_all=" # SKIP $skip_all"
541 if test $test_external_has_tap -eq 0
543 if test $test_remaining -gt 0
545 say_color pass "${statusprefix}# passed all $msg"
547 say "${statusprefix}1..$test_count$skip_all"
550 test -d "$remove_trash" &&
551 cd "$(dirname "$remove_trash")" &&
552 rm -rf "$(basename "$remove_trash")"
559 if test $test_external_has_tap -eq 0
561 say_color error "${statusprefix}# failed $test_failure among $msg"
562 say "${statusprefix}1..$test_count"
571 # Set up a directory that we can put in PATH which redirects all git
572 # calls to 'valgrind git ...'.
573 if test -n "$valgrind"
577 test "$1" = "$(readlink "$2")" || {
585 while test -d "$2".lock
587 say "Waiting for lock on $2."
594 make_valgrind_symlink () {
595 # handle only executables, unless they are shell libraries that
596 # need to be in the exec-path. We will just use "#!" as a
597 # guess for a shell-script, since we have no idea what the user
598 # may have configured as the shell path.
600 test "#!" = "$(head -c 2 <"$1")" ||
603 base=$(basename "$1")
604 symlink_target=$GIT_BUILD_DIR/$base
605 # do not override scripts
606 if test -x "$symlink_target" &&
607 test ! -d "$symlink_target" &&
608 test "#!" != "$(head -c 2 < "$symlink_target")"
610 symlink_target=../valgrind.sh
614 symlink_target=../unprocessed-script
616 # create the link, or replace it if it is out of date
617 make_symlink "$symlink_target" "$GIT_VALGRIND/bin/$base" || exit
620 # In the case of --valgrind-parallel, we only need to do the
621 # wrapping once, in the main script. The worker children all
622 # have $valgrind_only_stride set, so we can skip based on that.
623 if test -z "$valgrind_only_stride"
625 # override all git executables in TEST_DIRECTORY/..
626 GIT_VALGRIND=$TEST_DIRECTORY/valgrind
627 mkdir -p "$GIT_VALGRIND"/bin
628 for file in $GIT_BUILD_DIR/git* $GIT_BUILD_DIR/test-*
630 make_valgrind_symlink $file
632 # special-case the mergetools loadables
633 make_symlink "$GIT_BUILD_DIR"/mergetools "$GIT_VALGRIND/bin/mergetools"
638 ls "$path"/git-* 2> /dev/null |
641 make_valgrind_symlink "$file"
646 PATH=$GIT_VALGRIND/bin:$PATH
647 GIT_EXEC_PATH=$GIT_VALGRIND/bin
649 GIT_VALGRIND_MODE="$valgrind"
650 export GIT_VALGRIND_MODE
651 GIT_VALGRIND_ENABLED=t
652 if test -n "$valgrind_only" || test -n "$valgrind_only_stride"
654 GIT_VALGRIND_ENABLED=
656 export GIT_VALGRIND_ENABLED
657 elif test -n "$GIT_TEST_INSTALLED"
659 GIT_EXEC_PATH=$($GIT_TEST_INSTALLED/git --exec-path) ||
660 error "Cannot run git from $GIT_TEST_INSTALLED."
661 PATH=$GIT_TEST_INSTALLED:$GIT_BUILD_DIR:$PATH
662 GIT_EXEC_PATH=${GIT_TEST_EXEC_PATH:-$GIT_EXEC_PATH}
663 else # normal case, use ../bin-wrappers only unless $with_dashes:
664 git_bin_dir="$GIT_BUILD_DIR/bin-wrappers"
665 if ! test -x "$git_bin_dir/git"
667 if test -z "$with_dashes"
669 say "$git_bin_dir/git is not executable; using GIT_EXEC_PATH"
673 PATH="$git_bin_dir:$PATH"
674 GIT_EXEC_PATH=$GIT_BUILD_DIR
675 if test -n "$with_dashes"
677 PATH="$GIT_BUILD_DIR:$PATH"
680 GIT_TEMPLATE_DIR="$GIT_BUILD_DIR"/templates/blt
682 GIT_CONFIG_NOSYSTEM=1
684 export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG_NOSYSTEM GIT_ATTR_NOSYSTEM
686 if test -z "$GIT_TEST_CMP"
688 if test -n "$GIT_TEST_CMP_USE_COPIED_CONTEXT"
690 GIT_TEST_CMP="$DIFF -c"
692 GIT_TEST_CMP="$DIFF -u"
696 GITPERLLIB="$GIT_BUILD_DIR"/perl/blib/lib:"$GIT_BUILD_DIR"/perl/blib/arch/auto/Git
698 test -d "$GIT_BUILD_DIR"/templates/blt || {
699 error "You haven't built things yet, have you?"
702 if test -z "$GIT_TEST_INSTALLED" && test -z "$NO_PYTHON"
704 GITPYTHONLIB="$GIT_BUILD_DIR/git_remote_helpers/build/lib"
706 test -d "$GIT_BUILD_DIR"/git_remote_helpers/build || {
707 error "You haven't built git_remote_helpers yet, have you?"
711 if ! test -x "$GIT_BUILD_DIR"/test-chmtime
713 echo >&2 'You need to build test-chmtime:'
714 echo >&2 'Run "make test-chmtime" in the source (toplevel) directory'
719 TRASH_DIRECTORY="trash directory.$(basename "$0" .sh)"
720 test -n "$root" && TRASH_DIRECTORY="$root/$TRASH_DIRECTORY"
721 case "$TRASH_DIRECTORY" in
722 /*) ;; # absolute path is good
723 *) TRASH_DIRECTORY="$TEST_OUTPUT_DIRECTORY/$TRASH_DIRECTORY" ;;
725 test ! -z "$debug" || remove_trash=$TRASH_DIRECTORY
726 rm -fr "$TRASH_DIRECTORY" || {
728 echo >&5 "FATAL: Cannot prepare test area"
732 HOME="$TRASH_DIRECTORY"
735 if test -z "$TEST_NO_CREATE_REPO"
737 test_create_repo "$TRASH_DIRECTORY"
739 mkdir -p "$TRASH_DIRECTORY"
742 # Gross hack to spawn N sub-instances of the tests in parallel, and
743 # summarize the results. Note that if this is enabled, the script
744 # terminates at the end of this 'if' block.
745 if test -n "$valgrind_parallel"
747 for i in $(test_seq 1 $valgrind_parallel)
749 root="$TRASH_DIRECTORY/vgparallel-$i"
751 TEST_OUTPUT_DIRECTORY="$root" \
753 --root="$root" --statusprefix="[$i] " \
754 --valgrind="$valgrind" \
755 --valgrind-only-stride="$valgrind_parallel" \
756 --valgrind-only-offset="$i" &
759 trap "kill $pids" INT TERM HUP
762 for i in $(test_seq 1 $valgrind_parallel)
764 root="$TRASH_DIRECTORY/vgparallel-$i"
765 eval "$(cat "$root/test-results/$(basename "$0" .sh)"-*.counts |
766 sed 's/^\([a-z][a-z]*\) \([0-9][0-9]*\)/inner_\1=\2/')"
767 test_count=$(expr $test_count + $inner_total)
768 test_success=$(expr $test_success + $inner_success)
769 test_fixed=$(expr $test_fixed + $inner_fixed)
770 test_broken=$(expr $test_broken + $inner_broken)
771 test_failure=$(expr $test_failure + $inner_failed)
776 # Use -P to resolve symlinks in our working directory so that the cwd
777 # in subprocesses like git equals our $PWD (for pathname comparisons).
778 cd -P "$TRASH_DIRECTORY" || exit 1
781 this_test=${this_test%%-*}
782 if match_pattern_list "$this_test" $GIT_SKIP_TESTS
784 say_color info >&3 "skipping test $this_test altogether"
785 skip_all="skip all tests in $this_test"
789 # Provide an implementation of the 'yes' utility
804 # Fix some commands on Windows
807 # Windows has its own (incompatible) sort and find
817 # git sees Windows-style pwd
821 # no POSIX permissions
822 # backslashes in pathspec are converted to '/'
823 # exec does not inherit the PID
824 test_set_prereq MINGW
825 test_set_prereq NOT_CYGWIN
826 test_set_prereq SED_STRIPS_CR
829 test_set_prereq POSIXPERM
830 test_set_prereq EXECKEEPSPID
831 test_set_prereq NOT_MINGW
832 test_set_prereq CYGWIN
833 test_set_prereq SED_STRIPS_CR
836 test_set_prereq POSIXPERM
837 test_set_prereq BSLASHPSPEC
838 test_set_prereq EXECKEEPSPID
839 test_set_prereq NOT_MINGW
840 test_set_prereq NOT_CYGWIN
844 ( COLUMNS=1 && test $COLUMNS = 1 ) && test_set_prereq COLUMNS_CAN_BE_1
845 test -z "$NO_PERL" && test_set_prereq PERL
846 test -z "$NO_PYTHON" && test_set_prereq PYTHON
847 test -n "$USE_LIBPCRE" && test_set_prereq LIBPCRE
848 test -z "$NO_GETTEXT" && test_set_prereq GETTEXT
850 # Can we rely on git's output in the C locale?
851 if test -n "$GETTEXT_POISON"
853 GIT_GETTEXT_POISON=YesPlease
854 export GIT_GETTEXT_POISON
855 test_set_prereq GETTEXT_POISON
857 test_set_prereq C_LOCALE_OUTPUT
860 # Use this instead of test_cmp to compare files that contain expected and
861 # actual output from git commands that can be translated. When running
862 # under GETTEXT_POISON this pretends that the command produced expected
865 test -n "$GETTEXT_POISON" || test_cmp "$@"
868 # Use this instead of "grep expected-string actual" to see if the
869 # output from a git command that can be translated either contains an
870 # expected string, or does not contain an unwanted one. When running
871 # under GETTEXT_POISON this pretends that the command produced expected
874 if test -n "$GETTEXT_POISON"
877 elif test "x!" = "x$1"
886 test_lazy_prereq PIPE '
887 # test whether the filesystem supports FIFOs
893 rm -f testfifo && mkfifo testfifo
898 test_lazy_prereq SYMLINKS '
899 # test whether the filesystem supports symbolic links
900 ln -s x y && test -h y
903 test_lazy_prereq CASE_INSENSITIVE_FS '
904 echo good >CamelCase &&
905 echo bad >camelcase &&
906 test "$(cat CamelCase)" != good
909 test_lazy_prereq UTF8_NFD_TO_NFC '
910 # check whether FS converts nfd unicode to nfc
911 auml=$(printf "\303\244")
912 aumlcdiar=$(printf "\141\314\210")
922 test_lazy_prereq AUTOIDENT '
923 sane_unset GIT_AUTHOR_NAME &&
924 sane_unset GIT_AUTHOR_EMAIL &&
925 git var GIT_AUTHOR_IDENT
928 # When the tests are run as root, permission tests will report that
929 # things are writable when they shouldn't be.
930 test -w / || test_set_prereq SANITY
932 GIT_UNZIP=${GIT_UNZIP:-unzip}
933 test_lazy_prereq UNZIP '