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
122 if test -n "$color"; then
128 error) tput bold; tput setaf 1;; # bold red
129 skip) tput bold; tput setaf 2;; # bold green
130 pass) tput setaf 2;; # green
131 info) tput setaf 3;; # brown
132 *) test -n "$quiet" && return;;
142 test -z "$1" && test -n "$quiet" && return
149 say_color error "error: $*"
158 test "${test_description}" != "" ||
159 error "Test script did not set test_description."
161 if test "$help" = "t"
163 echo "$test_description"
168 if test "$verbose" = "t"
172 exec 4>/dev/null 3>/dev/null
182 echo >&5 "FATAL: Unexpected exit with code $?"
188 # The semantics of the editor variables are that of invoking
189 # sh -c "$EDITOR \"$@\"" files ...
191 # If our trash directory contains shell metacharacters, they will be
192 # interpreted if we just set $EDITOR directly, so do a little dance with
193 # environment variables to work around this.
195 # In particular, quoting isn't enough, as the path may contain the same quote
200 VISUAL='"$FAKE_EDITOR"'
205 if test -z "${test_tick+set}"
209 test_tick=$(($test_tick + 60))
211 GIT_COMMITTER_DATE="$test_tick -0700"
212 GIT_AUTHOR_DATE="$test_tick -0700"
213 export GIT_COMMITTER_DATE GIT_AUTHOR_DATE
216 # Call test_commit with the arguments "<message> [<file> [<contents>]]"
218 # This will commit a file with the given contents and the given commit
219 # message. It will also add a tag with <message> as name.
221 # Both <file> and <contents> default to <message>.
225 echo "${3-$1}" > "$file" &&
228 git commit -m "$1" &&
232 # Call test_merge with the arguments "<message> <commit>", where <commit>
233 # can be a tag pointing to the commit-to-merge.
237 git merge -m "$1" "$2" &&
241 # This function helps systems where core.filemode=false is set.
242 # Use it instead of plain 'chmod +x' to set or unset the executable bit
243 # of a file in the working directory and add it to the index.
247 git update-index --add "--chmod=$@"
250 # Use test_set_prereq to tell that a particular prerequisite is available.
251 # The prerequisite can later be checked for in two ways:
253 # - Explicitly using test_have_prereq.
255 # - Implicitly by specifying the prerequisite tag in the calls to
256 # test_expect_{success,failure,code}.
258 # The single parameter is the prerequisite tag (a simple word, in all
259 # capital letters by convention).
262 satisfied="$satisfied$1 "
266 test_have_prereq () {
275 # You are not expected to call test_ok_ and test_failure_ directly, use
276 # the text_expect_* functions instead.
279 test_success=$(($test_success + 1))
280 say_color "" " ok $test_count: $@"
284 test_failure=$(($test_failure + 1))
285 say_color error "FAIL $test_count: $1"
287 echo "$@" | sed -e 's/^/ /'
288 test "$immediate" = "" || { trap - EXIT; exit 1; }
291 test_known_broken_ok_ () {
292 test_fixed=$(($test_fixed+1))
293 say_color "" " FIXED $test_count: $@"
296 test_known_broken_failure_ () {
297 test_broken=$(($test_broken+1))
298 say_color skip " still broken $test_count: $@"
302 test "$debug" = "" || eval "$1"
312 test_count=$(($test_count+1))
314 for skp in $GIT_SKIP_TESTS
316 case $this_test.$test_count in
321 if test -z "$to_skip" && test -n "$prereq" &&
322 ! test_have_prereq "$prereq"
328 say_color skip >&3 "skipping test: $@"
329 say_color skip "skip $test_count: $1"
338 test_expect_failure () {
339 test "$#" = 3 && { prereq=$1; shift; } || prereq=
341 error "bug in the test script: not 2 or 3 parameters to test-expect-failure"
344 say >&3 "checking known breakage: $2"
346 if [ "$?" = 0 -a "$eval_ret" = 0 ]
348 test_known_broken_ok_ "$1"
350 test_known_broken_failure_ "$1"
356 test_expect_success () {
357 test "$#" = 3 && { prereq=$1; shift; } || prereq=
359 error "bug in the test script: not 2 or 3 parameters to test-expect-success"
362 say >&3 "expecting success: $2"
364 if [ "$?" = 0 -a "$eval_ret" = 0 ]
374 test_expect_code () {
375 test "$#" = 4 && { prereq=$1; shift; } || prereq=
377 error "bug in the test script: not 3 or 4 parameters to test-expect-code"
380 say >&3 "expecting exit code $1: $3"
382 if [ "$?" = 0 -a "$eval_ret" = "$1" ]
392 # test_external runs external test scripts that provide continuous
393 # test output about their progress, and succeeds/fails on
394 # zero/non-zero exit code. It outputs the test output on stdout even
395 # in non-verbose mode, and announces the external script with "* run
396 # <n>: ..." before running it. When providing relative paths, keep in
397 # mind that all scripts run in "trash directory".
398 # Usage: test_external description command arguments...
399 # Example: test_external 'Perl API' perl ../path/to/test.pl
401 test "$#" = 4 && { prereq=$1; shift; } || prereq=
403 error >&5 "bug in the test script: not 3 or 4 parameters to test_external"
406 if ! test_skip "$descr" "$@"
408 # Announce the script to reduce confusion about the
409 # test output that follows.
410 say_color "" " run $test_count: $descr ($*)"
411 # Run command; redirect its stderr to &4 as in
412 # test_run_, but keep its stdout on our stdout even in
419 test_failure_ "$descr" "$@"
424 # Like test_external, but in addition tests that the command generated
425 # no output on stderr.
426 test_external_without_stderr () {
427 # The temporary file has no (and must have no) security
429 tmp="$TMPDIR"; if [ -z "$tmp" ]; then tmp=/tmp; fi
430 stderr="$tmp/git-external-stderr.$$.tmp"
431 test_external "$@" 4> "$stderr"
432 [ -f "$stderr" ] || error "Internal error: $stderr disappeared."
433 descr="no stderr: $1"
435 say >&3 "expecting no stderr from previous command"
436 if [ ! -s "$stderr" ]; then
440 if [ "$verbose" = t ]; then
441 output=`echo; echo Stderr is:; cat "$stderr"`
445 # rm first in case test_failure exits.
447 test_failure_ "$descr" "$@" "$output"
451 # This is not among top-level (test_expect_success | test_expect_failure)
452 # but is a prefix that can be used in the test script, like:
454 # test_expect_success 'complain and die' '
456 # do something else &&
457 # test_must_fail git checkout ../outerspace
460 # Writing this as "! git checkout ../outerspace" is wrong, because
461 # the failure could be due to a segv. We want a controlled failure.
465 test $? -gt 0 -a $? -le 129 -o $? -gt 192
468 # test_cmp is a helper function to compare actual and expected output.
469 # You can use it like:
471 # test_expect_success 'foo works' '
472 # echo expected >expected &&
474 # test_cmp expected actual
477 # This could be written as either "cmp" or "diff -u", but:
478 # - cmp's output is not nearly as easy to read as diff -u
479 # - not all diff versions understand "-u"
485 # Most tests can use the created repository, but some may need to create more.
486 # Usage: test_create_repo <directory>
487 test_create_repo () {
489 error "bug in the test script: not 1 parameter to test-create-repo"
493 cd "$repo" || error "Cannot setup test environment"
494 "$GIT_EXEC_PATH/git-init" "--template=$owd/../templates/blt/" >&3 2>&4 ||
495 error "cannot run git init -- have you built things yet?"
496 mv .git/hooks .git/hooks-disabled
502 test_results_dir="$TEST_DIRECTORY/test-results"
503 mkdir -p "$test_results_dir"
504 test_results_path="$test_results_dir/${0%.sh}-$$"
506 echo "total $test_count" >> $test_results_path
507 echo "success $test_success" >> $test_results_path
508 echo "fixed $test_fixed" >> $test_results_path
509 echo "broken $test_broken" >> $test_results_path
510 echo "failed $test_failure" >> $test_results_path
511 echo "" >> $test_results_path
513 if test "$test_fixed" != 0
515 say_color pass "fixed $test_fixed known breakage(s)"
517 if test "$test_broken" != 0
519 say_color error "still have $test_broken known breakage(s)"
520 msg="remaining $(($test_count-$test_broken)) test(s)"
522 msg="$test_count test(s)"
524 case "$test_failure" in
527 # cd .. && rm -fr 'trash directory'
528 # but that means we forbid any tests that use their own
529 # subdirectory from calling test_done without coming back
530 # to where they started from.
531 # The Makefile provided will clean this test area so
532 # we will leave things as they are.
534 say_color pass "passed all $msg"
536 test -d "$remove_trash" &&
537 cd "$(dirname "$remove_trash")" &&
538 rm -rf "$(basename "$remove_trash")"
543 say_color error "failed $test_failure among $msg"
549 # Test the binaries we have just built. The tests are kept in
550 # t/ subdirectory and are run in 'trash directory' subdirectory.
551 TEST_DIRECTORY=$(pwd)
552 if test -z "$valgrind"
554 if test -z "$GIT_TEST_INSTALLED"
556 PATH=$TEST_DIRECTORY/..:$PATH
557 GIT_EXEC_PATH=$TEST_DIRECTORY/..
559 GIT_EXEC_PATH=$($GIT_TEST_INSTALLED/git --exec-path) ||
560 error "Cannot run git from $GIT_TEST_INSTALLED."
561 PATH=$GIT_TEST_INSTALLED:$TEST_DIRECTORY/..:$PATH
562 GIT_EXEC_PATH=${GIT_TEST_EXEC_PATH:-$GIT_EXEC_PATH}
567 test "$1" = "$(readlink "$2")" || {
575 while test -d "$2".lock
577 say "Waiting for lock on $2."
584 make_valgrind_symlink () {
585 # handle only executables
586 test -x "$1" || return
588 base=$(basename "$1")
589 symlink_target=$TEST_DIRECTORY/../$base
590 # do not override scripts
591 if test -x "$symlink_target" &&
592 test ! -d "$symlink_target" &&
593 test "#!" != "$(head -c 2 < "$symlink_target")"
595 symlink_target=../valgrind.sh
599 symlink_target=../unprocessed-script
601 # create the link, or replace it if it is out of date
602 make_symlink "$symlink_target" "$GIT_VALGRIND/bin/$base" || exit
605 # override all git executables in TEST_DIRECTORY/..
606 GIT_VALGRIND=$TEST_DIRECTORY/valgrind
607 mkdir -p "$GIT_VALGRIND"/bin
608 for file in $TEST_DIRECTORY/../git* $TEST_DIRECTORY/../test-*
610 make_valgrind_symlink $file
616 ls "$path"/git-* 2> /dev/null |
619 make_valgrind_symlink "$file"
623 PATH=$GIT_VALGRIND/bin:$PATH
624 GIT_EXEC_PATH=$GIT_VALGRIND/bin
627 GIT_TEMPLATE_DIR=$(pwd)/../templates/blt
629 GIT_CONFIG_NOSYSTEM=1
630 GIT_CONFIG_NOGLOBAL=1
631 export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG_NOSYSTEM GIT_CONFIG_NOGLOBAL
633 GITPERLLIB=$(pwd)/../perl/blib/lib:$(pwd)/../perl/blib/arch/auto/Git
635 test -d ../templates/blt || {
636 error "You haven't built things yet, have you?"
639 if ! test -x ../test-chmtime; then
640 echo >&2 'You need to build test-chmtime:'
641 echo >&2 'Run "make test-chmtime" in the source (toplevel) directory'
645 . ../GIT-BUILD-OPTIONS
648 test="trash directory.$(basename "$0" .sh)"
649 test ! -z "$debug" || remove_trash="$TEST_DIRECTORY/$test"
652 echo >&5 "FATAL: Cannot prepare test area"
656 test_create_repo "$test"
657 # Use -P to resolve symlinks in our working directory so that the cwd
658 # in subprocesses like git equals our $PWD (for pathname comparisons).
659 cd -P "$test" || exit 1
662 this_test=${this_test%%-*}
663 for skp in $GIT_SKIP_TESTS
666 for skp in $GIT_SKIP_TESTS
675 say_color skip >&3 "skipping test $this_test altogether"
676 say_color skip "skip all tests in $this_test"
681 # Fix some commands on Windows
684 # Windows has its own (incompatible) sort and find
694 # git sees Windows-style pwd
698 # no POSIX permissions
699 # backslashes in pathspec are converted to '/'
700 # exec does not inherit the PID
703 test_set_prereq POSIXPERM
704 test_set_prereq BSLASHPSPEC
705 test_set_prereq EXECKEEPSPID
709 # test whether the filesystem supports symbolic links
710 ln -s x y 2>/dev/null && test -h y 2>/dev/null && test_set_prereq SYMLINKS