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 ;;
137 --va|--val|--valg|--valgr|--valgri|--valgrin|--valgrind)
138 valgrind=t; verbose=t; shift ;;
140 shift ;; # was handled already
142 root=$(expr "z$1" : 'z[^=]*=\(.*\)')
145 echo "error: unknown test option '$1'" >&2; exit 1 ;;
149 if test -n "$color"; then
155 error) tput bold; tput setaf 1;; # bold red
156 skip) tput bold; tput setaf 2;; # bold green
157 pass) tput setaf 2;; # green
158 info) tput setaf 3;; # brown
159 *) test -n "$quiet" && return;;
169 test -z "$1" && test -n "$quiet" && return
176 say_color error "error: $*"
185 test "${test_description}" != "" ||
186 error "Test script did not set test_description."
188 if test "$help" = "t"
190 echo "$test_description"
195 if test "$verbose" = "t"
199 exec 4>/dev/null 3>/dev/null
208 test_external_has_tap=0
212 if test -n "$GIT_EXIT_OK"
216 echo >&5 "FATAL: Unexpected exit with code $code"
224 # The semantics of the editor variables are that of invoking
225 # sh -c "$EDITOR \"$@\"" files ...
227 # If our trash directory contains shell metacharacters, they will be
228 # interpreted if we just set $EDITOR directly, so do a little dance with
229 # environment variables to work around this.
231 # In particular, quoting isn't enough, as the path may contain the same quote
236 EDITOR='"$FAKE_EDITOR"'
240 test_decode_color () {
241 sed -e 's/.\[1m/<WHITE>/g' \
242 -e 's/.\[31m/<RED>/g' \
243 -e 's/.\[32m/<GREEN>/g' \
244 -e 's/.\[33m/<YELLOW>/g' \
245 -e 's/.\[34m/<BLUE>/g' \
246 -e 's/.\[35m/<MAGENTA>/g' \
247 -e 's/.\[36m/<CYAN>/g' \
248 -e 's/.\[m/<RESET>/g'
260 sed -e 's/$/Q/' | tr Q '\015'
264 tr '\015' Q | sed -e 's/Q$//'
268 if test -z "${test_tick+set}"
272 test_tick=$(($test_tick + 60))
274 GIT_COMMITTER_DATE="$test_tick -0700"
275 GIT_AUTHOR_DATE="$test_tick -0700"
276 export GIT_COMMITTER_DATE GIT_AUTHOR_DATE
279 # Call test_commit with the arguments "<message> [<file> [<contents>]]"
281 # This will commit a file with the given contents and the given commit
282 # message. It will also add a tag with <message> as name.
284 # Both <file> and <contents> default to <message>.
288 echo "${3-$1}" > "$file" &&
291 git commit -m "$1" &&
295 # Call test_merge with the arguments "<message> <commit>", where <commit>
296 # can be a tag pointing to the commit-to-merge.
300 git merge -m "$1" "$2" &&
304 # This function helps systems where core.filemode=false is set.
305 # Use it instead of plain 'chmod +x' to set or unset the executable bit
306 # of a file in the working directory and add it to the index.
310 git update-index --add "--chmod=$@"
313 # Use test_set_prereq to tell that a particular prerequisite is available.
314 # The prerequisite can later be checked for in two ways:
316 # - Explicitly using test_have_prereq.
318 # - Implicitly by specifying the prerequisite tag in the calls to
319 # test_expect_{success,failure,code}.
321 # The single parameter is the prerequisite tag (a simple word, in all
322 # capital letters by convention).
325 satisfied="$satisfied$1 "
329 test_have_prereq () {
330 # prerequisites can be concatenated with ','
342 total_prereq=$(($total_prereq + 1))
345 ok_prereq=$(($ok_prereq + 1))
348 # Keep a list of missing prerequisites
349 if test -z "$missing_prereq"
351 missing_prereq=$prerequisite
353 missing_prereq="$prerequisite,$missing_prereq"
358 test $total_prereq = $ok_prereq
361 # You are not expected to call test_ok_ and test_failure_ directly, use
362 # the text_expect_* functions instead.
365 test_success=$(($test_success + 1))
366 say_color "" "ok $test_count - $@"
370 test_failure=$(($test_failure + 1))
371 say_color error "not ok - $test_count $1"
373 echo "$@" | sed -e 's/^/# /'
374 test "$immediate" = "" || { GIT_EXIT_OK=t; exit 1; }
377 test_known_broken_ok_ () {
378 test_fixed=$(($test_fixed+1))
379 say_color "" "ok $test_count - $@ # TODO known breakage"
382 test_known_broken_failure_ () {
383 test_broken=$(($test_broken+1))
384 say_color skip "not ok $test_count - $@ # TODO known breakage"
388 test "$debug" = "" || eval "$1"
395 eval >&3 2>&4 "$test_cleanup"
396 if test "$verbose" = "t" && test -n "$HARNESS_ACTIVE"; then
403 test_count=$(($test_count+1))
405 for skp in $GIT_SKIP_TESTS
407 case $this_test.$test_count in
413 if test -z "$to_skip" && test -n "$prereq" &&
414 ! test_have_prereq "$prereq"
421 if test "$missing_prereq" != "$prereq"
423 of_prereq=" of $prereq"
426 say_color skip >&3 "skipping test: $@"
427 say_color skip "ok $test_count # skip $1 (missing $missing_prereq${of_prereq})"
436 test_expect_failure () {
437 test "$#" = 3 && { prereq=$1; shift; } || prereq=
439 error "bug in the test script: not 2 or 3 parameters to test-expect-failure"
442 say >&3 "checking known breakage: $2"
444 if [ "$?" = 0 -a "$eval_ret" = 0 ]
446 test_known_broken_ok_ "$1"
448 test_known_broken_failure_ "$1"
454 test_expect_success () {
455 test "$#" = 3 && { prereq=$1; shift; } || prereq=
457 error "bug in the test script: not 2 or 3 parameters to test-expect-success"
460 say >&3 "expecting success: $2"
462 if [ "$?" = 0 -a "$eval_ret" = 0 ]
472 test_expect_code () {
473 test "$#" = 4 && { prereq=$1; shift; } || prereq=
475 error "bug in the test script: not 3 or 4 parameters to test-expect-code"
478 say >&3 "expecting exit code $1: $3"
480 if [ "$?" = 0 -a "$eval_ret" = "$1" ]
490 # test_external runs external test scripts that provide continuous
491 # test output about their progress, and succeeds/fails on
492 # zero/non-zero exit code. It outputs the test output on stdout even
493 # in non-verbose mode, and announces the external script with "# run
494 # <n>: ..." before running it. When providing relative paths, keep in
495 # mind that all scripts run in "trash directory".
496 # Usage: test_external description command arguments...
497 # Example: test_external 'Perl API' perl ../path/to/test.pl
499 test "$#" = 4 && { prereq=$1; shift; } || prereq=
501 error >&5 "bug in the test script: not 3 or 4 parameters to test_external"
504 if ! test_skip "$descr" "$@"
506 # Announce the script to reduce confusion about the
507 # test output that follows.
508 say_color "" "# run $test_count: $descr ($*)"
509 # Export TEST_DIRECTORY, TRASH_DIRECTORY and GIT_TEST_LONG
510 # to be able to use them in script
511 export TEST_DIRECTORY TRASH_DIRECTORY GIT_TEST_LONG
512 # Run command; redirect its stderr to &4 as in
513 # test_run_, but keep its stdout on our stdout even in
518 if test $test_external_has_tap -eq 0; then
521 say_color "" "# test_external test $descr was ok"
522 test_success=$(($test_success + 1))
525 if test $test_external_has_tap -eq 0; then
526 test_failure_ "$descr" "$@"
528 say_color error "# test_external test $descr failed: $@"
529 test_failure=$(($test_failure + 1))
535 # Like test_external, but in addition tests that the command generated
536 # no output on stderr.
537 test_external_without_stderr () {
538 # The temporary file has no (and must have no) security
540 tmp="$TMPDIR"; if [ -z "$tmp" ]; then tmp=/tmp; fi
541 stderr="$tmp/git-external-stderr.$$.tmp"
542 test_external "$@" 4> "$stderr"
543 [ -f "$stderr" ] || error "Internal error: $stderr disappeared."
544 descr="no stderr: $1"
546 say >&3 "# expecting no stderr from previous command"
547 if [ ! -s "$stderr" ]; then
550 if test $test_external_has_tap -eq 0; then
553 say_color "" "# test_external_without_stderr test $descr was ok"
554 test_success=$(($test_success + 1))
557 if [ "$verbose" = t ]; then
558 output=`echo; echo "# Stderr is:"; cat "$stderr"`
562 # rm first in case test_failure exits.
564 if test $test_external_has_tap -eq 0; then
565 test_failure_ "$descr" "$@" "$output"
567 say_color error "# test_external_without_stderr test $descr failed: $@: $output"
568 test_failure=$(($test_failure + 1))
573 # This is not among top-level (test_expect_success | test_expect_failure)
574 # but is a prefix that can be used in the test script, like:
576 # test_expect_success 'complain and die' '
578 # do something else &&
579 # test_must_fail git checkout ../outerspace
582 # Writing this as "! git checkout ../outerspace" is wrong, because
583 # the failure could be due to a segv. We want a controlled failure.
587 test $? -gt 0 -a $? -le 129 -o $? -gt 192
590 # Similar to test_must_fail, but tolerates success, too. This is
591 # meant to be used in contexts like:
593 # test_expect_success 'some command works without configuration' '
594 # test_might_fail git config --unset all.configuration &&
598 # Writing "git config --unset all.configuration || :" would be wrong,
599 # because we want to notice if it fails due to segv.
603 test $? -ge 0 -a $? -le 129 -o $? -gt 192
606 # test_cmp is a helper function to compare actual and expected output.
607 # You can use it like:
609 # test_expect_success 'foo works' '
610 # echo expected >expected &&
612 # test_cmp expected actual
615 # This could be written as either "cmp" or "diff -u", but:
616 # - cmp's output is not nearly as easy to read as diff -u
617 # - not all diff versions understand "-u"
623 # This function can be used to schedule some commands to be run
624 # unconditionally at the end of the test to restore sanity:
626 # test_expect_success 'test core.capslock' '
627 # git config core.capslock true &&
628 # test_when_finished "git config --unset core.capslock" &&
632 # That would be roughly equivalent to
634 # test_expect_success 'test core.capslock' '
635 # git config core.capslock true &&
637 # git config --unset core.capslock
640 # except that the greeting and config --unset must both succeed for
643 test_when_finished () {
645 } && (exit \"\$eval_ret\"); eval_ret=\$?; $test_cleanup"
648 # Most tests can use the created repository, but some may need to create more.
649 # Usage: test_create_repo <directory>
650 test_create_repo () {
652 error "bug in the test script: not 1 parameter to test-create-repo"
656 cd "$repo" || error "Cannot setup test environment"
657 "$GIT_EXEC_PATH/git-init" "--template=$GIT_BUILD_DIR/templates/blt/" >&3 2>&4 ||
658 error "cannot run git init -- have you built things yet?"
659 mv .git/hooks .git/hooks-disabled
666 if test -z "$HARNESS_ACTIVE"; then
667 test_results_dir="$TEST_DIRECTORY/test-results"
668 mkdir -p "$test_results_dir"
669 test_results_path="$test_results_dir/${0%.sh}-$$.counts"
671 echo "total $test_count" >> $test_results_path
672 echo "success $test_success" >> $test_results_path
673 echo "fixed $test_fixed" >> $test_results_path
674 echo "broken $test_broken" >> $test_results_path
675 echo "failed $test_failure" >> $test_results_path
676 echo "" >> $test_results_path
679 if test "$test_fixed" != 0
681 say_color pass "# fixed $test_fixed known breakage(s)"
683 if test "$test_broken" != 0
685 say_color error "# still have $test_broken known breakage(s)"
686 msg="remaining $(($test_count-$test_broken)) test(s)"
688 msg="$test_count test(s)"
690 case "$test_failure" in
692 # Maybe print SKIP message
693 [ -z "$skip_all" ] || skip_all=" # SKIP $skip_all"
695 if test $test_external_has_tap -eq 0; then
696 say_color pass "# passed all $msg"
697 say "1..$test_count$skip_all"
700 test -d "$remove_trash" &&
701 cd "$(dirname "$remove_trash")" &&
702 rm -rf "$(basename "$remove_trash")"
707 if test $test_external_has_tap -eq 0; then
708 say_color error "# failed $test_failure among $msg"
717 # Test the binaries we have just built. The tests are kept in
718 # t/ subdirectory and are run in 'trash directory' subdirectory.
719 if test -z "$TEST_DIRECTORY"
721 # We allow tests to override this, in case they want to run tests
722 # outside of t/, e.g. for running tests on the test library
724 TEST_DIRECTORY=$(pwd)
726 GIT_BUILD_DIR="$TEST_DIRECTORY"/..
728 if test -n "$valgrind"
732 test "$1" = "$(readlink "$2")" || {
740 while test -d "$2".lock
742 say "Waiting for lock on $2."
749 make_valgrind_symlink () {
750 # handle only executables
751 test -x "$1" || return
753 base=$(basename "$1")
754 symlink_target=$GIT_BUILD_DIR/$base
755 # do not override scripts
756 if test -x "$symlink_target" &&
757 test ! -d "$symlink_target" &&
758 test "#!" != "$(head -c 2 < "$symlink_target")"
760 symlink_target=../valgrind.sh
764 symlink_target=../unprocessed-script
766 # create the link, or replace it if it is out of date
767 make_symlink "$symlink_target" "$GIT_VALGRIND/bin/$base" || exit
770 # override all git executables in TEST_DIRECTORY/..
771 GIT_VALGRIND=$TEST_DIRECTORY/valgrind
772 mkdir -p "$GIT_VALGRIND"/bin
773 for file in $GIT_BUILD_DIR/git* $GIT_BUILD_DIR/test-*
775 make_valgrind_symlink $file
781 ls "$path"/git-* 2> /dev/null |
784 make_valgrind_symlink "$file"
788 PATH=$GIT_VALGRIND/bin:$PATH
789 GIT_EXEC_PATH=$GIT_VALGRIND/bin
791 elif test -n "$GIT_TEST_INSTALLED" ; then
792 GIT_EXEC_PATH=$($GIT_TEST_INSTALLED/git --exec-path) ||
793 error "Cannot run git from $GIT_TEST_INSTALLED."
794 PATH=$GIT_TEST_INSTALLED:$GIT_BUILD_DIR:$PATH
795 GIT_EXEC_PATH=${GIT_TEST_EXEC_PATH:-$GIT_EXEC_PATH}
796 else # normal case, use ../bin-wrappers only unless $with_dashes:
797 git_bin_dir="$GIT_BUILD_DIR/bin-wrappers"
798 if ! test -x "$git_bin_dir/git" ; then
799 if test -z "$with_dashes" ; then
800 say "$git_bin_dir/git is not executable; using GIT_EXEC_PATH"
804 PATH="$git_bin_dir:$PATH"
805 GIT_EXEC_PATH=$GIT_BUILD_DIR
806 if test -n "$with_dashes" ; then
807 PATH="$GIT_BUILD_DIR:$PATH"
810 GIT_TEMPLATE_DIR="$GIT_BUILD_DIR"/templates/blt
812 GIT_CONFIG_NOSYSTEM=1
813 GIT_CONFIG_NOGLOBAL=1
814 export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG_NOSYSTEM GIT_CONFIG_NOGLOBAL
816 . "$GIT_BUILD_DIR"/GIT-BUILD-OPTIONS
818 if test -z "$GIT_TEST_CMP"
820 if test -n "$GIT_TEST_CMP_USE_COPIED_CONTEXT"
822 GIT_TEST_CMP="$DIFF -c"
824 GIT_TEST_CMP="$DIFF -u"
828 GITPERLLIB="$GIT_BUILD_DIR"/perl/blib/lib:"$GIT_BUILD_DIR"/perl/blib/arch/auto/Git
830 test -d "$GIT_BUILD_DIR"/templates/blt || {
831 error "You haven't built things yet, have you?"
834 if test -z "$GIT_TEST_INSTALLED" && test -z "$NO_PYTHON"
836 GITPYTHONLIB="$GIT_BUILD_DIR/git_remote_helpers/build/lib"
838 test -d "$GIT_BUILD_DIR"/git_remote_helpers/build || {
839 error "You haven't built git_remote_helpers yet, have you?"
843 if ! test -x "$GIT_BUILD_DIR"/test-chmtime; then
844 echo >&2 'You need to build test-chmtime:'
845 echo >&2 'Run "make test-chmtime" in the source (toplevel) directory'
850 test="trash directory.$(basename "$0" .sh)"
851 test -n "$root" && test="$root/$test"
853 /*) TRASH_DIRECTORY="$test" ;;
854 *) TRASH_DIRECTORY="$TEST_DIRECTORY/$test" ;;
856 test ! -z "$debug" || remove_trash=$TRASH_DIRECTORY
859 echo >&5 "FATAL: Cannot prepare test area"
863 test_create_repo "$test"
864 # Use -P to resolve symlinks in our working directory so that the cwd
865 # in subprocesses like git equals our $PWD (for pathname comparisons).
866 cd -P "$test" || exit 1
869 this_test=${this_test%%-*}
870 for skp in $GIT_SKIP_TESTS
874 say_color skip >&3 "skipping test $this_test altogether"
875 skip_all="skip all tests in $this_test"
880 # Provide an implementation of the 'yes' utility
895 # Fix some commands on Windows
898 # Windows has its own (incompatible) sort and find
908 # git sees Windows-style pwd
912 # no POSIX permissions
913 # backslashes in pathspec are converted to '/'
914 # exec does not inherit the PID
917 test_set_prereq POSIXPERM
918 test_set_prereq BSLASHPSPEC
919 test_set_prereq EXECKEEPSPID
923 test -z "$NO_PERL" && test_set_prereq PERL
924 test -z "$NO_PYTHON" && test_set_prereq PYTHON
926 # test whether the filesystem supports symbolic links
927 ln -s x y 2>/dev/null && test -h y 2>/dev/null && test_set_prereq SYMLINKS
930 # When the tests are run as root, permission tests will report that
931 # things are writable when they shouldn't be.
932 test -w / || test_set_prereq SANITY