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 () {
338 # You are not expected to call test_ok_ and test_failure_ directly, use
339 # the text_expect_* functions instead.
342 test_success=$(($test_success + 1))
343 say_color "" "ok $test_count - $@"
347 test_failure=$(($test_failure + 1))
348 say_color error "not ok - $test_count $1"
350 echo "$@" | sed -e 's/^/# /'
351 test "$immediate" = "" || { GIT_EXIT_OK=t; exit 1; }
354 test_known_broken_ok_ () {
355 test_fixed=$(($test_fixed+1))
356 say_color "" "ok $test_count - $@ # TODO known breakage"
359 test_known_broken_failure_ () {
360 test_broken=$(($test_broken+1))
361 say_color skip "not ok $test_count - $@ # TODO known breakage"
365 test "$debug" = "" || eval "$1"
372 eval >&3 2>&4 "$test_cleanup"
373 if test "$verbose" = "t" && test -n "$HARNESS_ACTIVE"; then
380 test_count=$(($test_count+1))
382 for skp in $GIT_SKIP_TESTS
384 case $this_test.$test_count in
389 if test -z "$to_skip" && test -n "$prereq" &&
390 ! test_have_prereq "$prereq"
396 say_color skip >&3 "skipping test: $@"
397 say_color skip "ok $test_count: # skip $1"
406 test_expect_failure () {
407 test "$#" = 3 && { prereq=$1; shift; } || prereq=
409 error "bug in the test script: not 2 or 3 parameters to test-expect-failure"
412 say >&3 "checking known breakage: $2"
414 if [ "$?" = 0 -a "$eval_ret" = 0 ]
416 test_known_broken_ok_ "$1"
418 test_known_broken_failure_ "$1"
424 test_expect_success () {
425 test "$#" = 3 && { prereq=$1; shift; } || prereq=
427 error "bug in the test script: not 2 or 3 parameters to test-expect-success"
430 say >&3 "expecting success: $2"
432 if [ "$?" = 0 -a "$eval_ret" = 0 ]
442 test_expect_code () {
443 test "$#" = 4 && { prereq=$1; shift; } || prereq=
445 error "bug in the test script: not 3 or 4 parameters to test-expect-code"
448 say >&3 "expecting exit code $1: $3"
450 if [ "$?" = 0 -a "$eval_ret" = "$1" ]
460 # test_external runs external test scripts that provide continuous
461 # test output about their progress, and succeeds/fails on
462 # zero/non-zero exit code. It outputs the test output on stdout even
463 # in non-verbose mode, and announces the external script with "# run
464 # <n>: ..." before running it. When providing relative paths, keep in
465 # mind that all scripts run in "trash directory".
466 # Usage: test_external description command arguments...
467 # Example: test_external 'Perl API' perl ../path/to/test.pl
469 test "$#" = 4 && { prereq=$1; shift; } || prereq=
471 error >&5 "bug in the test script: not 3 or 4 parameters to test_external"
474 if ! test_skip "$descr" "$@"
476 # Announce the script to reduce confusion about the
477 # test output that follows.
478 say_color "" "# run $test_count: $descr ($*)"
479 # Export TEST_DIRECTORY, TRASH_DIRECTORY and GIT_TEST_LONG
480 # to be able to use them in script
481 export TEST_DIRECTORY TRASH_DIRECTORY GIT_TEST_LONG
482 # Run command; redirect its stderr to &4 as in
483 # test_run_, but keep its stdout on our stdout even in
488 if test $test_external_has_tap -eq 0; then
491 say_color "" "# test_external test $descr was ok"
492 test_success=$(($test_success + 1))
495 if test $test_external_has_tap -eq 0; then
496 test_failure_ "$descr" "$@"
498 say_color error "# test_external test $descr failed: $@"
499 test_failure=$(($test_failure + 1))
505 # Like test_external, but in addition tests that the command generated
506 # no output on stderr.
507 test_external_without_stderr () {
508 # The temporary file has no (and must have no) security
510 tmp="$TMPDIR"; if [ -z "$tmp" ]; then tmp=/tmp; fi
511 stderr="$tmp/git-external-stderr.$$.tmp"
512 test_external "$@" 4> "$stderr"
513 [ -f "$stderr" ] || error "Internal error: $stderr disappeared."
514 descr="no stderr: $1"
516 say >&3 "# expecting no stderr from previous command"
517 if [ ! -s "$stderr" ]; then
520 if test $test_external_has_tap -eq 0; then
523 say_color "" "# test_external_without_stderr test $descr was ok"
524 test_success=$(($test_success + 1))
527 if [ "$verbose" = t ]; then
528 output=`echo; echo "# Stderr is:"; cat "$stderr"`
532 # rm first in case test_failure exits.
534 if test $test_external_has_tap -eq 0; then
535 test_failure_ "$descr" "$@" "$output"
537 say_color error "# test_external_without_stderr test $descr failed: $@: $output"
538 test_failure=$(($test_failure + 1))
543 # This is not among top-level (test_expect_success | test_expect_failure)
544 # but is a prefix that can be used in the test script, like:
546 # test_expect_success 'complain and die' '
548 # do something else &&
549 # test_must_fail git checkout ../outerspace
552 # Writing this as "! git checkout ../outerspace" is wrong, because
553 # the failure could be due to a segv. We want a controlled failure.
557 test $? -gt 0 -a $? -le 129 -o $? -gt 192
560 # Similar to test_must_fail, but tolerates success, too. This is
561 # meant to be used in contexts like:
563 # test_expect_success 'some command works without configuration' '
564 # test_might_fail git config --unset all.configuration &&
568 # Writing "git config --unset all.configuration || :" would be wrong,
569 # because we want to notice if it fails due to segv.
573 test $? -ge 0 -a $? -le 129 -o $? -gt 192
576 # test_cmp is a helper function to compare actual and expected output.
577 # You can use it like:
579 # test_expect_success 'foo works' '
580 # echo expected >expected &&
582 # test_cmp expected actual
585 # This could be written as either "cmp" or "diff -u", but:
586 # - cmp's output is not nearly as easy to read as diff -u
587 # - not all diff versions understand "-u"
593 # This function can be used to schedule some commands to be run
594 # unconditionally at the end of the test to restore sanity:
596 # test_expect_success 'test core.capslock' '
597 # git config core.capslock true &&
598 # test_when_finished "git config --unset core.capslock" &&
602 # That would be roughly equivalent to
604 # test_expect_success 'test core.capslock' '
605 # git config core.capslock true &&
607 # git config --unset core.capslock
610 # except that the greeting and config --unset must both succeed for
613 test_when_finished () {
615 } && (exit \"\$eval_ret\"); eval_ret=\$?; $test_cleanup"
618 # Most tests can use the created repository, but some may need to create more.
619 # Usage: test_create_repo <directory>
620 test_create_repo () {
622 error "bug in the test script: not 1 parameter to test-create-repo"
626 cd "$repo" || error "Cannot setup test environment"
627 "$GIT_EXEC_PATH/git-init" "--template=$TEST_DIRECTORY/../templates/blt/" >&3 2>&4 ||
628 error "cannot run git init -- have you built things yet?"
629 mv .git/hooks .git/hooks-disabled
635 test_results_dir="$TEST_DIRECTORY/test-results"
636 mkdir -p "$test_results_dir"
637 test_results_path="$test_results_dir/${0%.sh}-$$"
639 echo "total $test_count" >> $test_results_path
640 echo "success $test_success" >> $test_results_path
641 echo "fixed $test_fixed" >> $test_results_path
642 echo "broken $test_broken" >> $test_results_path
643 echo "failed $test_failure" >> $test_results_path
644 echo "" >> $test_results_path
646 if test "$test_fixed" != 0
648 say_color pass "# fixed $test_fixed known breakage(s)"
650 if test "$test_broken" != 0
652 say_color error "# still have $test_broken known breakage(s)"
653 msg="remaining $(($test_count-$test_broken)) test(s)"
655 msg="$test_count test(s)"
657 case "$test_failure" in
659 # Maybe print SKIP message
660 [ -z "$skip_all" ] || skip_all=" # SKIP $skip_all"
662 if test $test_external_has_tap -eq 0; then
663 say_color pass "# passed all $msg"
664 say "1..$test_count$skip_all"
667 test -d "$remove_trash" &&
668 cd "$(dirname "$remove_trash")" &&
669 rm -rf "$(basename "$remove_trash")"
674 if test $test_external_has_tap -eq 0; then
675 say_color error "# failed $test_failure among $msg"
684 # Test the binaries we have just built. The tests are kept in
685 # t/ subdirectory and are run in 'trash directory' subdirectory.
686 TEST_DIRECTORY=$(pwd)
687 if test -n "$valgrind"
691 test "$1" = "$(readlink "$2")" || {
699 while test -d "$2".lock
701 say "Waiting for lock on $2."
708 make_valgrind_symlink () {
709 # handle only executables
710 test -x "$1" || return
712 base=$(basename "$1")
713 symlink_target=$TEST_DIRECTORY/../$base
714 # do not override scripts
715 if test -x "$symlink_target" &&
716 test ! -d "$symlink_target" &&
717 test "#!" != "$(head -c 2 < "$symlink_target")"
719 symlink_target=../valgrind.sh
723 symlink_target=../unprocessed-script
725 # create the link, or replace it if it is out of date
726 make_symlink "$symlink_target" "$GIT_VALGRIND/bin/$base" || exit
729 # override all git executables in TEST_DIRECTORY/..
730 GIT_VALGRIND=$TEST_DIRECTORY/valgrind
731 mkdir -p "$GIT_VALGRIND"/bin
732 for file in $TEST_DIRECTORY/../git* $TEST_DIRECTORY/../test-*
734 make_valgrind_symlink $file
740 ls "$path"/git-* 2> /dev/null |
743 make_valgrind_symlink "$file"
747 PATH=$GIT_VALGRIND/bin:$PATH
748 GIT_EXEC_PATH=$GIT_VALGRIND/bin
750 elif test -n "$GIT_TEST_INSTALLED" ; then
751 GIT_EXEC_PATH=$($GIT_TEST_INSTALLED/git --exec-path) ||
752 error "Cannot run git from $GIT_TEST_INSTALLED."
753 PATH=$GIT_TEST_INSTALLED:$TEST_DIRECTORY/..:$PATH
754 GIT_EXEC_PATH=${GIT_TEST_EXEC_PATH:-$GIT_EXEC_PATH}
755 else # normal case, use ../bin-wrappers only unless $with_dashes:
756 git_bin_dir="$TEST_DIRECTORY/../bin-wrappers"
757 if ! test -x "$git_bin_dir/git" ; then
758 if test -z "$with_dashes" ; then
759 say "$git_bin_dir/git is not executable; using GIT_EXEC_PATH"
763 PATH="$git_bin_dir:$PATH"
764 GIT_EXEC_PATH=$TEST_DIRECTORY/..
765 if test -n "$with_dashes" ; then
766 PATH="$TEST_DIRECTORY/..:$PATH"
769 GIT_TEMPLATE_DIR=$(pwd)/../templates/blt
771 GIT_CONFIG_NOSYSTEM=1
772 GIT_CONFIG_NOGLOBAL=1
773 export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG_NOSYSTEM GIT_CONFIG_NOGLOBAL
775 . ../GIT-BUILD-OPTIONS
777 if test -z "$GIT_TEST_CMP"
779 if test -n "$GIT_TEST_CMP_USE_COPIED_CONTEXT"
781 GIT_TEST_CMP="$DIFF -c"
783 GIT_TEST_CMP="$DIFF -u"
787 GITPERLLIB=$(pwd)/../perl/blib/lib:$(pwd)/../perl/blib/arch/auto/Git
789 test -d ../templates/blt || {
790 error "You haven't built things yet, have you?"
793 if test -z "$GIT_TEST_INSTALLED" && test -z "$NO_PYTHON"
795 GITPYTHONLIB="$(pwd)/../git_remote_helpers/build/lib"
797 test -d ../git_remote_helpers/build || {
798 error "You haven't built git_remote_helpers yet, have you?"
802 if ! test -x ../test-chmtime; then
803 echo >&2 'You need to build test-chmtime:'
804 echo >&2 'Run "make test-chmtime" in the source (toplevel) directory'
809 test="trash directory.$(basename "$0" .sh)"
810 test -n "$root" && test="$root/$test"
812 /*) TRASH_DIRECTORY="$test" ;;
813 *) TRASH_DIRECTORY="$TEST_DIRECTORY/$test" ;;
815 test ! -z "$debug" || remove_trash=$TRASH_DIRECTORY
818 echo >&5 "FATAL: Cannot prepare test area"
822 test_create_repo "$test"
823 # Use -P to resolve symlinks in our working directory so that the cwd
824 # in subprocesses like git equals our $PWD (for pathname comparisons).
825 cd -P "$test" || exit 1
828 this_test=${this_test%%-*}
829 for skp in $GIT_SKIP_TESTS
832 for skp in $GIT_SKIP_TESTS
841 say_color skip >&3 "skipping test $this_test altogether"
842 say_color skip "skip all tests in $this_test"
847 # Provide an implementation of the 'yes' utility
862 # Fix some commands on Windows
865 # Windows has its own (incompatible) sort and find
875 # git sees Windows-style pwd
879 # no POSIX permissions
880 # backslashes in pathspec are converted to '/'
881 # exec does not inherit the PID
884 test_set_prereq POSIXPERM
885 test_set_prereq BSLASHPSPEC
886 test_set_prereq EXECKEEPSPID
890 test -z "$NO_PERL" && test_set_prereq PERL
891 test -z "$NO_PYTHON" && test_set_prereq PYTHON
893 # test whether the filesystem supports symbolic links
894 ln -s x y 2>/dev/null && test -h y 2>/dev/null && test_set_prereq SYMLINKS