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