t/test-lib.sh

   1 #!/bin/sh
   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 # if --tee was passed, write the output not only to the terminal, but
  19 # additionally to the file test-results/$BASENAME.out, too.
  20 case "$GIT_TEST_TEE_STARTED, $* " in
  21 done,*)
  22         # do not redirect again
  23         ;;
  24 *' --tee '*|*' --va'*)
  25         mkdir -p test-results
  26         BASE=test-results/$(basename "$0" .sh)
  27         (GIT_TEST_TEE_STARTED=done ${SHELL-sh} "$0" "$@" 2>&1;
  28          echo $? > $BASE.exit) | tee $BASE.out
  29         test "$(cat $BASE.exit)" = 0
  30         exit
  31         ;;
  32 esac
  33
  34 # Keep the original TERM for say_color
  35 ORIGINAL_TERM=$TERM
  36
  37 # For repeatability, reset the environment to known value.
  38 LANG=C
  39 LC_ALL=C
  40 PAGER=cat
  41 TZ=UTC
  42 TERM=dumb
  43 export LANG LC_ALL PAGER TERM TZ
  44 EDITOR=:
  45 unset VISUAL
  46 unset GIT_EDITOR
  47 unset AUTHOR_DATE
  48 unset AUTHOR_EMAIL
  49 unset AUTHOR_NAME
  50 unset COMMIT_AUTHOR_EMAIL
  51 unset COMMIT_AUTHOR_NAME
  52 unset EMAIL
  53 unset GIT_ALTERNATE_OBJECT_DIRECTORIES
  54 unset GIT_AUTHOR_DATE
  55 GIT_AUTHOR_EMAIL=author@example.com
  56 GIT_AUTHOR_NAME='A U Thor'
  57 unset GIT_COMMITTER_DATE
  58 GIT_COMMITTER_EMAIL=committer@example.com
  59 GIT_COMMITTER_NAME='C O Mitter'
  60 unset GIT_DIFF_OPTS
  61 unset GIT_DIR
  62 unset GIT_WORK_TREE
  63 unset GIT_EXTERNAL_DIFF
  64 unset GIT_INDEX_FILE
  65 unset GIT_OBJECT_DIRECTORY
  66 unset GIT_CEILING_DIRECTORIES
  67 unset SHA1_FILE_DIRECTORIES
  68 unset SHA1_FILE_DIRECTORY
  69 unset GIT_NOTES_REF
  70 unset GIT_NOTES_DISPLAY_REF
  71 unset GIT_NOTES_REWRITE_REF
  72 unset GIT_NOTES_REWRITE_MODE
  73 GIT_MERGE_VERBOSITY=5
  74 export GIT_MERGE_VERBOSITY
  75 export GIT_AUTHOR_EMAIL GIT_AUTHOR_NAME
  76 export GIT_COMMITTER_EMAIL GIT_COMMITTER_NAME
  77 export EDITOR
  78
  79 # Protect ourselves from common misconfiguration to export
  80 # CDPATH into the environment
  81 unset CDPATH
  82
  83 unset GREP_OPTIONS
  84
  85 case $(echo $GIT_TRACE |tr "[A-Z]" "[a-z]") in
  86         1|2|true)
  87                 echo "* warning: Some tests will not work if GIT_TRACE" \
  88                         "is set as to trace on STDERR ! *"
  89                 echo "* warning: Please set GIT_TRACE to something" \
  90                         "other than 1, 2 or true ! *"
  91                 ;;
  92 esac
  93
  94 # Convenience
  95 #
  96 # A regexp to match 5 and 40 hexdigits
  97 _x05='[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
  98 _x40="$_x05$_x05$_x05$_x05$_x05$_x05$_x05$_x05"
  99
 100 # Each test should start with something like this, after copyright notices:
 101 #
 102 # test_description='Description of this test...
 103 # This test checks if command xyzzy does the right thing...
 104 # '
 105 # . ./test-lib.sh
 106 [ "x$ORIGINAL_TERM" != "xdumb" ] && (
 107                 TERM=$ORIGINAL_TERM &&
 108                 export TERM &&
 109                 [ -t 1 ] &&
 110                 tput bold >/dev/null 2>&1 &&
 111                 tput setaf 1 >/dev/null 2>&1 &&
 112                 tput sgr0 >/dev/null 2>&1
 113         ) &&
 114         color=t
 115
 116 while test "$#" -ne 0
 117 do
 118         case "$1" in
 119         -d|--d|--de|--deb|--debu|--debug)
 120                 debug=t; shift ;;
 121         -i|--i|--im|--imm|--imme|--immed|--immedi|--immedia|--immediat|--immediate)
 122                 immediate=t; shift ;;
 123         -l|--l|--lo|--lon|--long|--long-|--long-t|--long-te|--long-tes|--long-test|--long-tests)
 124                 GIT_TEST_LONG=t; export GIT_TEST_LONG; shift ;;
 125         -h|--h|--he|--hel|--help)
 126                 help=t; shift ;;
 127         -v|--v|--ve|--ver|--verb|--verbo|--verbos|--verbose)
 128                 verbose=t; shift ;;
 129         -q|--q|--qu|--qui|--quie|--quiet)
 130                 # Ignore --quiet under a TAP::Harness. Saying how many tests
 131                 # passed without the ok/not ok details is always an error.
 132                 test -z "$HARNESS_ACTIVE" && quiet=t; shift ;;
 133         --with-dashes)
 134                 with_dashes=t; shift ;;
 135         --no-color)
 136                 color=; shift ;;
 137         --va|--val|--valg|--valgr|--valgri|--valgrin|--valgrind)
 138                 valgrind=t; verbose=t; shift ;;
 139         --tee)
 140                 shift ;; # was handled already
 141         --root=*)
 142                 root=$(expr "z$1" : 'z[^=]*=\(.*\)')
 143                 shift ;;
 144         *)
 145                 echo "error: unknown test option '$1'" >&2; exit 1 ;;
 146         esac
 147 done
 148
 149 if test -n "$color"; then
 150         say_color () {
 151                 (
 152                 TERM=$ORIGINAL_TERM
 153                 export TERM
 154                 case "$1" in
 155                         error) tput bold; tput setaf 1;; # bold red
 156                         skip)  tput bold; tput setaf 2;; # bold green
 157                         pass)  tput setaf 2;;            # green
 158                         info)  tput setaf 3;;            # brown
 159                         *) test -n "$quiet" && return;;
 160                 esac
 161                 shift
 162                 printf "%s" "$*"
 163                 tput sgr0
 164                 echo
 165                 )
 166         }
 167 else
 168         say_color() {
 169                 test -z "$1" && test -n "$quiet" && return
 170                 shift
 171                 echo "$*"
 172         }
 173 fi
 174
 175 error () {
 176         say_color error "error: $*"
 177         GIT_EXIT_OK=t
 178         exit 1
 179 }
 180
 181 say () {
 182         say_color info "$*"
 183 }
 184
 185 test "${test_description}" != "" ||
 186 error "Test script did not set test_description."
 187
 188 if test "$help" = "t"
 189 then
 190         echo "$test_description"
 191         exit 0
 192 fi
 193
 194 exec 5>&1
 195 if test "$verbose" = "t"
 196 then
 197         exec 4>&2 3>&1
 198 else
 199         exec 4>/dev/null 3>/dev/null
 200 fi
 201
 202 test_failure=0
 203 test_count=0
 204 test_fixed=0
 205 test_broken=0
 206 test_success=0
 207
 208 test_external_has_tap=0
 209
 210 die () {
 211         code=$?
 212         if test -n "$GIT_EXIT_OK"
 213         then
 214                 exit $code
 215         else
 216                 echo >&5 "FATAL: Unexpected exit with code $code"
 217                 exit 1
 218         fi
 219 }
 220
 221 GIT_EXIT_OK=
 222 trap 'die' EXIT
 223
 224 # The semantics of the editor variables are that of invoking
 225 # sh -c "$EDITOR \"$@\"" files ...
 226 #
 227 # If our trash directory contains shell metacharacters, they will be
 228 # interpreted if we just set $EDITOR directly, so do a little dance with
 229 # environment variables to work around this.
 230 #
 231 # In particular, quoting isn't enough, as the path may contain the same quote
 232 # that we're using.
 233 test_set_editor () {
 234         FAKE_EDITOR="$1"
 235         export FAKE_EDITOR
 236         EDITOR='"$FAKE_EDITOR"'
 237         export EDITOR
 238 }
 239
 240 test_decode_color () {
 241         sed     -e 's/.\[1m/<WHITE>/g' \
 242                 -e 's/.\[31m/<RED>/g' \
 243                 -e 's/.\[32m/<GREEN>/g' \
 244                 -e 's/.\[33m/<YELLOW>/g' \
 245                 -e 's/.\[34m/<BLUE>/g' \
 246                 -e 's/.\[35m/<MAGENTA>/g' \
 247                 -e 's/.\[36m/<CYAN>/g' \
 248                 -e 's/.\[m/<RESET>/g'
 249 }
 250
 251 q_to_nul () {
 252         perl -pe 'y/Q/\000/'
 253 }
 254
 255 q_to_cr () {
 256         tr Q '\015'
 257 }
 258
 259 append_cr () {
 260         sed -e 's/$/Q/' | tr Q '\015'
 261 }
 262
 263 remove_cr () {
 264         tr '\015' Q | sed -e 's/Q$//'
 265 }
 266
 267 test_tick () {
 268         if test -z "${test_tick+set}"
 269         then
 270                 test_tick=1112911993
 271         else
 272                 test_tick=$(($test_tick + 60))
 273         fi
 274         GIT_COMMITTER_DATE="$test_tick -0700"
 275         GIT_AUTHOR_DATE="$test_tick -0700"
 276         export GIT_COMMITTER_DATE GIT_AUTHOR_DATE
 277 }
 278
 279 # Call test_commit with the arguments "<message> [<file> [<contents>]]"
 280 #
 281 # This will commit a file with the given contents and the given commit
 282 # message.  It will also add a tag with <message> as name.
 283 #
 284 # Both <file> and <contents> default to <message>.
 285
 286 test_commit () {
 287         file=${2:-"$1.t"}
 288         echo "${3-$1}" > "$file" &&
 289         git add "$file" &&
 290         test_tick &&
 291         git commit -m "$1" &&
 292         git tag "$1"
 293 }
 294
 295 # Call test_merge with the arguments "<message> <commit>", where <commit>
 296 # can be a tag pointing to the commit-to-merge.
 297
 298 test_merge () {
 299         test_tick &&
 300         git merge -m "$1" "$2" &&
 301         git tag "$1"
 302 }
 303
 304 # This function helps systems where core.filemode=false is set.
 305 # Use it instead of plain 'chmod +x' to set or unset the executable bit
 306 # of a file in the working directory and add it to the index.
 307
 308 test_chmod () {
 309         chmod "$@" &&
 310         git update-index --add "--chmod=$@"
 311 }
 312
 313 # Use test_set_prereq to tell that a particular prerequisite is available.
 314 # The prerequisite can later be checked for in two ways:
 315 #
 316 # - Explicitly using test_have_prereq.
 317 #
 318 # - Implicitly by specifying the prerequisite tag in the calls to
 319 #   test_expect_{success,failure,code}.
 320 #
 321 # The single parameter is the prerequisite tag (a simple word, in all
 322 # capital letters by convention).
 323
 324 test_set_prereq () {
 325         satisfied="$satisfied$1 "
 326 }
 327 satisfied=" "
 328
 329 test_have_prereq () {
 330         # prerequisites can be concatenated with ','
 331         save_IFS=$IFS
 332         IFS=,
 333         set -- $*
 334         IFS=$save_IFS
 335
 336         total_prereq=0
 337         ok_prereq=0
 338         missing_prereq=
 339
 340         for prerequisite
 341         do
 342                 total_prereq=$(($total_prereq + 1))
 343                 case $satisfied in
 344                 *" $prerequisite "*)
 345                         ok_prereq=$(($ok_prereq + 1))
 346                         ;;
 347                 *)
 348                         # Keep a list of missing prerequisites
 349                         if test -z "$missing_prereq"
 350                         then
 351                                 missing_prereq=$prerequisite
 352                         else
 353                                 missing_prereq="$prerequisite,$missing_prereq"
 354                         fi
 355                 esac
 356         done
 357
 358         test $total_prereq = $ok_prereq
 359 }
 360
 361 # You are not expected to call test_ok_ and test_failure_ directly, use
 362 # the text_expect_* functions instead.
 363
 364 test_ok_ () {
 365         test_success=$(($test_success + 1))
 366         say_color "" "ok $test_count - $@"
 367 }
 368
 369 test_failure_ () {
 370         test_failure=$(($test_failure + 1))
 371         say_color error "not ok - $test_count $1"
 372         shift
 373         echo "$@" | sed -e 's/^/#       /'
 374         test "$immediate" = "" || { GIT_EXIT_OK=t; exit 1; }
 375 }
 376
 377 test_known_broken_ok_ () {
 378         test_fixed=$(($test_fixed+1))
 379         say_color "" "ok $test_count - $@ # TODO known breakage"
 380 }
 381
 382 test_known_broken_failure_ () {
 383         test_broken=$(($test_broken+1))
 384         say_color skip "not ok $test_count - $@ # TODO known breakage"
 385 }
 386
 387 test_debug () {
 388         test "$debug" = "" || eval "$1"
 389 }
 390
 391 test_run_ () {
 392         test_cleanup=:
 393         eval >&3 2>&4 "$1"
 394         eval_ret=$?
 395         eval >&3 2>&4 "$test_cleanup"
 396         if test "$verbose" = "t" && test -n "$HARNESS_ACTIVE"; then
 397                 echo ""
 398         fi
 399         return 0
 400 }
 401
 402 test_skip () {
 403         test_count=$(($test_count+1))
 404         to_skip=
 405         for skp in $GIT_SKIP_TESTS
 406         do
 407                 case $this_test.$test_count in
 408                 $skp)
 409                         to_skip=t
 410                         break
 411                 esac
 412         done
 413         if test -z "$to_skip" && test -n "$prereq" &&
 414            ! test_have_prereq "$prereq"
 415         then
 416                 to_skip=t
 417         fi
 418         case "$to_skip" in
 419         t)
 420                 say_color skip >&3 "skipping test: $@"
 421                 say_color skip "ok $test_count # skip $1 (missing $missing_prereq of $prereq)"
 422                 : true
 423                 ;;
 424         *)
 425                 false
 426                 ;;
 427         esac
 428 }
 429
 430 test_expect_failure () {
 431         test "$#" = 3 && { prereq=$1; shift; } || prereq=
 432         test "$#" = 2 ||
 433         error "bug in the test script: not 2 or 3 parameters to test-expect-failure"
 434         if ! test_skip "$@"
 435         then
 436                 say >&3 "checking known breakage: $2"
 437                 test_run_ "$2"
 438                 if [ "$?" = 0 -a "$eval_ret" = 0 ]
 439                 then
 440                         test_known_broken_ok_ "$1"
 441                 else
 442                         test_known_broken_failure_ "$1"
 443                 fi
 444         fi
 445         echo >&3 ""
 446 }
 447
 448 test_expect_success () {
 449         test "$#" = 3 && { prereq=$1; shift; } || prereq=
 450         test "$#" = 2 ||
 451         error "bug in the test script: not 2 or 3 parameters to test-expect-success"
 452         if ! test_skip "$@"
 453         then
 454                 say >&3 "expecting success: $2"
 455                 test_run_ "$2"
 456                 if [ "$?" = 0 -a "$eval_ret" = 0 ]
 457                 then
 458                         test_ok_ "$1"
 459                 else
 460                         test_failure_ "$@"
 461                 fi
 462         fi
 463         echo >&3 ""
 464 }
 465
 466 test_expect_code () {
 467         test "$#" = 4 && { prereq=$1; shift; } || prereq=
 468         test "$#" = 3 ||
 469         error "bug in the test script: not 3 or 4 parameters to test-expect-code"
 470         if ! test_skip "$@"
 471         then
 472                 say >&3 "expecting exit code $1: $3"
 473                 test_run_ "$3"
 474                 if [ "$?" = 0 -a "$eval_ret" = "$1" ]
 475                 then
 476                         test_ok_ "$2"
 477                 else
 478                         test_failure_ "$@"
 479                 fi
 480         fi
 481         echo >&3 ""
 482 }
 483
 484 # test_external runs external test scripts that provide continuous
 485 # test output about their progress, and succeeds/fails on
 486 # zero/non-zero exit code.  It outputs the test output on stdout even
 487 # in non-verbose mode, and announces the external script with "# run
 488 # <n>: ..." before running it.  When providing relative paths, keep in
 489 # mind that all scripts run in "trash directory".
 490 # Usage: test_external description command arguments...
 491 # Example: test_external 'Perl API' perl ../path/to/test.pl
 492 test_external () {
 493         test "$#" = 4 && { prereq=$1; shift; } || prereq=
 494         test "$#" = 3 ||
 495         error >&5 "bug in the test script: not 3 or 4 parameters to test_external"
 496         descr="$1"
 497         shift
 498         if ! test_skip "$descr" "$@"
 499         then
 500                 # Announce the script to reduce confusion about the
 501                 # test output that follows.
 502                 say_color "" "# run $test_count: $descr ($*)"
 503                 # Export TEST_DIRECTORY, TRASH_DIRECTORY and GIT_TEST_LONG
 504                 # to be able to use them in script
 505                 export TEST_DIRECTORY TRASH_DIRECTORY GIT_TEST_LONG
 506                 # Run command; redirect its stderr to &4 as in
 507                 # test_run_, but keep its stdout on our stdout even in
 508                 # non-verbose mode.
 509                 "$@" 2>&4
 510                 if [ "$?" = 0 ]
 511                 then
 512                         if test $test_external_has_tap -eq 0; then
 513                                 test_ok_ "$descr"
 514                         else
 515                                 say_color "" "# test_external test $descr was ok"
 516                                 test_success=$(($test_success + 1))
 517                         fi
 518                 else
 519                         if test $test_external_has_tap -eq 0; then
 520                                 test_failure_ "$descr" "$@"
 521                         else
 522                                 say_color error "# test_external test $descr failed: $@"
 523                                 test_failure=$(($test_failure + 1))
 524                         fi
 525                 fi
 526         fi
 527 }
 528
 529 # Like test_external, but in addition tests that the command generated
 530 # no output on stderr.
 531 test_external_without_stderr () {
 532         # The temporary file has no (and must have no) security
 533         # implications.
 534         tmp="$TMPDIR"; if [ -z "$tmp" ]; then tmp=/tmp; fi
 535         stderr="$tmp/git-external-stderr.$$.tmp"
 536         test_external "$@" 4> "$stderr"
 537         [ -f "$stderr" ] || error "Internal error: $stderr disappeared."
 538         descr="no stderr: $1"
 539         shift
 540         say >&3 "# expecting no stderr from previous command"
 541         if [ ! -s "$stderr" ]; then
 542                 rm "$stderr"
 543
 544                 if test $test_external_has_tap -eq 0; then
 545                         test_ok_ "$descr"
 546                 else
 547                         say_color "" "# test_external_without_stderr test $descr was ok"
 548                         test_success=$(($test_success + 1))
 549                 fi
 550         else
 551                 if [ "$verbose" = t ]; then
 552                         output=`echo; echo "# Stderr is:"; cat "$stderr"`
 553                 else
 554                         output=
 555                 fi
 556                 # rm first in case test_failure exits.
 557                 rm "$stderr"
 558                 if test $test_external_has_tap -eq 0; then
 559                         test_failure_ "$descr" "$@" "$output"
 560                 else
 561                         say_color error "# test_external_without_stderr test $descr failed: $@: $output"
 562                         test_failure=$(($test_failure + 1))
 563                 fi
 564         fi
 565 }
 566
 567 # This is not among top-level (test_expect_success | test_expect_failure)
 568 # but is a prefix that can be used in the test script, like:
 569 #
 570 #       test_expect_success 'complain and die' '
 571 #           do something &&
 572 #           do something else &&
 573 #           test_must_fail git checkout ../outerspace
 574 #       '
 575 #
 576 # Writing this as "! git checkout ../outerspace" is wrong, because
 577 # the failure could be due to a segv.  We want a controlled failure.
 578
 579 test_must_fail () {
 580         "$@"
 581         test $? -gt 0 -a $? -le 129 -o $? -gt 192
 582 }
 583
 584 # Similar to test_must_fail, but tolerates success, too.  This is
 585 # meant to be used in contexts like:
 586 #
 587 #       test_expect_success 'some command works without configuration' '
 588 #               test_might_fail git config --unset all.configuration &&
 589 #               do something
 590 #       '
 591 #
 592 # Writing "git config --unset all.configuration || :" would be wrong,
 593 # because we want to notice if it fails due to segv.
 594
 595 test_might_fail () {
 596         "$@"
 597         test $? -ge 0 -a $? -le 129 -o $? -gt 192
 598 }
 599
 600 # test_cmp is a helper function to compare actual and expected output.
 601 # You can use it like:
 602 #
 603 #       test_expect_success 'foo works' '
 604 #               echo expected >expected &&
 605 #               foo >actual &&
 606 #               test_cmp expected actual
 607 #       '
 608 #
 609 # This could be written as either "cmp" or "diff -u", but:
 610 # - cmp's output is not nearly as easy to read as diff -u
 611 # - not all diff versions understand "-u"
 612
 613 test_cmp() {
 614         $GIT_TEST_CMP "$@"
 615 }
 616
 617 # This function can be used to schedule some commands to be run
 618 # unconditionally at the end of the test to restore sanity:
 619 #
 620 #       test_expect_success 'test core.capslock' '
 621 #               git config core.capslock true &&
 622 #               test_when_finished "git config --unset core.capslock" &&
 623 #               hello world
 624 #       '
 625 #
 626 # That would be roughly equivalent to
 627 #
 628 #       test_expect_success 'test core.capslock' '
 629 #               git config core.capslock true &&
 630 #               hello world
 631 #               git config --unset core.capslock
 632 #       '
 633 #
 634 # except that the greeting and config --unset must both succeed for
 635 # the test to pass.
 636
 637 test_when_finished () {
 638         test_cleanup="{ $*
 639                 } && (exit \"\$eval_ret\"); eval_ret=\$?; $test_cleanup"
 640 }
 641
 642 # Most tests can use the created repository, but some may need to create more.
 643 # Usage: test_create_repo <directory>
 644 test_create_repo () {
 645         test "$#" = 1 ||
 646         error "bug in the test script: not 1 parameter to test-create-repo"
 647         owd=`pwd`
 648         repo="$1"
 649         mkdir -p "$repo"
 650         cd "$repo" || error "Cannot setup test environment"
 651         "$GIT_EXEC_PATH/git-init" "--template=$GIT_BUILD_DIR/templates/blt/" >&3 2>&4 ||
 652         error "cannot run git init -- have you built things yet?"
 653         mv .git/hooks .git/hooks-disabled
 654         cd "$owd"
 655 }
 656
 657 test_done () {
 658         GIT_EXIT_OK=t
 659
 660         if test -z "$HARNESS_ACTIVE"; then
 661                 test_results_dir="$TEST_DIRECTORY/test-results"
 662                 mkdir -p "$test_results_dir"
 663                 test_results_path="$test_results_dir/${0%.sh}-$$.counts"
 664
 665                 echo "total $test_count" >> $test_results_path
 666                 echo "success $test_success" >> $test_results_path
 667                 echo "fixed $test_fixed" >> $test_results_path
 668                 echo "broken $test_broken" >> $test_results_path
 669                 echo "failed $test_failure" >> $test_results_path
 670                 echo "" >> $test_results_path
 671         fi
 672
 673         if test "$test_fixed" != 0
 674         then
 675                 say_color pass "# fixed $test_fixed known breakage(s)"
 676         fi
 677         if test "$test_broken" != 0
 678         then
 679                 say_color error "# still have $test_broken known breakage(s)"
 680                 msg="remaining $(($test_count-$test_broken)) test(s)"
 681         else
 682                 msg="$test_count test(s)"
 683         fi
 684         case "$test_failure" in
 685         0)
 686                 # Maybe print SKIP message
 687                 [ -z "$skip_all" ] || skip_all=" # SKIP $skip_all"
 688
 689                 if test $test_external_has_tap -eq 0; then
 690                         say_color pass "# passed all $msg"
 691                         say "1..$test_count$skip_all"
 692                 fi
 693
 694                 test -d "$remove_trash" &&
 695                 cd "$(dirname "$remove_trash")" &&
 696                 rm -rf "$(basename "$remove_trash")"
 697
 698                 exit 0 ;;
 699
 700         *)
 701                 if test $test_external_has_tap -eq 0; then
 702                         say_color error "# failed $test_failure among $msg"
 703                         say "1..$test_count"
 704                 fi
 705
 706                 exit 1 ;;
 707
 708         esac
 709 }
 710
 711 # Test the binaries we have just built.  The tests are kept in
 712 # t/ subdirectory and are run in 'trash directory' subdirectory.
 713 if test -z "$TEST_DIRECTORY"
 714 then
 715         # We allow tests to override this, in case they want to run tests
 716         # outside of t/, e.g. for running tests on the test library
 717         # itself.
 718         TEST_DIRECTORY=$(pwd)
 719 fi
 720 GIT_BUILD_DIR="$TEST_DIRECTORY"/..
 721
 722 if test -n "$valgrind"
 723 then
 724         make_symlink () {
 725                 test -h "$2" &&
 726                 test "$1" = "$(readlink "$2")" || {
 727                         # be super paranoid
 728                         if mkdir "$2".lock
 729                         then
 730                                 rm -f "$2" &&
 731                                 ln -s "$1" "$2" &&
 732                                 rm -r "$2".lock
 733                         else
 734                                 while test -d "$2".lock
 735                                 do
 736                                         say "Waiting for lock on $2."
 737                                         sleep 1
 738                                 done
 739                         fi
 740                 }
 741         }
 742
 743         make_valgrind_symlink () {
 744                 # handle only executables
 745                 test -x "$1" || return
 746
 747                 base=$(basename "$1")
 748                 symlink_target=$GIT_BUILD_DIR/$base
 749                 # do not override scripts
 750                 if test -x "$symlink_target" &&
 751                     test ! -d "$symlink_target" &&
 752                     test "#!" != "$(head -c 2 < "$symlink_target")"
 753                 then
 754                         symlink_target=../valgrind.sh
 755                 fi
 756                 case "$base" in
 757                 *.sh|*.perl)
 758                         symlink_target=../unprocessed-script
 759                 esac
 760                 # create the link, or replace it if it is out of date
 761                 make_symlink "$symlink_target" "$GIT_VALGRIND/bin/$base" || exit
 762         }
 763
 764         # override all git executables in TEST_DIRECTORY/..
 765         GIT_VALGRIND=$TEST_DIRECTORY/valgrind
 766         mkdir -p "$GIT_VALGRIND"/bin
 767         for file in $GIT_BUILD_DIR/git* $GIT_BUILD_DIR/test-*
 768         do
 769                 make_valgrind_symlink $file
 770         done
 771         OLDIFS=$IFS
 772         IFS=:
 773         for path in $PATH
 774         do
 775                 ls "$path"/git-* 2> /dev/null |
 776                 while read file
 777                 do
 778                         make_valgrind_symlink "$file"
 779                 done
 780         done
 781         IFS=$OLDIFS
 782         PATH=$GIT_VALGRIND/bin:$PATH
 783         GIT_EXEC_PATH=$GIT_VALGRIND/bin
 784         export GIT_VALGRIND
 785 elif test -n "$GIT_TEST_INSTALLED" ; then
 786         GIT_EXEC_PATH=$($GIT_TEST_INSTALLED/git --exec-path)  ||
 787         error "Cannot run git from $GIT_TEST_INSTALLED."
 788         PATH=$GIT_TEST_INSTALLED:$GIT_BUILD_DIR:$PATH
 789         GIT_EXEC_PATH=${GIT_TEST_EXEC_PATH:-$GIT_EXEC_PATH}
 790 else # normal case, use ../bin-wrappers only unless $with_dashes:
 791         git_bin_dir="$GIT_BUILD_DIR/bin-wrappers"
 792         if ! test -x "$git_bin_dir/git" ; then
 793                 if test -z "$with_dashes" ; then
 794                         say "$git_bin_dir/git is not executable; using GIT_EXEC_PATH"
 795                 fi
 796                 with_dashes=t
 797         fi
 798         PATH="$git_bin_dir:$PATH"
 799         GIT_EXEC_PATH=$GIT_BUILD_DIR
 800         if test -n "$with_dashes" ; then
 801                 PATH="$GIT_BUILD_DIR:$PATH"
 802         fi
 803 fi
 804 GIT_TEMPLATE_DIR="$GIT_BUILD_DIR"/templates/blt
 805 unset GIT_CONFIG
 806 GIT_CONFIG_NOSYSTEM=1
 807 GIT_CONFIG_NOGLOBAL=1
 808 export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG_NOSYSTEM GIT_CONFIG_NOGLOBAL
 809
 810 . "$GIT_BUILD_DIR"/GIT-BUILD-OPTIONS
 811
 812 if test -z "$GIT_TEST_CMP"
 813 then
 814         if test -n "$GIT_TEST_CMP_USE_COPIED_CONTEXT"
 815         then
 816                 GIT_TEST_CMP="$DIFF -c"
 817         else
 818                 GIT_TEST_CMP="$DIFF -u"
 819         fi
 820 fi
 821
 822 GITPERLLIB="$GIT_BUILD_DIR"/perl/blib/lib:"$GIT_BUILD_DIR"/perl/blib/arch/auto/Git
 823 export GITPERLLIB
 824 test -d "$GIT_BUILD_DIR"/templates/blt || {
 825         error "You haven't built things yet, have you?"
 826 }
 827
 828 if test -z "$GIT_TEST_INSTALLED" && test -z "$NO_PYTHON"
 829 then
 830         GITPYTHONLIB="$GIT_BUILD_DIR/git_remote_helpers/build/lib"
 831         export GITPYTHONLIB
 832         test -d "$GIT_BUILD_DIR"/git_remote_helpers/build || {
 833                 error "You haven't built git_remote_helpers yet, have you?"
 834         }
 835 fi
 836
 837 if ! test -x "$GIT_BUILD_DIR"/test-chmtime; then
 838         echo >&2 'You need to build test-chmtime:'
 839         echo >&2 'Run "make test-chmtime" in the source (toplevel) directory'
 840         exit 1
 841 fi
 842
 843 # Test repository
 844 test="trash directory.$(basename "$0" .sh)"
 845 test -n "$root" && test="$root/$test"
 846 case "$test" in
 847 /*) TRASH_DIRECTORY="$test" ;;
 848  *) TRASH_DIRECTORY="$TEST_DIRECTORY/$test" ;;
 849 esac
 850 test ! -z "$debug" || remove_trash=$TRASH_DIRECTORY
 851 rm -fr "$test" || {
 852         GIT_EXIT_OK=t
 853         echo >&5 "FATAL: Cannot prepare test area"
 854         exit 1
 855 }
 856
 857 test_create_repo "$test"
 858 # Use -P to resolve symlinks in our working directory so that the cwd
 859 # in subprocesses like git equals our $PWD (for pathname comparisons).
 860 cd -P "$test" || exit 1
 861
 862 this_test=${0##*/}
 863 this_test=${this_test%%-*}
 864 for skp in $GIT_SKIP_TESTS
 865 do
 866         case "$this_test" in
 867         $skp)
 868                 say_color skip >&3 "skipping test $this_test altogether"
 869                 skip_all="skip all tests in $this_test"
 870                 test_done
 871         esac
 872 done
 873
 874 # Provide an implementation of the 'yes' utility
 875 yes () {
 876         if test $# = 0
 877         then
 878                 y=y
 879         else
 880                 y="$*"
 881         fi
 882
 883         while echo "$y"
 884         do
 885                 :
 886         done
 887 }
 888
 889 # Fix some commands on Windows
 890 case $(uname -s) in
 891 *MINGW*)
 892         # Windows has its own (incompatible) sort and find
 893         sort () {
 894                 /usr/bin/sort "$@"
 895         }
 896         find () {
 897                 /usr/bin/find "$@"
 898         }
 899         sum () {
 900                 md5sum "$@"
 901         }
 902         # git sees Windows-style pwd
 903         pwd () {
 904                 builtin pwd -W
 905         }
 906         # no POSIX permissions
 907         # backslashes in pathspec are converted to '/'
 908         # exec does not inherit the PID
 909         ;;
 910 *)
 911         test_set_prereq POSIXPERM
 912         test_set_prereq BSLASHPSPEC
 913         test_set_prereq EXECKEEPSPID
 914         ;;
 915 esac
 916
 917 test -z "$NO_PERL" && test_set_prereq PERL
 918 test -z "$NO_PYTHON" && test_set_prereq PYTHON
 919
 920 # test whether the filesystem supports symbolic links
 921 ln -s x y 2>/dev/null && test -h y 2>/dev/null && test_set_prereq SYMLINKS
 922 rm -f y
 923
 924 # When the tests are run as root, permission tests will report that
 925 # things are writable when they shouldn't be.
 926 test -w / || test_set_prereq SANITY