git-remote-hg: add the helper
[git/dscho.git] / t / test-lib.sh
blob7e2d0f3eb0316d4e76c2f1184665347289fce78e
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 # Keep the original TERM for say_color
23 ORIGINAL_TERM=$TERM
25 # Test the binaries we have just built. The tests are kept in
26 # t/ subdirectory and are run in 'trash directory' subdirectory.
27 if test -z "$TEST_DIRECTORY"
28 then
29 # We allow tests to override this, in case they want to run tests
30 # outside of t/, e.g. for running tests on the test library
31 # itself.
32 TEST_DIRECTORY=$(pwd)
34 if test -z "$TEST_OUTPUT_DIRECTORY"
35 then
36 # Similarly, override this to store the test-results subdir
37 # elsewhere
38 TEST_OUTPUT_DIRECTORY=$TEST_DIRECTORY
40 GIT_BUILD_DIR="$TEST_DIRECTORY"/..
42 ################################################################
43 # It appears that people try to run tests without building...
44 "$GIT_BUILD_DIR/git" >/dev/null
45 if test $? != 1
46 then
47 echo >&2 'error: you do not seem to have built git yet.'
48 exit 1
51 . "$GIT_BUILD_DIR"/GIT-BUILD-OPTIONS
52 export PERL_PATH SHELL_PATH
54 # if --tee was passed, write the output not only to the terminal, but
55 # additionally to the file test-results/$BASENAME.out, too.
56 case "$GIT_TEST_TEE_STARTED, $* " in
57 done,*)
58 # do not redirect again
60 *' --tee '*|*' --va'*)
61 mkdir -p test-results
62 BASE=test-results/$(basename "$0" .sh)
63 (GIT_TEST_TEE_STARTED=done ${SHELL_PATH} "$0" "$@" 2>&1;
64 echo $? > $BASE.exit) | tee $BASE.out
65 test "$(cat $BASE.exit)" = 0
66 exit
68 esac
70 # For repeatability, reset the environment to known value.
71 LANG=C
72 LC_ALL=C
73 PAGER=cat
74 TZ=UTC
75 TERM=dumb
76 export LANG LC_ALL PAGER TERM TZ
77 EDITOR=:
78 # A call to "unset" with no arguments causes at least Solaris 10
79 # /usr/xpg4/bin/sh and /bin/ksh to bail out. So keep the unsets
80 # deriving from the command substitution clustered with the other
81 # ones.
82 unset VISUAL EMAIL LANGUAGE COLUMNS $("$PERL_PATH" -e '
83 my @env = keys %ENV;
84 my $ok = join("|", qw(
85 TRACE
86 DEBUG
87 USE_LOOKUP
88 TEST
89 .*_TEST
90 PROVE
91 VALGRIND
92 PERF_AGGREGATING_LATER
93 ));
94 my @vars = grep(/^GIT_/ && !/^GIT_($ok)/o, @env);
95 print join("\n", @vars);
97 unset XDG_CONFIG_HOME
98 GIT_AUTHOR_EMAIL=author@example.com
99 GIT_AUTHOR_NAME='A U Thor'
100 GIT_COMMITTER_EMAIL=committer@example.com
101 GIT_COMMITTER_NAME='C O Mitter'
102 GIT_MERGE_VERBOSITY=5
103 GIT_MERGE_AUTOEDIT=no
104 export GIT_MERGE_VERBOSITY GIT_MERGE_AUTOEDIT
105 export GIT_AUTHOR_EMAIL GIT_AUTHOR_NAME
106 export GIT_COMMITTER_EMAIL GIT_COMMITTER_NAME
107 export EDITOR
109 # Add libc MALLOC and MALLOC_PERTURB test
110 # only if we are not executing the test with valgrind
111 if expr " $GIT_TEST_OPTS " : ".* --valgrind " >/dev/null ||
112 test -n "$TEST_NO_MALLOC_CHECK"
113 then
114 setup_malloc_check () {
115 : nothing
117 teardown_malloc_check () {
118 : nothing
120 else
121 setup_malloc_check () {
122 MALLOC_CHECK_=3 MALLOC_PERTURB_=165
123 export MALLOC_CHECK_ MALLOC_PERTURB_
125 teardown_malloc_check () {
126 unset MALLOC_CHECK_ MALLOC_PERTURB_
130 # Protect ourselves from common misconfiguration to export
131 # CDPATH into the environment
132 unset CDPATH
134 unset GREP_OPTIONS
136 case $(echo $GIT_TRACE |tr "[A-Z]" "[a-z]") in
137 1|2|true)
138 echo "* warning: Some tests will not work if GIT_TRACE" \
139 "is set as to trace on STDERR ! *"
140 echo "* warning: Please set GIT_TRACE to something" \
141 "other than 1, 2 or true ! *"
143 esac
145 # Convenience
147 # A regexp to match 5 and 40 hexdigits
148 _x05='[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
149 _x40="$_x05$_x05$_x05$_x05$_x05$_x05$_x05$_x05"
151 # Zero SHA-1
152 _z40=0000000000000000000000000000000000000000
154 # Line feed
155 LF='
158 export _x05 _x40 _z40 LF
160 # Each test should start with something like this, after copyright notices:
162 # test_description='Description of this test...
163 # This test checks if command xyzzy does the right thing...
165 # . ./test-lib.sh
166 [ "x$ORIGINAL_TERM" != "xdumb" ] && (
167 TERM=$ORIGINAL_TERM &&
168 export TERM &&
169 [ -t 1 ] &&
170 tput bold >/dev/null 2>&1 &&
171 tput setaf 1 >/dev/null 2>&1 &&
172 tput sgr0 >/dev/null 2>&1
173 ) &&
174 color=t
176 while test "$#" -ne 0
178 case "$1" in
179 -d|--d|--de|--deb|--debu|--debug)
180 debug=t; shift ;;
181 -i|--i|--im|--imm|--imme|--immed|--immedi|--immedia|--immediat|--immediate)
182 immediate=t; shift ;;
183 -l|--l|--lo|--lon|--long|--long-|--long-t|--long-te|--long-tes|--long-test|--long-tests)
184 GIT_TEST_LONG=t; export GIT_TEST_LONG; shift ;;
185 -h|--h|--he|--hel|--help)
186 help=t; shift ;;
187 -v|--v|--ve|--ver|--verb|--verbo|--verbos|--verbose)
188 verbose=t; shift ;;
189 -q|--q|--qu|--qui|--quie|--quiet)
190 # Ignore --quiet under a TAP::Harness. Saying how many tests
191 # passed without the ok/not ok details is always an error.
192 test -z "$HARNESS_ACTIVE" && quiet=t; shift ;;
193 --with-dashes)
194 with_dashes=t; shift ;;
195 --no-color)
196 color=; shift ;;
197 --va|--val|--valg|--valgr|--valgri|--valgrin|--valgrind)
198 valgrind=t; verbose=t; shift ;;
199 --tee)
200 shift ;; # was handled already
201 --root=*)
202 root=$(expr "z$1" : 'z[^=]*=\(.*\)')
203 shift ;;
205 echo "error: unknown test option '$1'" >&2; exit 1 ;;
206 esac
207 done
209 if test -n "$color"
210 then
211 say_color () {
213 TERM=$ORIGINAL_TERM
214 export TERM
215 case "$1" in
216 error)
217 tput bold; tput setaf 1;; # bold red
218 skip)
219 tput bold; tput setaf 2;; # bold green
220 pass)
221 tput setaf 2;; # green
222 info)
223 tput setaf 3;; # brown
225 test -n "$quiet" && return;;
226 esac
227 shift
228 printf "%s" "$*"
229 tput sgr0
230 echo
233 else
234 say_color() {
235 test -z "$1" && test -n "$quiet" && return
236 shift
237 echo "$*"
241 error () {
242 say_color error "error: $*"
243 GIT_EXIT_OK=t
244 exit 1
247 say () {
248 say_color info "$*"
251 test "${test_description}" != "" ||
252 error "Test script did not set test_description."
254 if test "$help" = "t"
255 then
256 echo "$test_description"
257 exit 0
260 exec 5>&1
261 exec 6<&0
262 if test "$verbose" = "t"
263 then
264 exec 4>&2 3>&1
265 else
266 exec 4>/dev/null 3>/dev/null
269 test_failure=0
270 test_count=0
271 test_fixed=0
272 test_broken=0
273 test_success=0
275 test_external_has_tap=0
277 die () {
278 code=$?
279 if test -n "$GIT_EXIT_OK"
280 then
281 exit $code
282 else
283 echo >&5 "FATAL: Unexpected exit with code $code"
284 exit 1
288 GIT_EXIT_OK=
289 trap 'die' EXIT
291 # The user-facing functions are loaded from a separate file so that
292 # test_perf subshells can have them too
293 . "$TEST_DIRECTORY/test-lib-functions.sh"
295 # You are not expected to call test_ok_ and test_failure_ directly, use
296 # the text_expect_* functions instead.
298 test_ok_ () {
299 test_success=$(($test_success + 1))
300 say_color "" "ok $test_count - $@"
303 test_failure_ () {
304 test_failure=$(($test_failure + 1))
305 say_color error "not ok - $test_count $1"
306 shift
307 echo "$@" | sed -e 's/^/# /'
308 test "$immediate" = "" || { GIT_EXIT_OK=t; exit 1; }
311 test_known_broken_ok_ () {
312 test_fixed=$(($test_fixed+1))
313 say_color "" "ok $test_count - $@ # TODO known breakage"
316 test_known_broken_failure_ () {
317 test_broken=$(($test_broken+1))
318 say_color skip "not ok $test_count - $@ # TODO known breakage"
321 test_debug () {
322 test "$debug" = "" || eval "$1"
325 test_eval_ () {
326 # This is a separate function because some tests use
327 # "return" to end a test_expect_success block early.
328 eval </dev/null >&3 2>&4 "$*"
331 test_run_ () {
332 test_cleanup=:
333 expecting_failure=$2
334 test_eval_ "$1"
335 eval_ret=$?
337 if test -z "$immediate" || test $eval_ret = 0 || test -n "$expecting_failure"
338 then
339 setup_malloc_check
340 test_eval_ "$test_cleanup"
341 teardown_malloc_check
343 if test "$verbose" = "t" && test -n "$HARNESS_ACTIVE"
344 then
345 echo ""
347 return "$eval_ret"
350 test_skip () {
351 test_count=$(($test_count+1))
352 to_skip=
353 for skp in $GIT_SKIP_TESTS
355 case $this_test.$test_count in
356 $skp)
357 to_skip=t
358 break
359 esac
360 done
361 if test -z "$to_skip" && test -n "$test_prereq" &&
362 ! test_have_prereq "$test_prereq"
363 then
364 to_skip=t
366 case "$to_skip" in
368 of_prereq=
369 if test "$missing_prereq" != "$test_prereq"
370 then
371 of_prereq=" of $test_prereq"
374 say_color skip >&3 "skipping test: $@"
375 say_color skip "ok $test_count # skip $1 (missing $missing_prereq${of_prereq})"
376 : true
379 false
381 esac
384 # stub; perf-lib overrides it
385 test_at_end_hook_ () {
389 test_done () {
390 GIT_EXIT_OK=t
392 if test -z "$HARNESS_ACTIVE"
393 then
394 test_results_dir="$TEST_OUTPUT_DIRECTORY/test-results"
395 mkdir -p "$test_results_dir"
396 test_results_path="$test_results_dir/${0%.sh}-$$.counts"
398 cat >>"$test_results_path" <<-EOF
399 total $test_count
400 success $test_success
401 fixed $test_fixed
402 broken $test_broken
403 failed $test_failure
408 if test "$test_fixed" != 0
409 then
410 say_color pass "# fixed $test_fixed known breakage(s)"
412 if test "$test_broken" != 0
413 then
414 say_color error "# still have $test_broken known breakage(s)"
415 msg="remaining $(($test_count-$test_broken)) test(s)"
416 else
417 msg="$test_count test(s)"
419 case "$test_failure" in
421 # Maybe print SKIP message
422 if test -n "$skip_all" && test $test_count -gt 0
423 then
424 error "Can't use skip_all after running some tests"
426 [ -z "$skip_all" ] || skip_all=" # SKIP $skip_all"
428 if test $test_external_has_tap -eq 0
429 then
430 if test $test_count -gt 0
431 then
432 say_color pass "# passed all $msg"
434 say "1..$test_count$skip_all"
437 test -d "$remove_trash" &&
438 cd "$(dirname "$remove_trash")" &&
439 rm -rf "$(basename "$remove_trash")"
441 test_at_end_hook_
443 exit 0 ;;
446 if test $test_external_has_tap -eq 0
447 then
448 say_color error "# failed $test_failure among $msg"
449 say "1..$test_count"
452 exit 1 ;;
454 esac
457 if test -n "$valgrind"
458 then
459 make_symlink () {
460 test -h "$2" &&
461 test "$1" = "$(readlink "$2")" || {
462 # be super paranoid
463 if mkdir "$2".lock
464 then
465 rm -f "$2" &&
466 ln -s "$1" "$2" &&
467 rm -r "$2".lock
468 else
469 while test -d "$2".lock
471 say "Waiting for lock on $2."
472 sleep 1
473 done
478 make_valgrind_symlink () {
479 # handle only executables, unless they are shell libraries that
480 # need to be in the exec-path. We will just use "#!" as a
481 # guess for a shell-script, since we have no idea what the user
482 # may have configured as the shell path.
483 test -x "$1" ||
484 test "#!" = "$(head -c 2 <"$1")" ||
485 return;
487 base=$(basename "$1")
488 symlink_target=$GIT_BUILD_DIR/$base
489 # do not override scripts
490 if test -x "$symlink_target" &&
491 test ! -d "$symlink_target" &&
492 test "#!" != "$(head -c 2 < "$symlink_target")"
493 then
494 symlink_target=../valgrind.sh
496 case "$base" in
497 *.sh|*.perl)
498 symlink_target=../unprocessed-script
499 esac
500 # create the link, or replace it if it is out of date
501 make_symlink "$symlink_target" "$GIT_VALGRIND/bin/$base" || exit
504 # override all git executables in TEST_DIRECTORY/..
505 GIT_VALGRIND=$TEST_DIRECTORY/valgrind
506 mkdir -p "$GIT_VALGRIND"/bin
507 for file in $GIT_BUILD_DIR/git* $GIT_BUILD_DIR/test-*
509 make_valgrind_symlink $file
510 done
511 # special-case the mergetools loadables
512 make_symlink "$GIT_BUILD_DIR"/mergetools "$GIT_VALGRIND/bin/mergetools"
513 OLDIFS=$IFS
514 IFS=:
515 for path in $PATH
517 ls "$path"/git-* 2> /dev/null |
518 while read file
520 make_valgrind_symlink "$file"
521 done
522 done
523 IFS=$OLDIFS
524 PATH=$GIT_VALGRIND/bin:$PATH
525 GIT_EXEC_PATH=$GIT_VALGRIND/bin
526 export GIT_VALGRIND
527 elif test -n "$GIT_TEST_INSTALLED"
528 then
529 GIT_EXEC_PATH=$($GIT_TEST_INSTALLED/git --exec-path) ||
530 error "Cannot run git from $GIT_TEST_INSTALLED."
531 PATH=$GIT_TEST_INSTALLED:$GIT_BUILD_DIR:$PATH
532 GIT_EXEC_PATH=${GIT_TEST_EXEC_PATH:-$GIT_EXEC_PATH}
533 else # normal case, use ../bin-wrappers only unless $with_dashes:
534 git_bin_dir="$GIT_BUILD_DIR/bin-wrappers"
535 if ! test -x "$git_bin_dir/git"
536 then
537 if test -z "$with_dashes"
538 then
539 say "$git_bin_dir/git is not executable; using GIT_EXEC_PATH"
541 with_dashes=t
543 PATH="$git_bin_dir:$PATH"
544 GIT_EXEC_PATH=$GIT_BUILD_DIR
545 if test -n "$with_dashes"
546 then
547 PATH="$GIT_BUILD_DIR:$PATH"
550 GIT_TEMPLATE_DIR="$GIT_BUILD_DIR"/templates/blt
551 unset GIT_CONFIG
552 GIT_CONFIG_NOSYSTEM=1
553 GIT_ATTR_NOSYSTEM=1
554 export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG_NOSYSTEM GIT_ATTR_NOSYSTEM
556 if test -z "$GIT_TEST_CMP"
557 then
558 if test -n "$GIT_TEST_CMP_USE_COPIED_CONTEXT"
559 then
560 GIT_TEST_CMP="$DIFF -c"
561 else
562 GIT_TEST_CMP="$DIFF -u"
566 GITPERLLIB="$GIT_BUILD_DIR"/perl/blib/lib:"$GIT_BUILD_DIR"/perl/blib/arch/auto/Git
567 export GITPERLLIB
568 test -d "$GIT_BUILD_DIR"/templates/blt || {
569 error "You haven't built things yet, have you?"
572 if test -z "$GIT_TEST_INSTALLED" && test -z "$NO_PYTHON"
573 then
574 GITPYTHONLIB="$GIT_BUILD_DIR/git_remote_helpers/build/lib"
575 export GITPYTHONLIB
576 test -d "$GIT_BUILD_DIR"/git_remote_helpers/build || {
577 error "You haven't built git_remote_helpers yet, have you?"
581 if ! test -x "$GIT_BUILD_DIR"/test-chmtime
582 then
583 echo >&2 'You need to build test-chmtime:'
584 echo >&2 'Run "make test-chmtime" in the source (toplevel) directory'
585 exit 1
588 # Test repository
589 test="trash directory.$(basename "$0" .sh)"
590 test -n "$root" && test="$root/$test"
591 case "$test" in
592 /*) TRASH_DIRECTORY="$test" ;;
593 *) TRASH_DIRECTORY="$TEST_OUTPUT_DIRECTORY/$test" ;;
594 esac
595 test ! -z "$debug" || remove_trash=$TRASH_DIRECTORY
596 rm -fr "$test" || {
597 GIT_EXIT_OK=t
598 echo >&5 "FATAL: Cannot prepare test area"
599 exit 1
602 HOME="$TRASH_DIRECTORY"
603 export HOME
605 if test -z "$TEST_NO_CREATE_REPO"
606 then
607 test_create_repo "$test"
608 else
609 mkdir -p "$test"
611 # Use -P to resolve symlinks in our working directory so that the cwd
612 # in subprocesses like git equals our $PWD (for pathname comparisons).
613 cd -P "$test" || exit 1
615 this_test=${0##*/}
616 this_test=${this_test%%-*}
617 for skp in $GIT_SKIP_TESTS
619 case "$this_test" in
620 $skp)
621 say_color skip >&3 "skipping test $this_test altogether"
622 skip_all="skip all tests in $this_test"
623 test_done
624 esac
625 done
627 # Provide an implementation of the 'yes' utility
628 yes () {
629 if test $# = 0
630 then
632 else
633 y="$*"
636 while echo "$y"
639 done
642 # Fix some commands on Windows
643 case $(uname -s) in
644 *MINGW*)
645 # Windows has its own (incompatible) sort and find
646 sort () {
647 /usr/bin/sort "$@"
649 find () {
650 /usr/bin/find "$@"
652 sum () {
653 md5sum "$@"
655 # git sees Windows-style pwd
656 pwd () {
657 builtin pwd -W
659 # no POSIX permissions
660 # backslashes in pathspec are converted to '/'
661 # exec does not inherit the PID
662 test_set_prereq MINGW
663 test_set_prereq SED_STRIPS_CR
665 *CYGWIN*)
666 test_set_prereq POSIXPERM
667 test_set_prereq EXECKEEPSPID
668 test_set_prereq NOT_MINGW
669 test_set_prereq SED_STRIPS_CR
672 test_set_prereq POSIXPERM
673 test_set_prereq BSLASHPSPEC
674 test_set_prereq EXECKEEPSPID
675 test_set_prereq NOT_MINGW
677 esac
679 ( COLUMNS=1 && test $COLUMNS = 1 ) && test_set_prereq COLUMNS_CAN_BE_1
680 test -z "$NO_PERL" && test_set_prereq PERL
681 test -z "$NO_PYTHON" && test_set_prereq PYTHON
682 test -n "$USE_LIBPCRE" && test_set_prereq LIBPCRE
683 test -z "$NO_GETTEXT" && test_set_prereq GETTEXT
685 # Can we rely on git's output in the C locale?
686 if test -n "$GETTEXT_POISON"
687 then
688 GIT_GETTEXT_POISON=YesPlease
689 export GIT_GETTEXT_POISON
690 test_set_prereq GETTEXT_POISON
691 else
692 test_set_prereq C_LOCALE_OUTPUT
695 # Use this instead of test_cmp to compare files that are expected to contain
696 # text (and therefore it should not matter whether the line ends in an LF or
697 # a CR/LF).
698 test_cmp_text () {
699 if test_have_prereq MINGW
700 then
701 dos2unix "$1" &&
702 dos2unix "$2"
703 fi &&
704 test_cmp "$@"
707 # Use this instead of test_cmp to compare files that contain expected and
708 # actual output from git commands that can be translated. When running
709 # under GETTEXT_POISON this pretends that the command produced expected
710 # results.
711 test_i18ncmp () {
712 test -n "$GETTEXT_POISON" || test_cmp_text "$@"
715 # Use this instead of "grep expected-string actual" to see if the
716 # output from a git command that can be translated either contains an
717 # expected string, or does not contain an unwanted one. When running
718 # under GETTEXT_POISON this pretends that the command produced expected
719 # results.
720 test_i18ngrep () {
721 if test -n "$GETTEXT_POISON"
722 then
723 : # pretend success
724 elif test "x!" = "x$1"
725 then
726 shift
727 ! grep "$@"
728 else
729 grep "$@"
733 test_lazy_prereq SYMLINKS '
734 # test whether the filesystem supports symbolic links
735 ln -s x y && test -h y
738 test_lazy_prereq CASE_INSENSITIVE_FS '
739 echo good >CamelCase &&
740 echo bad >camelcase &&
741 test "$(cat CamelCase)" != good
744 test_lazy_prereq UTF8_NFD_TO_NFC '
745 # check whether FS converts nfd unicode to nfc
746 auml=$(printf "\303\244")
747 aumlcdiar=$(printf "\141\314\210")
748 >"$auml" &&
749 case "$(echo *)" in
750 "$aumlcdiar")
751 true ;;
753 false ;;
754 esac
757 # When the tests are run as root, permission tests will report that
758 # things are writable when they shouldn't be.
759 test -w / || test_set_prereq SANITY