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