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 ################################################################
  61 # It appears that people try to run tests without building...
  62 "${GIT_TEST_INSTALLED:-$GIT_BUILD_DIR}/git$X" >/dev/null
  63 if test $? != 1
  64 then
  65         if test -n "$GIT_TEST_INSTALLED"
  66         then
  67                 echo >&2 "error: there is no working Git at '$GIT_TEST_INSTALLED'"
  68         else
  69                 echo >&2 'error: you do not seem to have built git yet.'
  70         fi
  71         exit 1
  72 fi
  73
  74 # Parse options while taking care to leave $@ intact, so we will still
  75 # have all the original command line options when executing the test
  76 # script again for '--tee' and '--verbose-log' below.
  77 store_arg_to=
  78 prev_opt=
  79 for opt
  80 do
  81         if test -n "$store_arg_to"
  82         then
  83                 eval $store_arg_to=\$opt
  84                 store_arg_to=
  85                 prev_opt=
  86                 continue
  87         fi
  88
  89         case "$opt" in
  90         -d|--d|--de|--deb|--debu|--debug)
  91                 debug=t ;;
  92         -i|--i|--im|--imm|--imme|--immed|--immedi|--immedia|--immediat|--immediate)
  93                 immediate=t ;;
  94         -l|--l|--lo|--lon|--long|--long-|--long-t|--long-te|--long-tes|--long-test|--long-tests)
  95                 GIT_TEST_LONG=t; export GIT_TEST_LONG ;;
  96         -r)
  97                 store_arg_to=run_list
  98                 ;;
  99         --run=*)
 100                 run_list=${opt#--*=} ;;
 101         -h|--h|--he|--hel|--help)
 102                 help=t ;;
 103         -v|--v|--ve|--ver|--verb|--verbo|--verbos|--verbose)
 104                 verbose=t ;;
 105         --verbose-only=*)
 106                 verbose_only=${opt#--*=}
 107                 ;;
 108         -q|--q|--qu|--qui|--quie|--quiet)
 109                 # Ignore --quiet under a TAP::Harness. Saying how many tests
 110                 # passed without the ok/not ok details is always an error.
 111                 test -z "$HARNESS_ACTIVE" && quiet=t ;;
 112         --with-dashes)
 113                 with_dashes=t ;;
 114         --no-color)
 115                 color= ;;
 116         --va|--val|--valg|--valgr|--valgri|--valgrin|--valgrind)
 117                 valgrind=memcheck
 118                 tee=t
 119                 ;;
 120         --valgrind=*)
 121                 valgrind=${opt#--*=}
 122                 tee=t
 123                 ;;
 124         --valgrind-only=*)
 125                 valgrind_only=${opt#--*=}
 126                 tee=t
 127                 ;;
 128         --tee)
 129                 tee=t ;;
 130         --root=*)
 131                 root=${opt#--*=} ;;
 132         --chain-lint)
 133                 GIT_TEST_CHAIN_LINT=1 ;;
 134         --no-chain-lint)
 135                 GIT_TEST_CHAIN_LINT=0 ;;
 136         -x)
 137                 trace=t ;;
 138         -V|--verbose-log)
 139                 verbose_log=t
 140                 tee=t
 141                 ;;
 142         *)
 143                 echo "error: unknown test option '$opt'" >&2; exit 1 ;;
 144         esac
 145
 146         prev_opt=$opt
 147 done
 148 if test -n "$store_arg_to"
 149 then
 150         echo "error: $prev_opt requires an argument" >&2
 151         exit 1
 152 fi
 153
 154 if test -n "$valgrind_only"
 155 then
 156         test -z "$valgrind" && valgrind=memcheck
 157         test -z "$verbose" && verbose_only="$valgrind_only"
 158 elif test -n "$valgrind"
 159 then
 160         test -z "$verbose_log" && verbose=t
 161 fi
 162
 163 # if --tee was passed, write the output not only to the terminal, but
 164 # additionally to the file test-results/$BASENAME.out, too.
 165 if test "$GIT_TEST_TEE_STARTED" = "done"
 166 then
 167         : # do not redirect again
 168 elif test -n "$tee"
 169 then
 170         mkdir -p "$TEST_OUTPUT_DIRECTORY/test-results"
 171         BASE="$TEST_OUTPUT_DIRECTORY/test-results/$(basename "$0" .sh)"
 172
 173         # Make this filename available to the sub-process in case it is using
 174         # --verbose-log.
 175         GIT_TEST_TEE_OUTPUT_FILE=$BASE.out
 176         export GIT_TEST_TEE_OUTPUT_FILE
 177
 178         # Truncate before calling "tee -a" to get rid of the results
 179         # from any previous runs.
 180         >"$GIT_TEST_TEE_OUTPUT_FILE"
 181
 182         (GIT_TEST_TEE_STARTED=done ${TEST_SHELL_PATH} "$0" "$@" 2>&1;
 183          echo $? >"$BASE.exit") | tee -a "$GIT_TEST_TEE_OUTPUT_FILE"
 184         test "$(cat "$BASE.exit")" = 0
 185         exit
 186 fi
 187
 188 if test -n "$trace" && test -n "$test_untraceable"
 189 then
 190         # '-x' tracing requested, but this test script can't be reliably
 191         # traced, unless it is run with a Bash version supporting
 192         # BASH_XTRACEFD (introduced in Bash v4.1).
 193         #
 194         # Perform this version check _after_ the test script was
 195         # potentially re-executed with $TEST_SHELL_PATH for '--tee' or
 196         # '--verbose-log', so the right shell is checked and the
 197         # warning is issued only once.
 198         if test -n "$BASH_VERSION" && eval '
 199              test ${BASH_VERSINFO[0]} -gt 4 || {
 200                test ${BASH_VERSINFO[0]} -eq 4 &&
 201                test ${BASH_VERSINFO[1]} -ge 1
 202              }
 203            '
 204         then
 205                 : Executed by a Bash version supporting BASH_XTRACEFD.  Good.
 206         else
 207                 echo >&2 "warning: ignoring -x; '$0' is untraceable without BASH_XTRACEFD"
 208                 trace=
 209         fi
 210 fi
 211 if test -n "$trace" && test -z "$verbose_log"
 212 then
 213         verbose=t
 214 fi
 215
 216 # For repeatability, reset the environment to known value.
 217 # TERM is sanitized below, after saving color control sequences.
 218 LANG=C
 219 LC_ALL=C
 220 PAGER=cat
 221 TZ=UTC
 222 export LANG LC_ALL PAGER TZ
 223 EDITOR=:
 224
 225 # GIT_TEST_GETTEXT_POISON should not influence git commands executed
 226 # during initialization of test-lib and the test repo. Back it up,
 227 # unset and then restore after initialization is finished.
 228 if test -n "$GIT_TEST_GETTEXT_POISON"
 229 then
 230         GIT_TEST_GETTEXT_POISON_ORIG=$GIT_TEST_GETTEXT_POISON
 231         unset GIT_TEST_GETTEXT_POISON
 232 fi
 233
 234 # A call to "unset" with no arguments causes at least Solaris 10
 235 # /usr/xpg4/bin/sh and /bin/ksh to bail out.  So keep the unsets
 236 # deriving from the command substitution clustered with the other
 237 # ones.
 238 unset VISUAL EMAIL LANGUAGE COLUMNS $("$PERL_PATH" -e '
 239         my @env = keys %ENV;
 240         my $ok = join("|", qw(
 241                 TRACE
 242                 DEBUG
 243                 TEST
 244                 .*_TEST
 245                 PROVE
 246                 VALGRIND
 247                 UNZIP
 248                 PERF_
 249                 CURL_VERBOSE
 250                 TRACE_CURL
 251         ));
 252         my @vars = grep(/^GIT_/ && !/^GIT_($ok)/o, @env);
 253         print join("\n", @vars);
 254 ')
 255 unset XDG_CACHE_HOME
 256 unset XDG_CONFIG_HOME
 257 unset GITPERLLIB
 258 GIT_AUTHOR_EMAIL=author@example.com
 259 GIT_AUTHOR_NAME='A U Thor'
 260 GIT_COMMITTER_EMAIL=committer@example.com
 261 GIT_COMMITTER_NAME='C O Mitter'
 262 GIT_MERGE_VERBOSITY=5
 263 GIT_MERGE_AUTOEDIT=no
 264 export GIT_MERGE_VERBOSITY GIT_MERGE_AUTOEDIT
 265 export GIT_AUTHOR_EMAIL GIT_AUTHOR_NAME
 266 export GIT_COMMITTER_EMAIL GIT_COMMITTER_NAME
 267 export EDITOR
 268
 269 # Tests using GIT_TRACE typically don't want <timestamp> <file>:<line> output
 270 GIT_TRACE_BARE=1
 271 export GIT_TRACE_BARE
 272
 273 check_var_migration () {
 274         # the warnings and hints given from this helper depends
 275         # on end-user settings, which will disrupt the self-test
 276         # done on the test framework itself.
 277         case "$GIT_TEST_FRAMEWORK_SELFTEST" in
 278         t)      return ;;
 279         esac
 280
 281         old_name=$1 new_name=$2
 282         eval "old_isset=\${${old_name}:+isset}"
 283         eval "new_isset=\${${new_name}:+isset}"
 284
 285         case "$old_isset,$new_isset" in
 286         isset,)
 287                 echo >&2 "warning: $old_name is now $new_name"
 288                 echo >&2 "hint: set $new_name too during the transition period"
 289                 eval "$new_name=\$$old_name"
 290                 ;;
 291         isset,isset)
 292                 # do this later
 293                 # echo >&2 "warning: $old_name is now $new_name"
 294                 # echo >&2 "hint: remove $old_name"
 295                 ;;
 296         esac
 297 }
 298
 299 check_var_migration GIT_FSMONITOR_TEST GIT_TEST_FSMONITOR
 300 check_var_migration TEST_GIT_INDEX_VERSION GIT_TEST_INDEX_VERSION
 301 check_var_migration GIT_FORCE_PRELOAD_TEST GIT_TEST_PRELOAD_INDEX
 302
 303 # Use specific version of the index file format
 304 if test -n "${GIT_TEST_INDEX_VERSION:+isset}"
 305 then
 306         GIT_INDEX_VERSION="$GIT_TEST_INDEX_VERSION"
 307         export GIT_INDEX_VERSION
 308 fi
 309
 310 # Add libc MALLOC and MALLOC_PERTURB test
 311 # only if we are not executing the test with valgrind
 312 if test -n "$valgrind" ||
 313    test -n "$TEST_NO_MALLOC_CHECK"
 314 then
 315         setup_malloc_check () {
 316                 : nothing
 317         }
 318         teardown_malloc_check () {
 319                 : nothing
 320         }
 321 else
 322         setup_malloc_check () {
 323                 MALLOC_CHECK_=3 MALLOC_PERTURB_=165
 324                 export MALLOC_CHECK_ MALLOC_PERTURB_
 325         }
 326         teardown_malloc_check () {
 327                 unset MALLOC_CHECK_ MALLOC_PERTURB_
 328         }
 329 fi
 330
 331 # Protect ourselves from common misconfiguration to export
 332 # CDPATH into the environment
 333 unset CDPATH
 334
 335 unset GREP_OPTIONS
 336 unset UNZIP
 337
 338 case $(echo $GIT_TRACE |tr "[A-Z]" "[a-z]") in
 339 1|2|true)
 340         GIT_TRACE=4
 341         ;;
 342 esac
 343
 344 # Convenience
 345 #
 346 # A regexp to match 5, 35 and 40 hexdigits
 347 _x05='[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
 348 _x35="$_x05$_x05$_x05$_x05$_x05$_x05$_x05"
 349 _x40="$_x35$_x05"
 350
 351 # Zero SHA-1
 352 _z40=0000000000000000000000000000000000000000
 353
 354 OID_REGEX="$_x40"
 355 ZERO_OID=$_z40
 356 EMPTY_TREE=4b825dc642cb6eb9a060e54bf8d69288fbee4904
 357 EMPTY_BLOB=e69de29bb2d1d6434b8b29ae775ad8c2e48c5391
 358
 359 # Line feed
 360 LF='
 361 '
 362
 363 # UTF-8 ZERO WIDTH NON-JOINER, which HFS+ ignores
 364 # when case-folding filenames
 365 u200c=$(printf '\342\200\214')
 366
 367 export _x05 _x35 _x40 _z40 LF u200c EMPTY_TREE EMPTY_BLOB ZERO_OID OID_REGEX
 368
 369 # Each test should start with something like this, after copyright notices:
 370 #
 371 # test_description='Description of this test...
 372 # This test checks if command xyzzy does the right thing...
 373 # '
 374 # . ./test-lib.sh
 375 test "x$TERM" != "xdumb" && (
 376                 test -t 1 &&
 377                 tput bold >/dev/null 2>&1 &&
 378                 tput setaf 1 >/dev/null 2>&1 &&
 379                 tput sgr0 >/dev/null 2>&1
 380         ) &&
 381         color=t
 382
 383 if test -n "$color"
 384 then
 385         # Save the color control sequences now rather than run tput
 386         # each time say_color() is called.  This is done for two
 387         # reasons:
 388         #   * TERM will be changed to dumb
 389         #   * HOME will be changed to a temporary directory and tput
 390         #     might need to read ~/.terminfo from the original HOME
 391         #     directory to get the control sequences
 392         # Note:  This approach assumes the control sequences don't end
 393         # in a newline for any terminal of interest (command
 394         # substitutions strip trailing newlines).  Given that most
 395         # (all?) terminals in common use are related to ECMA-48, this
 396         # shouldn't be a problem.
 397         say_color_error=$(tput bold; tput setaf 1) # bold red
 398         say_color_skip=$(tput setaf 4) # blue
 399         say_color_warn=$(tput setaf 3) # brown/yellow
 400         say_color_pass=$(tput setaf 2) # green
 401         say_color_info=$(tput setaf 6) # cyan
 402         say_color_reset=$(tput sgr0)
 403         say_color_="" # no formatting for normal text
 404         say_color () {
 405                 test -z "$1" && test -n "$quiet" && return
 406                 eval "say_color_color=\$say_color_$1"
 407                 shift
 408                 printf "%s\\n" "$say_color_color$*$say_color_reset"
 409         }
 410 else
 411         say_color() {
 412                 test -z "$1" && test -n "$quiet" && return
 413                 shift
 414                 printf "%s\n" "$*"
 415         }
 416 fi
 417
 418 TERM=dumb
 419 export TERM
 420
 421 error () {
 422         say_color error "error: $*"
 423         GIT_EXIT_OK=t
 424         exit 1
 425 }
 426
 427 BUG () {
 428         error >&7 "bug in the test script: $*"
 429 }
 430
 431 say () {
 432         say_color info "$*"
 433 }
 434
 435 if test -n "$HARNESS_ACTIVE"
 436 then
 437         if test "$verbose" = t || test -n "$verbose_only"
 438         then
 439                 printf 'Bail out! %s\n' \
 440                  'verbose mode forbidden under TAP harness; try --verbose-log'
 441                 exit 1
 442         fi
 443 fi
 444
 445 test "${test_description}" != "" ||
 446 error "Test script did not set test_description."
 447
 448 if test "$help" = "t"
 449 then
 450         printf '%s\n' "$test_description"
 451         exit 0
 452 fi
 453
 454 exec 5>&1
 455 exec 6<&0
 456 exec 7>&2
 457 if test "$verbose_log" = "t"
 458 then
 459         exec 3>>"$GIT_TEST_TEE_OUTPUT_FILE" 4>&3
 460 elif test "$verbose" = "t"
 461 then
 462         exec 4>&2 3>&1
 463 else
 464         exec 4>/dev/null 3>/dev/null
 465 fi
 466
 467 # Send any "-x" output directly to stderr to avoid polluting tests
 468 # which capture stderr. We can do this unconditionally since it
 469 # has no effect if tracing isn't turned on.
 470 #
 471 # Note that this sets up the trace fd as soon as we assign the variable, so it
 472 # must come after the creation of descriptor 4 above. Likewise, we must never
 473 # unset this, as it has the side effect of closing descriptor 4, which we
 474 # use to show verbose tests to the user.
 475 #
 476 # Note also that we don't need or want to export it. The tracing is local to
 477 # this shell, and we would not want to influence any shells we exec.
 478 BASH_XTRACEFD=4
 479
 480 test_failure=0
 481 test_count=0
 482 test_fixed=0
 483 test_broken=0
 484 test_success=0
 485
 486 test_external_has_tap=0
 487
 488 die () {
 489         code=$?
 490         if test -n "$GIT_EXIT_OK"
 491         then
 492                 exit $code
 493         else
 494                 echo >&5 "FATAL: Unexpected exit with code $code"
 495                 exit 1
 496         fi
 497 }
 498
 499 GIT_EXIT_OK=
 500 trap 'die' EXIT
 501 trap 'exit $?' INT TERM HUP
 502
 503 # The user-facing functions are loaded from a separate file so that
 504 # test_perf subshells can have them too
 505 . "$TEST_DIRECTORY/test-lib-functions.sh"
 506
 507 # You are not expected to call test_ok_ and test_failure_ directly, use
 508 # the test_expect_* functions instead.
 509
 510 test_ok_ () {
 511         test_success=$(($test_success + 1))
 512         say_color "" "ok $test_count - $@"
 513 }
 514
 515 test_failure_ () {
 516         test_failure=$(($test_failure + 1))
 517         say_color error "not ok $test_count - $1"
 518         shift
 519         printf '%s\n' "$*" | sed -e 's/^/#      /'
 520         test "$immediate" = "" || { GIT_EXIT_OK=t; exit 1; }
 521 }
 522
 523 test_known_broken_ok_ () {
 524         test_fixed=$(($test_fixed+1))
 525         say_color error "ok $test_count - $@ # TODO known breakage vanished"
 526 }
 527
 528 test_known_broken_failure_ () {
 529         test_broken=$(($test_broken+1))
 530         say_color warn "not ok $test_count - $@ # TODO known breakage"
 531 }
 532
 533 test_debug () {
 534         test "$debug" = "" || eval "$1"
 535 }
 536
 537 match_pattern_list () {
 538         arg="$1"
 539         shift
 540         test -z "$*" && return 1
 541         for pattern_
 542         do
 543                 case "$arg" in
 544                 $pattern_)
 545                         return 0
 546                 esac
 547         done
 548         return 1
 549 }
 550
 551 match_test_selector_list () {
 552         title="$1"
 553         shift
 554         arg="$1"
 555         shift
 556         test -z "$1" && return 0
 557
 558         # Both commas and whitespace are accepted as separators.
 559         OLDIFS=$IFS
 560         IFS='   ,'
 561         set -- $1
 562         IFS=$OLDIFS
 563
 564         # If the first selector is negative we include by default.
 565         include=
 566         case "$1" in
 567                 !*) include=t ;;
 568         esac
 569
 570         for selector
 571         do
 572                 orig_selector=$selector
 573
 574                 positive=t
 575                 case "$selector" in
 576                         !*)
 577                                 positive=
 578                                 selector=${selector##?}
 579                                 ;;
 580                 esac
 581
 582                 test -z "$selector" && continue
 583
 584                 case "$selector" in
 585                         *-*)
 586                                 if expr "z${selector%%-*}" : "z[0-9]*[^0-9]" >/dev/null
 587                                 then
 588                                         echo "error: $title: invalid non-numeric in range" \
 589                                                 "start: '$orig_selector'" >&2
 590                                         exit 1
 591                                 fi
 592                                 if expr "z${selector#*-}" : "z[0-9]*[^0-9]" >/dev/null
 593                                 then
 594                                         echo "error: $title: invalid non-numeric in range" \
 595                                                 "end: '$orig_selector'" >&2
 596                                         exit 1
 597                                 fi
 598                                 ;;
 599                         *)
 600                                 if expr "z$selector" : "z[0-9]*[^0-9]" >/dev/null
 601                                 then
 602                                         echo "error: $title: invalid non-numeric in test" \
 603                                                 "selector: '$orig_selector'" >&2
 604                                         exit 1
 605                                 fi
 606                 esac
 607
 608                 # Short cut for "obvious" cases
 609                 test -z "$include" && test -z "$positive" && continue
 610                 test -n "$include" && test -n "$positive" && continue
 611
 612                 case "$selector" in
 613                         -*)
 614                                 if test $arg -le ${selector#-}
 615                                 then
 616                                         include=$positive
 617                                 fi
 618                                 ;;
 619                         *-)
 620                                 if test $arg -ge ${selector%-}
 621                                 then
 622                                         include=$positive
 623                                 fi
 624                                 ;;
 625                         *-*)
 626                                 if test ${selector%%-*} -le $arg \
 627                                         && test $arg -le ${selector#*-}
 628                                 then
 629                                         include=$positive
 630                                 fi
 631                                 ;;
 632                         *)
 633                                 if test $arg -eq $selector
 634                                 then
 635                                         include=$positive
 636                                 fi
 637                                 ;;
 638                 esac
 639         done
 640
 641         test -n "$include"
 642 }
 643
 644 maybe_teardown_verbose () {
 645         test -z "$verbose_only" && return
 646         exec 4>/dev/null 3>/dev/null
 647         verbose=
 648 }
 649
 650 last_verbose=t
 651 maybe_setup_verbose () {
 652         test -z "$verbose_only" && return
 653         if match_pattern_list $test_count $verbose_only
 654         then
 655                 exec 4>&2 3>&1
 656                 # Emit a delimiting blank line when going from
 657                 # non-verbose to verbose.  Within verbose mode the
 658                 # delimiter is printed by test_expect_*.  The choice
 659                 # of the initial $last_verbose is such that before
 660                 # test 1, we do not print it.
 661                 test -z "$last_verbose" && echo >&3 ""
 662                 verbose=t
 663         else
 664                 exec 4>/dev/null 3>/dev/null
 665                 verbose=
 666         fi
 667         last_verbose=$verbose
 668 }
 669
 670 maybe_teardown_valgrind () {
 671         test -z "$GIT_VALGRIND" && return
 672         GIT_VALGRIND_ENABLED=
 673 }
 674
 675 maybe_setup_valgrind () {
 676         test -z "$GIT_VALGRIND" && return
 677         if test -z "$valgrind_only"
 678         then
 679                 GIT_VALGRIND_ENABLED=t
 680                 return
 681         fi
 682         GIT_VALGRIND_ENABLED=
 683         if match_pattern_list $test_count $valgrind_only
 684         then
 685                 GIT_VALGRIND_ENABLED=t
 686         fi
 687 }
 688
 689 want_trace () {
 690         test "$trace" = t && {
 691                 test "$verbose" = t || test "$verbose_log" = t
 692         }
 693 }
 694
 695 # This is a separate function because some tests use
 696 # "return" to end a test_expect_success block early
 697 # (and we want to make sure we run any cleanup like
 698 # "set +x").
 699 test_eval_inner_ () {
 700         # Do not add anything extra (including LF) after '$*'
 701         eval "
 702                 want_trace && set -x
 703                 $*"
 704 }
 705
 706 test_eval_ () {
 707         # If "-x" tracing is in effect, then we want to avoid polluting stderr
 708         # with non-test commands. But once in "set -x" mode, we cannot prevent
 709         # the shell from printing the "set +x" to turn it off (nor the saving
 710         # of $? before that). But we can make sure that the output goes to
 711         # /dev/null.
 712         #
 713         # There are a few subtleties here:
 714         #
 715         #   - we have to redirect descriptor 4 in addition to 2, to cover
 716         #     BASH_XTRACEFD
 717         #
 718         #   - the actual eval has to come before the redirection block (since
 719         #     it needs to see descriptor 4 to set up its stderr)
 720         #
 721         #   - likewise, any error message we print must be outside the block to
 722         #     access descriptor 4
 723         #
 724         #   - checking $? has to come immediately after the eval, but it must
 725         #     be _inside_ the block to avoid polluting the "set -x" output
 726         #
 727
 728         test_eval_inner_ "$@" </dev/null >&3 2>&4
 729         {
 730                 test_eval_ret_=$?
 731                 if want_trace
 732                 then
 733                         set +x
 734                 fi
 735         } 2>/dev/null 4>&2
 736
 737         if test "$test_eval_ret_" != 0 && want_trace
 738         then
 739                 say_color error >&4 "error: last command exited with \$?=$test_eval_ret_"
 740         fi
 741         return $test_eval_ret_
 742 }
 743
 744 test_run_ () {
 745         test_cleanup=:
 746         expecting_failure=$2
 747
 748         if test "${GIT_TEST_CHAIN_LINT:-1}" != 0; then
 749                 # turn off tracing for this test-eval, as it simply creates
 750                 # confusing noise in the "-x" output
 751                 trace_tmp=$trace
 752                 trace=
 753                 # 117 is magic because it is unlikely to match the exit
 754                 # code of other programs
 755                 if $(printf '%s\n' "$1" | sed -f "$GIT_BUILD_DIR/t/chainlint.sed" | grep -q '?![A-Z][A-Z]*?!') ||
 756                         test "OK-117" != "$(test_eval_ "(exit 117) && $1${LF}${LF}echo OK-\$?" 3>&1)"
 757                 then
 758                         BUG "broken &&-chain or run-away HERE-DOC: $1"
 759                 fi
 760                 trace=$trace_tmp
 761         fi
 762
 763         setup_malloc_check
 764         test_eval_ "$1"
 765         eval_ret=$?
 766         teardown_malloc_check
 767
 768         if test -z "$immediate" || test $eval_ret = 0 ||
 769            test -n "$expecting_failure" && test "$test_cleanup" != ":"
 770         then
 771                 setup_malloc_check
 772                 test_eval_ "$test_cleanup"
 773                 teardown_malloc_check
 774         fi
 775         if test "$verbose" = "t" && test -n "$HARNESS_ACTIVE"
 776         then
 777                 echo ""
 778         fi
 779         return "$eval_ret"
 780 }
 781
 782 test_start_ () {
 783         test_count=$(($test_count+1))
 784         maybe_setup_verbose
 785         maybe_setup_valgrind
 786 }
 787
 788 test_finish_ () {
 789         echo >&3 ""
 790         maybe_teardown_valgrind
 791         maybe_teardown_verbose
 792 }
 793
 794 test_skip () {
 795         to_skip=
 796         skipped_reason=
 797         if match_pattern_list $this_test.$test_count $GIT_SKIP_TESTS
 798         then
 799                 to_skip=t
 800                 skipped_reason="GIT_SKIP_TESTS"
 801         fi
 802         if test -z "$to_skip" && test -n "$test_prereq" &&
 803            ! test_have_prereq "$test_prereq"
 804         then
 805                 to_skip=t
 806
 807                 of_prereq=
 808                 if test "$missing_prereq" != "$test_prereq"
 809                 then
 810                         of_prereq=" of $test_prereq"
 811                 fi
 812                 skipped_reason="missing $missing_prereq${of_prereq}"
 813         fi
 814         if test -z "$to_skip" && test -n "$run_list" &&
 815                 ! match_test_selector_list '--run' $test_count "$run_list"
 816         then
 817                 to_skip=t
 818                 skipped_reason="--run"
 819         fi
 820
 821         case "$to_skip" in
 822         t)
 823                 say_color skip >&3 "skipping test: $@"
 824                 say_color skip "ok $test_count # skip $1 ($skipped_reason)"
 825                 : true
 826                 ;;
 827         *)
 828                 false
 829                 ;;
 830         esac
 831 }
 832
 833 # stub; perf-lib overrides it
 834 test_at_end_hook_ () {
 835         :
 836 }
 837
 838 test_done () {
 839         GIT_EXIT_OK=t
 840
 841         if test -z "$HARNESS_ACTIVE"
 842         then
 843                 test_results_dir="$TEST_OUTPUT_DIRECTORY/test-results"
 844                 mkdir -p "$test_results_dir"
 845                 base=${0##*/}
 846                 test_results_path="$test_results_dir/${base%.sh}.counts"
 847
 848                 cat >"$test_results_path" <<-EOF
 849                 total $test_count
 850                 success $test_success
 851                 fixed $test_fixed
 852                 broken $test_broken
 853                 failed $test_failure
 854
 855                 EOF
 856         fi
 857
 858         if test "$test_fixed" != 0
 859         then
 860                 say_color error "# $test_fixed known breakage(s) vanished; please update test(s)"
 861         fi
 862         if test "$test_broken" != 0
 863         then
 864                 say_color warn "# still have $test_broken known breakage(s)"
 865         fi
 866         if test "$test_broken" != 0 || test "$test_fixed" != 0
 867         then
 868                 test_remaining=$(( $test_count - $test_broken - $test_fixed ))
 869                 msg="remaining $test_remaining test(s)"
 870         else
 871                 test_remaining=$test_count
 872                 msg="$test_count test(s)"
 873         fi
 874         case "$test_failure" in
 875         0)
 876                 if test $test_external_has_tap -eq 0
 877                 then
 878                         if test $test_remaining -gt 0
 879                         then
 880                                 say_color pass "# passed all $msg"
 881                         fi
 882
 883                         # Maybe print SKIP message
 884                         test -z "$skip_all" || skip_all="# SKIP $skip_all"
 885                         case "$test_count" in
 886                         0)
 887                                 say "1..$test_count${skip_all:+ $skip_all}"
 888                                 ;;
 889                         *)
 890                                 test -z "$skip_all" ||
 891                                 say_color warn "$skip_all"
 892                                 say "1..$test_count"
 893                                 ;;
 894                         esac
 895                 fi
 896
 897                 if test -z "$debug"
 898                 then
 899                         test -d "$TRASH_DIRECTORY" ||
 900                         error "Tests passed but trash directory already removed before test cleanup; aborting"
 901
 902                         cd "$TRASH_DIRECTORY/.." &&
 903                         rm -fr "$TRASH_DIRECTORY" ||
 904                         error "Tests passed but test cleanup failed; aborting"
 905                 fi
 906                 test_at_end_hook_
 907
 908                 exit 0 ;;
 909
 910         *)
 911                 if test $test_external_has_tap -eq 0
 912                 then
 913                         say_color error "# failed $test_failure among $msg"
 914                         say "1..$test_count"
 915                 fi
 916
 917                 exit 1 ;;
 918
 919         esac
 920 }
 921
 922 if test -n "$valgrind"
 923 then
 924         make_symlink () {
 925                 test -h "$2" &&
 926                 test "$1" = "$(readlink "$2")" || {
 927                         # be super paranoid
 928                         if mkdir "$2".lock
 929                         then
 930                                 rm -f "$2" &&
 931                                 ln -s "$1" "$2" &&
 932                                 rm -r "$2".lock
 933                         else
 934                                 while test -d "$2".lock
 935                                 do
 936                                         say "Waiting for lock on $2."
 937                                         sleep 1
 938                                 done
 939                         fi
 940                 }
 941         }
 942
 943         make_valgrind_symlink () {
 944                 # handle only executables, unless they are shell libraries that
 945                 # need to be in the exec-path.
 946                 test -x "$1" ||
 947                 test "# " = "$(test_copy_bytes 2 <"$1")" ||
 948                 return;
 949
 950                 base=$(basename "$1")
 951                 case "$base" in
 952                 test-*)
 953                         symlink_target="$GIT_BUILD_DIR/t/helper/$base"
 954                         ;;
 955                 *)
 956                         symlink_target="$GIT_BUILD_DIR/$base"
 957                         ;;
 958                 esac
 959                 # do not override scripts
 960                 if test -x "$symlink_target" &&
 961                     test ! -d "$symlink_target" &&
 962                     test "#!" != "$(test_copy_bytes 2 <"$symlink_target")"
 963                 then
 964                         symlink_target=../valgrind.sh
 965                 fi
 966                 case "$base" in
 967                 *.sh|*.perl)
 968                         symlink_target=../unprocessed-script
 969                 esac
 970                 # create the link, or replace it if it is out of date
 971                 make_symlink "$symlink_target" "$GIT_VALGRIND/bin/$base" || exit
 972         }
 973
 974         # override all git executables in TEST_DIRECTORY/..
 975         GIT_VALGRIND=$TEST_DIRECTORY/valgrind
 976         mkdir -p "$GIT_VALGRIND"/bin
 977         for file in $GIT_BUILD_DIR/git* $GIT_BUILD_DIR/t/helper/test-*
 978         do
 979                 make_valgrind_symlink $file
 980         done
 981         # special-case the mergetools loadables
 982         make_symlink "$GIT_BUILD_DIR"/mergetools "$GIT_VALGRIND/bin/mergetools"
 983         OLDIFS=$IFS
 984         IFS=:
 985         for path in $PATH
 986         do
 987                 ls "$path"/git-* 2> /dev/null |
 988                 while read file
 989                 do
 990                         make_valgrind_symlink "$file"
 991                 done
 992         done
 993         IFS=$OLDIFS
 994         PATH=$GIT_VALGRIND/bin:$PATH
 995         GIT_EXEC_PATH=$GIT_VALGRIND/bin
 996         export GIT_VALGRIND
 997         GIT_VALGRIND_MODE="$valgrind"
 998         export GIT_VALGRIND_MODE
 999         GIT_VALGRIND_ENABLED=t
