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