merge: use editor by default in interactive sessions
[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 EMAIL
47 unset $(perl -e '
48         my @env = keys %ENV;
49         my $ok = join("|", qw(
50                 TRACE
51                 DEBUG
52                 USE_LOOKUP
53                 TEST
54                 .*_TEST
55                 PROVE
56                 VALGRIND
57         ));
58         my @vars = grep(/^GIT_/ && !/^GIT_($ok)/o, @env);
59         print join("\n", @vars);
60 ')
61 GIT_AUTHOR_EMAIL=author@example.com
62 GIT_AUTHOR_NAME='A U Thor'
63 GIT_COMMITTER_EMAIL=committer@example.com
64 GIT_COMMITTER_NAME='C O Mitter'
65 GIT_MERGE_VERBOSITY=5
66 GIT_MERGE_AUTOEDIT=no
67 export GIT_MERGE_VERBOSITY GIT_MERGE_AUTOEDIT
68 export GIT_AUTHOR_EMAIL GIT_AUTHOR_NAME
69 export GIT_COMMITTER_EMAIL GIT_COMMITTER_NAME
70 export EDITOR
71
72 # Protect ourselves from common misconfiguration to export
73 # CDPATH into the environment
74 unset CDPATH
75
76 unset GREP_OPTIONS
77
78 case $(echo $GIT_TRACE |tr "[A-Z]" "[a-z]") in
79         1|2|true)
80                 echo "* warning: Some tests will not work if GIT_TRACE" \
81                         "is set as to trace on STDERR ! *"
82                 echo "* warning: Please set GIT_TRACE to something" \
83                         "other than 1, 2 or true ! *"
84                 ;;
85 esac
86
87 # Convenience
88 #
89 # A regexp to match 5 and 40 hexdigits
90 _x05='[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
91 _x40="$_x05$_x05$_x05$_x05$_x05$_x05$_x05$_x05"
92
93 # Zero SHA-1
94 _z40=0000000000000000000000000000000000000000
95
96 # Line feed
97 LF='
98 '
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         awk '
242                 function name(n) {
243                         if (n == 0) return "RESET";
244                         if (n == 1) return "BOLD";
245                         if (n == 30) return "BLACK";
246                         if (n == 31) return "RED";
247                         if (n == 32) return "GREEN";
248                         if (n == 33) return "YELLOW";
249                         if (n == 34) return "BLUE";
250                         if (n == 35) return "MAGENTA";
251                         if (n == 36) return "CYAN";
252                         if (n == 37) return "WHITE";
253                         if (n == 40) return "BLACK";
254                         if (n == 41) return "BRED";
255                         if (n == 42) return "BGREEN";
256                         if (n == 43) return "BYELLOW";
257                         if (n == 44) return "BBLUE";
258                         if (n == 45) return "BMAGENTA";
259                         if (n == 46) return "BCYAN";
260                         if (n == 47) return "BWHITE";
261                 }
262                 {
263                         while (match($0, /\033\[[0-9;]*m/) != 0) {
264                                 printf "%s<", substr($0, 1, RSTART-1);
265                                 codes = substr($0, RSTART+2, RLENGTH-3);
266                                 if (length(codes) == 0)
267                                         printf "%s", name(0)
268                                 else {
269                                         n = split(codes, ary, ";");
270                                         sep = "";
271                                         for (i = 1; i <= n; i++) {
272                                                 printf "%s%s", sep, name(ary[i]);
273                                                 sep = ";"
274                                         }
275                                 }
276                                 printf ">";
277                                 $0 = substr($0, RSTART + RLENGTH, length($0) - RSTART - RLENGTH + 1);
278                         }
279                         print
280                 }
281         '
282 }
283
284 nul_to_q () {
285         perl -pe 'y/\000/Q/'
286 }
287
288 q_to_nul () {
289         perl -pe 'y/Q/\000/'
290 }
291
292 q_to_cr () {
293         tr Q '\015'
294 }
295
296 q_to_tab () {
297         tr Q '\011'
298 }
299
300 append_cr () {
301         sed -e 's/$/Q/' | tr Q '\015'
302 }
303
304 remove_cr () {
305         tr '\015' Q | sed -e 's/Q$//'
306 }
307
308 # In some bourne shell implementations, the "unset" builtin returns
309 # nonzero status when a variable to be unset was not set in the first
310 # place.
311 #
312 # Use sane_unset when that should not be considered an error.
313
314 sane_unset () {
315         unset "$@"
316         return 0
317 }
318
319 test_tick () {
320         if test -z "${test_tick+set}"
321         then
322                 test_tick=1112911993
323         else
324                 test_tick=$(($test_tick + 60))
325         fi
326         GIT_COMMITTER_DATE="$test_tick -0700"
327         GIT_AUTHOR_DATE="$test_tick -0700"
328         export GIT_COMMITTER_DATE GIT_AUTHOR_DATE
329 }
330
331 # Call test_commit with the arguments "<message> [<file> [<contents>]]"
332 #
333 # This will commit a file with the given contents and the given commit
334 # message.  It will also add a tag with <message> as name.
335 #
336 # Both <file> and <contents> default to <message>.
337
338 test_commit () {
339         file=${2:-"$1.t"}
340         echo "${3-$1}" > "$file" &&
341         git add "$file" &&
342         test_tick &&
343         git commit -m "$1" &&
344         git tag "$1"
345 }
346
347 # Call test_merge with the arguments "<message> <commit>", where <commit>
348 # can be a tag pointing to the commit-to-merge.
349
350 test_merge () {
351         test_tick &&
352         git merge -m "$1" "$2" &&
353         git tag "$1"
354 }
355
356 # This function helps systems where core.filemode=false is set.
357 # Use it instead of plain 'chmod +x' to set or unset the executable bit
358 # of a file in the working directory and add it to the index.
359
360 test_chmod () {
361         chmod "$@" &&
362         git update-index --add "--chmod=$@"
363 }
364
365 # Unset a configuration variable, but don't fail if it doesn't exist.
366 test_unconfig () {
367         git config --unset-all "$@"
368         config_status=$?
369         case "$config_status" in
370         5) # ok, nothing to unset
371                 config_status=0
372                 ;;
373         esac
374         return $config_status
375 }
376
377 # Set git config, automatically unsetting it after the test is over.
378 test_config () {
379         test_when_finished "test_unconfig '$1'" &&
380         git config "$@"
381 }
382
383 # Use test_set_prereq to tell that a particular prerequisite is available.
384 # The prerequisite can later be checked for in two ways:
385 #
386 # - Explicitly using test_have_prereq.
387 #
388 # - Implicitly by specifying the prerequisite tag in the calls to
389 #   test_expect_{success,failure,code}.
390 #
391 # The single parameter is the prerequisite tag (a simple word, in all
392 # capital letters by convention).
393
394 test_set_prereq () {
395         satisfied="$satisfied$1 "
396 }
397 satisfied=" "
398
399 test_have_prereq () {
400         # prerequisites can be concatenated with ','
401         save_IFS=$IFS
402         IFS=,
403         set -- $*
404         IFS=$save_IFS
405
406         total_prereq=0
407         ok_prereq=0
408         missing_prereq=
409
410         for prerequisite
411         do
412                 total_prereq=$(($total_prereq + 1))
413                 case $satisfied in
414                 *" $prerequisite "*)
415                         ok_prereq=$(($ok_prereq + 1))
416                         ;;
417                 *)
418                         # Keep a list of missing prerequisites
419                         if test -z "$missing_prereq"
420                         then
421                                 missing_prereq=$prerequisite
422                         else
423                                 missing_prereq="$prerequisite,$missing_prereq"
424                         fi
425                 esac
426         done
427
428         test $total_prereq = $ok_prereq
429 }
430
431 test_declared_prereq () {
432         case ",$test_prereq," in
433         *,$1,*)
434                 return 0
435                 ;;
436         esac
437         return 1
438 }
439
440 # You are not expected to call test_ok_ and test_failure_ directly, use
441 # the text_expect_* functions instead.
442
443 test_ok_ () {
444         test_success=$(($test_success + 1))
445         say_color "" "ok $test_count - $@"
446 }
447
448 test_failure_ () {
449         test_failure=$(($test_failure + 1))
450         say_color error "not ok - $test_count $1"
451         shift
452         echo "$@" | sed -e 's/^/#       /'
453         test "$immediate" = "" || { GIT_EXIT_OK=t; exit 1; }
454 }
455
456 test_known_broken_ok_ () {
457         test_fixed=$(($test_fixed+1))
458         say_color "" "ok $test_count - $@ # TODO known breakage"
459 }
460
461 test_known_broken_failure_ () {
462         test_broken=$(($test_broken+1))
463         say_color skip "not ok $test_count - $@ # TODO known breakage"
464 }
465
466 test_debug () {
467         test "$debug" = "" || eval "$1"
468 }
469
470 test_eval_ () {
471         # This is a separate function because some tests use
472         # "return" to end a test_expect_success block early.
473         eval >&3 2>&4 "$*"
474 }
475
476 test_run_ () {
477         test_cleanup=:
478         expecting_failure=$2
479         test_eval_ "$1"
480         eval_ret=$?
481
482         if test -z "$immediate" || test $eval_ret = 0 || test -n "$expecting_failure"
483         then
484                 test_eval_ "$test_cleanup"
485         fi
486         if test "$verbose" = "t" && test -n "$HARNESS_ACTIVE"; then
487                 echo ""
488         fi
489         return "$eval_ret"
490 }
491
492 test_skip () {
493         test_count=$(($test_count+1))
494         to_skip=
495         for skp in $GIT_SKIP_TESTS
496         do
497                 case $this_test.$test_count in
498                 $skp)
499                         to_skip=t
500                         break
501                 esac
502         done
503         if test -z "$to_skip" && test -n "$test_prereq" &&
504            ! test_have_prereq "$test_prereq"
505         then
506                 to_skip=t
507         fi
508         case "$to_skip" in
509         t)
510                 of_prereq=
511                 if test "$missing_prereq" != "$test_prereq"
512                 then
513                         of_prereq=" of $test_prereq"
514                 fi
515
516                 say_color skip >&3 "skipping test: $@"
517                 say_color skip "ok $test_count # skip $1 (missing $missing_prereq${of_prereq})"
518                 : true
519                 ;;
520         *)
521                 false
522                 ;;
523         esac
524 }
525
526 test_expect_failure () {
527         test "$#" = 3 && { test_prereq=$1; shift; } || test_prereq=
528         test "$#" = 2 ||
529         error "bug in the test script: not 2 or 3 parameters to test-expect-failure"
530         export test_prereq
531         if ! test_skip "$@"
532         then
533                 say >&3 "checking known breakage: $2"
534                 if test_run_ "$2" expecting_failure
535                 then
536                         test_known_broken_ok_ "$1"
537                 else
538                         test_known_broken_failure_ "$1"
539                 fi
540         fi
541         echo >&3 ""
542 }
543
544 test_expect_success () {
545         test "$#" = 3 && { test_prereq=$1; shift; } || test_prereq=
546         test "$#" = 2 ||
547         error "bug in the test script: not 2 or 3 parameters to test-expect-success"
548         export test_prereq
549         if ! test_skip "$@"
550         then
551                 say >&3 "expecting success: $2"
552                 if test_run_ "$2"
553                 then
554                         test_ok_ "$1"
555                 else
556                         test_failure_ "$@"
557                 fi
558         fi
559         echo >&3 ""
560 }
561
562 # test_external runs external test scripts that provide continuous
563 # test output about their progress, and succeeds/fails on
564 # zero/non-zero exit code.  It outputs the test output on stdout even
565 # in non-verbose mode, and announces the external script with "# run
566 # <n>: ..." before running it.  When providing relative paths, keep in
567 # mind that all scripts run in "trash directory".
568 # Usage: test_external description command arguments...
569 # Example: test_external 'Perl API' perl ../path/to/test.pl
570 test_external () {
571         test "$#" = 4 && { test_prereq=$1; shift; } || test_prereq=
572         test "$#" = 3 ||
573         error >&5 "bug in the test script: not 3 or 4 parameters to test_external"
574         descr="$1"
575         shift
576         export test_prereq
577         if ! test_skip "$descr" "$@"
578         then
579                 # Announce the script to reduce confusion about the
580                 # test output that follows.
581                 say_color "" "# run $test_count: $descr ($*)"
582                 # Export TEST_DIRECTORY, TRASH_DIRECTORY and GIT_TEST_LONG
583                 # to be able to use them in script
584                 export TEST_DIRECTORY TRASH_DIRECTORY GIT_TEST_LONG
585                 # Run command; redirect its stderr to &4 as in
586                 # test_run_, but keep its stdout on our stdout even in
587                 # non-verbose mode.
588                 "$@" 2>&4
589                 if [ "$?" = 0 ]
590                 then
591                         if test $test_external_has_tap -eq 0; then
592                                 test_ok_ "$descr"
593                         else
594                                 say_color "" "# test_external test $descr was ok"
595                                 test_success=$(($test_success + 1))
596                         fi
597                 else
598                         if test $test_external_has_tap -eq 0; then
599                                 test_failure_ "$descr" "$@"
600                         else
601                                 say_color error "# test_external test $descr failed: $@"
602                                 test_failure=$(($test_failure + 1))
603                         fi
604                 fi
605         fi
606 }
607
608 # Like test_external, but in addition tests that the command generated
609 # no output on stderr.
610 test_external_without_stderr () {
611         # The temporary file has no (and must have no) security
612         # implications.
613         tmp=${TMPDIR:-/tmp}
614         stderr="$tmp/git-external-stderr.$$.tmp"
615         test_external "$@" 4> "$stderr"
616         [ -f "$stderr" ] || error "Internal error: $stderr disappeared."
617         descr="no stderr: $1"
618         shift
619         say >&3 "# expecting no stderr from previous command"
620         if [ ! -s "$stderr" ]; then
621                 rm "$stderr"
622
623                 if test $test_external_has_tap -eq 0; then
624                         test_ok_ "$descr"
625                 else
626                         say_color "" "# test_external_without_stderr test $descr was ok"
627                         test_success=$(($test_success + 1))
628                 fi
629         else
630                 if [ "$verbose" = t ]; then
631                         output=`echo; echo "# Stderr is:"; cat "$stderr"`
632                 else
633                         output=
634                 fi
635                 # rm first in case test_failure exits.
636                 rm "$stderr"
637                 if test $test_external_has_tap -eq 0; then
638                         test_failure_ "$descr" "$@" "$output"
639                 else
640                         say_color error "# test_external_without_stderr test $descr failed: $@: $output"
641                         test_failure=$(($test_failure + 1))
642                 fi
643         fi
644 }
645
646 # debugging-friendly alternatives to "test [-f|-d|-e]"
647 # The commands test the existence or non-existence of $1. $2 can be
648 # given to provide a more precise diagnosis.
649 test_path_is_file () {
650         if ! [ -f "$1" ]
651         then
652                 echo "File $1 doesn't exist. $*"
653                 false
654         fi
655 }
656
657 test_path_is_dir () {
658         if ! [ -d "$1" ]
659         then
660                 echo "Directory $1 doesn't exist. $*"
661                 false
662         fi
663 }
664
665 test_path_is_missing () {
666         if [ -e "$1" ]
667         then
668                 echo "Path exists:"
669                 ls -ld "$1"
670                 if [ $# -ge 1 ]; then
671                         echo "$*"
672                 fi
673                 false
674         fi
675 }
676
677 # test_line_count checks that a file has the number of lines it
678 # ought to. For example:
679 #
680 #       test_expect_success 'produce exactly one line of output' '
681 #               do something >output &&
682 #               test_line_count = 1 output
683 #       '
684 #
685 # is like "test $(wc -l <output) = 1" except that it passes the
686 # output through when the number of lines is wrong.
687
688 test_line_count () {
689         if test $# != 3
690         then
691                 error "bug in the test script: not 3 parameters to test_line_count"
692         elif ! test $(wc -l <"$3") "$1" "$2"
693         then
694                 echo "test_line_count: line count for $3 !$1 $2"
695                 cat "$3"
696                 return 1
697         fi
698 }
699
700 # This is not among top-level (test_expect_success | test_expect_failure)
701 # but is a prefix that can be used in the test script, like:
702 #
703 #       test_expect_success 'complain and die' '
704 #           do something &&
705 #           do something else &&
706 #           test_must_fail git checkout ../outerspace
707 #       '
708 #
709 # Writing this as "! git checkout ../outerspace" is wrong, because
710 # the failure could be due to a segv.  We want a controlled failure.
711
712 test_must_fail () {
713         "$@"
714         exit_code=$?
715         if test $exit_code = 0; then
716                 echo >&2 "test_must_fail: command succeeded: $*"
717                 return 1
718         elif test $exit_code -gt 129 -a $exit_code -le 192; then
719                 echo >&2 "test_must_fail: died by signal: $*"
720                 return 1
721         elif test $exit_code = 127; then
722                 echo >&2 "test_must_fail: command not found: $*"
723                 return 1
724         fi
725         return 0
726 }
727
728 # Similar to test_must_fail, but tolerates success, too.  This is
729 # meant to be used in contexts like:
730 #
731 #       test_expect_success 'some command works without configuration' '
732 #               test_might_fail git config --unset all.configuration &&
733 #               do something
734 #       '
735 #
736 # Writing "git config --unset all.configuration || :" would be wrong,
737 # because we want to notice if it fails due to segv.
738
739 test_might_fail () {
740         "$@"
741         exit_code=$?
742         if test $exit_code -gt 129 -a $exit_code -le 192; then
743                 echo >&2 "test_might_fail: died by signal: $*"
744                 return 1
745         elif test $exit_code = 127; then
746                 echo >&2 "test_might_fail: command not found: $*"
747                 return 1
748         fi
749         return 0
750 }
751
752 # Similar to test_must_fail and test_might_fail, but check that a
753 # given command exited with a given exit code. Meant to be used as:
754 #
755 #       test_expect_success 'Merge with d/f conflicts' '
756 #               test_expect_code 1 git merge "merge msg" B master
757 #       '
758
759 test_expect_code () {
760         want_code=$1
761         shift
762         "$@"
763         exit_code=$?
764         if test $exit_code = $want_code
765         then
766                 return 0
767         fi
768
769         echo >&2 "test_expect_code: command exited with $exit_code, we wanted $want_code $*"
770         return 1
771 }
772
773 # test_cmp is a helper function to compare actual and expected output.
774 # You can use it like:
775 #
776 #       test_expect_success 'foo works' '
777 #               echo expected >expected &&
778 #               foo >actual &&
779 #               test_cmp expected actual
780 #       '
781 #
782 # This could be written as either "cmp" or "diff -u", but:
783 # - cmp's output is not nearly as easy to read as diff -u
784 # - not all diff versions understand "-u"
785
786 test_cmp() {
787         $GIT_TEST_CMP "$@"
788 }
789
790 # This function can be used to schedule some commands to be run
791 # unconditionally at the end of the test to restore sanity:
792 #
793 #       test_expect_success 'test core.capslock' '
794 #               git config core.capslock true &&
795 #               test_when_finished "git config --unset core.capslock" &&
796 #               hello world
797 #       '
798 #
799 # That would be roughly equivalent to
800 #
801 #       test_expect_success 'test core.capslock' '
802 #               git config core.capslock true &&
803 #               hello world
804 #               git config --unset core.capslock
805 #       '
806 #
807 # except that the greeting and config --unset must both succeed for
808 # the test to pass.
809 #
810 # Note that under --immediate mode, no clean-up is done to help diagnose
811 # what went wrong.
812
813 test_when_finished () {
814         test_cleanup="{ $*
815                 } && (exit \"\$eval_ret\"); eval_ret=\$?; $test_cleanup"
816 }
817
818 # Most tests can use the created repository, but some may need to create more.
819 # Usage: test_create_repo <directory>
820 test_create_repo () {
821         test "$#" = 1 ||
822         error "bug in the test script: not 1 parameter to test-create-repo"
823         repo="$1"
824         mkdir -p "$repo"
825         (
826                 cd "$repo" || error "Cannot setup test environment"
827                 "$GIT_EXEC_PATH/git-init" "--template=$GIT_BUILD_DIR/templates/blt/" >&3 2>&4 ||
828                 error "cannot run git init -- have you built things yet?"
829                 mv .git/hooks .git/hooks-disabled
830         ) || exit
831 }
832
833 test_done () {
834         GIT_EXIT_OK=t
835
836         if test -z "$HARNESS_ACTIVE"; then
837                 test_results_dir="$TEST_DIRECTORY/test-results"
838                 mkdir -p "$test_results_dir"
839                 test_results_path="$test_results_dir/${0%.sh}-$$.counts"
840
841                 cat >>"$test_results_path" <<-EOF
842                 total $test_count
843                 success $test_success
844                 fixed $test_fixed
845                 broken $test_broken
846                 failed $test_failure
847
848                 EOF
849         fi
850
851         if test "$test_fixed" != 0
852         then
853                 say_color pass "# fixed $test_fixed known breakage(s)"
854         fi
855         if test "$test_broken" != 0
856         then
857                 say_color error "# still have $test_broken known breakage(s)"
858                 msg="remaining $(($test_count-$test_broken)) test(s)"
859         else
860                 msg="$test_count test(s)"
861         fi
862         case "$test_failure" in
863         0)
864                 # Maybe print SKIP message
865                 [ -z "$skip_all" ] || skip_all=" # SKIP $skip_all"
866
867                 if test $test_external_has_tap -eq 0; then
868                         say_color pass "# passed all $msg"
869                         say "1..$test_count$skip_all"
870                 fi
871
872                 test -d "$remove_trash" &&
873                 cd "$(dirname "$remove_trash")" &&
874                 rm -rf "$(basename "$remove_trash")"
875
876                 exit 0 ;;
877
878         *)
879                 if test $test_external_has_tap -eq 0; then
880                         say_color error "# failed $test_failure among $msg"
881                         say "1..$test_count"
882                 fi
883
884                 exit 1 ;;
885
886         esac
887 }
888
889 # Test the binaries we have just built.  The tests are kept in
890 # t/ subdirectory and are run in 'trash directory' subdirectory.
891 if test -z "$TEST_DIRECTORY"
892 then
893         # We allow tests to override this, in case they want to run tests
894         # outside of t/, e.g. for running tests on the test library
895         # itself.
896         TEST_DIRECTORY=$(pwd)
897 fi
898 GIT_BUILD_DIR="$TEST_DIRECTORY"/..
899
900 if test -n "$valgrind"
901 then
902         make_symlink () {
903                 test -h "$2" &&
904                 test "$1" = "$(readlink "$2")" || {
905                         # be super paranoid
906                         if mkdir "$2".lock
907                         then
908                                 rm -f "$2" &&
909                                 ln -s "$1" "$2" &&
910                                 rm -r "$2".lock
911                         else
912                                 while test -d "$2".lock
913                                 do
914                                         say "Waiting for lock on $2."
915                                         sleep 1
916                                 done
917                         fi
918                 }
919         }
920
921         make_valgrind_symlink () {
922                 # handle only executables, unless they are shell libraries that
923                 # need to be in the exec-path.  We will just use "#!" as a
924                 # guess for a shell-script, since we have no idea what the user
925                 # may have configured as the shell path.
926                 test -x "$1" ||
927                 test "#!" = "$(head -c 2 <"$1")" ||
928                 return;
929
930                 base=$(basename "$1")
931                 symlink_target=$GIT_BUILD_DIR/$base
932                 # do not override scripts
933                 if test -x "$symlink_target" &&
934                     test ! -d "$symlink_target" &&
935                     test "#!" != "$(head -c 2 < "$symlink_target")"
936                 then
937                         symlink_target=../valgrind.sh
938                 fi
939                 case "$base" in
940                 *.sh|*.perl)
941                         symlink_target=../unprocessed-script
942                 esac
943                 # create the link, or replace it if it is out of date
944                 make_symlink "$symlink_target" "$GIT_VALGRIND/bin/$base" || exit
945         }
946
947         # override all git executables in TEST_DIRECTORY/..
948         GIT_VALGRIND=$TEST_DIRECTORY/valgrind
949         mkdir -p "$GIT_VALGRIND"/bin
950         for file in $GIT_BUILD_DIR/git* $GIT_BUILD_DIR/test-*
951         do
952                 make_valgrind_symlink $file
953         done
954         # special-case the mergetools loadables
955         make_symlink "$GIT_BUILD_DIR"/mergetools "$GIT_VALGRIND/bin/mergetools"
956         OLDIFS=$IFS
957         IFS=:
958         for path in $PATH
959         do
960                 ls "$path"/git-* 2> /dev/null |
961                 while read file
962                 do
963                         make_valgrind_symlink "$file"
964                 done
965         done
966         IFS=$OLDIFS
967         PATH=$GIT_VALGRIND/bin:$PATH
968         GIT_EXEC_PATH=$GIT_VALGRIND/bin
969         export GIT_VALGRIND
970 elif test -n "$GIT_TEST_INSTALLED" ; then
971         GIT_EXEC_PATH=$($GIT_TEST_INSTALLED/git --exec-path)  ||
972         error "Cannot run git from $GIT_TEST_INSTALLED."
973         PATH=$GIT_TEST_INSTALLED:$GIT_BUILD_DIR:$PATH
974         GIT_EXEC_PATH=${GIT_TEST_EXEC_PATH:-$GIT_EXEC_PATH}
975 else # normal case, use ../bin-wrappers only unless $with_dashes:
976         git_bin_dir="$GIT_BUILD_DIR/bin-wrappers"
977         if ! test -x "$git_bin_dir/git" ; then
978                 if test -z "$with_dashes" ; then
979                         say "$git_bin_dir/git is not executable; using GIT_EXEC_PATH"
980                 fi
981                 with_dashes=t
982         fi
983         PATH="$git_bin_dir:$PATH"
984         GIT_EXEC_PATH=$GIT_BUILD_DIR
985         if test -n "$with_dashes" ; then
986                 PATH="$GIT_BUILD_DIR:$PATH"
987         fi
988 fi
989 GIT_TEMPLATE_DIR="$GIT_BUILD_DIR"/templates/blt
990 unset GIT_CONFIG
991 GIT_CONFIG_NOSYSTEM=1
992 GIT_ATTR_NOSYSTEM=1
993 export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG_NOSYSTEM GIT_ATTR_NOSYSTEM
994
995 . "$GIT_BUILD_DIR"/GIT-BUILD-OPTIONS
996
997 if test -z "$GIT_TEST_CMP"
998 then
999         if test -n "$GIT_TEST_CMP_USE_COPIED_CONTEXT"
1000         then
1001                 GIT_TEST_CMP="$DIFF -c"
1002         else
1003                 GIT_TEST_CMP="$DIFF -u"
1004         fi
1005 fi
1006
1007 GITPERLLIB="$GIT_BUILD_DIR"/perl/blib/lib:"$GIT_BUILD_DIR"/perl/blib/arch/auto/Git
1008 export GITPERLLIB
1009 test -d "$GIT_BUILD_DIR"/templates/blt || {
1010         error "You haven't built things yet, have you?"
1011 }
1012
1013 if test -z "$GIT_TEST_INSTALLED" && test -z "$NO_PYTHON"
1014 then
1015         GITPYTHONLIB="$GIT_BUILD_DIR/git_remote_helpers/build/lib"
1016         export GITPYTHONLIB
1017         test -d "$GIT_BUILD_DIR"/git_remote_helpers/build || {
1018                 error "You haven't built git_remote_helpers yet, have you?"
1019         }
1020 fi
1021
1022 if ! test -x "$GIT_BUILD_DIR"/test-chmtime; then
1023         echo >&2 'You need to build test-chmtime:'
1024         echo >&2 'Run "make test-chmtime" in the source (toplevel) directory'
1025         exit 1
1026 fi
1027
1028 # Test repository
1029 test="trash directory.$(basename "$0" .sh)"
1030 test -n "$root" && test="$root/$test"
1031 case "$test" in
1032 /*) TRASH_DIRECTORY="$test" ;;
1033  *) TRASH_DIRECTORY="$TEST_DIRECTORY/$test" ;;
1034 esac
1035 test ! -z "$debug" || remove_trash=$TRASH_DIRECTORY
1036 rm -fr "$test" || {
1037         GIT_EXIT_OK=t
1038         echo >&5 "FATAL: Cannot prepare test area"
1039         exit 1
1040 }
1041
1042 HOME="$TRASH_DIRECTORY"
1043 export HOME
1044
1045 test_create_repo "$test"
1046 # Use -P to resolve symlinks in our working directory so that the cwd
1047 # in subprocesses like git equals our $PWD (for pathname comparisons).
1048 cd -P "$test" || exit 1
1049
1050 this_test=${0##*/}
1051 this_test=${this_test%%-*}
1052 for skp in $GIT_SKIP_TESTS
1053 do
1054         case "$this_test" in
1055         $skp)
1056                 say_color skip >&3 "skipping test $this_test altogether"
1057                 skip_all="skip all tests in $this_test"
1058                 test_done
1059         esac
1060 done
1061
1062 # Provide an implementation of the 'yes' utility
1063 yes () {
1064         if test $# = 0
1065         then
1066                 y=y
1067         else
1068                 y="$*"
1069         fi
1070
1071         while echo "$y"
1072         do
1073                 :
1074         done
1075 }
1076
1077 # Fix some commands on Windows
1078 case $(uname -s) in
1079 *MINGW*)
1080         # Windows has its own (incompatible) sort and find
1081         sort () {
1082                 /usr/bin/sort "$@"
1083         }
1084         find () {
1085                 /usr/bin/find "$@"
1086         }
1087         sum () {
1088                 md5sum "$@"
1089         }
1090         # git sees Windows-style pwd
1091         pwd () {
1092                 builtin pwd -W
1093         }
1094         # no POSIX permissions
1095         # backslashes in pathspec are converted to '/'
1096         # exec does not inherit the PID
1097         test_set_prereq MINGW
1098         test_set_prereq SED_STRIPS_CR
1099         ;;
1100 *CYGWIN*)
1101         test_set_prereq POSIXPERM
1102         test_set_prereq EXECKEEPSPID
1103         test_set_prereq NOT_MINGW
1104         test_set_prereq SED_STRIPS_CR
1105         ;;
1106 *)
1107         test_set_prereq POSIXPERM
1108         test_set_prereq BSLASHPSPEC
1109         test_set_prereq EXECKEEPSPID
1110         test_set_prereq NOT_MINGW
1111         ;;
1112 esac
1113
1114 test -z "$NO_PERL" && test_set_prereq PERL
1115 test -z "$NO_PYTHON" && test_set_prereq PYTHON
1116 test -n "$USE_LIBPCRE" && test_set_prereq LIBPCRE
1117
1118 # Can we rely on git's output in the C locale?
1119 if test -n "$GETTEXT_POISON"
1120 then
1121         GIT_GETTEXT_POISON=YesPlease
1122         export GIT_GETTEXT_POISON
1123 else
1124         test_set_prereq C_LOCALE_OUTPUT
1125 fi
1126
1127 # Use this instead of test_cmp to compare files that contain expected and
1128 # actual output from git commands that can be translated.  When running
1129 # under GETTEXT_POISON this pretends that the command produced expected
1130 # results.
1131 test_i18ncmp () {
1132         test -n "$GETTEXT_POISON" || test_cmp "$@"
1133 }
1134
1135 # Use this instead of "grep expected-string actual" to see if the
1136 # output from a git command that can be translated either contains an
1137 # expected string, or does not contain an unwanted one.  When running
1138 # under GETTEXT_POISON this pretends that the command produced expected
1139 # results.
1140 test_i18ngrep () {
1141         if test -n "$GETTEXT_POISON"
1142         then
1143             : # pretend success
1144         elif test "x!" = "x$1"
1145         then
1146                 shift
1147                 ! grep "$@"
1148         else
1149                 grep "$@"
1150         fi
1151 }
1152
1153 # test whether the filesystem supports symbolic links
1154 ln -s x y 2>/dev/null && test -h y 2>/dev/null && test_set_prereq SYMLINKS
1155 rm -f y
1156
1157 # When the tests are run as root, permission tests will report that
1158 # things are writable when they shouldn't be.
1159 test -w / || test_set_prereq SANITY