tests: paint unexpectedly fixed known breakages in bold red
[git.git] / t / test-lib.sh
blob30a0937dd726c8bf9667e2f9e8145d21584d271d
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 # 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
21 done,*)
22 # do not redirect again
24 *' --tee '*|*' --va'*)
25 mkdir -p test-results
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
30 exit
32 esac
34 # Keep the original TERM for say_color
35 ORIGINAL_TERM=$TERM
37 # Test the binaries we have just built. The tests are kept in
38 # t/ subdirectory and are run in 'trash directory' subdirectory.
39 if test -z "$TEST_DIRECTORY"
40 then
41 # We allow tests to override this, in case they want to run tests
42 # outside of t/, e.g. for running tests on the test library
43 # itself.
44 TEST_DIRECTORY=$(pwd)
46 if test -z "$TEST_OUTPUT_DIRECTORY"
47 then
48 # Similarly, override this to store the test-results subdir
49 # elsewhere
50 TEST_OUTPUT_DIRECTORY=$TEST_DIRECTORY
52 GIT_BUILD_DIR="$TEST_DIRECTORY"/..
54 . "$GIT_BUILD_DIR"/GIT-BUILD-OPTIONS
55 export PERL_PATH SHELL_PATH
57 # For repeatability, reset the environment to known value.
58 LANG=C
59 LC_ALL=C
60 PAGER=cat
61 TZ=UTC
62 TERM=dumb
63 export LANG LC_ALL PAGER TERM TZ
64 EDITOR=:
65 # A call to "unset" with no arguments causes at least Solaris 10
66 # /usr/xpg4/bin/sh and /bin/ksh to bail out. So keep the unsets
67 # deriving from the command substitution clustered with the other
68 # ones.
69 unset VISUAL EMAIL LANGUAGE COLUMNS $("$PERL_PATH" -e '
70 my @env = keys %ENV;
71 my $ok = join("|", qw(
72 TRACE
73 DEBUG
74 USE_LOOKUP
75 TEST
76 .*_TEST
77 PROVE
78 VALGRIND
79 PERF_AGGREGATING_LATER
80 ));
81 my @vars = grep(/^GIT_/ && !/^GIT_($ok)/o, @env);
82 print join("\n", @vars);
84 unset XDG_CONFIG_HOME
85 GIT_AUTHOR_EMAIL=author@example.com
86 GIT_AUTHOR_NAME='A U Thor'
87 GIT_COMMITTER_EMAIL=committer@example.com
88 GIT_COMMITTER_NAME='C O Mitter'
89 GIT_MERGE_VERBOSITY=5
90 GIT_MERGE_AUTOEDIT=no
91 export GIT_MERGE_VERBOSITY GIT_MERGE_AUTOEDIT
92 export GIT_AUTHOR_EMAIL GIT_AUTHOR_NAME
93 export GIT_COMMITTER_EMAIL GIT_COMMITTER_NAME
94 export EDITOR
96 # Protect ourselves from common misconfiguration to export
97 # CDPATH into the environment
98 unset CDPATH
100 unset GREP_OPTIONS
102 case $(echo $GIT_TRACE |tr "[A-Z]" "[a-z]") in
103 1|2|true)
104 echo "* warning: Some tests will not work if GIT_TRACE" \
105 "is set as to trace on STDERR ! *"
106 echo "* warning: Please set GIT_TRACE to something" \
107 "other than 1, 2 or true ! *"
109 esac
111 # Convenience
113 # A regexp to match 5 and 40 hexdigits
114 _x05='[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
115 _x40="$_x05$_x05$_x05$_x05$_x05$_x05$_x05$_x05"
117 # Zero SHA-1
118 _z40=0000000000000000000000000000000000000000
120 # Line feed
121 LF='
124 export _x05 _x40 _z40 LF
126 # Each test should start with something like this, after copyright notices:
128 # test_description='Description of this test...
129 # This test checks if command xyzzy does the right thing...
131 # . ./test-lib.sh
132 [ "x$ORIGINAL_TERM" != "xdumb" ] && (
133 TERM=$ORIGINAL_TERM &&
134 export TERM &&
135 [ -t 1 ] &&
136 tput bold >/dev/null 2>&1 &&
137 tput setaf 1 >/dev/null 2>&1 &&
138 tput sgr0 >/dev/null 2>&1
139 ) &&
140 color=t
142 while test "$#" -ne 0
144 case "$1" in
145 -d|--d|--de|--deb|--debu|--debug)
146 debug=t; shift ;;
147 -i|--i|--im|--imm|--imme|--immed|--immedi|--immedia|--immediat|--immediate)
148 immediate=t; shift ;;
149 -l|--l|--lo|--lon|--long|--long-|--long-t|--long-te|--long-tes|--long-test|--long-tests)
150 GIT_TEST_LONG=t; export GIT_TEST_LONG; shift ;;
151 -h|--h|--he|--hel|--help)
152 help=t; shift ;;
153 -v|--v|--ve|--ver|--verb|--verbo|--verbos|--verbose)
154 verbose=t; shift ;;
155 -q|--q|--qu|--qui|--quie|--quiet)
156 # Ignore --quiet under a TAP::Harness. Saying how many tests
157 # passed without the ok/not ok details is always an error.
158 test -z "$HARNESS_ACTIVE" && quiet=t; shift ;;
159 --with-dashes)
160 with_dashes=t; shift ;;
161 --no-color)
162 color=; shift ;;
163 --va|--val|--valg|--valgr|--valgri|--valgrin|--valgrind)
164 valgrind=t; verbose=t; shift ;;
165 --tee)
166 shift ;; # was handled already
167 --root=*)
168 root=$(expr "z$1" : 'z[^=]*=\(.*\)')
169 shift ;;
171 echo "error: unknown test option '$1'" >&2; exit 1 ;;
172 esac
173 done
175 if test -n "$color"
176 then
177 say_color () {
179 TERM=$ORIGINAL_TERM
180 export TERM
181 case "$1" in
182 error)
183 tput bold; tput setaf 1;; # bold red
184 skip)
185 tput setaf 4;; # blue
186 warn)
187 tput setaf 3;; # brown/yellow
188 pass)
189 tput setaf 2;; # green
190 info)
191 tput setaf 6;; # cyan
193 test -n "$quiet" && return;;
194 esac
195 shift
196 printf "%s" "$*"
197 tput sgr0
198 echo
201 else
202 say_color() {
203 test -z "$1" && test -n "$quiet" && return
204 shift
205 echo "$*"
209 error () {
210 say_color error "error: $*"
211 GIT_EXIT_OK=t
212 exit 1
215 say () {
216 say_color info "$*"
219 test "${test_description}" != "" ||
220 error "Test script did not set test_description."
222 if test "$help" = "t"
223 then
224 echo "$test_description"
225 exit 0
228 exec 5>&1
229 exec 6<&0
230 if test "$verbose" = "t"
231 then
232 exec 4>&2 3>&1
233 else
234 exec 4>/dev/null 3>/dev/null
237 test_failure=0
238 test_count=0
239 test_fixed=0
240 test_broken=0
241 test_success=0
243 test_external_has_tap=0
245 die () {
246 code=$?
247 if test -n "$GIT_EXIT_OK"
248 then
249 exit $code
250 else
251 echo >&5 "FATAL: Unexpected exit with code $code"
252 exit 1
256 GIT_EXIT_OK=
257 trap 'die' EXIT
259 # The user-facing functions are loaded from a separate file so that
260 # test_perf subshells can have them too
261 . "$TEST_DIRECTORY/test-lib-functions.sh"
263 # You are not expected to call test_ok_ and test_failure_ directly, use
264 # the text_expect_* functions instead.
266 test_ok_ () {
267 test_success=$(($test_success + 1))
268 say_color "" "ok $test_count - $@"
271 test_failure_ () {
272 test_failure=$(($test_failure + 1))
273 say_color error "not ok $test_count - $1"
274 shift
275 echo "$@" | sed -e 's/^/# /'
276 test "$immediate" = "" || { GIT_EXIT_OK=t; exit 1; }
279 test_known_broken_ok_ () {
280 test_fixed=$(($test_fixed+1))
281 say_color error "ok $test_count - $@ # TODO known breakage vanished"
284 test_known_broken_failure_ () {
285 test_broken=$(($test_broken+1))
286 say_color warn "not ok $test_count - $@ # TODO known breakage"
289 test_debug () {
290 test "$debug" = "" || eval "$1"
293 test_eval_ () {
294 # This is a separate function because some tests use
295 # "return" to end a test_expect_success block early.
296 eval </dev/null >&3 2>&4 "$*"
299 test_run_ () {
300 test_cleanup=:
301 expecting_failure=$2
302 test_eval_ "$1"
303 eval_ret=$?
305 if test -z "$immediate" || test $eval_ret = 0 || test -n "$expecting_failure"
306 then
307 test_eval_ "$test_cleanup"
309 if test "$verbose" = "t" && test -n "$HARNESS_ACTIVE"
310 then
311 echo ""
313 return "$eval_ret"
316 test_skip () {
317 test_count=$(($test_count+1))
318 to_skip=
319 for skp in $GIT_SKIP_TESTS
321 case $this_test.$test_count in
322 $skp)
323 to_skip=t
324 break
325 esac
326 done
327 if test -z "$to_skip" && test -n "$test_prereq" &&
328 ! test_have_prereq "$test_prereq"
329 then
330 to_skip=t
332 case "$to_skip" in
334 of_prereq=
335 if test "$missing_prereq" != "$test_prereq"
336 then
337 of_prereq=" of $test_prereq"
340 say_color skip >&3 "skipping test: $@"
341 say_color skip "ok $test_count # skip $1 (missing $missing_prereq${of_prereq})"
342 : true
345 false
347 esac
350 # stub; perf-lib overrides it
351 test_at_end_hook_ () {
355 test_done () {
356 GIT_EXIT_OK=t
358 if test -z "$HARNESS_ACTIVE"
359 then
360 test_results_dir="$TEST_OUTPUT_DIRECTORY/test-results"
361 mkdir -p "$test_results_dir"
362 test_results_path="$test_results_dir/${0%.sh}-$$.counts"
364 cat >>"$test_results_path" <<-EOF
365 total $test_count
366 success $test_success
367 fixed $test_fixed
368 broken $test_broken
369 failed $test_failure
374 if test "$test_fixed" != 0
375 then
376 say_color error "# $test_fixed known breakage(s) vanished; please update test(s)"
378 if test "$test_broken" != 0
379 then
380 say_color warn "# still have $test_broken known breakage(s)"
382 if test "$test_broken" != 0 || test "$test_fixed" != 0
383 then
384 test_remaining=$(( $test_count - $test_broken - $test_fixed ))
385 msg="remaining $test_remaining test(s)"
386 else
387 test_remaining=$test_count
388 msg="$test_count test(s)"
390 case "$test_failure" in
392 # Maybe print SKIP message
393 if test -n "$skip_all" && test $test_count -gt 0
394 then
395 error "Can't use skip_all after running some tests"
397 [ -z "$skip_all" ] || skip_all=" # SKIP $skip_all"
399 if test $test_external_has_tap -eq 0
400 then
401 if test $test_remaining -gt 0
402 then
403 say_color pass "# passed all $msg"
405 say "1..$test_count$skip_all"
408 test -d "$remove_trash" &&
409 cd "$(dirname "$remove_trash")" &&
410 rm -rf "$(basename "$remove_trash")"
412 test_at_end_hook_
414 exit 0 ;;
417 if test $test_external_has_tap -eq 0
418 then
419 say_color error "# failed $test_failure among $msg"
420 say "1..$test_count"
423 exit 1 ;;
425 esac
428 if test -n "$valgrind"
429 then
430 make_symlink () {
431 test -h "$2" &&
432 test "$1" = "$(readlink "$2")" || {
433 # be super paranoid
434 if mkdir "$2".lock
435 then
436 rm -f "$2" &&
437 ln -s "$1" "$2" &&
438 rm -r "$2".lock
439 else
440 while test -d "$2".lock
442 say "Waiting for lock on $2."
443 sleep 1
444 done
449 make_valgrind_symlink () {
450 # handle only executables, unless they are shell libraries that
451 # need to be in the exec-path. We will just use "#!" as a
452 # guess for a shell-script, since we have no idea what the user
453 # may have configured as the shell path.
454 test -x "$1" ||
455 test "#!" = "$(head -c 2 <"$1")" ||
456 return;
458 base=$(basename "$1")
459 symlink_target=$GIT_BUILD_DIR/$base
460 # do not override scripts
461 if test -x "$symlink_target" &&
462 test ! -d "$symlink_target" &&
463 test "#!" != "$(head -c 2 < "$symlink_target")"
464 then
465 symlink_target=../valgrind.sh
467 case "$base" in
468 *.sh|*.perl)
469 symlink_target=../unprocessed-script
470 esac
471 # create the link, or replace it if it is out of date
472 make_symlink "$symlink_target" "$GIT_VALGRIND/bin/$base" || exit
475 # override all git executables in TEST_DIRECTORY/..
476 GIT_VALGRIND=$TEST_DIRECTORY/valgrind
477 mkdir -p "$GIT_VALGRIND"/bin
478 for file in $GIT_BUILD_DIR/git* $GIT_BUILD_DIR/test-*
480 make_valgrind_symlink $file
481 done
482 # special-case the mergetools loadables
483 make_symlink "$GIT_BUILD_DIR"/mergetools "$GIT_VALGRIND/bin/mergetools"
484 OLDIFS=$IFS
485 IFS=:
486 for path in $PATH
488 ls "$path"/git-* 2> /dev/null |
489 while read file
491 make_valgrind_symlink "$file"
492 done
493 done
494 IFS=$OLDIFS
495 PATH=$GIT_VALGRIND/bin:$PATH
496 GIT_EXEC_PATH=$GIT_VALGRIND/bin
497 export GIT_VALGRIND
498 elif test -n "$GIT_TEST_INSTALLED"
499 then
500 GIT_EXEC_PATH=$($GIT_TEST_INSTALLED/git --exec-path) ||
501 error "Cannot run git from $GIT_TEST_INSTALLED."
502 PATH=$GIT_TEST_INSTALLED:$GIT_BUILD_DIR:$PATH
503 GIT_EXEC_PATH=${GIT_TEST_EXEC_PATH:-$GIT_EXEC_PATH}
504 else # normal case, use ../bin-wrappers only unless $with_dashes:
505 git_bin_dir="$GIT_BUILD_DIR/bin-wrappers"
506 if ! test -x "$git_bin_dir/git"
507 then
508 if test -z "$with_dashes"
509 then
510 say "$git_bin_dir/git is not executable; using GIT_EXEC_PATH"
512 with_dashes=t
514 PATH="$git_bin_dir:$PATH"
515 GIT_EXEC_PATH=$GIT_BUILD_DIR
516 if test -n "$with_dashes"
517 then
518 PATH="$GIT_BUILD_DIR:$PATH"
521 GIT_TEMPLATE_DIR="$GIT_BUILD_DIR"/templates/blt
522 unset GIT_CONFIG
523 GIT_CONFIG_NOSYSTEM=1
524 GIT_ATTR_NOSYSTEM=1
525 export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG_NOSYSTEM GIT_ATTR_NOSYSTEM
527 if test -z "$GIT_TEST_CMP"
528 then
529 if test -n "$GIT_TEST_CMP_USE_COPIED_CONTEXT"
530 then
531 GIT_TEST_CMP="$DIFF -c"
532 else
533 GIT_TEST_CMP="$DIFF -u"
537 GITPERLLIB="$GIT_BUILD_DIR"/perl/blib/lib:"$GIT_BUILD_DIR"/perl/blib/arch/auto/Git
538 export GITPERLLIB
539 test -d "$GIT_BUILD_DIR"/templates/blt || {
540 error "You haven't built things yet, have you?"
543 if test -z "$GIT_TEST_INSTALLED" && test -z "$NO_PYTHON"
544 then
545 GITPYTHONLIB="$GIT_BUILD_DIR/git_remote_helpers/build/lib"
546 export GITPYTHONLIB
547 test -d "$GIT_BUILD_DIR"/git_remote_helpers/build || {
548 error "You haven't built git_remote_helpers yet, have you?"
552 if ! test -x "$GIT_BUILD_DIR"/test-chmtime
553 then
554 echo >&2 'You need to build test-chmtime:'
555 echo >&2 'Run "make test-chmtime" in the source (toplevel) directory'
556 exit 1
559 # Test repository
560 test="trash directory.$(basename "$0" .sh)"
561 test -n "$root" && test="$root/$test"
562 case "$test" in
563 /*) TRASH_DIRECTORY="$test" ;;
564 *) TRASH_DIRECTORY="$TEST_OUTPUT_DIRECTORY/$test" ;;
565 esac
566 test ! -z "$debug" || remove_trash=$TRASH_DIRECTORY
567 rm -fr "$test" || {
568 GIT_EXIT_OK=t
569 echo >&5 "FATAL: Cannot prepare test area"
570 exit 1
573 HOME="$TRASH_DIRECTORY"
574 export HOME
576 if test -z "$TEST_NO_CREATE_REPO"
577 then
578 test_create_repo "$test"
579 else
580 mkdir -p "$test"
582 # Use -P to resolve symlinks in our working directory so that the cwd
583 # in subprocesses like git equals our $PWD (for pathname comparisons).
584 cd -P "$test" || exit 1
586 this_test=${0##*/}
587 this_test=${this_test%%-*}
588 for skp in $GIT_SKIP_TESTS
590 case "$this_test" in
591 $skp)
592 say_color info >&3 "skipping test $this_test altogether"
593 skip_all="skip all tests in $this_test"
594 test_done
595 esac
596 done
598 # Provide an implementation of the 'yes' utility
599 yes () {
600 if test $# = 0
601 then
603 else
604 y="$*"
607 while echo "$y"
610 done
613 # Fix some commands on Windows
614 case $(uname -s) in
615 *MINGW*)
616 # Windows has its own (incompatible) sort and find
617 sort () {
618 /usr/bin/sort "$@"
620 find () {
621 /usr/bin/find "$@"
623 sum () {
624 md5sum "$@"
626 # git sees Windows-style pwd
627 pwd () {
628 builtin pwd -W
630 # no POSIX permissions
631 # backslashes in pathspec are converted to '/'
632 # exec does not inherit the PID
633 test_set_prereq MINGW
634 test_set_prereq SED_STRIPS_CR
636 *CYGWIN*)
637 test_set_prereq POSIXPERM
638 test_set_prereq EXECKEEPSPID
639 test_set_prereq NOT_MINGW
640 test_set_prereq SED_STRIPS_CR
643 test_set_prereq POSIXPERM
644 test_set_prereq BSLASHPSPEC
645 test_set_prereq EXECKEEPSPID
646 test_set_prereq NOT_MINGW
648 esac
650 ( COLUMNS=1 && test $COLUMNS = 1 ) && test_set_prereq COLUMNS_CAN_BE_1
651 test -z "$NO_PERL" && test_set_prereq PERL
652 test -z "$NO_PYTHON" && test_set_prereq PYTHON
653 test -n "$USE_LIBPCRE" && test_set_prereq LIBPCRE
654 test -z "$NO_GETTEXT" && test_set_prereq GETTEXT
656 # Can we rely on git's output in the C locale?
657 if test -n "$GETTEXT_POISON"
658 then
659 GIT_GETTEXT_POISON=YesPlease
660 export GIT_GETTEXT_POISON
661 test_set_prereq GETTEXT_POISON
662 else
663 test_set_prereq C_LOCALE_OUTPUT
666 # Use this instead of test_cmp to compare files that contain expected and
667 # actual output from git commands that can be translated. When running
668 # under GETTEXT_POISON this pretends that the command produced expected
669 # results.
670 test_i18ncmp () {
671 test -n "$GETTEXT_POISON" || test_cmp "$@"
674 # Use this instead of "grep expected-string actual" to see if the
675 # output from a git command that can be translated either contains an
676 # expected string, or does not contain an unwanted one. When running
677 # under GETTEXT_POISON this pretends that the command produced expected
678 # results.
679 test_i18ngrep () {
680 if test -n "$GETTEXT_POISON"
681 then
682 : # pretend success
683 elif test "x!" = "x$1"
684 then
685 shift
686 ! grep "$@"
687 else
688 grep "$@"
692 test_lazy_prereq SYMLINKS '
693 # test whether the filesystem supports symbolic links
694 ln -s x y && test -h y
697 test_lazy_prereq CASE_INSENSITIVE_FS '
698 echo good >CamelCase &&
699 echo bad >camelcase &&
700 test "$(cat CamelCase)" != good
703 test_lazy_prereq UTF8_NFD_TO_NFC '
704 # check whether FS converts nfd unicode to nfc
705 auml=$(printf "\303\244")
706 aumlcdiar=$(printf "\141\314\210")
707 >"$auml" &&
708 case "$(echo *)" in
709 "$aumlcdiar")
710 true ;;
712 false ;;
713 esac
716 # When the tests are run as root, permission tests will report that
717 # things are writable when they shouldn't be.
718 test -w / || test_set_prereq SANITY