t/test-lib.sh

   1 #!/bin/sh
   2 #
   3 # Copyright (c) 2005 Junio C Hamano
   4 #
   5 # This program is free software: you can redistribute it and/or modify
   6 # it under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation, either version 2 of the License, or
   8 # (at your option) any later version.
   9 #
  10 # This program is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 # GNU General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License
  16 # along with this program.  If not, see http://www.gnu.org/licenses/ .
  17
  18 # if --tee was passed, write the output not only to the terminal, but
  19 # additionally to the file test-results/$BASENAME.out, too.
  20 case "$GIT_TEST_TEE_STARTED, $* " in
  21 done,*)
  22         # do not redirect again
  23         ;;
  24 *' --tee '*|*' --va'*)
  25         mkdir -p test-results
  26         BASE=test-results/$(basename "$0" .sh)
  27         (GIT_TEST_TEE_STARTED=done ${SHELL-sh} "$0" "$@" 2>&1;
  28          echo $? > $BASE.exit) | tee $BASE.out
  29         test "$(cat $BASE.exit)" = 0
  30         exit
  31         ;;
  32 esac
  33
  34 # Keep the original TERM for say_color
  35 ORIGINAL_TERM=$TERM
  36
  37 # For repeatability, reset the environment to known value.
  38 LANG=C
  39 LC_ALL=C
  40 PAGER=cat
  41 TZ=UTC
  42 TERM=dumb
  43 export LANG LC_ALL PAGER TERM TZ
  44 EDITOR=:
  45 unset VISUAL
  46 unset EMAIL
  47 unset $(perl -e '
  48         my @env = keys %ENV;
  49         my $ok = join("|", qw(
  50                 TRACE
  51                 DEBUG
  52                 USE_LOOKUP
  53                 TEST
  54                 .*_TEST
  55                 PROVE
  56                 VALGRIND
  57         ));
  58         my @vars = grep(/^GIT_/ && !/^GIT_($ok)/o, @env);
  59         print join("\n", @vars);
  60 ')
  61 GIT_AUTHOR_EMAIL=author@example.com
  62 GIT_AUTHOR_NAME='A U Thor'
  63 GIT_COMMITTER_EMAIL=committer@example.com
  64 GIT_COMMITTER_NAME='C O Mitter'
  65 GIT_MERGE_VERBOSITY=5
  66 export GIT_MERGE_VERBOSITY
  67 export GIT_AUTHOR_EMAIL GIT_AUTHOR_NAME
  68 export GIT_COMMITTER_EMAIL GIT_COMMITTER_NAME
  69 export EDITOR
  70
  71 # Protect ourselves from common misconfiguration to export
  72 # CDPATH into the environment
  73 unset CDPATH
  74
  75 unset GREP_OPTIONS
  76
  77 case $(echo $GIT_TRACE |tr "[A-Z]" "[a-z]") in
  78         1|2|true)
  79                 echo "* warning: Some tests will not work if GIT_TRACE" \
  80                         "is set as to trace on STDERR ! *"
  81                 echo "* warning: Please set GIT_TRACE to something" \
  82                         "other than 1, 2 or true ! *"
  83                 ;;
  84 esac
  85
  86 # Convenience
  87 #
  88 # A regexp to match 5 and 40 hexdigits
  89 _x05='[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
  90 _x40="$_x05$_x05$_x05$_x05$_x05$_x05$_x05$_x05"
  91
  92 # Zero SHA-1
  93 _z40=0000000000000000000000000000000000000000
  94
  95 # Each test should start with something like this, after copyright notices:
  96 #
  97 # test_description='Description of this test...
  98 # This test checks if command xyzzy does the right thing...
  99 # '
 100 # . ./test-lib.sh
 101 [ "x$ORIGINAL_TERM" != "xdumb" ] && (
 102                 TERM=$ORIGINAL_TERM &&
 103                 export TERM &&
 104                 [ -t 1 ] &&
 105                 tput bold >/dev/null 2>&1 &&
 106                 tput setaf 1 >/dev/null 2>&1 &&
 107                 tput sgr0 >/dev/null 2>&1
 108         ) &&
 109         color=t
 110
 111 while test "$#" -ne 0
 112 do
 113         case "$1" in
 114         -d|--d|--de|--deb|--debu|--debug)
 115                 debug=t; shift ;;
 116         -i|--i|--im|--imm|--imme|--immed|--immedi|--immedia|--immediat|--immediate)
 117                 immediate=t; shift ;;
 118         -l|--l|--lo|--lon|--long|--long-|--long-t|--long-te|--long-tes|--long-test|--long-tests)
 119                 GIT_TEST_LONG=t; export GIT_TEST_LONG; shift ;;
 120         -h|--h|--he|--hel|--help)
 121                 help=t; shift ;;
 122         -v|--v|--ve|--ver|--verb|--verbo|--verbos|--verbose)
 123                 verbose=t; shift ;;
 124         -q|--q|--qu|--qui|--quie|--quiet)
 125                 # Ignore --quiet under a TAP::Harness. Saying how many tests
 126                 # passed without the ok/not ok details is always an error.
 127                 test -z "$HARNESS_ACTIVE" && quiet=t; shift ;;
 128         --with-dashes)
 129                 with_dashes=t; shift ;;
 130         --no-color)
 131                 color=; shift ;;
 132         --va|--val|--valg|--valgr|--valgri|--valgrin|--valgrind)
 133                 valgrind=t; verbose=t; shift ;;
 134         --tee)
 135                 shift ;; # was handled already
 136         --root=*)
 137                 root=$(expr "z$1" : 'z[^=]*=\(.*\)')
 138                 shift ;;
 139         *)
 140                 echo "error: unknown test option '$1'" >&2; exit 1 ;;
 141         esac
 142 done
 143
 144 if test -n "$color"; then
 145         say_color () {
 146                 (
 147                 TERM=$ORIGINAL_TERM
 148                 export TERM
 149                 case "$1" in
 150                         error) tput bold; tput setaf 1;; # bold red
 151                         skip)  tput bold; tput setaf 2;; # bold green
 152                         pass)  tput setaf 2;;            # green
 153                         info)  tput setaf 3;;            # brown
 154                         *) test -n "$quiet" && return;;
 155                 esac
 156                 shift
 157                 printf "%s" "$*"
 158                 tput sgr0
 159                 echo
 160                 )
 161         }
 162 else
 163         say_color() {
 164                 test -z "$1" && test -n "$quiet" && return
 165                 shift
 166                 echo "$*"
 167         }
 168 fi
 169
 170 error () {
 171         say_color error "error: $*"
 172         GIT_EXIT_OK=t
 173         exit 1
 174 }
 175
 176 say () {
 177         say_color info "$*"
 178 }
 179
 180 test "${test_description}" != "" ||
 181 error "Test script did not set test_description."
 182
 183 if test "$help" = "t"
 184 then
 185         echo "$test_description"
 186         exit 0
 187 fi
 188
 189 exec 5>&1
 190 if test "$verbose" = "t"
 191 then
 192         exec 4>&2 3>&1
 193 else
 194         exec 4>/dev/null 3>/dev/null
 195 fi
 196
 197 test_failure=0
 198 test_count=0
 199 test_fixed=0
 200 test_broken=0
 201 test_success=0
 202
 203 test_external_has_tap=0
 204
 205 die () {
 206         code=$?
 207         if test -n "$GIT_EXIT_OK"
 208         then
 209                 exit $code
 210         else
 211                 echo >&5 "FATAL: Unexpected exit with code $code"
 212                 exit 1
 213         fi
 214 }
 215
 216 GIT_EXIT_OK=
 217 trap 'die' EXIT
 218
 219 # The semantics of the editor variables are that of invoking
 220 # sh -c "$EDITOR \"$@\"" files ...
 221 #
 222 # If our trash directory contains shell metacharacters, they will be
 223 # interpreted if we just set $EDITOR directly, so do a little dance with
 224 # environment variables to work around this.
 225 #
 226 # In particular, quoting isn't enough, as the path may contain the same quote
 227 # that we're using.
 228 test_set_editor () {
 229         FAKE_EDITOR="$1"
 230         export FAKE_EDITOR
 231         EDITOR='"$FAKE_EDITOR"'
 232         export EDITOR
 233 }
 234
 235 test_decode_color () {
 236         awk '
 237                 function name(n) {
 238                         if (n == 0) return "RESET";
 239                         if (n == 1) return "BOLD";
 240                         if (n == 30) return "BLACK";
 241                         if (n == 31) return "RED";
 242                         if (n == 32) return "GREEN";
 243                         if (n == 33) return "YELLOW";
 244                         if (n == 34) return "BLUE";
 245                         if (n == 35) return "MAGENTA";
 246                         if (n == 36) return "CYAN";
 247                         if (n == 37) return "WHITE";
 248                         if (n == 40) return "BLACK";
 249                         if (n == 41) return "BRED";
 250                         if (n == 42) return "BGREEN";
 251                         if (n == 43) return "BYELLOW";
 252                         if (n == 44) return "BBLUE";
 253                         if (n == 45) return "BMAGENTA";
 254                         if (n == 46) return "BCYAN";
 255                         if (n == 47) return "BWHITE";
 256                 }
 257                 {
 258                         while (match($0, /\033\[[0-9;]*m/) != 0) {
 259                                 printf "%s<", substr($0, 1, RSTART-1);
 260                                 codes = substr($0, RSTART+2, RLENGTH-3);
 261                                 if (length(codes) == 0)
 262                                         printf "%s", name(0)
 263                                 else {
 264                                         n = split(codes, ary, ";");
 265                                         sep = "";
 266                                         for (i = 1; i <= n; i++) {
 267                                                 printf "%s%s", sep, name(ary[i]);
 268                                                 sep = ";"
 269                                         }
 270                                 }
 271                                 printf ">";
 272                                 $0 = substr($0, RSTART + RLENGTH, length($0) - RSTART - RLENGTH + 1);
 273                         }
 274                         print
 275                 }
 276         '
 277 }
 278
 279 nul_to_q () {
 280         perl -pe 'y/\000/Q/'
 281 }
 282
 283 q_to_nul () {
 284         perl -pe 'y/Q/\000/'
 285 }
 286
 287 q_to_cr () {
 288         tr Q '\015'
 289 }
 290
 291 q_to_tab () {
 292         tr Q '\011'
 293 }
 294
 295 append_cr () {
 296         sed -e 's/$/Q/' | tr Q '\015'
 297 }
 298
 299 remove_cr () {
 300         tr '\015' Q | sed -e 's/Q$//'
 301 }
 302
 303 # In some bourne shell implementations, the "unset" builtin returns
 304 # nonzero status when a variable to be unset was not set in the first
 305 # place.
 306 #
 307 # Use sane_unset when that should not be considered an error.
 308
 309 sane_unset () {
 310         unset "$@"
 311         return 0
 312 }
 313
 314 test_tick () {
 315         if test -z "${test_tick+set}"
 316         then
 317                 test_tick=1112911993
 318         else
 319                 test_tick=$(($test_tick + 60))
 320         fi
 321         GIT_COMMITTER_DATE="$test_tick -0700"
 322         GIT_AUTHOR_DATE="$test_tick -0700"
 323         export GIT_COMMITTER_DATE GIT_AUTHOR_DATE
 324 }
 325
 326 # Call test_commit with the arguments "<message> [<file> [<contents>]]"
 327 #
 328 # This will commit a file with the given contents and the given commit
 329 # message.  It will also add a tag with <message> as name.
 330 #
 331 # Both <file> and <contents> default to <message>.
 332
 333 test_commit () {
 334         file=${2:-"$1.t"}
 335         echo "${3-$1}" > "$file" &&
 336         git add "$file" &&
 337         test_tick &&
 338         git commit -m "$1" &&
 339         git tag "$1"
 340 }
 341
 342 # Call test_merge with the arguments "<message> <commit>", where <commit>
 343 # can be a tag pointing to the commit-to-merge.
 344
 345 test_merge () {
 346         test_tick &&
 347         git merge -m "$1" "$2" &&
 348         git tag "$1"
 349 }
 350
 351 # This function helps systems where core.filemode=false is set.
 352 # Use it instead of plain 'chmod +x' to set or unset the executable bit
 353 # of a file in the working directory and add it to the index.
 354
 355 test_chmod () {
 356         chmod "$@" &&
 357         git update-index --add "--chmod=$@"
 358 }
 359
 360 # Use test_set_prereq to tell that a particular prerequisite is available.
 361 # The prerequisite can later be checked for in two ways:
 362 #
 363 # - Explicitly using test_have_prereq.
 364 #
 365 # - Implicitly by specifying the prerequisite tag in the calls to
 366 #   test_expect_{success,failure,code}.
 367 #
 368 # The single parameter is the prerequisite tag (a simple word, in all
 369 # capital letters by convention).
 370
 371 test_set_prereq () {
 372         satisfied="$satisfied$1 "
 373 }
 374 satisfied=" "
 375
 376 test_have_prereq () {
 377         # prerequisites can be concatenated with ','
 378         save_IFS=$IFS
 379         IFS=,
 380         set -- $*
 381         IFS=$save_IFS
 382
 383         total_prereq=0
 384         ok_prereq=0
 385         missing_prereq=
 386
 387         for prerequisite
 388         do
 389                 total_prereq=$(($total_prereq + 1))
 390                 case $satisfied in
 391                 *" $prerequisite "*)
 392                         ok_prereq=$(($ok_prereq + 1))
 393                         ;;
 394                 *)
 395                         # Keep a list of missing prerequisites
 396                         if test -z "$missing_prereq"
 397                         then
 398                                 missing_prereq=$prerequisite
 399                         else
 400                                 missing_prereq="$prerequisite,$missing_prereq"
 401                         fi
 402                 esac
 403         done
 404
 405         test $total_prereq = $ok_prereq
 406 }
 407
 408 test_declared_prereq () {
 409         case ",$test_prereq," in
 410         *,$1,*)
 411                 return 0
 412                 ;;
 413         esac
 414         return 1
 415 }
 416
 417 # You are not expected to call test_ok_ and test_failure_ directly, use
 418 # the text_expect_* functions instead.
 419
 420 test_ok_ () {
 421         test_success=$(($test_success + 1))
 422         say_color "" "ok $test_count - $@"
 423 }
 424
 425 test_failure_ () {
 426         test_failure=$(($test_failure + 1))
 427         say_color error "not ok - $test_count $1"
 428         shift
 429         echo "$@" | sed -e 's/^/#       /'
 430         test "$immediate" = "" || { GIT_EXIT_OK=t; exit 1; }
 431 }
 432
 433 test_known_broken_ok_ () {
 434         test_fixed=$(($test_fixed+1))
 435         say_color "" "ok $test_count - $@ # TODO known breakage"
 436 }
 437
 438 test_known_broken_failure_ () {
 439         test_broken=$(($test_broken+1))
 440         say_color skip "not ok $test_count - $@ # TODO known breakage"
 441 }
 442
 443 test_debug () {
 444         test "$debug" = "" || eval "$1"
 445 }
 446
 447 test_eval_ () {
 448         # This is a separate function because some tests use
 449         # "return" to end a test_expect_success block early.
 450         eval >&3 2>&4 "$*"
 451 }
 452
 453 test_run_ () {
 454         test_cleanup=:
 455         expecting_failure=$2
 456         test_eval_ "$1"
 457         eval_ret=$?
 458
 459         if test -z "$immediate" || test $eval_ret = 0 || test -n "$expecting_failure"
 460         then
 461                 test_eval_ "$test_cleanup"
 462         fi
 463         if test "$verbose" = "t" && test -n "$HARNESS_ACTIVE"; then
 464                 echo ""
 465         fi
 466         return "$eval_ret"
 467 }
 468
 469 test_skip () {
 470         test_count=$(($test_count+1))
 471         to_skip=
 472         for skp in $GIT_SKIP_TESTS
 473         do
 474                 case $this_test.$test_count in
 475                 $skp)
 476                         to_skip=t
 477                         break
 478                 esac
 479         done
 480         if test -z "$to_skip" && test -n "$test_prereq" &&
 481            ! test_have_prereq "$test_prereq"
 482         then
 483                 to_skip=t
 484         fi
 485         case "$to_skip" in
 486         t)
 487                 of_prereq=
 488                 if test "$missing_prereq" != "$test_prereq"
 489                 then
 490                         of_prereq=" of $test_prereq"
 491                 fi
 492
 493                 say_color skip >&3 "skipping test: $@"
 494                 say_color skip "ok $test_count # skip $1 (missing $missing_prereq${of_prereq})"
 495                 : true
 496                 ;;
 497         *)
 498                 false
 499                 ;;
 500         esac
 501 }
 502
 503 test_expect_failure () {
 504         test "$#" = 3 && { test_prereq=$1; shift; } || test_prereq=
 505         test "$#" = 2 ||
 506         error "bug in the test script: not 2 or 3 parameters to test-expect-failure"
 507         export test_prereq
 508         if ! test_skip "$@"
 509         then
 510                 say >&3 "checking known breakage: $2"
 511                 if test_run_ "$2" expecting_failure
 512                 then
 513                         test_known_broken_ok_ "$1"
 514                 else
 515                         test_known_broken_failure_ "$1"
 516                 fi
 517         fi
 518         echo >&3 ""
 519 }
 520
 521 test_expect_success () {
 522         test "$#" = 3 && { test_prereq=$1; shift; } || test_prereq=
 523         test "$#" = 2 ||
 524         error "bug in the test script: not 2 or 3 parameters to test-expect-success"
 525         export test_prereq
 526         if ! test_skip "$@"
 527         then
 528                 say >&3 "expecting success: $2"
 529                 if test_run_ "$2"
 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:-/tmp}
 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                 return 0
 744         fi
 745
 746         echo >&2 "test_expect_code: command exited with $exit_code, we wanted $want_code $*"
 747         return 1
 748 }
 749
 750 # test_cmp is a helper function to compare actual and expected output.
 751 # You can use it like:
 752 #
 753 #       test_expect_success 'foo works' '
 754 #               echo expected >expected &&
 755 #               foo >actual &&
 756 #               test_cmp expected actual
 757 #       '
 758 #
 759 # This could be written as either "cmp" or "diff -u", but:
 760 # - cmp's output is not nearly as easy to read as diff -u
 761 # - not all diff versions understand "-u"
 762
 763 test_cmp() {
 764         $GIT_TEST_CMP "$@"
 765 }
 766
 767 # This function can be used to schedule some commands to be run
 768 # unconditionally at the end of the test to restore sanity:
 769 #
 770 #       test_expect_success 'test core.capslock' '
 771 #               git config core.capslock true &&
 772 #               test_when_finished "git config --unset core.capslock" &&
 773 #               hello world
 774 #       '
 775 #
 776 # That would be roughly equivalent to
 777 #
 778 #       test_expect_success 'test core.capslock' '
 779 #               git config core.capslock true &&
 780 #               hello world
 781 #               git config --unset core.capslock
 782 #       '
 783 #
 784 # except that the greeting and config --unset must both succeed for
 785 # the test to pass.
 786 #
 787 # Note that under --immediate mode, no clean-up is done to help diagnose
 788 # what went wrong.
 789
 790 test_when_finished () {
 791         test_cleanup="{ $*
 792                 } && (exit \"\$eval_ret\"); eval_ret=\$?; $test_cleanup"
 793 }
 794
 795 # Most tests can use the created repository, but some may need to create more.
 796 # Usage: test_create_repo <directory>
 797 test_create_repo () {
 798         test "$#" = 1 ||
 799         error "bug in the test script: not 1 parameter to test-create-repo"
 800         repo="$1"
 801         mkdir -p "$repo"
 802         (
 803                 cd "$repo" || error "Cannot setup test environment"
 804                 "$GIT_EXEC_PATH/git-init" "--template=$GIT_BUILD_DIR/templates/blt/" >&3 2>&4 ||
 805                 error "cannot run git init -- have you built things yet?"
 806                 mv .git/hooks .git/hooks-disabled
 807         ) || exit
 808 }
 809
 810 test_done () {
 811         GIT_EXIT_OK=t
 812
 813         if test -z "$HARNESS_ACTIVE"; then
 814                 test_results_dir="$TEST_DIRECTORY/test-results"
 815                 mkdir -p "$test_results_dir"
 816                 test_results_path="$test_results_dir/${0%.sh}-$$.counts"
 817
 818                 cat >>"$test_results_path" <<-EOF
 819                 total $test_count
 820                 success $test_success
 821                 fixed $test_fixed
 822                 broken $test_broken
 823                 failed $test_failure
 824
 825                 EOF
 826         fi
 827
 828         if test "$test_fixed" != 0
 829         then
 830                 say_color pass "# fixed $test_fixed known breakage(s)"
 831         fi
 832         if test "$test_broken" != 0
 833         then
 834                 say_color error "# still have $test_broken known breakage(s)"
 835                 msg="remaining $(($test_count-$test_broken)) test(s)"
 836         else
 837                 msg="$test_count test(s)"
 838         fi
 839         case "$test_failure" in
 840         0)
 841                 # Maybe print SKIP message
 842                 [ -z "$skip_all" ] || skip_all=" # SKIP $skip_all"
 843
 844                 if test $test_external_has_tap -eq 0; then
 845                         say_color pass "# passed all $msg"
 846                         say "1..$test_count$skip_all"
 847                 fi
 848
 849                 test -d "$remove_trash" &&
 850                 cd "$(dirname "$remove_trash")" &&
 851                 rm -rf "$(basename "$remove_trash")"
 852
 853                 exit 0 ;;
 854
 855         *)
 856                 if test $test_external_has_tap -eq 0; then
 857                         say_color error "# failed $test_failure among $msg"
 858                         say "1..$test_count"
 859                 fi
 860
 861                 exit 1 ;;
 862
 863         esac
 864 }
 865
 866 # Test the binaries we have just built.  The tests are kept in
 867 # t/ subdirectory and are run in 'trash directory' subdirectory.
 868 if test -z "$TEST_DIRECTORY"
 869 then
 870         # We allow tests to override this, in case they want to run tests
 871         # outside of t/, e.g. for running tests on the test library
 872         # itself.
 873         TEST_DIRECTORY=$(pwd)
 874 fi
 875 GIT_BUILD_DIR="$TEST_DIRECTORY"/..
 876
 877 if test -n "$valgrind"
 878 then
 879         make_symlink () {
 880                 test -h "$2" &&
 881                 test "$1" = "$(readlink "$2")" || {
 882                         # be super paranoid
 883                         if mkdir "$2".lock
 884                         then
 885                                 rm -f "$2" &&
 886                                 ln -s "$1" "$2" &&
 887                                 rm -r "$2".lock
 888                         else
 889                                 while test -d "$2".lock
 890                                 do
 891                                         say "Waiting for lock on $2."
 892                                         sleep 1
 893                                 done
 894                         fi
 895                 }
 896         }
 897
 898         make_valgrind_symlink () {
 899                 # handle only executables, unless they are shell libraries that
 900                 # need to be in the exec-path.  We will just use "#!" as a
 901                 # guess for a shell-script, since we have no idea what the user
 902                 # may have configured as the shell path.
 903                 test -x "$1" ||
 904                 test "#!" = "$(head -c 2 <"$1")" ||
 905                 return;
 906
 907                 base=$(basename "$1")
 908                 symlink_target=$GIT_BUILD_DIR/$base
 909                 # do not override scripts
 910                 if test -x "$symlink_target" &&
 911                     test ! -d "$symlink_target" &&
 912                     test "#!" != "$(head -c 2 < "$symlink_target")"
 913                 then
 914                         symlink_target=../valgrind.sh
 915                 fi
 916                 case "$base" in
 917                 *.sh|*.perl)
 918                         symlink_target=../unprocessed-script
 919                 esac
 920                 # create the link, or replace it if it is out of date
 921                 make_symlink "$symlink_target" "$GIT_VALGRIND/bin/$base" || exit
 922         }
 923
 924         # override all git executables in TEST_DIRECTORY/..
 925         GIT_VALGRIND=$TEST_DIRECTORY/valgrind
 926         mkdir -p "$GIT_VALGRIND"/bin
 927         for file in $GIT_BUILD_DIR/git* $GIT_BUILD_DIR/test-*
 928         do
 929                 make_valgrind_symlink $file
 930         done
 931         OLDIFS=$IFS
 932         IFS=:
 933         for path in $PATH
 934         do
 935                 ls "$path"/git-* 2> /dev/null |
 936                 while read file
 937                 do
 938                         make_valgrind_symlink "$file"
 939                 done
 940         done
 941         IFS=$OLDIFS
 942         PATH=$GIT_VALGRIND/bin:$PATH
 943         GIT_EXEC_PATH=$GIT_VALGRIND/bin
 944         export GIT_VALGRIND
 945 elif test -n "$GIT_TEST_INSTALLED" ; then
 946         GIT_EXEC_PATH=$($GIT_TEST_INSTALLED/git --exec-path)  ||
 947         error "Cannot run git from $GIT_TEST_INSTALLED."
 948         PATH=$GIT_TEST_INSTALLED:$GIT_BUILD_DIR:$PATH
 949         GIT_EXEC_PATH=${GIT_TEST_EXEC_PATH:-$GIT_EXEC_PATH}
 950 else # normal case, use ../bin-wrappers only unless $with_dashes:
 951         git_bin_dir="$GIT_BUILD_DIR/bin-wrappers"
 952         if ! test -x "$git_bin_dir/git" ; then
 953                 if test -z "$with_dashes" ; then
 954                         say "$git_bin_dir/git is not executable; using GIT_EXEC_PATH"
 955                 fi
 956                 with_dashes=t
 957         fi
 958         PATH="$git_bin_dir:$PATH"
 959         GIT_EXEC_PATH=$GIT_BUILD_DIR
 960         if test -n "$with_dashes" ; then
 961                 PATH="$GIT_BUILD_DIR:$PATH"
 962         fi
 963 fi
 964 GIT_TEMPLATE_DIR="$GIT_BUILD_DIR"/templates/blt
 965 unset GIT_CONFIG
 966 GIT_CONFIG_NOSYSTEM=1
 967 GIT_ATTR_NOSYSTEM=1
 968 export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG_NOSYSTEM GIT_ATTR_NOSYSTEM
 969
 970 . "$GIT_BUILD_DIR"/GIT-BUILD-OPTIONS
 971
 972 if test -z "$GIT_TEST_CMP"
 973 then
 974         if test -n "$GIT_TEST_CMP_USE_COPIED_CONTEXT"
 975         then
 976                 GIT_TEST_CMP="$DIFF -c"
 977         else
 978                 GIT_TEST_CMP="$DIFF -u"
 979         fi
 980 fi
 981
 982 GITPERLLIB="$GIT_BUILD_DIR"/perl/blib/lib:"$GIT_BUILD_DIR"/perl/blib/arch/auto/Git
 983 export GITPERLLIB
 984 test -d "$GIT_BUILD_DIR"/templates/blt || {
 985         error "You haven't built things yet, have you?"
 986 }
 987
 988 if test -z "$GIT_TEST_INSTALLED" && test -z "$NO_PYTHON"
 989 then
 990         GITPYTHONLIB="$GIT_BUILD_DIR/git_remote_helpers/build/lib"
 991         export GITPYTHONLIB
 992         test -d "$GIT_BUILD_DIR"/git_remote_helpers/build || {
 993                 error "You haven't built git_remote_helpers yet, have you?"
 994         }
 995 fi
 996
 997 if ! test -x "$GIT_BUILD_DIR"/test-chmtime; then
 998         echo >&2 'You need to build test-chmtime:'
 999         echo >&2 'Run "make test-chmtime" in the source (toplevel) directory'
