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