MALLOC_CHECK: enable it, unless disabled explicitly
[git.git] / t / test-lib.sh
blob9ecbc409a2d42bb047721bdc72574752ba5c31f3
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 # Add libc MALLOC and MALLOC_PERTURB test
97 # only if we are not executing the test with valgrind
98 if expr " $GIT_TEST_OPTS " : ".* --valgrind " >/dev/null ||
99 test -n "$TEST_NO_MALLOC_CHECK"
100 then
101 setup_malloc_check () {
102 : nothing
104 teardown_malloc_check () {
105 : nothing
107 else
108 setup_malloc_check () {
109 MALLOC_CHECK_=3 MALLOC_PERTURB_=165
110 export MALLOC_CHECK_ MALLOC_PERTURB_
112 teardown_malloc_check () {
113 unset MALLOC_CHECK_ MALLOC_PERTURB_
117 # Protect ourselves from common misconfiguration to export
118 # CDPATH into the environment
119 unset CDPATH
121 unset GREP_OPTIONS
123 case $(echo $GIT_TRACE |tr "[A-Z]" "[a-z]") in
124 1|2|true)
125 echo "* warning: Some tests will not work if GIT_TRACE" \
126 "is set as to trace on STDERR ! *"
127 echo "* warning: Please set GIT_TRACE to something" \
128 "other than 1, 2 or true ! *"
130 esac
132 # Convenience
134 # A regexp to match 5 and 40 hexdigits
135 _x05='[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
136 _x40="$_x05$_x05$_x05$_x05$_x05$_x05$_x05$_x05"
138 # Zero SHA-1
139 _z40=0000000000000000000000000000000000000000
141 # Line feed
142 LF='
145 export _x05 _x40 _z40 LF
147 # Each test should start with something like this, after copyright notices:
149 # test_description='Description of this test...
150 # This test checks if command xyzzy does the right thing...
152 # . ./test-lib.sh
153 [ "x$ORIGINAL_TERM" != "xdumb" ] && (
154 TERM=$ORIGINAL_TERM &&
155 export TERM &&
156 [ -t 1 ] &&
157 tput bold >/dev/null 2>&1 &&
158 tput setaf 1 >/dev/null 2>&1 &&
159 tput sgr0 >/dev/null 2>&1
160 ) &&
161 color=t
163 while test "$#" -ne 0
165 case "$1" in
166 -d|--d|--de|--deb|--debu|--debug)
167 debug=t; shift ;;
168 -i|--i|--im|--imm|--imme|--immed|--immedi|--immedia|--immediat|--immediate)
169 immediate=t; shift ;;
170 -l|--l|--lo|--lon|--long|--long-|--long-t|--long-te|--long-tes|--long-test|--long-tests)
171 GIT_TEST_LONG=t; export GIT_TEST_LONG; shift ;;
172 -h|--h|--he|--hel|--help)
173 help=t; shift ;;
174 -v|--v|--ve|--ver|--verb|--verbo|--verbos|--verbose)
175 verbose=t; shift ;;
176 -q|--q|--qu|--qui|--quie|--quiet)
177 # Ignore --quiet under a TAP::Harness. Saying how many tests
178 # passed without the ok/not ok details is always an error.
179 test -z "$HARNESS_ACTIVE" && quiet=t; shift ;;
180 --with-dashes)
181 with_dashes=t; shift ;;
182 --no-color)
183 color=; shift ;;
184 --va|--val|--valg|--valgr|--valgri|--valgrin|--valgrind)
185 valgrind=t; verbose=t; shift ;;
186 --tee)
187 shift ;; # was handled already
188 --root=*)
189 root=$(expr "z$1" : 'z[^=]*=\(.*\)')
190 shift ;;
192 echo "error: unknown test option '$1'" >&2; exit 1 ;;
193 esac
194 done
196 if test -n "$color"
197 then
198 say_color () {
200 TERM=$ORIGINAL_TERM
201 export TERM
202 case "$1" in
203 error)
204 tput bold; tput setaf 1;; # bold red
205 skip)
206 tput bold; tput setaf 2;; # bold green
207 pass)
208 tput setaf 2;; # green
209 info)
210 tput setaf 3;; # brown
212 test -n "$quiet" && return;;
213 esac
214 shift
215 printf "%s" "$*"
216 tput sgr0
217 echo
220 else
221 say_color() {
222 test -z "$1" && test -n "$quiet" && return
223 shift
224 echo "$*"
228 error () {
229 say_color error "error: $*"
230 GIT_EXIT_OK=t
231 exit 1
234 say () {
235 say_color info "$*"
238 test "${test_description}" != "" ||
239 error "Test script did not set test_description."
241 if test "$help" = "t"
242 then
243 echo "$test_description"
244 exit 0
247 exec 5>&1
248 exec 6<&0
249 if test "$verbose" = "t"
250 then
251 exec 4>&2 3>&1
252 else
253 exec 4>/dev/null 3>/dev/null
256 test_failure=0
257 test_count=0
258 test_fixed=0
259 test_broken=0
260 test_success=0
262 test_external_has_tap=0
264 die () {
265 code=$?
266 if test -n "$GIT_EXIT_OK"
267 then
268 exit $code
269 else
270 echo >&5 "FATAL: Unexpected exit with code $code"
271 exit 1
275 GIT_EXIT_OK=
276 trap 'die' EXIT
278 # The user-facing functions are loaded from a separate file so that
279 # test_perf subshells can have them too
280 . "$TEST_DIRECTORY/test-lib-functions.sh"
282 # You are not expected to call test_ok_ and test_failure_ directly, use
283 # the text_expect_* functions instead.
285 test_ok_ () {
286 test_success=$(($test_success + 1))
287 say_color "" "ok $test_count - $@"
290 test_failure_ () {
291 test_failure=$(($test_failure + 1))
292 say_color error "not ok - $test_count $1"
293 shift
294 echo "$@" | sed -e 's/^/# /'
295 test "$immediate" = "" || { GIT_EXIT_OK=t; exit 1; }
298 test_known_broken_ok_ () {
299 test_fixed=$(($test_fixed+1))
300 say_color "" "ok $test_count - $@ # TODO known breakage"
303 test_known_broken_failure_ () {
304 test_broken=$(($test_broken+1))
305 say_color skip "not ok $test_count - $@ # TODO known breakage"
308 test_debug () {
309 test "$debug" = "" || eval "$1"
312 test_eval_ () {
313 # This is a separate function because some tests use
314 # "return" to end a test_expect_success block early.
315 eval </dev/null >&3 2>&4 "$*"
318 test_run_ () {
319 test_cleanup=:
320 expecting_failure=$2
321 test_eval_ "$1"
322 eval_ret=$?
324 if test -z "$immediate" || test $eval_ret = 0 || test -n "$expecting_failure"
325 then
326 setup_malloc_check
327 test_eval_ "$test_cleanup"
328 teardown_malloc_check
330 if test "$verbose" = "t" && test -n "$HARNESS_ACTIVE"
331 then
332 echo ""
334 return "$eval_ret"
337 test_skip () {
338 test_count=$(($test_count+1))
339 to_skip=
340 for skp in $GIT_SKIP_TESTS
342 case $this_test.$test_count in
343 $skp)
344 to_skip=t
345 break
346 esac
347 done
348 if test -z "$to_skip" && test -n "$test_prereq" &&
349 ! test_have_prereq "$test_prereq"
350 then
351 to_skip=t
353 case "$to_skip" in
355 of_prereq=
356 if test "$missing_prereq" != "$test_prereq"
357 then
358 of_prereq=" of $test_prereq"
361 say_color skip >&3 "skipping test: $@"
362 say_color skip "ok $test_count # skip $1 (missing $missing_prereq${of_prereq})"
363 : true
366 false
368 esac
371 # stub; perf-lib overrides it
372 test_at_end_hook_ () {
376 test_done () {
377 GIT_EXIT_OK=t
379 if test -z "$HARNESS_ACTIVE"
380 then
381 test_results_dir="$TEST_OUTPUT_DIRECTORY/test-results"
382 mkdir -p "$test_results_dir"
383 test_results_path="$test_results_dir/${0%.sh}-$$.counts"
385 cat >>"$test_results_path" <<-EOF
386 total $test_count
387 success $test_success
388 fixed $test_fixed
389 broken $test_broken
390 failed $test_failure
395 if test "$test_fixed" != 0
396 then
397 say_color pass "# fixed $test_fixed known breakage(s)"
399 if test "$test_broken" != 0
400 then
401 say_color error "# still have $test_broken known breakage(s)"
402 msg="remaining $(($test_count-$test_broken)) test(s)"
403 else
404 msg="$test_count test(s)"
406 case "$test_failure" in
408 # Maybe print SKIP message
409 if test -n "$skip_all" && test $test_count -gt 0
410 then
411 error "Can't use skip_all after running some tests"
413 [ -z "$skip_all" ] || skip_all=" # SKIP $skip_all"
415 if test $test_external_has_tap -eq 0
416 then
417 if test $test_count -gt 0
418 then
419 say_color pass "# passed all $msg"
421 say "1..$test_count$skip_all"
424 test -d "$remove_trash" &&
425 cd "$(dirname "$remove_trash")" &&
426 rm -rf "$(basename "$remove_trash")"
428 test_at_end_hook_
430 exit 0 ;;
433 if test $test_external_has_tap -eq 0
434 then
435 say_color error "# failed $test_failure among $msg"
436 say "1..$test_count"
439 exit 1 ;;
441 esac
444 if test -n "$valgrind"
445 then
446 make_symlink () {
447 test -h "$2" &&
448 test "$1" = "$(readlink "$2")" || {
449 # be super paranoid
450 if mkdir "$2".lock
451 then
452 rm -f "$2" &&
453 ln -s "$1" "$2" &&
454 rm -r "$2".lock
455 else
456 while test -d "$2".lock
458 say "Waiting for lock on $2."
459 sleep 1
460 done
465 make_valgrind_symlink () {
466 # handle only executables, unless they are shell libraries that
467 # need to be in the exec-path. We will just use "#!" as a
468 # guess for a shell-script, since we have no idea what the user
469 # may have configured as the shell path.
470 test -x "$1" ||
471 test "#!" = "$(head -c 2 <"$1")" ||
472 return;
474 base=$(basename "$1")
475 symlink_target=$GIT_BUILD_DIR/$base
476 # do not override scripts
477 if test -x "$symlink_target" &&
478 test ! -d "$symlink_target" &&
479 test "#!" != "$(head -c 2 < "$symlink_target")"
480 then
481 symlink_target=../valgrind.sh
483 case "$base" in
484 *.sh|*.perl)
485 symlink_target=../unprocessed-script
486 esac
487 # create the link, or replace it if it is out of date
488 make_symlink "$symlink_target" "$GIT_VALGRIND/bin/$base" || exit
491 # override all git executables in TEST_DIRECTORY/..
492 GIT_VALGRIND=$TEST_DIRECTORY/valgrind
493 mkdir -p "$GIT_VALGRIND"/bin
494 for file in $GIT_BUILD_DIR/git* $GIT_BUILD_DIR/test-*
496 make_valgrind_symlink $file
497 done
498 # special-case the mergetools loadables
499 make_symlink "$GIT_BUILD_DIR"/mergetools "$GIT_VALGRIND/bin/mergetools"
500 OLDIFS=$IFS
501 IFS=:
502 for path in $PATH
504 ls "$path"/git-* 2> /dev/null |
505 while read file
507 make_valgrind_symlink "$file"
508 done
509 done
510 IFS=$OLDIFS
511 PATH=$GIT_VALGRIND/bin:$PATH
512 GIT_EXEC_PATH=$GIT_VALGRIND/bin
513 export GIT_VALGRIND
514 elif test -n "$GIT_TEST_INSTALLED"
515 then
516 GIT_EXEC_PATH=$($GIT_TEST_INSTALLED/git --exec-path) ||
517 error "Cannot run git from $GIT_TEST_INSTALLED."
518 PATH=$GIT_TEST_INSTALLED:$GIT_BUILD_DIR:$PATH
519 GIT_EXEC_PATH=${GIT_TEST_EXEC_PATH:-$GIT_EXEC_PATH}
520 else # normal case, use ../bin-wrappers only unless $with_dashes:
521 git_bin_dir="$GIT_BUILD_DIR/bin-wrappers"
522 if ! test -x "$git_bin_dir/git"
523 then
524 if test -z "$with_dashes"
525 then
526 say "$git_bin_dir/git is not executable; using GIT_EXEC_PATH"
528 with_dashes=t
530 PATH="$git_bin_dir:$PATH"
531 GIT_EXEC_PATH=$GIT_BUILD_DIR
532 if test -n "$with_dashes"
533 then
534 PATH="$GIT_BUILD_DIR:$PATH"
537 GIT_TEMPLATE_DIR="$GIT_BUILD_DIR"/templates/blt
538 unset GIT_CONFIG
539 GIT_CONFIG_NOSYSTEM=1
540 GIT_ATTR_NOSYSTEM=1
541 export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG_NOSYSTEM GIT_ATTR_NOSYSTEM
543 if test -z "$GIT_TEST_CMP"
544 then
545 if test -n "$GIT_TEST_CMP_USE_COPIED_CONTEXT"
546 then
547 GIT_TEST_CMP="$DIFF -c"
548 else
549 GIT_TEST_CMP="$DIFF -u"
553 GITPERLLIB="$GIT_BUILD_DIR"/perl/blib/lib:"$GIT_BUILD_DIR"/perl/blib/arch/auto/Git
554 export GITPERLLIB
555 test -d "$GIT_BUILD_DIR"/templates/blt || {
556 error "You haven't built things yet, have you?"
559 if test -z "$GIT_TEST_INSTALLED" && test -z "$NO_PYTHON"
560 then
561 GITPYTHONLIB="$GIT_BUILD_DIR/git_remote_helpers/build/lib"
562 export GITPYTHONLIB
563 test -d "$GIT_BUILD_DIR"/git_remote_helpers/build || {
564 error "You haven't built git_remote_helpers yet, have you?"
568 if ! test -x "$GIT_BUILD_DIR"/test-chmtime
569 then
570 echo >&2 'You need to build test-chmtime:'
571 echo >&2 'Run "make test-chmtime" in the source (toplevel) directory'
572 exit 1
575 # Test repository
576 test="trash directory.$(basename "$0" .sh)"
577 test -n "$root" && test="$root/$test"
578 case "$test" in
579 /*) TRASH_DIRECTORY="$test" ;;
580 *) TRASH_DIRECTORY="$TEST_OUTPUT_DIRECTORY/$test" ;;
581 esac
582 test ! -z "$debug" || remove_trash=$TRASH_DIRECTORY
583 rm -fr "$test" || {
584 GIT_EXIT_OK=t
585 echo >&5 "FATAL: Cannot prepare test area"
586 exit 1
589 HOME="$TRASH_DIRECTORY"
590 export HOME
592 if test -z "$TEST_NO_CREATE_REPO"
593 then
594 test_create_repo "$test"
595 else
596 mkdir -p "$test"
598 # Use -P to resolve symlinks in our working directory so that the cwd
599 # in subprocesses like git equals our $PWD (for pathname comparisons).
600 cd -P "$test" || exit 1
602 this_test=${0##*/}
603 this_test=${this_test%%-*}
604 for skp in $GIT_SKIP_TESTS
606 case "$this_test" in
607 $skp)
608 say_color skip >&3 "skipping test $this_test altogether"
609 skip_all="skip all tests in $this_test"
610 test_done
611 esac
612 done
614 # Provide an implementation of the 'yes' utility
615 yes () {
616 if test $# = 0
617 then
619 else
620 y="$*"
623 while echo "$y"
626 done
629 # Fix some commands on Windows
630 case $(uname -s) in
631 *MINGW*)
632 # Windows has its own (incompatible) sort and find
633 sort () {
634 /usr/bin/sort "$@"
636 find () {
637 /usr/bin/find "$@"
639 sum () {
640 md5sum "$@"
642 # git sees Windows-style pwd
643 pwd () {
644 builtin pwd -W
646 # no POSIX permissions
647 # backslashes in pathspec are converted to '/'
648 # exec does not inherit the PID
649 test_set_prereq MINGW
650 test_set_prereq SED_STRIPS_CR
652 *CYGWIN*)
653 test_set_prereq POSIXPERM
654 test_set_prereq EXECKEEPSPID
655 test_set_prereq NOT_MINGW
656 test_set_prereq SED_STRIPS_CR
659 test_set_prereq POSIXPERM
660 test_set_prereq BSLASHPSPEC
661 test_set_prereq EXECKEEPSPID
662 test_set_prereq NOT_MINGW
664 esac
666 ( COLUMNS=1 && test $COLUMNS = 1 ) && test_set_prereq COLUMNS_CAN_BE_1
667 test -z "$NO_PERL" && test_set_prereq PERL
668 test -z "$NO_PYTHON" && test_set_prereq PYTHON
669 test -n "$USE_LIBPCRE" && test_set_prereq LIBPCRE
670 test -z "$NO_GETTEXT" && test_set_prereq GETTEXT
672 # Can we rely on git's output in the C locale?
673 if test -n "$GETTEXT_POISON"
674 then
675 GIT_GETTEXT_POISON=YesPlease
676 export GIT_GETTEXT_POISON
677 test_set_prereq GETTEXT_POISON
678 else
679 test_set_prereq C_LOCALE_OUTPUT
682 # Use this instead of test_cmp to compare files that contain expected and
683 # actual output from git commands that can be translated. When running
684 # under GETTEXT_POISON this pretends that the command produced expected
685 # results.
686 test_i18ncmp () {
687 test -n "$GETTEXT_POISON" || test_cmp "$@"
690 # Use this instead of "grep expected-string actual" to see if the
691 # output from a git command that can be translated either contains an
692 # expected string, or does not contain an unwanted one. When running
693 # under GETTEXT_POISON this pretends that the command produced expected
694 # results.
695 test_i18ngrep () {
696 if test -n "$GETTEXT_POISON"
697 then
698 : # pretend success
699 elif test "x!" = "x$1"
700 then
701 shift
702 ! grep "$@"
703 else
704 grep "$@"
708 test_lazy_prereq SYMLINKS '
709 # test whether the filesystem supports symbolic links
710 ln -s x y && test -h y
713 test_lazy_prereq CASE_INSENSITIVE_FS '
714 echo good >CamelCase &&
715 echo bad >camelcase &&
716 test "$(cat CamelCase)" != good
719 test_lazy_prereq UTF8_NFD_TO_NFC '
720 # check whether FS converts nfd unicode to nfc
721 auml=$(printf "\303\244")
722 aumlcdiar=$(printf "\141\314\210")
723 >"$auml" &&
724 case "$(echo *)" in
725 "$aumlcdiar")
726 true ;;
728 false ;;
729 esac
732 # When the tests are run as root, permission tests will report that
733 # things are writable when they shouldn't be.
734 test -w / || test_set_prereq SANITY