]> git.ipfire.org Git - thirdparty/git.git/blob - t/test-lib.sh
52c1b08ef4a524f12238ed3823953b0fe6f16405
[thirdparty/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 # ensure that TEST_DIRECTORY is an absolute path so that it
23 # is valid even if the current working directory is changed
24 TEST_DIRECTORY=$(pwd)
25 else
26 # The TEST_DIRECTORY will always be the path to the "t"
27 # directory in the git.git checkout. This is overridden by
28 # e.g. t/lib-subtest.sh, but only because its $(pwd) is
29 # different. Those tests still set "$TEST_DIRECTORY" to the
30 # same path.
31 #
32 # See use of "$GIT_BUILD_DIR" and "$TEST_DIRECTORY" below for
33 # hard assumptions about "$GIT_BUILD_DIR/t" existing and being
34 # the "$TEST_DIRECTORY", and e.g. "$TEST_DIRECTORY/helper"
35 # needing to exist.
36 TEST_DIRECTORY=$(cd "$TEST_DIRECTORY" && pwd) || exit 1
37 fi
38 if test -z "$TEST_OUTPUT_DIRECTORY"
39 then
40 # Similarly, override this to store the test-results subdir
41 # elsewhere
42 TEST_OUTPUT_DIRECTORY=$TEST_DIRECTORY
43 fi
44 GIT_BUILD_DIR="${TEST_DIRECTORY%/t}"
45 if test "$TEST_DIRECTORY" = "$GIT_BUILD_DIR"
46 then
47 echo "PANIC: Running in a $TEST_DIRECTORY that doesn't end in '/t'?" >&2
48 exit 1
49 fi
50 if test -f "$GIT_BUILD_DIR/GIT-BUILD-DIR"
51 then
52 GIT_BUILD_DIR="$(cat "$GIT_BUILD_DIR/GIT-BUILD-DIR")" || exit 1
53 # On Windows, we must convert Windows paths lest they contain a colon
54 case "$(uname -s)" in
55 *MINGW*)
56 GIT_BUILD_DIR="$(cygpath -au "$GIT_BUILD_DIR")"
57 ;;
58 esac
59 fi
60
61 # Prepend a string to a VAR using an arbitrary ":" delimiter, not
62 # adding the delimiter if VAR or VALUE is empty. I.e. a generalized:
63 #
64 # VAR=$1${VAR:+${1:+$2}$VAR}
65 #
66 # Usage (using ":" as the $2 delimiter):
67 #
68 # prepend_var VAR : VALUE
69 prepend_var () {
70 eval "$1=\"$3\${$1:+${3:+$2}\$$1}\""
71 }
72
73 # If [AL]SAN is in effect we want to abort so that we notice
74 # problems. The GIT_SAN_OPTIONS variable can be used to set common
75 # defaults shared between [AL]SAN_OPTIONS.
76 prepend_var GIT_SAN_OPTIONS : abort_on_error=1
77 prepend_var GIT_SAN_OPTIONS : strip_path_prefix="$GIT_BUILD_DIR/"
78
79 # If we were built with ASAN, it may complain about leaks
80 # of program-lifetime variables. Disable it by default to lower
81 # the noise level. This needs to happen at the start of the script,
82 # before we even do our "did we build git yet" check (since we don't
83 # want that one to complain to stderr).
84 prepend_var ASAN_OPTIONS : $GIT_SAN_OPTIONS
85 prepend_var ASAN_OPTIONS : detect_leaks=0
86 export ASAN_OPTIONS
87
88 prepend_var LSAN_OPTIONS : $GIT_SAN_OPTIONS
89 prepend_var LSAN_OPTIONS : fast_unwind_on_malloc=0
90 export LSAN_OPTIONS
91
92 if test ! -f "$GIT_BUILD_DIR"/GIT-BUILD-OPTIONS
93 then
94 echo >&2 'error: GIT-BUILD-OPTIONS missing (has Git been built?).'
95 exit 1
96 fi
97 . "$GIT_BUILD_DIR"/GIT-BUILD-OPTIONS
98 export PERL_PATH SHELL_PATH
99
100 # In t0000, we need to override test directories of nested testcases. In case
101 # the developer has TEST_OUTPUT_DIRECTORY part of his build options, then we'd
102 # reset this value to instead contain what the developer has specified. We thus
103 # have this knob to allow overriding the directory.
104 if test -n "${TEST_OUTPUT_DIRECTORY_OVERRIDE}"
105 then
106 TEST_OUTPUT_DIRECTORY="${TEST_OUTPUT_DIRECTORY_OVERRIDE}"
107 fi
108
109 # Disallow the use of abbreviated options in the test suite by default
110 if test -z "${GIT_TEST_DISALLOW_ABBREVIATED_OPTIONS}"
111 then
112 GIT_TEST_DISALLOW_ABBREVIATED_OPTIONS=true
113 export GIT_TEST_DISALLOW_ABBREVIATED_OPTIONS
114 fi
115
116 # Explicitly set the default branch name for testing, to avoid the
117 # transitory "git init" warning under --verbose.
118 : ${GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME:=master}
119 export GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME
120
121 ################################################################
122 # It appears that people try to run tests without building...
123 "${GIT_TEST_INSTALLED:-$GIT_BUILD_DIR}/git$X" >/dev/null
124 if test $? != 1
125 then
126 if test -n "$GIT_TEST_INSTALLED"
127 then
128 echo >&2 "error: there is no working Git at '$GIT_TEST_INSTALLED'"
129 else
130 echo >&2 'error: you do not seem to have built git yet.'
131 fi
132 exit 1
133 fi
134
135 store_arg_to=
136 opt_required_arg=
137 # $1: option string
138 # $2: name of the var where the arg will be stored
139 mark_option_requires_arg () {
140 if test -n "$opt_required_arg"
141 then
142 echo "error: options that require args cannot be bundled" \
143 "together: '$opt_required_arg' and '$1'" >&2
144 exit 1
145 fi
146 opt_required_arg=$1
147 store_arg_to=$2
148 }
149
150 # These functions can be overridden e.g. to output JUnit XML
151 start_test_output () { :; }
152 start_test_case_output () { :; }
153 finalize_test_case_output () { :; }
154 finalize_test_output () { :; }
155
156 parse_option () {
157 local opt="$1"
158
159 case "$opt" in
160 -d|--d|--de|--deb|--debu|--debug)
161 debug=t ;;
162 -i|--i|--im|--imm|--imme|--immed|--immedi|--immedia|--immediat|--immediate)
163 immediate=t ;;
164 -l|--l|--lo|--lon|--long|--long-|--long-t|--long-te|--long-tes|--long-test|--long-tests)
165 GIT_TEST_LONG=t; export GIT_TEST_LONG ;;
166 -r)
167 mark_option_requires_arg "$opt" run_list
168 ;;
169 --run=*)
170 run_list=${opt#--*=} ;;
171 -h|--h|--he|--hel|--help)
172 help=t ;;
173 -v|--v|--ve|--ver|--verb|--verbo|--verbos|--verbose)
174 verbose=t ;;
175 --verbose-only=*)
176 verbose_only=${opt#--*=}
177 ;;
178 -q|--q|--qu|--qui|--quie|--quiet)
179 # Ignore --quiet under a TAP::Harness. Saying how many tests
180 # passed without the ok/not ok details is always an error.
181 test -z "$HARNESS_ACTIVE" && quiet=t ;;
182 --with-dashes)
183 with_dashes=t ;;
184 --no-bin-wrappers)
185 no_bin_wrappers=t ;;
186 --no-color)
187 color= ;;
188 --va|--val|--valg|--valgr|--valgri|--valgrin|--valgrind)
189 valgrind=memcheck
190 tee=t
191 ;;
192 --valgrind=*)
193 valgrind=${opt#--*=}
194 tee=t
195 ;;
196 --valgrind-only=*)
197 valgrind_only=${opt#--*=}
198 tee=t
199 ;;
200 --tee)
201 tee=t ;;
202 --root=*)
203 root=${opt#--*=} ;;
204 --chain-lint)
205 GIT_TEST_CHAIN_LINT=1 ;;
206 --no-chain-lint)
207 GIT_TEST_CHAIN_LINT=0 ;;
208 -x)
209 trace=t ;;
210 -V|--verbose-log)
211 verbose_log=t
212 tee=t
213 ;;
214 --write-junit-xml)
215 . "$TEST_DIRECTORY/test-lib-junit.sh"
216 ;;
217 --github-workflow-markup)
218 . "$TEST_DIRECTORY/test-lib-github-workflow-markup.sh"
219 ;;
220 --stress)
221 stress=t ;;
222 --stress=*)
223 echo "error: --stress does not accept an argument: '$opt'" >&2
224 echo "did you mean --stress-jobs=${opt#*=} or --stress-limit=${opt#*=}?" >&2
225 exit 1
226 ;;
227 --stress-jobs=*)
228 stress=t;
229 stress_jobs=${opt#--*=}
230 case "$stress_jobs" in
231 *[!0-9]*|0*|"")
232 echo "error: --stress-jobs=<N> requires the number of jobs to run" >&2
233 exit 1
234 ;;
235 *) # Good.
236 ;;
237 esac
238 ;;
239 --stress-limit=*)
240 stress=t;
241 stress_limit=${opt#--*=}
242 case "$stress_limit" in
243 *[!0-9]*|0*|"")
244 echo "error: --stress-limit=<N> requires the number of repetitions" >&2
245 exit 1
246 ;;
247 *) # Good.
248 ;;
249 esac
250 ;;
251 --invert-exit-code)
252 invert_exit_code=t
253 ;;
254 *)
255 echo "error: unknown test option '$opt'" >&2; exit 1 ;;
256 esac
257 }
258
259 # Parse options while taking care to leave $@ intact, so we will still
260 # have all the original command line options when executing the test
261 # script again for '--tee' and '--verbose-log' later.
262 for opt
263 do
264 if test -n "$store_arg_to"
265 then
266 eval $store_arg_to=\$opt
267 store_arg_to=
268 opt_required_arg=
269 continue
270 fi
271
272 case "$opt" in
273 --*|-?)
274 parse_option "$opt" ;;
275 -?*)
276 # bundled short options must be fed separately to parse_option
277 opt=${opt#-}
278 while test -n "$opt"
279 do
280 extra=${opt#?}
281 this=${opt%$extra}
282 opt=$extra
283 parse_option "-$this"
284 done
285 ;;
286 *)
287 echo "error: unknown test option '$opt'" >&2; exit 1 ;;
288 esac
289 done
290 if test -n "$store_arg_to"
291 then
292 echo "error: $opt_required_arg requires an argument" >&2
293 exit 1
294 fi
295
296 if test -n "$valgrind_only"
297 then
298 test -z "$valgrind" && valgrind=memcheck
299 test -z "$verbose" && verbose_only="$valgrind_only"
300 elif test -n "$valgrind"
301 then
302 test -z "$verbose_log" && verbose=t
303 fi
304
305 if test -n "$stress"
306 then
307 verbose=t
308 trace=t
309 immediate=t
310 fi
311
312 TEST_STRESS_JOB_SFX="${GIT_TEST_STRESS_JOB_NR:+.stress-$GIT_TEST_STRESS_JOB_NR}"
313 TEST_NAME="$(basename "$0" .sh)"
314 TEST_NUMBER="${TEST_NAME%%-*}"
315 TEST_NUMBER="${TEST_NUMBER#t}"
316 TEST_RESULTS_DIR="$TEST_OUTPUT_DIRECTORY/test-results"
317 TEST_RESULTS_BASE="$TEST_RESULTS_DIR/$TEST_NAME$TEST_STRESS_JOB_SFX"
318 TEST_RESULTS_SAN_FILE_PFX=trace
319 TEST_RESULTS_SAN_DIR_SFX=leak
320 TEST_RESULTS_SAN_FILE=
321 TEST_RESULTS_SAN_DIR="$TEST_RESULTS_DIR/$TEST_NAME.$TEST_RESULTS_SAN_DIR_SFX"
322 TEST_RESULTS_SAN_DIR_NR_LEAKS_STARTUP=
323 TRASH_DIRECTORY="trash directory.$TEST_NAME$TEST_STRESS_JOB_SFX"
324 test -n "$root" && TRASH_DIRECTORY="$root/$TRASH_DIRECTORY"
325 case "$TRASH_DIRECTORY" in
326 /*) ;; # absolute path is good
327 *) TRASH_DIRECTORY="$TEST_OUTPUT_DIRECTORY/$TRASH_DIRECTORY" ;;
328 esac
329
330 # Utility functions using $TEST_RESULTS_* variables
331 nr_san_dir_leaks_ () {
332 # stderr piped to /dev/null because the directory may have
333 # been "rmdir"'d already.
334 find "$TEST_RESULTS_SAN_DIR" \
335 -type f \
336 -name "$TEST_RESULTS_SAN_FILE_PFX.*" 2>/dev/null |
337 wc -l
338 }
339
340 # If --stress was passed, run this test repeatedly in several parallel loops.
341 if test "$GIT_TEST_STRESS_STARTED" = "done"
342 then
343 : # Don't stress test again.
344 elif test -n "$stress"
345 then
346 if test -n "$stress_jobs"
347 then
348 job_count=$stress_jobs
349 elif test -n "$GIT_TEST_STRESS_LOAD"
350 then
351 job_count="$GIT_TEST_STRESS_LOAD"
352 elif job_count=$(getconf _NPROCESSORS_ONLN 2>/dev/null) &&
353 test -n "$job_count"
354 then
355 job_count=$((2 * $job_count))
356 else
357 job_count=8
358 fi
359
360 mkdir -p "$TEST_RESULTS_DIR"
361 stressfail="$TEST_RESULTS_BASE.stress-failed"
362 rm -f "$stressfail"
363
364 stress_exit=0
365 trap '
366 kill $job_pids 2>/dev/null
367 wait
368 stress_exit=1
369 ' TERM INT HUP
370
371 job_pids=
372 job_nr=0
373 while test $job_nr -lt "$job_count"
374 do
375 (
376 GIT_TEST_STRESS_STARTED=done
377 GIT_TEST_STRESS_JOB_NR=$job_nr
378 export GIT_TEST_STRESS_STARTED GIT_TEST_STRESS_JOB_NR
379
380 trap '
381 kill $test_pid 2>/dev/null
382 wait
383 exit 1
384 ' TERM INT
385
386 cnt=1
387 while ! test -e "$stressfail" &&
388 { test -z "$stress_limit" ||
389 test $cnt -le $stress_limit ; }
390 do
391 $TEST_SHELL_PATH "$0" "$@" >"$TEST_RESULTS_BASE.stress-$job_nr.out" 2>&1 &
392 test_pid=$!
393
394 if wait $test_pid
395 then
396 printf "OK %2d.%d\n" $GIT_TEST_STRESS_JOB_NR $cnt
397 else
398 echo $GIT_TEST_STRESS_JOB_NR >>"$stressfail"
399 printf "FAIL %2d.%d\n" $GIT_TEST_STRESS_JOB_NR $cnt
400 fi
401 cnt=$(($cnt + 1))
402 done
403 ) &
404 job_pids="$job_pids $!"
405 job_nr=$(($job_nr + 1))
406 done
407
408 wait
409
410 if test -f "$stressfail"
411 then
412 stress_exit=1
413 echo "Log(s) of failed test run(s):"
414 for failed_job_nr in $(sort -n "$stressfail")
415 do
416 echo "Contents of '$TEST_RESULTS_BASE.stress-$failed_job_nr.out':"
417 cat "$TEST_RESULTS_BASE.stress-$failed_job_nr.out"
418 done
419 rm -rf "$TRASH_DIRECTORY.stress-failed"
420 # Move the last one.
421 mv "$TRASH_DIRECTORY.stress-$failed_job_nr" "$TRASH_DIRECTORY.stress-failed"
422 fi
423
424 exit $stress_exit
425 fi
426
427 # if --tee was passed, write the output not only to the terminal, but
428 # additionally to the file test-results/$BASENAME.out, too.
429 if test "$GIT_TEST_TEE_STARTED" = "done"
430 then
431 : # do not redirect again
432 elif test -n "$tee"
433 then
434 mkdir -p "$TEST_RESULTS_DIR"
435
436 # Make this filename available to the sub-process in case it is using
437 # --verbose-log.
438 GIT_TEST_TEE_OUTPUT_FILE=$TEST_RESULTS_BASE.out
439 export GIT_TEST_TEE_OUTPUT_FILE
440
441 # Truncate before calling "tee -a" to get rid of the results
442 # from any previous runs.
443 >"$GIT_TEST_TEE_OUTPUT_FILE"
444
445 (GIT_TEST_TEE_STARTED=done ${TEST_SHELL_PATH} "$0" "$@" 2>&1;
446 echo $? >"$TEST_RESULTS_BASE.exit") | tee -a "$GIT_TEST_TEE_OUTPUT_FILE"
447 test "$(cat "$TEST_RESULTS_BASE.exit")" = 0
448 exit
449 fi
450
451 if test -n "$trace" && test -n "$test_untraceable"
452 then
453 # '-x' tracing requested, but this test script can't be reliably
454 # traced, unless it is run with a Bash version supporting
455 # BASH_XTRACEFD (introduced in Bash v4.1).
456 #
457 # Perform this version check _after_ the test script was
458 # potentially re-executed with $TEST_SHELL_PATH for '--tee' or
459 # '--verbose-log', so the right shell is checked and the
460 # warning is issued only once.
461 if test -n "$BASH_VERSION" && eval '
462 test ${BASH_VERSINFO[0]} -gt 4 || {
463 test ${BASH_VERSINFO[0]} -eq 4 &&
464 test ${BASH_VERSINFO[1]} -ge 1
465 }
466 '
467 then
468 : Executed by a Bash version supporting BASH_XTRACEFD. Good.
469 else
470 echo >&2 "warning: ignoring -x; '$0' is untraceable without BASH_XTRACEFD"
471 trace=
472 fi
473 fi
474 if test -n "$trace" && test -z "$verbose_log"
475 then
476 verbose=t
477 fi
478
479 # Since bash 5.0, checkwinsize is enabled by default which does
480 # update the COLUMNS variable every time a non-builtin command
481 # completes, even for non-interactive shells.
482 # Disable that since we are aiming for repeatability.
483 test -n "$BASH_VERSION" && shopt -u checkwinsize 2>/dev/null
484
485 # For repeatability, reset the environment to known value.
486 # TERM is sanitized below, after saving color control sequences.
487 LANG=C
488 LC_ALL=C
489 PAGER=cat
490 TZ=UTC
491 COLUMNS=80
492 export LANG LC_ALL PAGER TZ COLUMNS
493 EDITOR=:
494
495 # A call to "unset" with no arguments causes at least Solaris 10
496 # /usr/xpg4/bin/sh and /bin/ksh to bail out. So keep the unsets
497 # deriving from the command substitution clustered with the other
498 # ones.
499 unset VISUAL EMAIL LANGUAGE $("$PERL_PATH" -e '
500 my @env = keys %ENV;
501 my $ok = join("|", qw(
502 TRACE
503 DEBUG
504 TEST
505 .*_TEST
506 PROVE
507 VALGRIND
508 UNZIP
509 PERF_
510 CURL_VERBOSE
511 TRACE_CURL
512 ));
513 my @vars = grep(/^GIT_/ && !/^GIT_($ok)/o, @env);
514 print join("\n", @vars);
515 ')
516 unset XDG_CACHE_HOME
517 unset XDG_CONFIG_HOME
518 unset GITPERLLIB
519 unset GIT_TRACE2_PARENT_NAME
520 unset GIT_TRACE2_PARENT_SID
521 TEST_AUTHOR_LOCALNAME=author
522 TEST_AUTHOR_DOMAIN=example.com
523 GIT_AUTHOR_EMAIL=${TEST_AUTHOR_LOCALNAME}@${TEST_AUTHOR_DOMAIN}
524 GIT_AUTHOR_NAME='A U Thor'
525 GIT_AUTHOR_DATE='1112354055 +0200'
526 TEST_COMMITTER_LOCALNAME=committer
527 TEST_COMMITTER_DOMAIN=example.com
528 GIT_COMMITTER_EMAIL=${TEST_COMMITTER_LOCALNAME}@${TEST_COMMITTER_DOMAIN}
529 GIT_COMMITTER_NAME='C O Mitter'
530 GIT_COMMITTER_DATE='1112354055 +0200'
531 GIT_MERGE_VERBOSITY=5
532 GIT_MERGE_AUTOEDIT=no
533 export GIT_MERGE_VERBOSITY GIT_MERGE_AUTOEDIT
534 export GIT_AUTHOR_EMAIL GIT_AUTHOR_NAME
535 export GIT_COMMITTER_EMAIL GIT_COMMITTER_NAME
536 export GIT_COMMITTER_DATE GIT_AUTHOR_DATE
537 export EDITOR
538
539 GIT_DEFAULT_HASH="${GIT_TEST_DEFAULT_HASH:-sha1}"
540 export GIT_DEFAULT_HASH
541 GIT_TEST_MERGE_ALGORITHM="${GIT_TEST_MERGE_ALGORITHM:-ort}"
542 export GIT_TEST_MERGE_ALGORITHM
543
544 # Tests using GIT_TRACE typically don't want <timestamp> <file>:<line> output
545 GIT_TRACE_BARE=1
546 export GIT_TRACE_BARE
547
548 # Some tests scan the GIT_TRACE2_EVENT feed for events, but the
549 # default depth is 2, which frequently causes issues when the
550 # events are wrapped in new regions. Set it to a sufficiently
551 # large depth to avoid custom changes in the test suite.
552 GIT_TRACE2_EVENT_NESTING=100
553 export GIT_TRACE2_EVENT_NESTING
554
555 # Use specific version of the index file format
556 if test -n "${GIT_TEST_INDEX_VERSION:+isset}"
557 then
558 GIT_INDEX_VERSION="$GIT_TEST_INDEX_VERSION"
559 export GIT_INDEX_VERSION
560 fi
561
562 if test -n "$GIT_TEST_PERL_FATAL_WARNINGS"
563 then
564 GIT_PERL_FATAL_WARNINGS=1
565 export GIT_PERL_FATAL_WARNINGS
566 fi
567
568 case $GIT_TEST_FSYNC in
569 '')
570 GIT_TEST_FSYNC=0
571 export GIT_TEST_FSYNC
572 ;;
573 esac
574
575 # Add libc MALLOC and MALLOC_PERTURB test only if we are not executing
576 # the test with valgrind and have not compiled with conflict SANITIZE
577 # options.
578 if test -n "$valgrind" ||
579 test -n "$SANITIZE_ADDRESS" ||
580 test -n "$SANITIZE_LEAK" ||
581 test -n "$TEST_NO_MALLOC_CHECK"
582 then
583 setup_malloc_check () {
584 : nothing
585 }
586 teardown_malloc_check () {
587 : nothing
588 }
589 else
590 _USE_GLIBC_TUNABLES=
591 if _GLIBC_VERSION=$(getconf GNU_LIBC_VERSION 2>/dev/null) &&
592 _GLIBC_VERSION=${_GLIBC_VERSION#"glibc "} &&
593 expr 2.34 \<= "$_GLIBC_VERSION" >/dev/null
594 then
595 _USE_GLIBC_TUNABLES=YesPlease
596 fi
597 setup_malloc_check () {
598 local g
599 local t
600 MALLOC_CHECK_=3 MALLOC_PERTURB_=165
601 export MALLOC_CHECK_ MALLOC_PERTURB_
602 if test -n "$_USE_GLIBC_TUNABLES"
603 then
604 g=
605 LD_PRELOAD="libc_malloc_debug.so.0"
606 for t in \
607 glibc.malloc.check=1 \
608 glibc.malloc.perturb=165
609 do
610 g="${g#:}:$t"
611 done
612 GLIBC_TUNABLES=$g
613 export LD_PRELOAD GLIBC_TUNABLES
614 fi
615 }
616 teardown_malloc_check () {
617 unset MALLOC_CHECK_ MALLOC_PERTURB_
618 unset LD_PRELOAD GLIBC_TUNABLES
619 }
620 fi
621
622 # Protect ourselves from common misconfiguration to export
623 # CDPATH into the environment
624 unset CDPATH
625
626 unset GREP_OPTIONS
627 unset UNZIP
628
629 case $(echo $GIT_TRACE |tr "[A-Z]" "[a-z]") in
630 1|2|true)
631 GIT_TRACE=4
632 ;;
633 esac
634
635 # Line feed
636 LF='
637 '
638
639 # Single quote
640 SQ=\'
641
642 # UTF-8 ZERO WIDTH NON-JOINER, which HFS+ ignores
643 # when case-folding filenames
644 u200c=$(printf '\342\200\214')
645
646 export _x05 _x35 LF u200c EMPTY_TREE EMPTY_BLOB ZERO_OID OID_REGEX
647
648 # Each test should start with something like this, after copyright notices:
649 #
650 # test_description='Description of this test...
651 # This test checks if command xyzzy does the right thing...
652 # '
653 # . ./test-lib.sh
654 test "x$TERM" != "xdumb" && (
655 test -t 1 &&
656 tput bold >/dev/null 2>&1 &&
657 tput setaf 1 >/dev/null 2>&1 &&
658 tput sgr0 >/dev/null 2>&1
659 ) &&
660 color=t
661
662 if test -n "$color"
663 then
664 # Save the color control sequences now rather than run tput
665 # each time say_color() is called. This is done for two
666 # reasons:
667 # * TERM will be changed to dumb
668 # * HOME will be changed to a temporary directory and tput
669 # might need to read ~/.terminfo from the original HOME
670 # directory to get the control sequences
671 # Note: This approach assumes the control sequences don't end
672 # in a newline for any terminal of interest (command
673 # substitutions strip trailing newlines). Given that most
674 # (all?) terminals in common use are related to ECMA-48, this
675 # shouldn't be a problem.
676 say_color_error=$(tput bold; tput setaf 1) # bold red
677 say_color_skip=$(tput setaf 4) # blue
678 say_color_warn=$(tput setaf 3) # brown/yellow
679 say_color_pass=$(tput setaf 2) # green
680 say_color_info=$(tput setaf 6) # cyan
681 say_color_reset=$(tput sgr0)
682 say_color_="" # no formatting for normal text
683 say_color () {
684 test -z "$1" && test -n "$quiet" && return
685 eval "say_color_color=\$say_color_$1"
686 shift
687 printf "%s\\n" "$say_color_color$*$say_color_reset"
688 }
689 else
690 say_color() {
691 test -z "$1" && test -n "$quiet" && return
692 shift
693 printf "%s\n" "$*"
694 }
695 fi
696
697 USER_TERM="$TERM"
698 TERM=dumb
699 export TERM USER_TERM
700
701 # What is written by tests to stdout and stderr is sent to different places
702 # depending on the test mode (e.g. /dev/null in non-verbose mode, piped to tee
703 # with --tee option, etc.). We save the original stdin to FD #6 and stdout and
704 # stderr to #5 and #7, so that the test framework can use them (e.g. for
705 # printing errors within the test framework) independently of the test mode.
706 exec 5>&1
707 exec 6<&0
708 exec 7>&2
709
710 _error_exit () {
711 finalize_test_output
712 GIT_EXIT_OK=t
713 exit 1
714 }
715
716 error () {
717 say_color error "error: $*"
718 _error_exit
719 }
720
721 BUG () {
722 error >&7 "bug in the test script: $*"
723 }
724
725 BAIL_OUT () {
726 test $# -ne 1 && BUG "1 param"
727
728 # Do not change "Bail out! " string. It's part of TAP syntax:
729 # https://testanything.org/tap-specification.html
730 local bail_out="Bail out! "
731 local message="$1"
732
733 say_color >&5 error $bail_out "$message"
734 _error_exit
735 }
736
737 say () {
738 say_color info "$*"
739 }
740
741 if test -n "$HARNESS_ACTIVE"
742 then
743 if test "$verbose" = t || test -n "$verbose_only"
744 then
745 BAIL_OUT 'verbose mode forbidden under TAP harness; try --verbose-log'
746 fi
747 fi
748
749 test "${test_description}" != "" ||
750 error "Test script did not set test_description."
751
752 if test "$help" = "t"
753 then
754 printf '%s\n' "$test_description"
755 exit 0
756 fi
757
758 if test "$verbose_log" = "t"
759 then
760 exec 3>>"$GIT_TEST_TEE_OUTPUT_FILE" 4>&3
761 elif test "$verbose" = "t"
762 then
763 exec 4>&2 3>&1
764 else
765 exec 4>/dev/null 3>/dev/null
766 fi
767
768 # Send any "-x" output directly to stderr to avoid polluting tests
769 # which capture stderr. We can do this unconditionally since it
770 # has no effect if tracing isn't turned on.
771 #
772 # Note that this sets up the trace fd as soon as we assign the variable, so it
773 # must come after the creation of descriptor 4 above. Likewise, we must never
774 # unset this, as it has the side effect of closing descriptor 4, which we
775 # use to show verbose tests to the user.
776 #
777 # Note also that we don't need or want to export it. The tracing is local to
778 # this shell, and we would not want to influence any shells we exec.
779 BASH_XTRACEFD=4
780
781 test_failure=0
782 test_count=0
783 test_fixed=0
784 test_broken=0
785 test_success=0
786
787 test_missing_prereq=
788
789 test_external_has_tap=0
790
791 die () {
792 code=$?
793 # This is responsible for running the atexit commands even when a
794 # test script run with '--immediate' fails, or when the user hits
795 # ctrl-C, i.e. when 'test_done' is not invoked at all.
796 test_atexit_handler || code=$?
797 if test -n "$GIT_EXIT_OK"
798 then
799 exit $code
800 else
801 echo >&5 "FATAL: Unexpected exit with code $code"
802 exit 1
803 fi
804 }
805
806 GIT_EXIT_OK=
807 trap 'die' EXIT
808 # Disable '-x' tracing, because with some shells, notably dash, it
809 # prevents running the cleanup commands when a test script run with
810 # '--verbose-log -x' is interrupted.
811 trap '{ code=$?; set +x; } 2>/dev/null; exit $code' INT TERM HUP
812
813 # The user-facing functions are loaded from a separate file so that
814 # test_perf subshells can have them too
815 . "$TEST_DIRECTORY/test-lib-functions.sh"
816
817 # You are not expected to call test_ok_ and test_failure_ directly, use
818 # the test_expect_* functions instead.
819
820 test_ok_ () {
821 test_success=$(($test_success + 1))
822 say_color "" "ok $test_count - $@"
823 finalize_test_case_output ok "$@"
824 }
825
826 _invert_exit_code_failure_end_blurb () {
827 say_color warn "# faked up failures as TODO & now exiting with 0 due to --invert-exit-code"
828 }
829
830 test_failure_ () {
831 failure_label=$1
832 test_failure=$(($test_failure + 1))
833 local pfx=""
834 if test -n "$invert_exit_code" # && test -n "$HARNESS_ACTIVE"
835 then
836 pfx="# TODO induced breakage (--invert-exit-code):"
837 fi
838 say_color error "not ok $test_count - ${pfx:+$pfx }$1"
839 shift
840 printf '%s\n' "$*" | sed -e 's/^/# /'
841 if test -n "$immediate"
842 then
843 say_color error "1..$test_count"
844 if test -n "$invert_exit_code"
845 then
846 finalize_test_output
847 _invert_exit_code_failure_end_blurb
848 GIT_EXIT_OK=t
849 exit 0
850 fi
851 _error_exit
852 fi
853 finalize_test_case_output failure "$failure_label" "$@"
854 }
855
856 test_known_broken_ok_ () {
857 test_fixed=$(($test_fixed+1))
858 say_color error "ok $test_count - $1 # TODO known breakage vanished"
859 finalize_test_case_output fixed "$1"
860 }
861
862 test_known_broken_failure_ () {
863 test_broken=$(($test_broken+1))
864 say_color warn "not ok $test_count - $1 # TODO known breakage"
865 finalize_test_case_output broken "$1"
866 }
867
868 test_debug () {
869 test "$debug" = "" || eval "$1"
870 }
871
872 match_pattern_list () {
873 arg="$1"
874 shift
875 test -z "$*" && return 1
876 # We need to use "$*" to get field-splitting, but we want to
877 # disable globbing, since we are matching against an arbitrary
878 # $arg, not what's in the filesystem. Using "set -f" accomplishes
879 # that, but we must do it in a subshell to avoid impacting the
880 # rest of the script. The exit value of the subshell becomes
881 # the function's return value.
882 (
883 set -f
884 for pattern_ in $*
885 do
886 case "$arg" in
887 $pattern_)
888 exit 0
889 ;;
890 esac
891 done
892 exit 1
893 )
894 }
895
896 match_test_selector_list () {
897 operation="$1"
898 shift
899 title="$1"
900 shift
901 arg="$1"
902 shift
903 test -z "$1" && return 0
904
905 # Commas are accepted as separators.
906 OLDIFS=$IFS
907 IFS=','
908 set -- $1
909 IFS=$OLDIFS
910
911 # If the first selector is negative we include by default.
912 include=
913 case "$1" in
914 !*) include=t ;;
915 esac
916
917 for selector
918 do
919 orig_selector=$selector
920
921 positive=t
922 case "$selector" in
923 !*)
924 positive=
925 selector=${selector##?}
926 ;;
927 esac
928
929 test -z "$selector" && continue
930
931 case "$selector" in
932 *-*)
933 if expr "z${selector%%-*}" : "z[0-9]*[^0-9]" >/dev/null
934 then
935 echo "error: $operation: invalid non-numeric in range" \
936 "start: '$orig_selector'" >&2
937 exit 1
938 fi
939 if expr "z${selector#*-}" : "z[0-9]*[^0-9]" >/dev/null
940 then
941 echo "error: $operation: invalid non-numeric in range" \
942 "end: '$orig_selector'" >&2
943 exit 1
944 fi
945 ;;
946 *)
947 if expr "z$selector" : "z[0-9]*[^0-9]" >/dev/null
948 then
949 case "$title" in *${selector}*)
950 include=$positive
951 ;;
952 esac
953 continue
954 fi
955 esac
956
957 # Short cut for "obvious" cases
958 test -z "$include" && test -z "$positive" && continue
959 test -n "$include" && test -n "$positive" && continue
960
961 case "$selector" in
962 -*)
963 if test $arg -le ${selector#-}
964 then
965 include=$positive
966 fi
967 ;;
968 *-)
969 if test $arg -ge ${selector%-}
970 then
971 include=$positive
972 fi
973 ;;
974 *-*)
975 if test ${selector%%-*} -le $arg \
976 && test $arg -le ${selector#*-}
977 then
978 include=$positive
979 fi
980 ;;
981 *)
982 if test $arg -eq $selector
983 then
984 include=$positive
985 fi
986 ;;
987 esac
988 done
989
990 test -n "$include"
991 }
992
993 maybe_teardown_verbose () {
994 test -z "$verbose_only" && return
995 exec 4>/dev/null 3>/dev/null
996 verbose=
997 }
998
999 last_verbose=t
1000 maybe_setup_verbose () {
1001 test -z "$verbose_only" && return
1002 if match_pattern_list $test_count "$verbose_only"
1003 then
1004 exec 4>&2 3>&1
1005 # Emit a delimiting blank line when going from
1006 # non-verbose to verbose. Within verbose mode the
1007 # delimiter is printed by test_expect_*. The choice
1008 # of the initial $last_verbose is such that before
1009 # test 1, we do not print it.
1010 test -z "$last_verbose" && echo >&3 ""
1011 verbose=t
1012 else
1013 exec 4>/dev/null 3>/dev/null
1014 verbose=
1015 fi
1016 last_verbose=$verbose
1017 }
1018
1019 maybe_teardown_valgrind () {
1020 test -z "$GIT_VALGRIND" && return
1021 GIT_VALGRIND_ENABLED=
1022 }
1023
1024 maybe_setup_valgrind () {
1025 test -z "$GIT_VALGRIND" && return
1026 if test -z "$valgrind_only"
1027 then
1028 GIT_VALGRIND_ENABLED=t
1029 return
1030 fi
1031 GIT_VALGRIND_ENABLED=
1032 if match_pattern_list $test_count "$valgrind_only"
1033 then
1034 GIT_VALGRIND_ENABLED=t
1035 fi
1036 }
1037
1038 trace_level_=0
1039 want_trace () {
1040 test "$trace" = t && {
1041 test "$verbose" = t || test "$verbose_log" = t
1042 }
1043 }
1044
1045 # This is a separate function because some tests use
1046 # "return" to end a test_expect_success block early
1047 # (and we want to make sure we run any cleanup like
1048 # "set +x").
1049 test_eval_inner_ () {
1050 # Do not add anything extra (including LF) after '$*'
1051 eval "
1052 want_trace && trace_level_=$(($trace_level_+1)) && set -x
1053 $*"
1054 }
1055
1056 test_eval_ () {
1057 # If "-x" tracing is in effect, then we want to avoid polluting stderr
1058 # with non-test commands. But once in "set -x" mode, we cannot prevent
1059 # the shell from printing the "set +x" to turn it off (nor the saving
1060 # of $? before that). But we can make sure that the output goes to
1061 # /dev/null.
1062 #
1063 # There are a few subtleties here:
1064 #
1065 # - we have to redirect descriptor 4 in addition to 2, to cover
1066 # BASH_XTRACEFD
1067 #
1068 # - the actual eval has to come before the redirection block (since
1069 # it needs to see descriptor 4 to set up its stderr)
1070 #
1071 # - likewise, any error message we print must be outside the block to
1072 # access descriptor 4
1073 #
1074 # - checking $? has to come immediately after the eval, but it must
1075 # be _inside_ the block to avoid polluting the "set -x" output
1076 #
1077
1078 test_eval_inner_ "$@" </dev/null >&3 2>&4
1079 {
1080 test_eval_ret_=$?
1081 if want_trace
1082 then
1083 test 1 = $trace_level_ && set +x
1084 trace_level_=$(($trace_level_-1))
1085 fi
1086 } 2>/dev/null 4>&2
1087
1088 if test "$test_eval_ret_" != 0 && want_trace
1089 then
1090 say_color error >&4 "error: last command exited with \$?=$test_eval_ret_"
1091 fi
1092 return $test_eval_ret_
1093 }
1094
1095 test_run_ () {
1096 test_cleanup=:
1097 expecting_failure=$2
1098
1099 if test "${GIT_TEST_CHAIN_LINT:-1}" != 0; then
1100 # turn off tracing for this test-eval, as it simply creates
1101 # confusing noise in the "-x" output
1102 trace_tmp=$trace
1103 trace=
1104 # 117 is magic because it is unlikely to match the exit
1105 # code of other programs
1106 if test "OK-117" != "$(test_eval_ "(exit 117) && $1${LF}${LF}echo OK-\$?" 3>&1)"
1107 then
1108 BUG "broken &&-chain or run-away HERE-DOC: $1"
1109 fi
1110 trace=$trace_tmp
1111 fi
1112
1113 setup_malloc_check
1114 test_eval_ "$1"
1115 eval_ret=$?
1116 teardown_malloc_check
1117
1118 if test -z "$immediate" || test $eval_ret = 0 ||
1119 test -n "$expecting_failure" && test "$test_cleanup" != ":"
1120 then
1121 setup_malloc_check
1122 test_eval_ "$test_cleanup"
1123 teardown_malloc_check
1124 fi
1125 if test "$verbose" = "t" && test -n "$HARNESS_ACTIVE"
1126 then
1127 echo ""
1128 fi
1129 return "$eval_ret"
1130 }
1131
1132 test_start_ () {
1133 test_count=$(($test_count+1))
1134 maybe_setup_verbose
1135 maybe_setup_valgrind
1136 start_test_case_output "$@"
1137 }
1138
1139 test_finish_ () {
1140 echo >&3 ""
1141 maybe_teardown_valgrind
1142 maybe_teardown_verbose
1143 if test -n "$GIT_TEST_TEE_OFFSET"
1144 then
1145 GIT_TEST_TEE_OFFSET=$(test-tool path-utils file-size \
1146 "$GIT_TEST_TEE_OUTPUT_FILE")
1147 fi
1148 }
1149
1150 test_skip () {
1151 to_skip=
1152 skipped_reason=
1153 if match_pattern_list $this_test.$test_count "$GIT_SKIP_TESTS"
1154 then
1155 to_skip=t
1156 skipped_reason="GIT_SKIP_TESTS"
1157 fi
1158 if test -z "$to_skip" && test -n "$run_list" &&
1159 ! match_test_selector_list '--run' "$1" $test_count "$run_list"
1160 then
1161 to_skip=t
1162 skipped_reason="--run"
1163 fi
1164 if test -z "$to_skip" && test -n "$test_prereq" &&
1165 ! test_have_prereq "$test_prereq"
1166 then
1167 to_skip=t
1168
1169 of_prereq=
1170 if test "$missing_prereq" != "$test_prereq"
1171 then
1172 of_prereq=" of $test_prereq"
1173 fi
1174 skipped_reason="missing $missing_prereq${of_prereq}"
1175
1176 # Keep a list of all the missing prereq for result aggregation
1177 if test -z "$missing_prereq"
1178 then
1179 test_missing_prereq=$missing_prereq
1180 else
1181 test_missing_prereq="$test_missing_prereq,$missing_prereq"
1182 fi
1183 fi
1184
1185 case "$to_skip" in
1186 t)
1187
1188 say_color skip "ok $test_count # skip $1 ($skipped_reason)"
1189 : true
1190 finalize_test_case_output skip "$@"
1191 ;;
1192 *)
1193 false
1194 ;;
1195 esac
1196 }
1197
1198 # stub; perf-lib overrides it
1199 test_at_end_hook_ () {
1200 :
1201 }
1202
1203 test_atexit_cleanup=:
1204 test_atexit_handler () {
1205 # In a succeeding test script 'test_atexit_handler' is invoked
1206 # twice: first from 'test_done', then from 'die' in the trap on
1207 # EXIT.
1208 # This condition and resetting 'test_atexit_cleanup' below makes
1209 # sure that the registered cleanup commands are run only once.
1210 test : != "$test_atexit_cleanup" || return 0
1211
1212 setup_malloc_check
1213 test_eval_ "$test_atexit_cleanup"
1214 test_atexit_cleanup=:
1215 teardown_malloc_check
1216 }
1217
1218 sanitize_leak_log_message_ () {
1219 local new="$1" &&
1220 local old="$2" &&
1221 local file="$3" &&
1222
1223 printf "With SANITIZE=leak at exit we have %d leak logs, but started with %d
1224
1225 This means that we have a blindspot where git is leaking but we're
1226 losing the exit code somewhere, or not propagating it appropriately
1227 upwards!
1228
1229 See the logs at \"%s.*\";
1230 those logs are reproduced below." \
1231 "$new" "$old" "$file"
1232 }
1233
1234 check_test_results_san_file_ () {
1235 if test -z "$TEST_RESULTS_SAN_FILE"
1236 then
1237 return
1238 fi &&
1239 local old="$TEST_RESULTS_SAN_DIR_NR_LEAKS_STARTUP" &&
1240 local new="$(nr_san_dir_leaks_)" &&
1241
1242 if test $new -le $old
1243 then
1244 return
1245 fi &&
1246 local out="$(sanitize_leak_log_message_ "$new" "$old" "$TEST_RESULTS_SAN_FILE")" &&
1247 say_color error "$out" &&
1248 if test "$old" != 0
1249 then
1250 echo &&
1251 say_color error "The logs include output from past runs to avoid" &&
1252 say_color error "that remove 'test-results' between runs."
1253 fi &&
1254 say_color error "$(cat "$TEST_RESULTS_SAN_FILE".*)" &&
1255
1256 if test -n "$passes_sanitize_leak" && test "$test_failure" = 0
1257 then
1258 say "As TEST_PASSES_SANITIZE_LEAK=true and our logs show we're leaking, exit non-zero!" &&
1259 invert_exit_code=t
1260 elif test -n "$passes_sanitize_leak"
1261 then
1262 say "As TEST_PASSES_SANITIZE_LEAK=true and our logs show we're leaking, and we're failing for other reasons too..." &&
1263 invert_exit_code=
1264 elif test -n "$sanitize_leak_check" && test "$test_failure" = 0
1265 then
1266 say "As TEST_PASSES_SANITIZE_LEAK=true isn't set the above leak is 'ok' with GIT_TEST_PASSING_SANITIZE_LEAK=check" &&
1267 invert_exit_code=
1268 elif test -n "$sanitize_leak_check"
1269 then
1270 say "As TEST_PASSES_SANITIZE_LEAK=true isn't set the above leak is 'ok' with GIT_TEST_PASSING_SANITIZE_LEAK=check" &&
1271 invert_exit_code=t
1272 else
1273 say "With GIT_TEST_SANITIZE_LEAK_LOG=true our logs revealed a memory leak, exit non-zero!" &&
1274 invert_exit_code=t
1275 fi
1276 }
1277
1278 test_done () {
1279 # Run the atexit commands _before_ the trash directory is
1280 # removed, so the commands can access pidfiles and socket files.
1281 test_atexit_handler
1282
1283 finalize_test_output
1284
1285 if test -z "$HARNESS_ACTIVE"
1286 then
1287 mkdir -p "$TEST_RESULTS_DIR"
1288
1289 cat >"$TEST_RESULTS_BASE.counts" <<-EOF
1290 total $test_count
1291 success $test_success
1292 fixed $test_fixed
1293 broken $test_broken
1294 failed $test_failure
1295 missing_prereq $test_missing_prereq
1296
1297 EOF
1298 fi
1299
1300 if test "$test_fixed" != 0
1301 then
1302 say_color error "# $test_fixed known breakage(s) vanished; please update test(s)"
1303 fi
1304 if test "$test_broken" != 0
1305 then
1306 say_color warn "# still have $test_broken known breakage(s)"
1307 fi
1308 if test "$test_broken" != 0 || test "$test_fixed" != 0
1309 then
1310 test_remaining=$(( $test_count - $test_broken - $test_fixed ))
1311 msg="remaining $test_remaining test(s)"
1312 else
1313 test_remaining=$test_count
1314 msg="$test_count test(s)"
1315 fi
1316 case "$test_failure" in
1317 0)
1318 if test $test_remaining -gt 0
1319 then
1320 say_color pass "# passed all $msg"
1321 fi
1322
1323 # Maybe print SKIP message
1324 test -z "$skip_all" || skip_all="# SKIP $skip_all"
1325 case "$test_count" in
1326 0)
1327 say "1..$test_count${skip_all:+ $skip_all}"
1328 ;;
1329 *)
1330 test -z "$skip_all" ||
1331 say_color warn "$skip_all"
1332 say "1..$test_count"
1333 ;;
1334 esac
1335
1336 if test -n "$stress" && test -n "$invert_exit_code"
1337 then
1338 # We're about to move our "$TRASH_DIRECTORY"
1339 # to "$TRASH_DIRECTORY.stress-failed" if
1340 # --stress is combined with
1341 # --invert-exit-code.
1342 say "with --stress and --invert-exit-code we're not removing '$TRASH_DIRECTORY'"
1343 elif test -z "$debug" && test -n "$remove_trash"
1344 then
1345 test -d "$TRASH_DIRECTORY" ||
1346 error "Tests passed but trash directory already removed before test cleanup; aborting"
1347
1348 cd "$TRASH_DIRECTORY/.." &&
1349 rm -fr "$TRASH_DIRECTORY" || {
1350 # try again in a bit
1351 sleep 5;
1352 rm -fr "$TRASH_DIRECTORY"
1353 } ||
1354 error "Tests passed but test cleanup failed; aborting"
1355 fi
1356
1357 check_test_results_san_file_ "$test_failure"
1358
1359 if test -z "$skip_all" && test -n "$invert_exit_code"
1360 then
1361 say_color warn "# faking up non-zero exit with --invert-exit-code"
1362 GIT_EXIT_OK=t
1363 exit 1
1364 fi
1365
1366 test_at_end_hook_
1367
1368 GIT_EXIT_OK=t
1369 exit 0 ;;
1370
1371 *)
1372 say_color error "# failed $test_failure among $msg"
1373 say "1..$test_count"
1374
1375 check_test_results_san_file_ "$test_failure"
1376
1377 if test -n "$invert_exit_code"
1378 then
1379 _invert_exit_code_failure_end_blurb
1380 GIT_EXIT_OK=t
1381 exit 0
1382 fi
1383
1384 GIT_EXIT_OK=t
1385 exit 1 ;;
1386
1387 esac
1388 }
1389
1390 if test -n "$valgrind"
1391 then
1392 make_symlink () {
1393 test -h "$2" &&
1394 test "$1" = "$(readlink "$2")" || {
1395 # be super paranoid
1396 if mkdir "$2".lock
1397 then
1398 rm -f "$2" &&
1399 ln -s "$1" "$2" &&
1400 rm -r "$2".lock
1401 else
1402 while test -d "$2".lock
1403 do
1404 say "Waiting for lock on $2."
1405 sleep 1
1406 done
1407 fi
1408 }
1409 }
1410
1411 make_valgrind_symlink () {
1412 # handle only executables, unless they are shell libraries that
1413 # need to be in the exec-path.
1414 test -x "$1" ||
1415 test "# " = "$(test_copy_bytes 2 <"$1")" ||
1416 return;
1417
1418 base=$(basename "$1")
1419 case "$base" in
1420 test-*)
1421 symlink_target="$GIT_BUILD_DIR/t/helper/$base"
1422 ;;
1423 *)
1424 symlink_target="$GIT_BUILD_DIR/$base"
1425 ;;
1426 esac
1427 # do not override scripts
1428 if test -x "$symlink_target" &&
1429 test ! -d "$symlink_target" &&
1430 test "#!" != "$(test_copy_bytes 2 <"$symlink_target")"
1431 then
1432 symlink_target=../valgrind.sh
1433 fi
1434 case "$base" in
1435 *.sh|*.perl)
1436 symlink_target=../unprocessed-script
1437 esac
1438 # create the link, or replace it if it is out of date
1439 make_symlink "$symlink_target" "$GIT_VALGRIND/bin/$base" || exit
1440 }
1441
1442 # override all git executables in TEST_DIRECTORY/..
1443 GIT_VALGRIND=$TEST_DIRECTORY/valgrind
1444 mkdir -p "$GIT_VALGRIND"/bin
1445 for file in $GIT_BUILD_DIR/git* $GIT_BUILD_DIR/t/helper/test-*
1446 do
1447 make_valgrind_symlink $file
1448 done
1449 # special-case the mergetools loadables
1450 make_symlink "$GIT_BUILD_DIR"/mergetools "$GIT_VALGRIND/bin/mergetools"
1451 OLDIFS=$IFS
1452 IFS=:
1453 for path in $PATH
1454 do
1455 ls "$path"/git-* 2> /dev/null |
1456 while read file
1457 do
1458 make_valgrind_symlink "$file"
1459 done
1460 done
1461 IFS=$OLDIFS
1462 PATH=$GIT_VALGRIND/bin:$PATH
1463 GIT_EXEC_PATH=$GIT_VALGRIND/bin
1464 export GIT_VALGRIND
1465 GIT_VALGRIND_MODE="$valgrind"
1466 export GIT_VALGRIND_MODE
1467 GIT_VALGRIND_ENABLED=t
1468 test -n "$valgrind_only" && GIT_VALGRIND_ENABLED=
1469 export GIT_VALGRIND_ENABLED
1470 elif test -n "$GIT_TEST_INSTALLED"
1471 then
1472 GIT_EXEC_PATH=$($GIT_TEST_INSTALLED/git --exec-path) ||
1473 error "Cannot run git from $GIT_TEST_INSTALLED."
1474 PATH=$GIT_TEST_INSTALLED:$GIT_BUILD_DIR/t/helper:$PATH
1475 GIT_EXEC_PATH=${GIT_TEST_EXEC_PATH:-$GIT_EXEC_PATH}
1476 else # normal case, use ../bin-wrappers only unless $with_dashes:
1477 if test -n "$no_bin_wrappers"
1478 then
1479 with_dashes=t
1480 else
1481 git_bin_dir="$GIT_BUILD_DIR/bin-wrappers"
1482 if ! test -x "$git_bin_dir/git"
1483 then
1484 if test -z "$with_dashes"
1485 then
1486 say "$git_bin_dir/git is not executable; using GIT_EXEC_PATH"
1487 fi
1488 with_dashes=t
1489 fi
1490 PATH="$git_bin_dir:$PATH"
1491 fi
1492 GIT_EXEC_PATH=$GIT_BUILD_DIR
1493 if test -n "$with_dashes"
1494 then
1495 PATH="$GIT_BUILD_DIR:$GIT_BUILD_DIR/t/helper:$PATH"
1496 fi
1497 fi
1498 GIT_TEMPLATE_DIR="$GIT_BUILD_DIR"/templates/blt
1499 GIT_CONFIG_NOSYSTEM=1
1500 GIT_ATTR_NOSYSTEM=1
1501 GIT_CEILING_DIRECTORIES="$TRASH_DIRECTORY/.."
1502 export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG_NOSYSTEM GIT_ATTR_NOSYSTEM GIT_CEILING_DIRECTORIES
1503
1504 if test -z "$GIT_TEST_CMP"
1505 then
1506 if test -n "$GIT_TEST_CMP_USE_COPIED_CONTEXT"
1507 then
1508 GIT_TEST_CMP="$DIFF -c"
1509 else
1510 GIT_TEST_CMP="$DIFF -u"
1511 fi
1512 fi
1513
1514 GITPERLLIB="$GIT_BUILD_DIR"/perl/build/lib
1515 export GITPERLLIB
1516 test -d "$GIT_BUILD_DIR"/templates/blt || {
1517 BAIL_OUT "You haven't built things yet, have you?"
1518 }
1519
1520 if ! test -x "$GIT_BUILD_DIR"/t/helper/test-tool$X
1521 then
1522 BAIL_OUT 'You need to build test-tool; Run "make t/helper/test-tool" in the source (toplevel) directory'
1523 fi
1524
1525 # Are we running this test at all?
1526 remove_trash=
1527 this_test=${0##*/}
1528 this_test=${this_test%%-*}
1529 if match_pattern_list "$this_test" "$GIT_SKIP_TESTS"
1530 then
1531 say_color info >&3 "skipping test $this_test altogether"
1532 skip_all="skip all tests in $this_test"
1533 test_done
1534 fi
1535
1536 BAIL_OUT_ENV_NEEDS_SANITIZE_LEAK () {
1537 BAIL_OUT "$1 has no effect except when compiled with SANITIZE=leak"
1538 }
1539
1540 if test -n "$SANITIZE_LEAK"
1541 then
1542 # Normalize with test_bool_env
1543 passes_sanitize_leak=
1544
1545 # We need to see TEST_PASSES_SANITIZE_LEAK in "test-tool
1546 # env-helper" (via test_bool_env)
1547 export TEST_PASSES_SANITIZE_LEAK
1548 if test_bool_env TEST_PASSES_SANITIZE_LEAK false
1549 then
1550 passes_sanitize_leak=t
1551 fi
1552
1553 if test "$GIT_TEST_PASSING_SANITIZE_LEAK" = "check"
1554 then
1555 sanitize_leak_check=t
1556 if test -n "$invert_exit_code"
1557 then
1558 BAIL_OUT "cannot use --invert-exit-code under GIT_TEST_PASSING_SANITIZE_LEAK=check"
1559 fi
1560
1561 if test -z "$passes_sanitize_leak"
1562 then
1563 say "in GIT_TEST_PASSING_SANITIZE_LEAK=check mode, setting --invert-exit-code for TEST_PASSES_SANITIZE_LEAK != true"
1564 invert_exit_code=t
1565 fi
1566 elif test -z "$passes_sanitize_leak" &&
1567 test_bool_env GIT_TEST_PASSING_SANITIZE_LEAK false
1568 then
1569 skip_all="skipping $this_test under GIT_TEST_PASSING_SANITIZE_LEAK=true"
1570 test_done
1571 fi
1572
1573 if test_bool_env GIT_TEST_SANITIZE_LEAK_LOG false
1574 then
1575 if ! mkdir -p "$TEST_RESULTS_SAN_DIR"
1576 then
1577 BAIL_OUT "cannot create $TEST_RESULTS_SAN_DIR"
1578 fi &&
1579 TEST_RESULTS_SAN_FILE="$TEST_RESULTS_SAN_DIR/$TEST_RESULTS_SAN_FILE_PFX"
1580
1581 # In case "test-results" is left over from a previous
1582 # run: Only report if new leaks show up.
1583 TEST_RESULTS_SAN_DIR_NR_LEAKS_STARTUP=$(nr_san_dir_leaks_)
1584
1585 # Don't litter *.leak dirs if there was nothing to report
1586 test_atexit "rmdir \"$TEST_RESULTS_SAN_DIR\" 2>/dev/null || :"
1587
1588 prepend_var LSAN_OPTIONS : dedup_token_length=9999
1589 prepend_var LSAN_OPTIONS : log_exe_name=1
1590 prepend_var LSAN_OPTIONS : log_path=\"$TEST_RESULTS_SAN_FILE\"
1591 export LSAN_OPTIONS
1592 fi
1593 elif test "$GIT_TEST_PASSING_SANITIZE_LEAK" = "check" ||
1594 test_bool_env GIT_TEST_PASSING_SANITIZE_LEAK false
1595 then
1596 BAIL_OUT_ENV_NEEDS_SANITIZE_LEAK "GIT_TEST_PASSING_SANITIZE_LEAK=true"
1597 elif test_bool_env GIT_TEST_SANITIZE_LEAK_LOG false
1598 then
1599 BAIL_OUT_ENV_NEEDS_SANITIZE_LEAK "GIT_TEST_SANITIZE_LEAK_LOG=true"
1600 fi
1601
1602 if test "${GIT_TEST_CHAIN_LINT:-1}" != 0
1603 then
1604 "$PERL_PATH" "$TEST_DIRECTORY/chainlint.pl" "$0" ||
1605 BUG "lint error (see '?!...!? annotations above)"
1606 fi
1607
1608 # Last-minute variable setup
1609 USER_HOME="$HOME"
1610 HOME="$TRASH_DIRECTORY"
1611 GNUPGHOME="$HOME/gnupg-home-not-used"
1612 export HOME GNUPGHOME USER_HOME
1613
1614 # "rm -rf" existing trash directory, even if a previous run left it
1615 # with bad permissions.
1616 remove_trash_directory () {
1617 dir="$1"
1618 if ! rm -rf "$dir" 2>/dev/null
1619 then
1620 chmod -R u+rwx "$dir"
1621 rm -rf "$dir"
1622 fi
1623 ! test -d "$dir"
1624 }
1625
1626 # Test repository
1627 remove_trash_directory "$TRASH_DIRECTORY" || {
1628 BAIL_OUT 'cannot prepare test area'
1629 }
1630
1631 remove_trash=t
1632 if test -z "$TEST_NO_CREATE_REPO"
1633 then
1634 git init \
1635 ${TEST_CREATE_REPO_NO_TEMPLATE:+--template=} \
1636 "$TRASH_DIRECTORY" >&3 2>&4 ||
1637 error "cannot run git init"
1638 else
1639 mkdir -p "$TRASH_DIRECTORY"
1640 fi
1641
1642 # Use -P to resolve symlinks in our working directory so that the cwd
1643 # in subprocesses like git equals our $PWD (for pathname comparisons).
1644 cd -P "$TRASH_DIRECTORY" || BAIL_OUT "cannot cd -P to \"$TRASH_DIRECTORY\""
1645
1646 start_test_output "$0"
1647
1648 # Convenience
1649 # A regexp to match 5 and 35 hexdigits
1650 _x05='[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
1651 _x35="$_x05$_x05$_x05$_x05$_x05$_x05$_x05"
1652
1653 test_oid_init
1654
1655 ZERO_OID=$(test_oid zero)
1656 OID_REGEX=$(echo $ZERO_OID | sed -e 's/0/[0-9a-f]/g')
1657 OIDPATH_REGEX=$(test_oid_to_path $ZERO_OID | sed -e 's/0/[0-9a-f]/g')
1658 EMPTY_TREE=$(test_oid empty_tree)
1659 EMPTY_BLOB=$(test_oid empty_blob)
1660
1661 # Provide an implementation of the 'yes' utility; the upper bound
1662 # limit is there to help Windows that cannot stop this loop from
1663 # wasting cycles when the downstream stops reading, so do not be
1664 # tempted to turn it into an infinite loop. cf. 6129c930 ("test-lib:
1665 # limit the output of the yes utility", 2016-02-02)
1666 yes () {
1667 if test $# = 0
1668 then
1669 y=y
1670 else
1671 y="$*"
1672 fi
1673
1674 i=0
1675 while test $i -lt 99
1676 do
1677 echo "$y"
1678 i=$(($i+1))
1679 done
1680 }
1681
1682 # The GIT_TEST_FAIL_PREREQS code hooks into test_set_prereq(), and
1683 # thus needs to be set up really early, and set an internal variable
1684 # for convenience so the hot test_set_prereq() codepath doesn't need
1685 # to call "test-tool env-helper" (via test_bool_env). Only do that work
1686 # if needed by seeing if GIT_TEST_FAIL_PREREQS is set at all.
1687 GIT_TEST_FAIL_PREREQS_INTERNAL=
1688 if test -n "$GIT_TEST_FAIL_PREREQS"
1689 then
1690 if test_bool_env GIT_TEST_FAIL_PREREQS false
1691 then
1692 GIT_TEST_FAIL_PREREQS_INTERNAL=true
1693 test_set_prereq FAIL_PREREQS
1694 fi
1695 else
1696 test_lazy_prereq FAIL_PREREQS '
1697 test_bool_env GIT_TEST_FAIL_PREREQS false
1698 '
1699 fi
1700
1701 # Fix some commands on Windows, and other OS-specific things
1702 uname_s=$(uname -s)
1703 case $uname_s in
1704 *MINGW*)
1705 # Windows has its own (incompatible) sort and find
1706 sort () {
1707 /usr/bin/sort "$@"
1708 }
1709 find () {
1710 /usr/bin/find "$@"
1711 }
1712 # git sees Windows-style pwd
1713 pwd () {
1714 builtin pwd -W
1715 }
1716 # no POSIX permissions
1717 # backslashes in pathspec are converted to '/'
1718 # exec does not inherit the PID
1719 test_set_prereq MINGW
1720 test_set_prereq NATIVE_CRLF
1721 test_set_prereq SED_STRIPS_CR
1722 test_set_prereq GREP_STRIPS_CR
1723 test_set_prereq WINDOWS
1724 GIT_TEST_CMP=mingw_test_cmp
1725 ;;
1726 *CYGWIN*)
1727 test_set_prereq POSIXPERM
1728 test_set_prereq EXECKEEPSPID
1729 test_set_prereq CYGWIN
1730 test_set_prereq SED_STRIPS_CR
1731 test_set_prereq GREP_STRIPS_CR
1732 test_set_prereq WINDOWS
1733 ;;
1734 *)
1735 test_set_prereq POSIXPERM
1736 test_set_prereq BSLASHPSPEC
1737 test_set_prereq EXECKEEPSPID
1738 ;;
1739 esac
1740
1741 # Detect arches where a few things don't work
1742 uname_m=$(uname -m)
1743 case $uname_m in
1744 parisc* | hppa*)
1745 test_set_prereq HPPA
1746 ;;
1747 esac
1748
1749 test_set_prereq REFFILES
1750
1751 ( COLUMNS=1 && test $COLUMNS = 1 ) && test_set_prereq COLUMNS_CAN_BE_1
1752 test -z "$NO_CURL" && test_set_prereq LIBCURL
1753 test -z "$NO_PERL" && test_set_prereq PERL
1754 test -z "$NO_PTHREADS" && test_set_prereq PTHREADS
1755 test -z "$NO_PYTHON" && test_set_prereq PYTHON
1756 test -n "$USE_LIBPCRE2" && test_set_prereq PCRE
1757 test -n "$USE_LIBPCRE2" && test_set_prereq LIBPCRE2
1758 test -z "$NO_GETTEXT" && test_set_prereq GETTEXT
1759 test -n "$SANITIZE_LEAK" && test_set_prereq SANITIZE_LEAK
1760 test -n "$GIT_VALGRIND_ENABLED" && test_set_prereq VALGRIND
1761
1762 if test -z "$GIT_TEST_CHECK_CACHE_TREE"
1763 then
1764 GIT_TEST_CHECK_CACHE_TREE=true
1765 export GIT_TEST_CHECK_CACHE_TREE
1766 fi
1767
1768 test_lazy_prereq PIPE '
1769 # test whether the filesystem supports FIFOs
1770 test_have_prereq !MINGW,!CYGWIN &&
1771 rm -f testfifo && mkfifo testfifo
1772 '
1773
1774 test_lazy_prereq SYMLINKS '
1775 # test whether the filesystem supports symbolic links
1776 ln -s x y && test -h y
1777 '
1778
1779 test_lazy_prereq SYMLINKS_WINDOWS '
1780 # test whether symbolic links are enabled on Windows
1781 test_have_prereq MINGW &&
1782 cmd //c "mklink y x" &> /dev/null && test -h y
1783 '
1784
1785 test_lazy_prereq FILEMODE '
1786 test "$(git config --bool core.filemode)" = true
1787 '
1788
1789 test_lazy_prereq CASE_INSENSITIVE_FS '
1790 echo good >CamelCase &&
1791 echo bad >camelcase &&
1792 test "$(cat CamelCase)" != good
1793 '
1794
1795 test_lazy_prereq FUNNYNAMES '
1796 test_have_prereq !MINGW &&
1797 touch -- \
1798 "FUNNYNAMES tab embedded" \
1799 "FUNNYNAMES \"quote embedded\"" \
1800 "FUNNYNAMES newline
1801 embedded" 2>/dev/null &&
1802 rm -- \
1803 "FUNNYNAMES tab embedded" \
1804 "FUNNYNAMES \"quote embedded\"" \
1805 "FUNNYNAMES newline
1806 embedded" 2>/dev/null
1807 '
1808
1809 test_lazy_prereq UTF8_NFD_TO_NFC '
1810 # check whether FS converts nfd unicode to nfc
1811 auml=$(printf "\303\244")
1812 aumlcdiar=$(printf "\141\314\210")
1813 >"$auml" &&
1814 test -f "$aumlcdiar"
1815 '
1816
1817 test_lazy_prereq AUTOIDENT '
1818 sane_unset GIT_AUTHOR_NAME &&
1819 sane_unset GIT_AUTHOR_EMAIL &&
1820 git var GIT_AUTHOR_IDENT
1821 '
1822
1823 test_lazy_prereq EXPENSIVE '
1824 test -n "$GIT_TEST_LONG"
1825 '
1826
1827 test_lazy_prereq EXPENSIVE_ON_WINDOWS '
1828 test_have_prereq EXPENSIVE || test_have_prereq !MINGW,!CYGWIN
1829 '
1830
1831 test_lazy_prereq USR_BIN_TIME '
1832 test -x /usr/bin/time
1833 '
1834
1835 test_lazy_prereq NOT_ROOT '
1836 uid=$(id -u) &&
1837 test "$uid" != 0
1838 '
1839
1840 test_lazy_prereq JGIT '
1841 jgit --version
1842 '
1843
1844 # SANITY is about "can you correctly predict what the filesystem would
1845 # do by only looking at the permission bits of the files and
1846 # directories?" A typical example of !SANITY is running the test
1847 # suite as root, where a test may expect "chmod -r file && cat file"
1848 # to fail because file is supposed to be unreadable after a successful
1849 # chmod. In an environment (i.e. combination of what filesystem is
1850 # being used and who is running the tests) that lacks SANITY, you may
1851 # be able to delete or create a file when the containing directory
1852 # doesn't have write permissions, or access a file even if the
1853 # containing directory doesn't have read or execute permissions.
1854
1855 test_lazy_prereq SANITY '
1856 mkdir SANETESTD.1 SANETESTD.2 &&
1857
1858 chmod +w SANETESTD.1 SANETESTD.2 &&
1859 >SANETESTD.1/x 2>SANETESTD.2/x &&
1860 chmod -w SANETESTD.1 &&
1861 chmod -r SANETESTD.1/x &&
1862 chmod -rx SANETESTD.2 ||
1863 BUG "cannot prepare SANETESTD"
1864
1865 ! test -r SANETESTD.1/x &&
1866 ! rm SANETESTD.1/x && ! test -f SANETESTD.2/x
1867 status=$?
1868
1869 chmod +rwx SANETESTD.1 SANETESTD.2 &&
1870 rm -rf SANETESTD.1 SANETESTD.2 ||
1871 BUG "cannot clean SANETESTD"
1872 return $status
1873 '
1874
1875 test FreeBSD != $uname_s || GIT_UNZIP=${GIT_UNZIP:-/usr/local/bin/unzip}
1876 GIT_UNZIP=${GIT_UNZIP:-unzip}
1877 test_lazy_prereq UNZIP '
1878 "$GIT_UNZIP" -v
1879 test $? -ne 127
1880 '
1881
1882 run_with_limited_cmdline () {
1883 (ulimit -s 128 && "$@")
1884 }
1885
1886 test_lazy_prereq CMDLINE_LIMIT '
1887 test_have_prereq !HPPA,!MINGW,!CYGWIN &&
1888 run_with_limited_cmdline true
1889 '
1890
1891 run_with_limited_stack () {
1892 (ulimit -s 128 && "$@")
1893 }
1894
1895 test_lazy_prereq ULIMIT_STACK_SIZE '
1896 test_have_prereq !HPPA,!MINGW,!CYGWIN &&
1897 run_with_limited_stack true
1898 '
1899
1900 run_with_limited_open_files () {
1901 (ulimit -n 32 && "$@")
1902 }
1903
1904 test_lazy_prereq ULIMIT_FILE_DESCRIPTORS '
1905 test_have_prereq !MINGW,!CYGWIN &&
1906 run_with_limited_open_files true
1907 '
1908
1909 build_option () {
1910 git version --build-options |
1911 sed -ne "s/^$1: //p"
1912 }
1913
1914 test_lazy_prereq SIZE_T_IS_64BIT '
1915 test 8 -eq "$(build_option sizeof-size_t)"
1916 '
1917
1918 test_lazy_prereq LONG_IS_64BIT '
1919 test 8 -le "$(build_option sizeof-long)"
1920 '
1921
1922 test_lazy_prereq TIME_IS_64BIT 'test-tool date is64bit'
1923 test_lazy_prereq TIME_T_IS_64BIT 'test-tool date time_t-is64bit'
1924
1925 test_lazy_prereq CURL '
1926 curl --version
1927 '
1928
1929 # SHA1 is a test if the hash algorithm in use is SHA-1. This is both for tests
1930 # which will not work with other hash algorithms and tests that work but don't
1931 # test anything meaningful (e.g. special values which cause short collisions).
1932 test_lazy_prereq SHA1 '
1933 case "$GIT_DEFAULT_HASH" in
1934 sha1) true ;;
1935 "") test $(git hash-object /dev/null) = e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 ;;
1936 *) false ;;
1937 esac
1938 '
1939
1940 test_lazy_prereq ADD_I_USE_BUILTIN '
1941 test_bool_env GIT_TEST_ADD_I_USE_BUILTIN true
1942 '
1943
1944 # Ensure that no test accidentally triggers a Git command
1945 # that runs the actual maintenance scheduler, affecting a user's
1946 # system permanently.
1947 # Tests that verify the scheduler integration must set this locally
1948 # to avoid errors.
1949 GIT_TEST_MAINT_SCHEDULER="none:exit 1"
1950
1951 # Does this platform support `git fsmonitor--daemon`
1952 #
1953 test_lazy_prereq FSMONITOR_DAEMON '
1954 git version --build-options >output &&
1955 grep "feature: fsmonitor--daemon" output
1956 '