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