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