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