Warn if the Windows console font doesn't support Unicode
[git/dscho.git] / t / test-lib.sh
blob521b74872faf68c06e739566ecccd485c743ca2b
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 unset VISUAL
50 unset EMAIL
51 unset LANGUAGE
52 unset $(perl -e '
53 my @env = keys %ENV;
54 my $ok = join("|", qw(
55 TRACE
56 DEBUG
57 USE_LOOKUP
58 TEST
59 .*_TEST
60 PROVE
61 VALGRIND
62 ));
63 my @vars = grep(/^GIT_/ && !/^GIT_($ok)/o, @env);
64 print join("\n", @vars);
66 GIT_AUTHOR_EMAIL=author@example.com
67 GIT_AUTHOR_NAME='A U Thor'
68 GIT_COMMITTER_EMAIL=committer@example.com
69 GIT_COMMITTER_NAME='C O Mitter'
70 GIT_MERGE_VERBOSITY=5
71 GIT_MERGE_AUTOEDIT=no
72 export GIT_MERGE_VERBOSITY GIT_MERGE_AUTOEDIT
73 export GIT_AUTHOR_EMAIL GIT_AUTHOR_NAME
74 export GIT_COMMITTER_EMAIL GIT_COMMITTER_NAME
75 export EDITOR
77 # Protect ourselves from common misconfiguration to export
78 # CDPATH into the environment
79 unset CDPATH
81 unset GREP_OPTIONS
83 case $(echo $GIT_TRACE |tr "[A-Z]" "[a-z]") in
84 1|2|true)
85 echo "* warning: Some tests will not work if GIT_TRACE" \
86 "is set as to trace on STDERR ! *"
87 echo "* warning: Please set GIT_TRACE to something" \
88 "other than 1, 2 or true ! *"
90 esac
92 # Convenience
94 # A regexp to match 5 and 40 hexdigits
95 _x05='[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
96 _x40="$_x05$_x05$_x05$_x05$_x05$_x05$_x05$_x05"
98 # Zero SHA-1
99 _z40=0000000000000000000000000000000000000000
101 # Line feed
102 LF='
105 # Each test should start with something like this, after copyright notices:
107 # test_description='Description of this test...
108 # This test checks if command xyzzy does the right thing...
110 # . ./test-lib.sh
111 [ "x$ORIGINAL_TERM" != "xdumb" ] && (
112 TERM=$ORIGINAL_TERM &&
113 export TERM &&
114 [ -t 1 ] &&
115 tput bold >/dev/null 2>&1 &&
116 tput setaf 1 >/dev/null 2>&1 &&
117 tput sgr0 >/dev/null 2>&1
118 ) &&
119 color=t
121 while test "$#" -ne 0
123 case "$1" in
124 -d|--d|--de|--deb|--debu|--debug)
125 debug=t; shift ;;
126 -i|--i|--im|--imm|--imme|--immed|--immedi|--immedia|--immediat|--immediate)
127 immediate=t; shift ;;
128 -l|--l|--lo|--lon|--long|--long-|--long-t|--long-te|--long-tes|--long-test|--long-tests)
129 GIT_TEST_LONG=t; export GIT_TEST_LONG; shift ;;
130 -h|--h|--he|--hel|--help)
131 help=t; shift ;;
132 -v|--v|--ve|--ver|--verb|--verbo|--verbos|--verbose)
133 verbose=t; shift ;;
134 -q|--q|--qu|--qui|--quie|--quiet)
135 # Ignore --quiet under a TAP::Harness. Saying how many tests
136 # passed without the ok/not ok details is always an error.
137 test -z "$HARNESS_ACTIVE" && quiet=t; shift ;;
138 --with-dashes)
139 with_dashes=t; shift ;;
140 --no-color)
141 color=; shift ;;
142 --va|--val|--valg|--valgr|--valgri|--valgrin|--valgrind)
143 valgrind=t; verbose=t; shift ;;
144 --tee)
145 shift ;; # was handled already
146 --root=*)
147 root=$(expr "z$1" : 'z[^=]*=\(.*\)')
148 shift ;;
150 echo "error: unknown test option '$1'" >&2; exit 1 ;;
151 esac
152 done
154 if test -n "$color"; then
155 say_color () {
157 TERM=$ORIGINAL_TERM
158 export TERM
159 case "$1" in
160 error) tput bold; tput setaf 1;; # bold red
161 skip) tput bold; tput setaf 2;; # bold green
162 pass) tput setaf 2;; # green
163 info) tput setaf 3;; # brown
164 *) test -n "$quiet" && return;;
165 esac
166 shift
167 printf "%s" "$*"
168 tput sgr0
169 echo
172 else
173 say_color() {
174 test -z "$1" && test -n "$quiet" && return
175 shift
176 echo "$*"
180 error () {
181 say_color error "error: $*"
182 GIT_EXIT_OK=t
183 exit 1
186 say () {
187 say_color info "$*"
190 test "${test_description}" != "" ||
191 error "Test script did not set test_description."
193 if test "$help" = "t"
194 then
195 echo "$test_description"
196 exit 0
199 exec 5>&1
200 exec 6<&0
201 if test "$verbose" = "t"
202 then
203 exec 4>&2 3>&1
204 else
205 exec 4>/dev/null 3>/dev/null
208 test_failure=0
209 test_count=0
210 test_fixed=0
211 test_broken=0
212 test_success=0
214 test_external_has_tap=0
216 die () {
217 code=$?
218 if test -n "$GIT_EXIT_OK"
219 then
220 exit $code
221 else
222 echo >&5 "FATAL: Unexpected exit with code $code"
223 exit 1
227 GIT_EXIT_OK=
228 trap 'die' EXIT
230 # The semantics of the editor variables are that of invoking
231 # sh -c "$EDITOR \"$@\"" files ...
233 # If our trash directory contains shell metacharacters, they will be
234 # interpreted if we just set $EDITOR directly, so do a little dance with
235 # environment variables to work around this.
237 # In particular, quoting isn't enough, as the path may contain the same quote
238 # that we're using.
239 test_set_editor () {
240 FAKE_EDITOR="$1"
241 export FAKE_EDITOR
242 EDITOR='"$FAKE_EDITOR"'
243 export EDITOR
246 test_decode_color () {
247 awk '
248 function name(n) {
249 if (n == 0) return "RESET";
250 if (n == 1) return "BOLD";
251 if (n == 30) return "BLACK";
252 if (n == 31) return "RED";
253 if (n == 32) return "GREEN";
254 if (n == 33) return "YELLOW";
255 if (n == 34) return "BLUE";
256 if (n == 35) return "MAGENTA";
257 if (n == 36) return "CYAN";
258 if (n == 37) return "WHITE";
259 if (n == 40) return "BLACK";
260 if (n == 41) return "BRED";
261 if (n == 42) return "BGREEN";
262 if (n == 43) return "BYELLOW";
263 if (n == 44) return "BBLUE";
264 if (n == 45) return "BMAGENTA";
265 if (n == 46) return "BCYAN";
266 if (n == 47) return "BWHITE";
269 while (match($0, /\033\[[0-9;]*m/) != 0) {
270 printf "%s<", substr($0, 1, RSTART-1);
271 codes = substr($0, RSTART+2, RLENGTH-3);
272 if (length(codes) == 0)
273 printf "%s", name(0)
274 else {
275 n = split(codes, ary, ";");
276 sep = "";
277 for (i = 1; i <= n; i++) {
278 printf "%s%s", sep, name(ary[i]);
279 sep = ";"
282 printf ">";
283 $0 = substr($0, RSTART + RLENGTH, length($0) - RSTART - RLENGTH + 1);
285 print
290 nul_to_q () {
291 perl -pe 'y/\000/Q/'
294 q_to_nul () {
295 perl -pe 'y/Q/\000/'
298 q_to_cr () {
299 tr Q '\015'
302 q_to_tab () {
303 tr Q '\011'
306 append_cr () {
307 sed -e 's/$/Q/' | tr Q '\015'
310 remove_cr () {
311 tr '\015' Q | sed -e 's/Q$//'
314 # In some bourne shell implementations, the "unset" builtin returns
315 # nonzero status when a variable to be unset was not set in the first
316 # place.
318 # Use sane_unset when that should not be considered an error.
320 sane_unset () {
321 unset "$@"
322 return 0
325 test_tick () {
326 if test -z "${test_tick+set}"
327 then
328 test_tick=1112911993
329 else
330 test_tick=$(($test_tick + 60))
332 GIT_COMMITTER_DATE="$test_tick -0700"
333 GIT_AUTHOR_DATE="$test_tick -0700"
334 export GIT_COMMITTER_DATE GIT_AUTHOR_DATE
337 # Stop execution and start a shell. This is useful for debugging tests and
338 # only makes sense together with "-v".
340 # Be sure to remove all invocations of this command before submitting.
342 test_pause () {
343 if test "$verbose" = t; then
344 "$SHELL_PATH" <&6 >&3 2>&4
345 else
346 error >&5 "test_pause requires --verbose"
350 # Call test_commit with the arguments "<message> [<file> [<contents>]]"
352 # This will commit a file with the given contents and the given commit
353 # message. It will also add a tag with <message> as name.
355 # Both <file> and <contents> default to <message>.
357 test_commit () {
358 file=${2:-"$1.t"}
359 echo "${3-$1}" > "$file" &&
360 git add "$file" &&
361 test_tick &&
362 git commit -m "$1" &&
363 git tag "$1"
366 # Call test_merge with the arguments "<message> <commit>", where <commit>
367 # can be a tag pointing to the commit-to-merge.
369 test_merge () {
370 test_tick &&
371 git merge -m "$1" "$2" &&
372 git tag "$1"
375 # This function helps systems where core.filemode=false is set.
376 # Use it instead of plain 'chmod +x' to set or unset the executable bit
377 # of a file in the working directory and add it to the index.
379 test_chmod () {
380 chmod "$@" &&
381 git update-index --add "--chmod=$@"
384 # Unset a configuration variable, but don't fail if it doesn't exist.
385 test_unconfig () {
386 git config --unset-all "$@"
387 config_status=$?
388 case "$config_status" in
389 5) # ok, nothing to unset
390 config_status=0
392 esac
393 return $config_status
396 # Set git config, automatically unsetting it after the test is over.
397 test_config () {
398 test_when_finished "test_unconfig '$1'" &&
399 git config "$@"
402 test_config_global () {
403 test_when_finished "test_unconfig --global '$1'" &&
404 git config --global "$@"
407 # Use test_set_prereq to tell that a particular prerequisite is available.
408 # The prerequisite can later be checked for in two ways:
410 # - Explicitly using test_have_prereq.
412 # - Implicitly by specifying the prerequisite tag in the calls to
413 # test_expect_{success,failure,code}.
415 # The single parameter is the prerequisite tag (a simple word, in all
416 # capital letters by convention).
418 test_set_prereq () {
419 satisfied="$satisfied$1 "
421 satisfied=" "
423 test_have_prereq () {
424 # prerequisites can be concatenated with ','
425 save_IFS=$IFS
426 IFS=,
427 set -- $*
428 IFS=$save_IFS
430 total_prereq=0
431 ok_prereq=0
432 missing_prereq=
434 for prerequisite
436 total_prereq=$(($total_prereq + 1))
437 case $satisfied in
438 *" $prerequisite "*)
439 ok_prereq=$(($ok_prereq + 1))
442 # Keep a list of missing prerequisites
443 if test -z "$missing_prereq"
444 then
445 missing_prereq=$prerequisite
446 else
447 missing_prereq="$prerequisite,$missing_prereq"
449 esac
450 done
452 test $total_prereq = $ok_prereq
455 test_declared_prereq () {
456 case ",$test_prereq," in
457 *,$1,*)
458 return 0
460 esac
461 return 1
464 # You are not expected to call test_ok_ and test_failure_ directly, use
465 # the text_expect_* functions instead.
467 test_ok_ () {
468 test_success=$(($test_success + 1))
469 say_color "" "ok $test_count - $@"
472 test_failure_ () {
473 test_failure=$(($test_failure + 1))
474 say_color error "not ok - $test_count $1"
475 shift
476 echo "$@" | sed -e 's/^/# /'
477 test "$immediate" = "" || { GIT_EXIT_OK=t; exit 1; }
480 test_known_broken_ok_ () {
481 test_fixed=$(($test_fixed+1))
482 say_color "" "ok $test_count - $@ # TODO known breakage"
485 test_known_broken_failure_ () {
486 test_broken=$(($test_broken+1))
487 say_color skip "not ok $test_count - $@ # TODO known breakage"
490 test_debug () {
491 test "$debug" = "" || eval "$1"
494 test_eval_ () {
495 # This is a separate function because some tests use
496 # "return" to end a test_expect_success block early.
497 eval </dev/null >&3 2>&4 "$*"
500 test_run_ () {
501 test_cleanup=:
502 expecting_failure=$2
503 test_eval_ "$1"
504 eval_ret=$?
506 if test -z "$immediate" || test $eval_ret = 0 || test -n "$expecting_failure"
507 then
508 test_eval_ "$test_cleanup"
510 if test "$verbose" = "t" && test -n "$HARNESS_ACTIVE"; then
511 echo ""
513 return "$eval_ret"
516 test_skip () {
517 test_count=$(($test_count+1))
518 to_skip=
519 for skp in $GIT_SKIP_TESTS
521 case $this_test.$test_count in
522 $skp)
523 to_skip=t
524 break
525 esac
526 done
527 if test -z "$to_skip" && test -n "$test_prereq" &&
528 ! test_have_prereq "$test_prereq"
529 then
530 to_skip=t
532 case "$to_skip" in
534 of_prereq=
535 if test "$missing_prereq" != "$test_prereq"
536 then
537 of_prereq=" of $test_prereq"
540 say_color skip >&3 "skipping test: $@"
541 say_color skip "ok $test_count # skip $1 (missing $missing_prereq${of_prereq})"
542 : true
545 false
547 esac
550 test_expect_failure () {
551 test "$#" = 3 && { test_prereq=$1; shift; } || test_prereq=
552 test "$#" = 2 ||
553 error "bug in the test script: not 2 or 3 parameters to test-expect-failure"
554 export test_prereq
555 if ! test_skip "$@"
556 then
557 say >&3 "checking known breakage: $2"
558 if test_run_ "$2" expecting_failure
559 then
560 test_known_broken_ok_ "$1"
561 else
562 test_known_broken_failure_ "$1"
565 echo >&3 ""
568 test_expect_success () {
569 test "$#" = 3 && { test_prereq=$1; shift; } || test_prereq=
570 test "$#" = 2 ||
571 error "bug in the test script: not 2 or 3 parameters to test-expect-success"
572 export test_prereq
573 if ! test_skip "$@"
574 then
575 say >&3 "expecting success: $2"
576 if test_run_ "$2"
577 then
578 test_ok_ "$1"
579 else
580 test_failure_ "$@"
583 echo >&3 ""
586 # test_external runs external test scripts that provide continuous
587 # test output about their progress, and succeeds/fails on
588 # zero/non-zero exit code. It outputs the test output on stdout even
589 # in non-verbose mode, and announces the external script with "# run
590 # <n>: ..." before running it. When providing relative paths, keep in
591 # mind that all scripts run in "trash directory".
592 # Usage: test_external description command arguments...
593 # Example: test_external 'Perl API' perl ../path/to/test.pl
594 test_external () {
595 test "$#" = 4 && { test_prereq=$1; shift; } || test_prereq=
596 test "$#" = 3 ||
597 error >&5 "bug in the test script: not 3 or 4 parameters to test_external"
598 descr="$1"
599 shift
600 export test_prereq
601 if ! test_skip "$descr" "$@"
602 then
603 # Announce the script to reduce confusion about the
604 # test output that follows.
605 say_color "" "# run $test_count: $descr ($*)"
606 # Export TEST_DIRECTORY, TRASH_DIRECTORY and GIT_TEST_LONG
607 # to be able to use them in script
608 export TEST_DIRECTORY TRASH_DIRECTORY GIT_TEST_LONG
609 # Run command; redirect its stderr to &4 as in
610 # test_run_, but keep its stdout on our stdout even in
611 # non-verbose mode.
612 "$@" 2>&4
613 if [ "$?" = 0 ]
614 then
615 if test $test_external_has_tap -eq 0; then
616 test_ok_ "$descr"
617 else
618 say_color "" "# test_external test $descr was ok"
619 test_success=$(($test_success + 1))
621 else
622 if test $test_external_has_tap -eq 0; then
623 test_failure_ "$descr" "$@"
624 else
625 say_color error "# test_external test $descr failed: $@"
626 test_failure=$(($test_failure + 1))
632 # Like test_external, but in addition tests that the command generated
633 # no output on stderr.
634 test_external_without_stderr () {
635 # The temporary file has no (and must have no) security
636 # implications.
637 tmp=${TMPDIR:-/tmp}
638 stderr="$tmp/git-external-stderr.$$.tmp"
639 test_external "$@" 4> "$stderr"
640 [ -f "$stderr" ] || error "Internal error: $stderr disappeared."
641 descr="no stderr: $1"
642 shift
643 say >&3 "# expecting no stderr from previous command"
644 if [ ! -s "$stderr" ]; then
645 rm "$stderr"
647 if test $test_external_has_tap -eq 0; then
648 test_ok_ "$descr"
649 else
650 say_color "" "# test_external_without_stderr test $descr was ok"
651 test_success=$(($test_success + 1))
653 else
654 if [ "$verbose" = t ]; then
655 output=`echo; echo "# Stderr is:"; cat "$stderr"`
656 else
657 output=
659 # rm first in case test_failure exits.
660 rm "$stderr"
661 if test $test_external_has_tap -eq 0; then
662 test_failure_ "$descr" "$@" "$output"
663 else
664 say_color error "# test_external_without_stderr test $descr failed: $@: $output"
665 test_failure=$(($test_failure + 1))
670 # debugging-friendly alternatives to "test [-f|-d|-e]"
671 # The commands test the existence or non-existence of $1. $2 can be
672 # given to provide a more precise diagnosis.
673 test_path_is_file () {
674 if ! [ -f "$1" ]
675 then
676 echo "File $1 doesn't exist. $*"
677 false
681 test_path_is_dir () {
682 if ! [ -d "$1" ]
683 then
684 echo "Directory $1 doesn't exist. $*"
685 false
689 test_path_is_missing () {
690 if [ -e "$1" ]
691 then
692 echo "Path exists:"
693 ls -ld "$1"
694 if [ $# -ge 1 ]; then
695 echo "$*"
697 false
701 # test_line_count checks that a file has the number of lines it
702 # ought to. For example:
704 # test_expect_success 'produce exactly one line of output' '
705 # do something >output &&
706 # test_line_count = 1 output
709 # is like "test $(wc -l <output) = 1" except that it passes the
710 # output through when the number of lines is wrong.
712 test_line_count () {
713 if test $# != 3
714 then
715 error "bug in the test script: not 3 parameters to test_line_count"
716 elif ! test $(wc -l <"$3") "$1" "$2"
717 then
718 echo "test_line_count: line count for $3 !$1 $2"
719 cat "$3"
720 return 1
724 # This is not among top-level (test_expect_success | test_expect_failure)
725 # but is a prefix that can be used in the test script, like:
727 # test_expect_success 'complain and die' '
728 # do something &&
729 # do something else &&
730 # test_must_fail git checkout ../outerspace
733 # Writing this as "! git checkout ../outerspace" is wrong, because
734 # the failure could be due to a segv. We want a controlled failure.
736 test_must_fail () {
737 "$@"
738 exit_code=$?
739 if test $exit_code = 0; then
740 echo >&2 "test_must_fail: command succeeded: $*"
741 return 1
742 elif test $exit_code -gt 129 -a $exit_code -le 192; then
743 echo >&2 "test_must_fail: died by signal: $*"
744 return 1
745 elif test $exit_code = 127; then
746 echo >&2 "test_must_fail: command not found: $*"
747 return 1
749 return 0
752 # Similar to test_must_fail, but tolerates success, too. This is
753 # meant to be used in contexts like:
755 # test_expect_success 'some command works without configuration' '
756 # test_might_fail git config --unset all.configuration &&
757 # do something
760 # Writing "git config --unset all.configuration || :" would be wrong,
761 # because we want to notice if it fails due to segv.
763 test_might_fail () {
764 "$@"
765 exit_code=$?
766 if test $exit_code -gt 129 -a $exit_code -le 192; then
767 echo >&2 "test_might_fail: died by signal: $*"
768 return 1
769 elif test $exit_code = 127; then
770 echo >&2 "test_might_fail: command not found: $*"
771 return 1
773 return 0
776 # Similar to test_must_fail and test_might_fail, but check that a
777 # given command exited with a given exit code. Meant to be used as:
779 # test_expect_success 'Merge with d/f conflicts' '
780 # test_expect_code 1 git merge "merge msg" B master
783 test_expect_code () {
784 want_code=$1
785 shift
786 "$@"
787 exit_code=$?
788 if test $exit_code = $want_code
789 then
790 return 0
793 echo >&2 "test_expect_code: command exited with $exit_code, we wanted $want_code $*"
794 return 1
797 # test_cmp is a helper function to compare actual and expected output.
798 # You can use it like:
800 # test_expect_success 'foo works' '
801 # echo expected >expected &&
802 # foo >actual &&
803 # test_cmp expected actual
806 # This could be written as either "cmp" or "diff -u", but:
807 # - cmp's output is not nearly as easy to read as diff -u
808 # - not all diff versions understand "-u"
810 test_cmp() {
811 $GIT_TEST_CMP "$@"
814 # This function can be used to schedule some commands to be run
815 # unconditionally at the end of the test to restore sanity:
817 # test_expect_success 'test core.capslock' '
818 # git config core.capslock true &&
819 # test_when_finished "git config --unset core.capslock" &&
820 # hello world
823 # That would be roughly equivalent to
825 # test_expect_success 'test core.capslock' '
826 # git config core.capslock true &&
827 # hello world
828 # git config --unset core.capslock
831 # except that the greeting and config --unset must both succeed for
832 # the test to pass.
834 # Note that under --immediate mode, no clean-up is done to help diagnose
835 # what went wrong.
837 test_when_finished () {
838 test_cleanup="{ $*
839 } && (exit \"\$eval_ret\"); eval_ret=\$?; $test_cleanup"
842 # Most tests can use the created repository, but some may need to create more.
843 # Usage: test_create_repo <directory>
844 test_create_repo () {
845 test "$#" = 1 ||
846 error "bug in the test script: not 1 parameter to test-create-repo"
847 repo="$1"
848 mkdir -p "$repo"
850 cd "$repo" || error "Cannot setup test environment"
851 "$GIT_EXEC_PATH/git-init" "--template=$GIT_BUILD_DIR/templates/blt/" >&3 2>&4 ||
852 error "cannot run git init -- have you built things yet?"
853 mv .git/hooks .git/hooks-disabled
854 ) || exit
857 test_done () {
858 GIT_EXIT_OK=t
860 if test -z "$HARNESS_ACTIVE"; then
861 test_results_dir="$TEST_DIRECTORY/test-results"
862 mkdir -p "$test_results_dir"
863 test_results_path="$test_results_dir/${0%.sh}-$$.counts"
865 cat >>"$test_results_path" <<-EOF
866 total $test_count
867 success $test_success
868 fixed $test_fixed
869 broken $test_broken
870 failed $test_failure
875 if test "$test_fixed" != 0
876 then
877 say_color pass "# fixed $test_fixed known breakage(s)"
879 if test "$test_broken" != 0
880 then
881 say_color error "# still have $test_broken known breakage(s)"
882 msg="remaining $(($test_count-$test_broken)) test(s)"
883 else
884 msg="$test_count test(s)"
886 case "$test_failure" in
888 # Maybe print SKIP message
889 [ -z "$skip_all" ] || skip_all=" # SKIP $skip_all"
891 if test $test_external_has_tap -eq 0; then
892 say_color pass "# passed all $msg"
893 say "1..$test_count$skip_all"
896 test -d "$remove_trash" &&
897 cd "$(dirname "$remove_trash")" &&
898 rm -rf "$(basename "$remove_trash")"
900 exit 0 ;;
903 if test $test_external_has_tap -eq 0; then
904 say_color error "# failed $test_failure among $msg"
905 say "1..$test_count"
908 exit 1 ;;
910 esac
913 # Test the binaries we have just built. The tests are kept in
914 # t/ subdirectory and are run in 'trash directory' subdirectory.
915 if test -z "$TEST_DIRECTORY"
916 then
917 # We allow tests to override this, in case they want to run tests
918 # outside of t/, e.g. for running tests on the test library
919 # itself.
920 TEST_DIRECTORY=$(pwd)
922 GIT_BUILD_DIR="$TEST_DIRECTORY"/..
924 if test -n "$valgrind"
925 then
926 make_symlink () {
927 test -h "$2" &&
928 test "$1" = "$(readlink "$2")" || {
929 # be super paranoid
930 if mkdir "$2".lock
931 then
932 rm -f "$2" &&
933 ln -s "$1" "$2" &&
934 rm -r "$2".lock
935 else
936 while test -d "$2".lock
938 say "Waiting for lock on $2."
939 sleep 1
940 done
945 make_valgrind_symlink () {
946 # handle only executables, unless they are shell libraries that
947 # need to be in the exec-path. We will just use "#!" as a
948 # guess for a shell-script, since we have no idea what the user
949 # may have configured as the shell path.
950 test -x "$1" ||
951 test "#!" = "$(head -c 2 <"$1")" ||
952 return;
954 base=$(basename "$1")
955 symlink_target=$GIT_BUILD_DIR/$base
956 # do not override scripts
957 if test -x "$symlink_target" &&
958 test ! -d "$symlink_target" &&
959 test "#!" != "$(head -c 2 < "$symlink_target")"
960 then
961 symlink_target=../valgrind.sh
963 case "$base" in
964 *.sh|*.perl)
965 symlink_target=../unprocessed-script
966 esac
967 # create the link, or replace it if it is out of date
968 make_symlink "$symlink_target" "$GIT_VALGRIND/bin/$base" || exit
971 # override all git executables in TEST_DIRECTORY/..
972 GIT_VALGRIND=$TEST_DIRECTORY/valgrind
973 mkdir -p "$GIT_VALGRIND"/bin
974 for file in $GIT_BUILD_DIR/git* $GIT_BUILD_DIR/test-*
976 make_valgrind_symlink $file
977 done
978 # special-case the mergetools loadables
979 make_symlink "$GIT_BUILD_DIR"/mergetools "$GIT_VALGRIND/bin/mergetools"
980 OLDIFS=$IFS
981 IFS=:
982 for path in $PATH
984 ls "$path"/git-* 2> /dev/null |
985 while read file
987 make_valgrind_symlink "$file"
988 done
989 done
990 IFS=$OLDIFS
991 PATH=$GIT_VALGRIND/bin:$PATH
992 GIT_EXEC_PATH=$GIT_VALGRIND/bin
993 export GIT_VALGRIND
994 elif test -n "$GIT_TEST_INSTALLED" ; then
995 GIT_EXEC_PATH=$($GIT_TEST_INSTALLED/git --exec-path) ||
996 error "Cannot run git from $GIT_TEST_INSTALLED."
997 PATH=$GIT_TEST_INSTALLED:$GIT_BUILD_DIR:$PATH
998 GIT_EXEC_PATH=${GIT_TEST_EXEC_PATH:-$GIT_EXEC_PATH}
999 else # normal case, use ../bin-wrappers only unless $with_dashes:
1000 git_bin_dir="$GIT_BUILD_DIR/bin-wrappers"
1001 if ! test -x "$git_bin_dir/git" ; then
1002 if test -z "$with_dashes" ; then
1003 say "$git_bin_dir/git is not executable; using GIT_EXEC_PATH"
1005 with_dashes=t
1007 PATH="$git_bin_dir:$PATH"
1008 GIT_EXEC_PATH=$GIT_BUILD_DIR
1009 if test -n "$with_dashes" ; then
1010 PATH="$GIT_BUILD_DIR:$PATH"
1013 GIT_TEMPLATE_DIR="$GIT_BUILD_DIR"/templates/blt
1014 unset GIT_CONFIG
1015 GIT_CONFIG_NOSYSTEM=1
1016 GIT_ATTR_NOSYSTEM=1
1017 export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG_NOSYSTEM GIT_ATTR_NOSYSTEM
1019 . "$GIT_BUILD_DIR"/GIT-BUILD-OPTIONS
1021 if test -z "$GIT_TEST_CMP"
1022 then
1023 if test -n "$GIT_TEST_CMP_USE_COPIED_CONTEXT"
1024 then
1025 GIT_TEST_CMP="$DIFF -c"
1026 else
1027 GIT_TEST_CMP="$DIFF -u"
1031 GITPERLLIB="$GIT_BUILD_DIR"/perl/blib/lib:"$GIT_BUILD_DIR"/perl/blib/arch/auto/Git
1032 export GITPERLLIB
1033 test -d "$GIT_BUILD_DIR"/templates/blt || {
1034 error "You haven't built things yet, have you?"
1037 if test -z "$GIT_TEST_INSTALLED" && test -z "$NO_PYTHON"
1038 then
1039 GITPYTHONLIB="$GIT_BUILD_DIR/git_remote_helpers/build/lib"
1040 export GITPYTHONLIB
1041 test -d "$GIT_BUILD_DIR"/git_remote_helpers/build || {
1042 error "You haven't built git_remote_helpers yet, have you?"
1046 if ! test -x "$GIT_BUILD_DIR"/test-chmtime; then
1047 echo >&2 'You need to build test-chmtime:'
1048 echo >&2 'Run "make test-chmtime" in the source (toplevel) directory'
1049 exit 1
1052 # Test repository
1053 test="trash directory.$(basename "$0" .sh)"
1054 test -n "$root" && test="$root/$test"
1055 case "$test" in
1056 /*) TRASH_DIRECTORY="$test" ;;
1057 *) TRASH_DIRECTORY="$TEST_DIRECTORY/$test" ;;
1058 esac
1059 test ! -z "$debug" || remove_trash=$TRASH_DIRECTORY
1060 rm -fr "$test" || {
1061 GIT_EXIT_OK=t
1062 echo >&5 "FATAL: Cannot prepare test area"
1063 exit 1
1066 HOME="$TRASH_DIRECTORY"
1067 export HOME
1069 test_create_repo "$test"
1070 # Use -P to resolve symlinks in our working directory so that the cwd
1071 # in subprocesses like git equals our $PWD (for pathname comparisons).
1072 cd -P "$test" || exit 1
1074 this_test=${0##*/}
1075 this_test=${this_test%%-*}
1076 for skp in $GIT_SKIP_TESTS
1078 case "$this_test" in
1079 $skp)
1080 say_color skip >&3 "skipping test $this_test altogether"
1081 skip_all="skip all tests in $this_test"
1082 test_done
1083 esac
1084 done
1086 # Provide an implementation of the 'yes' utility
1087 yes () {
1088 if test $# = 0
1089 then
1091 else
1092 y="$*"
1095 while echo "$y"
1098 done
1101 # Fix some commands on Windows
1102 case $(uname -s) in
1103 *MINGW*)
1104 # Windows has its own (incompatible) sort and find
1105 sort () {
1106 /usr/bin/sort "$@"
1108 find () {
1109 /usr/bin/find "$@"
1111 sum () {
1112 md5sum "$@"
1114 # git sees Windows-style pwd
1115 pwd () {
1116 builtin pwd -W
1118 # no POSIX permissions
1119 # backslashes in pathspec are converted to '/'
1120 # exec does not inherit the PID
1121 test_set_prereq MINGW
1122 test_set_prereq SED_STRIPS_CR
1124 *CYGWIN*)
1125 test_set_prereq POSIXPERM
1126 test_set_prereq EXECKEEPSPID
1127 test_set_prereq NOT_MINGW
1128 test_set_prereq SED_STRIPS_CR
1131 test_set_prereq POSIXPERM
1132 test_set_prereq BSLASHPSPEC
1133 test_set_prereq EXECKEEPSPID
1134 test_set_prereq NOT_MINGW
1136 esac
1138 test -z "$NO_PERL" && test_set_prereq PERL
1139 test -z "$NO_PYTHON" && test_set_prereq PYTHON
1140 test -n "$USE_LIBPCRE" && test_set_prereq LIBPCRE
1141 test -z "$NO_GETTEXT" && test_set_prereq GETTEXT
1143 # Can we rely on git's output in the C locale?
1144 if test -n "$GETTEXT_POISON"
1145 then
1146 GIT_GETTEXT_POISON=YesPlease
1147 export GIT_GETTEXT_POISON
1148 test_set_prereq GETTEXT_POISON
1149 else
1150 test_set_prereq C_LOCALE_OUTPUT
1153 # Use this instead of test_cmp to compare files that contain expected and
1154 # actual output from git commands that can be translated. When running
1155 # under GETTEXT_POISON this pretends that the command produced expected
1156 # results.
1157 test_i18ncmp () {
1158 test -n "$GETTEXT_POISON" || test_cmp "$@"
1161 # Use this instead of "grep expected-string actual" to see if the
1162 # output from a git command that can be translated either contains an
1163 # expected string, or does not contain an unwanted one. When running
1164 # under GETTEXT_POISON this pretends that the command produced expected
1165 # results.
1166 test_i18ngrep () {
1167 if test -n "$GETTEXT_POISON"
1168 then
1169 : # pretend success
1170 elif test "x!" = "x$1"
1171 then
1172 shift
1173 ! grep "$@"
1174 else
1175 grep "$@"
1179 # test whether the filesystem supports symbolic links
1180 ln -s x y 2>/dev/null && test -h y 2>/dev/null && test_set_prereq SYMLINKS
1181 rm -f y
1183 # When the tests are run as root, permission tests will report that
1184 # things are writable when they shouldn't be.
1185 test -w / || test_set_prereq SANITY