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