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