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)
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[^=]*=\(.*\)')
208 shift ;; # was handled already
210 root
=$
(expr "z$1" : 'z[^=]*=\(.*\)')
213 statusprefix
=$
(expr "z$1" : 'z[^=]*=\(.*\)')
216 echo "error: unknown test option '$1'" >&2; exit 1 ;;
220 if test -n "$valgrind_only"
222 test -z "$valgrind" && valgrind
=memcheck
223 test -z "$verbose" && verbose_only
="$valgrind_only"
224 elif test -n "$valgrind"
237 tput bold
; tput setaf
1;; # bold red
239 tput setaf
4;; # blue
241 tput setaf
3;; # brown/yellow
243 tput setaf
2;; # green
245 tput setaf
6;; # cyan
247 test -n "$quiet" && return;;
257 test -z "$1" && test -n "$quiet" && return
264 say_color error
"error: $*"
273 test "${test_description}" != "" ||
274 error
"Test script did not set test_description."
276 if test "$help" = "t"
278 echo "$test_description"
284 if test "$verbose" = "t"
288 exec 4>/dev
/null
3>/dev
/null
297 test_external_has_tap
=0
301 if test -n "$GIT_EXIT_OK"
305 echo >&5 "FATAL: Unexpected exit with code $code"
313 # The user-facing functions are loaded from a separate file so that
314 # test_perf subshells can have them too
315 .
"$TEST_DIRECTORY/test-lib-functions.sh"
317 # You are not expected to call test_ok_ and test_failure_ directly, use
318 # the text_expect_* functions instead.
321 test_success
=$
(($test_success + 1))
322 say_color
"" "${statusprefix}ok $test_count - $@"
326 test_failure
=$
(($test_failure + 1))
327 say_color error
"${statusprefix}not ok $test_count - $1"
329 echo "$@" |
sed -e 's/^/# /'
330 test "$immediate" = "" ||
{ GIT_EXIT_OK
=t
; exit 1; }
333 test_known_broken_ok_
() {
334 test_fixed
=$
(($test_fixed+1))
335 say_color error
"${statusprefix}ok $test_count - $@ # TODO known breakage vanished"
338 test_known_broken_failure_
() {
339 test_broken
=$
(($test_broken+1))
340 say_color warn
"${statusprefix}not ok $test_count - $@ # TODO known breakage"
344 test "$debug" = "" ||
eval "$1"
347 match_pattern_list
() {
350 test -z "$*" && return 1
361 maybe_teardown_verbose
() {
362 test -z "$verbose_only" && return
363 exec 4>/dev
/null
3>/dev
/null
368 maybe_setup_verbose
() {
369 test -z "$verbose_only" && return
370 if match_pattern_list
$test_count $verbose_only
373 # Emit a delimiting blank line when going from
374 # non-verbose to verbose. Within verbose mode the
375 # delimiter is printed by test_expect_*. The choice
376 # of the initial $last_verbose is such that before
377 # test 1, we do not print it.
378 test -z "$last_verbose" && echo >&3 ""
381 exec 4>/dev
/null
3>/dev
/null
384 last_verbose
=$verbose
387 maybe_teardown_valgrind
() {
388 test -z "$GIT_VALGRIND" && return
389 GIT_VALGRIND_ENABLED
=
392 maybe_setup_valgrind
() {
393 test -z "$GIT_VALGRIND" && return
394 if test -z "$valgrind_only"
396 GIT_VALGRIND_ENABLED
=t
399 GIT_VALGRIND_ENABLED
=
400 if match_pattern_list
$test_count $valgrind_only
402 GIT_VALGRIND_ENABLED
=t
407 # This is a separate function because some tests use
408 # "return" to end a test_expect_success block early.
409 eval </dev
/null
>&3 2>&4 "$*"
418 teardown_malloc_check
420 if test -z "$immediate" ||
test $eval_ret = 0 ||
test -n "$expecting_failure"
423 test_eval_
"$test_cleanup"
424 teardown_malloc_check
426 if test "$verbose" = "t" && test -n "$HARNESS_ACTIVE"
434 test_count
=$
(($test_count+1))
441 maybe_teardown_valgrind
442 maybe_teardown_verbose
447 if match_pattern_list
$this_test.
$test_count $GIT_SKIP_TESTS
451 if test -z "$to_skip" && test -n "$test_prereq" &&
452 ! test_have_prereq
"$test_prereq"
459 if test "$missing_prereq" != "$test_prereq"
461 of_prereq
=" of $test_prereq"
464 say_color skip
>&3 "${statusprefix}skipping test: $@"
465 say_color skip
"${statusprefix}ok $test_count # skip $1 (missing $missing_prereq${of_prereq})"
474 # stub; perf-lib overrides it
475 test_at_end_hook_
() {
482 # Note: t0000 relies on $HARNESS_ACTIVE disabling the .counts
484 if test -z "$HARNESS_ACTIVE"
486 test_results_dir
="$TEST_OUTPUT_DIRECTORY/test-results"
487 mkdir
-p "$test_results_dir"
489 test_results_path
="$test_results_dir/${base%.sh}-$$.counts"
491 cat >>"$test_results_path" <<-EOF
493 success $test_success
501 if test "$test_fixed" != 0
503 say_color error
"${statusprefix}# $test_fixed known breakage(s) vanished; please update test(s)"
505 if test "$test_broken" != 0
507 say_color warn
"${statusprefix}# still have $test_broken known breakage(s)"
509 if test "$test_broken" != 0 ||
test "$test_fixed" != 0
511 test_remaining
=$
(( $test_count - $test_broken - $test_fixed ))
512 msg
="remaining $test_remaining test(s)"
514 test_remaining
=$test_count
515 msg
="$test_count test(s)"
517 case "$test_failure" in
519 # Maybe print SKIP message
520 if test -n "$skip_all" && test $test_count -gt 0
522 error
"Can't use skip_all after running some tests"
524 [ -z "$skip_all" ] || skip_all
=" # SKIP $skip_all"
526 if test $test_external_has_tap -eq 0
528 if test $test_remaining -gt 0
530 say_color pass
"${statusprefix}# passed all $msg"
532 say
"${statusprefix}1..$test_count$skip_all"
535 test -d "$remove_trash" &&
536 cd "$(dirname "$remove_trash")" &&
537 rm -rf "$(basename "$remove_trash")"
544 if test $test_external_has_tap -eq 0
546 say_color error
"${statusprefix}# failed $test_failure among $msg"
547 say
"${statusprefix}1..$test_count"
555 if test -n "$valgrind"
559 test "$1" = "$(readlink "$2")" ||
{
567 while test -d "$2".lock
569 say
"Waiting for lock on $2."
576 make_valgrind_symlink
() {
577 # handle only executables, unless they are shell libraries that
578 # need to be in the exec-path. We will just use "#!" as a
579 # guess for a shell-script, since we have no idea what the user
580 # may have configured as the shell path.
582 test "#!" = "$(head -c 2 <"$1")" ||
585 base
=$
(basename "$1")
586 symlink_target
=$GIT_BUILD_DIR/$base
587 # do not override scripts
588 if test -x "$symlink_target" &&
589 test ! -d "$symlink_target" &&
590 test "#!" != "$(head -c 2 < "$symlink_target")"
592 symlink_target
=..
/valgrind.sh
596 symlink_target
=..
/unprocessed-script
598 # create the link, or replace it if it is out of date
599 make_symlink
"$symlink_target" "$GIT_VALGRIND/bin/$base" ||
exit
602 # override all git executables in TEST_DIRECTORY/..
603 GIT_VALGRIND
=$TEST_DIRECTORY/valgrind
604 mkdir
-p "$GIT_VALGRIND"/bin
605 for file in $GIT_BUILD_DIR/git
* $GIT_BUILD_DIR/test-
*
607 make_valgrind_symlink
$file
609 # special-case the mergetools loadables
610 make_symlink
"$GIT_BUILD_DIR"/mergetools
"$GIT_VALGRIND/bin/mergetools"
615 ls "$path"/git-
* 2> /dev
/null |
618 make_valgrind_symlink
"$file"
622 PATH
=$GIT_VALGRIND/bin
:$PATH
623 GIT_EXEC_PATH
=$GIT_VALGRIND/bin
625 GIT_VALGRIND_MODE
="$valgrind"
626 export GIT_VALGRIND_MODE
627 GIT_VALGRIND_ENABLED
=t
628 test -n "$valgrind_only" && GIT_VALGRIND_ENABLED
=
629 export GIT_VALGRIND_ENABLED
630 elif test -n "$GIT_TEST_INSTALLED"
632 GIT_EXEC_PATH
=$
($GIT_TEST_INSTALLED/git
--exec-path) ||
633 error
"Cannot run git from $GIT_TEST_INSTALLED."
634 PATH
=$GIT_TEST_INSTALLED:$GIT_BUILD_DIR:$PATH
635 GIT_EXEC_PATH
=${GIT_TEST_EXEC_PATH:-$GIT_EXEC_PATH}
636 else # normal case, use ../bin-wrappers only unless $with_dashes:
637 git_bin_dir
="$GIT_BUILD_DIR/bin-wrappers"
638 if ! test -x "$git_bin_dir/git"
640 if test -z "$with_dashes"
642 say
"$git_bin_dir/git is not executable; using GIT_EXEC_PATH"
646 PATH
="$git_bin_dir:$PATH"
647 GIT_EXEC_PATH
=$GIT_BUILD_DIR
648 if test -n "$with_dashes"
650 PATH
="$GIT_BUILD_DIR:$PATH"
653 GIT_TEMPLATE_DIR
="$GIT_BUILD_DIR"/templates
/blt
655 GIT_CONFIG_NOSYSTEM
=1
657 export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG_NOSYSTEM GIT_ATTR_NOSYSTEM
659 if test -z "$GIT_TEST_CMP"
661 if test -n "$GIT_TEST_CMP_USE_COPIED_CONTEXT"
663 GIT_TEST_CMP
="$DIFF -c"
665 GIT_TEST_CMP
="$DIFF -u"
669 GITPERLLIB
="$GIT_BUILD_DIR"/perl
/blib
/lib
:"$GIT_BUILD_DIR"/perl
/blib
/arch
/auto
/Git
671 test -d "$GIT_BUILD_DIR"/templates
/blt ||
{
672 error
"You haven't built things yet, have you?"
675 if test -z "$GIT_TEST_INSTALLED" && test -z "$NO_PYTHON"
677 GITPYTHONLIB
="$GIT_BUILD_DIR/git_remote_helpers/build/lib"
679 test -d "$GIT_BUILD_DIR"/git_remote_helpers
/build ||
{
680 error
"You haven't built git_remote_helpers yet, have you?"
684 if ! test -x "$GIT_BUILD_DIR"/test-chmtime
686 echo >&2 'You need to build test-chmtime:'
687 echo >&2 'Run "make test-chmtime" in the source (toplevel) directory'
692 TRASH_DIRECTORY
="trash directory.$(basename "$0" .sh)"
693 test -n "$root" && TRASH_DIRECTORY
="$root/$TRASH_DIRECTORY"
694 case "$TRASH_DIRECTORY" in
695 /*) ;; # absolute path is good
696 *) TRASH_DIRECTORY
="$TEST_OUTPUT_DIRECTORY/$TRASH_DIRECTORY" ;;
698 test ! -z "$debug" || remove_trash
=$TRASH_DIRECTORY
699 rm -fr "$TRASH_DIRECTORY" ||
{
701 echo >&5 "FATAL: Cannot prepare test area"
705 HOME
="$TRASH_DIRECTORY"
708 if test -z "$TEST_NO_CREATE_REPO"
710 test_create_repo
"$TRASH_DIRECTORY"
712 mkdir
-p "$TRASH_DIRECTORY"
714 # Use -P to resolve symlinks in our working directory so that the cwd
715 # in subprocesses like git equals our $PWD (for pathname comparisons).
716 cd -P "$TRASH_DIRECTORY" ||
exit 1
719 this_test
=${this_test%%-*}
720 if match_pattern_list
"$this_test" $GIT_SKIP_TESTS
722 say_color info
>&3 "skipping test $this_test altogether"
723 skip_all
="skip all tests in $this_test"
727 # Provide an implementation of the 'yes' utility
742 # Fix some commands on Windows
745 # Windows has its own (incompatible) sort and find
755 # git sees Windows-style pwd
759 # no POSIX permissions
760 # backslashes in pathspec are converted to '/'
761 # exec does not inherit the PID
762 test_set_prereq MINGW
763 test_set_prereq NOT_CYGWIN
764 test_set_prereq SED_STRIPS_CR
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
774 test_set_prereq POSIXPERM
775 test_set_prereq BSLASHPSPEC
776 test_set_prereq EXECKEEPSPID
777 test_set_prereq NOT_MINGW
778 test_set_prereq NOT_CYGWIN
782 ( COLUMNS
=1 && test $COLUMNS = 1 ) && test_set_prereq COLUMNS_CAN_BE_1
783 test -z "$NO_PERL" && test_set_prereq PERL
784 test -z "$NO_PYTHON" && test_set_prereq PYTHON
785 test -n "$USE_LIBPCRE" && test_set_prereq LIBPCRE
786 test -z "$NO_GETTEXT" && test_set_prereq GETTEXT
788 # Can we rely on git's output in the C locale?
789 if test -n "$GETTEXT_POISON"
791 GIT_GETTEXT_POISON
=YesPlease
792 export GIT_GETTEXT_POISON
793 test_set_prereq GETTEXT_POISON
795 test_set_prereq C_LOCALE_OUTPUT
798 # Use this instead of test_cmp to compare files that contain expected and
799 # actual output from git commands that can be translated. When running
800 # under GETTEXT_POISON this pretends that the command produced expected
803 test -n "$GETTEXT_POISON" || test_cmp
"$@"
806 # Use this instead of "grep expected-string actual" to see if the
807 # output from a git command that can be translated either contains an
808 # expected string, or does not contain an unwanted one. When running
809 # under GETTEXT_POISON this pretends that the command produced expected
812 if test -n "$GETTEXT_POISON"
815 elif test "x!" = "x$1"
824 test_lazy_prereq PIPE
'
825 # test whether the filesystem supports FIFOs
826 rm -f testfifo && mkfifo testfifo
829 test_lazy_prereq SYMLINKS
'
830 # test whether the filesystem supports symbolic links
831 ln -s x y && test -h y
834 test_lazy_prereq CASE_INSENSITIVE_FS
'
835 echo good >CamelCase &&
836 echo bad >camelcase &&
837 test "$(cat CamelCase)" != good
840 test_lazy_prereq UTF8_NFD_TO_NFC
'
841 # check whether FS converts nfd unicode to nfc
842 auml=$(printf "\303\244")
843 aumlcdiar=$(printf "\141\314\210")
853 test_lazy_prereq AUTOIDENT
'
854 sane_unset GIT_AUTHOR_NAME &&
855 sane_unset GIT_AUTHOR_EMAIL &&
856 git var GIT_AUTHOR_IDENT
859 # When the tests are run as root, permission tests will report that
860 # things are writable when they shouldn't be.
861 test -w / || test_set_prereq SANITY
863 GIT_UNZIP
=${GIT_UNZIP:-unzip}
864 test_lazy_prereq UNZIP
'