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