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