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 q_to_tab () {
 260         tr Q '\011'
 261 }
 262
 263 append_cr () {
 264         sed -e 's/$/Q/' | tr Q '\015'
 265 }
 266
 267 remove_cr () {
 268         tr '\015' Q | sed -e 's/Q$//'
 269 }
 270
 271 test_tick () {
 272         if test -z "${test_tick+set}"
 273         then
 274                 test_tick=1112911993
 275         else
 276                 test_tick=$(($test_tick + 60))
 277         fi
 278         GIT_COMMITTER_DATE="$test_tick -0700"
 279         GIT_AUTHOR_DATE="$test_tick -0700"
 280         export GIT_COMMITTER_DATE GIT_AUTHOR_DATE
 281 }
 282
 283 # Call test_commit with the arguments "<message> [<file> [<contents>]]"
 284 #
 285 # This will commit a file with the given contents and the given commit
 286 # message.  It will also add a tag with <message> as name.
 287 #
 288 # Both <file> and <contents> default to <message>.
 289
 290 test_commit () {
 291         file=${2:-"$1.t"}
 292         echo "${3-$1}" > "$file" &&
 293         git add "$file" &&
 294         test_tick &&
 295         git commit -m "$1" &&
 296         git tag "$1"
 297 }
 298
 299 # Call test_merge with the arguments "<message> <commit>", where <commit>
 300 # can be a tag pointing to the commit-to-merge.
 301
 302 test_merge () {
 303         test_tick &&
 304         git merge -m "$1" "$2" &&
 305         git tag "$1"
 306 }
 307
 308 # This function helps systems where core.filemode=false is set.
 309 # Use it instead of plain 'chmod +x' to set or unset the executable bit
 310 # of a file in the working directory and add it to the index.
 311
 312 test_chmod () {
 313         chmod "$@" &&
 314         git update-index --add "--chmod=$@"
 315 }
 316
 317 # Use test_set_prereq to tell that a particular prerequisite is available.
 318 # The prerequisite can later be checked for in two ways:
 319 #
 320 # - Explicitly using test_have_prereq.
 321 #
 322 # - Implicitly by specifying the prerequisite tag in the calls to
 323 #   test_expect_{success,failure,code}.
 324 #
 325 # The single parameter is the prerequisite tag (a simple word, in all
 326 # capital letters by convention).
 327
 328 test_set_prereq () {
 329         satisfied="$satisfied$1 "
 330 }
 331 satisfied=" "
 332
 333 test_have_prereq () {
 334         case $satisfied in
 335         *" $1 "*)
 336                 : yes, have it ;;
 337         *)
 338                 ! : nope ;;
 339         esac
 340 }
 341
 342 # You are not expected to call test_ok_ and test_failure_ directly, use
 343 # the text_expect_* functions instead.
 344
 345 test_ok_ () {
 346         test_success=$(($test_success + 1))
 347         say_color "" "ok $test_count - $@"
 348 }
 349
 350 test_failure_ () {
 351         test_failure=$(($test_failure + 1))
 352         say_color error "not ok - $test_count $1"
 353         shift
 354         echo "$@" | sed -e 's/^/#       /'
 355         test "$immediate" = "" || { GIT_EXIT_OK=t; exit 1; }
 356 }
 357
 358 test_known_broken_ok_ () {
 359         test_fixed=$(($test_fixed+1))
 360         say_color "" "ok $test_count - $@ # TODO known breakage"
 361 }
 362
 363 test_known_broken_failure_ () {
 364         test_broken=$(($test_broken+1))
 365         say_color skip "not ok $test_count - $@ # TODO known breakage"
 366 }
 367
 368 test_debug () {
 369         test "$debug" = "" || eval "$1"
 370 }
 371
 372 test_run_ () {
 373         test_cleanup=:
 374         eval >&3 2>&4 "$1"
 375         eval_ret=$?
 376         eval >&3 2>&4 "$test_cleanup"
 377         if test "$verbose" = "t" && test -n "$HARNESS_ACTIVE"; then
 378                 echo ""
 379         fi
 380         return 0
 381 }
 382
 383 test_skip () {
 384         test_count=$(($test_count+1))
 385         to_skip=
 386         for skp in $GIT_SKIP_TESTS
 387         do
 388                 case $this_test.$test_count in
 389                 $skp)
 390                         to_skip=t
 391                         break
 392                 esac
 393         done
 394         if test -z "$to_skip" && test -n "$prereq" &&
 395            ! test_have_prereq "$prereq"
 396         then
 397                 to_skip=t
 398         fi
 399         case "$to_skip" in
 400         t)
 401                 say_color skip >&3 "skipping test: $@"
 402                 say_color skip "ok $test_count # skip $1"
 403                 : true
 404                 ;;
 405         *)
 406                 false
 407                 ;;
 408         esac
 409 }
 410
 411 test_expect_failure () {
 412         test "$#" = 3 && { prereq=$1; shift; } || prereq=
 413         test "$#" = 2 ||
 414         error "bug in the test script: not 2 or 3 parameters to test-expect-failure"
 415         if ! test_skip "$@"
 416         then
 417                 say >&3 "checking known breakage: $2"
 418                 test_run_ "$2"
 419                 if [ "$?" = 0 -a "$eval_ret" = 0 ]
 420                 then
 421                         test_known_broken_ok_ "$1"
 422                 else
 423                         test_known_broken_failure_ "$1"
 424                 fi
 425         fi
 426         echo >&3 ""
 427 }
 428
 429 test_expect_success () {
 430         test "$#" = 3 && { prereq=$1; shift; } || prereq=
 431         test "$#" = 2 ||
 432         error "bug in the test script: not 2 or 3 parameters to test-expect-success"
 433         if ! test_skip "$@"
 434         then
 435                 say >&3 "expecting success: $2"
 436                 test_run_ "$2"
 437                 if [ "$?" = 0 -a "$eval_ret" = 0 ]
 438                 then
 439                         test_ok_ "$1"
 440                 else
 441                         test_failure_ "$@"
 442                 fi
 443         fi
 444         echo >&3 ""
 445 }
 446
 447 test_expect_code () {
 448         test "$#" = 4 && { prereq=$1; shift; } || prereq=
 449         test "$#" = 3 ||
 450         error "bug in the test script: not 3 or 4 parameters to test-expect-code"
 451         if ! test_skip "$@"
 452         then
 453                 say >&3 "expecting exit code $1: $3"
 454                 test_run_ "$3"
 455                 if [ "$?" = 0 -a "$eval_ret" = "$1" ]
 456                 then
 457                         test_ok_ "$2"
 458                 else
 459                         test_failure_ "$@"
 460                 fi
 461         fi
 462         echo >&3 ""
 463 }
 464
 465 # test_external runs external test scripts that provide continuous
 466 # test output about their progress, and succeeds/fails on
 467 # zero/non-zero exit code.  It outputs the test output on stdout even
 468 # in non-verbose mode, and announces the external script with "# run
 469 # <n>: ..." before running it.  When providing relative paths, keep in
 470 # mind that all scripts run in "trash directory".
 471 # Usage: test_external description command arguments...
 472 # Example: test_external 'Perl API' perl ../path/to/test.pl
 473 test_external () {
 474         test "$#" = 4 && { prereq=$1; shift; } || prereq=
 475         test "$#" = 3 ||
 476         error >&5 "bug in the test script: not 3 or 4 parameters to test_external"
 477         descr="$1"
 478         shift
 479         if ! test_skip "$descr" "$@"
 480         then
 481                 # Announce the script to reduce confusion about the
 482                 # test output that follows.
 483                 say_color "" "# run $test_count: $descr ($*)"
 484                 # Export TEST_DIRECTORY, TRASH_DIRECTORY and GIT_TEST_LONG
 485                 # to be able to use them in script
 486                 export TEST_DIRECTORY TRASH_DIRECTORY GIT_TEST_LONG
 487                 # Run command; redirect its stderr to &4 as in
 488                 # test_run_, but keep its stdout on our stdout even in
 489                 # non-verbose mode.
 490                 "$@" 2>&4
 491                 if [ "$?" = 0 ]
 492                 then
 493                         if test $test_external_has_tap -eq 0; then
 494                                 test_ok_ "$descr"
 495                         else
 496                                 say_color "" "# test_external test $descr was ok"
 497                                 test_success=$(($test_success + 1))
 498                         fi
 499                 else
 500                         if test $test_external_has_tap -eq 0; then
 501                                 test_failure_ "$descr" "$@"
 502                         else
 503                                 say_color error "# test_external test $descr failed: $@"
 504                                 test_failure=$(($test_failure + 1))
 505                         fi
 506                 fi
 507         fi
 508 }
 509
 510 # Like test_external, but in addition tests that the command generated
 511 # no output on stderr.
 512 test_external_without_stderr () {
 513         # The temporary file has no (and must have no) security
 514         # implications.
 515         tmp="$TMPDIR"; if [ -z "$tmp" ]; then tmp=/tmp; fi
 516         stderr="$tmp/git-external-stderr.$$.tmp"
 517         test_external "$@" 4> "$stderr"
 518         [ -f "$stderr" ] || error "Internal error: $stderr disappeared."
 519         descr="no stderr: $1"
 520         shift
 521         say >&3 "# expecting no stderr from previous command"
 522         if [ ! -s "$stderr" ]; then
 523                 rm "$stderr"
 524
 525                 if test $test_external_has_tap -eq 0; then
 526                         test_ok_ "$descr"
 527                 else
 528                         say_color "" "# test_external_without_stderr test $descr was ok"
 529                         test_success=$(($test_success + 1))
 530                 fi
 531         else
 532                 if [ "$verbose" = t ]; then
 533                         output=`echo; echo "# Stderr is:"; cat "$stderr"`
 534                 else
 535                         output=
 536                 fi
 537                 # rm first in case test_failure exits.
 538                 rm "$stderr"
 539                 if test $test_external_has_tap -eq 0; then
 540                         test_failure_ "$descr" "$@" "$output"
 541                 else
 542                         say_color error "# test_external_without_stderr test $descr failed: $@: $output"
 543                         test_failure=$(($test_failure + 1))
 544                 fi
 545         fi
 546 }
 547
 548 # debugging-friendly alternatives to "test [-f|-d|-e]"
 549 # The commands test the existence or non-existence of $1. $2 can be
 550 # given to provide a more precise diagnosis.
 551 test_path_is_file () {
 552         if ! [ -f "$1" ]
 553         then
 554                 echo "File $1 doesn't exist. $*"
 555                 false
 556         fi
 557 }
 558
 559 test_path_is_dir () {
 560         if ! [ -d "$1" ]
 561         then
 562                 echo "Directory $1 doesn't exist. $*"
 563                 false
 564         fi
 565 }
 566
 567 test_path_is_missing () {
 568         if [ -e "$1" ]
 569         then
 570                 echo "Path exists:"
 571                 ls -ld "$1"
 572                 if [ $# -ge 1 ]; then
 573                         echo "$*"
 574                 fi
 575                 false
 576         fi
 577 }
 578
 579
 580 # This is not among top-level (test_expect_success | test_expect_failure)
 581 # but is a prefix that can be used in the test script, like:
 582 #
 583 #       test_expect_success 'complain and die' '
 584 #           do something &&
 585 #           do something else &&
 586 #           test_must_fail git checkout ../outerspace
 587 #       '
 588 #
 589 # Writing this as "! git checkout ../outerspace" is wrong, because
 590 # the failure could be due to a segv.  We want a controlled failure.
 591
 592 test_must_fail () {
 593         "$@"
 594         exit_code=$?
 595         if test $exit_code = 0; then
 596                 echo >&2 "test_must_fail: command succeeded: $*"
 597                 return 1
 598         elif test $exit_code -gt 129 -a $exit_code -le 192; then
 599                 echo >&2 "test_must_fail: died by signal: $*"
 600                 return 1
 601         elif test $exit_code = 127; then
 602                 echo >&2 "test_must_fail: command not found: $*"
 603                 return 1
 604         fi
 605         return 0
 606 }
 607
 608 # Similar to test_must_fail, but tolerates success, too.  This is
 609 # meant to be used in contexts like:
 610 #
 611 #       test_expect_success 'some command works without configuration' '
 612 #               test_might_fail git config --unset all.configuration &&
 613 #               do something
 614 #       '
 615 #
 616 # Writing "git config --unset all.configuration || :" would be wrong,
 617 # because we want to notice if it fails due to segv.
 618
 619 test_might_fail () {
 620         "$@"
 621         exit_code=$?
 622         if test $exit_code -gt 129 -a $exit_code -le 192; then
 623                 echo >&2 "test_might_fail: died by signal: $*"
 624                 return 1
 625         fi
 626         return 0
 627 }
 628
 629 # test_cmp is a helper function to compare actual and expected output.
 630 # You can use it like:
 631 #
 632 #       test_expect_success 'foo works' '
 633 #               echo expected >expected &&
 634 #               foo >actual &&
 635 #               test_cmp expected actual
 636 #       '
 637 #
 638 # This could be written as either "cmp" or "diff -u", but:
 639 # - cmp's output is not nearly as easy to read as diff -u
 640 # - not all diff versions understand "-u"
 641
 642 test_cmp() {
 643         $GIT_TEST_CMP "$@"
 644 }
 645
 646 # This function can be used to schedule some commands to be run
 647 # unconditionally at the end of the test to restore sanity:
 648 #
 649 #       test_expect_success 'test core.capslock' '
 650 #               git config core.capslock true &&
 651 #               test_when_finished "git config --unset core.capslock" &&
 652 #               hello world
 653 #       '
 654 #
 655 # That would be roughly equivalent to
 656 #
 657 #       test_expect_success 'test core.capslock' '
 658 #               git config core.capslock true &&
 659 #               hello world
 660 #               git config --unset core.capslock
 661 #       '
 662 #
 663 # except that the greeting and config --unset must both succeed for
 664 # the test to pass.
 665
 666 test_when_finished () {
 667         test_cleanup="{ $*
 668                 } && (exit \"\$eval_ret\"); eval_ret=\$?; $test_cleanup"
 669 }
 670
 671 # Most tests can use the created repository, but some may need to create more.
 672 # Usage: test_create_repo <directory>
 673 test_create_repo () {
 674         test "$#" = 1 ||
 675         error "bug in the test script: not 1 parameter to test-create-repo"
 676         owd=`pwd`
 677         repo="$1"
 678         mkdir -p "$repo"
 679         cd "$repo" || error "Cannot setup test environment"
 680         "$GIT_EXEC_PATH/git-init" "--template=$TEST_DIRECTORY/../templates/blt/" >&3 2>&4 ||
 681         error "cannot run git init -- have you built things yet?"
 682         mv .git/hooks .git/hooks-disabled
 683         cd "$owd"
 684 }
 685
 686 test_done () {
 687         GIT_EXIT_OK=t
 688         test_results_dir="$TEST_DIRECTORY/test-results"
 689         mkdir -p "$test_results_dir"
 690         test_results_path="$test_results_dir/${0%.sh}-$$.counts"
 691
 692         echo "total $test_count" >> $test_results_path
 693         echo "success $test_success" >> $test_results_path
 694         echo "fixed $test_fixed" >> $test_results_path
 695         echo "broken $test_broken" >> $test_results_path
 696         echo "failed $test_failure" >> $test_results_path
 697         echo "" >> $test_results_path
 698
 699         if test "$test_fixed" != 0
 700         then
 701                 say_color pass "# fixed $test_fixed known breakage(s)"
 702         fi
 703         if test "$test_broken" != 0
 704         then
 705                 say_color error "# still have $test_broken known breakage(s)"
 706                 msg="remaining $(($test_count-$test_broken)) test(s)"
 707         else
 708                 msg="$test_count test(s)"
 709         fi
 710         case "$test_failure" in
 711         0)
 712                 # Maybe print SKIP message
 713                 [ -z "$skip_all" ] || skip_all=" # SKIP $skip_all"
 714
 715                 if test $test_external_has_tap -eq 0; then
 716                         say_color pass "# passed all $msg"
 717                         say "1..$test_count$skip_all"
 718                 fi
 719
 720                 test -d "$remove_trash" &&
 721                 cd "$(dirname "$remove_trash")" &&
 722                 rm -rf "$(basename "$remove_trash")"
 723
 724                 exit 0 ;;
 725
 726         *)
 727                 if test $test_external_has_tap -eq 0; then
 728                         say_color error "# failed $test_failure among $msg"
 729                         say "1..$test_count"
 730                 fi
 731
 732                 exit 1 ;;
 733
 734         esac
 735 }
 736
 737 # Test the binaries we have just built.  The tests are kept in
 738 # t/ subdirectory and are run in 'trash directory' subdirectory.
 739 TEST_DIRECTORY=$(pwd)
 740 if test -n "$valgrind"
 741 then
 742         make_symlink () {
 743                 test -h "$2" &&
 744                 test "$1" = "$(readlink "$2")" || {
 745                         # be super paranoid
 746                         if mkdir "$2".lock
 747                         then
 748                                 rm -f "$2" &&
 749                                 ln -s "$1" "$2" &&
 750                                 rm -r "$2".lock
 751                         else
 752                                 while test -d "$2".lock
 753                                 do
 754                                         say "Waiting for lock on $2."
 755                                         sleep 1
 756                                 done
 757                         fi
 758                 }
 759         }
 760
 761         make_valgrind_symlink () {
 762                 # handle only executables
 763                 test -x "$1" || return
 764
 765                 base=$(basename "$1")
 766                 symlink_target=$TEST_DIRECTORY/../$base
 767                 # do not override scripts
 768                 if test -x "$symlink_target" &&
 769                     test ! -d "$symlink_target" &&
 770                     test "#!" != "$(head -c 2 < "$symlink_target")"
 771                 then
 772                         symlink_target=../valgrind.sh
 773                 fi
 774                 case "$base" in
 775                 *.sh|*.perl)
 776                         symlink_target=../unprocessed-script
 777                 esac
 778                 # create the link, or replace it if it is out of date
 779                 make_symlink "$symlink_target" "$GIT_VALGRIND/bin/$base" || exit
 780         }
 781
 782         # override all git executables in TEST_DIRECTORY/..
 783         GIT_VALGRIND=$TEST_DIRECTORY/valgrind
 784         mkdir -p "$GIT_VALGRIND"/bin
 785         for file in $TEST_DIRECTORY/../git* $TEST_DIRECTORY/../test-*
 786         do
 787                 make_valgrind_symlink $file
 788         done
 789         OLDIFS=$IFS
 790         IFS=:
 791         for path in $PATH
 792         do
 793                 ls "$path"/git-* 2> /dev/null |
 794                 while read file
 795                 do
 796                         make_valgrind_symlink "$file"
 797                 done
 798         done
 799         IFS=$OLDIFS
 800         PATH=$GIT_VALGRIND/bin:$PATH
 801         GIT_EXEC_PATH=$GIT_VALGRIND/bin
 802         export GIT_VALGRIND
 803 elif test -n "$GIT_TEST_INSTALLED" ; then
 804         GIT_EXEC_PATH=$($GIT_TEST_INSTALLED/git --exec-path)  ||
 805         error "Cannot run git from $GIT_TEST_INSTALLED."
 806         PATH=$GIT_TEST_INSTALLED:$TEST_DIRECTORY/..:$PATH
 807         GIT_EXEC_PATH=${GIT_TEST_EXEC_PATH:-$GIT_EXEC_PATH}
 808 else # normal case, use ../bin-wrappers only unless $with_dashes:
 809         git_bin_dir="$TEST_DIRECTORY/../bin-wrappers"
 810         if ! test -x "$git_bin_dir/git" ; then
 811                 if test -z "$with_dashes" ; then
 812                         say "$git_bin_dir/git is not executable; using GIT_EXEC_PATH"
 813                 fi
 814                 with_dashes=t
 815         fi
 816         PATH="$git_bin_dir:$PATH"
 817         GIT_EXEC_PATH=$TEST_DIRECTORY/..
 818         if test -n "$with_dashes" ; then
 819                 PATH="$TEST_DIRECTORY/..:$PATH"
 820         fi
 821 fi
 822 GIT_TEMPLATE_DIR=$(pwd)/../templates/blt
 823 unset GIT_CONFIG
 824 GIT_CONFIG_NOSYSTEM=1
 825 GIT_CONFIG_NOGLOBAL=1
 826 export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG_NOSYSTEM GIT_CONFIG_NOGLOBAL
 827
 828 . ../GIT-BUILD-OPTIONS
 829
 830 if test -z "$GIT_TEST_CMP"
 831 then
 832         if test -n "$GIT_TEST_CMP_USE_COPIED_CONTEXT"
 833         then
 834                 GIT_TEST_CMP="$DIFF -c"
 835         else
 836                 GIT_TEST_CMP="$DIFF -u"
 837         fi
 838 fi
 839
 840 GITPERLLIB=$(pwd)/../perl/blib/lib:$(pwd)/../perl/blib/arch/auto/Git
 841 export GITPERLLIB
 842 test -d ../templates/blt || {
 843         error "You haven't built things yet, have you?"
 844 }
 845
 846 if test -z "$GIT_TEST_INSTALLED" && test -z "$NO_PYTHON"
 847 then
 848         GITPYTHONLIB="$(pwd)/../git_remote_helpers/build/lib"
 849         export GITPYTHONLIB
 850         test -d ../git_remote_helpers/build || {
 851                 error "You haven't built git_remote_helpers yet, have you?"
 852         }
 853 fi
 854
 855 if ! test -x ../test-chmtime; then
 856         echo >&2 'You need to build test-chmtime:'
 857         echo >&2 'Run "make test-chmtime" in the source (toplevel) directory'
 858         exit 1
 859 fi
 860
 861 # Test repository
 862 test="trash directory.$(basename "$0" .sh)"
 863 test -n "$root" && test="$root/$test"
 864 case "$test" in
 865 /*) TRASH_DIRECTORY="$test" ;;
 866  *) TRASH_DIRECTORY="$TEST_DIRECTORY/$test" ;;
 867 esac
 868 test ! -z "$debug" || remove_trash=$TRASH_DIRECTORY
 869 rm -fr "$test" || {
 870         GIT_EXIT_OK=t
 871         echo >&5 "FATAL: Cannot prepare test area"
 872         exit 1
 873 }
 874
 875 test_create_repo "$test"
 876 # Use -P to resolve symlinks in our working directory so that the cwd
 877 # in subprocesses like git equals our $PWD (for pathname comparisons).
 878 cd -P "$test" || exit 1
 879
 880 this_test=${0##*/}
 881 this_test=${this_test%%-*}
 882 for skp in $GIT_SKIP_TESTS
 883 do
 884         case "$this_test" in
 885         $skp)
 886                 say_color skip >&3 "skipping test $this_test altogether"
 887                 skip_all="skip all tests in $this_test"
 888                 test_done
 889         esac
 890 done
 891
 892 # Provide an implementation of the 'yes' utility
 893 yes () {
 894         if test $# = 0
 895         then
 896                 y=y
 897         else
 898                 y="$*"
 899         fi
 900
 901         while echo "$y"
 902         do
 903                 :
 904         done
 905 }
 906
 907 # Fix some commands on Windows
 908 case $(uname -s) in
 909 *MINGW*)
 910         # Windows has its own (incompatible) sort and find
 911         sort () {
 912                 /usr/bin/sort "$@"
 913         }
 914         find () {
 915                 /usr/bin/find "$@"
 916         }
 917         sum () {
 918                 md5sum "$@"
 919         }
 920         # git sees Windows-style pwd
 921         pwd () {
 922                 builtin pwd -W
 923         }
 924         # no POSIX permissions
 925         # backslashes in pathspec are converted to '/'
 926         # exec does not inherit the PID
 927         ;;
 928 *)
 929         test_set_prereq POSIXPERM
 930         test_set_prereq BSLASHPSPEC
 931         test_set_prereq EXECKEEPSPID
 932         ;;
 933 esac
 934
 935 test -z "$NO_PERL" && test_set_prereq PERL
 936 test -z "$NO_PYTHON" && test_set_prereq PYTHON
 937
 938 # test whether the filesystem supports symbolic links
 939 ln -s x y 2>/dev/null && test -h y 2>/dev/null && test_set_prereq SYMLINKS
 940 rm -f y