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