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