3 # Copyright (c) 2005 Junio C Hamano
6 # if --tee was passed, write the output not only to the terminal, but
7 # additionally to the file test-results/$BASENAME.out, too.
8 case "$GIT_TEST_TEE_STARTED, $* " in
10 # do not redirect again
12 *' --tee '*|
*' --va'*)
14 BASE
=test-results
/$
(basename "$0" .sh
)
15 (GIT_TEST_TEE_STARTED
=done ${SHELL-sh} "$0" "$@" 2>&1;
16 echo $?
> $BASE.
exit) |
tee $BASE.out
17 test "$(cat $BASE.exit)" = 0
22 # Keep the original TERM for say_color
25 # For repeatability, reset the environment to known value.
31 export LANG LC_ALL PAGER TERM TZ
38 unset COMMIT_AUTHOR_EMAIL
39 unset COMMIT_AUTHOR_NAME
41 unset GIT_ALTERNATE_OBJECT_DIRECTORIES
43 GIT_AUTHOR_EMAIL
=author@example.com
44 GIT_AUTHOR_NAME
='A U Thor'
45 unset GIT_COMMITTER_DATE
46 GIT_COMMITTER_EMAIL
=committer@example.com
47 GIT_COMMITTER_NAME
='C O Mitter'
51 unset GIT_EXTERNAL_DIFF
53 unset GIT_OBJECT_DIRECTORY
54 unset GIT_CEILING_DIRECTORIES
55 unset SHA1_FILE_DIRECTORIES
56 unset SHA1_FILE_DIRECTORY
58 export GIT_MERGE_VERBOSITY
59 export GIT_AUTHOR_EMAIL GIT_AUTHOR_NAME
60 export GIT_COMMITTER_EMAIL GIT_COMMITTER_NAME
62 GIT_TEST_CMP
=${GIT_TEST_CMP:-diff -u}
64 # Protect ourselves from common misconfiguration to export
65 # CDPATH into the environment
68 case $
(echo $GIT_TRACE |
tr "[A-Z]" "[a-z]") in
70 echo "* warning: Some tests will not work if GIT_TRACE" \
71 "is set as to trace on STDERR ! *"
72 echo "* warning: Please set GIT_TRACE to something" \
73 "other than 1, 2 or true ! *"
77 # Each test should start with something like this, after copyright notices:
79 # test_description='Description of this test...
80 # This test checks if command xyzzy does the right thing...
83 [ "x$ORIGINAL_TERM" != "xdumb" ] && (
84 TERM
=$ORIGINAL_TERM &&
87 tput bold
>/dev
/null
2>&1 &&
88 tput setaf
1 >/dev
/null
2>&1 &&
89 tput sgr0
>/dev
/null
2>&1
96 -d|
--d|
--de|
--deb|
--debu|
--debug)
98 -i|
--i|
--im|
--imm|
--imme|
--immed|
--immedi|
--immedia|
--immediat|
--immediate)
100 -l|
--l|
--lo|
--lon|
--long|
--long-|
--long-t|
--long-te|
--long-tes|
--long-test|
--long-tests)
101 GIT_TEST_LONG
=t
; export GIT_TEST_LONG
; shift ;;
102 -h|
--h|
--he|
--hel|
--help)
104 -v|
--v|
--ve|
--ver|
--verb|
--verbo|
--verbos|
--verbose)
106 -q|
--q|
--qu|
--qui|
--quie|
--quiet)
113 --va|
--val|
--valg|
--valgr|
--valgri|
--valgrin|
--valgrind)
114 valgrind
=t
; verbose
=t
; shift ;;
116 shift ;; # was handled already
118 root
=$
(expr "z$1" : 'z[^=]*=\(.*\)')
121 echo "error: unknown test option '$1'" >&2; exit 1 ;;
125 if test -n "$color"; then
131 error
) tput bold
; tput setaf
1;; # bold red
132 skip
) tput bold
; tput setaf
2;; # bold green
133 pass
) tput setaf
2;; # green
134 info
) tput setaf
3;; # brown
135 *) test -n "$quiet" && return;;
145 test -z "$1" && test -n "$quiet" && return
152 say_color error
"error: $*"
161 test "${test_description}" != "" ||
162 error
"Test script did not set test_description."
164 if test "$help" = "t"
166 echo "$test_description"
171 if test "$verbose" = "t"
175 exec 4>/dev
/null
3>/dev
/null
186 if test -n "$GIT_EXIT_OK"
190 echo >&5 "FATAL: Unexpected exit with code $code"
198 # The semantics of the editor variables are that of invoking
199 # sh -c "$EDITOR \"$@\"" files ...
201 # If our trash directory contains shell metacharacters, they will be
202 # interpreted if we just set $EDITOR directly, so do a little dance with
203 # environment variables to work around this.
205 # In particular, quoting isn't enough, as the path may contain the same quote
210 EDITOR
='"$FAKE_EDITOR"'
214 test_decode_color
() {
215 sed -e 's/.\[1m/<WHITE>/g' \
216 -e 's/.\[31m/<RED>/g' \
217 -e 's/.\[32m/<GREEN>/g' \
218 -e 's/.\[33m/<YELLOW>/g' \
219 -e 's/.\[34m/<BLUE>/g' \
220 -e 's/.\[35m/<MAGENTA>/g' \
221 -e 's/.\[36m/<CYAN>/g' \
222 -e 's/.\[m/<RESET>/g'
226 if test -z "${test_tick+set}"
230 test_tick
=$
(($test_tick + 60))
232 GIT_COMMITTER_DATE
="$test_tick -0700"
233 GIT_AUTHOR_DATE
="$test_tick -0700"
234 export GIT_COMMITTER_DATE GIT_AUTHOR_DATE
237 # Call test_commit with the arguments "<message> [<file> [<contents>]]"
239 # This will commit a file with the given contents and the given commit
240 # message. It will also add a tag with <message> as name.
242 # Both <file> and <contents> default to <message>.
246 echo "${3-$1}" > "$file" &&
249 git commit
-m "$1" &&
253 # Call test_merge with the arguments "<message> <commit>", where <commit>
254 # can be a tag pointing to the commit-to-merge.
258 git merge
-m "$1" "$2" &&
262 # This function helps systems where core.filemode=false is set.
263 # Use it instead of plain 'chmod +x' to set or unset the executable bit
264 # of a file in the working directory and add it to the index.
268 git update-index
--add "--chmod=$@"
271 # Use test_set_prereq to tell that a particular prerequisite is available.
272 # The prerequisite can later be checked for in two ways:
274 # - Explicitly using test_have_prereq.
276 # - Implicitly by specifying the prerequisite tag in the calls to
277 # test_expect_{success,failure,code}.
279 # The single parameter is the prerequisite tag (a simple word, in all
280 # capital letters by convention).
283 satisfied
="$satisfied$1 "
287 test_have_prereq
() {
296 # You are not expected to call test_ok_ and test_failure_ directly, use
297 # the text_expect_* functions instead.
300 test_success
=$
(($test_success + 1))
301 say_color
"" " ok $test_count: $@"
305 test_failure
=$
(($test_failure + 1))
306 say_color error
"FAIL $test_count: $1"
308 echo "$@" |
sed -e 's/^/ /'
309 test "$immediate" = "" ||
{ GIT_EXIT_OK
=t
; exit 1; }
312 test_known_broken_ok_
() {
313 test_fixed
=$
(($test_fixed+1))
314 say_color
"" " FIXED $test_count: $@"
317 test_known_broken_failure_
() {
318 test_broken
=$
(($test_broken+1))
319 say_color skip
" still broken $test_count: $@"
323 test "$debug" = "" ||
eval "$1"
333 test_count
=$
(($test_count+1))
335 for skp
in $GIT_SKIP_TESTS
337 case $this_test.
$test_count in
342 if test -z "$to_skip" && test -n "$prereq" &&
343 ! test_have_prereq
"$prereq"
349 say_color skip
>&3 "skipping test: $@"
350 say_color skip
"skip $test_count: $1"
359 test_expect_failure
() {
360 test "$#" = 3 && { prereq
=$1; shift; } || prereq
=
362 error
"bug in the test script: not 2 or 3 parameters to test-expect-failure"
365 say
>&3 "checking known breakage: $2"
367 if [ "$?" = 0 -a "$eval_ret" = 0 ]
369 test_known_broken_ok_
"$1"
371 test_known_broken_failure_
"$1"
377 test_expect_success
() {
378 test "$#" = 3 && { prereq
=$1; shift; } || prereq
=
380 error
"bug in the test script: not 2 or 3 parameters to test-expect-success"
383 say
>&3 "expecting success: $2"
385 if [ "$?" = 0 -a "$eval_ret" = 0 ]
395 test_expect_code
() {
396 test "$#" = 4 && { prereq
=$1; shift; } || prereq
=
398 error
"bug in the test script: not 3 or 4 parameters to test-expect-code"
401 say
>&3 "expecting exit code $1: $3"
403 if [ "$?" = 0 -a "$eval_ret" = "$1" ]
413 # test_external runs external test scripts that provide continuous
414 # test output about their progress, and succeeds/fails on
415 # zero/non-zero exit code. It outputs the test output on stdout even
416 # in non-verbose mode, and announces the external script with "* run
417 # <n>: ..." before running it. When providing relative paths, keep in
418 # mind that all scripts run in "trash directory".
419 # Usage: test_external description command arguments...
420 # Example: test_external 'Perl API' perl ../path/to/test.pl
422 test "$#" = 4 && { prereq
=$1; shift; } || prereq
=
424 error
>&5 "bug in the test script: not 3 or 4 parameters to test_external"
427 if ! test_skip
"$descr" "$@"
429 # Announce the script to reduce confusion about the
430 # test output that follows.
431 say_color
"" " run $test_count: $descr ($*)"
432 # Run command; redirect its stderr to &4 as in
433 # test_run_, but keep its stdout on our stdout even in
440 test_failure_
"$descr" "$@"
445 # Like test_external, but in addition tests that the command generated
446 # no output on stderr.
447 test_external_without_stderr
() {
448 # The temporary file has no (and must have no) security
450 tmp
="$TMPDIR"; if [ -z "$tmp" ]; then tmp
=/tmp
; fi
451 stderr
="$tmp/git-external-stderr.$$.tmp"
452 test_external
"$@" 4> "$stderr"
453 [ -f "$stderr" ] || error
"Internal error: $stderr disappeared."
454 descr
="no stderr: $1"
456 say
>&3 "expecting no stderr from previous command"
457 if [ ! -s "$stderr" ]; then
461 if [ "$verbose" = t
]; then
462 output
=`echo; echo Stderr is:; cat "$stderr"`
466 # rm first in case test_failure exits.
468 test_failure_
"$descr" "$@" "$output"
472 # This is not among top-level (test_expect_success | test_expect_failure)
473 # but is a prefix that can be used in the test script, like:
475 # test_expect_success 'complain and die' '
477 # do something else &&
478 # test_must_fail git checkout ../outerspace
481 # Writing this as "! git checkout ../outerspace" is wrong, because
482 # the failure could be due to a segv. We want a controlled failure.
486 test $?
-gt 0 -a $?
-le 129 -o $?
-gt 192
489 # test_cmp is a helper function to compare actual and expected output.
490 # You can use it like:
492 # test_expect_success 'foo works' '
493 # echo expected >expected &&
495 # test_cmp expected actual
498 # This could be written as either "cmp" or "diff -u", but:
499 # - cmp's output is not nearly as easy to read as diff -u
500 # - not all diff versions understand "-u"
506 # Most tests can use the created repository, but some may need to create more.
507 # Usage: test_create_repo <directory>
508 test_create_repo
() {
510 error
"bug in the test script: not 1 parameter to test-create-repo"
514 cd "$repo" || error
"Cannot setup test environment"
515 "$GIT_EXEC_PATH/git-init" "--template=$TEST_DIRECTORY/../templates/blt/" >&3 2>&4 ||
516 error
"cannot run git init -- have you built things yet?"
517 mv .git
/hooks .git
/hooks-disabled
523 test_results_dir
="$TEST_DIRECTORY/test-results"
524 mkdir
-p "$test_results_dir"
525 test_results_path
="$test_results_dir/${0%.sh}-$$"
527 echo "total $test_count" >> $test_results_path
528 echo "success $test_success" >> $test_results_path
529 echo "fixed $test_fixed" >> $test_results_path
530 echo "broken $test_broken" >> $test_results_path
531 echo "failed $test_failure" >> $test_results_path
532 echo "" >> $test_results_path
534 if test "$test_fixed" != 0
536 say_color pass
"fixed $test_fixed known breakage(s)"
538 if test "$test_broken" != 0
540 say_color error
"still have $test_broken known breakage(s)"
541 msg
="remaining $(($test_count-$test_broken)) test(s)"
543 msg
="$test_count test(s)"
545 case "$test_failure" in
547 say_color pass
"passed all $msg"
549 test -d "$remove_trash" &&
550 cd "$(dirname "$remove_trash")" &&
551 rm -rf "$(basename "$remove_trash")"
556 say_color error
"failed $test_failure among $msg"
562 # Test the binaries we have just built. The tests are kept in
563 # t/ subdirectory and are run in 'trash directory' subdirectory.
564 TEST_DIRECTORY
=$
(pwd)
565 if test -z "$valgrind"
567 if test -z "$GIT_TEST_INSTALLED"
569 PATH
=$TEST_DIRECTORY/..
:$PATH
570 GIT_EXEC_PATH
=$TEST_DIRECTORY/..
572 GIT_EXEC_PATH
=$
($GIT_TEST_INSTALLED/git
--exec-path) ||
573 error
"Cannot run git from $GIT_TEST_INSTALLED."
574 PATH
=$GIT_TEST_INSTALLED:$TEST_DIRECTORY/..
:$PATH
575 GIT_EXEC_PATH
=${GIT_TEST_EXEC_PATH:-$GIT_EXEC_PATH}
580 test "$1" = "$(readlink "$2")" ||
{
588 while test -d "$2".lock
590 say
"Waiting for lock on $2."
597 make_valgrind_symlink
() {
598 # handle only executables
599 test -x "$1" ||
return
601 base
=$
(basename "$1")
602 symlink_target
=$TEST_DIRECTORY/..
/$base
603 # do not override scripts
604 if test -x "$symlink_target" &&
605 test ! -d "$symlink_target" &&
606 test "#!" != "$(head -c 2 < "$symlink_target")"
608 symlink_target
=..
/valgrind.sh
612 symlink_target
=..
/unprocessed-script
614 # create the link, or replace it if it is out of date
615 make_symlink
"$symlink_target" "$GIT_VALGRIND/bin/$base" ||
exit
618 # override all git executables in TEST_DIRECTORY/..
619 GIT_VALGRIND
=$TEST_DIRECTORY/valgrind
620 mkdir
-p "$GIT_VALGRIND"/bin
621 for file in $TEST_DIRECTORY/..
/git
* $TEST_DIRECTORY/..
/test-
*
623 make_valgrind_symlink
$file
629 ls "$path"/git-
* 2> /dev
/null |
632 make_valgrind_symlink
"$file"
636 PATH
=$GIT_VALGRIND/bin
:$PATH
637 GIT_EXEC_PATH
=$GIT_VALGRIND/bin
640 GIT_TEMPLATE_DIR
=$
(pwd)/..
/templates
/blt
642 GIT_CONFIG_NOSYSTEM
=1
643 GIT_CONFIG_NOGLOBAL
=1
644 export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG_NOSYSTEM GIT_CONFIG_NOGLOBAL
646 . ..
/GIT-BUILD-OPTIONS
648 GITPERLLIB
=$
(pwd)/..
/perl
/blib
/lib
:$
(pwd)/..
/perl
/blib
/arch
/auto
/Git
650 test -d ..
/templates
/blt ||
{
651 error
"You haven't built things yet, have you?"
654 if test -z "$GIT_TEST_INSTALLED" && test -z "$NO_PYTHON"
656 GITPYTHONLIB
="$(pwd)/../git_remote_helpers/build/lib"
658 test -d ..
/git_remote_helpers
/build ||
{
659 error
"You haven't built git_remote_helpers yet, have you?"
663 if ! test -x ..
/test-chmtime
; then
664 echo >&2 'You need to build test-chmtime:'
665 echo >&2 'Run "make test-chmtime" in the source (toplevel) directory'
670 test="trash directory.$(basename "$0" .sh)"
671 test -n "$root" && test="$root/$test"
673 /*) TRASH_DIRECTORY
="$test" ;;
674 *) TRASH_DIRECTORY
="$TEST_DIRECTORY/$test" ;;
676 test ! -z "$debug" || remove_trash
=$TRASH_DIRECTORY
679 echo >&5 "FATAL: Cannot prepare test area"
683 test_create_repo
"$test"
684 # Use -P to resolve symlinks in our working directory so that the cwd
685 # in subprocesses like git equals our $PWD (for pathname comparisons).
686 cd -P "$test" ||
exit 1
689 this_test
=${this_test%%-*}
690 for skp
in $GIT_SKIP_TESTS
693 for skp
in $GIT_SKIP_TESTS
702 say_color skip
>&3 "skipping test $this_test altogether"
703 say_color skip
"skip all tests in $this_test"
708 # Provide an implementation of the 'yes' utility
723 # Fix some commands on Windows
726 # Windows has its own (incompatible) sort and find
736 # git sees Windows-style pwd
740 # no POSIX permissions
741 # backslashes in pathspec are converted to '/'
742 # exec does not inherit the PID
745 test_set_prereq POSIXPERM
746 test_set_prereq BSLASHPSPEC
747 test_set_prereq EXECKEEPSPID
751 test -z "$NO_PERL" && test_set_prereq PERL
752 test -z "$NO_PYTHON" && test_set_prereq PYTHON
754 # test whether the filesystem supports symbolic links
755 ln -s x y
2>/dev
/null
&& test -h y
2>/dev
/null
&& test_set_prereq SYMLINKS