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'*)
58 BASE=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)
187 -q|--q|--qu|--qui|--quie|--quiet)
188 # Ignore --quiet under a TAP::Harness. Saying how many tests
189 # passed without the ok/not ok details is always an error.
190 test -z "$HARNESS_ACTIVE" && quiet=t; shift ;;
192 with_dashes=t; shift ;;
195 --va|--val|--valg|--valgr|--valgri|--valgrin|--valgrind)
196 valgrind=t; verbose=t; shift ;;
198 shift ;; # was handled already
200 root=$(expr "z$1" : 'z[^=]*=\(.*\)')
203 echo "error: unknown test option '$1'" >&2; exit 1 ;;
215 tput bold; tput setaf 1;; # bold red
217 tput setaf 4;; # blue
219 tput setaf 3;; # brown/yellow
221 tput setaf 2;; # green
223 tput setaf 6;; # cyan
225 test -n "$quiet" && return;;
235 test -z "$1" && test -n "$quiet" && return
242 say_color error "error: $*"
251 test "${test_description}" != "" ||
252 error "Test script did not set test_description."
254 if test "$help" = "t"
256 echo "$test_description"
262 if test "$verbose" = "t"
266 exec 4>/dev/null 3>/dev/null
275 test_external_has_tap=0
279 if test -n "$GIT_EXIT_OK"
283 echo >&5 "FATAL: Unexpected exit with code $code"
291 # The user-facing functions are loaded from a separate file so that
292 # test_perf subshells can have them too
293 . "$TEST_DIRECTORY/test-lib-functions.sh"
295 # You are not expected to call test_ok_ and test_failure_ directly, use
296 # the text_expect_* functions instead.
299 test_success=$(($test_success + 1))
300 say_color "" "ok $test_count - $@"
304 test_failure=$(($test_failure + 1))
305 say_color error "not ok $test_count - $1"
307 echo "$@" | sed -e 's/^/# /'
308 test "$immediate" = "" || { GIT_EXIT_OK=t; exit 1; }
311 test_known_broken_ok_ () {
312 test_fixed=$(($test_fixed+1))
313 say_color error "ok $test_count - $@ # TODO known breakage vanished"
316 test_known_broken_failure_ () {
317 test_broken=$(($test_broken+1))
318 say_color warn "not ok $test_count - $@ # TODO known breakage"
322 test "$debug" = "" || eval "$1"
326 # This is a separate function because some tests use
327 # "return" to end a test_expect_success block early.
328 eval </dev/null >&3 2>&4 "$*"
337 if test -z "$immediate" || test $eval_ret = 0 || test -n "$expecting_failure"
340 test_eval_ "$test_cleanup"
341 teardown_malloc_check
343 if test "$verbose" = "t" && test -n "$HARNESS_ACTIVE"
351 test_count=$(($test_count+1))
353 for skp in $GIT_SKIP_TESTS
355 case $this_test.$test_count in
361 if test -z "$to_skip" && test -n "$test_prereq" &&
362 ! test_have_prereq "$test_prereq"
369 if test "$missing_prereq" != "$test_prereq"
371 of_prereq=" of $test_prereq"
374 say_color skip >&3 "skipping test: $@"
375 say_color skip "ok $test_count # skip $1 (missing $missing_prereq${of_prereq})"
384 # stub; perf-lib overrides it
385 test_at_end_hook_ () {
392 if test -z "$HARNESS_ACTIVE"
394 test_results_dir="$TEST_OUTPUT_DIRECTORY/test-results"
395 mkdir -p "$test_results_dir"
397 test_results_path="$test_results_dir/${base%.sh}-$$.counts"
399 cat >>"$test_results_path" <<-EOF
401 success $test_success
409 if test "$test_fixed" != 0
411 say_color error "# $test_fixed known breakage(s) vanished; please update test(s)"
413 if test "$test_broken" != 0
415 say_color warn "# still have $test_broken known breakage(s)"
417 if test "$test_broken" != 0 || test "$test_fixed" != 0
419 test_remaining=$(( $test_count - $test_broken - $test_fixed ))
420 msg="remaining $test_remaining test(s)"
422 test_remaining=$test_count
423 msg="$test_count test(s)"
425 case "$test_failure" in
427 # Maybe print SKIP message
428 if test -n "$skip_all" && test $test_count -gt 0
430 error "Can't use skip_all after running some tests"
432 [ -z "$skip_all" ] || skip_all=" # SKIP $skip_all"
434 if test $test_external_has_tap -eq 0
436 if test $test_remaining -gt 0
438 say_color pass "# passed all $msg"
440 say "1..$test_count$skip_all"
443 test -d "$remove_trash" &&
444 cd "$(dirname "$remove_trash")" &&
445 rm -rf "$(basename "$remove_trash")"
452 if test $test_external_has_tap -eq 0
454 say_color error "# failed $test_failure among $msg"
463 if test -n "$valgrind"
467 test "$1" = "$(readlink "$2")" || {
475 while test -d "$2".lock
477 say "Waiting for lock on $2."
484 make_valgrind_symlink () {
485 # handle only executables, unless they are shell libraries that
486 # need to be in the exec-path. We will just use "#!" as a
487 # guess for a shell-script, since we have no idea what the user
488 # may have configured as the shell path.
490 test "#!" = "$(head -c 2 <"$1")" ||
493 base=$(basename "$1")
494 symlink_target=$GIT_BUILD_DIR/$base
495 # do not override scripts
496 if test -x "$symlink_target" &&
497 test ! -d "$symlink_target" &&
498 test "#!" != "$(head -c 2 < "$symlink_target")"
500 symlink_target=../valgrind.sh
504 symlink_target=../unprocessed-script
506 # create the link, or replace it if it is out of date
507 make_symlink "$symlink_target" "$GIT_VALGRIND/bin/$base" || exit
510 # override all git executables in TEST_DIRECTORY/..
511 GIT_VALGRIND=$TEST_DIRECTORY/valgrind
512 mkdir -p "$GIT_VALGRIND"/bin
513 for file in $GIT_BUILD_DIR/git* $GIT_BUILD_DIR/test-*
515 make_valgrind_symlink $file
517 # special-case the mergetools loadables
518 make_symlink "$GIT_BUILD_DIR"/mergetools "$GIT_VALGRIND/bin/mergetools"
523 ls "$path"/git-* 2> /dev/null |
526 make_valgrind_symlink "$file"
530 PATH=$GIT_VALGRIND/bin:$PATH
531 GIT_EXEC_PATH=$GIT_VALGRIND/bin
533 elif test -n "$GIT_TEST_INSTALLED"
535 GIT_EXEC_PATH=$($GIT_TEST_INSTALLED/git --exec-path) ||
536 error "Cannot run git from $GIT_TEST_INSTALLED."
537 PATH=$GIT_TEST_INSTALLED:$GIT_BUILD_DIR:$PATH
538 GIT_EXEC_PATH=${GIT_TEST_EXEC_PATH:-$GIT_EXEC_PATH}
539 else # normal case, use ../bin-wrappers only unless $with_dashes:
540 git_bin_dir="$GIT_BUILD_DIR/bin-wrappers"
541 if ! test -x "$git_bin_dir/git"
543 if test -z "$with_dashes"
545 say "$git_bin_dir/git is not executable; using GIT_EXEC_PATH"
549 PATH="$git_bin_dir:$PATH"
550 GIT_EXEC_PATH=$GIT_BUILD_DIR
551 if test -n "$with_dashes"
553 PATH="$GIT_BUILD_DIR:$PATH"
556 GIT_TEMPLATE_DIR="$GIT_BUILD_DIR"/templates/blt
558 GIT_CONFIG_NOSYSTEM=1
560 export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG_NOSYSTEM GIT_ATTR_NOSYSTEM
562 if test -z "$GIT_TEST_CMP"
564 if test -n "$GIT_TEST_CMP_USE_COPIED_CONTEXT"
566 GIT_TEST_CMP="$DIFF -c"
568 GIT_TEST_CMP="$DIFF -u"
572 GITPERLLIB="$GIT_BUILD_DIR"/perl/blib/lib:"$GIT_BUILD_DIR"/perl/blib/arch/auto/Git
574 test -d "$GIT_BUILD_DIR"/templates/blt || {
575 error "You haven't built things yet, have you?"
578 if test -z "$GIT_TEST_INSTALLED" && test -z "$NO_PYTHON"
580 GITPYTHONLIB="$GIT_BUILD_DIR/git_remote_helpers/build/lib"
582 test -d "$GIT_BUILD_DIR"/git_remote_helpers/build || {
583 error "You haven't built git_remote_helpers yet, have you?"
587 if ! test -x "$GIT_BUILD_DIR"/test-chmtime
589 echo >&2 'You need to build test-chmtime:'
590 echo >&2 'Run "make test-chmtime" in the source (toplevel) directory'
595 test="trash directory.$(basename "$0" .sh)"
596 test -n "$root" && test="$root/$test"
598 /*) TRASH_DIRECTORY="$test" ;;
599 *) TRASH_DIRECTORY="$TEST_OUTPUT_DIRECTORY/$test" ;;
601 test ! -z "$debug" || remove_trash=$TRASH_DIRECTORY
604 echo >&5 "FATAL: Cannot prepare test area"
608 HOME="$TRASH_DIRECTORY"
611 if test -z "$TEST_NO_CREATE_REPO"
613 test_create_repo "$test"
617 # Use -P to resolve symlinks in our working directory so that the cwd
618 # in subprocesses like git equals our $PWD (for pathname comparisons).
619 cd -P "$test" || exit 1
622 this_test=${this_test%%-*}
623 for skp in $GIT_SKIP_TESTS
627 say_color info >&3 "skipping test $this_test altogether"
628 skip_all="skip all tests in $this_test"
633 # Provide an implementation of the 'yes' utility
648 # Fix some commands on Windows
651 # Windows has its own (incompatible) sort and find
661 # git sees Windows-style pwd
665 # no POSIX permissions
666 # backslashes in pathspec are converted to '/'
667 # exec does not inherit the PID
668 test_set_prereq MINGW
669 test_set_prereq NOT_CYGWIN
670 test_set_prereq SED_STRIPS_CR
673 test_set_prereq POSIXPERM
674 test_set_prereq EXECKEEPSPID
675 test_set_prereq NOT_MINGW
676 test_set_prereq CYGWIN
677 test_set_prereq SED_STRIPS_CR
680 test_set_prereq POSIXPERM
681 test_set_prereq BSLASHPSPEC
682 test_set_prereq EXECKEEPSPID
683 test_set_prereq NOT_MINGW
684 test_set_prereq NOT_CYGWIN
688 ( COLUMNS=1 && test $COLUMNS = 1 ) && test_set_prereq COLUMNS_CAN_BE_1
689 test -z "$NO_PERL" && test_set_prereq PERL
690 test -z "$NO_PYTHON" && test_set_prereq PYTHON
691 test -n "$USE_LIBPCRE" && test_set_prereq LIBPCRE
692 test -z "$NO_GETTEXT" && test_set_prereq GETTEXT
694 # Can we rely on git's output in the C locale?
695 if test -n "$GETTEXT_POISON"
697 GIT_GETTEXT_POISON=YesPlease
698 export GIT_GETTEXT_POISON
699 test_set_prereq GETTEXT_POISON
701 test_set_prereq C_LOCALE_OUTPUT
704 # Use this instead of test_cmp to compare files that contain expected and
705 # actual output from git commands that can be translated. When running
706 # under GETTEXT_POISON this pretends that the command produced expected
709 test -n "$GETTEXT_POISON" || test_cmp "$@"
712 # Use this instead of "grep expected-string actual" to see if the
713 # output from a git command that can be translated either contains an
714 # expected string, or does not contain an unwanted one. When running
715 # under GETTEXT_POISON this pretends that the command produced expected
718 if test -n "$GETTEXT_POISON"
721 elif test "x!" = "x$1"
730 test_lazy_prereq PIPE '
731 # test whether the filesystem supports FIFOs
732 rm -f testfifo && mkfifo testfifo
735 test_lazy_prereq SYMLINKS '
736 # test whether the filesystem supports symbolic links
737 ln -s x y && test -h y
740 test_lazy_prereq CASE_INSENSITIVE_FS '
741 echo good >CamelCase &&
742 echo bad >camelcase &&
743 test "$(cat CamelCase)" != good
746 test_lazy_prereq UTF8_NFD_TO_NFC '
747 # check whether FS converts nfd unicode to nfc
748 auml=$(printf "\303\244")
749 aumlcdiar=$(printf "\141\314\210")
759 test_lazy_prereq AUTOIDENT '
760 sane_unset GIT_AUTHOR_NAME &&
761 sane_unset GIT_AUTHOR_EMAIL &&
762 git var GIT_AUTHOR_IDENT
765 # When the tests are run as root, permission tests will report that
766 # things are writable when they shouldn't be.
767 test -w / || test_set_prereq SANITY
769 GIT_UNZIP=${GIT_UNZIP:-unzip}
770 test_lazy_prereq UNZIP '