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 EMAIL
  51 unset LANGUAGE
  52 unset $(perl -e '
  53         my @env = keys %ENV;
  54         my $ok = join("|", qw(
  55                 TRACE
  56                 DEBUG
  57                 USE_LOOKUP
  58                 TEST
  59                 .*_TEST
  60                 PROVE
  61                 VALGRIND
  62         ));
  63         my @vars = grep(/^GIT_/ && !/^GIT_($ok)/o, @env);
  64         print join("\n", @vars);
  65 ')
  66 GIT_AUTHOR_EMAIL=author@example.com
  67 GIT_AUTHOR_NAME='A U Thor'
  68 GIT_COMMITTER_EMAIL=committer@example.com
  69 GIT_COMMITTER_NAME='C O Mitter'
  70 GIT_MERGE_VERBOSITY=5
  71 GIT_MERGE_AUTOEDIT=no
  72 export GIT_MERGE_VERBOSITY GIT_MERGE_AUTOEDIT
  73 export GIT_AUTHOR_EMAIL GIT_AUTHOR_NAME
  74 export GIT_COMMITTER_EMAIL GIT_COMMITTER_NAME
  75 export EDITOR
  76
  77 # Protect ourselves from common misconfiguration to export
  78 # CDPATH into the environment
  79 unset CDPATH
  80
  81 unset GREP_OPTIONS
  82
  83 case $(echo $GIT_TRACE |tr "[A-Z]" "[a-z]") in
  84         1|2|true)
  85                 echo "* warning: Some tests will not work if GIT_TRACE" \
  86                         "is set as to trace on STDERR ! *"
  87                 echo "* warning: Please set GIT_TRACE to something" \
  88                         "other than 1, 2 or true ! *"
  89                 ;;
  90 esac
  91
  92 # Convenience
  93 #
  94 # A regexp to match 5 and 40 hexdigits
  95 _x05='[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
  96 _x40="$_x05$_x05$_x05$_x05$_x05$_x05$_x05$_x05"
  97
  98 # Zero SHA-1
  99 _z40=0000000000000000000000000000000000000000
 100
 101 # Line feed
 102 LF='
 103 '
 104
 105 # Each test should start with something like this, after copyright notices:
 106 #
 107 # test_description='Description of this test...
 108 # This test checks if command xyzzy does the right thing...
 109 # '
 110 # . ./test-lib.sh
 111 [ "x$ORIGINAL_TERM" != "xdumb" ] && (
 112                 TERM=$ORIGINAL_TERM &&
 113                 export TERM &&
 114                 [ -t 1 ] &&
 115                 tput bold >/dev/null 2>&1 &&
 116                 tput setaf 1 >/dev/null 2>&1 &&
 117                 tput sgr0 >/dev/null 2>&1
 118         ) &&
 119         color=t
 120
 121 while test "$#" -ne 0
 122 do
 123         case "$1" in
 124         -d|--d|--de|--deb|--debu|--debug)
 125                 debug=t; shift ;;
 126         -i|--i|--im|--imm|--imme|--immed|--immedi|--immedia|--immediat|--immediate)
 127                 immediate=t; shift ;;
 128         -l|--l|--lo|--lon|--long|--long-|--long-t|--long-te|--long-tes|--long-test|--long-tests)
 129                 GIT_TEST_LONG=t; export GIT_TEST_LONG; shift ;;
 130         -h|--h|--he|--hel|--help)
 131                 help=t; shift ;;
 132         -v|--v|--ve|--ver|--verb|--verbo|--verbos|--verbose)
 133                 verbose=t; shift ;;
 134         -q|--q|--qu|--qui|--quie|--quiet)
 135                 # Ignore --quiet under a TAP::Harness. Saying how many tests
 136                 # passed without the ok/not ok details is always an error.
 137                 test -z "$HARNESS_ACTIVE" && quiet=t; shift ;;
 138         --with-dashes)
 139                 with_dashes=t; shift ;;
 140         --no-color)
 141                 color=; shift ;;
 142         --va|--val|--valg|--valgr|--valgri|--valgrin|--valgrind)
 143                 valgrind=t; verbose=t; shift ;;
 144         --tee)
 145                 shift ;; # was handled already
 146         --root=*)
 147                 root=$(expr "z$1" : 'z[^=]*=\(.*\)')
 148                 shift ;;
 149         *)
 150                 echo "error: unknown test option '$1'" >&2; exit 1 ;;
 151         esac
 152 done
 153
 154 if test -n "$color"; then
 155         say_color () {
 156                 (
 157                 TERM=$ORIGINAL_TERM
 158                 export TERM
 159                 case "$1" in
 160                         error) tput bold; tput setaf 1;; # bold red
 161                         skip)  tput bold; tput setaf 2;; # bold green
 162                         pass)  tput setaf 2;;            # green
 163                         info)  tput setaf 3;;            # brown
 164                         *) test -n "$quiet" && return;;
 165                 esac
 166                 shift
 167                 printf "%s" "$*"
 168                 tput sgr0
 169                 echo
 170                 )
 171         }
 172 else
 173         say_color() {
 174                 test -z "$1" && test -n "$quiet" && return
 175                 shift
 176                 echo "$*"
 177         }
 178 fi
 179
 180 error () {
 181         say_color error "error: $*"
 182         GIT_EXIT_OK=t
 183         exit 1
 184 }
 185
 186 say () {
 187         say_color info "$*"
 188 }
 189
 190 test "${test_description}" != "" ||
 191 error "Test script did not set test_description."
 192
 193 if test "$help" = "t"
 194 then
 195         echo "$test_description"
 196         exit 0
 197 fi
 198
 199 exec 5>&1
 200 exec 6<&0
 201 if test "$verbose" = "t"
 202 then
 203         exec 4>&2 3>&1
 204 else
 205         exec 4>/dev/null 3>/dev/null
 206 fi
 207
 208 test_failure=0
 209 test_count=0
 210 test_fixed=0
 211 test_broken=0
 212 test_success=0
 213
 214 test_external_has_tap=0
 215
 216 die () {
 217         code=$?
 218         if test -n "$GIT_EXIT_OK"
 219         then
 220                 exit $code
 221         else
 222                 echo >&5 "FATAL: Unexpected exit with code $code"
 223                 exit 1
 224         fi
 225 }
 226
 227 GIT_EXIT_OK=
 228 trap 'die' EXIT
 229
 230 # The semantics of the editor variables are that of invoking
 231 # sh -c "$EDITOR \"$@\"" files ...
 232 #
 233 # If our trash directory contains shell metacharacters, they will be
 234 # interpreted if we just set $EDITOR directly, so do a little dance with
 235 # environment variables to work around this.
 236 #
 237 # In particular, quoting isn't enough, as the path may contain the same quote
 238 # that we're using.
 239 test_set_editor () {
 240         FAKE_EDITOR="$1"
 241         export FAKE_EDITOR
 242         EDITOR='"$FAKE_EDITOR"'
 243         export EDITOR
 244 }
 245
 246 test_decode_color () {
 247         awk '
 248                 function name(n) {
 249                         if (n == 0) return "RESET";
 250                         if (n == 1) return "BOLD";
 251                         if (n == 30) return "BLACK";
 252                         if (n == 31) return "RED";
 253                         if (n == 32) return "GREEN";
 254                         if (n == 33) return "YELLOW";
 255                         if (n == 34) return "BLUE";
 256                         if (n == 35) return "MAGENTA";
 257                         if (n == 36) return "CYAN";
 258                         if (n == 37) return "WHITE";
 259                         if (n == 40) return "BLACK";
 260                         if (n == 41) return "BRED";
 261                         if (n == 42) return "BGREEN";
 262                         if (n == 43) return "BYELLOW";
 263                         if (n == 44) return "BBLUE";
 264                         if (n == 45) return "BMAGENTA";
 265                         if (n == 46) return "BCYAN";
 266                         if (n == 47) return "BWHITE";
 267                 }
 268                 {
 269                         while (match($0, /\033\[[0-9;]*m/) != 0) {
 270                                 printf "%s<", substr($0, 1, RSTART-1);
 271                                 codes = substr($0, RSTART+2, RLENGTH-3);
 272                                 if (length(codes) == 0)
 273                                         printf "%s", name(0)
 274                                 else {
 275                                         n = split(codes, ary, ";");
 276                                         sep = "";
 277                                         for (i = 1; i <= n; i++) {
 278                                                 printf "%s%s", sep, name(ary[i]);
 279                                                 sep = ";"
 280                                         }
 281                                 }
 282                                 printf ">";
 283                                 $0 = substr($0, RSTART + RLENGTH, length($0) - RSTART - RLENGTH + 1);
 284                         }
 285                         print
 286                 }
 287         '
 288 }
 289
 290 nul_to_q () {
 291         perl -pe 'y/\000/Q/'
 292 }
 293
 294 q_to_nul () {
 295         perl -pe 'y/Q/\000/'
 296 }
 297
 298 q_to_cr () {
 299         tr Q '\015'
 300 }
 301
 302 q_to_tab () {
 303         tr Q '\011'
 304 }
 305
 306 append_cr () {
 307         sed -e 's/$/Q/' | tr Q '\015'
 308 }
 309
 310 remove_cr () {
 311         tr '\015' Q | sed -e 's/Q$//'
 312 }
 313
 314 # In some bourne shell implementations, the "unset" builtin returns
 315 # nonzero status when a variable to be unset was not set in the first
 316 # place.
 317 #
 318 # Use sane_unset when that should not be considered an error.
 319
 320 sane_unset () {
 321         unset "$@"
 322         return 0
 323 }
 324
 325 test_tick () {
 326         if test -z "${test_tick+set}"
 327         then
 328                 test_tick=1112911993
 329         else
 330                 test_tick=$(($test_tick + 60))
 331         fi
 332         GIT_COMMITTER_DATE="$test_tick -0700"
 333         GIT_AUTHOR_DATE="$test_tick -0700"
 334         export GIT_COMMITTER_DATE GIT_AUTHOR_DATE
 335 }
 336
 337 # Stop execution and start a shell. This is useful for debugging tests and
 338 # only makes sense together with "-v".
 339 #
 340 # Be sure to remove all invocations of this command before submitting.
 341
 342 test_pause () {
 343         if test "$verbose" = t; then
 344                 "$SHELL_PATH" <&6 >&3 2>&4
 345         else
 346                 error >&5 "test_pause requires --verbose"
 347         fi
 348 }
 349
 350 # Call test_commit with the arguments "<message> [<file> [<contents>]]"
 351 #
 352 # This will commit a file with the given contents and the given commit
 353 # message.  It will also add a tag with <message> as name.
 354 #
 355 # Both <file> and <contents> default to <message>.
 356
 357 test_commit () {
 358         file=${2:-"$1.t"}
 359         echo "${3-$1}" > "$file" &&
 360         git add "$file" &&
 361         test_tick &&
 362         git commit -m "$1" &&
 363         git tag "$1"
 364 }
 365
 366 # Call test_merge with the arguments "<message> <commit>", where <commit>
 367 # can be a tag pointing to the commit-to-merge.
 368
 369 test_merge () {
 370         test_tick &&
 371         git merge -m "$1" "$2" &&
 372         git tag "$1"
 373 }
 374
 375 # This function helps systems where core.filemode=false is set.
 376 # Use it instead of plain 'chmod +x' to set or unset the executable bit
 377 # of a file in the working directory and add it to the index.
 378
 379 test_chmod () {
 380         chmod "$@" &&
 381         git update-index --add "--chmod=$@"
 382 }
 383
 384 # Unset a configuration variable, but don't fail if it doesn't exist.
 385 test_unconfig () {
 386         git config --unset-all "$@"
 387         config_status=$?
 388         case "$config_status" in
 389         5) # ok, nothing to unset
 390                 config_status=0
 391                 ;;
 392         esac
 393         return $config_status
 394 }
 395
 396 # Set git config, automatically unsetting it after the test is over.
 397 test_config () {
 398         test_when_finished "test_unconfig '$1'" &&
 399         git config "$@"
 400 }
 401
 402
 403 test_config_global () {
 404         test_when_finished "test_unconfig --global '$1'" &&
 405         git config --global "$@"
 406 }
 407
 408 write_script () {
 409         {
 410                 echo "#!${2-"$SHELL_PATH"}" &&
 411                 cat
 412         } >"$1" &&
 413         chmod +x "$1"
 414 }
 415
 416 # Use test_set_prereq to tell that a particular prerequisite is available.
 417 # The prerequisite can later be checked for in two ways:
 418 #
 419 # - Explicitly using test_have_prereq.
 420 #
 421 # - Implicitly by specifying the prerequisite tag in the calls to
 422 #   test_expect_{success,failure,code}.
 423 #
 424 # The single parameter is the prerequisite tag (a simple word, in all
 425 # capital letters by convention).
 426
 427 test_set_prereq () {
 428         satisfied="$satisfied$1 "
 429 }
 430 satisfied=" "
 431
 432 test_have_prereq () {
 433         # prerequisites can be concatenated with ','
 434         save_IFS=$IFS
 435         IFS=,
 436         set -- $*
 437         IFS=$save_IFS
 438
 439         total_prereq=0
 440         ok_prereq=0
 441         missing_prereq=
 442
 443         for prerequisite
 444         do
 445                 total_prereq=$(($total_prereq + 1))
 446                 case $satisfied in
 447                 *" $prerequisite "*)
 448                         ok_prereq=$(($ok_prereq + 1))
 449                         ;;
 450                 *)
 451                         # Keep a list of missing prerequisites
 452                         if test -z "$missing_prereq"
 453                         then
 454                                 missing_prereq=$prerequisite
 455                         else
 456                                 missing_prereq="$prerequisite,$missing_prereq"
 457                         fi
 458                 esac
 459         done
 460
 461         test $total_prereq = $ok_prereq
 462 }
 463
 464 test_declared_prereq () {
 465         case ",$test_prereq," in
 466         *,$1,*)
 467                 return 0
 468                 ;;
 469         esac
 470         return 1
 471 }
 472
 473 # You are not expected to call test_ok_ and test_failure_ directly, use
 474 # the text_expect_* functions instead.
 475
 476 test_ok_ () {
 477         test_success=$(($test_success + 1))
 478         say_color "" "ok $test_count - $@"
 479 }
 480
 481 test_failure_ () {
 482         test_failure=$(($test_failure + 1))
 483         say_color error "not ok - $test_count $1"
 484         shift
 485         echo "$@" | sed -e 's/^/#       /'
 486         test "$immediate" = "" || { GIT_EXIT_OK=t; exit 1; }
 487 }
 488
 489 test_known_broken_ok_ () {
 490         test_fixed=$(($test_fixed+1))
 491         say_color "" "ok $test_count - $@ # TODO known breakage"
 492 }
 493
 494 test_known_broken_failure_ () {
 495         test_broken=$(($test_broken+1))
 496         say_color skip "not ok $test_count - $@ # TODO known breakage"
 497 }
 498
 499 test_debug () {
 500         test "$debug" = "" || eval "$1"
 501 }
 502
 503 test_eval_ () {
 504         # This is a separate function because some tests use
 505         # "return" to end a test_expect_success block early.
 506         eval </dev/null >&3 2>&4 "$*"
 507 }
 508
 509 test_run_ () {
 510         test_cleanup=:
 511         expecting_failure=$2
 512         test_eval_ "$1"
 513         eval_ret=$?
 514
 515         if test -z "$immediate" || test $eval_ret = 0 || test -n "$expecting_failure"
 516         then
 517                 test_eval_ "$test_cleanup"
 518         fi
 519         if test "$verbose" = "t" && test -n "$HARNESS_ACTIVE"; then
 520                 echo ""
 521         fi
 522         return "$eval_ret"
 523 }
 524
 525 test_skip () {
 526         test_count=$(($test_count+1))
 527         to_skip=
 528         for skp in $GIT_SKIP_TESTS
 529         do
 530                 case $this_test.$test_count in
 531                 $skp)
 532                         to_skip=t
 533                         break
 534                 esac
 535         done
 536         if test -z "$to_skip" && test -n "$test_prereq" &&
 537            ! test_have_prereq "$test_prereq"
 538         then
 539                 to_skip=t
 540         fi
 541         case "$to_skip" in
 542         t)
 543                 of_prereq=
 544                 if test "$missing_prereq" != "$test_prereq"
 545                 then
 546                         of_prereq=" of $test_prereq"
 547                 fi
 548
 549                 say_color skip >&3 "skipping test: $@"
 550                 say_color skip "ok $test_count # skip $1 (missing $missing_prereq${of_prereq})"
 551                 : true
 552                 ;;
 553         *)
 554                 false
 555                 ;;
 556         esac
 557 }
 558
 559 test_expect_failure () {
 560         test "$#" = 3 && { test_prereq=$1; shift; } || test_prereq=
 561         test "$#" = 2 ||
 562         error "bug in the test script: not 2 or 3 parameters to test-expect-failure"
 563         export test_prereq
 564         if ! test_skip "$@"
 565         then
 566                 say >&3 "checking known breakage: $2"
 567                 if test_run_ "$2" expecting_failure
 568                 then
 569                         test_known_broken_ok_ "$1"
 570                 else
 571                         test_known_broken_failure_ "$1"
 572                 fi
 573         fi
 574         echo >&3 ""
 575 }
 576
 577 test_expect_success () {
 578         test "$#" = 3 && { test_prereq=$1; shift; } || test_prereq=
 579         test "$#" = 2 ||
 580         error "bug in the test script: not 2 or 3 parameters to test-expect-success"
 581         export test_prereq
 582         if ! test_skip "$@"
 583         then
 584                 say >&3 "expecting success: $2"
 585                 if test_run_ "$2"
 586                 then
 587                         test_ok_ "$1"
 588                 else
 589                         test_failure_ "$@"
 590                 fi
 591         fi
 592         echo >&3 ""
 593 }
 594
 595 # test_external runs external test scripts that provide continuous
 596 # test output about their progress, and succeeds/fails on
 597 # zero/non-zero exit code.  It outputs the test output on stdout even
 598 # in non-verbose mode, and announces the external script with "# run
 599 # <n>: ..." before running it.  When providing relative paths, keep in
 600 # mind that all scripts run in "trash directory".
 601 # Usage: test_external description command arguments...
 602 # Example: test_external 'Perl API' perl ../path/to/test.pl
 603 test_external () {
 604         test "$#" = 4 && { test_prereq=$1; shift; } || test_prereq=
 605         test "$#" = 3 ||
 606         error >&5 "bug in the test script: not 3 or 4 parameters to test_external"
 607         descr="$1"
 608         shift
 609         export test_prereq
 610         if ! test_skip "$descr" "$@"
 611         then
 612                 # Announce the script to reduce confusion about the
 613                 # test output that follows.
 614                 say_color "" "# run $test_count: $descr ($*)"
 615                 # Export TEST_DIRECTORY, TRASH_DIRECTORY and GIT_TEST_LONG
 616                 # to be able to use them in script
 617                 export TEST_DIRECTORY TRASH_DIRECTORY GIT_TEST_LONG
 618                 # Run command; redirect its stderr to &4 as in
 619                 # test_run_, but keep its stdout on our stdout even in
 620                 # non-verbose mode.
 621                 "$@" 2>&4
 622                 if [ "$?" = 0 ]
 623                 then
 624                         if test $test_external_has_tap -eq 0; then
 625                                 test_ok_ "$descr"
 626                         else
 627                                 say_color "" "# test_external test $descr was ok"
 628                                 test_success=$(($test_success + 1))
 629                         fi
 630                 else
 631                         if test $test_external_has_tap -eq 0; then
 632                                 test_failure_ "$descr" "$@"
 633                         else
 634                                 say_color error "# test_external test $descr failed: $@"
 635                                 test_failure=$(($test_failure + 1))
 636                         fi
 637                 fi
 638         fi
 639 }
 640
 641 # Like test_external, but in addition tests that the command generated
 642 # no output on stderr.
 643 test_external_without_stderr () {
 644         # The temporary file has no (and must have no) security
 645         # implications.
 646         tmp=${TMPDIR:-/tmp}
 647         stderr="$tmp/git-external-stderr.$$.tmp"
 648         test_external "$@" 4> "$stderr"
 649         [ -f "$stderr" ] || error "Internal error: $stderr disappeared."
 650         descr="no stderr: $1"
 651         shift
 652         say >&3 "# expecting no stderr from previous command"
 653         if [ ! -s "$stderr" ]; then
 654                 rm "$stderr"
 655
 656                 if test $test_external_has_tap -eq 0; then
 657                         test_ok_ "$descr"
 658                 else
 659                         say_color "" "# test_external_without_stderr test $descr was ok"
 660                         test_success=$(($test_success + 1))
 661                 fi
 662         else
 663                 if [ "$verbose" = t ]; then
 664                         output=`echo; echo "# Stderr is:"; cat "$stderr"`
 665                 else
 666                         output=
 667                 fi
 668                 # rm first in case test_failure exits.
 669                 rm "$stderr"
 670                 if test $test_external_has_tap -eq 0; then
 671                         test_failure_ "$descr" "$@" "$output"
 672                 else
 673                         say_color error "# test_external_without_stderr test $descr failed: $@: $output"
 674                         test_failure=$(($test_failure + 1))
 675                 fi
 676         fi
 677 }
 678
 679 # debugging-friendly alternatives to "test [-f|-d|-e]"
 680 # The commands test the existence or non-existence of $1. $2 can be
 681 # given to provide a more precise diagnosis.
 682 test_path_is_file () {
 683         if ! [ -f "$1" ]
 684         then
 685                 echo "File $1 doesn't exist. $*"
 686                 false
 687         fi
 688 }
 689
 690 test_path_is_dir () {
 691         if ! [ -d "$1" ]
 692         then
 693                 echo "Directory $1 doesn't exist. $*"
 694                 false
 695         fi
 696 }
 697
 698 test_path_is_missing () {
 699         if [ -e "$1" ]
 700         then
 701                 echo "Path exists:"
 702                 ls -ld "$1"
 703                 if [ $# -ge 1 ]; then
 704                         echo "$*"
 705                 fi
 706                 false
 707         fi
 708 }
 709
 710 # test_line_count checks that a file has the number of lines it
 711 # ought to. For example:
 712 #
 713 #       test_expect_success 'produce exactly one line of output' '
 714 #               do something >output &&
 715 #               test_line_count = 1 output
 716 #       '
 717 #
 718 # is like "test $(wc -l <output) = 1" except that it passes the
 719 # output through when the number of lines is wrong.
 720
 721 test_line_count () {
 722         if test $# != 3
 723         then
 724                 error "bug in the test script: not 3 parameters to test_line_count"
 725         elif ! test $(wc -l <"$3") "$1" "$2"
 726         then
 727                 echo "test_line_count: line count for $3 !$1 $2"
 728                 cat "$3"
 729                 return 1
 730         fi
 731 }
 732
 733 # This is not among top-level (test_expect_success | test_expect_failure)
 734 # but is a prefix that can be used in the test script, like:
 735 #
 736 #       test_expect_success 'complain and die' '
 737 #           do something &&
 738 #           do something else &&
 739 #           test_must_fail git checkout ../outerspace
 740 #       '
 741 #
 742 # Writing this as "! git checkout ../outerspace" is wrong, because
 743 # the failure could be due to a segv.  We want a controlled failure.
 744
 745 test_must_fail () {
 746         "$@"
 747         exit_code=$?
 748         if test $exit_code = 0; then
 749                 echo >&2 "test_must_fail: command succeeded: $*"
 750                 return 1
 751         elif test $exit_code -gt 129 -a $exit_code -le 192; then
 752                 echo >&2 "test_must_fail: died by signal: $*"
 753                 return 1
 754         elif test $exit_code = 127; then
 755                 echo >&2 "test_must_fail: command not found: $*"
 756                 return 1
 757         fi
 758         return 0
 759 }
 760
 761 # Similar to test_must_fail, but tolerates success, too.  This is
 762 # meant to be used in contexts like:
 763 #
 764 #       test_expect_success 'some command works without configuration' '
 765 #               test_might_fail git config --unset all.configuration &&
 766 #               do something
 767 #       '
 768 #
 769 # Writing "git config --unset all.configuration || :" would be wrong,
 770 # because we want to notice if it fails due to segv.
 771
 772 test_might_fail () {
 773         "$@"
 774         exit_code=$?
 775         if test $exit_code -gt 129 -a $exit_code -le 192; then
 776                 echo >&2 "test_might_fail: died by signal: $*"
 777                 return 1
 778         elif test $exit_code = 127; then
 779                 echo >&2 "test_might_fail: command not found: $*"
 780                 return 1
 781         fi
 782         return 0
 783 }
 784
 785 # Similar to test_must_fail and test_might_fail, but check that a
 786 # given command exited with a given exit code. Meant to be used as:
 787 #
 788 #       test_expect_success 'Merge with d/f conflicts' '
 789 #               test_expect_code 1 git merge "merge msg" B master
 790 #       '
 791
 792 test_expect_code () {
 793         want_code=$1
 794         shift
 795         "$@"
 796         exit_code=$?
 797         if test $exit_code = $want_code
 798         then
 799                 return 0
 800         fi
 801
 802         echo >&2 "test_expect_code: command exited with $exit_code, we wanted $want_code $*"
 803         return 1
 804 }
 805
 806 # test_cmp is a helper function to compare actual and expected output.
 807 # You can use it like:
 808 #
 809 #       test_expect_success 'foo works' '
 810 #               echo expected >expected &&
 811 #               foo >actual &&
 812 #               test_cmp expected actual
 813 #       '
 814 #
 815 # This could be written as either "cmp" or "diff -u", but:
 816 # - cmp's output is not nearly as easy to read as diff -u
 817 # - not all diff versions understand "-u"
 818
 819 test_cmp() {
 820         $GIT_TEST_CMP "$@"
 821 }
 822
 823 # This function can be used to schedule some commands to be run
 824 # unconditionally at the end of the test to restore sanity:
 825 #
 826 #       test_expect_success 'test core.capslock' '
 827 #               git config core.capslock true &&
 828 #               test_when_finished "git config --unset core.capslock" &&
 829 #               hello world
 830 #       '
 831 #
 832 # That would be roughly equivalent to
 833 #
 834 #       test_expect_success 'test core.capslock' '
 835 #               git config core.capslock true &&
 836 #               hello world
 837 #               git config --unset core.capslock
 838 #       '
 839 #
 840 # except that the greeting and config --unset must both succeed for
 841 # the test to pass.
 842 #
 843 # Note that under --immediate mode, no clean-up is done to help diagnose
 844 # what went wrong.
 845
 846 test_when_finished () {
 847         test_cleanup="{ $*
 848                 } && (exit \"\$eval_ret\"); eval_ret=\$?; $test_cleanup"
 849 }
 850
 851 # Most tests can use the created repository, but some may need to create more.
 852 # Usage: test_create_repo <directory>
 853 test_create_repo () {
 854         test "$#" = 1 ||
 855         error "bug in the test script: not 1 parameter to test-create-repo"
 856         repo="$1"
 857         mkdir -p "$repo"
 858         (
 859                 cd "$repo" || error "Cannot setup test environment"
 860                 "$GIT_EXEC_PATH/git-init" "--template=$GIT_BUILD_DIR/templates/blt/" >&3 2>&4 ||
 861                 error "cannot run git init -- have you built things yet?"
 862                 mv .git/hooks .git/hooks-disabled
 863         ) || exit
 864 }
 865
 866 test_done () {
 867         GIT_EXIT_OK=t
 868
 869         if test -z "$HARNESS_ACTIVE"; then
 870                 test_results_dir="$TEST_DIRECTORY/test-results"
 871                 mkdir -p "$test_results_dir"
 872                 test_results_path="$test_results_dir/${0%.sh}-$$.counts"
 873
 874                 cat >>"$test_results_path" <<-EOF
 875                 total $test_count
 876                 success $test_success
 877                 fixed $test_fixed
 878                 broken $test_broken
 879                 failed $test_failure
 880
 881                 EOF
 882         fi
 883
 884         if test "$test_fixed" != 0
 885         then
 886                 say_color pass "# fixed $test_fixed known breakage(s)"
 887         fi
 888         if test "$test_broken" != 0
 889         then
 890                 say_color error "# still have $test_broken known breakage(s)"
 891                 msg="remaining $(($test_count-$test_broken)) test(s)"
 892         else
 893                 msg="$test_count test(s)"
 894         fi
 895         case "$test_failure" in
 896         0)
 897                 # Maybe print SKIP message
 898                 [ -z "$skip_all" ] || skip_all=" # SKIP $skip_all"
 899
 900                 if test $test_external_has_tap -eq 0; then
 901                         say_color pass "# passed all $msg"
 902                         say "1..$test_count$skip_all"
 903                 fi
 904
 905                 test -d "$remove_trash" &&
 906                 cd "$(dirname "$remove_trash")" &&
 907                 rm -rf "$(basename "$remove_trash")"
 908
 909                 exit 0 ;;
 910
 911         *)
 912                 if test $test_external_has_tap -eq 0; then
 913                         say_color error "# failed $test_failure among $msg"
 914                         say "1..$test_count"
 915                 fi
 916
 917                 exit 1 ;;
 918
 919         esac
 920 }
 921
 922 # Test the binaries we have just built.  The tests are kept in
 923 # t/ subdirectory and are run in 'trash directory' subdirectory.
 924 if test -z "$TEST_DIRECTORY"
 925 then
 926         # We allow tests to override this, in case they want to run tests
 927         # outside of t/, e.g. for running tests on the test library
 928         # itself.
 929         TEST_DIRECTORY=$(pwd)
 930 fi
 931 GIT_BUILD_DIR="$TEST_DIRECTORY"/..
 932
 933 if test -n "$valgrind"
 934 then
 935         make_symlink () {
 936                 test -h "$2" &&
 937                 test "$1" = "$(readlink "$2")" || {
 938                         # be super paranoid
 939                         if mkdir "$2".lock
 940                         then
 941                                 rm -f "$2" &&
 942                                 ln -s "$1" "$2" &&
 943                                 rm -r "$2".lock
 944                         else
 945                                 while test -d "$2".lock
 946                                 do
 947                                         say "Waiting for lock on $2."
 948                                         sleep 1
 949                                 done
 950                         fi
 951                 }
 952         }
 953
 954         make_valgrind_symlink () {
 955                 # handle only executables, unless they are shell libraries that
 956                 # need to be in the exec-path.  We will just use "#!" as a
 957                 # guess for a shell-script, since we have no idea what the user
 958                 # may have configured as the shell path.
 959                 test -x "$1" ||
 960                 test "#!" = "$(head -c 2 <"$1")" ||
 961                 return;
 962
 963                 base=$(basename "$1")
 964                 symlink_target=$GIT_BUILD_DIR/$base
 965                 # do not override scripts
 966                 if test -x "$symlink_target" &&
 967                     test ! -d "$symlink_target" &&
 968                     test "#!" != "$(head -c 2 < "$symlink_target")"
 969                 then
 970                         symlink_target=../valgrind.sh
 971                 fi
 972                 case "$base" in
 973                 *.sh|*.perl)
 974                         symlink_target=../unprocessed-script
 975                 esac
 976                 # create the link, or replace it if it is out of date
 977                 make_symlink "$symlink_target" "$GIT_VALGRIND/bin/$base" || exit
 978         }
 979
 980         # override all git executables in TEST_DIRECTORY/..
 981         GIT_VALGRIND=$TEST_DIRECTORY/valgrind
 982         mkdir -p "$GIT_VALGRIND"/bin
 983         for file in $GIT_BUILD_DIR/git* $GIT_BUILD_DIR/test-*
 984         do
 985                 make_valgrind_symlink $file
 986         done
 987         # special-case the mergetools loadables
 988         make_symlink "$GIT_BUILD_DIR"/mergetools "$GIT_VALGRIND/bin/mergetools"
 989         OLDIFS=$IFS
 990         IFS=:
 991         for path in $PATH
 992         do
 993                 ls "$path"/git-* 2> /dev/null |
 994                 while read file
 995                 do
 996                         make_valgrind_symlink "$file"
 997                 done
 998         done
 999         IFS=$OLDIFS
