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)
132 with_dashes=t; shift ;;
138 --va|--val|--valg|--valgr|--valgri|--valgrin|--valgrind)
139 valgrind=t; verbose=t; shift ;;
141 shift ;; # was handled already
143 root=$(expr "z$1" : 'z[^=]*=\(.*\)')
146 echo "error: unknown test option '$1'" >&2; exit 1 ;;
150 if test -n "$color"; then
156 error) tput bold; tput setaf 1;; # bold red
157 skip) tput bold; tput setaf 2;; # bold green
158 pass) tput setaf 2;; # green
159 info) tput setaf 3;; # brown
160 *) test -n "$quiet" && return;;
170 test -z "$1" && test -n "$quiet" && return
177 say_color error "error: $*"
186 test "${test_description}" != "" ||
187 error "Test script did not set test_description."
189 if test "$help" = "t"
191 echo "$test_description"
196 if test "$verbose" = "t"
200 exec 4>/dev/null 3>/dev/null
211 if test -n "$GIT_EXIT_OK"
215 echo >&5 "FATAL: Unexpected exit with code $code"
223 # The semantics of the editor variables are that of invoking
224 # sh -c "$EDITOR \"$@\"" files ...
226 # If our trash directory contains shell metacharacters, they will be
227 # interpreted if we just set $EDITOR directly, so do a little dance with
228 # environment variables to work around this.
230 # In particular, quoting isn't enough, as the path may contain the same quote
235 EDITOR='"$FAKE_EDITOR"'
239 test_decode_color () {
240 sed -e 's/.\[1m/<WHITE>/g' \
241 -e 's/.\[31m/<RED>/g' \
242 -e 's/.\[32m/<GREEN>/g' \
243 -e 's/.\[33m/<YELLOW>/g' \
244 -e 's/.\[34m/<BLUE>/g' \
245 -e 's/.\[35m/<MAGENTA>/g' \
246 -e 's/.\[36m/<CYAN>/g' \
247 -e 's/.\[m/<RESET>/g'
259 sed -e 's/$/Q/' | tr Q '\015'
263 tr '\015' Q | sed -e 's/Q$//'
267 if test -z "${test_tick+set}"
271 test_tick=$(($test_tick + 60))
273 GIT_COMMITTER_DATE="$test_tick -0700"
274 GIT_AUTHOR_DATE="$test_tick -0700"
275 export GIT_COMMITTER_DATE GIT_AUTHOR_DATE
278 # Call test_commit with the arguments "<message> [<file> [<contents>]]"
280 # This will commit a file with the given contents and the given commit
281 # message. It will also add a tag with <message> as name.
283 # Both <file> and <contents> default to <message>.
287 echo "${3-$1}" > "$file" &&
290 git commit -m "$1" &&
294 # Call test_merge with the arguments "<message> <commit>", where <commit>
295 # can be a tag pointing to the commit-to-merge.
299 git merge -m "$1" "$2" &&
303 # This function helps systems where core.filemode=false is set.
304 # Use it instead of plain 'chmod +x' to set or unset the executable bit
305 # of a file in the working directory and add it to the index.
309 git update-index --add "--chmod=$@"
312 # Use test_set_prereq to tell that a particular prerequisite is available.
313 # The prerequisite can later be checked for in two ways:
315 # - Explicitly using test_have_prereq.
317 # - Implicitly by specifying the prerequisite tag in the calls to
318 # test_expect_{success,failure,code}.
320 # The single parameter is the prerequisite tag (a simple word, in all
321 # capital letters by convention).
324 satisfied="$satisfied$1 "
328 test_have_prereq () {
337 # You are not expected to call test_ok_ and test_failure_ directly, use
338 # the text_expect_* functions instead.
341 test_success=$(($test_success + 1))
342 say_color "" " ok $test_count: $@"
346 test_failure=$(($test_failure + 1))
347 say_color error "FAIL $test_count: $1"
349 echo "$@" | sed -e 's/^/ /'
350 test "$immediate" = "" || { GIT_EXIT_OK=t; exit 1; }
353 test_known_broken_ok_ () {
354 test_fixed=$(($test_fixed+1))
355 say_color "" " FIXED $test_count: $@"
358 test_known_broken_failure_ () {
359 test_broken=$(($test_broken+1))
360 say_color skip " still broken $test_count: $@"
364 test "$debug" = "" || eval "$1"
371 eval >&3 2>&4 "$test_cleanup"
376 test_count=$(($test_count+1))
378 for skp in $GIT_SKIP_TESTS
380 case $this_test.$test_count in
385 if test -z "$to_skip" && test -n "$prereq" &&
386 ! test_have_prereq "$prereq"
392 say_color skip >&3 "skipping test: $@"
393 say_color skip "skip $test_count: $1"
402 test_expect_failure () {
403 test "$#" = 3 && { prereq=$1; shift; } || prereq=
405 error "bug in the test script: not 2 or 3 parameters to test-expect-failure"
408 say >&3 "checking known breakage: $2"
410 if [ "$?" = 0 -a "$eval_ret" = 0 ]
412 test_known_broken_ok_ "$1"
414 test_known_broken_failure_ "$1"
420 test_expect_success () {
421 test "$#" = 3 && { prereq=$1; shift; } || prereq=
423 error "bug in the test script: not 2 or 3 parameters to test-expect-success"
426 say >&3 "expecting success: $2"
428 if [ "$?" = 0 -a "$eval_ret" = 0 ]
438 test_expect_code () {
439 test "$#" = 4 && { prereq=$1; shift; } || prereq=
441 error "bug in the test script: not 3 or 4 parameters to test-expect-code"
444 say >&3 "expecting exit code $1: $3"
446 if [ "$?" = 0 -a "$eval_ret" = "$1" ]
456 # test_external runs external test scripts that provide continuous
457 # test output about their progress, and succeeds/fails on
458 # zero/non-zero exit code. It outputs the test output on stdout even
459 # in non-verbose mode, and announces the external script with "* run
460 # <n>: ..." before running it. When providing relative paths, keep in
461 # mind that all scripts run in "trash directory".
462 # Usage: test_external description command arguments...
463 # Example: test_external 'Perl API' perl ../path/to/test.pl
465 test "$#" = 4 && { prereq=$1; shift; } || prereq=
467 error >&5 "bug in the test script: not 3 or 4 parameters to test_external"
470 if ! test_skip "$descr" "$@"
472 # Announce the script to reduce confusion about the
473 # test output that follows.
474 say_color "" " run $test_count: $descr ($*)"
475 # Export TEST_DIRECTORY, TRASH_DIRECTORY and GIT_TEST_LONG
476 # to be able to use them in script
477 export TEST_DIRECTORY TRASH_DIRECTORY GIT_TEST_LONG
478 # Run command; redirect its stderr to &4 as in
479 # test_run_, but keep its stdout on our stdout even in
486 test_failure_ "$descr" "$@"
491 # Like test_external, but in addition tests that the command generated
492 # no output on stderr.
493 test_external_without_stderr () {
494 # The temporary file has no (and must have no) security
496 tmp="$TMPDIR"; if [ -z "$tmp" ]; then tmp=/tmp; fi
497 stderr="$tmp/git-external-stderr.$$.tmp"
498 test_external "$@" 4> "$stderr"
499 [ -f "$stderr" ] || error "Internal error: $stderr disappeared."
500 descr="no stderr: $1"
502 say >&3 "expecting no stderr from previous command"
503 if [ ! -s "$stderr" ]; then
507 if [ "$verbose" = t ]; then
508 output=`echo; echo Stderr is:; cat "$stderr"`
512 # rm first in case test_failure exits.
514 test_failure_ "$descr" "$@" "$output"
518 # This is not among top-level (test_expect_success | test_expect_failure)
519 # but is a prefix that can be used in the test script, like:
521 # test_expect_success 'complain and die' '
523 # do something else &&
524 # test_must_fail git checkout ../outerspace
527 # Writing this as "! git checkout ../outerspace" is wrong, because
528 # the failure could be due to a segv. We want a controlled failure.
532 test $? -gt 0 -a $? -le 129 -o $? -gt 192
535 # Similar to test_must_fail, but tolerates success, too. This is
536 # meant to be used in contexts like:
538 # test_expect_success 'some command works without configuration' '
539 # test_might_fail git config --unset all.configuration &&
543 # Writing "git config --unset all.configuration || :" would be wrong,
544 # because we want to notice if it fails due to segv.
548 test $? -ge 0 -a $? -le 129 -o $? -gt 192
551 # test_cmp is a helper function to compare actual and expected output.
552 # You can use it like:
554 # test_expect_success 'foo works' '
555 # echo expected >expected &&
557 # test_cmp expected actual
560 # This could be written as either "cmp" or "diff -u", but:
561 # - cmp's output is not nearly as easy to read as diff -u
562 # - not all diff versions understand "-u"
568 # This function can be used to schedule some commands to be run
569 # unconditionally at the end of the test to restore sanity:
571 # test_expect_success 'test core.capslock' '
572 # git config core.capslock true &&
573 # test_when_finished "git config --unset core.capslock" &&
577 # That would be roughly equivalent to
579 # test_expect_success 'test core.capslock' '
580 # git config core.capslock true &&
582 # git config --unset core.capslock
585 # except that the greeting and config --unset must both succeed for
588 test_when_finished () {
590 } && (exit \"\$eval_ret\"); eval_ret=\$?; $test_cleanup"
593 # Most tests can use the created repository, but some may need to create more.
594 # Usage: test_create_repo <directory>
595 test_create_repo () {
597 error "bug in the test script: not 1 parameter to test-create-repo"
601 cd "$repo" || error "Cannot setup test environment"
602 "$GIT_EXEC_PATH/git-init" "--template=$TEST_DIRECTORY/../templates/blt/" >&3 2>&4 ||
603 error "cannot run git init -- have you built things yet?"
604 mv .git/hooks .git/hooks-disabled
610 test_results_dir="$TEST_DIRECTORY/test-results"
611 mkdir -p "$test_results_dir"
612 test_results_path="$test_results_dir/${0%.sh}-$$"
614 echo "total $test_count" >> $test_results_path
615 echo "success $test_success" >> $test_results_path
616 echo "fixed $test_fixed" >> $test_results_path
617 echo "broken $test_broken" >> $test_results_path
618 echo "failed $test_failure" >> $test_results_path
619 echo "" >> $test_results_path
621 if test "$test_fixed" != 0
623 say_color pass "fixed $test_fixed known breakage(s)"
625 if test "$test_broken" != 0
627 say_color error "still have $test_broken known breakage(s)"
628 msg="remaining $(($test_count-$test_broken)) test(s)"
630 msg="$test_count test(s)"
632 case "$test_failure" in
634 say_color pass "passed all $msg"
636 test -d "$remove_trash" &&
637 cd "$(dirname "$remove_trash")" &&
638 rm -rf "$(basename "$remove_trash")"
643 say_color error "failed $test_failure among $msg"
649 # Test the binaries we have just built. The tests are kept in
650 # t/ subdirectory and are run in 'trash directory' subdirectory.
651 TEST_DIRECTORY=$(pwd)
652 if test -n "$valgrind"
656 test "$1" = "$(readlink "$2")" || {
664 while test -d "$2".lock
666 say "Waiting for lock on $2."
673 make_valgrind_symlink () {
674 # handle only executables
675 test -x "$1" || return
677 base=$(basename "$1")
678 symlink_target=$TEST_DIRECTORY/../$base
679 # do not override scripts
680 if test -x "$symlink_target" &&
681 test ! -d "$symlink_target" &&
682 test "#!" != "$(head -c 2 < "$symlink_target")"
684 symlink_target=../valgrind.sh
688 symlink_target=../unprocessed-script
690 # create the link, or replace it if it is out of date
691 make_symlink "$symlink_target" "$GIT_VALGRIND/bin/$base" || exit
694 # override all git executables in TEST_DIRECTORY/..
695 GIT_VALGRIND=$TEST_DIRECTORY/valgrind
696 mkdir -p "$GIT_VALGRIND"/bin
697 for file in $TEST_DIRECTORY/../git* $TEST_DIRECTORY/../test-*
699 make_valgrind_symlink $file
705 ls "$path"/git-* 2> /dev/null |
708 make_valgrind_symlink "$file"
712 PATH=$GIT_VALGRIND/bin:$PATH
713 GIT_EXEC_PATH=$GIT_VALGRIND/bin
715 elif test -n "$GIT_TEST_INSTALLED" ; then
716 GIT_EXEC_PATH=$($GIT_TEST_INSTALLED/git --exec-path) ||
717 error "Cannot run git from $GIT_TEST_INSTALLED."
718 PATH=$GIT_TEST_INSTALLED:$TEST_DIRECTORY/..:$PATH
719 GIT_EXEC_PATH=${GIT_TEST_EXEC_PATH:-$GIT_EXEC_PATH}
720 else # normal case, use ../bin-wrappers only unless $with_dashes:
721 git_bin_dir="$TEST_DIRECTORY/../bin-wrappers"
722 if ! test -x "$git_bin_dir/git" ; then
723 if test -z "$with_dashes" ; then
724 say "$git_bin_dir/git is not executable; using GIT_EXEC_PATH"
728 PATH="$git_bin_dir:$PATH"
729 GIT_EXEC_PATH=$TEST_DIRECTORY/..
730 if test -n "$with_dashes" ; then
731 PATH="$TEST_DIRECTORY/..:$PATH"
734 GIT_TEMPLATE_DIR=$(pwd)/../templates/blt
736 GIT_CONFIG_NOSYSTEM=1
737 GIT_CONFIG_NOGLOBAL=1
738 export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG_NOSYSTEM GIT_CONFIG_NOGLOBAL
740 . ../GIT-BUILD-OPTIONS
742 if test -z "$GIT_TEST_CMP"
744 if test -n "$GIT_TEST_CMP_USE_COPIED_CONTEXT"
746 GIT_TEST_CMP="$DIFF -c"
748 GIT_TEST_CMP="$DIFF -u"
752 GITPERLLIB=$(pwd)/../perl/blib/lib:$(pwd)/../perl/blib/arch/auto/Git
754 test -d ../templates/blt || {
755 error "You haven't built things yet, have you?"
758 if test -z "$GIT_TEST_INSTALLED" && test -z "$NO_PYTHON"
760 GITPYTHONLIB="$(pwd)/../git_remote_helpers/build/lib"
762 test -d ../git_remote_helpers/build || {
763 error "You haven't built git_remote_helpers yet, have you?"
767 if ! test -x ../test-chmtime; then
768 echo >&2 'You need to build test-chmtime:'
769 echo >&2 'Run "make test-chmtime" in the source (toplevel) directory'
774 test="trash directory.$(basename "$0" .sh)"
775 test -n "$root" && test="$root/$test"
777 /*) TRASH_DIRECTORY="$test" ;;
778 *) TRASH_DIRECTORY="$TEST_DIRECTORY/$test" ;;
780 test ! -z "$debug" || remove_trash=$TRASH_DIRECTORY
783 echo >&5 "FATAL: Cannot prepare test area"
787 test_create_repo "$test"
788 # Use -P to resolve symlinks in our working directory so that the cwd
789 # in subprocesses like git equals our $PWD (for pathname comparisons).
790 cd -P "$test" || exit 1
793 this_test=${this_test%%-*}
794 for skp in $GIT_SKIP_TESTS
797 for skp in $GIT_SKIP_TESTS
806 say_color skip >&3 "skipping test $this_test altogether"
807 say_color skip "skip all tests in $this_test"
812 # Provide an implementation of the 'yes' utility
827 # Fix some commands on Windows
830 # Windows has its own (incompatible) sort and find
840 # git sees Windows-style pwd
844 # no POSIX permissions
845 # backslashes in pathspec are converted to '/'
846 # exec does not inherit the PID
849 test_set_prereq POSIXPERM
850 test_set_prereq BSLASHPSPEC
851 test_set_prereq EXECKEEPSPID
855 test -z "$NO_PERL" && test_set_prereq PERL
856 test -z "$NO_PYTHON" && test_set_prereq PYTHON
858 # test whether the filesystem supports symbolic links
859 ln -s x y 2>/dev/null && test -h y 2>/dev/null && test_set_prereq SYMLINKS