1000         exit 1
1001 fi
1002
1003 # Test repository
1004 test="trash directory.$(basename "$0" .sh)"
1005 test -n "$root" && test="$root/$test"
1006 case "$test" in
1007 /*) TRASH_DIRECTORY="$test" ;;
1008  *) TRASH_DIRECTORY="$TEST_DIRECTORY/$test" ;;
1009 esac
1010 test ! -z "$debug" || remove_trash=$TRASH_DIRECTORY
1011 rm -fr "$test" || {
1012         GIT_EXIT_OK=t
1013         echo >&5 "FATAL: Cannot prepare test area"
1014         exit 1
1015 }
1016
1017 HOME="$TRASH_DIRECTORY"
1018 export HOME
1019
1020 test_create_repo "$test"
1021 # Use -P to resolve symlinks in our working directory so that the cwd
1022 # in subprocesses like git equals our $PWD (for pathname comparisons).
1023 cd -P "$test" || exit 1
1024
1025 this_test=${0##*/}
1026 this_test=${this_test%%-*}
1027 for skp in $GIT_SKIP_TESTS
1028 do
1029         case "$this_test" in
1030         $skp)
1031                 say_color skip >&3 "skipping test $this_test altogether"
1032                 skip_all="skip all tests in $this_test"
1033                 test_done
1034         esac
1035 done
1036
1037 # Provide an implementation of the 'yes' utility
1038 yes () {
1039         if test $# = 0
1040         then
1041                 y=y
1042         else
1043                 y="$*"
1044         fi
1045
1046         while echo "$y"
1047         do
1048                 :
1049         done
1050 }
1051
1052 # Fix some commands on Windows
1053 case $(uname -s) in
1054 *MINGW*)
1055         # Windows has its own (incompatible) sort and find
1056         sort () {
1057                 /usr/bin/sort "$@"
1058         }
1059         find () {
1060                 /usr/bin/find "$@"
1061         }
1062         sum () {
1063                 md5sum "$@"
1064         }
1065         # git sees Windows-style pwd
1066         pwd () {
1067                 builtin pwd -W
1068         }
1069         # no POSIX permissions
1070         # backslashes in pathspec are converted to '/'
1071         # exec does not inherit the PID
1072         test_set_prereq MINGW
1073         test_set_prereq SED_STRIPS_CR
1074         ;;
1075 *CYGWIN*)
1076         test_set_prereq POSIXPERM
1077         test_set_prereq EXECKEEPSPID
1078         test_set_prereq NOT_MINGW
1079         test_set_prereq SED_STRIPS_CR
1080         ;;
1081 *)
1082         test_set_prereq POSIXPERM
1083         test_set_prereq BSLASHPSPEC
1084         test_set_prereq EXECKEEPSPID
1085         test_set_prereq NOT_MINGW
1086         ;;
1087 esac
1088
1089 test -z "$NO_PERL" && test_set_prereq PERL
1090 test -z "$NO_PYTHON" && test_set_prereq PYTHON
1091 test -n "$USE_LIBPCRE" && test_set_prereq LIBPCRE
1092
1093 # Can we rely on git's output in the C locale?
1094 if test -n "$GETTEXT_POISON"
1095 then
1096         GIT_GETTEXT_POISON=YesPlease
1097         export GIT_GETTEXT_POISON
1098 else
1099         test_set_prereq C_LOCALE_OUTPUT
1100 fi
1101
1102 # Use this instead of test_cmp to compare files that contain expected and
1103 # actual output from git commands that can be translated.  When running
1104 # under GETTEXT_POISON this pretends that the command produced expected
1105 # results.
1106 test_i18ncmp () {
1107         test -n "$GETTEXT_POISON" || test_cmp "$@"
1108 }
1109
1110 # Use this instead of "grep expected-string actual" to see if the
1111 # output from a git command that can be translated either contains an
1112 # expected string, or does not contain an unwanted one.  When running
1113 # under GETTEXT_POISON this pretends that the command produced expected
1114 # results.
1115 test_i18ngrep () {
1116         if test -n "$GETTEXT_POISON"
1117         then
1118             : # pretend success
1119         elif test "x!" = "x$1"
1120         then
1121                 shift
1122                 ! grep "$@"
1123         else
1124                 grep "$@"
1125         fi
1126 }
1127
1128 # test whether the filesystem supports symbolic links
1129 ln -s x y 2>/dev/null && test -h y 2>/dev/null && test_set_prereq SYMLINKS
1130 rm -f y
1131
1132 # When the tests are run as root, permission tests will report that
1133 # things are writable when they shouldn't be.
1134 test -w / || test_set_prereq SANITY