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)
199 valgrind
=$
(expr "z$1" : 'z[^=]*=\(.*\)')
202 shift ;; # was handled already
204 root
=$
(expr "z$1" : 'z[^=]*=\(.*\)')
207 echo "error: unknown test option '$1'" >&2; exit 1 ;;
211 test -n "$valgrind" && verbose
=t
221 tput bold
; tput setaf
1;; # bold red
223 tput setaf
4;; # blue
225 tput setaf
3;; # brown/yellow
227 tput setaf
2;; # green
229 tput setaf
6;; # cyan
231 test -n "$quiet" && return;;
241 test -z "$1" && test -n "$quiet" && return
248 say_color error
"error: $*"
257 test "${test_description}" != "" ||
258 error
"Test script did not set test_description."
260 if test "$help" = "t"
262 echo "$test_description"
268 if test "$verbose" = "t"
272 exec 4>/dev
/null
3>/dev
/null
281 test_external_has_tap
=0
285 if test -n "$GIT_EXIT_OK"
289 echo >&5 "FATAL: Unexpected exit with code $code"
297 # The user-facing functions are loaded from a separate file so that
298 # test_perf subshells can have them too
299 .
"$TEST_DIRECTORY/test-lib-functions.sh"
301 # You are not expected to call test_ok_ and test_failure_ directly, use
302 # the text_expect_* functions instead.
305 test_success
=$
(($test_success + 1))
306 say_color
"" "ok $test_count - $@"
310 test_failure
=$
(($test_failure + 1))
311 say_color error
"not ok $test_count - $1"
313 echo "$@" |
sed -e 's/^/# /'
314 test "$immediate" = "" ||
{ GIT_EXIT_OK
=t
; exit 1; }
317 test_known_broken_ok_
() {
318 test_fixed
=$
(($test_fixed+1))
319 say_color error
"ok $test_count - $@ # TODO known breakage vanished"
322 test_known_broken_failure_
() {
323 test_broken
=$
(($test_broken+1))
324 say_color warn
"not ok $test_count - $@ # TODO known breakage"
328 test "$debug" = "" ||
eval "$1"
331 match_pattern_list
() {
334 test -z "$*" && return 1
346 # This is a separate function because some tests use
347 # "return" to end a test_expect_success block early.
348 eval </dev
/null
>&3 2>&4 "$*"
357 teardown_malloc_check
359 if test -z "$immediate" ||
test $eval_ret = 0 ||
test -n "$expecting_failure"
362 test_eval_
"$test_cleanup"
363 teardown_malloc_check
365 if test "$verbose" = "t" && test -n "$HARNESS_ACTIVE"
373 test_count
=$
(($test_count+1))
375 if match_pattern_list
$this_test.
$test_count $GIT_SKIP_TESTS
379 if test -z "$to_skip" && test -n "$test_prereq" &&
380 ! test_have_prereq
"$test_prereq"
387 if test "$missing_prereq" != "$test_prereq"
389 of_prereq
=" of $test_prereq"
392 say_color skip
>&3 "skipping test: $@"
393 say_color skip
"ok $test_count # skip $1 (missing $missing_prereq${of_prereq})"
402 # stub; perf-lib overrides it
403 test_at_end_hook_
() {
410 if test -z "$HARNESS_ACTIVE"
412 test_results_dir
="$TEST_OUTPUT_DIRECTORY/test-results"
413 mkdir
-p "$test_results_dir"
415 test_results_path
="$test_results_dir/${base%.sh}-$$.counts"
417 cat >>"$test_results_path" <<-EOF
419 success $test_success
427 if test "$test_fixed" != 0
429 say_color error
"# $test_fixed known breakage(s) vanished; please update test(s)"
431 if test "$test_broken" != 0
433 say_color warn
"# still have $test_broken known breakage(s)"
435 if test "$test_broken" != 0 ||
test "$test_fixed" != 0
437 test_remaining
=$
(( $test_count - $test_broken - $test_fixed ))
438 msg
="remaining $test_remaining test(s)"
440 test_remaining
=$test_count
441 msg
="$test_count test(s)"
443 case "$test_failure" in
445 # Maybe print SKIP message
446 if test -n "$skip_all" && test $test_count -gt 0
448 error
"Can't use skip_all after running some tests"
450 [ -z "$skip_all" ] || skip_all
=" # SKIP $skip_all"
452 if test $test_external_has_tap -eq 0
454 if test $test_remaining -gt 0
456 say_color pass
"# passed all $msg"
458 say
"1..$test_count$skip_all"
461 test -d "$remove_trash" &&
462 cd "$(dirname "$remove_trash")" &&
463 rm -rf "$(basename "$remove_trash")"
470 if test $test_external_has_tap -eq 0
472 say_color error
"# failed $test_failure among $msg"
481 if test -n "$valgrind"
485 test "$1" = "$(readlink "$2")" ||
{
493 while test -d "$2".lock
495 say
"Waiting for lock on $2."
502 make_valgrind_symlink
() {
503 # handle only executables, unless they are shell libraries that
504 # need to be in the exec-path. We will just use "#!" as a
505 # guess for a shell-script, since we have no idea what the user
506 # may have configured as the shell path.
508 test "#!" = "$(head -c 2 <"$1")" ||
511 base
=$
(basename "$1")
512 symlink_target
=$GIT_BUILD_DIR/$base
513 # do not override scripts
514 if test -x "$symlink_target" &&
515 test ! -d "$symlink_target" &&
516 test "#!" != "$(head -c 2 < "$symlink_target")"
518 symlink_target
=..
/valgrind.sh
522 symlink_target
=..
/unprocessed-script
524 # create the link, or replace it if it is out of date
525 make_symlink
"$symlink_target" "$GIT_VALGRIND/bin/$base" ||
exit
528 # override all git executables in TEST_DIRECTORY/..
529 GIT_VALGRIND
=$TEST_DIRECTORY/valgrind
530 mkdir
-p "$GIT_VALGRIND"/bin
531 for file in $GIT_BUILD_DIR/git
* $GIT_BUILD_DIR/test-
*
533 make_valgrind_symlink
$file
535 # special-case the mergetools loadables
536 make_symlink
"$GIT_BUILD_DIR"/mergetools
"$GIT_VALGRIND/bin/mergetools"
541 ls "$path"/git-
* 2> /dev
/null |
544 make_valgrind_symlink
"$file"
548 PATH
=$GIT_VALGRIND/bin
:$PATH
549 GIT_EXEC_PATH
=$GIT_VALGRIND/bin
551 GIT_VALGRIND_MODE
="$valgrind"
552 export GIT_VALGRIND_MODE
553 elif test -n "$GIT_TEST_INSTALLED"
555 GIT_EXEC_PATH
=$
($GIT_TEST_INSTALLED/git
--exec-path) ||
556 error
"Cannot run git from $GIT_TEST_INSTALLED."
557 PATH
=$GIT_TEST_INSTALLED:$GIT_BUILD_DIR:$PATH
558 GIT_EXEC_PATH
=${GIT_TEST_EXEC_PATH:-$GIT_EXEC_PATH}
559 else # normal case, use ../bin-wrappers only unless $with_dashes:
560 git_bin_dir
="$GIT_BUILD_DIR/bin-wrappers"
561 if ! test -x "$git_bin_dir/git"
563 if test -z "$with_dashes"
565 say
"$git_bin_dir/git is not executable; using GIT_EXEC_PATH"
569 PATH
="$git_bin_dir:$PATH"
570 GIT_EXEC_PATH
=$GIT_BUILD_DIR
571 if test -n "$with_dashes"
573 PATH
="$GIT_BUILD_DIR:$PATH"
576 GIT_TEMPLATE_DIR
="$GIT_BUILD_DIR"/templates
/blt
578 GIT_CONFIG_NOSYSTEM
=1
580 export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG_NOSYSTEM GIT_ATTR_NOSYSTEM
582 if test -z "$GIT_TEST_CMP"
584 if test -n "$GIT_TEST_CMP_USE_COPIED_CONTEXT"
586 GIT_TEST_CMP
="$DIFF -c"
588 GIT_TEST_CMP
="$DIFF -u"
592 GITPERLLIB
="$GIT_BUILD_DIR"/perl
/blib
/lib
:"$GIT_BUILD_DIR"/perl
/blib
/arch
/auto
/Git
594 test -d "$GIT_BUILD_DIR"/templates
/blt ||
{
595 error
"You haven't built things yet, have you?"
598 if test -z "$GIT_TEST_INSTALLED" && test -z "$NO_PYTHON"
600 GITPYTHONLIB
="$GIT_BUILD_DIR/git_remote_helpers/build/lib"
602 test -d "$GIT_BUILD_DIR"/git_remote_helpers
/build ||
{
603 error
"You haven't built git_remote_helpers yet, have you?"
607 if ! test -x "$GIT_BUILD_DIR"/test-chmtime
609 echo >&2 'You need to build test-chmtime:'
610 echo >&2 'Run "make test-chmtime" in the source (toplevel) directory'
615 TRASH_DIRECTORY
="trash directory.$(basename "$0" .sh)"
616 test -n "$root" && TRASH_DIRECTORY
="$root/$TRASH_DIRECTORY"
617 case "$TRASH_DIRECTORY" in
618 /*) ;; # absolute path is good
619 *) TRASH_DIRECTORY
="$TEST_OUTPUT_DIRECTORY/$TRASH_DIRECTORY" ;;
621 test ! -z "$debug" || remove_trash
=$TRASH_DIRECTORY
622 rm -fr "$TRASH_DIRECTORY" ||
{
624 echo >&5 "FATAL: Cannot prepare test area"
628 HOME
="$TRASH_DIRECTORY"
631 if test -z "$TEST_NO_CREATE_REPO"
633 test_create_repo
"$TRASH_DIRECTORY"
635 mkdir
-p "$TRASH_DIRECTORY"
637 # Use -P to resolve symlinks in our working directory so that the cwd
638 # in subprocesses like git equals our $PWD (for pathname comparisons).
639 cd -P "$TRASH_DIRECTORY" ||
exit 1
642 this_test
=${this_test%%-*}
643 if match_pattern_list
"$this_test" $GIT_SKIP_TESTS
645 say_color info
>&3 "skipping test $this_test altogether"
646 skip_all
="skip all tests in $this_test"
650 # Provide an implementation of the 'yes' utility
665 # Fix some commands on Windows
668 # Windows has its own (incompatible) sort and find
678 # git sees Windows-style pwd
682 # no POSIX permissions
683 # backslashes in pathspec are converted to '/'
684 # exec does not inherit the PID
685 test_set_prereq MINGW
686 test_set_prereq NOT_CYGWIN
687 test_set_prereq SED_STRIPS_CR
690 test_set_prereq POSIXPERM
691 test_set_prereq EXECKEEPSPID
692 test_set_prereq NOT_MINGW
693 test_set_prereq CYGWIN
694 test_set_prereq SED_STRIPS_CR
697 test_set_prereq POSIXPERM
698 test_set_prereq BSLASHPSPEC
699 test_set_prereq EXECKEEPSPID
700 test_set_prereq NOT_MINGW
701 test_set_prereq NOT_CYGWIN
705 ( COLUMNS
=1 && test $COLUMNS = 1 ) && test_set_prereq COLUMNS_CAN_BE_1
706 test -z "$NO_PERL" && test_set_prereq PERL
707 test -z "$NO_PYTHON" && test_set_prereq PYTHON
708 test -n "$USE_LIBPCRE" && test_set_prereq LIBPCRE
709 test -z "$NO_GETTEXT" && test_set_prereq GETTEXT
711 # Can we rely on git's output in the C locale?
712 if test -n "$GETTEXT_POISON"
714 GIT_GETTEXT_POISON
=YesPlease
715 export GIT_GETTEXT_POISON
716 test_set_prereq GETTEXT_POISON
718 test_set_prereq C_LOCALE_OUTPUT
721 # Use this instead of test_cmp to compare files that contain expected and
722 # actual output from git commands that can be translated. When running
723 # under GETTEXT_POISON this pretends that the command produced expected
726 test -n "$GETTEXT_POISON" || test_cmp
"$@"
729 # Use this instead of "grep expected-string actual" to see if the
730 # output from a git command that can be translated either contains an
731 # expected string, or does not contain an unwanted one. When running
732 # under GETTEXT_POISON this pretends that the command produced expected
735 if test -n "$GETTEXT_POISON"
738 elif test "x!" = "x$1"
747 test_lazy_prereq PIPE
'
748 # test whether the filesystem supports FIFOs
749 rm -f testfifo && mkfifo testfifo
752 test_lazy_prereq SYMLINKS
'
753 # test whether the filesystem supports symbolic links
754 ln -s x y && test -h y
757 test_lazy_prereq CASE_INSENSITIVE_FS
'
758 echo good >CamelCase &&
759 echo bad >camelcase &&
760 test "$(cat CamelCase)" != good
763 test_lazy_prereq UTF8_NFD_TO_NFC
'
764 # check whether FS converts nfd unicode to nfc
765 auml=$(printf "\303\244")
766 aumlcdiar=$(printf "\141\314\210")
776 test_lazy_prereq AUTOIDENT
'
777 sane_unset GIT_AUTHOR_NAME &&
778 sane_unset GIT_AUTHOR_EMAIL &&
779 git var GIT_AUTHOR_IDENT
782 # When the tests are run as root, permission tests will report that
783 # things are writable when they shouldn't be.
784 test -w / || test_set_prereq SANITY
786 GIT_UNZIP
=${GIT_UNZIP:-unzip}
787 test_lazy_prereq UNZIP
'