Merge branch 'cb/diff-fname-optim' into maint
[git] / t / test-lib.sh
1 #!/bin/sh
2 #
3 # Copyright (c) 2005 Junio C Hamano
4 #
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.
9 #
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.
14 #
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/ .
17
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
23         ;;
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
31         ;;
32 esac
33
34 # Keep the original TERM for say_color
35 ORIGINAL_TERM=$TERM
36
37 # For repeatability, reset the environment to known value.
38 LANG=C
39 LC_ALL=C
40 PAGER=cat
41 TZ=UTC
42 TERM=dumb
43 export LANG LC_ALL PAGER TERM TZ
44 EDITOR=:
45 unset VISUAL
46 unset GIT_EDITOR
47 unset AUTHOR_DATE
48 unset AUTHOR_EMAIL
49 unset AUTHOR_NAME
50 unset COMMIT_AUTHOR_EMAIL
51 unset COMMIT_AUTHOR_NAME
52 unset EMAIL
53 unset GIT_ALTERNATE_OBJECT_DIRECTORIES
54 unset GIT_AUTHOR_DATE
55 GIT_AUTHOR_EMAIL=author@example.com
56 GIT_AUTHOR_NAME='A U Thor'
57 unset GIT_COMMITTER_DATE
58 GIT_COMMITTER_EMAIL=committer@example.com
59 GIT_COMMITTER_NAME='C O Mitter'
60 unset GIT_DIFF_OPTS
61 unset GIT_DIR
62 unset GIT_WORK_TREE
63 unset GIT_EXTERNAL_DIFF
64 unset GIT_INDEX_FILE
65 unset GIT_OBJECT_DIRECTORY
66 unset GIT_CEILING_DIRECTORIES
67 unset SHA1_FILE_DIRECTORIES
68 unset SHA1_FILE_DIRECTORY
69 unset GIT_NOTES_REF
70 unset GIT_NOTES_DISPLAY_REF
71 unset GIT_NOTES_REWRITE_REF
72 unset GIT_NOTES_REWRITE_MODE
73 GIT_MERGE_VERBOSITY=5
74 export GIT_MERGE_VERBOSITY
75 export GIT_AUTHOR_EMAIL GIT_AUTHOR_NAME
76 export GIT_COMMITTER_EMAIL GIT_COMMITTER_NAME
77 export EDITOR
78
79 # Protect ourselves from common misconfiguration to export
80 # CDPATH into the environment
81 unset CDPATH
82
83 unset GREP_OPTIONS
84
85 case $(echo $GIT_TRACE |tr "[A-Z]" "[a-z]") in
86         1|2|true)
87                 echo "* warning: Some tests will not work if GIT_TRACE" \
88                         "is set as to trace on STDERR ! *"
89                 echo "* warning: Please set GIT_TRACE to something" \
90                         "other than 1, 2 or true ! *"
91                 ;;
92 esac
93
94 # Convenience
95 #
96 # A regexp to match 5 and 40 hexdigits
97 _x05='[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
98 _x40="$_x05$_x05$_x05$_x05$_x05$_x05$_x05$_x05"
99
100 # Each test should start with something like this, after copyright notices:
101 #
102 # test_description='Description of this test...
103 # This test checks if command xyzzy does the right thing...
104 # '
105 # . ./test-lib.sh
106 [ "x$ORIGINAL_TERM" != "xdumb" ] && (
107                 TERM=$ORIGINAL_TERM &&
108                 export TERM &&
109                 [ -t 1 ] &&
110                 tput bold >/dev/null 2>&1 &&
111                 tput setaf 1 >/dev/null 2>&1 &&
112                 tput sgr0 >/dev/null 2>&1
113         ) &&
114         color=t
115
116 while test "$#" -ne 0
117 do
118         case "$1" in
119         -d|--d|--de|--deb|--debu|--debug)
120                 debug=t; shift ;;
121         -i|--i|--im|--imm|--imme|--immed|--immedi|--immedia|--immediat|--immediate)
122                 immediate=t; shift ;;
123         -l|--l|--lo|--lon|--long|--long-|--long-t|--long-te|--long-tes|--long-test|--long-tests)
124                 GIT_TEST_LONG=t; export GIT_TEST_LONG; shift ;;
125         -h|--h|--he|--hel|--help)
126                 help=t; shift ;;
127         -v|--v|--ve|--ver|--verb|--verbo|--verbos|--verbose)
128                 verbose=t; shift ;;
129         -q|--q|--qu|--qui|--quie|--quiet)
130                 # Ignore --quiet under a TAP::Harness. Saying how many tests
131                 # passed without the ok/not ok details is always an error.
132                 test -z "$HARNESS_ACTIVE" && quiet=t; shift ;;
133         --with-dashes)
134                 with_dashes=t; shift ;;
135         --no-color)
136                 color=; shift ;;
137         --va|--val|--valg|--valgr|--valgri|--valgrin|--valgrind)
138                 valgrind=t; verbose=t; shift ;;
139         --tee)
140                 shift ;; # was handled already
141         --root=*)
142                 root=$(expr "z$1" : 'z[^=]*=\(.*\)')
143                 shift ;;
144         *)
145                 echo "error: unknown test option '$1'" >&2; exit 1 ;;
146         esac
147 done
148
149 if test -n "$color"; then
150         say_color () {
151                 (
152                 TERM=$ORIGINAL_TERM
153                 export TERM
154                 case "$1" in
155                         error) tput bold; tput setaf 1;; # bold red
156                         skip)  tput bold; tput setaf 2;; # bold green
157                         pass)  tput setaf 2;;            # green
158                         info)  tput setaf 3;;            # brown
159                         *) test -n "$quiet" && return;;
160                 esac
161                 shift
162                 printf "%s" "$*"
163                 tput sgr0
164                 echo
165                 )
166         }
167 else
168         say_color() {
169                 test -z "$1" && test -n "$quiet" && return
170                 shift
171                 echo "$*"
172         }
173 fi
174
175 error () {
176         say_color error "error: $*"
177         GIT_EXIT_OK=t
178         exit 1
179 }
180
181 say () {
182         say_color info "$*"
183 }
184
185 test "${test_description}" != "" ||
186 error "Test script did not set test_description."
187
188 if test "$help" = "t"
189 then
190         echo "$test_description"
191         exit 0
192 fi
193
194 exec 5>&1
195 if test "$verbose" = "t"
196 then
197         exec 4>&2 3>&1
198 else
199         exec 4>/dev/null 3>/dev/null
200 fi
201
202 test_failure=0
203 test_count=0
204 test_fixed=0
205 test_broken=0
206 test_success=0
207
208 test_external_has_tap=0
209
210 die () {
211         code=$?
212         if test -n "$GIT_EXIT_OK"
213         then
214                 exit $code
215         else
216                 echo >&5 "FATAL: Unexpected exit with code $code"
217                 exit 1
218         fi
219 }
220
221 GIT_EXIT_OK=
222 trap 'die' EXIT
223
224 # The semantics of the editor variables are that of invoking
225 # sh -c "$EDITOR \"$@\"" files ...
226 #
227 # If our trash directory contains shell metacharacters, they will be
228 # interpreted if we just set $EDITOR directly, so do a little dance with
229 # environment variables to work around this.
230 #
231 # In particular, quoting isn't enough, as the path may contain the same quote
232 # that we're using.
233 test_set_editor () {
234         FAKE_EDITOR="$1"
235         export FAKE_EDITOR
236         EDITOR='"$FAKE_EDITOR"'
237         export EDITOR
238 }
239
240 test_decode_color () {
241         sed     -e 's/.\[1m/<WHITE>/g' \
242                 -e 's/.\[31m/<RED>/g' \
243                 -e 's/.\[32m/<GREEN>/g' \
244                 -e 's/.\[33m/<YELLOW>/g' \
245                 -e 's/.\[34m/<BLUE>/g' \
246                 -e 's/.\[35m/<MAGENTA>/g' \
247                 -e 's/.\[36m/<CYAN>/g' \
248                 -e 's/.\[m/<RESET>/g'
249 }
250
251 q_to_nul () {
252         perl -pe 'y/Q/\000/'
253 }
254
255 q_to_cr () {
256         tr Q '\015'
257 }
258
259 q_to_tab () {
260         tr Q '\011'
261 }
262
263 append_cr () {
264         sed -e 's/$/Q/' | tr Q '\015'
265 }
266
267 remove_cr () {
268         tr '\015' Q | sed -e 's/Q$//'
269 }
270
271 test_tick () {
272         if test -z "${test_tick+set}"
273         then
274                 test_tick=1112911993
275         else
276                 test_tick=$(($test_tick + 60))
277         fi
278         GIT_COMMITTER_DATE="$test_tick -0700"
279         GIT_AUTHOR_DATE="$test_tick -0700"
280         export GIT_COMMITTER_DATE GIT_AUTHOR_DATE
281 }
282
283 # Call test_commit with the arguments "<message> [<file> [<contents>]]"
284 #
285 # This will commit a file with the given contents and the given commit
286 # message.  It will also add a tag with <message> as name.
287 #
288 # Both <file> and <contents> default to <message>.
289
290 test_commit () {
291         file=${2:-"$1.t"}
292         echo "${3-$1}" > "$file" &&
293         git add "$file" &&
294         test_tick &&
295         git commit -m "$1" &&
296         git tag "$1"
297 }
298
299 # Call test_merge with the arguments "<message> <commit>", where <commit>
300 # can be a tag pointing to the commit-to-merge.
301
302 test_merge () {
303         test_tick &&
304         git merge -m "$1" "$2" &&
305         git tag "$1"
306 }
307
308 # This function helps systems where core.filemode=false is set.
309 # Use it instead of plain 'chmod +x' to set or unset the executable bit
310 # of a file in the working directory and add it to the index.
311
312 test_chmod () {
313         chmod "$@" &&
314         git update-index --add "--chmod=$@"
315 }
316
317 # Use test_set_prereq to tell that a particular prerequisite is available.
318 # The prerequisite can later be checked for in two ways:
319 #
320 # - Explicitly using test_have_prereq.
321 #
322 # - Implicitly by specifying the prerequisite tag in the calls to
323 #   test_expect_{success,failure,code}.
324 #
325 # The single parameter is the prerequisite tag (a simple word, in all
326 # capital letters by convention).
327
328 test_set_prereq () {
329         satisfied="$satisfied$1 "
330 }
331 satisfied=" "
332
333 test_have_prereq () {
334         # prerequisites can be concatenated with ','
335         save_IFS=$IFS
336         IFS=,
337         set -- $*
338         IFS=$save_IFS
339
340         total_prereq=0
341         ok_prereq=0
342         missing_prereq=
343
344         for prerequisite
345         do
346                 total_prereq=$(($total_prereq + 1))
347                 case $satisfied in
348                 *" $prerequisite "*)
349                         ok_prereq=$(($ok_prereq + 1))
350                         ;;
351                 *)
352                         # Keep a list of missing prerequisites
353                         if test -z "$missing_prereq"
354                         then
355                                 missing_prereq=$prerequisite
356                         else
357                                 missing_prereq="$prerequisite,$missing_prereq"
358                         fi
359                 esac
360         done
361
362         test $total_prereq = $ok_prereq
363 }
364
365 # You are not expected to call test_ok_ and test_failure_ directly, use
366 # the text_expect_* functions instead.
367
368 test_ok_ () {
369         test_success=$(($test_success + 1))
370         say_color "" "ok $test_count - $@"
371 }
372
373 test_failure_ () {
374         test_failure=$(($test_failure + 1))
375         say_color error "not ok - $test_count $1"
376         shift
377         echo "$@" | sed -e 's/^/#       /'
378         test "$immediate" = "" || { GIT_EXIT_OK=t; exit 1; }
379 }
380
381 test_known_broken_ok_ () {
382         test_fixed=$(($test_fixed+1))
383         say_color "" "ok $test_count - $@ # TODO known breakage"
384 }
385
386 test_known_broken_failure_ () {
387         test_broken=$(($test_broken+1))
388         say_color skip "not ok $test_count - $@ # TODO known breakage"
389 }
390
391 test_debug () {
392         test "$debug" = "" || eval "$1"
393 }
394
395 test_run_ () {
396         test_cleanup=:
397         eval >&3 2>&4 "$1"
398         eval_ret=$?
399         eval >&3 2>&4 "$test_cleanup"
400         if test "$verbose" = "t" && test -n "$HARNESS_ACTIVE"; then
401                 echo ""
402         fi
403         return 0
404 }
405
406 test_skip () {
407         test_count=$(($test_count+1))
408         to_skip=
409         for skp in $GIT_SKIP_TESTS
410         do
411                 case $this_test.$test_count in
412                 $skp)
413                         to_skip=t
414                         break
415                 esac
416         done
417         if test -z "$to_skip" && test -n "$prereq" &&
418            ! test_have_prereq "$prereq"
419         then
420                 to_skip=t
421         fi
422         case "$to_skip" in
423         t)
424                 of_prereq=
425                 if test "$missing_prereq" != "$prereq"
426                 then
427                         of_prereq=" of $prereq"
428                 fi
429
430                 say_color skip >&3 "skipping test: $@"
431                 say_color skip "ok $test_count # skip $1 (missing $missing_prereq${of_prereq})"
432                 : true
433                 ;;
434         *)
435                 false
436                 ;;
437         esac
438 }
439
440 test_expect_failure () {
441         test "$#" = 3 && { prereq=$1; shift; } || prereq=
442         test "$#" = 2 ||
443         error "bug in the test script: not 2 or 3 parameters to test-expect-failure"
444         if ! test_skip "$@"
445         then
446                 say >&3 "checking known breakage: $2"
447                 test_run_ "$2"
448                 if [ "$?" = 0 -a "$eval_ret" = 0 ]
449                 then
450                         test_known_broken_ok_ "$1"
451                 else
452                         test_known_broken_failure_ "$1"
453                 fi
454         fi
455         echo >&3 ""
456 }
457
458 test_expect_success () {
459         test "$#" = 3 && { prereq=$1; shift; } || prereq=
460         test "$#" = 2 ||
461         error "bug in the test script: not 2 or 3 parameters to test-expect-success"
462         if ! test_skip "$@"
463         then
464                 say >&3 "expecting success: $2"
465                 test_run_ "$2"
466                 if [ "$?" = 0 -a "$eval_ret" = 0 ]
467                 then
468                         test_ok_ "$1"
469                 else
470                         test_failure_ "$@"
471                 fi
472         fi
473         echo >&3 ""
474 }
475
476 test_expect_code () {
477         test "$#" = 4 && { prereq=$1; shift; } || prereq=
478         test "$#" = 3 ||
479         error "bug in the test script: not 3 or 4 parameters to test-expect-code"
480         if ! test_skip "$@"
481         then
482                 say >&3 "expecting exit code $1: $3"
483                 test_run_ "$3"
484                 if [ "$?" = 0 -a "$eval_ret" = "$1" ]
485                 then
486                         test_ok_ "$2"
487                 else
488                         test_failure_ "$@"
489                 fi
490         fi
491         echo >&3 ""
492 }
493
494 # test_external runs external test scripts that provide continuous
495 # test output about their progress, and succeeds/fails on
496 # zero/non-zero exit code.  It outputs the test output on stdout even
497 # in non-verbose mode, and announces the external script with "# run
498 # <n>: ..." before running it.  When providing relative paths, keep in
499 # mind that all scripts run in "trash directory".
500 # Usage: test_external description command arguments...
501 # Example: test_external 'Perl API' perl ../path/to/test.pl
502 test_external () {
503         test "$#" = 4 && { prereq=$1; shift; } || prereq=
504         test "$#" = 3 ||
505         error >&5 "bug in the test script: not 3 or 4 parameters to test_external"
506         descr="$1"
507         shift
508         if ! test_skip "$descr" "$@"
509         then
510                 # Announce the script to reduce confusion about the
511                 # test output that follows.
512                 say_color "" "# run $test_count: $descr ($*)"
513                 # Export TEST_DIRECTORY, TRASH_DIRECTORY and GIT_TEST_LONG
514                 # to be able to use them in script
515                 export TEST_DIRECTORY TRASH_DIRECTORY GIT_TEST_LONG
516                 # Run command; redirect its stderr to &4 as in
517                 # test_run_, but keep its stdout on our stdout even in
518                 # non-verbose mode.
519                 "$@" 2>&4
520                 if [ "$?" = 0 ]
521                 then
522                         if test $test_external_has_tap -eq 0; then
523                                 test_ok_ "$descr"
524                         else
525                                 say_color "" "# test_external test $descr was ok"
526                                 test_success=$(($test_success + 1))
527                         fi
528                 else
529                         if test $test_external_has_tap -eq 0; then
530                                 test_failure_ "$descr" "$@"
531                         else
532                                 say_color error "# test_external test $descr failed: $@"
533                                 test_failure=$(($test_failure + 1))
534                         fi
535                 fi
536         fi
537 }
538
539 # Like test_external, but in addition tests that the command generated
540 # no output on stderr.
541 test_external_without_stderr () {
542         # The temporary file has no (and must have no) security
543         # implications.
544         tmp="$TMPDIR"; if [ -z "$tmp" ]; then tmp=/tmp; fi
545         stderr="$tmp/git-external-stderr.$$.tmp"
546         test_external "$@" 4> "$stderr"
547         [ -f "$stderr" ] || error "Internal error: $stderr disappeared."
548         descr="no stderr: $1"
549         shift
550         say >&3 "# expecting no stderr from previous command"
551         if [ ! -s "$stderr" ]; then
552                 rm "$stderr"
553
554                 if test $test_external_has_tap -eq 0; then
555                         test_ok_ "$descr"
556                 else
557                         say_color "" "# test_external_without_stderr test $descr was ok"
558                         test_success=$(($test_success + 1))
559                 fi
560         else
561                 if [ "$verbose" = t ]; then
562                         output=`echo; echo "# Stderr is:"; cat "$stderr"`
563                 else
564                         output=
565                 fi
566                 # rm first in case test_failure exits.
567                 rm "$stderr"
568                 if test $test_external_has_tap -eq 0; then
569                         test_failure_ "$descr" "$@" "$output"
570                 else
571                         say_color error "# test_external_without_stderr test $descr failed: $@: $output"
572                         test_failure=$(($test_failure + 1))
573                 fi
574         fi
575 }
576
577 # debugging-friendly alternatives to "test [-f|-d|-e]"
578 # The commands test the existence or non-existence of $1. $2 can be
579 # given to provide a more precise diagnosis.
580 test_path_is_file () {
581         if ! [ -f "$1" ]
582         then
583                 echo "File $1 doesn't exist. $*"
584                 false
585         fi
586 }
587
588 test_path_is_dir () {
589         if ! [ -d "$1" ]
590         then
591                 echo "Directory $1 doesn't exist. $*"
592                 false
593         fi
594 }
595
596 test_path_is_missing () {
597         if [ -e "$1" ]
598         then
599                 echo "Path exists:"
600                 ls -ld "$1"
601                 if [ $# -ge 1 ]; then
602                         echo "$*"
603                 fi
604                 false
605         fi
606 }
607
608
609 # This is not among top-level (test_expect_success | test_expect_failure)
610 # but is a prefix that can be used in the test script, like:
611 #
612 #       test_expect_success 'complain and die' '
613 #           do something &&
614 #           do something else &&
615 #           test_must_fail git checkout ../outerspace
616 #       '
617 #
618 # Writing this as "! git checkout ../outerspace" is wrong, because
619 # the failure could be due to a segv.  We want a controlled failure.
620
621 test_must_fail () {
622         "$@"
623         exit_code=$?
624         if test $exit_code = 0; then
625                 echo >&2 "test_must_fail: command succeeded: $*"
626                 return 1
627         elif test $exit_code -gt 129 -a $exit_code -le 192; then
628                 echo >&2 "test_must_fail: died by signal: $*"
629                 return 1
630         elif test $exit_code = 127; then
631                 echo >&2 "test_must_fail: command not found: $*"
632                 return 1
633         fi
634         return 0
635 }
636
637 # Similar to test_must_fail, but tolerates success, too.  This is
638 # meant to be used in contexts like:
639 #
640 #       test_expect_success 'some command works without configuration' '
641 #               test_might_fail git config --unset all.configuration &&
642 #               do something
643 #       '
644 #
645 # Writing "git config --unset all.configuration || :" would be wrong,
646 # because we want to notice if it fails due to segv.
647
648 test_might_fail () {
649         "$@"
650         exit_code=$?
651         if test $exit_code -gt 129 -a $exit_code -le 192; then
652                 echo >&2 "test_might_fail: died by signal: $*"
653                 return 1
654         elif test $exit_code = 127; then
655                 echo >&2 "test_might_fail: command not found: $*"
656                 return 1
657         fi
658         return 0
659 }
660
661 # test_cmp is a helper function to compare actual and expected output.
662 # You can use it like:
663 #
664 #       test_expect_success 'foo works' '
665 #               echo expected >expected &&
666 #               foo >actual &&
667 #               test_cmp expected actual
668 #       '
669 #
670 # This could be written as either "cmp" or "diff -u", but:
671 # - cmp's output is not nearly as easy to read as diff -u
672 # - not all diff versions understand "-u"
673
674 test_cmp() {
675         $GIT_TEST_CMP "$@"
676 }
677
678 # This function can be used to schedule some commands to be run
679 # unconditionally at the end of the test to restore sanity:
680 #
681 #       test_expect_success 'test core.capslock' '
682 #               git config core.capslock true &&
683 #               test_when_finished "git config --unset core.capslock" &&
684 #               hello world
685 #       '
686 #
687 # That would be roughly equivalent to
688 #
689 #       test_expect_success 'test core.capslock' '
690 #               git config core.capslock true &&
691 #               hello world
692 #               git config --unset core.capslock
693 #       '
694 #
695 # except that the greeting and config --unset must both succeed for
696 # the test to pass.
697
698 test_when_finished () {
699         test_cleanup="{ $*
700                 } && (exit \"\$eval_ret\"); eval_ret=\$?; $test_cleanup"
701 }
702
703 # Most tests can use the created repository, but some may need to create more.
704 # Usage: test_create_repo <directory>
705 test_create_repo () {
706         test "$#" = 1 ||
707         error "bug in the test script: not 1 parameter to test-create-repo"
708         repo="$1"
709         mkdir -p "$repo"
710         (
711                 cd "$repo" || error "Cannot setup test environment"
712                 "$GIT_EXEC_PATH/git-init" "--template=$GIT_BUILD_DIR/templates/blt/" >&3 2>&4 ||
713                 error "cannot run git init -- have you built things yet?"
714                 mv .git/hooks .git/hooks-disabled
715         ) || exit
716 }
717
718 test_done () {
719         GIT_EXIT_OK=t
720
721         if test -z "$HARNESS_ACTIVE"; then
722                 test_results_dir="$TEST_DIRECTORY/test-results"
723                 mkdir -p "$test_results_dir"
724                 test_results_path="$test_results_dir/${0%.sh}-$$.counts"
725
726                 echo "total $test_count" >> $test_results_path
727                 echo "success $test_success" >> $test_results_path
728                 echo "fixed $test_fixed" >> $test_results_path
729                 echo "broken $test_broken" >> $test_results_path
730                 echo "failed $test_failure" >> $test_results_path
731                 echo "" >> $test_results_path
732         fi
733
734         if test "$test_fixed" != 0
735         then
736                 say_color pass "# fixed $test_fixed known breakage(s)"
737         fi
738         if test "$test_broken" != 0
739         then
740                 say_color error "# still have $test_broken known breakage(s)"
741                 msg="remaining $(($test_count-$test_broken)) test(s)"
742         else
743                 msg="$test_count test(s)"
744         fi
745         case "$test_failure" in
746         0)
747                 # Maybe print SKIP message
748                 [ -z "$skip_all" ] || skip_all=" # SKIP $skip_all"
749
750                 if test $test_external_has_tap -eq 0; then
751                         say_color pass "# passed all $msg"
752                         say "1..$test_count$skip_all"
753                 fi
754
755                 test -d "$remove_trash" &&
756                 cd "$(dirname "$remove_trash")" &&
757                 rm -rf "$(basename "$remove_trash")"
758
759                 exit 0 ;;
760
761         *)
762                 if test $test_external_has_tap -eq 0; then
763                         say_color error "# failed $test_failure among $msg"
764                         say "1..$test_count"
765                 fi
766
767                 exit 1 ;;
768
769         esac
770 }
771
772 # Test the binaries we have just built.  The tests are kept in
773 # t/ subdirectory and are run in 'trash directory' subdirectory.
774 if test -z "$TEST_DIRECTORY"
775 then
776         # We allow tests to override this, in case they want to run tests
777         # outside of t/, e.g. for running tests on the test library
778         # itself.
779         TEST_DIRECTORY=$(pwd)
780 fi
781 GIT_BUILD_DIR="$TEST_DIRECTORY"/..
782
783 if test -n "$valgrind"
784 then
785         make_symlink () {
786                 test -h "$2" &&
787                 test "$1" = "$(readlink "$2")" || {
788                         # be super paranoid
789                         if mkdir "$2".lock
790                         then
791                                 rm -f "$2" &&
792                                 ln -s "$1" "$2" &&
793                                 rm -r "$2".lock
794                         else
795                                 while test -d "$2".lock
796                                 do
797                                         say "Waiting for lock on $2."
798                                         sleep 1
799                                 done
800                         fi
801                 }
802         }
803
804         make_valgrind_symlink () {
805                 # handle only executables
806                 test -x "$1" || return
807
808                 base=$(basename "$1")
809                 symlink_target=$GIT_BUILD_DIR/$base
810                 # do not override scripts
811                 if test -x "$symlink_target" &&
812                     test ! -d "$symlink_target" &&
813                     test "#!" != "$(head -c 2 < "$symlink_target")"
814                 then
815                         symlink_target=../valgrind.sh
816                 fi
817                 case "$base" in
818                 *.sh|*.perl)
819                         symlink_target=../unprocessed-script
820                 esac
821                 # create the link, or replace it if it is out of date
822                 make_symlink "$symlink_target" "$GIT_VALGRIND/bin/$base" || exit
823         }
824
825         # override all git executables in TEST_DIRECTORY/..
826         GIT_VALGRIND=$TEST_DIRECTORY/valgrind
827         mkdir -p "$GIT_VALGRIND"/bin
828         for file in $GIT_BUILD_DIR/git* $GIT_BUILD_DIR/test-*
829         do
830                 make_valgrind_symlink $file
831         done
832         OLDIFS=$IFS
833         IFS=:
834         for path in $PATH
835         do
836                 ls "$path"/git-* 2> /dev/null |
837                 while read file
838                 do
839                         make_valgrind_symlink "$file"
840                 done
841         done
842         IFS=$OLDIFS
843         PATH=$GIT_VALGRIND/bin:$PATH
844         GIT_EXEC_PATH=$GIT_VALGRIND/bin
845         export GIT_VALGRIND
846 elif test -n "$GIT_TEST_INSTALLED" ; then
847         GIT_EXEC_PATH=$($GIT_TEST_INSTALLED/git --exec-path)  ||
848         error "Cannot run git from $GIT_TEST_INSTALLED."
849         PATH=$GIT_TEST_INSTALLED:$GIT_BUILD_DIR:$PATH
850         GIT_EXEC_PATH=${GIT_TEST_EXEC_PATH:-$GIT_EXEC_PATH}
851 else # normal case, use ../bin-wrappers only unless $with_dashes:
852         git_bin_dir="$GIT_BUILD_DIR/bin-wrappers"
853         if ! test -x "$git_bin_dir/git" ; then
854                 if test -z "$with_dashes" ; then
855                         say "$git_bin_dir/git is not executable; using GIT_EXEC_PATH"
856                 fi
857                 with_dashes=t
858         fi
859         PATH="$git_bin_dir:$PATH"
860         GIT_EXEC_PATH=$GIT_BUILD_DIR
861         if test -n "$with_dashes" ; then
862                 PATH="$GIT_BUILD_DIR:$PATH"
863         fi
864 fi
865 GIT_TEMPLATE_DIR="$GIT_BUILD_DIR"/templates/blt
866 unset GIT_CONFIG
867 GIT_CONFIG_NOSYSTEM=1
868 GIT_CONFIG_NOGLOBAL=1
869 export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG_NOSYSTEM GIT_CONFIG_NOGLOBAL
870
871 . "$GIT_BUILD_DIR"/GIT-BUILD-OPTIONS
872
873 if test -z "$GIT_TEST_CMP"
874 then
875         if test -n "$GIT_TEST_CMP_USE_COPIED_CONTEXT"
876         then
877                 GIT_TEST_CMP="$DIFF -c"
878         else
879                 GIT_TEST_CMP="$DIFF -u"
880         fi
881 fi
882
883 GITPERLLIB="$GIT_BUILD_DIR"/perl/blib/lib:"$GIT_BUILD_DIR"/perl/blib/arch/auto/Git
884 export GITPERLLIB
885 test -d "$GIT_BUILD_DIR"/templates/blt || {
886         error "You haven't built things yet, have you?"
887 }
888
889 if test -z "$GIT_TEST_INSTALLED" && test -z "$NO_PYTHON"
890 then
891         GITPYTHONLIB="$GIT_BUILD_DIR/git_remote_helpers/build/lib"
892         export GITPYTHONLIB
893         test -d "$GIT_BUILD_DIR"/git_remote_helpers/build || {
894                 error "You haven't built git_remote_helpers yet, have you?"
895         }
896 fi
897
898 if ! test -x "$GIT_BUILD_DIR"/test-chmtime; then
899         echo >&2 'You need to build test-chmtime:'
900         echo >&2 'Run "make test-chmtime" in the source (toplevel) directory'
901         exit 1
902 fi
903
904 # Test repository
905 test="trash directory.$(basename "$0" .sh)"
906 test -n "$root" && test="$root/$test"
907 case "$test" in
908 /*) TRASH_DIRECTORY="$test" ;;
909  *) TRASH_DIRECTORY="$TEST_DIRECTORY/$test" ;;
910 esac
911 test ! -z "$debug" || remove_trash=$TRASH_DIRECTORY
912 rm -fr "$test" || {
913         GIT_EXIT_OK=t
914         echo >&5 "FATAL: Cannot prepare test area"
915         exit 1
916 }
917
918 test_create_repo "$test"
919 # Use -P to resolve symlinks in our working directory so that the cwd
920 # in subprocesses like git equals our $PWD (for pathname comparisons).
921 cd -P "$test" || exit 1
922
923 HOME=$(pwd)
924 export HOME
925
926 this_test=${0##*/}
927 this_test=${this_test%%-*}
928 for skp in $GIT_SKIP_TESTS
929 do
930         case "$this_test" in
931         $skp)
932                 say_color skip >&3 "skipping test $this_test altogether"
933                 skip_all="skip all tests in $this_test"
934                 test_done
935         esac
936 done
937
938 # Provide an implementation of the 'yes' utility
939 yes () {
940         if test $# = 0
941         then
942                 y=y
943         else
944                 y="$*"
945         fi
946
947         while echo "$y"
948         do
949                 :
950         done
951 }
952
953 # Fix some commands on Windows
954 case $(uname -s) in
955 *MINGW*)
956         # Windows has its own (incompatible) sort and find
957         sort () {
958                 /usr/bin/sort "$@"
959         }
960         find () {
961                 /usr/bin/find "$@"
962         }
963         sum () {
964                 md5sum "$@"
965         }
966         # git sees Windows-style pwd
967         pwd () {
968                 builtin pwd -W
969         }
970         # no POSIX permissions
971         # backslashes in pathspec are converted to '/'
972         # exec does not inherit the PID
973         ;;
974 *)
975         test_set_prereq POSIXPERM
976         test_set_prereq BSLASHPSPEC
977         test_set_prereq EXECKEEPSPID
978         ;;
979 esac
980
981 test -z "$NO_PERL" && test_set_prereq PERL
982 test -z "$NO_PYTHON" && test_set_prereq PYTHON
983
984 # test whether the filesystem supports symbolic links
985 ln -s x y 2>/dev/null && test -h y 2>/dev/null && test_set_prereq SYMLINKS
986 rm -f y
987
988 # When the tests are run as root, permission tests will report that
989 # things are writable when they shouldn't be.
990 test -w / || test_set_prereq SANITY