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