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