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 # if --tee was passed, write the output not only to the terminal, but
19 # additionally to the file test-results/$BASENAME.out, too.
20 case "$GIT_TEST_TEE_STARTED, $* " in
22 # do not redirect again
24 *' --tee '*|
*' --va'*)
26 BASE
=test-results
/$
(basename "$0" .sh
)
27 (GIT_TEST_TEE_STARTED
=done ${SHELL-sh} "$0" "$@" 2>&1;
28 echo $?
> $BASE.
exit) |
tee $BASE.out
29 test "$(cat $BASE.exit)" = 0
34 # Keep the original TERM for say_color
37 # For repeatability, reset the environment to known value.
43 export LANG LC_ALL PAGER TERM TZ
50 unset COMMIT_AUTHOR_EMAIL
51 unset COMMIT_AUTHOR_NAME
53 unset GIT_ALTERNATE_OBJECT_DIRECTORIES
55 GIT_AUTHOR_EMAIL
=author@example.com
56 GIT_AUTHOR_NAME
='A U Thor'
57 unset GIT_COMMITTER_DATE
58 GIT_COMMITTER_EMAIL
=committer@example.com
59 GIT_COMMITTER_NAME
='C O Mitter'
63 unset GIT_EXTERNAL_DIFF
65 unset GIT_OBJECT_DIRECTORY
66 unset GIT_CEILING_DIRECTORIES
67 unset SHA1_FILE_DIRECTORIES
68 unset SHA1_FILE_DIRECTORY
70 unset GIT_NOTES_DISPLAY_REF
71 unset GIT_NOTES_REWRITE_REF
72 unset GIT_NOTES_REWRITE_MODE
74 export GIT_MERGE_VERBOSITY
75 export GIT_AUTHOR_EMAIL GIT_AUTHOR_NAME
76 export GIT_COMMITTER_EMAIL GIT_COMMITTER_NAME
79 # Protect ourselves from common misconfiguration to export
80 # CDPATH into the environment
85 case $
(echo $GIT_TRACE |
tr "[A-Z]" "[a-z]") in
87 echo "* warning: Some tests will not work if GIT_TRACE" \
88 "is set as to trace on STDERR ! *"
89 echo "* warning: Please set GIT_TRACE to something" \
90 "other than 1, 2 or true ! *"
96 # A regexp to match 5 and 40 hexdigits
97 _x05
='[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
98 _x40
="$_x05$_x05$_x05$_x05$_x05$_x05$_x05$_x05"
100 # Each test should start with something like this, after copyright notices:
102 # test_description='Description of this test...
103 # This test checks if command xyzzy does the right thing...
106 [ "x$ORIGINAL_TERM" != "xdumb" ] && (
107 TERM
=$ORIGINAL_TERM &&
110 tput bold
>/dev
/null
2>&1 &&
111 tput setaf
1 >/dev
/null
2>&1 &&
112 tput sgr0
>/dev
/null
2>&1
116 while test "$#" -ne 0
119 -d|
--d|
--de|
--deb|
--debu|
--debug)
121 -i|
--i|
--im|
--imm|
--imme|
--immed|
--immedi|
--immedia|
--immediat|
--immediate)
122 immediate
=t
; shift ;;
123 -l|
--l|
--lo|
--lon|
--long|
--long-|
--long-t|
--long-te|
--long-tes|
--long-test|
--long-tests)
124 GIT_TEST_LONG
=t
; export GIT_TEST_LONG
; shift ;;
125 -h|
--h|
--he|
--hel|
--help)
127 -v|
--v|
--ve|
--ver|
--verb|
--verbo|
--verbos|
--verbose)
129 -q|
--q|
--qu|
--qui|
--quie|
--quiet)
130 # Ignore --quiet under a TAP::Harness. Saying how many tests
131 # passed without the ok/not ok details is always an error.
132 test -z "$HARNESS_ACTIVE" && quiet
=t
; shift ;;
134 with_dashes
=t
; shift ;;
140 --va|
--val|
--valg|
--valgr|
--valgri|
--valgrin|
--valgrind)
141 valgrind
=t
; verbose
=t
; shift ;;
143 shift ;; # was handled already
145 root
=$
(expr "z$1" : 'z[^=]*=\(.*\)')
148 echo "error: unknown test option '$1'" >&2; exit 1 ;;
152 if test -n "$color"; then
158 error
) tput bold
; tput setaf
1;; # bold red
159 skip
) tput bold
; tput setaf
2;; # bold green
160 pass
) tput setaf
2;; # green
161 info
) tput setaf
3;; # brown
162 *) test -n "$quiet" && return;;
172 test -z "$1" && test -n "$quiet" && return
179 say_color error
"error: $*"
188 test "${test_description}" != "" ||
189 error
"Test script did not set test_description."
191 if test "$help" = "t"
193 echo "$test_description"
198 if test "$verbose" = "t"
202 exec 4>/dev
/null
3>/dev
/null
211 test_external_has_tap
=0
215 if test -n "$GIT_EXIT_OK"
219 echo >&5 "FATAL: Unexpected exit with code $code"
227 # The semantics of the editor variables are that of invoking
228 # sh -c "$EDITOR \"$@\"" files ...
230 # If our trash directory contains shell metacharacters, they will be
231 # interpreted if we just set $EDITOR directly, so do a little dance with
232 # environment variables to work around this.
234 # In particular, quoting isn't enough, as the path may contain the same quote
239 EDITOR
='"$FAKE_EDITOR"'
243 test_decode_color
() {
244 sed -e 's/.\[1m/<WHITE>/g' \
245 -e 's/.\[31m/<RED>/g' \
246 -e 's/.\[32m/<GREEN>/g' \
247 -e 's/.\[33m/<YELLOW>/g' \
248 -e 's/.\[34m/<BLUE>/g' \
249 -e 's/.\[35m/<MAGENTA>/g' \
250 -e 's/.\[36m/<CYAN>/g' \
251 -e 's/.\[m/<RESET>/g'
263 sed -e 's/$/Q/' |
tr Q
'\015'
267 tr '\015' Q |
sed -e 's/Q$//'
271 if test -z "${test_tick+set}"
275 test_tick
=$
(($test_tick + 60))
277 GIT_COMMITTER_DATE
="$test_tick -0700"
278 GIT_AUTHOR_DATE
="$test_tick -0700"
279 export GIT_COMMITTER_DATE GIT_AUTHOR_DATE
282 # Call test_commit with the arguments "<message> [<file> [<contents>]]"
284 # This will commit a file with the given contents and the given commit
285 # message. It will also add a tag with <message> as name.
287 # Both <file> and <contents> default to <message>.
291 echo "${3-$1}" > "$file" &&
294 git commit
-m "$1" &&
298 # Call test_merge with the arguments "<message> <commit>", where <commit>
299 # can be a tag pointing to the commit-to-merge.
303 git merge
-m "$1" "$2" &&
307 # This function helps systems where core.filemode=false is set.
308 # Use it instead of plain 'chmod +x' to set or unset the executable bit
309 # of a file in the working directory and add it to the index.
313 git update-index
--add "--chmod=$@"
316 # Use test_set_prereq to tell that a particular prerequisite is available.
317 # The prerequisite can later be checked for in two ways:
319 # - Explicitly using test_have_prereq.
321 # - Implicitly by specifying the prerequisite tag in the calls to
322 # test_expect_{success,failure,code}.
324 # The single parameter is the prerequisite tag (a simple word, in all
325 # capital letters by convention).
328 satisfied
="$satisfied$1 "
332 test_have_prereq
() {
341 # You are not expected to call test_ok_ and test_failure_ directly, use
342 # the text_expect_* functions instead.
345 test_success
=$
(($test_success + 1))
346 say_color
"" "ok $test_count - $@"
350 test_failure
=$
(($test_failure + 1))
351 say_color error
"not ok - $test_count $1"
353 echo "$@" |
sed -e 's/^/# /'
354 test "$immediate" = "" ||
{ GIT_EXIT_OK
=t
; exit 1; }
357 test_known_broken_ok_
() {
358 test_fixed
=$
(($test_fixed+1))
359 say_color
"" "ok $test_count - $@ # TODO known breakage"
362 test_known_broken_failure_
() {
363 test_broken
=$
(($test_broken+1))
364 say_color skip
"not ok $test_count - $@ # TODO known breakage"
368 test "$debug" = "" ||
eval "$1"
375 eval >&3 2>&4 "$test_cleanup"
376 if test "$verbose" = "t" && test -n "$HARNESS_ACTIVE"; then
383 test_count
=$
(($test_count+1))
385 for skp
in $GIT_SKIP_TESTS
387 case $this_test.
$test_count in
392 if test -z "$to_skip" && test -n "$prereq" &&
393 ! test_have_prereq
"$prereq"
399 say_color skip
>&3 "skipping test: $@"
400 say_color skip
"ok $test_count: # skip $1"
409 test_expect_failure
() {
410 test "$#" = 3 && { prereq
=$1; shift; } || prereq
=
412 error
"bug in the test script: not 2 or 3 parameters to test-expect-failure"
415 say
>&3 "checking known breakage: $2"
417 if [ "$?" = 0 -a "$eval_ret" = 0 ]
419 test_known_broken_ok_
"$1"
421 test_known_broken_failure_
"$1"
427 test_expect_success
() {
428 test "$#" = 3 && { prereq
=$1; shift; } || prereq
=
430 error
"bug in the test script: not 2 or 3 parameters to test-expect-success"
433 say
>&3 "expecting success: $2"
435 if [ "$?" = 0 -a "$eval_ret" = 0 ]
445 test_expect_code
() {
446 test "$#" = 4 && { prereq
=$1; shift; } || prereq
=
448 error
"bug in the test script: not 3 or 4 parameters to test-expect-code"
451 say
>&3 "expecting exit code $1: $3"
453 if [ "$?" = 0 -a "$eval_ret" = "$1" ]
463 # test_external runs external test scripts that provide continuous
464 # test output about their progress, and succeeds/fails on
465 # zero/non-zero exit code. It outputs the test output on stdout even
466 # in non-verbose mode, and announces the external script with "# run
467 # <n>: ..." before running it. When providing relative paths, keep in
468 # mind that all scripts run in "trash directory".
469 # Usage: test_external description command arguments...
470 # Example: test_external 'Perl API' perl ../path/to/test.pl
472 test "$#" = 4 && { prereq
=$1; shift; } || prereq
=
474 error
>&5 "bug in the test script: not 3 or 4 parameters to test_external"
477 if ! test_skip
"$descr" "$@"
479 # Announce the script to reduce confusion about the
480 # test output that follows.
481 say_color
"" "# run $test_count: $descr ($*)"
482 # Export TEST_DIRECTORY, TRASH_DIRECTORY and GIT_TEST_LONG
483 # to be able to use them in script
484 export TEST_DIRECTORY TRASH_DIRECTORY GIT_TEST_LONG
485 # Run command; redirect its stderr to &4 as in
486 # test_run_, but keep its stdout on our stdout even in
491 if test $test_external_has_tap -eq 0; then
494 say_color
"" "# test_external test $descr was ok"
495 test_success
=$
(($test_success + 1))
498 if test $test_external_has_tap -eq 0; then
499 test_failure_
"$descr" "$@"
501 say_color error
"# test_external test $descr failed: $@"
502 test_failure
=$
(($test_failure + 1))
508 # Like test_external, but in addition tests that the command generated
509 # no output on stderr.
510 test_external_without_stderr
() {
511 # The temporary file has no (and must have no) security
513 tmp
="$TMPDIR"; if [ -z "$tmp" ]; then tmp
=/tmp
; fi
514 stderr
="$tmp/git-external-stderr.$$.tmp"
515 test_external
"$@" 4> "$stderr"
516 [ -f "$stderr" ] || error
"Internal error: $stderr disappeared."
517 descr
="no stderr: $1"
519 say
>&3 "# expecting no stderr from previous command"
520 if [ ! -s "$stderr" ]; then
523 if test $test_external_has_tap -eq 0; then
526 say_color
"" "# test_external_without_stderr test $descr was ok"
527 test_success
=$
(($test_success + 1))
530 if [ "$verbose" = t
]; then
531 output
=`echo; echo "# Stderr is:"; cat "$stderr"`
535 # rm first in case test_failure exits.
537 if test $test_external_has_tap -eq 0; then
538 test_failure_
"$descr" "$@" "$output"
540 say_color error
"# test_external_without_stderr test $descr failed: $@: $output"
541 test_failure
=$
(($test_failure + 1))
546 # This is not among top-level (test_expect_success | test_expect_failure)
547 # but is a prefix that can be used in the test script, like:
549 # test_expect_success 'complain and die' '
551 # do something else &&
552 # test_must_fail git checkout ../outerspace
555 # Writing this as "! git checkout ../outerspace" is wrong, because
556 # the failure could be due to a segv. We want a controlled failure.
560 test $?
-gt 0 -a $?
-le 129 -o $?
-gt 192
563 # Similar to test_must_fail, but tolerates success, too. This is
564 # meant to be used in contexts like:
566 # test_expect_success 'some command works without configuration' '
567 # test_might_fail git config --unset all.configuration &&
571 # Writing "git config --unset all.configuration || :" would be wrong,
572 # because we want to notice if it fails due to segv.
576 test $?
-ge 0 -a $?
-le 129 -o $?
-gt 192
579 # test_cmp is a helper function to compare actual and expected output.
580 # You can use it like:
582 # test_expect_success 'foo works' '
583 # echo expected >expected &&
585 # test_cmp expected actual
588 # This could be written as either "cmp" or "diff -u", but:
589 # - cmp's output is not nearly as easy to read as diff -u
590 # - not all diff versions understand "-u"
596 # This function can be used to schedule some commands to be run
597 # unconditionally at the end of the test to restore sanity:
599 # test_expect_success 'test core.capslock' '
600 # git config core.capslock true &&
601 # test_when_finished "git config --unset core.capslock" &&
605 # That would be roughly equivalent to
607 # test_expect_success 'test core.capslock' '
608 # git config core.capslock true &&
610 # git config --unset core.capslock
613 # except that the greeting and config --unset must both succeed for
616 test_when_finished
() {
618 } && (exit \"\$eval_ret\"); eval_ret=\$?; $test_cleanup"
621 # Most tests can use the created repository, but some may need to create more.
622 # Usage: test_create_repo <directory>
623 test_create_repo
() {
625 error
"bug in the test script: not 1 parameter to test-create-repo"
629 cd "$repo" || error
"Cannot setup test environment"
630 "$GIT_EXEC_PATH/git-init" "--template=$TEST_DIRECTORY/../templates/blt/" >&3 2>&4 ||
631 error
"cannot run git init -- have you built things yet?"
632 mv .git
/hooks .git
/hooks-disabled
638 test_results_dir
="$TEST_DIRECTORY/test-results"
639 mkdir
-p "$test_results_dir"
640 test_results_path
="$test_results_dir/${0%.sh}-$$"
642 echo "total $test_count" >> $test_results_path
643 echo "success $test_success" >> $test_results_path
644 echo "fixed $test_fixed" >> $test_results_path
645 echo "broken $test_broken" >> $test_results_path
646 echo "failed $test_failure" >> $test_results_path
647 echo "" >> $test_results_path
649 if test "$test_fixed" != 0
651 say_color pass
"# fixed $test_fixed known breakage(s)"
653 if test "$test_broken" != 0
655 say_color error
"# still have $test_broken known breakage(s)"
656 msg
="remaining $(($test_count-$test_broken)) test(s)"
658 msg
="$test_count test(s)"
660 case "$test_failure" in
662 # Maybe print SKIP message
663 [ -z "$skip_all" ] || skip_all
=" # SKIP $skip_all"
665 if test $test_external_has_tap -eq 0; then
666 say_color pass
"# passed all $msg"
667 say
"1..$test_count$skip_all"
670 test -d "$remove_trash" &&
671 cd "$(dirname "$remove_trash")" &&
672 rm -rf "$(basename "$remove_trash")"
677 if test $test_external_has_tap -eq 0; then
678 say_color error
"# failed $test_failure among $msg"
687 # Test the binaries we have just built. The tests are kept in
688 # t/ subdirectory and are run in 'trash directory' subdirectory.
689 TEST_DIRECTORY
=$
(pwd)
690 if test -n "$valgrind"
694 test "$1" = "$(readlink "$2")" ||
{
702 while test -d "$2".lock
704 say
"Waiting for lock on $2."
711 make_valgrind_symlink
() {
712 # handle only executables
713 test -x "$1" ||
return
715 base
=$
(basename "$1")
716 symlink_target
=$TEST_DIRECTORY/..
/$base
717 # do not override scripts
718 if test -x "$symlink_target" &&
719 test ! -d "$symlink_target" &&
720 test "#!" != "$(head -c 2 < "$symlink_target")"
722 symlink_target
=..
/valgrind.sh
726 symlink_target
=..
/unprocessed-script
728 # create the link, or replace it if it is out of date
729 make_symlink
"$symlink_target" "$GIT_VALGRIND/bin/$base" ||
exit
732 # override all git executables in TEST_DIRECTORY/..
733 GIT_VALGRIND
=$TEST_DIRECTORY/valgrind
734 mkdir
-p "$GIT_VALGRIND"/bin
735 for file in $TEST_DIRECTORY/..
/git
* $TEST_DIRECTORY/..
/test-
*
737 make_valgrind_symlink
$file
743 ls "$path"/git-
* 2> /dev
/null |
746 make_valgrind_symlink
"$file"
750 PATH
=$GIT_VALGRIND/bin
:$PATH
751 GIT_EXEC_PATH
=$GIT_VALGRIND/bin
753 elif test -n "$GIT_TEST_INSTALLED" ; then
754 GIT_EXEC_PATH
=$
($GIT_TEST_INSTALLED/git
--exec-path) ||
755 error
"Cannot run git from $GIT_TEST_INSTALLED."
756 PATH
=$GIT_TEST_INSTALLED:$TEST_DIRECTORY/..
:$PATH
757 GIT_EXEC_PATH
=${GIT_TEST_EXEC_PATH:-$GIT_EXEC_PATH}
758 else # normal case, use ../bin-wrappers only unless $with_dashes:
759 git_bin_dir
="$TEST_DIRECTORY/../bin-wrappers"
760 if ! test -x "$git_bin_dir/git" ; then
761 if test -z "$with_dashes" ; then
762 say
"$git_bin_dir/git is not executable; using GIT_EXEC_PATH"
766 PATH
="$git_bin_dir:$PATH"
767 GIT_EXEC_PATH
=$TEST_DIRECTORY/..
768 if test -n "$with_dashes" ; then
769 PATH
="$TEST_DIRECTORY/..:$PATH"
772 GIT_TEMPLATE_DIR
=$
(pwd)/..
/templates
/blt
774 GIT_CONFIG_NOSYSTEM
=1
775 GIT_CONFIG_NOGLOBAL
=1
776 export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG_NOSYSTEM GIT_CONFIG_NOGLOBAL
778 . ..
/GIT-BUILD-OPTIONS
780 if test -z "$GIT_TEST_CMP"
782 if test -n "$GIT_TEST_CMP_USE_COPIED_CONTEXT"
784 GIT_TEST_CMP
="$DIFF -c"
786 GIT_TEST_CMP
="$DIFF -u"
790 GITPERLLIB
=$
(pwd)/..
/perl
/blib
/lib
:$
(pwd)/..
/perl
/blib
/arch
/auto
/Git
792 test -d ..
/templates
/blt ||
{
793 error
"You haven't built things yet, have you?"
796 if test -z "$GIT_TEST_INSTALLED" && test -z "$NO_PYTHON"
798 GITPYTHONLIB
="$(pwd)/../git_remote_helpers/build/lib"
800 test -d ..
/git_remote_helpers
/build ||
{
801 error
"You haven't built git_remote_helpers yet, have you?"
805 if ! test -x ..
/test-chmtime
; then
806 echo >&2 'You need to build test-chmtime:'
807 echo >&2 'Run "make test-chmtime" in the source (toplevel) directory'
812 test="trash directory.$(basename "$0" .sh)"
813 test -n "$root" && test="$root/$test"
815 /*) TRASH_DIRECTORY
="$test" ;;
816 *) TRASH_DIRECTORY
="$TEST_DIRECTORY/$test" ;;
818 test ! -z "$debug" || remove_trash
=$TRASH_DIRECTORY
821 echo >&5 "FATAL: Cannot prepare test area"
825 test_create_repo
"$test"
826 # Use -P to resolve symlinks in our working directory so that the cwd
827 # in subprocesses like git equals our $PWD (for pathname comparisons).
828 cd -P "$test" ||
exit 1
831 this_test
=${this_test%%-*}
832 for skp
in $GIT_SKIP_TESTS
835 for skp
in $GIT_SKIP_TESTS
844 say_color skip
>&3 "skipping test $this_test altogether"
845 say_color skip
"skip all tests in $this_test"
850 # Provide an implementation of the 'yes' utility
865 # Fix some commands on Windows
868 # Windows has its own (incompatible) sort and find
878 # git sees Windows-style pwd
882 # no POSIX permissions
883 # backslashes in pathspec are converted to '/'
884 # exec does not inherit the PID
887 test_set_prereq POSIXPERM
888 test_set_prereq BSLASHPSPEC
889 test_set_prereq EXECKEEPSPID
893 test -z "$NO_PERL" && test_set_prereq PERL
894 test -z "$NO_PYTHON" && test_set_prereq PYTHON
896 # test whether the filesystem supports symbolic links
897 ln -s x y
2>/dev
/null
&& test -h y
2>/dev
/null
&& test_set_prereq SYMLINKS