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