t/test-lib.sh

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