introduce GIT_INDEX_VERSION environment variable
[git/git.git] / t / test-lib.sh
CommitLineData
c74c7203 1# Test framework for git. See t/README for usage.
e1970ce4
JH
2#
3# Copyright (c) 2005 Junio C Hamano
4#
64b90323
MS
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/ .
e1970ce4 17
c2116a17
JH
18# Keep the original TERM for say_color
19ORIGINAL_TERM=$TERM
20
3c8f12c9
JH
21# Test the binaries we have just built. The tests are kept in
22# t/ subdirectory and are run in 'trash directory' subdirectory.
23if test -z "$TEST_DIRECTORY"
24then
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)
85176d72
FC
29else
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
3c8f12c9
JH
33fi
34if test -z "$TEST_OUTPUT_DIRECTORY"
35then
36 # Similarly, override this to store the test-results subdir
37 # elsewhere
38 TEST_OUTPUT_DIRECTORY=$TEST_DIRECTORY
39fi
40GIT_BUILD_DIR="$TEST_DIRECTORY"/..
41
2006f0ad
RR
42################################################################
43# It appears that people try to run tests without building...
44"$GIT_BUILD_DIR/git" >/dev/null
45if test $? != 1
46then
47 echo >&2 'error: you do not seem to have built git yet.'
48 exit 1
49fi
50
3c8f12c9
JH
51. "$GIT_BUILD_DIR"/GIT-BUILD-OPTIONS
52export PERL_PATH SHELL_PATH
53
4cde519f
RR
54# if --tee was passed, write the output not only to the terminal, but
55# additionally to the file test-results/$BASENAME.out, too.
56case "$GIT_TEST_TEE_STARTED, $* " in
57done,*)
58 # do not redirect again
59 ;;
60*' --tee '*|*' --va'*)
2d14e13c
JK
61 mkdir -p "$TEST_OUTPUT_DIRECTORY/test-results"
62 BASE="$TEST_OUTPUT_DIRECTORY/test-results/$(basename "$0" .sh)"
4cde519f
RR
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 ;;
68esac
69
e1970ce4
JH
70# For repeatability, reset the environment to known value.
71LANG=C
899460f3 72LC_ALL=C
d9bdd39e 73PAGER=cat
e1970ce4 74TZ=UTC
c2116a17
JH
75TERM=dumb
76export LANG LC_ALL PAGER TERM TZ
8ff99e74 77EDITOR=:
661bfd13
SL
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.
3c8f12c9 82unset VISUAL EMAIL LANGUAGE COLUMNS $("$PERL_PATH" -e '
95a1d12e 83 my @env = keys %ENV;
730477f1
JL
84 my $ok = join("|", qw(
85 TRACE
86 DEBUG
87 USE_LOOKUP
88 TEST
89 .*_TEST
90 PROVE
91 VALGRIND
ac001282 92 UNZIP
edb54081 93 PERF_
730477f1
JL
94 ));
95 my @vars = grep(/^GIT_/ && !/^GIT_($ok)/o, @env);
95a1d12e
JN
96 print join("\n", @vars);
97')
5adf84eb 98unset XDG_CONFIG_HOME
8bade1e1 99unset GITPERLLIB
29e55cd5
JH
100GIT_AUTHOR_EMAIL=author@example.com
101GIT_AUTHOR_NAME='A U Thor'
29e55cd5
JH
102GIT_COMMITTER_EMAIL=committer@example.com
103GIT_COMMITTER_NAME='C O Mitter'
8d0fc48f 104GIT_MERGE_VERBOSITY=5
f8246281
JH
105GIT_MERGE_AUTOEDIT=no
106export GIT_MERGE_VERBOSITY GIT_MERGE_AUTOEDIT
29e55cd5
JH
107export GIT_AUTHOR_EMAIL GIT_AUTHOR_NAME
108export GIT_COMMITTER_EMAIL GIT_COMMITTER_NAME
d33738d7 109export EDITOR
e1970ce4 110
a731fa91
EP
111# Add libc MALLOC and MALLOC_PERTURB test
112# only if we are not executing the test with valgrind
1b3185fc 113if expr " $GIT_TEST_OPTS " : ".* --valgrind " >/dev/null ||
ee1431bf 114 test -n "$TEST_NO_MALLOC_CHECK"
1b3185fc
JH
115then
116 setup_malloc_check () {
117 : nothing
118 }
119 teardown_malloc_check () {
120 : nothing
121 }
122else
123 setup_malloc_check () {
124 MALLOC_CHECK_=3 MALLOC_PERTURB_=165
125 export MALLOC_CHECK_ MALLOC_PERTURB_
126 }
127 teardown_malloc_check () {
128 unset MALLOC_CHECK_ MALLOC_PERTURB_
129 }
130fi
a731fa91 131
886a3907
JH
132# Protect ourselves from common misconfiguration to export
133# CDPATH into the environment
134unset CDPATH
135
5565f47c 136unset GREP_OPTIONS
ac001282 137unset UNZIP
5565f47c 138
3d5c0cc9 139case $(echo $GIT_TRACE |tr "[A-Z]" "[a-z]") in
1c0cc756
RJ
1401|2|true)
141 echo "* warning: Some tests will not work if GIT_TRACE" \
142 "is set as to trace on STDERR ! *"
143 echo "* warning: Please set GIT_TRACE to something" \
144 "other than 1, 2 or true ! *"
145 ;;
6ce4e61f
CC
146esac
147
cd3c095c
JH
148# Convenience
149#
150# A regexp to match 5 and 40 hexdigits
151_x05='[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
152_x40="$_x05$_x05$_x05$_x05$_x05$_x05$_x05$_x05"
153
3749fde5
JH
154# Zero SHA-1
155_z40=0000000000000000000000000000000000000000
156
3f4ab627
JH
157# Line feed
158LF='
159'
160
342e9ef2
TR
161export _x05 _x40 _z40 LF
162
e1970ce4
JH
163# Each test should start with something like this, after copyright notices:
164#
165# test_description='Description of this test...
166# This test checks if command xyzzy does the right thing...
167# '
168# . ./test-lib.sh
c2116a17
JH
169[ "x$ORIGINAL_TERM" != "xdumb" ] && (
170 TERM=$ORIGINAL_TERM &&
171 export TERM &&
172 [ -t 1 ] &&
173 tput bold >/dev/null 2>&1 &&
174 tput setaf 1 >/dev/null 2>&1 &&
175 tput sgr0 >/dev/null 2>&1
176 ) &&
55db1df0 177 color=t
e1970ce4 178
e1970ce4
JH
179while test "$#" -ne 0
180do
181 case "$1" in
182 -d|--d|--de|--deb|--debu|--debug)
183 debug=t; shift ;;
886856ab
JH
184 -i|--i|--im|--imm|--imme|--immed|--immedi|--immedia|--immediat|--immediate)
185 immediate=t; shift ;;
5e2c08c6 186 -l|--l|--lo|--lon|--long|--long-|--long-t|--long-te|--long-tes|--long-test|--long-tests)
91e80b98 187 GIT_TEST_LONG=t; export GIT_TEST_LONG; shift ;;
e1970ce4 188 -h|--h|--he|--hel|--help)
570f3226 189 help=t; shift ;;
e1970ce4
JH
190 -v|--v|--ve|--ver|--verb|--verbo|--verbos|--verbose)
191 verbose=t; shift ;;
ff09af3f
TR
192 --verbose-only=*)
193 verbose_only=$(expr "z$1" : 'z[^=]*=\(.*\)')
194 shift ;;
1ece1274 195 -q|--q|--qu|--qui|--quie|--quiet)
092c4334
ÆAB
196 # Ignore --quiet under a TAP::Harness. Saying how many tests
197 # passed without the ok/not ok details is always an error.
198 test -z "$HARNESS_ACTIVE" && quiet=t; shift ;;
e4597aae
MO
199 --with-dashes)
200 with_dashes=t; shift ;;
55db1df0 201 --no-color)
faa4bc35 202 color=; shift ;;
4e1be63c 203 --va|--val|--valg|--valgr|--valgri|--valgrin|--valgrind)
952af351
TR
204 valgrind=memcheck
205 shift ;;
206 --valgrind=*)
207 valgrind=$(expr "z$1" : 'z[^=]*=\(.*\)')
208 shift ;;
5dfc368f
TR
209 --valgrind-only=*)
210 valgrind_only=$(expr "z$1" : 'z[^=]*=\(.*\)')
211 shift ;;
44138559
JS
212 --tee)
213 shift ;; # was handled already
f423ef5f
JK
214 --root=*)
215 root=$(expr "z$1" : 'z[^=]*=\(.*\)')
216 shift ;;
e1970ce4 217 *)
1f729dca 218 echo "error: unknown test option '$1'" >&2; exit 1 ;;
e1970ce4
JH
219 esac
220done
221
26a07309 222if test -n "$valgrind_only"
5dfc368f
TR
223then
224 test -z "$valgrind" && valgrind=memcheck
225 test -z "$verbose" && verbose_only="$valgrind_only"
226elif test -n "$valgrind"
227then
228 verbose=t
229fi
952af351 230
1c0cc756
RJ
231if test -n "$color"
232then
55db1df0 233 say_color () {
c2116a17
JH
234 (
235 TERM=$ORIGINAL_TERM
236 export TERM
55db1df0 237 case "$1" in
1c0cc756
RJ
238 error)
239 tput bold; tput setaf 1;; # bold red
240 skip)
b8fc855a 241 tput setaf 4;; # blue
e8e51955
AS
242 warn)
243 tput setaf 3;; # brown/yellow
1c0cc756 244 pass)
0a6d4751 245 tput setaf 2;; # green
1c0cc756 246 info)
0a6d4751 247 tput setaf 6;; # cyan
1c0cc756
RJ
248 *)
249 test -n "$quiet" && return;;
55db1df0
PH
250 esac
251 shift
5099b99d 252 printf "%s" "$*"
55db1df0 253 tput sgr0
b8eecafd 254 echo
c2116a17 255 )
55db1df0
PH
256 }
257else
258 say_color() {
1ece1274 259 test -z "$1" && test -n "$quiet" && return
55db1df0 260 shift
7bc0911d 261 printf "%s\n" "$*"
55db1df0
PH
262 }
263fi
264
265error () {
266 say_color error "error: $*"
6e7b5aaf 267 GIT_EXIT_OK=t
55db1df0
PH
268 exit 1
269}
270
271say () {
272 say_color info "$*"
273}
274
570f3226
MB
275test "${test_description}" != "" ||
276error "Test script did not set test_description."
277
278if test "$help" = "t"
279then
280 echo "$test_description"
281 exit 0
282fi
283
4d9d62fa 284exec 5>&1
781f76b1 285exec 6<&0
e1970ce4
JH
286if test "$verbose" = "t"
287then
288 exec 4>&2 3>&1
289else
290 exec 4>/dev/null 3>/dev/null
291fi
292
293test_failure=0
294test_count=0
41ac414e
JH
295test_fixed=0
296test_broken=0
2d84e9fb 297test_success=0
e1970ce4 298
d998bd4a
ÆAB
299test_external_has_tap=0
300
faa4bc35 301die () {
6e7b5aaf
CB
302 code=$?
303 if test -n "$GIT_EXIT_OK"
304 then
305 exit $code
306 else
307 echo >&5 "FATAL: Unexpected exit with code $code"
308 exit 1
309 fi
faa4bc35
CB
310}
311
6e7b5aaf 312GIT_EXIT_OK=
35641310 313trap 'die' EXIT
41184273 314
12a29b1a
TR
315# The user-facing functions are loaded from a separate file so that
316# test_perf subshells can have them too
3c8f12c9 317. "$TEST_DIRECTORY/test-lib-functions.sh"
05236a5e 318
886856ab 319# You are not expected to call test_ok_ and test_failure_ directly, use
3fa36666 320# the test_expect_* functions instead.
886856ab
JH
321
322test_ok_ () {
d5d9de1b 323 test_success=$(($test_success + 1))
633fe50a 324 say_color "" "ok $test_count - $@"
e1970ce4
JH
325}
326
886856ab 327test_failure_ () {
d5d9de1b 328 test_failure=$(($test_failure + 1))
633fe50a 329 say_color error "not ok $test_count - $1"
bf0dd8a8 330 shift
5099b99d 331 echo "$@" | sed -e 's/^/# /'
6e7b5aaf 332 test "$immediate" = "" || { GIT_EXIT_OK=t; exit 1; }
886856ab
JH
333}
334
41ac414e 335test_known_broken_ok_ () {
41ac414e 336 test_fixed=$(($test_fixed+1))
633fe50a 337 say_color error "ok $test_count - $@ # TODO known breakage vanished"
41ac414e
JH
338}
339
340test_known_broken_failure_ () {
41ac414e 341 test_broken=$(($test_broken+1))
633fe50a 342 say_color warn "not ok $test_count - $@ # TODO known breakage"
41ac414e 343}
886856ab
JH
344
345test_debug () {
8e832ebc 346 test "$debug" = "" || eval "$1"
e1970ce4
JH
347}
348
e6a6ddc9
TR
349match_pattern_list () {
350 arg="$1"
351 shift
352 test -z "$*" && return 1
353 for pattern_
354 do
355 case "$arg" in
356 $pattern_)
357 return 0
358 esac
359 done
360 return 1
361}
362
ff09af3f
TR
363maybe_teardown_verbose () {
364 test -z "$verbose_only" && return
365 exec 4>/dev/null 3>/dev/null
366 verbose=
367}
368
369last_verbose=t
370maybe_setup_verbose () {
371 test -z "$verbose_only" && return
26a07309 372 if match_pattern_list $test_count $verbose_only
ff09af3f
TR
373 then
374 exec 4>&2 3>&1
375 # Emit a delimiting blank line when going from
376 # non-verbose to verbose. Within verbose mode the
377 # delimiter is printed by test_expect_*. The choice
378 # of the initial $last_verbose is such that before
379 # test 1, we do not print it.
380 test -z "$last_verbose" && echo >&3 ""
381 verbose=t
382 else
383 exec 4>/dev/null 3>/dev/null
384 verbose=
385 fi
386 last_verbose=$verbose
387}
388
5dfc368f
TR
389maybe_teardown_valgrind () {
390 test -z "$GIT_VALGRIND" && return
391 GIT_VALGRIND_ENABLED=
392}
393
394maybe_setup_valgrind () {
395 test -z "$GIT_VALGRIND" && return
26a07309 396 if test -z "$valgrind_only"
5dfc368f
TR
397 then
398 GIT_VALGRIND_ENABLED=t
399 return
400 fi
401 GIT_VALGRIND_ENABLED=
402 if match_pattern_list $test_count $valgrind_only
403 then
404 GIT_VALGRIND_ENABLED=t
405 fi
406}
407
a7c58f28
JN
408test_eval_ () {
409 # This is a separate function because some tests use
410 # "return" to end a test_expect_success block early.
781f76b1 411 eval </dev/null >&3 2>&4 "$*"
a7c58f28
JN
412}
413
4d9d62fa 414test_run_ () {
b6b0afdc 415 test_cleanup=:
b586744a 416 expecting_failure=$2
a57397b0 417 setup_malloc_check
a7c58f28 418 test_eval_ "$1"
b6b0afdc 419 eval_ret=$?
a57397b0 420 teardown_malloc_check
b586744a
JH
421
422 if test -z "$immediate" || test $eval_ret = 0 || test -n "$expecting_failure"
423 then
1b3185fc 424 setup_malloc_check
a7c58f28 425 test_eval_ "$test_cleanup"
1b3185fc 426 teardown_malloc_check
b586744a 427 fi
1c0cc756
RJ
428 if test "$verbose" = "t" && test -n "$HARNESS_ACTIVE"
429 then
57e1538a
ÆAB
430 echo ""
431 fi
aa0bcf96 432 return "$eval_ret"
4d9d62fa
PR
433}
434
ae75342c 435test_start_ () {
8586f98b 436 test_count=$(($test_count+1))
ff09af3f 437 maybe_setup_verbose
5dfc368f 438 maybe_setup_valgrind
ae75342c
TR
439}
440
441test_finish_ () {
442 echo >&3 ""
5dfc368f 443 maybe_teardown_valgrind
ff09af3f 444 maybe_teardown_verbose
ae75342c
TR
445}
446
447test_skip () {
04ece593 448 to_skip=
e6a6ddc9
TR
449 if match_pattern_list $this_test.$test_count $GIT_SKIP_TESTS
450 then
451 to_skip=t
452 fi
05236a5e
JN
453 if test -z "$to_skip" && test -n "$test_prereq" &&
454 ! test_have_prereq "$test_prereq"
a7bb3940
JS
455 then
456 to_skip=t
457 fi
04ece593
JH
458 case "$to_skip" in
459 t)
07431fc8 460 of_prereq=
05236a5e 461 if test "$missing_prereq" != "$test_prereq"
07431fc8 462 then
05236a5e 463 of_prereq=" of $test_prereq"
07431fc8
JN
464 fi
465
633fe50a
TR
466 say_color skip >&3 "skipping test: $@"
467 say_color skip "ok $test_count # skip $1 (missing $missing_prereq${of_prereq})"
04ece593
JH
468 : true
469 ;;
470 *)
471 false
472 ;;
473 esac
474}
475
342e9ef2
TR
476# stub; perf-lib overrides it
477test_at_end_hook_ () {
478 :
479}
480
e1970ce4 481test_done () {
6e7b5aaf 482 GIT_EXIT_OK=t
2d84e9fb 483
1c0cc756
RJ
484 if test -z "$HARNESS_ACTIVE"
485 then
342e9ef2 486 test_results_dir="$TEST_OUTPUT_DIRECTORY/test-results"
8ef1abe5 487 mkdir -p "$test_results_dir"
dd78478f
FC
488 base=${0##*/}
489 test_results_path="$test_results_dir/${base%.sh}-$$.counts"
8ef1abe5 490
c54e6be7
ML
491 cat >>"$test_results_path" <<-EOF
492 total $test_count
493 success $test_success
494 fixed $test_fixed
495 broken $test_broken
496 failed $test_failure
497
498 EOF
8ef1abe5 499 fi
41ac414e
JH
500
501 if test "$test_fixed" != 0
502 then
633fe50a 503 say_color error "# $test_fixed known breakage(s) vanished; please update test(s)"
41ac414e
JH
504 fi
505 if test "$test_broken" != 0
506 then
633fe50a 507 say_color warn "# still have $test_broken known breakage(s)"
b73d9a23
AS
508 fi
509 if test "$test_broken" != 0 || test "$test_fixed" != 0
510 then
511 test_remaining=$(( $test_count - $test_broken - $test_fixed ))
512 msg="remaining $test_remaining test(s)"
11d54b8b 513 else
b73d9a23 514 test_remaining=$test_count
11d54b8b 515 msg="$test_count test(s)"
41ac414e 516 fi
e1970ce4 517 case "$test_failure" in
10b94e28 518 0)
5099b99d 519 # Maybe print SKIP message
bf4b7219
RJ
520 if test -n "$skip_all" && test $test_count -gt 0
521 then
522 error "Can't use skip_all after running some tests"
523 fi
5099b99d
ÆAB
524 [ -z "$skip_all" ] || skip_all=" # SKIP $skip_all"
525
1c0cc756
RJ
526 if test $test_external_has_tap -eq 0
527 then
b73d9a23 528 if test $test_remaining -gt 0
d87bd7c1 529 then
633fe50a 530 say_color pass "# passed all $msg"
d87bd7c1 531 fi
633fe50a 532 say "1..$test_count$skip_all"
d998bd4a 533 fi
abc5d372
JS
534
535 test -d "$remove_trash" &&
536 cd "$(dirname "$remove_trash")" &&
537 rm -rf "$(basename "$remove_trash")"
538
342e9ef2
TR
539 test_at_end_hook_
540
e1970ce4
JH
541 exit 0 ;;
542
543 *)
1c0cc756
RJ
544 if test $test_external_has_tap -eq 0
545 then
633fe50a
TR
546 say_color error "# failed $test_failure among $msg"
547 say "1..$test_count"
d998bd4a 548 fi
5099b99d 549
e1970ce4
JH
550 exit 1 ;;
551
552 esac
553}
554
e4597aae 555if test -n "$valgrind"
4e1be63c 556then
4e1be63c
JS
557 make_symlink () {
558 test -h "$2" &&
559 test "$1" = "$(readlink "$2")" || {
560 # be super paranoid
561 if mkdir "$2".lock
562 then
563 rm -f "$2" &&
564 ln -s "$1" "$2" &&
565 rm -r "$2".lock
566 else
567 while test -d "$2".lock
568 do
569 say "Waiting for lock on $2."
570 sleep 1
571 done
572 fi
573 }
574 }
575
576 make_valgrind_symlink () {
36bfb0e5 577 # handle only executables, unless they are shell libraries that
11d62145 578 # need to be in the exec-path.
36bfb0e5 579 test -x "$1" ||
11d62145 580 test "# " = "$(head -c 2 <"$1")" ||
36bfb0e5 581 return;
4e1be63c
JS
582
583 base=$(basename "$1")
6cec5c68 584 symlink_target=$GIT_BUILD_DIR/$base
4e1be63c
JS
585 # do not override scripts
586 if test -x "$symlink_target" &&
587 test ! -d "$symlink_target" &&
588 test "#!" != "$(head -c 2 < "$symlink_target")"
589 then
590 symlink_target=../valgrind.sh
591 fi
efd92ffd
JS
592 case "$base" in
593 *.sh|*.perl)
594 symlink_target=../unprocessed-script
595 esac
4e1be63c
JS
596 # create the link, or replace it if it is out of date
597 make_symlink "$symlink_target" "$GIT_VALGRIND/bin/$base" || exit
598 }
599
26a07309
TR
600 # override all git executables in TEST_DIRECTORY/..
601 GIT_VALGRIND=$TEST_DIRECTORY/valgrind
602 mkdir -p "$GIT_VALGRIND"/bin
603 for file in $GIT_BUILD_DIR/git* $GIT_BUILD_DIR/test-*
604 do
605 make_valgrind_symlink $file
606 done
607 # special-case the mergetools loadables
608 make_symlink "$GIT_BUILD_DIR"/mergetools "$GIT_VALGRIND/bin/mergetools"
609 OLDIFS=$IFS
610 IFS=:
611 for path in $PATH
612 do
613 ls "$path"/git-* 2> /dev/null |
614 while read file
ad0e6233 615 do
26a07309 616 make_valgrind_symlink "$file"
ad0e6233 617 done
26a07309
TR
618 done
619 IFS=$OLDIFS
4e1be63c
JS
620 PATH=$GIT_VALGRIND/bin:$PATH
621 GIT_EXEC_PATH=$GIT_VALGRIND/bin
622 export GIT_VALGRIND
952af351
TR
623 GIT_VALGRIND_MODE="$valgrind"
624 export GIT_VALGRIND_MODE
5dfc368f 625 GIT_VALGRIND_ENABLED=t
26a07309 626 test -n "$valgrind_only" && GIT_VALGRIND_ENABLED=
5dfc368f 627 export GIT_VALGRIND_ENABLED
1c0cc756
RJ
628elif test -n "$GIT_TEST_INSTALLED"
629then
e4597aae
MO
630 GIT_EXEC_PATH=$($GIT_TEST_INSTALLED/git --exec-path) ||
631 error "Cannot run git from $GIT_TEST_INSTALLED."
6cec5c68 632 PATH=$GIT_TEST_INSTALLED:$GIT_BUILD_DIR:$PATH
e4597aae
MO
633 GIT_EXEC_PATH=${GIT_TEST_EXEC_PATH:-$GIT_EXEC_PATH}
634else # normal case, use ../bin-wrappers only unless $with_dashes:
6cec5c68 635 git_bin_dir="$GIT_BUILD_DIR/bin-wrappers"
1c0cc756
RJ
636 if ! test -x "$git_bin_dir/git"
637 then
638 if test -z "$with_dashes"
639 then
e4597aae
MO
640 say "$git_bin_dir/git is not executable; using GIT_EXEC_PATH"
641 fi
642 with_dashes=t
643 fi
644 PATH="$git_bin_dir:$PATH"
6cec5c68 645 GIT_EXEC_PATH=$GIT_BUILD_DIR
1c0cc756
RJ
646 if test -n "$with_dashes"
647 then
6cec5c68 648 PATH="$GIT_BUILD_DIR:$PATH"
e4597aae 649 fi
4e1be63c 650fi
6cec5c68 651GIT_TEMPLATE_DIR="$GIT_BUILD_DIR"/templates/blt
8bfa6bd6 652unset GIT_CONFIG
8bfa6bd6 653GIT_CONFIG_NOSYSTEM=1
3c995beb 654GIT_ATTR_NOSYSTEM=1
8f323c00 655export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG_NOSYSTEM GIT_ATTR_NOSYSTEM
49ccb087 656
5e87eae9
JH
657if test -z "$GIT_TEST_CMP"
658then
659 if test -n "$GIT_TEST_CMP_USE_COPIED_CONTEXT"
660 then
661 GIT_TEST_CMP="$DIFF -c"
662 else
663 GIT_TEST_CMP="$DIFF -u"
664 fi
665fi
666
6cec5c68 667GITPERLLIB="$GIT_BUILD_DIR"/perl/blib/lib:"$GIT_BUILD_DIR"/perl/blib/arch/auto/Git
6fcca938 668export GITPERLLIB
6cec5c68 669test -d "$GIT_BUILD_DIR"/templates/blt || {
eea42069
JH
670 error "You haven't built things yet, have you?"
671}
e1970ce4 672
1c0cc756
RJ
673if ! test -x "$GIT_BUILD_DIR"/test-chmtime
674then
56cf9806
EW
675 echo >&2 'You need to build test-chmtime:'
676 echo >&2 'Run "make test-chmtime" in the source (toplevel) directory'
677 exit 1
678fi
679
e1970ce4 680# Test repository
002d4ce8
JK
681TRASH_DIRECTORY="trash directory.$(basename "$0" .sh)"
682test -n "$root" && TRASH_DIRECTORY="$root/$TRASH_DIRECTORY"
683case "$TRASH_DIRECTORY" in
684/*) ;; # absolute path is good
685 *) TRASH_DIRECTORY="$TEST_OUTPUT_DIRECTORY/$TRASH_DIRECTORY" ;;
f423ef5f 686esac
91c8b825 687test ! -z "$debug" || remove_trash=$TRASH_DIRECTORY
38b074de 688rm -fr "$TRASH_DIRECTORY" || {
6e7b5aaf 689 GIT_EXIT_OK=t
8d14ac94
JH
690 echo >&5 "FATAL: Cannot prepare test area"
691 exit 1
692}
693
90cff968
AR
694HOME="$TRASH_DIRECTORY"
695export HOME
696
1c0cc756
RJ
697if test -z "$TEST_NO_CREATE_REPO"
698then
38b074de 699 test_create_repo "$TRASH_DIRECTORY"
342e9ef2 700else
38b074de 701 mkdir -p "$TRASH_DIRECTORY"
342e9ef2 702fi
1bd9c648
LW
703# Use -P to resolve symlinks in our working directory so that the cwd
704# in subprocesses like git equals our $PWD (for pathname comparisons).
38b074de 705cd -P "$TRASH_DIRECTORY" || exit 1
04ece593 706
d5d9de1b
JS
707this_test=${0##*/}
708this_test=${this_test%%-*}
e6a6ddc9
TR
709if match_pattern_list "$this_test" $GIT_SKIP_TESTS
710then
711 say_color info >&3 "skipping test $this_test altogether"
712 skip_all="skip all tests in $this_test"
713 test_done
714fi
f17e9fbb 715
8648732e
BC
716# Provide an implementation of the 'yes' utility
717yes () {
718 if test $# = 0
719 then
720 y=y
721 else
722 y="$*"
723 fi
724
725 while echo "$y"
726 do
727 :
728 done
729}
730
f17e9fbb
JS
731# Fix some commands on Windows
732case $(uname -s) in
733*MINGW*)
734 # Windows has its own (incompatible) sort and find
735 sort () {
736 /usr/bin/sort "$@"
737 }
738 find () {
739 /usr/bin/find "$@"
740 }
5397ea31
JS
741 sum () {
742 md5sum "$@"
743 }
4114156a
JS
744 # git sees Windows-style pwd
745 pwd () {
746 builtin pwd -W
747 }
ee9fb68c 748 # no POSIX permissions
6fd1106a 749 # backslashes in pathspec are converted to '/'
fb9a2bea 750 # exec does not inherit the PID
a94114ad 751 test_set_prereq MINGW
cfa96496 752 test_set_prereq NOT_CYGWIN
a31d0665 753 test_set_prereq SED_STRIPS_CR
97669eed 754 test_set_prereq GREP_STRIPS_CR
4d715ac0 755 GIT_TEST_CMP=mingw_test_cmp
a31d0665
RJ
756 ;;
757*CYGWIN*)
758 test_set_prereq POSIXPERM
a31d0665
RJ
759 test_set_prereq EXECKEEPSPID
760 test_set_prereq NOT_MINGW
cfa96496 761 test_set_prereq CYGWIN
a31d0665 762 test_set_prereq SED_STRIPS_CR
97669eed 763 test_set_prereq GREP_STRIPS_CR
ee9fb68c
JS
764 ;;
765*)
766 test_set_prereq POSIXPERM
6fd1106a 767 test_set_prereq BSLASHPSPEC
fb9a2bea 768 test_set_prereq EXECKEEPSPID
3ba9ba8f 769 test_set_prereq NOT_MINGW
cfa96496 770 test_set_prereq NOT_CYGWIN
f17e9fbb
JS
771 ;;
772esac
704a3143 773
b082687c 774( COLUMNS=1 && test $COLUMNS = 1 ) && test_set_prereq COLUMNS_CAN_BE_1
1b19ccd2 775test -z "$NO_PERL" && test_set_prereq PERL
d4e1b47a 776test -z "$NO_PYTHON" && test_set_prereq PYTHON
8f852ce6 777test -n "$USE_LIBPCRE" && test_set_prereq LIBPCRE
5e9637c6 778test -z "$NO_GETTEXT" && test_set_prereq GETTEXT
1b19ccd2 779
bb946bba 780# Can we rely on git's output in the C locale?
30955229
JN
781if test -n "$GETTEXT_POISON"
782then
783 GIT_GETTEXT_POISON=YesPlease
784 export GIT_GETTEXT_POISON
5e9637c6 785 test_set_prereq GETTEXT_POISON
30955229
JN
786else
787 test_set_prereq C_LOCALE_OUTPUT
788fi
bb946bba 789
cabdee2c
JH
790# Use this instead of test_cmp to compare files that contain expected and
791# actual output from git commands that can be translated. When running
792# under GETTEXT_POISON this pretends that the command produced expected
793# results.
794test_i18ncmp () {
795 test -n "$GETTEXT_POISON" || test_cmp "$@"
796}
797
127df8c6
JH
798# Use this instead of "grep expected-string actual" to see if the
799# output from a git command that can be translated either contains an
800# expected string, or does not contain an unwanted one. When running
801# under GETTEXT_POISON this pretends that the command produced expected
802# results.
803test_i18ngrep () {
804 if test -n "$GETTEXT_POISON"
805 then
806 : # pretend success
807 elif test "x!" = "x$1"
808 then
809 shift
810 ! grep "$@"
811 else
812 grep "$@"
813 fi
814}
815
20073274
AS
816test_lazy_prereq PIPE '
817 # test whether the filesystem supports FIFOs
9443605b
ML
818 case $(uname -s) in
819 CYGWIN*)
820 false
821 ;;
822 *)
823 rm -f testfifo && mkfifo testfifo
824 ;;
825 esac
20073274
AS
826'
827
04083f27
JH
828test_lazy_prereq SYMLINKS '
829 # test whether the filesystem supports symbolic links
830 ln -s x y && test -h y
831'
c91cfd19 832
b018c735
JN
833test_lazy_prereq FILEMODE '
834 test "$(git config --bool core.filemode)" = true
835'
836
ac39aa61
MG
837test_lazy_prereq CASE_INSENSITIVE_FS '
838 echo good >CamelCase &&
839 echo bad >camelcase &&
840 test "$(cat CamelCase)" != good
841'
842
5b0b5dd4
MG
843test_lazy_prereq UTF8_NFD_TO_NFC '
844 # check whether FS converts nfd unicode to nfc
845 auml=$(printf "\303\244")
846 aumlcdiar=$(printf "\141\314\210")
847 >"$auml" &&
848 case "$(echo *)" in
849 "$aumlcdiar")
850 true ;;
851 *)
852 false ;;
853 esac
854'
855
09feffb6
JK
856test_lazy_prereq AUTOIDENT '
857 sane_unset GIT_AUTHOR_NAME &&
858 sane_unset GIT_AUTHOR_EMAIL &&
859 git var GIT_AUTHOR_IDENT
860'
861
c91cfd19
ÆAB
862# When the tests are run as root, permission tests will report that
863# things are writable when they shouldn't be.
864test -w / || test_set_prereq SANITY
f838ce58
JK
865
866GIT_UNZIP=${GIT_UNZIP:-unzip}
867test_lazy_prereq UNZIP '
868 "$GIT_UNZIP" -v
869 test $? -ne 127
870'