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
45 # A call to "unset" with no arguments causes at least Solaris 10
46 # /usr/xpg4/bin/sh and /bin/ksh to bail out. So keep the unsets
47 # deriving from the command substitution clustered with the other
49 unset VISUAL EMAIL LANGUAGE COLUMNS $(perl -e '
51 my $ok = join("|", qw(
59 PERF_AGGREGATING_LATER
61 my @vars = grep(/^GIT_/ && !/^GIT_($ok)/o, @env);
62 print join("\n", @vars);
65 GIT_AUTHOR_EMAIL=author@example.com
66 GIT_AUTHOR_NAME='A U Thor'
67 GIT_COMMITTER_EMAIL=committer@example.com
68 GIT_COMMITTER_NAME='C O Mitter'
71 export GIT_MERGE_VERBOSITY GIT_MERGE_AUTOEDIT
72 export GIT_AUTHOR_EMAIL GIT_AUTHOR_NAME
73 export GIT_COMMITTER_EMAIL GIT_COMMITTER_NAME
76 # Protect ourselves from common misconfiguration to export
77 # CDPATH into the environment
82 case $(echo $GIT_TRACE |tr "[A-Z]" "[a-z]") in
84 echo "* warning: Some tests will not work if GIT_TRACE" \
85 "is set as to trace on STDERR ! *"
86 echo "* warning: Please set GIT_TRACE to something" \
87 "other than 1, 2 or true ! *"
93 # A regexp to match 5 and 40 hexdigits
94 _x05='[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
95 _x40="$_x05$_x05$_x05$_x05$_x05$_x05$_x05$_x05"
98 _z40=0000000000000000000000000000000000000000
104 export _x05 _x40 _z40 LF
106 # Each test should start with something like this, after copyright notices:
108 # test_description='Description of this test...
109 # This test checks if command xyzzy does the right thing...
112 [ "x$ORIGINAL_TERM" != "xdumb" ] && (
113 TERM=$ORIGINAL_TERM &&
116 tput bold >/dev/null 2>&1 &&
117 tput setaf 1 >/dev/null 2>&1 &&
118 tput sgr0 >/dev/null 2>&1
122 while test "$#" -ne 0
125 -d|--d|--de|--deb|--debu|--debug)
127 -i|--i|--im|--imm|--imme|--immed|--immedi|--immedia|--immediat|--immediate)
128 immediate=t; shift ;;
129 -l|--l|--lo|--lon|--long|--long-|--long-t|--long-te|--long-tes|--long-test|--long-tests)
130 GIT_TEST_LONG=t; export GIT_TEST_LONG; shift ;;
131 -h|--h|--he|--hel|--help)
133 -v|--v|--ve|--ver|--verb|--verbo|--verbos|--verbose)
135 -q|--q|--qu|--qui|--quie|--quiet)
136 # Ignore --quiet under a TAP::Harness. Saying how many tests
137 # passed without the ok/not ok details is always an error.
138 test -z "$HARNESS_ACTIVE" && quiet=t; shift ;;
140 with_dashes=t; shift ;;
143 --va|--val|--valg|--valgr|--valgri|--valgrin|--valgrind)
144 valgrind=t; verbose=t; shift ;;
146 shift ;; # was handled already
148 root=$(expr "z$1" : 'z[^=]*=\(.*\)')
151 echo "error: unknown test option '$1'" >&2; exit 1 ;;
155 if test -n "$color"; then
161 error) tput bold; tput setaf 1;; # bold red
162 skip) tput bold; tput setaf 2;; # bold green
163 pass) tput setaf 2;; # green
164 info) tput setaf 3;; # brown
165 *) test -n "$quiet" && return;;
175 test -z "$1" && test -n "$quiet" && return
182 say_color error "error: $*"
191 test "${test_description}" != "" ||
192 error "Test script did not set test_description."
194 if test "$help" = "t"
196 echo "$test_description"
202 if test "$verbose" = "t"
206 exec 4>/dev/null 3>/dev/null
215 test_external_has_tap=0
219 if test -n "$GIT_EXIT_OK"
223 echo >&5 "FATAL: Unexpected exit with code $code"
231 # The user-facing functions are loaded from a separate file so that
232 # test_perf subshells can have them too
233 . "${TEST_DIRECTORY:-.}"/test-lib-functions.sh
235 # You are not expected to call test_ok_ and test_failure_ directly, use
236 # the text_expect_* functions instead.
239 test_success=$(($test_success + 1))
240 say_color "" "ok $test_count - $@"
244 test_failure=$(($test_failure + 1))
245 say_color error "not ok - $test_count $1"
247 echo "$@" | sed -e 's/^/# /'
248 test "$immediate" = "" || { GIT_EXIT_OK=t; exit 1; }
251 test_known_broken_ok_ () {
252 test_fixed=$(($test_fixed+1))
253 say_color "" "ok $test_count - $@ # TODO known breakage"
256 test_known_broken_failure_ () {
257 test_broken=$(($test_broken+1))
258 say_color skip "not ok $test_count - $@ # TODO known breakage"
262 test "$debug" = "" || eval "$1"
266 # This is a separate function because some tests use
267 # "return" to end a test_expect_success block early.
268 eval </dev/null >&3 2>&4 "$*"
277 if test -z "$immediate" || test $eval_ret = 0 || test -n "$expecting_failure"
279 test_eval_ "$test_cleanup"
281 if test "$verbose" = "t" && test -n "$HARNESS_ACTIVE"; then
288 test_count=$(($test_count+1))
290 for skp in $GIT_SKIP_TESTS
292 case $this_test.$test_count in
298 if test -z "$to_skip" && test -n "$test_prereq" &&
299 ! test_have_prereq "$test_prereq"
306 if test "$missing_prereq" != "$test_prereq"
308 of_prereq=" of $test_prereq"
311 say_color skip >&3 "skipping test: $@"
312 say_color skip "ok $test_count # skip $1 (missing $missing_prereq${of_prereq})"
321 # stub; perf-lib overrides it
322 test_at_end_hook_ () {
329 if test -z "$HARNESS_ACTIVE"; then
330 test_results_dir="$TEST_OUTPUT_DIRECTORY/test-results"
331 mkdir -p "$test_results_dir"
332 test_results_path="$test_results_dir/${0%.sh}-$$.counts"
334 cat >>"$test_results_path" <<-EOF
336 success $test_success
344 if test "$test_fixed" != 0
346 say_color pass "# fixed $test_fixed known breakage(s)"
348 if test "$test_broken" != 0
350 say_color error "# still have $test_broken known breakage(s)"
351 msg="remaining $(($test_count-$test_broken)) test(s)"
353 msg="$test_count test(s)"
355 case "$test_failure" in
357 # Maybe print SKIP message
358 [ -z "$skip_all" ] || skip_all=" # SKIP $skip_all"
360 if test $test_external_has_tap -eq 0; then
361 say_color pass "# passed all $msg"
362 say "1..$test_count$skip_all"
365 test -d "$remove_trash" &&
366 cd "$(dirname "$remove_trash")" &&
367 rm -rf "$(basename "$remove_trash")"
374 if test $test_external_has_tap -eq 0; then
375 say_color error "# failed $test_failure among $msg"
384 # Test the binaries we have just built. The tests are kept in
385 # t/ subdirectory and are run in 'trash directory' subdirectory.
386 if test -z "$TEST_DIRECTORY"
388 # We allow tests to override this, in case they want to run tests
389 # outside of t/, e.g. for running tests on the test library
391 TEST_DIRECTORY=$(pwd)
393 if test -z "$TEST_OUTPUT_DIRECTORY"
395 # Similarly, override this to store the test-results subdir
397 TEST_OUTPUT_DIRECTORY=$TEST_DIRECTORY
399 GIT_BUILD_DIR="$TEST_DIRECTORY"/..
401 if test -n "$valgrind"
405 test "$1" = "$(readlink "$2")" || {
413 while test -d "$2".lock
415 say "Waiting for lock on $2."
422 make_valgrind_symlink () {
423 # handle only executables, unless they are shell libraries that
424 # need to be in the exec-path. We will just use "#!" as a
425 # guess for a shell-script, since we have no idea what the user
426 # may have configured as the shell path.
428 test "#!" = "$(head -c 2 <"$1")" ||
431 base=$(basename "$1")
432 symlink_target=$GIT_BUILD_DIR/$base
433 # do not override scripts
434 if test -x "$symlink_target" &&
435 test ! -d "$symlink_target" &&
436 test "#!" != "$(head -c 2 < "$symlink_target")"
438 symlink_target=../valgrind.sh
442 symlink_target=../unprocessed-script
444 # create the link, or replace it if it is out of date
445 make_symlink "$symlink_target" "$GIT_VALGRIND/bin/$base" || exit
448 # override all git executables in TEST_DIRECTORY/..
449 GIT_VALGRIND=$TEST_DIRECTORY/valgrind
450 mkdir -p "$GIT_VALGRIND"/bin
451 for file in $GIT_BUILD_DIR/git* $GIT_BUILD_DIR/test-*
453 make_valgrind_symlink $file
455 # special-case the mergetools loadables
456 make_symlink "$GIT_BUILD_DIR"/mergetools "$GIT_VALGRIND/bin/mergetools"
461 ls "$path"/git-* 2> /dev/null |
464 make_valgrind_symlink "$file"
468 PATH=$GIT_VALGRIND/bin:$PATH
469 GIT_EXEC_PATH=$GIT_VALGRIND/bin
471 elif test -n "$GIT_TEST_INSTALLED" ; then
472 GIT_EXEC_PATH=$($GIT_TEST_INSTALLED/git --exec-path) ||
473 error "Cannot run git from $GIT_TEST_INSTALLED."
474 PATH=$GIT_TEST_INSTALLED:$GIT_BUILD_DIR:$PATH
475 GIT_EXEC_PATH=${GIT_TEST_EXEC_PATH:-$GIT_EXEC_PATH}
476 else # normal case, use ../bin-wrappers only unless $with_dashes:
477 git_bin_dir="$GIT_BUILD_DIR/bin-wrappers"
478 if ! test -x "$git_bin_dir/git" ; then
479 if test -z "$with_dashes" ; then
480 say "$git_bin_dir/git is not executable; using GIT_EXEC_PATH"
484 PATH="$git_bin_dir:$PATH"
485 GIT_EXEC_PATH=$GIT_BUILD_DIR
486 if test -n "$with_dashes" ; then
487 PATH="$GIT_BUILD_DIR:$PATH"
490 GIT_TEMPLATE_DIR="$GIT_BUILD_DIR"/templates/blt
492 GIT_CONFIG_NOSYSTEM=1
494 export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG_NOSYSTEM GIT_ATTR_NOSYSTEM
496 . "$GIT_BUILD_DIR"/GIT-BUILD-OPTIONS
500 if test -z "$GIT_TEST_CMP"
502 if test -n "$GIT_TEST_CMP_USE_COPIED_CONTEXT"
504 GIT_TEST_CMP="$DIFF -c"
506 GIT_TEST_CMP="$DIFF -u"
510 GITPERLLIB="$GIT_BUILD_DIR"/perl/blib/lib:"$GIT_BUILD_DIR"/perl/blib/arch/auto/Git
512 test -d "$GIT_BUILD_DIR"/templates/blt || {
513 error "You haven't built things yet, have you?"
516 if test -z "$GIT_TEST_INSTALLED" && test -z "$NO_PYTHON"
518 GITPYTHONLIB="$GIT_BUILD_DIR/git_remote_helpers/build/lib"
520 test -d "$GIT_BUILD_DIR"/git_remote_helpers/build || {
521 error "You haven't built git_remote_helpers yet, have you?"
525 if ! test -x "$GIT_BUILD_DIR"/test-chmtime; then
526 echo >&2 'You need to build test-chmtime:'
527 echo >&2 'Run "make test-chmtime" in the source (toplevel) directory'
532 test="trash directory.$(basename "$0" .sh)"
533 test -n "$root" && test="$root/$test"
535 /*) TRASH_DIRECTORY="$test" ;;
536 *) TRASH_DIRECTORY="$TEST_OUTPUT_DIRECTORY/$test" ;;
538 test ! -z "$debug" || remove_trash=$TRASH_DIRECTORY
541 echo >&5 "FATAL: Cannot prepare test area"
545 HOME="$TRASH_DIRECTORY"
548 if test -z "$TEST_NO_CREATE_REPO"; then
549 test_create_repo "$test"
553 # Use -P to resolve symlinks in our working directory so that the cwd
554 # in subprocesses like git equals our $PWD (for pathname comparisons).
555 cd -P "$test" || exit 1
558 this_test=${this_test%%-*}
559 for skp in $GIT_SKIP_TESTS
563 say_color skip >&3 "skipping test $this_test altogether"
564 skip_all="skip all tests in $this_test"
569 # Provide an implementation of the 'yes' utility
584 # Fix some commands on Windows
587 # Windows has its own (incompatible) sort and find
597 # git sees Windows-style pwd
601 # no POSIX permissions
602 # backslashes in pathspec are converted to '/'
603 # exec does not inherit the PID
604 test_set_prereq MINGW
605 test_set_prereq SED_STRIPS_CR
608 test_set_prereq POSIXPERM
609 test_set_prereq EXECKEEPSPID
610 test_set_prereq NOT_MINGW
611 test_set_prereq SED_STRIPS_CR
614 test_set_prereq POSIXPERM
615 test_set_prereq BSLASHPSPEC
616 test_set_prereq EXECKEEPSPID
617 test_set_prereq NOT_MINGW
621 ( COLUMNS=1 && test $COLUMNS = 1 ) && test_set_prereq COLUMNS_CAN_BE_1
622 test -z "$NO_PERL" && test_set_prereq PERL
623 test -z "$NO_PYTHON" && test_set_prereq PYTHON
624 test -n "$USE_LIBPCRE" && test_set_prereq LIBPCRE
625 test -z "$NO_GETTEXT" && test_set_prereq GETTEXT
627 # Can we rely on git's output in the C locale?
628 if test -n "$GETTEXT_POISON"
630 GIT_GETTEXT_POISON=YesPlease
631 export GIT_GETTEXT_POISON
632 test_set_prereq GETTEXT_POISON
634 test_set_prereq C_LOCALE_OUTPUT
637 # Use this instead of test_cmp to compare files that contain expected and
638 # actual output from git commands that can be translated. When running
639 # under GETTEXT_POISON this pretends that the command produced expected
642 test -n "$GETTEXT_POISON" || test_cmp "$@"
645 # Use this instead of "grep expected-string actual" to see if the
646 # output from a git command that can be translated either contains an
647 # expected string, or does not contain an unwanted one. When running
648 # under GETTEXT_POISON this pretends that the command produced expected
651 if test -n "$GETTEXT_POISON"
654 elif test "x!" = "x$1"
663 # test whether the filesystem supports symbolic links
664 ln -s x y 2>/dev/null && test -h y 2>/dev/null && test_set_prereq SYMLINKS
667 # When the tests are run as root, permission tests will report that
668 # things are writable when they shouldn't be.
669 test -w / || test_set_prereq SANITY