Merge branch 'js/test-git-installed'
[git/git.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 # Test the binaries we have just built. The tests are kept in
19 # t/ subdirectory and are run in 'trash directory' subdirectory.
20 if test -z "$TEST_DIRECTORY"
21 then
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)
26 else
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
30 fi
31 if test -z "$TEST_OUTPUT_DIRECTORY"
32 then
33 # Similarly, override this to store the test-results subdir
34 # elsewhere
35 TEST_OUTPUT_DIRECTORY=$TEST_DIRECTORY
36 fi
37 GIT_BUILD_DIR="$TEST_DIRECTORY"/..
38
39 # If we were built with ASAN, it may complain about leaks
40 # of program-lifetime variables. Disable it by default to lower
41 # the noise level. This needs to happen at the start of the script,
42 # before we even do our "did we build git yet" check (since we don't
43 # want that one to complain to stderr).
44 : ${ASAN_OPTIONS=detect_leaks=0:abort_on_error=1}
45 export ASAN_OPTIONS
46
47 # If LSAN is in effect we _do_ want leak checking, but we still
48 # want to abort so that we notice the problems.
49 : ${LSAN_OPTIONS=abort_on_error=1}
50 export LSAN_OPTIONS
51
52 if test ! -f "$GIT_BUILD_DIR"/GIT-BUILD-OPTIONS
53 then
54 echo >&2 'error: GIT-BUILD-OPTIONS missing (has Git been built?).'
55 exit 1
56 fi
57 . "$GIT_BUILD_DIR"/GIT-BUILD-OPTIONS
58 export PERL_PATH SHELL_PATH
59
60 ################################################################
61 # It appears that people try to run tests without building...
62 "${GIT_TEST_INSTALLED:-$GIT_BUILD_DIR}/git$X" >/dev/null
63 if test $? != 1
64 then
65 if test -n "$GIT_TEST_INSTALLED"
66 then
67 echo >&2 "error: there is no working Git at '$GIT_TEST_INSTALLED'"
68 else
69 echo >&2 'error: you do not seem to have built git yet.'
70 fi
71 exit 1
72 fi
73
74 # if --tee was passed, write the output not only to the terminal, but
75 # additionally to the file test-results/$BASENAME.out, too.
76 case "$GIT_TEST_TEE_STARTED, $* " in
77 done,*)
78 # do not redirect again
79 ;;
80 *' --tee '*|*' --va'*|*' -V '*|*' --verbose-log '*)
81 mkdir -p "$TEST_OUTPUT_DIRECTORY/test-results"
82 BASE="$TEST_OUTPUT_DIRECTORY/test-results/$(basename "$0" .sh)"
83
84 # Make this filename available to the sub-process in case it is using
85 # --verbose-log.
86 GIT_TEST_TEE_OUTPUT_FILE=$BASE.out
87 export GIT_TEST_TEE_OUTPUT_FILE
88
89 # Truncate before calling "tee -a" to get rid of the results
90 # from any previous runs.
91 >"$GIT_TEST_TEE_OUTPUT_FILE"
92
93 (GIT_TEST_TEE_STARTED=done ${TEST_SHELL_PATH} "$0" "$@" 2>&1;
94 echo $? >"$BASE.exit") | tee -a "$GIT_TEST_TEE_OUTPUT_FILE"
95 test "$(cat "$BASE.exit")" = 0
96 exit
97 ;;
98 esac
99
100 # For repeatability, reset the environment to known value.
101 # TERM is sanitized below, after saving color control sequences.
102 LANG=C
103 LC_ALL=C
104 PAGER=cat
105 TZ=UTC
106 export LANG LC_ALL PAGER TZ
107 EDITOR=:
108
109 # GIT_TEST_GETTEXT_POISON should not influence git commands executed
110 # during initialization of test-lib and the test repo. Back it up,
111 # unset and then restore after initialization is finished.
112 if test -n "$GIT_TEST_GETTEXT_POISON"
113 then
114 GIT_TEST_GETTEXT_POISON_ORIG=$GIT_TEST_GETTEXT_POISON
115 unset GIT_TEST_GETTEXT_POISON
116 fi
117
118 # A call to "unset" with no arguments causes at least Solaris 10
119 # /usr/xpg4/bin/sh and /bin/ksh to bail out. So keep the unsets
120 # deriving from the command substitution clustered with the other
121 # ones.
122 unset VISUAL EMAIL LANGUAGE COLUMNS $("$PERL_PATH" -e '
123 my @env = keys %ENV;
124 my $ok = join("|", qw(
125 TRACE
126 DEBUG
127 TEST
128 .*_TEST
129 PROVE
130 VALGRIND
131 UNZIP
132 PERF_
133 CURL_VERBOSE
134 TRACE_CURL
135 ));
136 my @vars = grep(/^GIT_/ && !/^GIT_($ok)/o, @env);
137 print join("\n", @vars);
138 ')
139 unset XDG_CACHE_HOME
140 unset XDG_CONFIG_HOME
141 unset GITPERLLIB
142 GIT_AUTHOR_EMAIL=author@example.com
143 GIT_AUTHOR_NAME='A U Thor'
144 GIT_COMMITTER_EMAIL=committer@example.com
145 GIT_COMMITTER_NAME='C O Mitter'
146 GIT_MERGE_VERBOSITY=5
147 GIT_MERGE_AUTOEDIT=no
148 export GIT_MERGE_VERBOSITY GIT_MERGE_AUTOEDIT
149 export GIT_AUTHOR_EMAIL GIT_AUTHOR_NAME
150 export GIT_COMMITTER_EMAIL GIT_COMMITTER_NAME
151 export EDITOR
152
153 # Tests using GIT_TRACE typically don't want <timestamp> <file>:<line> output
154 GIT_TRACE_BARE=1
155 export GIT_TRACE_BARE
156
157 check_var_migration () {
158 # the warnings and hints given from this helper depends
159 # on end-user settings, which will disrupt the self-test
160 # done on the test framework itself.
161 case "$GIT_TEST_FRAMEWORK_SELFTEST" in
162 t) return ;;
163 esac
164
165 old_name=$1 new_name=$2
166 eval "old_isset=\${${old_name}:+isset}"
167 eval "new_isset=\${${new_name}:+isset}"
168
169 case "$old_isset,$new_isset" in
170 isset,)
171 echo >&2 "warning: $old_name is now $new_name"
172 echo >&2 "hint: set $new_name too during the transition period"
173 eval "$new_name=\$$old_name"
174 ;;
175 isset,isset)
176 # do this later
177 # echo >&2 "warning: $old_name is now $new_name"
178 # echo >&2 "hint: remove $old_name"
179 ;;
180 esac
181 }
182
183 check_var_migration GIT_FSMONITOR_TEST GIT_TEST_FSMONITOR
184 check_var_migration TEST_GIT_INDEX_VERSION GIT_TEST_INDEX_VERSION
185 check_var_migration GIT_FORCE_PRELOAD_TEST GIT_TEST_PRELOAD_INDEX
186
187 # Use specific version of the index file format
188 if test -n "${GIT_TEST_INDEX_VERSION:+isset}"
189 then
190 GIT_INDEX_VERSION="$GIT_TEST_INDEX_VERSION"
191 export GIT_INDEX_VERSION
192 fi
193
194 # Add libc MALLOC and MALLOC_PERTURB test
195 # only if we are not executing the test with valgrind
196 if expr " $GIT_TEST_OPTS " : ".* --valgrind " >/dev/null ||
197 test -n "$TEST_NO_MALLOC_CHECK"
198 then
199 setup_malloc_check () {
200 : nothing
201 }
202 teardown_malloc_check () {
203 : nothing
204 }
205 else
206 setup_malloc_check () {
207 MALLOC_CHECK_=3 MALLOC_PERTURB_=165
208 export MALLOC_CHECK_ MALLOC_PERTURB_
209 }
210 teardown_malloc_check () {
211 unset MALLOC_CHECK_ MALLOC_PERTURB_
212 }
213 fi
214
215 # Protect ourselves from common misconfiguration to export
216 # CDPATH into the environment
217 unset CDPATH
218
219 unset GREP_OPTIONS
220 unset UNZIP
221
222 case $(echo $GIT_TRACE |tr "[A-Z]" "[a-z]") in
223 1|2|true)
224 GIT_TRACE=4
225 ;;
226 esac
227
228 # Convenience
229 #
230 # A regexp to match 5, 35 and 40 hexdigits
231 _x05='[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
232 _x35="$_x05$_x05$_x05$_x05$_x05$_x05$_x05"
233 _x40="$_x35$_x05"
234
235 # Zero SHA-1
236 _z40=0000000000000000000000000000000000000000
237
238 OID_REGEX="$_x40"
239 ZERO_OID=$_z40
240 EMPTY_TREE=4b825dc642cb6eb9a060e54bf8d69288fbee4904
241 EMPTY_BLOB=e69de29bb2d1d6434b8b29ae775ad8c2e48c5391
242
243 # Line feed
244 LF='
245 '
246
247 # UTF-8 ZERO WIDTH NON-JOINER, which HFS+ ignores
248 # when case-folding filenames
249 u200c=$(printf '\342\200\214')
250
251 export _x05 _x35 _x40 _z40 LF u200c EMPTY_TREE EMPTY_BLOB ZERO_OID OID_REGEX
252
253 # Each test should start with something like this, after copyright notices:
254 #
255 # test_description='Description of this test...
256 # This test checks if command xyzzy does the right thing...
257 # '
258 # . ./test-lib.sh
259 test "x$TERM" != "xdumb" && (
260 test -t 1 &&
261 tput bold >/dev/null 2>&1 &&
262 tput setaf 1 >/dev/null 2>&1 &&
263 tput sgr0 >/dev/null 2>&1
264 ) &&
265 color=t
266
267 while test "$#" -ne 0
268 do
269 case "$1" in
270 -d|--d|--de|--deb|--debu|--debug)
271 debug=t; shift ;;
272 -i|--i|--im|--imm|--imme|--immed|--immedi|--immedia|--immediat|--immediate)
273 immediate=t; shift ;;
274 -l|--l|--lo|--lon|--long|--long-|--long-t|--long-te|--long-tes|--long-test|--long-tests)
275 GIT_TEST_LONG=t; export GIT_TEST_LONG; shift ;;
276 -r)
277 shift; test "$#" -ne 0 || {
278 echo 'error: -r requires an argument' >&2;
279 exit 1;
280 }
281 run_list=$1; shift ;;
282 --run=*)
283 run_list=${1#--*=}; shift ;;
284 -h|--h|--he|--hel|--help)
285 help=t; shift ;;
286 -v|--v|--ve|--ver|--verb|--verbo|--verbos|--verbose)
287 verbose=t; shift ;;
288 --verbose-only=*)
289 verbose_only=${1#--*=}
290 shift ;;
291 -q|--q|--qu|--qui|--quie|--quiet)
292 # Ignore --quiet under a TAP::Harness. Saying how many tests
293 # passed without the ok/not ok details is always an error.
294 test -z "$HARNESS_ACTIVE" && quiet=t; shift ;;
295 --with-dashes)
296 with_dashes=t; shift ;;
297 --no-color)
298 color=; shift ;;
299 --va|--val|--valg|--valgr|--valgri|--valgrin|--valgrind)
300 valgrind=memcheck
301 shift ;;
302 --valgrind=*)
303 valgrind=${1#--*=}
304 shift ;;
305 --valgrind-only=*)
306 valgrind_only=${1#--*=}
307 shift ;;
308 --tee)
309 shift ;; # was handled already
310 --root=*)
311 root=${1#--*=}
312 shift ;;
313 --chain-lint)
314 GIT_TEST_CHAIN_LINT=1
315 shift ;;
316 --no-chain-lint)
317 GIT_TEST_CHAIN_LINT=0
318 shift ;;
319 -x)
320 # Some test scripts can't be reliably traced with '-x',
321 # unless the test is run with a Bash version supporting
322 # BASH_XTRACEFD (introduced in Bash v4.1). Check whether
323 # this test is marked as such, and ignore '-x' if it
324 # isn't executed with a suitable Bash version.
325 if test -z "$test_untraceable" || {
326 test -n "$BASH_VERSION" && {
327 test ${BASH_VERSINFO[0]} -gt 4 || {
328 test ${BASH_VERSINFO[0]} -eq 4 &&
329 test ${BASH_VERSINFO[1]} -ge 1
330 }
331 }
332 }
333 then
334 trace=t
335 else
336 echo >&2 "warning: ignoring -x; '$0' is untraceable without BASH_XTRACEFD"
337 fi
338 shift ;;
339 -V|--verbose-log)
340 verbose_log=t
341 shift ;;
342 *)
343 echo "error: unknown test option '$1'" >&2; exit 1 ;;
344 esac
345 done
346
347 if test -n "$valgrind_only"
348 then
349 test -z "$valgrind" && valgrind=memcheck
350 test -z "$verbose" && verbose_only="$valgrind_only"
351 elif test -n "$valgrind"
352 then
353 test -z "$verbose_log" && verbose=t
354 fi
355
356 if test -n "$trace" && test -z "$verbose_log"
357 then
358 verbose=t
359 fi
360
361 if test -n "$color"
362 then
363 # Save the color control sequences now rather than run tput
364 # each time say_color() is called. This is done for two
365 # reasons:
366 # * TERM will be changed to dumb
367 # * HOME will be changed to a temporary directory and tput
368 # might need to read ~/.terminfo from the original HOME
369 # directory to get the control sequences
370 # Note: This approach assumes the control sequences don't end
371 # in a newline for any terminal of interest (command
372 # substitutions strip trailing newlines). Given that most
373 # (all?) terminals in common use are related to ECMA-48, this
374 # shouldn't be a problem.
375 say_color_error=$(tput bold; tput setaf 1) # bold red
376 say_color_skip=$(tput setaf 4) # blue
377 say_color_warn=$(tput setaf 3) # brown/yellow
378 say_color_pass=$(tput setaf 2) # green
379 say_color_info=$(tput setaf 6) # cyan
380 say_color_reset=$(tput sgr0)
381 say_color_="" # no formatting for normal text
382 say_color () {
383 test -z "$1" && test -n "$quiet" && return
384 eval "say_color_color=\$say_color_$1"
385 shift
386 printf "%s\\n" "$say_color_color$*$say_color_reset"
387 }
388 else
389 say_color() {
390 test -z "$1" && test -n "$quiet" && return
391 shift
392 printf "%s\n" "$*"
393 }
394 fi
395
396 TERM=dumb
397 export TERM
398
399 error () {
400 say_color error "error: $*"
401 GIT_EXIT_OK=t
402 exit 1
403 }
404
405 say () {
406 say_color info "$*"
407 }
408
409 if test -n "$HARNESS_ACTIVE"
410 then
411 if test "$verbose" = t || test -n "$verbose_only"
412 then
413 printf 'Bail out! %s\n' \
414 'verbose mode forbidden under TAP harness; try --verbose-log'
415 exit 1
416 fi
417 fi
418
419 test "${test_description}" != "" ||
420 error "Test script did not set test_description."
421
422 if test "$help" = "t"
423 then
424 printf '%s\n' "$test_description"
425 exit 0
426 fi
427
428 exec 5>&1
429 exec 6<&0
430 exec 7>&2
431 if test "$verbose_log" = "t"
432 then
433 exec 3>>"$GIT_TEST_TEE_OUTPUT_FILE" 4>&3
434 elif test "$verbose" = "t"
435 then
436 exec 4>&2 3>&1
437 else
438 exec 4>/dev/null 3>/dev/null
439 fi
440
441 # Send any "-x" output directly to stderr to avoid polluting tests
442 # which capture stderr. We can do this unconditionally since it
443 # has no effect if tracing isn't turned on.
444 #
445 # Note that this sets up the trace fd as soon as we assign the variable, so it
446 # must come after the creation of descriptor 4 above. Likewise, we must never
447 # unset this, as it has the side effect of closing descriptor 4, which we
448 # use to show verbose tests to the user.
449 #
450 # Note also that we don't need or want to export it. The tracing is local to
451 # this shell, and we would not want to influence any shells we exec.
452 BASH_XTRACEFD=4
453
454 test_failure=0
455 test_count=0
456 test_fixed=0
457 test_broken=0
458 test_success=0
459
460 test_external_has_tap=0
461
462 die () {
463 code=$?
464 if test -n "$GIT_EXIT_OK"
465 then
466 exit $code
467 else
468 echo >&5 "FATAL: Unexpected exit with code $code"
469 exit 1
470 fi
471 }
472
473 GIT_EXIT_OK=
474 trap 'die' EXIT
475 trap 'exit $?' INT
476
477 # The user-facing functions are loaded from a separate file so that
478 # test_perf subshells can have them too
479 . "$TEST_DIRECTORY/test-lib-functions.sh"
480
481 # You are not expected to call test_ok_ and test_failure_ directly, use
482 # the test_expect_* functions instead.
483
484 test_ok_ () {
485 test_success=$(($test_success + 1))
486 say_color "" "ok $test_count - $@"
487 }
488
489 test_failure_ () {
490 test_failure=$(($test_failure + 1))
491 say_color error "not ok $test_count - $1"
492 shift
493 printf '%s\n' "$*" | sed -e 's/^/# /'
494 test "$immediate" = "" || { GIT_EXIT_OK=t; exit 1; }
495 }
496
497 test_known_broken_ok_ () {
498 test_fixed=$(($test_fixed+1))
499 say_color error "ok $test_count - $@ # TODO known breakage vanished"
500 }
501
502 test_known_broken_failure_ () {
503 test_broken=$(($test_broken+1))
504 say_color warn "not ok $test_count - $@ # TODO known breakage"
505 }
506
507 test_debug () {
508 test "$debug" = "" || eval "$1"
509 }
510
511 match_pattern_list () {
512 arg="$1"
513 shift
514 test -z "$*" && return 1
515 for pattern_
516 do
517 case "$arg" in
518 $pattern_)
519 return 0
520 esac
521 done
522 return 1
523 }
524
525 match_test_selector_list () {
526 title="$1"
527 shift
528 arg="$1"
529 shift
530 test -z "$1" && return 0
531
532 # Both commas and whitespace are accepted as separators.
533 OLDIFS=$IFS
534 IFS=' ,'
535 set -- $1
536 IFS=$OLDIFS
537
538 # If the first selector is negative we include by default.
539 include=
540 case "$1" in
541 !*) include=t ;;
542 esac
543
544 for selector
545 do
546 orig_selector=$selector
547
548 positive=t
549 case "$selector" in
550 !*)
551 positive=
552 selector=${selector##?}
553 ;;
554 esac
555
556 test -z "$selector" && continue
557
558 case "$selector" in
559 *-*)
560 if expr "z${selector%%-*}" : "z[0-9]*[^0-9]" >/dev/null
561 then
562 echo "error: $title: invalid non-numeric in range" \
563 "start: '$orig_selector'" >&2
564 exit 1
565 fi
566 if expr "z${selector#*-}" : "z[0-9]*[^0-9]" >/dev/null
567 then
568 echo "error: $title: invalid non-numeric in range" \
569 "end: '$orig_selector'" >&2
570 exit 1
571 fi
572 ;;
573 *)
574 if expr "z$selector" : "z[0-9]*[^0-9]" >/dev/null
575 then
576 echo "error: $title: invalid non-numeric in test" \
577 "selector: '$orig_selector'" >&2
578 exit 1
579 fi
580 esac
581
582 # Short cut for "obvious" cases
583 test -z "$include" && test -z "$positive" && continue
584 test -n "$include" && test -n "$positive" && continue
585
586 case "$selector" in
587 -*)
588 if test $arg -le ${selector#-}
589 then
590 include=$positive
591 fi
592 ;;
593 *-)
594 if test $arg -ge ${selector%-}
595 then
596 include=$positive
597 fi
598 ;;
599 *-*)
600 if test ${selector%%-*} -le $arg \
601 && test $arg -le ${selector#*-}
602 then
603 include=$positive
604 fi
605 ;;
606 *)
607 if test $arg -eq $selector
608 then
609 include=$positive
610 fi
611 ;;
612 esac
613 done
614
615 test -n "$include"
616 }
617
618 maybe_teardown_verbose () {
619 test -z "$verbose_only" && return
620 exec 4>/dev/null 3>/dev/null
621 verbose=
622 }
623
624 last_verbose=t
625 maybe_setup_verbose () {
626 test -z "$verbose_only" && return
627 if match_pattern_list $test_count $verbose_only
628 then
629 exec 4>&2 3>&1
630 # Emit a delimiting blank line when going from
631 # non-verbose to verbose. Within verbose mode the
632 # delimiter is printed by test_expect_*. The choice
633 # of the initial $last_verbose is such that before
634 # test 1, we do not print it.
635 test -z "$last_verbose" && echo >&3 ""
636 verbose=t
637 else
638 exec 4>/dev/null 3>/dev/null
639 verbose=
640 fi
641 last_verbose=$verbose
642 }
643
644 maybe_teardown_valgrind () {
645 test -z "$GIT_VALGRIND" && return
646 GIT_VALGRIND_ENABLED=
647 }
648
649 maybe_setup_valgrind () {
650 test -z "$GIT_VALGRIND" && return
651 if test -z "$valgrind_only"
652 then
653 GIT_VALGRIND_ENABLED=t
654 return
655 fi
656 GIT_VALGRIND_ENABLED=
657 if match_pattern_list $test_count $valgrind_only
658 then
659 GIT_VALGRIND_ENABLED=t
660 fi
661 }
662
663 want_trace () {
664 test "$trace" = t && {
665 test "$verbose" = t || test "$verbose_log" = t
666 }
667 }
668
669 # This is a separate function because some tests use
670 # "return" to end a test_expect_success block early
671 # (and we want to make sure we run any cleanup like
672 # "set +x").
673 test_eval_inner_ () {
674 # Do not add anything extra (including LF) after '$*'
675 eval "
676 want_trace && set -x
677 $*"
678 }
679
680 test_eval_ () {
681 # If "-x" tracing is in effect, then we want to avoid polluting stderr
682 # with non-test commands. But once in "set -x" mode, we cannot prevent
683 # the shell from printing the "set +x" to turn it off (nor the saving
684 # of $? before that). But we can make sure that the output goes to
685 # /dev/null.
686 #
687 # There are a few subtleties here:
688 #
689 # - we have to redirect descriptor 4 in addition to 2, to cover
690 # BASH_XTRACEFD
691 #
692 # - the actual eval has to come before the redirection block (since
693 # it needs to see descriptor 4 to set up its stderr)
694 #
695 # - likewise, any error message we print must be outside the block to
696 # access descriptor 4
697 #
698 # - checking $? has to come immediately after the eval, but it must
699 # be _inside_ the block to avoid polluting the "set -x" output
700 #
701
702 test_eval_inner_ "$@" </dev/null >&3 2>&4
703 {
704 test_eval_ret_=$?
705 if want_trace
706 then
707 set +x
708 fi
709 } 2>/dev/null 4>&2
710
711 if test "$test_eval_ret_" != 0 && want_trace
712 then
713 say_color error >&4 "error: last command exited with \$?=$test_eval_ret_"
714 fi
715 return $test_eval_ret_
716 }
717
718 test_run_ () {
719 test_cleanup=:
720 expecting_failure=$2
721
722 if test "${GIT_TEST_CHAIN_LINT:-1}" != 0; then
723 # turn off tracing for this test-eval, as it simply creates
724 # confusing noise in the "-x" output
725 trace_tmp=$trace
726 trace=
727 # 117 is magic because it is unlikely to match the exit
728 # code of other programs
729 if $(printf '%s\n' "$1" | sed -f "$GIT_BUILD_DIR/t/chainlint.sed" | grep -q '?![A-Z][A-Z]*?!') ||
730 test "OK-117" != "$(test_eval_ "(exit 117) && $1${LF}${LF}echo OK-\$?" 3>&1)"
731 then
732 error "bug in the test script: broken &&-chain or run-away HERE-DOC: $1"
733 fi
734 trace=$trace_tmp
735 fi
736
737 setup_malloc_check
738 test_eval_ "$1"
739 eval_ret=$?
740 teardown_malloc_check
741
742 if test -z "$immediate" || test $eval_ret = 0 ||
743 test -n "$expecting_failure" && test "$test_cleanup" != ":"
744 then
745 setup_malloc_check
746 test_eval_ "$test_cleanup"
747 teardown_malloc_check
748 fi
749 if test "$verbose" = "t" && test -n "$HARNESS_ACTIVE"
750 then
751 echo ""
752 fi
753 return "$eval_ret"
754 }
755
756 test_start_ () {
757 test_count=$(($test_count+1))
758 maybe_setup_verbose
759 maybe_setup_valgrind
760 }
761
762 test_finish_ () {
763 echo >&3 ""
764 maybe_teardown_valgrind
765 maybe_teardown_verbose
766 }
767
768 test_skip () {
769 to_skip=
770 skipped_reason=
771 if match_pattern_list $this_test.$test_count $GIT_SKIP_TESTS
772 then
773 to_skip=t
774 skipped_reason="GIT_SKIP_TESTS"
775 fi
776 if test -z "$to_skip" && test -n "$test_prereq" &&
777 ! test_have_prereq "$test_prereq"
778 then
779 to_skip=t
780
781 of_prereq=
782 if test "$missing_prereq" != "$test_prereq"
783 then
784 of_prereq=" of $test_prereq"
785 fi
786 skipped_reason="missing $missing_prereq${of_prereq}"
787 fi
788 if test -z "$to_skip" && test -n "$run_list" &&
789 ! match_test_selector_list '--run' $test_count "$run_list"
790 then
791 to_skip=t
792 skipped_reason="--run"
793 fi
794
795 case "$to_skip" in
796 t)
797 say_color skip >&3 "skipping test: $@"
798 say_color skip "ok $test_count # skip $1 ($skipped_reason)"
799 : true
800 ;;
801 *)
802 false
803 ;;
804 esac
805 }
806
807 # stub; perf-lib overrides it
808 test_at_end_hook_ () {
809 :
810 }
811
812 test_done () {
813 GIT_EXIT_OK=t
814
815 if test -z "$HARNESS_ACTIVE"
816 then
817 test_results_dir="$TEST_OUTPUT_DIRECTORY/test-results"
818 mkdir -p "$test_results_dir"
819 base=${0##*/}
820 test_results_path="$test_results_dir/${base%.sh}.counts"
821
822 cat >"$test_results_path" <<-EOF
823 total $test_count
824 success $test_success
825 fixed $test_fixed
826 broken $test_broken
827 failed $test_failure
828
829 EOF
830 fi
831
832 if test "$test_fixed" != 0
833 then
834 say_color error "# $test_fixed known breakage(s) vanished; please update test(s)"
835 fi
836 if test "$test_broken" != 0
837 then
838 say_color warn "# still have $test_broken known breakage(s)"
839 fi
840 if test "$test_broken" != 0 || test "$test_fixed" != 0
841 then
842 test_remaining=$(( $test_count - $test_broken - $test_fixed ))
843 msg="remaining $test_remaining test(s)"
844 else
845 test_remaining=$test_count
846 msg="$test_count test(s)"
847 fi
848 case "$test_failure" in
849 0)
850 if test $test_external_has_tap -eq 0
851 then
852 if test $test_remaining -gt 0
853 then
854 say_color pass "# passed all $msg"
855 fi
856
857 # Maybe print SKIP message
858 test -z "$skip_all" || skip_all="# SKIP $skip_all"
859 case "$test_count" in
860 0)
861 say "1..$test_count${skip_all:+ $skip_all}"
862 ;;
863 *)
864 test -z "$skip_all" ||
865 say_color warn "$skip_all"
866 say "1..$test_count"
867 ;;
868 esac
869 fi
870
871 if test -z "$debug"
872 then
873 test -d "$TRASH_DIRECTORY" ||
874 error "Tests passed but trash directory already removed before test cleanup; aborting"
875
876 cd "$TRASH_DIRECTORY/.." &&
877 rm -fr "$TRASH_DIRECTORY" ||
878 error "Tests passed but test cleanup failed; aborting"
879 fi
880 test_at_end_hook_
881
882 exit 0 ;;
883
884 *)
885 if test $test_external_has_tap -eq 0
886 then
887 say_color error "# failed $test_failure among $msg"
888 say "1..$test_count"
889 fi
890
891 exit 1 ;;
892
893 esac
894 }
895
896 if test -n "$valgrind"
897 then
898 make_symlink () {
899 test -h "$2" &&
900 test "$1" = "$(readlink "$2")" || {
901 # be super paranoid
902 if mkdir "$2".lock
903 then
904 rm -f "$2" &&
905 ln -s "$1" "$2" &&
906 rm -r "$2".lock
907 else
908 while test -d "$2".lock
909 do
910 say "Waiting for lock on $2."
911 sleep 1
912 done
913 fi
914 }
915 }
916
917 make_valgrind_symlink () {
918 # handle only executables, unless they are shell libraries that
919 # need to be in the exec-path.
920 test -x "$1" ||
921 test "# " = "$(test_copy_bytes 2 <"$1")" ||
922 return;
923
924 base=$(basename "$1")
925 case "$base" in
926 test-*)
927 symlink_target="$GIT_BUILD_DIR/t/helper/$base"
928 ;;
929 *)
930 symlink_target="$GIT_BUILD_DIR/$base"
931 ;;
932 esac
933 # do not override scripts
934 if test -x "$symlink_target" &&
935 test ! -d "$symlink_target" &&
936 test "#!" != "$(test_copy_bytes 2 <"$symlink_target")"
937 then
938 symlink_target=../valgrind.sh
939 fi
940 case "$base" in
941 *.sh|*.perl)
942 symlink_target=../unprocessed-script
943 esac
944 # create the link, or replace it if it is out of date
945 make_symlink "$symlink_target" "$GIT_VALGRIND/bin/$base" || exit
946 }
947
948 # override all git executables in TEST_DIRECTORY/..
949 GIT_VALGRIND=$TEST_DIRECTORY/valgrind
950 mkdir -p "$GIT_VALGRIND"/bin
951 for file in $GIT_BUILD_DIR/git* $GIT_BUILD_DIR/t/helper/test-*
952 do
953 make_valgrind_symlink $file
954 done
955 # special-case the mergetools loadables
956 make_symlink "$GIT_BUILD_DIR"/mergetools "$GIT_VALGRIND/bin/mergetools"
957 OLDIFS=$IFS
958 IFS=:
959 for path in $PATH
960 do
961 ls "$path"/git-* 2> /dev/null |
962 while read file
963 do
964 make_valgrind_symlink "$file"
965 done
966 done
967 IFS=$OLDIFS
968 PATH=$GIT_VALGRIND/bin:$PATH
969 GIT_EXEC_PATH=$GIT_VALGRIND/bin
970 export GIT_VALGRIND
971 GIT_VALGRIND_MODE="$valgrind"
972 export GIT_VALGRIND_MODE
973 GIT_VALGRIND_ENABLED=t
974 test -n "$valgrind_only" && GIT_VALGRIND_ENABLED=
975 export GIT_VALGRIND_ENABLED
976 elif test -n "$GIT_TEST_INSTALLED"
977 then
978 GIT_EXEC_PATH=$($GIT_TEST_INSTALLED/git --exec-path) ||
979 error "Cannot run git from $GIT_TEST_INSTALLED."
980 PATH=$GIT_TEST_INSTALLED:$GIT_BUILD_DIR/t/helper:$PATH
981 GIT_EXEC_PATH=${GIT_TEST_EXEC_PATH:-$GIT_EXEC_PATH}
982 else # normal case, use ../bin-wrappers only unless $with_dashes:
983 git_bin_dir="$GIT_BUILD_DIR/bin-wrappers"
984 if ! test -x "$git_bin_dir/git"
985 then
986 if test -z "$with_dashes"
987 then
988 say "$git_bin_dir/git is not executable; using GIT_EXEC_PATH"
989 fi
990 with_dashes=t
991 fi
992 PATH="$git_bin_dir:$PATH"
993 GIT_EXEC_PATH=$GIT_BUILD_DIR
994 if test -n "$with_dashes"
995 then
996 PATH="$GIT_BUILD_DIR:$PATH"
997 fi
998 fi
999 GIT_TEMPLATE_DIR="$GIT_BUILD_DIR"/templates/blt
1000 GIT_CONFIG_NOSYSTEM=1
1001 GIT_ATTR_NOSYSTEM=1
1002 export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG_NOSYSTEM GIT_ATTR_NOSYSTEM
1003
1004 if test -z "$GIT_TEST_CMP"
1005 then
1006 if test -n "$GIT_TEST_CMP_USE_COPIED_CONTEXT"
1007 then
1008 GIT_TEST_CMP="$DIFF -c"
1009 else
1010 GIT_TEST_CMP="$DIFF -u"
1011 fi
1012 fi
1013
1014 GITPERLLIB="$GIT_BUILD_DIR"/perl/build/lib
1015 export GITPERLLIB
1016 test -d "$GIT_BUILD_DIR"/templates/blt || {
1017 error "You haven't built things yet, have you?"
1018 }
1019
1020 if ! test -x "$GIT_BUILD_DIR"/t/helper/test-tool
1021 then
1022 echo >&2 'You need to build test-tool:'
1023 echo >&2 'Run "make t/helper/test-tool" in the source (toplevel) directory'
1024 exit 1
1025 fi
1026
1027 # Test repository
1028 TRASH_DIRECTORY="trash directory.$(basename "$0" .sh)"
1029 test -n "$root" && TRASH_DIRECTORY="$root/$TRASH_DIRECTORY"
1030 case "$TRASH_DIRECTORY" in
1031 /*) ;; # absolute path is good
1032 *) TRASH_DIRECTORY="$TEST_OUTPUT_DIRECTORY/$TRASH_DIRECTORY" ;;
1033 esac
1034 rm -fr "$TRASH_DIRECTORY" || {
1035 GIT_EXIT_OK=t
1036 echo >&5 "FATAL: Cannot prepare test area"
1037 exit 1
1038 }
1039
1040 HOME="$TRASH_DIRECTORY"
1041 GNUPGHOME="$HOME/gnupg-home-not-used"
1042 export HOME GNUPGHOME
1043
1044 if test -z "$TEST_NO_CREATE_REPO"
1045 then
1046 test_create_repo "$TRASH_DIRECTORY"
1047 else
1048 mkdir -p "$TRASH_DIRECTORY"
1049 fi
1050 # Use -P to resolve symlinks in our working directory so that the cwd
1051 # in subprocesses like git equals our $PWD (for pathname comparisons).
1052 cd -P "$TRASH_DIRECTORY" || exit 1
1053
1054 this_test=${0##*/}
1055 this_test=${this_test%%-*}
1056 if match_pattern_list "$this_test" $GIT_SKIP_TESTS
1057 then
1058 say_color info >&3 "skipping test $this_test altogether"
1059 skip_all="skip all tests in $this_test"
1060 test_done
1061 fi
1062
1063 # Provide an implementation of the 'yes' utility
1064 yes () {
1065 if test $# = 0
1066 then
1067 y=y
1068 else
1069 y="$*"
1070 fi
1071
1072 i=0
1073 while test $i -lt 99
1074 do
1075 echo "$y"
1076 i=$(($i+1))
1077 done
1078 }
1079
1080 # Fix some commands on Windows
1081 uname_s=$(uname -s)
1082 case $uname_s in
1083 *MINGW*)
1084 # Windows has its own (incompatible) sort and find
1085 sort () {
1086 /usr/bin/sort "$@"
1087 }
1088 find () {
1089 /usr/bin/find "$@"
1090 }
1091 # git sees Windows-style pwd
1092 pwd () {
1093 builtin pwd -W
1094 }
1095 # no POSIX permissions
1096 # backslashes in pathspec are converted to '/'
1097 # exec does not inherit the PID
1098 test_set_prereq MINGW
1099 test_set_prereq NATIVE_CRLF
1100 test_set_prereq SED_STRIPS_CR
1101 test_set_prereq GREP_STRIPS_CR
1102 GIT_TEST_CMP=mingw_test_cmp
1103 ;;
1104 *CYGWIN*)
1105 test_set_prereq POSIXPERM
1106 test_set_prereq EXECKEEPSPID
1107 test_set_prereq CYGWIN
1108 test_set_prereq SED_STRIPS_CR
1109 test_set_prereq GREP_STRIPS_CR
1110 ;;
1111 *)
1112 test_set_prereq POSIXPERM
1113 test_set_prereq BSLASHPSPEC
1114 test_set_prereq EXECKEEPSPID
1115 ;;
1116 esac
1117
1118 ( COLUMNS=1 && test $COLUMNS = 1 ) && test_set_prereq COLUMNS_CAN_BE_1
1119 test -z "$NO_PERL" && test_set_prereq PERL
1120 test -z "$NO_PTHREADS" && test_set_prereq PTHREADS
1121 test -z "$NO_PYTHON" && test_set_prereq PYTHON
1122 test -n "$USE_LIBPCRE1$USE_LIBPCRE2" && test_set_prereq PCRE
1123 test -n "$USE_LIBPCRE1" && test_set_prereq LIBPCRE1
1124 test -n "$USE_LIBPCRE2" && test_set_prereq LIBPCRE2
1125 test -z "$NO_GETTEXT" && test_set_prereq GETTEXT
1126
1127 if test -n "$GIT_TEST_GETTEXT_POISON_ORIG"
1128 then
1129 GIT_TEST_GETTEXT_POISON=$GIT_TEST_GETTEXT_POISON_ORIG
1130 unset GIT_TEST_GETTEXT_POISON_ORIG
1131 fi
1132
1133 # Can we rely on git's output in the C locale?
1134 if test -z "$GIT_TEST_GETTEXT_POISON"
1135 then
1136 test_set_prereq C_LOCALE_OUTPUT
1137 fi
1138
1139 if test -z "$GIT_TEST_CHECK_CACHE_TREE"
1140 then
1141 GIT_TEST_CHECK_CACHE_TREE=true
1142 export GIT_TEST_CHECK_CACHE_TREE
1143 fi
1144
1145 test_lazy_prereq PIPE '
1146 # test whether the filesystem supports FIFOs
1147 test_have_prereq !MINGW,!CYGWIN &&
1148 rm -f testfifo && mkfifo testfifo
1149 '
1150
1151 test_lazy_prereq SYMLINKS '
1152 # test whether the filesystem supports symbolic links
1153 ln -s x y && test -h y
1154 '
1155
1156 test_lazy_prereq FILEMODE '
1157 test "$(git config --bool core.filemode)" = true
1158 '
1159
1160 test_lazy_prereq CASE_INSENSITIVE_FS '
1161 echo good >CamelCase &&
1162 echo bad >camelcase &&
1163 test "$(cat CamelCase)" != good
1164 '
1165
1166 test_lazy_prereq FUNNYNAMES '
1167 test_have_prereq !MINGW &&
1168 touch -- \
1169 "FUNNYNAMES tab embedded" \
1170 "FUNNYNAMES \"quote embedded\"" \
1171 "FUNNYNAMES newline
1172 embedded" 2>/dev/null &&
1173 rm -- \
1174 "FUNNYNAMES tab embedded" \
1175 "FUNNYNAMES \"quote embedded\"" \
1176 "FUNNYNAMES newline
1177 embedded" 2>/dev/null
1178 '
1179
1180 test_lazy_prereq UTF8_NFD_TO_NFC '
1181 # check whether FS converts nfd unicode to nfc
1182 auml=$(printf "\303\244")
1183 aumlcdiar=$(printf "\141\314\210")
1184 >"$auml" &&
1185 test -f "$aumlcdiar"
1186 '
1187
1188 test_lazy_prereq AUTOIDENT '
1189 sane_unset GIT_AUTHOR_NAME &&
1190 sane_unset GIT_AUTHOR_EMAIL &&
1191 git var GIT_AUTHOR_IDENT
1192 '
1193
1194 test_lazy_prereq EXPENSIVE '
1195 test -n "$GIT_TEST_LONG"
1196 '
1197
1198 test_lazy_prereq EXPENSIVE_ON_WINDOWS '
1199 test_have_prereq EXPENSIVE || test_have_prereq !MINGW,!CYGWIN
1200 '
1201
1202 test_lazy_prereq USR_BIN_TIME '
1203 test -x /usr/bin/time
1204 '
1205
1206 test_lazy_prereq NOT_ROOT '
1207 uid=$(id -u) &&
1208 test "$uid" != 0
1209 '
1210
1211 test_lazy_prereq JGIT '
1212 type jgit
1213 '
1214
1215 # SANITY is about "can you correctly predict what the filesystem would
1216 # do by only looking at the permission bits of the files and
1217 # directories?" A typical example of !SANITY is running the test
1218 # suite as root, where a test may expect "chmod -r file && cat file"
1219 # to fail because file is supposed to be unreadable after a successful
1220 # chmod. In an environment (i.e. combination of what filesystem is
1221 # being used and who is running the tests) that lacks SANITY, you may
1222 # be able to delete or create a file when the containing directory
1223 # doesn't have write permissions, or access a file even if the
1224 # containing directory doesn't have read or execute permissions.
1225
1226 test_lazy_prereq SANITY '
1227 mkdir SANETESTD.1 SANETESTD.2 &&
1228
1229 chmod +w SANETESTD.1 SANETESTD.2 &&
1230 >SANETESTD.1/x 2>SANETESTD.2/x &&
1231 chmod -w SANETESTD.1 &&
1232 chmod -r SANETESTD.1/x &&
1233 chmod -rx SANETESTD.2 ||
1234 error "bug in test sript: cannot prepare SANETESTD"
1235
1236 ! test -r SANETESTD.1/x &&
1237 ! rm SANETESTD.1/x && ! test -f SANETESTD.2/x
1238 status=$?
1239
1240 chmod +rwx SANETESTD.1 SANETESTD.2 &&
1241 rm -rf SANETESTD.1 SANETESTD.2 ||
1242 error "bug in test sript: cannot clean SANETESTD"
1243 return $status
1244 '
1245
1246 test FreeBSD != $uname_s || GIT_UNZIP=${GIT_UNZIP:-/usr/local/bin/unzip}
1247 GIT_UNZIP=${GIT_UNZIP:-unzip}
1248 test_lazy_prereq UNZIP '
1249 "$GIT_UNZIP" -v
1250 test $? -ne 127
1251 '
1252
1253 run_with_limited_cmdline () {
1254 (ulimit -s 128 && "$@")
1255 }
1256
1257 test_lazy_prereq CMDLINE_LIMIT '
1258 test_have_prereq !MINGW,!CYGWIN &&
1259 run_with_limited_cmdline true
1260 '
1261
1262 run_with_limited_stack () {
1263 (ulimit -s 128 && "$@")
1264 }
1265
1266 test_lazy_prereq ULIMIT_STACK_SIZE '
1267 test_have_prereq !MINGW,!CYGWIN &&
1268 run_with_limited_stack true
1269 '
1270
1271 build_option () {
1272 git version --build-options |
1273 sed -ne "s/^$1: //p"
1274 }
1275
1276 test_lazy_prereq LONG_IS_64BIT '
1277 test 8 -le "$(build_option sizeof-long)"
1278 '
1279
1280 test_lazy_prereq TIME_IS_64BIT 'test-tool date is64bit'
1281 test_lazy_prereq TIME_T_IS_64BIT 'test-tool date time_t-is64bit'
1282
1283 test_lazy_prereq CURL '
1284 curl --version
1285 '
1286
1287 # SHA1 is a test if the hash algorithm in use is SHA-1. This is both for tests
1288 # which will not work with other hash algorithms and tests that work but don't
1289 # test anything meaningful (e.g. special values which cause short collisions).
1290 test_lazy_prereq SHA1 '
1291 test $(git hash-object /dev/null) = e69de29bb2d1d6434b8b29ae775ad8c2e48c5391
1292 '
1293
1294 test_lazy_prereq REBASE_P '
1295 test -z "$GIT_TEST_SKIP_REBASE_P"
1296 '