test-lib: self-test that --verbose works
[git/gitweb.git] / t / test-lib.sh
blob432248dfb87f1cdfcf0396e80152eb460d6748c8
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 # Keep the original TERM for say_color
19 ORIGINAL_TERM=$TERM
21 # Test the binaries we have just built. The tests are kept in
22 # t/ subdirectory and are run in 'trash directory' subdirectory.
23 if test -z "$TEST_DIRECTORY"
24 then
25 # We allow tests to override this, in case they want to run tests
26 # outside of t/, e.g. for running tests on the test library
27 # itself.
28 TEST_DIRECTORY=$(pwd)
30 if test -z "$TEST_OUTPUT_DIRECTORY"
31 then
32 # Similarly, override this to store the test-results subdir
33 # elsewhere
34 TEST_OUTPUT_DIRECTORY=$TEST_DIRECTORY
36 GIT_BUILD_DIR="$TEST_DIRECTORY"/..
38 ################################################################
39 # It appears that people try to run tests without building...
40 "$GIT_BUILD_DIR/git" >/dev/null
41 if test $? != 1
42 then
43 echo >&2 'error: you do not seem to have built git yet.'
44 exit 1
47 . "$GIT_BUILD_DIR"/GIT-BUILD-OPTIONS
48 export PERL_PATH SHELL_PATH
50 # if --tee was passed, write the output not only to the terminal, but
51 # additionally to the file test-results/$BASENAME.out, too.
52 case "$GIT_TEST_TEE_STARTED, $* " in
53 done,*)
54 # do not redirect again
56 *' --tee '*|*' --va'*)
57 mkdir -p test-results
58 BASE=test-results/$(basename "$0" .sh)
59 (GIT_TEST_TEE_STARTED=done ${SHELL_PATH} "$0" "$@" 2>&1;
60 echo $? > $BASE.exit) | tee $BASE.out
61 test "$(cat $BASE.exit)" = 0
62 exit
64 esac
66 # For repeatability, reset the environment to known value.
67 LANG=C
68 LC_ALL=C
69 PAGER=cat
70 TZ=UTC
71 TERM=dumb
72 export LANG LC_ALL PAGER TERM TZ
73 EDITOR=:
74 # A call to "unset" with no arguments causes at least Solaris 10
75 # /usr/xpg4/bin/sh and /bin/ksh to bail out. So keep the unsets
76 # deriving from the command substitution clustered with the other
77 # ones.
78 unset VISUAL EMAIL LANGUAGE COLUMNS $("$PERL_PATH" -e '
79 my @env = keys %ENV;
80 my $ok = join("|", qw(
81 TRACE
82 DEBUG
83 USE_LOOKUP
84 TEST
85 .*_TEST
86 PROVE
87 VALGRIND
88 UNZIP
89 PERF_
90 ));
91 my @vars = grep(/^GIT_/ && !/^GIT_($ok)/o, @env);
92 print join("\n", @vars);
94 unset XDG_CONFIG_HOME
95 GIT_AUTHOR_EMAIL=author@example.com
96 GIT_AUTHOR_NAME='A U Thor'
97 GIT_COMMITTER_EMAIL=committer@example.com
98 GIT_COMMITTER_NAME='C O Mitter'
99 GIT_MERGE_VERBOSITY=5
100 GIT_MERGE_AUTOEDIT=no
101 export GIT_MERGE_VERBOSITY GIT_MERGE_AUTOEDIT
102 export GIT_AUTHOR_EMAIL GIT_AUTHOR_NAME
103 export GIT_COMMITTER_EMAIL GIT_COMMITTER_NAME
104 export EDITOR
106 # Add libc MALLOC and MALLOC_PERTURB test
107 # only if we are not executing the test with valgrind
108 if expr " $GIT_TEST_OPTS " : ".* --valgrind " >/dev/null ||
109 test -n "$TEST_NO_MALLOC_CHECK"
110 then
111 setup_malloc_check () {
112 : nothing
114 teardown_malloc_check () {
115 : nothing
117 else
118 setup_malloc_check () {
119 MALLOC_CHECK_=3 MALLOC_PERTURB_=165
120 export MALLOC_CHECK_ MALLOC_PERTURB_
122 teardown_malloc_check () {
123 unset MALLOC_CHECK_ MALLOC_PERTURB_
127 # Protect ourselves from common misconfiguration to export
128 # CDPATH into the environment
129 unset CDPATH
131 unset GREP_OPTIONS
132 unset UNZIP
134 case $(echo $GIT_TRACE |tr "[A-Z]" "[a-z]") in
135 1|2|true)
136 echo "* warning: Some tests will not work if GIT_TRACE" \
137 "is set as to trace on STDERR ! *"
138 echo "* warning: Please set GIT_TRACE to something" \
139 "other than 1, 2 or true ! *"
141 esac
143 # Convenience
145 # A regexp to match 5 and 40 hexdigits
146 _x05='[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
147 _x40="$_x05$_x05$_x05$_x05$_x05$_x05$_x05$_x05"
149 # Zero SHA-1
150 _z40=0000000000000000000000000000000000000000
152 # Line feed
153 LF='
156 export _x05 _x40 _z40 LF
158 # Each test should start with something like this, after copyright notices:
160 # test_description='Description of this test...
161 # This test checks if command xyzzy does the right thing...
163 # . ./test-lib.sh
164 [ "x$ORIGINAL_TERM" != "xdumb" ] && (
165 TERM=$ORIGINAL_TERM &&
166 export TERM &&
167 [ -t 1 ] &&
168 tput bold >/dev/null 2>&1 &&
169 tput setaf 1 >/dev/null 2>&1 &&
170 tput sgr0 >/dev/null 2>&1
171 ) &&
172 color=t
174 while test "$#" -ne 0
176 case "$1" in
177 -d|--d|--de|--deb|--debu|--debug)
178 debug=t; shift ;;
179 -i|--i|--im|--imm|--imme|--immed|--immedi|--immedia|--immediat|--immediate)
180 immediate=t; shift ;;
181 -l|--l|--lo|--lon|--long|--long-|--long-t|--long-te|--long-tes|--long-test|--long-tests)
182 GIT_TEST_LONG=t; export GIT_TEST_LONG; shift ;;
183 -h|--h|--he|--hel|--help)
184 help=t; shift ;;
185 -v|--v|--ve|--ver|--verb|--verbo|--verbos|--verbose)
186 verbose=t; shift ;;
187 -q|--q|--qu|--qui|--quie|--quiet)
188 # Ignore --quiet under a TAP::Harness. Saying how many tests
189 # passed without the ok/not ok details is always an error.
190 test -z "$HARNESS_ACTIVE" && quiet=t; shift ;;
191 --with-dashes)
192 with_dashes=t; shift ;;
193 --no-color)
194 color=; shift ;;
195 --va|--val|--valg|--valgr|--valgri|--valgrin|--valgrind)
196 valgrind=memcheck
197 shift ;;
198 --valgrind=*)
199 valgrind=$(expr "z$1" : 'z[^=]*=\(.*\)')
200 shift ;;
201 --tee)
202 shift ;; # was handled already
203 --root=*)
204 root=$(expr "z$1" : 'z[^=]*=\(.*\)')
205 shift ;;
207 echo "error: unknown test option '$1'" >&2; exit 1 ;;
208 esac
209 done
211 test -n "$valgrind" && verbose=t
213 if test -n "$color"
214 then
215 say_color () {
217 TERM=$ORIGINAL_TERM
218 export TERM
219 case "$1" in
220 error)
221 tput bold; tput setaf 1;; # bold red
222 skip)
223 tput setaf 4;; # blue
224 warn)
225 tput setaf 3;; # brown/yellow
226 pass)
227 tput setaf 2;; # green
228 info)
229 tput setaf 6;; # cyan
231 test -n "$quiet" && return;;
232 esac
233 shift
234 printf "%s" "$*"
235 tput sgr0
236 echo
239 else
240 say_color() {
241 test -z "$1" && test -n "$quiet" && return
242 shift
243 printf "%s\n" "$*"
247 error () {
248 say_color error "error: $*"
249 GIT_EXIT_OK=t
250 exit 1
253 say () {
254 say_color info "$*"
257 test "${test_description}" != "" ||
258 error "Test script did not set test_description."
260 if test "$help" = "t"
261 then
262 echo "$test_description"
263 exit 0
266 exec 5>&1
267 exec 6<&0
268 if test "$verbose" = "t"
269 then
270 exec 4>&2 3>&1
271 else
272 exec 4>/dev/null 3>/dev/null
275 test_failure=0
276 test_count=0
277 test_fixed=0
278 test_broken=0
279 test_success=0
281 test_external_has_tap=0
283 die () {
284 code=$?
285 if test -n "$GIT_EXIT_OK"
286 then
287 exit $code
288 else
289 echo >&5 "FATAL: Unexpected exit with code $code"
290 exit 1
294 GIT_EXIT_OK=
295 trap 'die' EXIT
297 # The user-facing functions are loaded from a separate file so that
298 # test_perf subshells can have them too
299 . "$TEST_DIRECTORY/test-lib-functions.sh"
301 # You are not expected to call test_ok_ and test_failure_ directly, use
302 # the text_expect_* functions instead.
304 test_ok_ () {
305 test_success=$(($test_success + 1))
306 say_color "" "ok $test_count - $@"
309 test_failure_ () {
310 test_failure=$(($test_failure + 1))
311 say_color error "not ok $test_count - $1"
312 shift
313 echo "$@" | sed -e 's/^/# /'
314 test "$immediate" = "" || { GIT_EXIT_OK=t; exit 1; }
317 test_known_broken_ok_ () {
318 test_fixed=$(($test_fixed+1))
319 say_color error "ok $test_count - $@ # TODO known breakage vanished"
322 test_known_broken_failure_ () {
323 test_broken=$(($test_broken+1))
324 say_color warn "not ok $test_count - $@ # TODO known breakage"
327 test_debug () {
328 test "$debug" = "" || eval "$1"
331 match_pattern_list () {
332 arg="$1"
333 shift
334 test -z "$*" && return 1
335 for pattern_
337 case "$arg" in
338 $pattern_)
339 return 0
340 esac
341 done
342 return 1
345 test_eval_ () {
346 # This is a separate function because some tests use
347 # "return" to end a test_expect_success block early.
348 eval </dev/null >&3 2>&4 "$*"
351 test_run_ () {
352 test_cleanup=:
353 expecting_failure=$2
354 setup_malloc_check
355 test_eval_ "$1"
356 eval_ret=$?
357 teardown_malloc_check
359 if test -z "$immediate" || test $eval_ret = 0 || test -n "$expecting_failure"
360 then
361 setup_malloc_check
362 test_eval_ "$test_cleanup"
363 teardown_malloc_check
365 if test "$verbose" = "t" && test -n "$HARNESS_ACTIVE"
366 then
367 echo ""
369 return "$eval_ret"
372 test_start_ () {
373 test_count=$(($test_count+1))
376 test_finish_ () {
377 echo >&3 ""
380 test_skip () {
381 to_skip=
382 if match_pattern_list $this_test.$test_count $GIT_SKIP_TESTS
383 then
384 to_skip=t
386 if test -z "$to_skip" && test -n "$test_prereq" &&
387 ! test_have_prereq "$test_prereq"
388 then
389 to_skip=t
391 case "$to_skip" in
393 of_prereq=
394 if test "$missing_prereq" != "$test_prereq"
395 then
396 of_prereq=" of $test_prereq"
399 say_color skip >&3 "skipping test: $@"
400 say_color skip "ok $test_count # skip $1 (missing $missing_prereq${of_prereq})"
401 : true
404 false
406 esac
409 # stub; perf-lib overrides it
410 test_at_end_hook_ () {
414 test_done () {
415 GIT_EXIT_OK=t
417 # Note: t0000 relies on $HARNESS_ACTIVE disabling the .counts
418 # output file
419 if test -z "$HARNESS_ACTIVE"
420 then
421 test_results_dir="$TEST_OUTPUT_DIRECTORY/test-results"
422 mkdir -p "$test_results_dir"
423 base=${0##*/}
424 test_results_path="$test_results_dir/${base%.sh}-$$.counts"
426 cat >>"$test_results_path" <<-EOF
427 total $test_count
428 success $test_success
429 fixed $test_fixed
430 broken $test_broken
431 failed $test_failure
436 if test "$test_fixed" != 0
437 then
438 say_color error "# $test_fixed known breakage(s) vanished; please update test(s)"
440 if test "$test_broken" != 0
441 then
442 say_color warn "# still have $test_broken known breakage(s)"
444 if test "$test_broken" != 0 || test "$test_fixed" != 0
445 then
446 test_remaining=$(( $test_count - $test_broken - $test_fixed ))
447 msg="remaining $test_remaining test(s)"
448 else
449 test_remaining=$test_count
450 msg="$test_count test(s)"
452 case "$test_failure" in
454 # Maybe print SKIP message
455 if test -n "$skip_all" && test $test_count -gt 0
456 then
457 error "Can't use skip_all after running some tests"
459 [ -z "$skip_all" ] || skip_all=" # SKIP $skip_all"
461 if test $test_external_has_tap -eq 0
462 then
463 if test $test_remaining -gt 0
464 then
465 say_color pass "# passed all $msg"
467 say "1..$test_count$skip_all"
470 test -d "$remove_trash" &&
471 cd "$(dirname "$remove_trash")" &&
472 rm -rf "$(basename "$remove_trash")"
474 test_at_end_hook_
476 exit 0 ;;
479 if test $test_external_has_tap -eq 0
480 then
481 say_color error "# failed $test_failure among $msg"
482 say "1..$test_count"
485 exit 1 ;;
487 esac
490 if test -n "$valgrind"
491 then
492 make_symlink () {
493 test -h "$2" &&
494 test "$1" = "$(readlink "$2")" || {
495 # be super paranoid
496 if mkdir "$2".lock
497 then
498 rm -f "$2" &&
499 ln -s "$1" "$2" &&
500 rm -r "$2".lock
501 else
502 while test -d "$2".lock
504 say "Waiting for lock on $2."
505 sleep 1
506 done
511 make_valgrind_symlink () {
512 # handle only executables, unless they are shell libraries that
513 # need to be in the exec-path. We will just use "#!" as a
514 # guess for a shell-script, since we have no idea what the user
515 # may have configured as the shell path.
516 test -x "$1" ||
517 test "#!" = "$(head -c 2 <"$1")" ||
518 return;
520 base=$(basename "$1")
521 symlink_target=$GIT_BUILD_DIR/$base
522 # do not override scripts
523 if test -x "$symlink_target" &&
524 test ! -d "$symlink_target" &&
525 test "#!" != "$(head -c 2 < "$symlink_target")"
526 then
527 symlink_target=../valgrind.sh
529 case "$base" in
530 *.sh|*.perl)
531 symlink_target=../unprocessed-script
532 esac
533 # create the link, or replace it if it is out of date
534 make_symlink "$symlink_target" "$GIT_VALGRIND/bin/$base" || exit
537 # override all git executables in TEST_DIRECTORY/..
538 GIT_VALGRIND=$TEST_DIRECTORY/valgrind
539 mkdir -p "$GIT_VALGRIND"/bin
540 for file in $GIT_BUILD_DIR/git* $GIT_BUILD_DIR/test-*
542 make_valgrind_symlink $file
543 done
544 # special-case the mergetools loadables
545 make_symlink "$GIT_BUILD_DIR"/mergetools "$GIT_VALGRIND/bin/mergetools"
546 OLDIFS=$IFS
547 IFS=:
548 for path in $PATH
550 ls "$path"/git-* 2> /dev/null |
551 while read file
553 make_valgrind_symlink "$file"
554 done
555 done
556 IFS=$OLDIFS
557 PATH=$GIT_VALGRIND/bin:$PATH
558 GIT_EXEC_PATH=$GIT_VALGRIND/bin
559 export GIT_VALGRIND
560 GIT_VALGRIND_MODE="$valgrind"
561 export GIT_VALGRIND_MODE
562 elif test -n "$GIT_TEST_INSTALLED"
563 then
564 GIT_EXEC_PATH=$($GIT_TEST_INSTALLED/git --exec-path) ||
565 error "Cannot run git from $GIT_TEST_INSTALLED."
566 PATH=$GIT_TEST_INSTALLED:$GIT_BUILD_DIR:$PATH
567 GIT_EXEC_PATH=${GIT_TEST_EXEC_PATH:-$GIT_EXEC_PATH}
568 else # normal case, use ../bin-wrappers only unless $with_dashes:
569 git_bin_dir="$GIT_BUILD_DIR/bin-wrappers"
570 if ! test -x "$git_bin_dir/git"
571 then
572 if test -z "$with_dashes"
573 then
574 say "$git_bin_dir/git is not executable; using GIT_EXEC_PATH"
576 with_dashes=t
578 PATH="$git_bin_dir:$PATH"
579 GIT_EXEC_PATH=$GIT_BUILD_DIR
580 if test -n "$with_dashes"
581 then
582 PATH="$GIT_BUILD_DIR:$PATH"
585 GIT_TEMPLATE_DIR="$GIT_BUILD_DIR"/templates/blt
586 unset GIT_CONFIG
587 GIT_CONFIG_NOSYSTEM=1
588 GIT_ATTR_NOSYSTEM=1
589 export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG_NOSYSTEM GIT_ATTR_NOSYSTEM
591 if test -z "$GIT_TEST_CMP"
592 then
593 if test -n "$GIT_TEST_CMP_USE_COPIED_CONTEXT"
594 then
595 GIT_TEST_CMP="$DIFF -c"
596 else
597 GIT_TEST_CMP="$DIFF -u"
601 GITPERLLIB="$GIT_BUILD_DIR"/perl/blib/lib:"$GIT_BUILD_DIR"/perl/blib/arch/auto/Git
602 export GITPERLLIB
603 test -d "$GIT_BUILD_DIR"/templates/blt || {
604 error "You haven't built things yet, have you?"
607 if test -z "$GIT_TEST_INSTALLED" && test -z "$NO_PYTHON"
608 then
609 GITPYTHONLIB="$GIT_BUILD_DIR/git_remote_helpers/build/lib"
610 export GITPYTHONLIB
611 test -d "$GIT_BUILD_DIR"/git_remote_helpers/build || {
612 error "You haven't built git_remote_helpers yet, have you?"
616 if ! test -x "$GIT_BUILD_DIR"/test-chmtime
617 then
618 echo >&2 'You need to build test-chmtime:'
619 echo >&2 'Run "make test-chmtime" in the source (toplevel) directory'
620 exit 1
623 # Test repository
624 TRASH_DIRECTORY="trash directory.$(basename "$0" .sh)"
625 test -n "$root" && TRASH_DIRECTORY="$root/$TRASH_DIRECTORY"
626 case "$TRASH_DIRECTORY" in
627 /*) ;; # absolute path is good
628 *) TRASH_DIRECTORY="$TEST_OUTPUT_DIRECTORY/$TRASH_DIRECTORY" ;;
629 esac
630 test ! -z "$debug" || remove_trash=$TRASH_DIRECTORY
631 rm -fr "$TRASH_DIRECTORY" || {
632 GIT_EXIT_OK=t
633 echo >&5 "FATAL: Cannot prepare test area"
634 exit 1
637 HOME="$TRASH_DIRECTORY"
638 export HOME
640 if test -z "$TEST_NO_CREATE_REPO"
641 then
642 test_create_repo "$TRASH_DIRECTORY"
643 else
644 mkdir -p "$TRASH_DIRECTORY"
646 # Use -P to resolve symlinks in our working directory so that the cwd
647 # in subprocesses like git equals our $PWD (for pathname comparisons).
648 cd -P "$TRASH_DIRECTORY" || exit 1
650 this_test=${0##*/}
651 this_test=${this_test%%-*}
652 if match_pattern_list "$this_test" $GIT_SKIP_TESTS
653 then
654 say_color info >&3 "skipping test $this_test altogether"
655 skip_all="skip all tests in $this_test"
656 test_done
659 # Provide an implementation of the 'yes' utility
660 yes () {
661 if test $# = 0
662 then
664 else
665 y="$*"
668 while echo "$y"
671 done
674 # Fix some commands on Windows
675 case $(uname -s) in
676 *MINGW*)
677 # Windows has its own (incompatible) sort and find
678 sort () {
679 /usr/bin/sort "$@"
681 find () {
682 /usr/bin/find "$@"
684 sum () {
685 md5sum "$@"
687 # git sees Windows-style pwd
688 pwd () {
689 builtin pwd -W
691 # no POSIX permissions
692 # backslashes in pathspec are converted to '/'
693 # exec does not inherit the PID
694 test_set_prereq MINGW
695 test_set_prereq NOT_CYGWIN
696 test_set_prereq SED_STRIPS_CR
698 *CYGWIN*)
699 test_set_prereq POSIXPERM
700 test_set_prereq EXECKEEPSPID
701 test_set_prereq NOT_MINGW
702 test_set_prereq CYGWIN
703 test_set_prereq SED_STRIPS_CR
706 test_set_prereq POSIXPERM
707 test_set_prereq BSLASHPSPEC
708 test_set_prereq EXECKEEPSPID
709 test_set_prereq NOT_MINGW
710 test_set_prereq NOT_CYGWIN
712 esac
714 ( COLUMNS=1 && test $COLUMNS = 1 ) && test_set_prereq COLUMNS_CAN_BE_1
715 test -z "$NO_PERL" && test_set_prereq PERL
716 test -z "$NO_PYTHON" && test_set_prereq PYTHON
717 test -n "$USE_LIBPCRE" && test_set_prereq LIBPCRE
718 test -z "$NO_GETTEXT" && test_set_prereq GETTEXT
720 # Can we rely on git's output in the C locale?
721 if test -n "$GETTEXT_POISON"
722 then
723 GIT_GETTEXT_POISON=YesPlease
724 export GIT_GETTEXT_POISON
725 test_set_prereq GETTEXT_POISON
726 else
727 test_set_prereq C_LOCALE_OUTPUT
730 # Use this instead of test_cmp to compare files that contain expected and
731 # actual output from git commands that can be translated. When running
732 # under GETTEXT_POISON this pretends that the command produced expected
733 # results.
734 test_i18ncmp () {
735 test -n "$GETTEXT_POISON" || test_cmp "$@"
738 # Use this instead of "grep expected-string actual" to see if the
739 # output from a git command that can be translated either contains an
740 # expected string, or does not contain an unwanted one. When running
741 # under GETTEXT_POISON this pretends that the command produced expected
742 # results.
743 test_i18ngrep () {
744 if test -n "$GETTEXT_POISON"
745 then
746 : # pretend success
747 elif test "x!" = "x$1"
748 then
749 shift
750 ! grep "$@"
751 else
752 grep "$@"
756 test_lazy_prereq PIPE '
757 # test whether the filesystem supports FIFOs
758 rm -f testfifo && mkfifo testfifo
761 test_lazy_prereq SYMLINKS '
762 # test whether the filesystem supports symbolic links
763 ln -s x y && test -h y
766 test_lazy_prereq CASE_INSENSITIVE_FS '
767 echo good >CamelCase &&
768 echo bad >camelcase &&
769 test "$(cat CamelCase)" != good
772 test_lazy_prereq UTF8_NFD_TO_NFC '
773 # check whether FS converts nfd unicode to nfc
774 auml=$(printf "\303\244")
775 aumlcdiar=$(printf "\141\314\210")
776 >"$auml" &&
777 case "$(echo *)" in
778 "$aumlcdiar")
779 true ;;
781 false ;;
782 esac
785 test_lazy_prereq AUTOIDENT '
786 sane_unset GIT_AUTHOR_NAME &&
787 sane_unset GIT_AUTHOR_EMAIL &&
788 git var GIT_AUTHOR_IDENT
791 # When the tests are run as root, permission tests will report that
792 # things are writable when they shouldn't be.
793 test -w / || test_set_prereq SANITY
795 GIT_UNZIP=${GIT_UNZIP:-unzip}
796 test_lazy_prereq UNZIP '
797 "$GIT_UNZIP" -v
798 test $? -ne 127