1000         test -n "$valgrind_only" && GIT_VALGRIND_ENABLED=
1001         export GIT_VALGRIND_ENABLED
1002 elif test -n "$GIT_TEST_INSTALLED"
1003 then
1004         GIT_EXEC_PATH=$($GIT_TEST_INSTALLED/git --exec-path)  ||
1005         error "Cannot run git from $GIT_TEST_INSTALLED."
1006         PATH=$GIT_TEST_INSTALLED:$GIT_BUILD_DIR/t/helper:$PATH
1007         GIT_EXEC_PATH=${GIT_TEST_EXEC_PATH:-$GIT_EXEC_PATH}
1008 else # normal case, use ../bin-wrappers only unless $with_dashes:
1009         git_bin_dir="$GIT_BUILD_DIR/bin-wrappers"
1010         if ! test -x "$git_bin_dir/git"
1011         then
1012                 if test -z "$with_dashes"
1013                 then
1014                         say "$git_bin_dir/git is not executable; using GIT_EXEC_PATH"
1015                 fi
1016                 with_dashes=t
1017         fi
1018         PATH="$git_bin_dir:$PATH"
1019         GIT_EXEC_PATH=$GIT_BUILD_DIR
1020         if test -n "$with_dashes"
1021         then
1022                 PATH="$GIT_BUILD_DIR:$PATH"
1023         fi
1024 fi
1025 GIT_TEMPLATE_DIR="$GIT_BUILD_DIR"/templates/blt
1026 GIT_CONFIG_NOSYSTEM=1
1027 GIT_ATTR_NOSYSTEM=1
1028 export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG_NOSYSTEM GIT_ATTR_NOSYSTEM
1029
1030 if test -z "$GIT_TEST_CMP"
1031 then
1032         if test -n "$GIT_TEST_CMP_USE_COPIED_CONTEXT"
1033         then
1034                 GIT_TEST_CMP="$DIFF -c"
1035         else
1036                 GIT_TEST_CMP="$DIFF -u"
1037         fi
1038 fi
1039
1040 GITPERLLIB="$GIT_BUILD_DIR"/perl/build/lib
1041 export GITPERLLIB
1042 test -d "$GIT_BUILD_DIR"/templates/blt || {
1043         error "You haven't built things yet, have you?"
1044 }
1045
1046 if ! test -x "$GIT_BUILD_DIR"/t/helper/test-tool
1047 then
1048         echo >&2 'You need to build test-tool:'
1049         echo >&2 'Run "make t/helper/test-tool" in the source (toplevel) directory'
1050         exit 1
1051 fi
1052
1053 # Test repository
1054 TRASH_DIRECTORY="trash directory.$(basename "$0" .sh)"
1055 test -n "$root" && TRASH_DIRECTORY="$root/$TRASH_DIRECTORY"
1056 case "$TRASH_DIRECTORY" in
1057 /*) ;; # absolute path is good
1058  *) TRASH_DIRECTORY="$TEST_OUTPUT_DIRECTORY/$TRASH_DIRECTORY" ;;
1059 esac
1060 rm -fr "$TRASH_DIRECTORY" || {
1061         GIT_EXIT_OK=t
1062         echo >&5 "FATAL: Cannot prepare test area"
1063         exit 1
1064 }
1065
1066 HOME="$TRASH_DIRECTORY"
1067 GNUPGHOME="$HOME/gnupg-home-not-used"
1068 export HOME GNUPGHOME
1069
1070 if test -z "$TEST_NO_CREATE_REPO"
1071 then
1072         test_create_repo "$TRASH_DIRECTORY"
1073 else
1074         mkdir -p "$TRASH_DIRECTORY"
1075 fi
1076 # Use -P to resolve symlinks in our working directory so that the cwd
1077 # in subprocesses like git equals our $PWD (for pathname comparisons).
1078 cd -P "$TRASH_DIRECTORY" || exit 1
1079
1080 this_test=${0##*/}
1081 this_test=${this_test%%-*}
1082 if match_pattern_list "$this_test" $GIT_SKIP_TESTS
1083 then
1084         say_color info >&3 "skipping test $this_test altogether"
1085         skip_all="skip all tests in $this_test"
1086         test_done
1087 fi
1088
1089 # Provide an implementation of the 'yes' utility
1090 yes () {
1091         if test $# = 0
1092         then
1093                 y=y
1094         else
1095                 y="$*"
1096         fi
1097
1098         i=0
1099         while test $i -lt 99
1100         do
1101                 echo "$y"
1102                 i=$(($i+1))
1103         done
1104 }
1105
1106 # Fix some commands on Windows
1107 uname_s=$(uname -s)
1108 case $uname_s in
1109 *MINGW*)
1110         # Windows has its own (incompatible) sort and find
1111         sort () {
1112                 /usr/bin/sort "$@"
1113         }
1114         find () {
1115                 /usr/bin/find "$@"
1116         }
1117         # git sees Windows-style pwd
1118         pwd () {
1119                 builtin pwd -W
1120         }
1121         # no POSIX permissions
1122         # backslashes in pathspec are converted to '/'
1123         # exec does not inherit the PID
1124         test_set_prereq MINGW
1125         test_set_prereq NATIVE_CRLF
1126         test_set_prereq SED_STRIPS_CR
1127         test_set_prereq GREP_STRIPS_CR
1128         GIT_TEST_CMP=mingw_test_cmp
1129         ;;
1130 *CYGWIN*)
1131         test_set_prereq POSIXPERM
1132         test_set_prereq EXECKEEPSPID
1133         test_set_prereq CYGWIN
1134         test_set_prereq SED_STRIPS_CR
1135         test_set_prereq GREP_STRIPS_CR
1136         ;;
1137 *)
1138         test_set_prereq POSIXPERM
1139         test_set_prereq BSLASHPSPEC
1140         test_set_prereq EXECKEEPSPID
1141         ;;
1142 esac
1143
1144 ( COLUMNS=1 && test $COLUMNS = 1 ) && test_set_prereq COLUMNS_CAN_BE_1
1145 test -z "$NO_PERL" && test_set_prereq PERL
1146 test -z "$NO_PTHREADS" && test_set_prereq PTHREADS
1147 test -z "$NO_PYTHON" && test_set_prereq PYTHON
1148 test -n "$USE_LIBPCRE1$USE_LIBPCRE2" && test_set_prereq PCRE
1149 test -n "$USE_LIBPCRE1" && test_set_prereq LIBPCRE1
1150 test -n "$USE_LIBPCRE2" && test_set_prereq LIBPCRE2
1151 test -z "$NO_GETTEXT" && test_set_prereq GETTEXT
1152
1153 if test -n "$GIT_TEST_GETTEXT_POISON_ORIG"
1154 then
1155         GIT_TEST_GETTEXT_POISON=$GIT_TEST_GETTEXT_POISON_ORIG
1156         unset GIT_TEST_GETTEXT_POISON_ORIG
1157 fi
1158
1159 # Can we rely on git's output in the C locale?
1160 if test -z "$GIT_TEST_GETTEXT_POISON"
1161 then
1162         test_set_prereq C_LOCALE_OUTPUT
1163 fi
1164
1165 if test -z "$GIT_TEST_CHECK_CACHE_TREE"
1166 then
1167         GIT_TEST_CHECK_CACHE_TREE=true
1168         export GIT_TEST_CHECK_CACHE_TREE
1169 fi
1170
1171 test_lazy_prereq PIPE '
1172         # test whether the filesystem supports FIFOs
1173         test_have_prereq !MINGW,!CYGWIN &&
1174         rm -f testfifo && mkfifo testfifo
1175 '
1176
1177 test_lazy_prereq SYMLINKS '
1178         # test whether the filesystem supports symbolic links
1179         ln -s x y && test -h y
1180 '
1181
1182 test_lazy_prereq FILEMODE '
1183         test "$(git config --bool core.filemode)" = true
1184 '
1185
1186 test_lazy_prereq CASE_INSENSITIVE_FS '
1187         echo good >CamelCase &&
1188         echo bad >camelcase &&
1189         test "$(cat CamelCase)" != good
1190 '
1191
1192 test_lazy_prereq FUNNYNAMES '
1193         test_have_prereq !MINGW &&
1194         touch -- \
1195                 "FUNNYNAMES tab embedded" \
1196                 "FUNNYNAMES \"quote embedded\"" \
1197                 "FUNNYNAMES newline
1198 embedded" 2>/dev/null &&
1199         rm -- \
1200                 "FUNNYNAMES tab embedded" \
1201                 "FUNNYNAMES \"quote embedded\"" \
1202                 "FUNNYNAMES newline
1203 embedded" 2>/dev/null
1204 '
1205
1206 test_lazy_prereq UTF8_NFD_TO_NFC '
1207         # check whether FS converts nfd unicode to nfc
1208         auml=$(printf "\303\244")
1209         aumlcdiar=$(printf "\141\314\210")
1210         >"$auml" &&
1211         test -f "$aumlcdiar"
1212 '
1213
1214 test_lazy_prereq AUTOIDENT '
1215         sane_unset GIT_AUTHOR_NAME &&
1216         sane_unset GIT_AUTHOR_EMAIL &&
1217         git var GIT_AUTHOR_IDENT
1218 '
1219
1220 test_lazy_prereq EXPENSIVE '
1221         test -n "$GIT_TEST_LONG"
1222 '
1223
1224 test_lazy_prereq EXPENSIVE_ON_WINDOWS '
1225         test_have_prereq EXPENSIVE || test_have_prereq !MINGW,!CYGWIN
1226 '
1227
1228 test_lazy_prereq USR_BIN_TIME '
1229         test -x /usr/bin/time
1230 '
1231
1232 test_lazy_prereq NOT_ROOT '
1233         uid=$(id -u) &&
1234         test "$uid" != 0
1235 '
1236
1237 test_lazy_prereq JGIT '
1238         type jgit
1239 '
1240
1241 # SANITY is about "can you correctly predict what the filesystem would
1242 # do by only looking at the permission bits of the files and
1243 # directories?"  A typical example of !SANITY is running the test
1244 # suite as root, where a test may expect "chmod -r file && cat file"
1245 # to fail because file is supposed to be unreadable after a successful
1246 # chmod.  In an environment (i.e. combination of what filesystem is
1247 # being used and who is running the tests) that lacks SANITY, you may
1248 # be able to delete or create a file when the containing directory
1249 # doesn't have write permissions, or access a file even if the
1250 # containing directory doesn't have read or execute permissions.
1251
1252 test_lazy_prereq SANITY '
1253         mkdir SANETESTD.1 SANETESTD.2 &&
1254
1255         chmod +w SANETESTD.1 SANETESTD.2 &&
1256         >SANETESTD.1/x 2>SANETESTD.2/x &&
1257         chmod -w SANETESTD.1 &&
1258         chmod -r SANETESTD.1/x &&
1259         chmod -rx SANETESTD.2 ||
1260         BUG "cannot prepare SANETESTD"
1261
1262         ! test -r SANETESTD.1/x &&
1263         ! rm SANETESTD.1/x && ! test -f SANETESTD.2/x
1264         status=$?
1265
1266         chmod +rwx SANETESTD.1 SANETESTD.2 &&
1267         rm -rf SANETESTD.1 SANETESTD.2 ||
1268         BUG "cannot clean SANETESTD"
1269         return $status
1270 '
1271
1272 test FreeBSD != $uname_s || GIT_UNZIP=${GIT_UNZIP:-/usr/local/bin/unzip}
1273 GIT_UNZIP=${GIT_UNZIP:-unzip}
1274 test_lazy_prereq UNZIP '
1275         "$GIT_UNZIP" -v
1276         test $? -ne 127
1277 '
1278
1279 run_with_limited_cmdline () {
1280         (ulimit -s 128 && "$@")
1281 }
1282
1283 test_lazy_prereq CMDLINE_LIMIT '
1284         test_have_prereq !MINGW,!CYGWIN &&
1285         run_with_limited_cmdline true
1286 '
1287
1288 run_with_limited_stack () {
1289         (ulimit -s 128 && "$@")
1290 }
1291
1292 test_lazy_prereq ULIMIT_STACK_SIZE '
1293         test_have_prereq !MINGW,!CYGWIN &&
1294         run_with_limited_stack true
1295 '
1296
1297 build_option () {
1298         git version --build-options |
1299         sed -ne "s/^$1: //p"
1300 }
1301
1302 test_lazy_prereq LONG_IS_64BIT '
1303         test 8 -le "$(build_option sizeof-long)"
1304 '
1305
1306 test_lazy_prereq TIME_IS_64BIT 'test-tool date is64bit'
1307 test_lazy_prereq TIME_T_IS_64BIT 'test-tool date time_t-is64bit'
1308
1309 test_lazy_prereq CURL '
1310         curl --version
1311 '
1312
1313 # SHA1 is a test if the hash algorithm in use is SHA-1.  This is both for tests
1314 # which will not work with other hash algorithms and tests that work but don't
1315 # test anything meaningful (e.g. special values which cause short collisions).
1316 test_lazy_prereq SHA1 '
1317         test $(git hash-object /dev/null) = e69de29bb2d1d6434b8b29ae775ad8c2e48c5391
1318 '
1319
1320 test_lazy_prereq REBASE_P '
1321         test -z "$GIT_TEST_SKIP_REBASE_P"
1322 '