1000         PATH=$GIT_VALGRIND/bin:$PATH
1001         GIT_EXEC_PATH=$GIT_VALGRIND/bin
1002         export GIT_VALGRIND
1003 elif test -n "$GIT_TEST_INSTALLED" ; then
1004         GIT_EXEC_PATH=$($GIT_TEST_INSTALLED/git --exec-path)  ||
1005         error "Cannot run git from $GIT_TEST_INSTALLED."
1006         PATH=$GIT_TEST_INSTALLED:$GIT_BUILD_DIR:$PATH
1007         GIT_EXEC_PATH=${GIT_TEST_EXEC_PATH:-$GIT_EXEC_PATH}
1008 else # normal case, use ../bin-wrappers only unless $with_dashes:
1009         git_bin_dir="$GIT_BUILD_DIR/bin-wrappers"
1010         if ! test -x "$git_bin_dir/git" ; then
1011                 if test -z "$with_dashes" ; then
1012                         say "$git_bin_dir/git is not executable; using GIT_EXEC_PATH"
1013                 fi
1014                 with_dashes=t
1015         fi
1016         PATH="$git_bin_dir:$PATH"
1017         GIT_EXEC_PATH=$GIT_BUILD_DIR
1018         if test -n "$with_dashes" ; then
1019                 PATH="$GIT_BUILD_DIR:$PATH"
1020         fi
1021 fi
1022 GIT_TEMPLATE_DIR="$GIT_BUILD_DIR"/templates/blt
1023 unset GIT_CONFIG
1024 GIT_CONFIG_NOSYSTEM=1
1025 GIT_ATTR_NOSYSTEM=1
1026 export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG_NOSYSTEM GIT_ATTR_NOSYSTEM
1027
1028 . "$GIT_BUILD_DIR"/GIT-BUILD-OPTIONS
1029
1030 if test -z "$GIT_TEST_CMP"
1031 then
1032         if test -n "$GIT_TEST_CMP_USE_COPIED_CONTEXT"
1033         then
1034                 GIT_TEST_CMP="$DIFF -c"
1035         else
1036                 GIT_TEST_CMP="$DIFF -u"
1037         fi
1038 fi
1039
1040 GITPERLLIB="$GIT_BUILD_DIR"/perl/blib/lib:"$GIT_BUILD_DIR"/perl/blib/arch/auto/Git
1041 export GITPERLLIB
1042 test -d "$GIT_BUILD_DIR"/templates/blt || {
1043         error "You haven't built things yet, have you?"
1044 }
1045
1046 if test -z "$GIT_TEST_INSTALLED" && test -z "$NO_PYTHON"
1047 then
1048         GITPYTHONLIB="$GIT_BUILD_DIR/git_remote_helpers/build/lib"
1049         export GITPYTHONLIB
1050         test -d "$GIT_BUILD_DIR"/git_remote_helpers/build || {
1051                 error "You haven't built git_remote_helpers yet, have you?"
1052         }
1053 fi
1054
1055 if ! test -x "$GIT_BUILD_DIR"/test-chmtime; then
1056         echo >&2 'You need to build test-chmtime:'
1057         echo >&2 'Run "make test-chmtime" in the source (toplevel) directory'
1058         exit 1
1059 fi
1060
1061 # Test repository
1062 test="trash directory.$(basename "$0" .sh)"
1063 test -n "$root" && test="$root/$test"
1064 case "$test" in
1065 /*) TRASH_DIRECTORY="$test" ;;
1066  *) TRASH_DIRECTORY="$TEST_DIRECTORY/$test" ;;
1067 esac
1068 test ! -z "$debug" || remove_trash=$TRASH_DIRECTORY
1069 rm -fr "$test" || {
1070         GIT_EXIT_OK=t
1071         echo >&5 "FATAL: Cannot prepare test area"
1072         exit 1
1073 }
1074
1075 HOME="$TRASH_DIRECTORY"
1076 export HOME
1077
1078 test_create_repo "$test"
1079 # Use -P to resolve symlinks in our working directory so that the cwd
1080 # in subprocesses like git equals our $PWD (for pathname comparisons).
1081 cd -P "$test" || exit 1
1082
1083 this_test=${0##*/}
1084 this_test=${this_test%%-*}
1085 for skp in $GIT_SKIP_TESTS
1086 do
1087         case "$this_test" in
1088         $skp)
1089                 say_color skip >&3 "skipping test $this_test altogether"
1090                 skip_all="skip all tests in $this_test"
1091                 test_done
1092         esac
1093 done
1094
1095 # Provide an implementation of the 'yes' utility
1096 yes () {
1097         if test $# = 0
1098         then
1099                 y=y
1100         else
1101                 y="$*"
1102         fi
1103
1104         while echo "$y"
1105         do
1106                 :
1107         done
1108 }
1109
1110 # Fix some commands on Windows
1111 case $(uname -s) in
1112 *MINGW*)
1113         # Windows has its own (incompatible) sort and find
1114         sort () {
1115                 /usr/bin/sort "$@"
1116         }
1117         find () {
1118                 /usr/bin/find "$@"
1119         }
1120         sum () {
1121                 md5sum "$@"
1122         }
1123         # git sees Windows-style pwd
1124         pwd () {
1125                 builtin pwd -W
1126         }
1127         # no POSIX permissions
1128         # backslashes in pathspec are converted to '/'
1129         # exec does not inherit the PID
1130         test_set_prereq MINGW
1131         test_set_prereq SED_STRIPS_CR
1132         ;;
1133 *CYGWIN*)
1134         test_set_prereq POSIXPERM
1135         test_set_prereq EXECKEEPSPID
1136         test_set_prereq NOT_MINGW
1137         test_set_prereq SED_STRIPS_CR
1138         ;;
1139 *)
1140         test_set_prereq POSIXPERM
1141         test_set_prereq BSLASHPSPEC
1142         test_set_prereq EXECKEEPSPID
1143         test_set_prereq NOT_MINGW
1144         ;;
1145 esac
1146
1147 test -z "$NO_PERL" && test_set_prereq PERL
1148 test -z "$NO_PYTHON" && test_set_prereq PYTHON
1149 test -n "$USE_LIBPCRE" && test_set_prereq LIBPCRE
1150 test -z "$NO_GETTEXT" && test_set_prereq GETTEXT
1151
1152 # Can we rely on git's output in the C locale?
1153 if test -n "$GETTEXT_POISON"
1154 then
1155         GIT_GETTEXT_POISON=YesPlease
1156         export GIT_GETTEXT_POISON
1157         test_set_prereq GETTEXT_POISON
1158 else
1159         test_set_prereq C_LOCALE_OUTPUT
1160 fi
1161
1162 # Use this instead of test_cmp to compare files that contain expected and
1163 # actual output from git commands that can be translated.  When running
1164 # under GETTEXT_POISON this pretends that the command produced expected
1165 # results.
1166 test_i18ncmp () {
1167         test -n "$GETTEXT_POISON" || test_cmp "$@"
1168 }
1169
1170 # Use this instead of "grep expected-string actual" to see if the
1171 # output from a git command that can be translated either contains an
1172 # expected string, or does not contain an unwanted one.  When running
1173 # under GETTEXT_POISON this pretends that the command produced expected
1174 # results.
1175 test_i18ngrep () {
1176         if test -n "$GETTEXT_POISON"
1177         then
1178             : # pretend success
1179         elif test "x!" = "x$1"
1180         then
1181                 shift
1182                 ! grep "$@"
1183         else
1184                 grep "$@"
1185         fi
1186 }
1187
1188 # test whether the filesystem supports symbolic links
1189 ln -s x y 2>/dev/null && test -h y 2>/dev/null && test_set_prereq SYMLINKS
1190 rm -f y
1191
1192 # When the tests are run as root, permission tests will report that
1193 # things are writable when they shouldn't be.
1194 test -w / || test_set_prereq SANITY