Enable color output in Windows cmd.exe
[git/dscho.git] / t / test-lib.sh
blob0c3518205fb35914a77687405b454761dba982f4
1 #!/bin/sh
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 # for git on windows so stdin will not be misdetected as attached to a
19 # terminal
20 exec < /dev/null
22 # if --tee was passed, write the output not only to the terminal, but
23 # additionally to the file test-results/$BASENAME.out, too.
24 case "$GIT_TEST_TEE_STARTED, $* " in
25 done,*)
26 # do not redirect again
28 *' --tee '*|*' --va'*)
29 mkdir -p test-results
30 BASE=test-results/$(basename "$0" .sh)
31 (GIT_TEST_TEE_STARTED=done ${SHELL-sh} "$0" "$@" 2>&1;
32 echo $? > $BASE.exit) | tee $BASE.out
33 test "$(cat $BASE.exit)" = 0
34 exit
36 esac
38 # Keep the original TERM for say_color
39 ORIGINAL_TERM=$TERM
41 # For repeatability, reset the environment to known value.
42 LANG=C
43 LC_ALL=C
44 PAGER=cat
45 TZ=UTC
46 TERM=dumb
47 export LANG LC_ALL PAGER TERM TZ
48 EDITOR=:
49 # A call to "unset" with no arguments causes at least Solaris 10
50 # /usr/xpg4/bin/sh and /bin/ksh to bail out. So keep the unsets
51 # deriving from the command substitution clustered with the other
52 # ones.
53 unset VISUAL EMAIL LANGUAGE $(perl -e '
54 my @env = keys %ENV;
55 my $ok = join("|", qw(
56 TRACE
57 DEBUG
58 USE_LOOKUP
59 TEST
60 .*_TEST
61 PROVE
62 VALGRIND
63 PERF_AGGREGATING_LATER
64 ));
65 my @vars = grep(/^GIT_/ && !/^GIT_($ok)/o, @env);
66 print join("\n", @vars);
68 GIT_AUTHOR_EMAIL=author@example.com
69 GIT_AUTHOR_NAME='A U Thor'
70 GIT_COMMITTER_EMAIL=committer@example.com
71 GIT_COMMITTER_NAME='C O Mitter'
72 GIT_MERGE_VERBOSITY=5
73 GIT_MERGE_AUTOEDIT=no
74 export GIT_MERGE_VERBOSITY GIT_MERGE_AUTOEDIT
75 export GIT_AUTHOR_EMAIL GIT_AUTHOR_NAME
76 export GIT_COMMITTER_EMAIL GIT_COMMITTER_NAME
77 export EDITOR
79 # Protect ourselves from common misconfiguration to export
80 # CDPATH into the environment
81 unset CDPATH
83 unset GREP_OPTIONS
85 case $(echo $GIT_TRACE |tr "[A-Z]" "[a-z]") in
86 1|2|true)
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 ! *"
92 esac
94 # Convenience
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 # Zero SHA-1
101 _z40=0000000000000000000000000000000000000000
103 # Line feed
104 LF='
107 export _x05 _x40 _z40 LF
109 # Each test should start with something like this, after copyright notices:
111 # test_description='Description of this test...
112 # This test checks if command xyzzy does the right thing...
114 # . ./test-lib.sh
115 [ "x$ORIGINAL_TERM" != "xdumb" ] && (
116 TERM=$ORIGINAL_TERM &&
117 export TERM &&
118 [ -t 1 ] &&
119 tput bold >/dev/null 2>&1 &&
120 tput setaf 1 >/dev/null 2>&1 &&
121 tput sgr0 >/dev/null 2>&1
122 ) &&
123 color=t
125 while test "$#" -ne 0
127 case "$1" in
128 -d|--d|--de|--deb|--debu|--debug)
129 debug=t; shift ;;
130 -i|--i|--im|--imm|--imme|--immed|--immedi|--immedia|--immediat|--immediate)
131 immediate=t; shift ;;
132 -l|--l|--lo|--lon|--long|--long-|--long-t|--long-te|--long-tes|--long-test|--long-tests)
133 GIT_TEST_LONG=t; export GIT_TEST_LONG; shift ;;
134 -h|--h|--he|--hel|--help)
135 help=t; shift ;;
136 -v|--v|--ve|--ver|--verb|--verbo|--verbos|--verbose)
137 verbose=t; shift ;;
138 -q|--q|--qu|--qui|--quie|--quiet)
139 # Ignore --quiet under a TAP::Harness. Saying how many tests
140 # passed without the ok/not ok details is always an error.
141 test -z "$HARNESS_ACTIVE" && quiet=t; shift ;;
142 --with-dashes)
143 with_dashes=t; shift ;;
144 --no-color)
145 color=; shift ;;
146 --va|--val|--valg|--valgr|--valgri|--valgrin|--valgrind)
147 valgrind=t; verbose=t; shift ;;
148 --tee)
149 shift ;; # was handled already
150 --root=*)
151 root=$(expr "z$1" : 'z[^=]*=\(.*\)')
152 shift ;;
154 echo "error: unknown test option '$1'" >&2; exit 1 ;;
155 esac
156 done
158 if test -n "$color"; then
159 say_color () {
161 TERM=$ORIGINAL_TERM
162 export TERM
163 case "$1" in
164 error) tput bold; tput setaf 1;; # bold red
165 skip) tput bold; tput setaf 2;; # bold green
166 pass) tput setaf 2;; # green
167 info) tput setaf 3;; # brown
168 *) test -n "$quiet" && return;;
169 esac
170 shift
171 printf "%s" "$*"
172 tput sgr0
173 echo
176 else
177 say_color() {
178 test -z "$1" && test -n "$quiet" && return
179 shift
180 echo "$*"
184 error () {
185 say_color error "error: $*"
186 GIT_EXIT_OK=t
187 exit 1
190 say () {
191 say_color info "$*"
194 test "${test_description}" != "" ||
195 error "Test script did not set test_description."
197 if test "$help" = "t"
198 then
199 echo "$test_description"
200 exit 0
203 exec 5>&1
204 exec 6<&0
205 if test "$verbose" = "t"
206 then
207 exec 4>&2 3>&1
208 else
209 exec 4>/dev/null 3>/dev/null
212 test_failure=0
213 test_count=0
214 test_fixed=0
215 test_broken=0
216 test_success=0
218 test_external_has_tap=0
220 die () {
221 code=$?
222 if test -n "$GIT_EXIT_OK"
223 then
224 exit $code
225 else
226 echo >&5 "FATAL: Unexpected exit with code $code"
227 exit 1
231 GIT_EXIT_OK=
232 trap 'die' EXIT
234 # The user-facing functions are loaded from a separate file so that
235 # test_perf subshells can have them too
236 . "${TEST_DIRECTORY:-.}"/test-lib-functions.sh
238 # You are not expected to call test_ok_ and test_failure_ directly, use
239 # the text_expect_* functions instead.
241 test_ok_ () {
242 test_success=$(($test_success + 1))
243 say_color "" "ok $test_count - $@"
246 test_failure_ () {
247 test_failure=$(($test_failure + 1))
248 say_color error "not ok - $test_count $1"
249 shift
250 echo "$@" | sed -e 's/^/# /'
251 test "$immediate" = "" || { GIT_EXIT_OK=t; exit 1; }
254 test_known_broken_ok_ () {
255 test_fixed=$(($test_fixed+1))
256 say_color "" "ok $test_count - $@ # TODO known breakage"
259 test_known_broken_failure_ () {
260 test_broken=$(($test_broken+1))
261 say_color skip "not ok $test_count - $@ # TODO known breakage"
264 test_debug () {
265 test "$debug" = "" || eval "$1"
268 test_eval_ () {
269 # This is a separate function because some tests use
270 # "return" to end a test_expect_success block early.
271 eval </dev/null >&3 2>&4 "$*"
274 test_run_ () {
275 test_cleanup=:
276 expecting_failure=$2
277 test_eval_ "$1"
278 eval_ret=$?
280 if test -z "$immediate" || test $eval_ret = 0 || test -n "$expecting_failure"
281 then
282 test_eval_ "$test_cleanup"
284 if test "$verbose" = "t" && test -n "$HARNESS_ACTIVE"; then
285 echo ""
287 return "$eval_ret"
290 test_skip () {
291 test_count=$(($test_count+1))
292 to_skip=
293 for skp in $GIT_SKIP_TESTS
295 case $this_test.$test_count in
296 $skp)
297 to_skip=t
298 break
299 esac
300 done
301 if test -z "$to_skip" && test -n "$test_prereq" &&
302 ! test_have_prereq "$test_prereq"
303 then
304 to_skip=t
306 case "$to_skip" in
308 of_prereq=
309 if test "$missing_prereq" != "$test_prereq"
310 then
311 of_prereq=" of $test_prereq"
314 say_color skip >&3 "skipping test: $@"
315 say_color skip "ok $test_count # skip $1 (missing $missing_prereq${of_prereq})"
316 : true
319 false
321 esac
324 # stub; perf-lib overrides it
325 test_at_end_hook_ () {
329 test_done () {
330 GIT_EXIT_OK=t
332 if test -z "$HARNESS_ACTIVE"; then
333 test_results_dir="$TEST_OUTPUT_DIRECTORY/test-results"
334 mkdir -p "$test_results_dir"
335 test_results_path="$test_results_dir/${0%.sh}-$$.counts"
337 cat >>"$test_results_path" <<-EOF
338 total $test_count
339 success $test_success
340 fixed $test_fixed
341 broken $test_broken
342 failed $test_failure
347 if test "$test_fixed" != 0
348 then
349 say_color pass "# fixed $test_fixed known breakage(s)"
351 if test "$test_broken" != 0
352 then
353 say_color error "# still have $test_broken known breakage(s)"
354 msg="remaining $(($test_count-$test_broken)) test(s)"
355 else
356 msg="$test_count test(s)"
358 case "$test_failure" in
360 # Maybe print SKIP message
361 [ -z "$skip_all" ] || skip_all=" # SKIP $skip_all"
363 if test $test_external_has_tap -eq 0; then
364 say_color pass "# passed all $msg"
365 say "1..$test_count$skip_all"
368 test -d "$remove_trash" &&
369 cd "$(dirname "$remove_trash")" &&
370 rm -rf "$(basename "$remove_trash")"
372 test_at_end_hook_
374 exit 0 ;;
377 if test $test_external_has_tap -eq 0; then
378 say_color error "# failed $test_failure among $msg"
379 say "1..$test_count"
382 exit 1 ;;
384 esac
387 # Test the binaries we have just built. The tests are kept in
388 # t/ subdirectory and are run in 'trash directory' subdirectory.
389 if test -z "$TEST_DIRECTORY"
390 then
391 # We allow tests to override this, in case they want to run tests
392 # outside of t/, e.g. for running tests on the test library
393 # itself.
394 TEST_DIRECTORY=$(pwd)
396 if test -z "$TEST_OUTPUT_DIRECTORY"
397 then
398 # Similarly, override this to store the test-results subdir
399 # elsewhere
400 TEST_OUTPUT_DIRECTORY=$TEST_DIRECTORY
402 GIT_BUILD_DIR="$TEST_DIRECTORY"/..
404 if test -n "$valgrind"
405 then
406 make_symlink () {
407 test -h "$2" &&
408 test "$1" = "$(readlink "$2")" || {
409 # be super paranoid
410 if mkdir "$2".lock
411 then
412 rm -f "$2" &&
413 ln -s "$1" "$2" &&
414 rm -r "$2".lock
415 else
416 while test -d "$2".lock
418 say "Waiting for lock on $2."
419 sleep 1
420 done
425 make_valgrind_symlink () {
426 # handle only executables, unless they are shell libraries that
427 # need to be in the exec-path. We will just use "#!" as a
428 # guess for a shell-script, since we have no idea what the user
429 # may have configured as the shell path.
430 test -x "$1" ||
431 test "#!" = "$(head -c 2 <"$1")" ||
432 return;
434 base=$(basename "$1")
435 symlink_target=$GIT_BUILD_DIR/$base
436 # do not override scripts
437 if test -x "$symlink_target" &&
438 test ! -d "$symlink_target" &&
439 test "#!" != "$(head -c 2 < "$symlink_target")"
440 then
441 symlink_target=../valgrind.sh
443 case "$base" in
444 *.sh|*.perl)
445 symlink_target=../unprocessed-script
446 esac
447 # create the link, or replace it if it is out of date
448 make_symlink "$symlink_target" "$GIT_VALGRIND/bin/$base" || exit
451 # override all git executables in TEST_DIRECTORY/..
452 GIT_VALGRIND=$TEST_DIRECTORY/valgrind
453 mkdir -p "$GIT_VALGRIND"/bin
454 for file in $GIT_BUILD_DIR/git* $GIT_BUILD_DIR/test-*
456 make_valgrind_symlink $file
457 done
458 # special-case the mergetools loadables
459 make_symlink "$GIT_BUILD_DIR"/mergetools "$GIT_VALGRIND/bin/mergetools"
460 OLDIFS=$IFS
461 IFS=:
462 for path in $PATH
464 ls "$path"/git-* 2> /dev/null |
465 while read file
467 make_valgrind_symlink "$file"
468 done
469 done
470 IFS=$OLDIFS
471 PATH=$GIT_VALGRIND/bin:$PATH
472 GIT_EXEC_PATH=$GIT_VALGRIND/bin
473 export GIT_VALGRIND
474 elif test -n "$GIT_TEST_INSTALLED" ; then
475 GIT_EXEC_PATH=$($GIT_TEST_INSTALLED/git --exec-path) ||
476 error "Cannot run git from $GIT_TEST_INSTALLED."
477 PATH=$GIT_TEST_INSTALLED:$GIT_BUILD_DIR:$PATH
478 GIT_EXEC_PATH=${GIT_TEST_EXEC_PATH:-$GIT_EXEC_PATH}
479 else # normal case, use ../bin-wrappers only unless $with_dashes:
480 git_bin_dir="$GIT_BUILD_DIR/bin-wrappers"
481 if ! test -x "$git_bin_dir/git" ; then
482 if test -z "$with_dashes" ; then
483 say "$git_bin_dir/git is not executable; using GIT_EXEC_PATH"
485 with_dashes=t
487 PATH="$git_bin_dir:$PATH"
488 GIT_EXEC_PATH=$GIT_BUILD_DIR
489 if test -n "$with_dashes" ; then
490 PATH="$GIT_BUILD_DIR:$PATH"
493 GIT_TEMPLATE_DIR="$GIT_BUILD_DIR"/templates/blt
494 unset GIT_CONFIG
495 GIT_CONFIG_NOSYSTEM=1
496 GIT_ATTR_NOSYSTEM=1
497 export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG_NOSYSTEM GIT_ATTR_NOSYSTEM
499 . "$GIT_BUILD_DIR"/GIT-BUILD-OPTIONS
501 if test -z "$GIT_TEST_CMP"
502 then
503 if test -n "$GIT_TEST_CMP_USE_COPIED_CONTEXT"
504 then
505 GIT_TEST_CMP="$DIFF -c"
506 else
507 GIT_TEST_CMP="$DIFF -u"
511 GITPERLLIB="$GIT_BUILD_DIR"/perl/blib/lib:"$GIT_BUILD_DIR"/perl/blib/arch/auto/Git
512 export GITPERLLIB
513 test -d "$GIT_BUILD_DIR"/templates/blt || {
514 error "You haven't built things yet, have you?"
517 if test -z "$GIT_TEST_INSTALLED" && test -z "$NO_PYTHON"
518 then
519 GITPYTHONLIB="$GIT_BUILD_DIR/git_remote_helpers/build/lib"
520 export GITPYTHONLIB
521 test -d "$GIT_BUILD_DIR"/git_remote_helpers/build || {
522 error "You haven't built git_remote_helpers yet, have you?"
526 if ! test -x "$GIT_BUILD_DIR"/test-chmtime; then
527 echo >&2 'You need to build test-chmtime:'
528 echo >&2 'Run "make test-chmtime" in the source (toplevel) directory'
529 exit 1
532 # Test repository
533 test="trash directory.$(basename "$0" .sh)"
534 test -n "$root" && test="$root/$test"
535 case "$test" in
536 /*) TRASH_DIRECTORY="$test" ;;
537 *) TRASH_DIRECTORY="$TEST_OUTPUT_DIRECTORY/$test" ;;
538 esac
539 test ! -z "$debug" || remove_trash=$TRASH_DIRECTORY
540 rm -fr "$test" || {
541 GIT_EXIT_OK=t
542 echo >&5 "FATAL: Cannot prepare test area"
543 exit 1
546 HOME="$TRASH_DIRECTORY"
547 export HOME
549 if test -z "$TEST_NO_CREATE_REPO"; then
550 test_create_repo "$test"
551 else
552 mkdir -p "$test"
554 # Use -P to resolve symlinks in our working directory so that the cwd
555 # in subprocesses like git equals our $PWD (for pathname comparisons).
556 cd -P "$test" || exit 1
558 this_test=${0##*/}
559 this_test=${this_test%%-*}
560 for skp in $GIT_SKIP_TESTS
562 case "$this_test" in
563 $skp)
564 say_color skip >&3 "skipping test $this_test altogether"
565 skip_all="skip all tests in $this_test"
566 test_done
567 esac
568 done
570 # Provide an implementation of the 'yes' utility
571 yes () {
572 if test $# = 0
573 then
575 else
576 y="$*"
579 while echo "$y"
582 done
585 # Fix some commands on Windows
586 case $(uname -s) in
587 *MINGW*)
588 # Windows has its own (incompatible) sort and find
589 sort () {
590 /usr/bin/sort "$@"
592 find () {
593 /usr/bin/find "$@"
595 sum () {
596 md5sum "$@"
598 # git sees Windows-style pwd
599 pwd () {
600 builtin pwd -W
602 # no POSIX permissions
603 # backslashes in pathspec are converted to '/'
604 # exec does not inherit the PID
605 test_set_prereq MINGW
606 test_set_prereq SED_STRIPS_CR
608 *CYGWIN*)
609 test_set_prereq POSIXPERM
610 test_set_prereq EXECKEEPSPID
611 test_set_prereq NOT_MINGW
612 test_set_prereq SED_STRIPS_CR
615 test_set_prereq POSIXPERM
616 test_set_prereq BSLASHPSPEC
617 test_set_prereq EXECKEEPSPID
618 test_set_prereq NOT_MINGW
620 esac
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"
629 then
630 GIT_GETTEXT_POISON=YesPlease
631 export GIT_GETTEXT_POISON
632 test_set_prereq GETTEXT_POISON
633 else
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
640 # results.
641 test_i18ncmp () {
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
649 # results.
650 test_i18ngrep () {
651 if test -n "$GETTEXT_POISON"
652 then
653 : # pretend success
654 elif test "x!" = "x$1"
655 then
656 shift
657 ! grep "$@"
658 else
659 grep "$@"
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
665 rm -f y
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