Merge branch 'ps/doc-packfile-vs-pack-file'
[git] / t / test-lib.sh
1 # Test framework for git.  See t/README for usage.
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 # Keep the original TERM for say_color
19 ORIGINAL_TERM=$TERM
20
21 # Test the binaries we have just built.  The tests are kept in
22 # t/ subdirectory and are run in 'trash directory' subdirectory.
23 if test -z "$TEST_DIRECTORY"
24 then
25         # We allow tests to override this, in case they want to run tests
26         # outside of t/, e.g. for running tests on the test library
27         # itself.
28         TEST_DIRECTORY=$(pwd)
29 else
30         # ensure that TEST_DIRECTORY is an absolute path so that it
31         # is valid even if the current working directory is changed
32         TEST_DIRECTORY=$(cd "$TEST_DIRECTORY" && pwd) || exit 1
33 fi
34 if test -z "$TEST_OUTPUT_DIRECTORY"
35 then
36         # Similarly, override this to store the test-results subdir
37         # elsewhere
38         TEST_OUTPUT_DIRECTORY=$TEST_DIRECTORY
39 fi
40 GIT_BUILD_DIR="$TEST_DIRECTORY"/..
41
42 ################################################################
43 # It appears that people try to run tests without building...
44 "$GIT_BUILD_DIR/git" >/dev/null
45 if test $? != 1
46 then
47         echo >&2 'error: you do not seem to have built git yet.'
48         exit 1
49 fi
50
51 . "$GIT_BUILD_DIR"/GIT-BUILD-OPTIONS
52 export PERL_PATH SHELL_PATH
53
54 # if --tee was passed, write the output not only to the terminal, but
55 # additionally to the file test-results/$BASENAME.out, too.
56 case "$GIT_TEST_TEE_STARTED, $* " in
57 done,*)
58         # do not redirect again
59         ;;
60 *' --tee '*|*' --va'*)
61         mkdir -p "$TEST_OUTPUT_DIRECTORY/test-results"
62         BASE="$TEST_OUTPUT_DIRECTORY/test-results/$(basename "$0" .sh)"
63         (GIT_TEST_TEE_STARTED=done ${SHELL_PATH} "$0" "$@" 2>&1;
64          echo $? > $BASE.exit) | tee $BASE.out
65         test "$(cat $BASE.exit)" = 0
66         exit
67         ;;
68 esac
69
70 # For repeatability, reset the environment to known value.
71 LANG=C
72 LC_ALL=C
73 PAGER=cat
74 TZ=UTC
75 TERM=dumb
76 export LANG LC_ALL PAGER TERM TZ
77 EDITOR=:
78 # A call to "unset" with no arguments causes at least Solaris 10
79 # /usr/xpg4/bin/sh and /bin/ksh to bail out.  So keep the unsets
80 # deriving from the command substitution clustered with the other
81 # ones.
82 unset VISUAL EMAIL LANGUAGE COLUMNS $("$PERL_PATH" -e '
83         my @env = keys %ENV;
84         my $ok = join("|", qw(
85                 TRACE
86                 DEBUG
87                 USE_LOOKUP
88                 TEST
89                 .*_TEST
90                 PROVE
91                 VALGRIND
92                 UNZIP
93                 PERF_
94                 CURL_VERBOSE
95         ));
96         my @vars = grep(/^GIT_/ && !/^GIT_($ok)/o, @env);
97         print join("\n", @vars);
98 ')
99 unset XDG_CONFIG_HOME
100 unset GITPERLLIB
101 GIT_AUTHOR_EMAIL=author@example.com
102 GIT_AUTHOR_NAME='A U Thor'
103 GIT_COMMITTER_EMAIL=committer@example.com
104 GIT_COMMITTER_NAME='C O Mitter'
105 GIT_MERGE_VERBOSITY=5
106 GIT_MERGE_AUTOEDIT=no
107 export GIT_MERGE_VERBOSITY GIT_MERGE_AUTOEDIT
108 export GIT_AUTHOR_EMAIL GIT_AUTHOR_NAME
109 export GIT_COMMITTER_EMAIL GIT_COMMITTER_NAME
110 export EDITOR
111
112 # Tests using GIT_TRACE typically don't want <timestamp> <file>:<line> output
113 GIT_TRACE_BARE=1
114 export GIT_TRACE_BARE
115
116 if test -n "${TEST_GIT_INDEX_VERSION:+isset}"
117 then
118         GIT_INDEX_VERSION="$TEST_GIT_INDEX_VERSION"
119         export GIT_INDEX_VERSION
120 fi
121
122 # Add libc MALLOC and MALLOC_PERTURB test
123 # only if we are not executing the test with valgrind
124 if expr " $GIT_TEST_OPTS " : ".* --valgrind " >/dev/null ||
125    test -n "$TEST_NO_MALLOC_CHECK"
126 then
127         setup_malloc_check () {
128                 : nothing
129         }
130         teardown_malloc_check () {
131                 : nothing
132         }
133 else
134         setup_malloc_check () {
135                 MALLOC_CHECK_=3 MALLOC_PERTURB_=165
136                 export MALLOC_CHECK_ MALLOC_PERTURB_
137         }
138         teardown_malloc_check () {
139                 unset MALLOC_CHECK_ MALLOC_PERTURB_
140         }
141 fi
142
143 : ${ASAN_OPTIONS=detect_leaks=0}
144 export ASAN_OPTIONS
145
146 # Protect ourselves from common misconfiguration to export
147 # CDPATH into the environment
148 unset CDPATH
149
150 unset GREP_OPTIONS
151 unset UNZIP
152
153 case $(echo $GIT_TRACE |tr "[A-Z]" "[a-z]") in
154 1|2|true)
155         GIT_TRACE=4
156         ;;
157 esac
158
159 # Convenience
160 #
161 # A regexp to match 5 and 40 hexdigits
162 _x05='[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
163 _x40="$_x05$_x05$_x05$_x05$_x05$_x05$_x05$_x05"
164
165 # Zero SHA-1
166 _z40=0000000000000000000000000000000000000000
167
168 # Line feed
169 LF='
170 '
171
172 # UTF-8 ZERO WIDTH NON-JOINER, which HFS+ ignores
173 # when case-folding filenames
174 u200c=$(printf '\342\200\214')
175
176 export _x05 _x40 _z40 LF u200c
177
178 # Each test should start with something like this, after copyright notices:
179 #
180 # test_description='Description of this test...
181 # This test checks if command xyzzy does the right thing...
182 # '
183 # . ./test-lib.sh
184
185 unset color
186 while test "$#" -ne 0
187 do
188         case "$1" in
189         -d|--d|--de|--deb|--debu|--debug)
190                 debug=t; shift ;;
191         -i|--i|--im|--imm|--imme|--immed|--immedi|--immedia|--immediat|--immediate)
192                 immediate=t; shift ;;
193         -l|--l|--lo|--lon|--long|--long-|--long-t|--long-te|--long-tes|--long-test|--long-tests)
194                 GIT_TEST_LONG=t; export GIT_TEST_LONG; shift ;;
195         -r)
196                 shift; test "$#" -ne 0 || {
197                         echo 'error: -r requires an argument' >&2;
198                         exit 1;
199                 }
200                 run_list=$1; shift ;;
201         --run=*)
202                 run_list=$(expr "z$1" : 'z[^=]*=\(.*\)'); shift ;;
203         -h|--h|--he|--hel|--help)
204                 help=t; shift ;;
205         -v|--v|--ve|--ver|--verb|--verbo|--verbos|--verbose)
206                 verbose=t; shift ;;
207         --verbose-only=*)
208                 verbose_only=$(expr "z$1" : 'z[^=]*=\(.*\)')
209                 shift ;;
210         -q|--q|--qu|--qui|--quie|--quiet)
211                 # Ignore --quiet under a TAP::Harness. Saying how many tests
212                 # passed without the ok/not ok details is always an error.
213                 test -z "$HARNESS_ACTIVE" && quiet=t; shift ;;
214         --with-dashes)
215                 with_dashes=t; shift ;;
216         --no-color)
217                 color=; shift ;;
218         --va|--val|--valg|--valgr|--valgri|--valgrin|--valgrind)
219                 valgrind=memcheck
220                 shift ;;
221         --valgrind=*)
222                 valgrind=$(expr "z$1" : 'z[^=]*=\(.*\)')
223                 shift ;;
224         --valgrind-only=*)
225                 valgrind_only=$(expr "z$1" : 'z[^=]*=\(.*\)')
226                 shift ;;
227         --tee)
228                 shift ;; # was handled already
229         --root=*)
230                 root=$(expr "z$1" : 'z[^=]*=\(.*\)')
231                 shift ;;
232         --chain-lint)
233                 GIT_TEST_CHAIN_LINT=1
234                 shift ;;
235         --no-chain-lint)
236                 GIT_TEST_CHAIN_LINT=0
237                 shift ;;
238         -x)
239                 trace=t
240                 verbose=t
241                 shift ;;
242         *)
243                 echo "error: unknown test option '$1'" >&2; exit 1 ;;
244         esac
245 done
246
247 if test -n "$valgrind_only"
248 then
249         test -z "$valgrind" && valgrind=memcheck
250         test -z "$verbose" && verbose_only="$valgrind_only"
251 elif test -n "$valgrind"
252 then
253         verbose=t
254 fi
255
256 error () {
257         say_color error "error: $*"
258         GIT_EXIT_OK=t
259         exit 1
260 }
261
262 say () {
263         say_color info "$*"
264 }
265
266 test "${test_description}" != "" ||
267 error "Test script did not set test_description."
268
269 if test "$help" = "t"
270 then
271         printf '%s\n' "$test_description"
272         exit 0
273 fi
274
275 exec 5>&1
276 exec 6<&0
277 if test "$verbose" = "t"
278 then
279         exec 4>&2 3>&1
280 else
281         exec 4>/dev/null 3>/dev/null
282 fi
283
284 test_failure=0
285 test_count=0
286 test_fixed=0
287 test_broken=0
288 test_success=0
289
290 test_external_has_tap=0
291
292 die () {
293         code=$?
294         if test -n "$GIT_EXIT_OK"
295         then
296                 exit $code
297         else
298                 echo >&5 "FATAL: Unexpected exit with code $code"
299                 exit 1
300         fi
301 }
302
303 GIT_EXIT_OK=
304 trap 'die' EXIT
305 trap 'exit $?' INT
306
307 # The user-facing functions are loaded from a separate file so that
308 # test_perf subshells can have them too
309 . "$TEST_DIRECTORY/test-lib-functions.sh"
310
311 # You are not expected to call test_ok_ and test_failure_ directly, use
312 # the test_expect_* functions instead.
313
314 test_ok_ () {
315         test_success=$(($test_success + 1))
316         say_color "" "ok $test_count - $@"
317 }
318
319 test_failure_ () {
320         test_failure=$(($test_failure + 1))
321         say_color error "not ok $test_count - $1"
322         shift
323         printf '%s\n' "$*" | sed -e 's/^/#      /'
324         test "$immediate" = "" || { GIT_EXIT_OK=t; exit 1; }
325 }
326
327 test_known_broken_ok_ () {
328         test_fixed=$(($test_fixed+1))
329         say_color error "ok $test_count - $@ # TODO known breakage vanished"
330 }
331
332 test_known_broken_failure_ () {
333         test_broken=$(($test_broken+1))
334         say_color warn "not ok $test_count - $@ # TODO known breakage"
335 }
336
337 test_debug () {
338         test "$debug" = "" || eval "$1"
339 }
340
341 match_pattern_list () {
342         arg="$1"
343         shift
344         test -z "$*" && return 1
345         for pattern_
346         do
347                 case "$arg" in
348                 $pattern_)
349                         return 0
350                 esac
351         done
352         return 1
353 }
354
355 match_test_selector_list () {
356         title="$1"
357         shift
358         arg="$1"
359         shift
360         test -z "$1" && return 0
361
362         # Both commas and whitespace are accepted as separators.
363         OLDIFS=$IFS
364         IFS='   ,'
365         set -- $1
366         IFS=$OLDIFS
367
368         # If the first selector is negative we include by default.
369         include=
370         case "$1" in
371                 !*) include=t ;;
372         esac
373
374         for selector
375         do
376                 orig_selector=$selector
377
378                 positive=t
379                 case "$selector" in
380                         !*)
381                                 positive=
382                                 selector=${selector##?}
383                                 ;;
384                 esac
385
386                 test -z "$selector" && continue
387
388                 case "$selector" in
389                         *-*)
390                                 if expr "z${selector%%-*}" : "z[0-9]*[^0-9]" >/dev/null
391                                 then
392                                         echo "error: $title: invalid non-numeric in range" \
393                                                 "start: '$orig_selector'" >&2
394                                         exit 1
395                                 fi
396                                 if expr "z${selector#*-}" : "z[0-9]*[^0-9]" >/dev/null
397                                 then
398                                         echo "error: $title: invalid non-numeric in range" \
399                                                 "end: '$orig_selector'" >&2
400                                         exit 1
401                                 fi
402                                 ;;
403                         *)
404                                 if expr "z$selector" : "z[0-9]*[^0-9]" >/dev/null
405                                 then
406                                         echo "error: $title: invalid non-numeric in test" \
407                                                 "selector: '$orig_selector'" >&2
408                                         exit 1
409                                 fi
410                 esac
411
412                 # Short cut for "obvious" cases
413                 test -z "$include" && test -z "$positive" && continue
414                 test -n "$include" && test -n "$positive" && continue
415
416                 case "$selector" in
417                         -*)
418                                 if test $arg -le ${selector#-}
419                                 then
420                                         include=$positive
421                                 fi
422                                 ;;
423                         *-)
424                                 if test $arg -ge ${selector%-}
425                                 then
426                                         include=$positive
427                                 fi
428                                 ;;
429                         *-*)
430                                 if test ${selector%%-*} -le $arg \
431                                         && test $arg -le ${selector#*-}
432                                 then
433                                         include=$positive
434                                 fi
435                                 ;;
436                         *)
437                                 if test $arg -eq $selector
438                                 then
439                                         include=$positive
440                                 fi
441                                 ;;
442                 esac
443         done
444
445         test -n "$include"
446 }
447
448 maybe_teardown_verbose () {
449         test -z "$verbose_only" && return
450         exec 4>/dev/null 3>/dev/null
451         verbose=
452 }
453
454 last_verbose=t
455 maybe_setup_verbose () {
456         test -z "$verbose_only" && return
457         if match_pattern_list $test_count $verbose_only
458         then
459                 exec 4>&2 3>&1
460                 # Emit a delimiting blank line when going from
461                 # non-verbose to verbose.  Within verbose mode the
462                 # delimiter is printed by test_expect_*.  The choice
463                 # of the initial $last_verbose is such that before
464                 # test 1, we do not print it.
465                 test -z "$last_verbose" && echo >&3 ""
466                 verbose=t
467         else
468                 exec 4>/dev/null 3>/dev/null
469                 verbose=
470         fi
471         last_verbose=$verbose
472 }
473
474 maybe_teardown_valgrind () {
475         test -z "$GIT_VALGRIND" && return
476         GIT_VALGRIND_ENABLED=
477 }
478
479 maybe_setup_valgrind () {
480         test -z "$GIT_VALGRIND" && return
481         if test -z "$valgrind_only"
482         then
483                 GIT_VALGRIND_ENABLED=t
484                 return
485         fi
486         GIT_VALGRIND_ENABLED=
487         if match_pattern_list $test_count $valgrind_only
488         then
489                 GIT_VALGRIND_ENABLED=t
490         fi
491 }
492
493 # This is a separate function because some tests use
494 # "return" to end a test_expect_success block early
495 # (and we want to make sure we run any cleanup like
496 # "set +x").
497 test_eval_inner_ () {
498         # Do not add anything extra (including LF) after '$*'
499         eval "
500                 test \"$trace\" = t && set -x
501                 $*"
502 }
503
504 test_eval_ () {
505         # We run this block with stderr redirected to avoid extra cruft
506         # during a "-x" trace. Once in "set -x" mode, we cannot prevent
507         # the shell from printing the "set +x" to turn it off (nor the saving
508         # of $? before that). But we can make sure that the output goes to
509         # /dev/null.
510         #
511         # The test itself is run with stderr put back to &4 (so either to
512         # /dev/null, or to the original stderr if --verbose was used).
513         {
514                 test_eval_inner_ "$@" </dev/null >&3 2>&4
515                 test_eval_ret_=$?
516                 if test "$trace" = t
517                 then
518                         set +x
519                         if test "$test_eval_ret_" != 0
520                         then
521                                 say_color error >&4 "error: last command exited with \$?=$test_eval_ret_"
522                         fi
523                 fi
524         } 2>/dev/null
525         return $test_eval_ret_
526 }
527
528 test_run_ () {
529         test_cleanup=:
530         expecting_failure=$2
531
532         if test "${GIT_TEST_CHAIN_LINT:-1}" != 0; then
533                 # 117 is magic because it is unlikely to match the exit
534                 # code of other programs
535                 test_eval_ "(exit 117) && $1"
536                 if test "$?" != 117; then
537                         error "bug in the test script: broken &&-chain: $1"
538                 fi
539         fi
540
541         setup_malloc_check
542         test_eval_ "$1"
543         eval_ret=$?
544         teardown_malloc_check
545
546         if test -z "$immediate" || test $eval_ret = 0 ||
547            test -n "$expecting_failure" && test "$test_cleanup" != ":"
548         then
549                 setup_malloc_check
550                 test_eval_ "$test_cleanup"
551                 teardown_malloc_check
552         fi
553         if test "$verbose" = "t" && test -n "$HARNESS_ACTIVE"
554         then
555                 echo ""
556         fi
557         return "$eval_ret"
558 }
559
560 test_start_ () {
561         test_count=$(($test_count+1))
562         maybe_setup_verbose
563         maybe_setup_valgrind
564 }
565
566 test_finish_ () {
567         echo >&3 ""
568         maybe_teardown_valgrind
569         maybe_teardown_verbose
570 }
571
572 test_skip () {
573         to_skip=
574         skipped_reason=
575         if match_pattern_list $this_test.$test_count $GIT_SKIP_TESTS
576         then
577                 to_skip=t
578                 skipped_reason="GIT_SKIP_TESTS"
579         fi
580         if test -z "$to_skip" && test -n "$test_prereq" &&
581            ! test_have_prereq "$test_prereq"
582         then
583                 to_skip=t
584
585                 of_prereq=
586                 if test "$missing_prereq" != "$test_prereq"
587                 then
588                         of_prereq=" of $test_prereq"
589                 fi
590                 skipped_reason="missing $missing_prereq${of_prereq}"
591         fi
592         if test -z "$to_skip" && test -n "$run_list" &&
593                 ! match_test_selector_list '--run' $test_count "$run_list"
594         then
595                 to_skip=t
596                 skipped_reason="--run"
597         fi
598
599         case "$to_skip" in
600         t)
601                 say_color skip >&3 "skipping test: $@"
602                 say_color skip "ok $test_count # skip $1 ($skipped_reason)"
603                 : true
604                 ;;
605         *)
606                 false
607                 ;;
608         esac
609 }
610
611 # stub; perf-lib overrides it
612 test_at_end_hook_ () {
613         :
614 }
615
616 test_done () {
617         GIT_EXIT_OK=t
618
619         if test -z "$HARNESS_ACTIVE"
620         then
621                 test_results_dir="$TEST_OUTPUT_DIRECTORY/test-results"
622                 mkdir -p "$test_results_dir"
623                 base=${0##*/}
624                 test_results_path="$test_results_dir/${base%.sh}-$$.counts"
625
626                 cat >>"$test_results_path" <<-EOF
627                 total $test_count
628                 success $test_success
629                 fixed $test_fixed
630                 broken $test_broken
631                 failed $test_failure
632
633                 EOF
634         fi
635
636         if test "$test_fixed" != 0
637         then
638                 say_color error "# $test_fixed known breakage(s) vanished; please update test(s)"
639         fi
640         if test "$test_broken" != 0
641         then
642                 say_color warn "# still have $test_broken known breakage(s)"
643         fi
644         if test "$test_broken" != 0 || test "$test_fixed" != 0
645         then
646                 test_remaining=$(( $test_count - $test_broken - $test_fixed ))
647                 msg="remaining $test_remaining test(s)"
648         else
649                 test_remaining=$test_count
650                 msg="$test_count test(s)"
651         fi
652         case "$test_failure" in
653         0)
654                 # Maybe print SKIP message
655                 if test -n "$skip_all" && test $test_count -gt 0
656                 then
657                         error "Can't use skip_all after running some tests"
658                 fi
659                 test -z "$skip_all" || skip_all=" # SKIP $skip_all"
660
661                 if test $test_external_has_tap -eq 0
662                 then
663                         if test $test_remaining -gt 0
664                         then
665                                 say_color pass "# passed all $msg"
666                         fi
667                         say "1..$test_count$skip_all"
668                 fi
669
670                 test -d "$remove_trash" &&
671                 cd "$(dirname "$remove_trash")" &&
672                 rm -rf "$(basename "$remove_trash")"
673
674                 test_at_end_hook_
675
676                 exit 0 ;;
677
678         *)
679                 if test $test_external_has_tap -eq 0
680                 then
681                         say_color error "# failed $test_failure among $msg"
682                         say "1..$test_count"
683                 fi
684
685                 exit 1 ;;
686
687         esac
688 }
689
690 if test -n "$valgrind"
691 then
692         make_symlink () {
693                 test -h "$2" &&
694                 test "$1" = "$(readlink "$2")" || {
695                         # be super paranoid
696                         if mkdir "$2".lock
697                         then
698                                 rm -f "$2" &&
699                                 ln -s "$1" "$2" &&
700                                 rm -r "$2".lock
701                         else
702                                 while test -d "$2".lock
703                                 do
704                                         say "Waiting for lock on $2."
705                                         sleep 1
706                                 done
707                         fi
708                 }
709         }
710
711         make_valgrind_symlink () {
712                 # handle only executables, unless they are shell libraries that
713                 # need to be in the exec-path.
714                 test -x "$1" ||
715                 test "# " = "$(head -c 2 <"$1")" ||
716                 return;
717
718                 base=$(basename "$1")
719                 symlink_target=$GIT_BUILD_DIR/$base
720                 # do not override scripts
721                 if test -x "$symlink_target" &&
722                     test ! -d "$symlink_target" &&
723                     test "#!" != "$(head -c 2 < "$symlink_target")"
724                 then
725                         symlink_target=../valgrind.sh
726                 fi
727                 case "$base" in
728                 *.sh|*.perl)
729                         symlink_target=../unprocessed-script
730                 esac
731                 # create the link, or replace it if it is out of date
732                 make_symlink "$symlink_target" "$GIT_VALGRIND/bin/$base" || exit
733         }
734
735         # override all git executables in TEST_DIRECTORY/..
736         GIT_VALGRIND=$TEST_DIRECTORY/valgrind
737         mkdir -p "$GIT_VALGRIND"/bin
738         for file in $GIT_BUILD_DIR/git* $GIT_BUILD_DIR/test-*
739         do
740                 make_valgrind_symlink $file
741         done
742         # special-case the mergetools loadables
743         make_symlink "$GIT_BUILD_DIR"/mergetools "$GIT_VALGRIND/bin/mergetools"
744         OLDIFS=$IFS
745         IFS=:
746         for path in $PATH
747         do
748                 ls "$path"/git-* 2> /dev/null |
749                 while read file
750                 do
751                         make_valgrind_symlink "$file"
752                 done
753         done
754         IFS=$OLDIFS
755         PATH=$GIT_VALGRIND/bin:$PATH
756         GIT_EXEC_PATH=$GIT_VALGRIND/bin
757         export GIT_VALGRIND
758         GIT_VALGRIND_MODE="$valgrind"
759         export GIT_VALGRIND_MODE
760         GIT_VALGRIND_ENABLED=t
761         test -n "$valgrind_only" && GIT_VALGRIND_ENABLED=
762         export GIT_VALGRIND_ENABLED
763 elif test -n "$GIT_TEST_INSTALLED"
764 then
765         GIT_EXEC_PATH=$($GIT_TEST_INSTALLED/git --exec-path)  ||
766         error "Cannot run git from $GIT_TEST_INSTALLED."
767         PATH=$GIT_TEST_INSTALLED:$GIT_BUILD_DIR:$PATH
768         GIT_EXEC_PATH=${GIT_TEST_EXEC_PATH:-$GIT_EXEC_PATH}
769 else # normal case, use ../bin-wrappers only unless $with_dashes:
770         git_bin_dir="$GIT_BUILD_DIR/bin-wrappers"
771         if ! test -x "$git_bin_dir/git"
772         then
773                 if test -z "$with_dashes"
774                 then
775                         say "$git_bin_dir/git is not executable; using GIT_EXEC_PATH"
776                 fi
777                 with_dashes=t
778         fi
779         PATH="$git_bin_dir:$PATH"
780         GIT_EXEC_PATH=$GIT_BUILD_DIR
781         if test -n "$with_dashes"
782         then
783                 PATH="$GIT_BUILD_DIR:$PATH"
784         fi
785 fi
786 GIT_TEMPLATE_DIR="$GIT_BUILD_DIR"/templates/blt
787 GIT_CONFIG_NOSYSTEM=1
788 GIT_ATTR_NOSYSTEM=1
789 export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG_NOSYSTEM GIT_ATTR_NOSYSTEM
790
791 if test -z "$GIT_TEST_CMP"
792 then
793         if test -n "$GIT_TEST_CMP_USE_COPIED_CONTEXT"
794         then
795                 GIT_TEST_CMP="$DIFF -c"
796         else
797                 GIT_TEST_CMP="$DIFF -u"
798         fi
799 fi
800
801 GITPERLLIB="$GIT_BUILD_DIR"/perl/blib/lib:"$GIT_BUILD_DIR"/perl/blib/arch/auto/Git
802 export GITPERLLIB
803 test -d "$GIT_BUILD_DIR"/templates/blt || {
804         error "You haven't built things yet, have you?"
805 }
806
807 if ! test -x "$GIT_BUILD_DIR"/test-chmtime
808 then
809         echo >&2 'You need to build test-chmtime:'
810         echo >&2 'Run "make test-chmtime" in the source (toplevel) directory'
811         exit 1
812 fi
813
814 # Test repository
815 TRASH_DIRECTORY="trash directory.$(basename "$0" .sh)"
816 test -n "$root" && TRASH_DIRECTORY="$root/$TRASH_DIRECTORY"
817 case "$TRASH_DIRECTORY" in
818 /*) ;; # absolute path is good
819  *) TRASH_DIRECTORY="$TEST_OUTPUT_DIRECTORY/$TRASH_DIRECTORY" ;;
820 esac
821 test ! -z "$debug" || remove_trash=$TRASH_DIRECTORY
822 rm -fr "$TRASH_DIRECTORY" || {
823         GIT_EXIT_OK=t
824         echo >&5 "FATAL: Cannot prepare test area"
825         exit 1
826 }
827
828 HOME="$TRASH_DIRECTORY"
829 GNUPGHOME="$HOME/gnupg-home-not-used"
830 export HOME GNUPGHOME
831
832 # run the tput tests *after* changing HOME (in case ncurses needs
833 # ~/.terminfo for $TERM)
834 test -n "${color+set}" || test "x$ORIGINAL_TERM" != "xdumb" && (
835                 TERM=$ORIGINAL_TERM &&
836                 export TERM &&
837                 test -t 1 &&
838                 tput bold >/dev/null 2>&1 &&
839                 tput setaf 1 >/dev/null 2>&1 &&
840                 tput sgr0 >/dev/null 2>&1
841         ) &&
842         color=t
843
844 if test -n "$color"
845 then
846         say_color () {
847                 (
848                 TERM=$ORIGINAL_TERM
849                 export TERM
850                 case "$1" in
851                 error)
852                         tput bold; tput setaf 1;; # bold red
853                 skip)
854                         tput setaf 4;; # blue
855                 warn)
856                         tput setaf 3;; # brown/yellow
857                 pass)
858                         tput setaf 2;; # green
859                 info)
860                         tput setaf 6;; # cyan
861                 *)
862                         test -n "$quiet" && return;;
863                 esac
864                 shift
865                 printf "%s" "$*"
866                 tput sgr0
867                 echo
868                 )
869         }
870 else
871         say_color() {
872                 test -z "$1" && test -n "$quiet" && return
873                 shift
874                 printf "%s\n" "$*"
875         }
876 fi
877
878 if test -z "$TEST_NO_CREATE_REPO"
879 then
880         test_create_repo "$TRASH_DIRECTORY"
881 else
882         mkdir -p "$TRASH_DIRECTORY"
883 fi
884 # Use -P to resolve symlinks in our working directory so that the cwd
885 # in subprocesses like git equals our $PWD (for pathname comparisons).
886 cd -P "$TRASH_DIRECTORY" || exit 1
887
888 this_test=${0##*/}
889 this_test=${this_test%%-*}
890 if match_pattern_list "$this_test" $GIT_SKIP_TESTS
891 then
892         say_color info >&3 "skipping test $this_test altogether"
893         skip_all="skip all tests in $this_test"
894         test_done
895 fi
896
897 # Provide an implementation of the 'yes' utility
898 yes () {
899         if test $# = 0
900         then
901                 y=y
902         else
903                 y="$*"
904         fi
905
906         while echo "$y"
907         do
908                 :
909         done
910 }
911
912 # Fix some commands on Windows
913 case $(uname -s) in
914 *MINGW*)
915         # Windows has its own (incompatible) sort and find
916         sort () {
917                 /usr/bin/sort "$@"
918         }
919         find () {
920                 /usr/bin/find "$@"
921         }
922         sum () {
923                 md5sum "$@"
924         }
925         # git sees Windows-style pwd
926         pwd () {
927                 builtin pwd -W
928         }
929         # no POSIX permissions
930         # backslashes in pathspec are converted to '/'
931         # exec does not inherit the PID
932         test_set_prereq MINGW
933         test_set_prereq NATIVE_CRLF
934         test_set_prereq SED_STRIPS_CR
935         test_set_prereq GREP_STRIPS_CR
936         GIT_TEST_CMP=mingw_test_cmp
937         ;;
938 *CYGWIN*)
939         test_set_prereq POSIXPERM
940         test_set_prereq EXECKEEPSPID
941         test_set_prereq CYGWIN
942         test_set_prereq SED_STRIPS_CR
943         test_set_prereq GREP_STRIPS_CR
944         ;;
945 *)
946         test_set_prereq POSIXPERM
947         test_set_prereq BSLASHPSPEC
948         test_set_prereq EXECKEEPSPID
949         ;;
950 esac
951
952 ( COLUMNS=1 && test $COLUMNS = 1 ) && test_set_prereq COLUMNS_CAN_BE_1
953 test -z "$NO_PERL" && test_set_prereq PERL
954 test -z "$NO_PYTHON" && test_set_prereq PYTHON
955 test -n "$USE_LIBPCRE" && test_set_prereq LIBPCRE
956 test -z "$NO_GETTEXT" && test_set_prereq GETTEXT
957
958 # Can we rely on git's output in the C locale?
959 if test -n "$GETTEXT_POISON"
960 then
961         GIT_GETTEXT_POISON=YesPlease
962         export GIT_GETTEXT_POISON
963         test_set_prereq GETTEXT_POISON
964 else
965         test_set_prereq C_LOCALE_OUTPUT
966 fi
967
968 # Use this instead of test_cmp to compare files that contain expected and
969 # actual output from git commands that can be translated.  When running
970 # under GETTEXT_POISON this pretends that the command produced expected
971 # results.
972 test_i18ncmp () {
973         test -n "$GETTEXT_POISON" || test_cmp "$@"
974 }
975
976 # Use this instead of "grep expected-string actual" to see if the
977 # output from a git command that can be translated either contains an
978 # expected string, or does not contain an unwanted one.  When running
979 # under GETTEXT_POISON this pretends that the command produced expected
980 # results.
981 test_i18ngrep () {
982         if test -n "$GETTEXT_POISON"
983         then
984             : # pretend success
985         elif test "x!" = "x$1"
986         then
987                 shift
988                 ! grep "$@"
989         else
990                 grep "$@"
991         fi
992 }
993
994 test_lazy_prereq PIPE '
995         # test whether the filesystem supports FIFOs
996         case $(uname -s) in
997         CYGWIN*)
998                 false
999                 ;;
1000         *)
1001                 rm -f testfifo && mkfifo testfifo
1002                 ;;
1003         esac
1004 '
1005
1006 test_lazy_prereq SYMLINKS '
1007         # test whether the filesystem supports symbolic links
1008         ln -s x y && test -h y
1009 '
1010
1011 test_lazy_prereq FILEMODE '
1012         test "$(git config --bool core.filemode)" = true
1013 '
1014
1015 test_lazy_prereq CASE_INSENSITIVE_FS '
1016         echo good >CamelCase &&
1017         echo bad >camelcase &&
1018         test "$(cat CamelCase)" != good
1019 '
1020
1021 test_lazy_prereq UTF8_NFD_TO_NFC '
1022         # check whether FS converts nfd unicode to nfc
1023         auml=$(printf "\303\244")
1024         aumlcdiar=$(printf "\141\314\210")
1025         >"$auml" &&
1026         case "$(echo *)" in
1027         "$aumlcdiar")
1028                 true ;;
1029         *)
1030                 false ;;
1031         esac
1032 '
1033
1034 test_lazy_prereq AUTOIDENT '
1035         sane_unset GIT_AUTHOR_NAME &&
1036         sane_unset GIT_AUTHOR_EMAIL &&
1037         git var GIT_AUTHOR_IDENT
1038 '
1039
1040 test_lazy_prereq EXPENSIVE '
1041         test -n "$GIT_TEST_LONG"
1042 '
1043
1044 test_lazy_prereq USR_BIN_TIME '
1045         test -x /usr/bin/time
1046 '
1047
1048 test_lazy_prereq NOT_ROOT '
1049         uid=$(id -u) &&
1050         test "$uid" != 0
1051 '
1052
1053 # On a filesystem that lacks SANITY, a file can be deleted even if
1054 # the containing directory doesn't have write permissions, or a file
1055 # can be accessed even if the containing directory doesn't have read
1056 # or execute permissions, causing our tests that validate that Git
1057 # works sensibly in such situations.
1058 test_lazy_prereq SANITY '
1059         mkdir SANETESTD.1 SANETESTD.2 &&
1060
1061         chmod +w SANETESTD.1 SANETESTD.2 &&
1062         >SANETESTD.1/x 2>SANETESTD.2/x &&
1063         chmod -w SANETESTD.1 &&
1064         chmod -rx SANETESTD.2 ||
1065         error "bug in test sript: cannot prepare SANETESTD"
1066
1067         ! rm SANETESTD.1/x && ! test -f SANETESTD.2/x
1068         status=$?
1069
1070         chmod +rwx SANETESTD.1 SANETESTD.2 &&
1071         rm -rf SANETESTD.1 SANETESTD.2 ||
1072         error "bug in test sript: cannot clean SANETESTD"
1073         return $status
1074 '
1075
1076 GIT_UNZIP=${GIT_UNZIP:-unzip}
1077 test_lazy_prereq UNZIP '
1078         "$GIT_UNZIP" -v
1079         test $? -ne 127
1080 '
1081
1082 run_with_limited_cmdline () {
1083         (ulimit -s 128 && "$@")
1084 }
1085
1086 test_lazy_prereq CMDLINE_LIMIT 'run_with_limited_cmdline true'