t/test-lib.sh

   1 # Test framework for git.  See t/README for usage.
   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 # Test the binaries we have just built.  The tests are kept in
  19 # t/ subdirectory and are run in 'trash directory' subdirectory.
  20 if test -z "$TEST_DIRECTORY"
  21 then
  22         # We allow tests to override this, in case they want to run tests
  23         # outside of t/, e.g. for running tests on the test library
  24         # itself.
  25         TEST_DIRECTORY=$(pwd)
  26 else
  27         # ensure that TEST_DIRECTORY is an absolute path so that it
  28         # is valid even if the current working directory is changed
  29         TEST_DIRECTORY=$(cd "$TEST_DIRECTORY" && pwd) || exit 1
  30 fi
  31 if test -z "$TEST_OUTPUT_DIRECTORY"
  32 then
  33         # Similarly, override this to store the test-results subdir
  34         # elsewhere
  35         TEST_OUTPUT_DIRECTORY=$TEST_DIRECTORY
  36 fi
  37 GIT_BUILD_DIR="$TEST_DIRECTORY"/..
  38
  39 ################################################################
  40 # It appears that people try to run tests without building...
  41 "$GIT_BUILD_DIR/git" >/dev/null
  42 if test $? != 1
  43 then
  44         echo >&2 'error: you do not seem to have built git yet.'
  45         exit 1
  46 fi
  47
  48 . "$GIT_BUILD_DIR"/GIT-BUILD-OPTIONS
  49 export PERL_PATH SHELL_PATH
  50
  51 # if --tee was passed, write the output not only to the terminal, but
  52 # additionally to the file test-results/$BASENAME.out, too.
  53 case "$GIT_TEST_TEE_STARTED, $* " in
  54 done,*)
  55         # do not redirect again
  56         ;;
  57 *' --tee '*|*' --va'*|*' --verbose-log '*)
  58         mkdir -p "$TEST_OUTPUT_DIRECTORY/test-results"
  59         BASE="$TEST_OUTPUT_DIRECTORY/test-results/$(basename "$0" .sh)"
  60
  61         # Make this filename available to the sub-process in case it is using
  62         # --verbose-log.
  63         GIT_TEST_TEE_OUTPUT_FILE=$BASE.out
  64         export GIT_TEST_TEE_OUTPUT_FILE
  65
  66         # Truncate before calling "tee -a" to get rid of the results
  67         # from any previous runs.
  68         >"$GIT_TEST_TEE_OUTPUT_FILE"
  69
  70         (GIT_TEST_TEE_STARTED=done ${SHELL_PATH} "$0" "$@" 2>&1;
  71          echo $? >"$BASE.exit") | tee -a "$GIT_TEST_TEE_OUTPUT_FILE"
  72         test "$(cat "$BASE.exit")" = 0
  73         exit
  74         ;;
  75 esac
  76
  77 # For repeatability, reset the environment to known value.
  78 # TERM is sanitized below, after saving color control sequences.
  79 LANG=C
  80 LC_ALL=C
  81 PAGER=cat
  82 TZ=UTC
  83 export LANG LC_ALL PAGER TZ
  84 EDITOR=:
  85 # A call to "unset" with no arguments causes at least Solaris 10
  86 # /usr/xpg4/bin/sh and /bin/ksh to bail out.  So keep the unsets
  87 # deriving from the command substitution clustered with the other
  88 # ones.
  89 unset VISUAL EMAIL LANGUAGE COLUMNS $("$PERL_PATH" -e '
  90         my @env = keys %ENV;
  91         my $ok = join("|", qw(
  92                 TRACE
  93                 DEBUG
  94                 USE_LOOKUP
  95                 TEST
  96                 .*_TEST
  97                 PROVE
  98                 VALGRIND
  99                 UNZIP
 100                 PERF_
 101                 CURL_VERBOSE
 102         ));
 103         my @vars = grep(/^GIT_/ && !/^GIT_($ok)/o, @env);
 104         print join("\n", @vars);
 105 ')
 106 unset XDG_CONFIG_HOME
 107 unset GITPERLLIB
 108 GIT_AUTHOR_EMAIL=author@example.com
 109 GIT_AUTHOR_NAME='A U Thor'
 110 GIT_COMMITTER_EMAIL=committer@example.com
 111 GIT_COMMITTER_NAME='C O Mitter'
 112 GIT_MERGE_VERBOSITY=5
 113 GIT_MERGE_AUTOEDIT=no
 114 export GIT_MERGE_VERBOSITY GIT_MERGE_AUTOEDIT
 115 export GIT_AUTHOR_EMAIL GIT_AUTHOR_NAME
 116 export GIT_COMMITTER_EMAIL GIT_COMMITTER_NAME
 117 export EDITOR
 118
 119 # Tests using GIT_TRACE typically don't want <timestamp> <file>:<line> output
 120 GIT_TRACE_BARE=1
 121 export GIT_TRACE_BARE
 122
 123 if test -n "${TEST_GIT_INDEX_VERSION:+isset}"
 124 then
 125         GIT_INDEX_VERSION="$TEST_GIT_INDEX_VERSION"
 126         export GIT_INDEX_VERSION
 127 fi
 128
 129 # Add libc MALLOC and MALLOC_PERTURB test
 130 # only if we are not executing the test with valgrind
 131 if expr " $GIT_TEST_OPTS " : ".* --valgrind " >/dev/null ||
 132    test -n "$TEST_NO_MALLOC_CHECK"
 133 then
 134         setup_malloc_check () {
 135                 : nothing
 136         }
 137         teardown_malloc_check () {
 138                 : nothing
 139         }
 140 else
 141         setup_malloc_check () {
 142                 MALLOC_CHECK_=3 MALLOC_PERTURB_=165
 143                 export MALLOC_CHECK_ MALLOC_PERTURB_
 144         }
 145         teardown_malloc_check () {
 146                 unset MALLOC_CHECK_ MALLOC_PERTURB_
 147         }
 148 fi
 149
 150 : ${ASAN_OPTIONS=detect_leaks=0}
 151 export ASAN_OPTIONS
 152
 153 # Protect ourselves from common misconfiguration to export
 154 # CDPATH into the environment
 155 unset CDPATH
 156
 157 unset GREP_OPTIONS
 158 unset UNZIP
 159
 160 case $(echo $GIT_TRACE |tr "[A-Z]" "[a-z]") in
 161 1|2|true)
 162         GIT_TRACE=4
 163         ;;
 164 esac
 165
 166 # Convenience
 167 #
 168 # A regexp to match 5 and 40 hexdigits
 169 _x05='[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
 170 _x40="$_x05$_x05$_x05$_x05$_x05$_x05$_x05$_x05"
 171
 172 # Zero SHA-1
 173 _z40=0000000000000000000000000000000000000000
 174
 175 # Line feed
 176 LF='
 177 '
 178
 179 # UTF-8 ZERO WIDTH NON-JOINER, which HFS+ ignores
 180 # when case-folding filenames
 181 u200c=$(printf '\342\200\214')
 182
 183 export _x05 _x40 _z40 LF u200c
 184
 185 # Each test should start with something like this, after copyright notices:
 186 #
 187 # test_description='Description of this test...
 188 # This test checks if command xyzzy does the right thing...
 189 # '
 190 # . ./test-lib.sh
 191 test "x$TERM" != "xdumb" && (
 192                 test -t 1 &&
 193                 tput bold >/dev/null 2>&1 &&
 194                 tput setaf 1 >/dev/null 2>&1 &&
 195                 tput sgr0 >/dev/null 2>&1
 196         ) &&
 197         color=t
 198
 199 while test "$#" -ne 0
 200 do
 201         case "$1" in
 202         -d|--d|--de|--deb|--debu|--debug)
 203                 debug=t; shift ;;
 204         -i|--i|--im|--imm|--imme|--immed|--immedi|--immedia|--immediat|--immediate)
 205                 immediate=t; shift ;;
 206         -l|--l|--lo|--lon|--long|--long-|--long-t|--long-te|--long-tes|--long-test|--long-tests)
 207                 GIT_TEST_LONG=t; export GIT_TEST_LONG; shift ;;
 208         -r)
 209                 shift; test "$#" -ne 0 || {
 210                         echo 'error: -r requires an argument' >&2;
 211                         exit 1;
 212                 }
 213                 run_list=$1; shift ;;
 214         --run=*)
 215                 run_list=${1#--*=}; shift ;;
 216         -h|--h|--he|--hel|--help)
 217                 help=t; shift ;;
 218         -v|--v|--ve|--ver|--verb|--verbo|--verbos|--verbose)
 219                 verbose=t; shift ;;
 220         --verbose-only=*)
 221                 verbose_only=${1#--*=}
 222                 shift ;;
 223         -q|--q|--qu|--qui|--quie|--quiet)
 224                 # Ignore --quiet under a TAP::Harness. Saying how many tests
 225                 # passed without the ok/not ok details is always an error.
 226                 test -z "$HARNESS_ACTIVE" && quiet=t; shift ;;
 227         --with-dashes)
 228                 with_dashes=t; shift ;;
 229         --no-color)
 230                 color=; shift ;;
 231         --va|--val|--valg|--valgr|--valgri|--valgrin|--valgrind)
 232                 valgrind=memcheck
 233                 shift ;;
 234         --valgrind=*)
 235                 valgrind=${1#--*=}
 236                 shift ;;
 237         --valgrind-only=*)
 238                 valgrind_only=${1#--*=}
 239                 shift ;;
 240         --tee)
 241                 shift ;; # was handled already
 242         --root=*)
 243                 root=${1#--*=}
 244                 shift ;;
 245         --chain-lint)
 246                 GIT_TEST_CHAIN_LINT=1
 247                 shift ;;
 248         --no-chain-lint)
 249                 GIT_TEST_CHAIN_LINT=0
 250                 shift ;;
 251         -x)
 252                 trace=t
 253                 verbose=t
 254                 shift ;;
 255         --verbose-log)
 256                 verbose_log=t
 257                 shift ;;
 258         *)
 259                 echo "error: unknown test option '$1'" >&2; exit 1 ;;
 260         esac
 261 done
 262
 263 if test -n "$valgrind_only"
 264 then
 265         test -z "$valgrind" && valgrind=memcheck
 266         test -z "$verbose" && verbose_only="$valgrind_only"
 267 elif test -n "$valgrind"
 268 then
 269         verbose=t
 270 fi
 271
 272 if test -n "$color"
 273 then
 274         # Save the color control sequences now rather than run tput
 275         # each time say_color() is called.  This is done for two
 276         # reasons:
 277         #   * TERM will be changed to dumb
 278         #   * HOME will be changed to a temporary directory and tput
 279         #     might need to read ~/.terminfo from the original HOME
 280         #     directory to get the control sequences
 281         # Note:  This approach assumes the control sequences don't end
 282         # in a newline for any terminal of interest (command
 283         # substitutions strip trailing newlines).  Given that most
 284         # (all?) terminals in common use are related to ECMA-48, this
 285         # shouldn't be a problem.
 286         say_color_error=$(tput bold; tput setaf 1) # bold red
 287         say_color_skip=$(tput setaf 4) # blue
 288         say_color_warn=$(tput setaf 3) # brown/yellow
 289         say_color_pass=$(tput setaf 2) # green
 290         say_color_info=$(tput setaf 6) # cyan
 291         say_color_reset=$(tput sgr0)
 292         say_color_="" # no formatting for normal text
 293         say_color () {
 294                 test -z "$1" && test -n "$quiet" && return
 295                 eval "say_color_color=\$say_color_$1"
 296                 shift
 297                 printf "%s\\n" "$say_color_color$*$say_color_reset"
 298         }
 299 else
 300         say_color() {
 301                 test -z "$1" && test -n "$quiet" && return
 302                 shift
 303                 printf "%s\n" "$*"
 304         }
 305 fi
 306
 307 TERM=dumb
 308 export TERM
 309
 310 error () {
 311         say_color error "error: $*"
 312         GIT_EXIT_OK=t
 313         exit 1
 314 }
 315
 316 say () {
 317         say_color info "$*"
 318 }
 319
 320 if test -n "$HARNESS_ACTIVE"
 321 then
 322         if test "$verbose" = t || test -n "$verbose_only"
 323         then
 324                 printf 'Bail out! %s\n' \
 325                  'verbose mode forbidden under TAP harness; try --verbose-log'
 326                 exit 1
 327         fi
 328 fi
 329
 330 test "${test_description}" != "" ||
 331 error "Test script did not set test_description."
 332
 333 if test "$help" = "t"
 334 then
 335         printf '%s\n' "$test_description"
 336         exit 0
 337 fi
 338
 339 exec 5>&1
 340 exec 6<&0
 341 if test "$verbose_log" = "t"
 342 then
 343         exec 3>>"$GIT_TEST_TEE_OUTPUT_FILE" 4>&3
 344 elif test "$verbose" = "t"
 345 then
 346         exec 4>&2 3>&1
 347 else
 348         exec 4>/dev/null 3>/dev/null
 349 fi
 350
 351 # Send any "-x" output directly to stderr to avoid polluting tests
 352 # which capture stderr. We can do this unconditionally since it
 353 # has no effect if tracing isn't turned on.
 354 #
 355 # Note that this sets up the trace fd as soon as we assign the variable, so it
 356 # must come after the creation of descriptor 4 above. Likewise, we must never
 357 # unset this, as it has the side effect of closing descriptor 4, which we
 358 # use to show verbose tests to the user.
 359 #
 360 # Note also that we don't need or want to export it. The tracing is local to
 361 # this shell, and we would not want to influence any shells we exec.
 362 BASH_XTRACEFD=4
 363
 364 test_failure=0
 365 test_count=0
 366 test_fixed=0
 367 test_broken=0
 368 test_success=0
 369
 370 test_external_has_tap=0
 371
 372 die () {
 373         code=$?
 374         if test -n "$GIT_EXIT_OK"
 375         then
 376                 exit $code
 377         else
 378                 echo >&5 "FATAL: Unexpected exit with code $code"
 379                 exit 1
 380         fi
 381 }
 382
 383 GIT_EXIT_OK=
 384 trap 'die' EXIT
 385 trap 'exit $?' INT
 386
 387 # The user-facing functions are loaded from a separate file so that
 388 # test_perf subshells can have them too
 389 . "$TEST_DIRECTORY/test-lib-functions.sh"
 390
 391 # You are not expected to call test_ok_ and test_failure_ directly, use
 392 # the test_expect_* functions instead.
 393
 394 test_ok_ () {
 395         test_success=$(($test_success + 1))
 396         say_color "" "ok $test_count - $@"
 397 }
 398
 399 test_failure_ () {
 400         test_failure=$(($test_failure + 1))
 401         say_color error "not ok $test_count - $1"
 402         shift
 403         printf '%s\n' "$*" | sed -e 's/^/#      /'
 404         test "$immediate" = "" || { GIT_EXIT_OK=t; exit 1; }
 405 }
 406
 407 test_known_broken_ok_ () {
 408         test_fixed=$(($test_fixed+1))
 409         say_color error "ok $test_count - $@ # TODO known breakage vanished"
 410 }
 411
 412 test_known_broken_failure_ () {
 413         test_broken=$(($test_broken+1))
 414         say_color warn "not ok $test_count - $@ # TODO known breakage"
 415 }
 416
 417 test_debug () {
 418         test "$debug" = "" || eval "$1"
 419 }
 420
 421 match_pattern_list () {
 422         arg="$1"
 423         shift
 424         test -z "$*" && return 1
 425         for pattern_
 426         do
 427                 case "$arg" in
 428                 $pattern_)
 429                         return 0
 430                 esac
 431         done
 432         return 1
 433 }
 434
 435 match_test_selector_list () {
 436         title="$1"
 437         shift
 438         arg="$1"
 439         shift
 440         test -z "$1" && return 0
 441
 442         # Both commas and whitespace are accepted as separators.
 443         OLDIFS=$IFS
 444         IFS='   ,'
 445         set -- $1
 446         IFS=$OLDIFS
 447
 448         # If the first selector is negative we include by default.
 449         include=
 450         case "$1" in
 451                 !*) include=t ;;
 452         esac
 453
 454         for selector
 455         do
 456                 orig_selector=$selector
 457
 458                 positive=t
 459                 case "$selector" in
 460                         !*)
 461                                 positive=
 462                                 selector=${selector##?}
 463                                 ;;
 464                 esac
 465
 466                 test -z "$selector" && continue
 467
 468                 case "$selector" in
 469                         *-*)
 470                                 if expr "z${selector%%-*}" : "z[0-9]*[^0-9]" >/dev/null
 471                                 then
 472                                         echo "error: $title: invalid non-numeric in range" \
 473                                                 "start: '$orig_selector'" >&2
 474                                         exit 1
 475                                 fi
 476                                 if expr "z${selector#*-}" : "z[0-9]*[^0-9]" >/dev/null
 477                                 then
 478                                         echo "error: $title: invalid non-numeric in range" \
 479                                                 "end: '$orig_selector'" >&2
 480                                         exit 1
 481                                 fi
 482                                 ;;
 483                         *)
 484                                 if expr "z$selector" : "z[0-9]*[^0-9]" >/dev/null
 485                                 then
 486                                         echo "error: $title: invalid non-numeric in test" \
 487                                                 "selector: '$orig_selector'" >&2
 488                                         exit 1
 489                                 fi
 490                 esac
 491
 492                 # Short cut for "obvious" cases
 493                 test -z "$include" && test -z "$positive" && continue
 494                 test -n "$include" && test -n "$positive" && continue
 495
 496                 case "$selector" in
 497                         -*)
 498                                 if test $arg -le ${selector#-}
 499                                 then
 500                                         include=$positive
 501                                 fi
 502                                 ;;
 503                         *-)
 504                                 if test $arg -ge ${selector%-}
 505                                 then
 506                                         include=$positive
 507                                 fi
 508                                 ;;
 509                         *-*)
 510                                 if test ${selector%%-*} -le $arg \
 511                                         && test $arg -le ${selector#*-}
 512                                 then
 513                                         include=$positive
 514                                 fi
 515                                 ;;
 516                         *)
 517                                 if test $arg -eq $selector
 518                                 then
 519                                         include=$positive
 520                                 fi
 521                                 ;;
 522                 esac
 523         done
 524
 525         test -n "$include"
 526 }
 527
 528 maybe_teardown_verbose () {
 529         test -z "$verbose_only" && return
 530         exec 4>/dev/null 3>/dev/null
 531         verbose=
 532 }
 533
 534 last_verbose=t
 535 maybe_setup_verbose () {
 536         test -z "$verbose_only" && return
 537         if match_pattern_list $test_count $verbose_only
 538         then
 539                 exec 4>&2 3>&1
 540                 # Emit a delimiting blank line when going from
 541                 # non-verbose to verbose.  Within verbose mode the
 542                 # delimiter is printed by test_expect_*.  The choice
 543                 # of the initial $last_verbose is such that before
 544                 # test 1, we do not print it.
 545                 test -z "$last_verbose" && echo >&3 ""
 546                 verbose=t
 547         else
 548                 exec 4>/dev/null 3>/dev/null
 549                 verbose=
 550         fi
 551         last_verbose=$verbose
 552 }
 553
 554 maybe_teardown_valgrind () {
 555         test -z "$GIT_VALGRIND" && return
 556         GIT_VALGRIND_ENABLED=
 557 }
 558
 559 maybe_setup_valgrind () {
 560         test -z "$GIT_VALGRIND" && return
 561         if test -z "$valgrind_only"
 562         then
 563                 GIT_VALGRIND_ENABLED=t
 564                 return
 565         fi
 566         GIT_VALGRIND_ENABLED=
 567         if match_pattern_list $test_count $valgrind_only
 568         then
 569                 GIT_VALGRIND_ENABLED=t
 570         fi
 571 }
 572
 573 want_trace () {
 574         test "$trace" = t && test "$verbose" = t
 575 }
 576
 577 # This is a separate function because some tests use
 578 # "return" to end a test_expect_success block early
 579 # (and we want to make sure we run any cleanup like
 580 # "set +x").
 581 test_eval_inner_ () {
 582         # Do not add anything extra (including LF) after '$*'
 583         eval "
 584                 want_trace && set -x
 585                 $*"
 586 }
 587
 588 test_eval_ () {
 589         # We run this block with stderr redirected to avoid extra cruft
 590         # during a "-x" trace. Once in "set -x" mode, we cannot prevent
 591         # the shell from printing the "set +x" to turn it off (nor the saving
 592         # of $? before that). But we can make sure that the output goes to
 593         # /dev/null.
 594         #
 595         # The test itself is run with stderr put back to &4 (so either to
 596         # /dev/null, or to the original stderr if --verbose was used).
 597         {
 598                 test_eval_inner_ "$@" </dev/null >&3 2>&4
 599                 test_eval_ret_=$?
 600                 if want_trace
 601                 then
 602                         set +x
 603                         if test "$test_eval_ret_" != 0
 604                         then
 605                                 say_color error >&4 "error: last command exited with \$?=$test_eval_ret_"
 606                         fi
 607                 fi
 608         } 2>/dev/null
 609         return $test_eval_ret_
 610 }
 611
 612 test_run_ () {
 613         test_cleanup=:
 614         expecting_failure=$2
 615
 616         if test "${GIT_TEST_CHAIN_LINT:-1}" != 0; then
 617                 # turn off tracing for this test-eval, as it simply creates
 618                 # confusing noise in the "-x" output
 619                 trace_tmp=$trace
 620                 trace=
 621                 # 117 is magic because it is unlikely to match the exit
 622                 # code of other programs
 623                 test_eval_ "(exit 117) && $1"
 624                 if test "$?" != 117; then
 625                         error "bug in the test script: broken &&-chain: $1"
 626                 fi
 627                 trace=$trace_tmp
 628         fi
 629
 630         setup_malloc_check
 631         test_eval_ "$1"
 632         eval_ret=$?
 633         teardown_malloc_check
 634
 635         if test -z "$immediate" || test $eval_ret = 0 ||
 636            test -n "$expecting_failure" && test "$test_cleanup" != ":"
 637         then
 638                 setup_malloc_check
 639                 test_eval_ "$test_cleanup"
 640                 teardown_malloc_check
 641         fi
 642         if test "$verbose" = "t" && test -n "$HARNESS_ACTIVE"
 643         then
 644                 echo ""
 645         fi
 646         return "$eval_ret"
 647 }
 648
 649 test_start_ () {
 650         test_count=$(($test_count+1))
 651         maybe_setup_verbose
 652         maybe_setup_valgrind
 653 }
 654
 655 test_finish_ () {
 656         echo >&3 ""
 657         maybe_teardown_valgrind
 658         maybe_teardown_verbose
 659 }
 660
 661 test_skip () {
 662         to_skip=
 663         skipped_reason=
 664         if match_pattern_list $this_test.$test_count $GIT_SKIP_TESTS
 665         then
 666                 to_skip=t
 667                 skipped_reason="GIT_SKIP_TESTS"
 668         fi
 669         if test -z "$to_skip" && test -n "$test_prereq" &&
 670            ! test_have_prereq "$test_prereq"
 671         then
 672                 to_skip=t
 673
 674                 of_prereq=
 675                 if test "$missing_prereq" != "$test_prereq"
 676                 then
 677                         of_prereq=" of $test_prereq"
 678                 fi
 679                 skipped_reason="missing $missing_prereq${of_prereq}"
 680         fi
 681         if test -z "$to_skip" && test -n "$run_list" &&
 682                 ! match_test_selector_list '--run' $test_count "$run_list"
 683         then
 684                 to_skip=t
 685                 skipped_reason="--run"
 686         fi
 687
 688         case "$to_skip" in
 689         t)
 690                 say_color skip >&3 "skipping test: $@"
 691                 say_color skip "ok $test_count # skip $1 ($skipped_reason)"
 692                 : true
 693                 ;;
 694         *)
 695                 false
 696                 ;;
 697         esac
 698 }
 699
 700 # stub; perf-lib overrides it
 701 test_at_end_hook_ () {
 702         :
 703 }
 704
 705 test_done () {
 706         GIT_EXIT_OK=t
 707
 708         if test -z "$HARNESS_ACTIVE"
 709         then
 710                 test_results_dir="$TEST_OUTPUT_DIRECTORY/test-results"
 711                 mkdir -p "$test_results_dir"
 712                 base=${0##*/}
 713                 test_results_path="$test_results_dir/${base%.sh}-$$.counts"
 714
 715                 cat >>"$test_results_path" <<-EOF
 716                 total $test_count
 717                 success $test_success
 718                 fixed $test_fixed
 719                 broken $test_broken
 720                 failed $test_failure
 721
 722                 EOF
 723         fi
 724
 725         if test "$test_fixed" != 0
 726         then
 727                 say_color error "# $test_fixed known breakage(s) vanished; please update test(s)"
 728         fi
 729         if test "$test_broken" != 0
 730         then
 731                 say_color warn "# still have $test_broken known breakage(s)"
 732         fi
 733         if test "$test_broken" != 0 || test "$test_fixed" != 0
 734         then
 735                 test_remaining=$(( $test_count - $test_broken - $test_fixed ))
 736                 msg="remaining $test_remaining test(s)"
 737         else
 738                 test_remaining=$test_count
 739                 msg="$test_count test(s)"
 740         fi
 741         case "$test_failure" in
 742         0)
 743                 # Maybe print SKIP message
 744                 if test -n "$skip_all" && test $test_count -gt 0
 745                 then
 746                         error "Can't use skip_all after running some tests"
 747                 fi
 748                 test -z "$skip_all" || skip_all=" # SKIP $skip_all"
 749
 750                 if test $test_external_has_tap -eq 0
 751                 then
 752                         if test $test_remaining -gt 0
 753                         then
 754                                 say_color pass "# passed all $msg"
 755                         fi
 756                         say "1..$test_count$skip_all"
 757                 fi
 758
 759                 test -d "$remove_trash" &&
 760                 cd "$(dirname "$remove_trash")" &&
 761                 rm -rf "$(basename "$remove_trash")"
 762
 763                 test_at_end_hook_
 764
 765                 exit 0 ;;
 766
 767         *)
 768                 if test $test_external_has_tap -eq 0
 769                 then
 770                         say_color error "# failed $test_failure among $msg"
 771                         say "1..$test_count"
 772                 fi
 773
 774                 exit 1 ;;
 775
 776         esac
 777 }
 778
 779 if test -n "$valgrind"
 780 then
 781         make_symlink () {
 782                 test -h "$2" &&
 783                 test "$1" = "$(readlink "$2")" || {
 784                         # be super paranoid
 785                         if mkdir "$2".lock
 786                         then
 787                                 rm -f "$2" &&
 788                                 ln -s "$1" "$2" &&
 789                                 rm -r "$2".lock
 790                         else
 791                                 while test -d "$2".lock
 792                                 do
 793                                         say "Waiting for lock on $2."
 794                                         sleep 1
 795                                 done
 796                         fi
 797                 }
 798         }
 799
 800         make_valgrind_symlink () {
 801                 # handle only executables, unless they are shell libraries that
 802                 # need to be in the exec-path.
 803                 test -x "$1" ||
 804                 test "# " = "$(head -c 2 <"$1")" ||
 805                 return;
 806
 807                 base=$(basename "$1")
 808                 symlink_target=$GIT_BUILD_DIR/$base
 809                 # do not override scripts
 810                 if test -x "$symlink_target" &&
 811                     test ! -d "$symlink_target" &&
 812                     test "#!" != "$(head -c 2 < "$symlink_target")"
 813                 then
 814                         symlink_target=../valgrind.sh
 815                 fi
 816                 case "$base" in
 817                 *.sh|*.perl)
 818                         symlink_target=../unprocessed-script
 819                 esac
 820                 # create the link, or replace it if it is out of date
 821                 make_symlink "$symlink_target" "$GIT_VALGRIND/bin/$base" || exit
 822         }
 823
 824         # override all git executables in TEST_DIRECTORY/..
 825         GIT_VALGRIND=$TEST_DIRECTORY/valgrind
 826         mkdir -p "$GIT_VALGRIND"/bin
 827         for file in $GIT_BUILD_DIR/git* $GIT_BUILD_DIR/test-*
 828         do
 829                 make_valgrind_symlink $file
 830         done
 831         # special-case the mergetools loadables
 832         make_symlink "$GIT_BUILD_DIR"/mergetools "$GIT_VALGRIND/bin/mergetools"
 833         OLDIFS=$IFS
 834         IFS=:
 835         for path in $PATH
 836         do
 837                 ls "$path"/git-* 2> /dev/null |
 838                 while read file
 839                 do
 840                         make_valgrind_symlink "$file"
 841                 done
 842         done
 843         IFS=$OLDIFS
 844         PATH=$GIT_VALGRIND/bin:$PATH
 845         GIT_EXEC_PATH=$GIT_VALGRIND/bin
 846         export GIT_VALGRIND
 847         GIT_VALGRIND_MODE="$valgrind"
 848         export GIT_VALGRIND_MODE
 849         GIT_VALGRIND_ENABLED=t
 850         test -n "$valgrind_only" && GIT_VALGRIND_ENABLED=
 851         export GIT_VALGRIND_ENABLED
 852 elif test -n "$GIT_TEST_INSTALLED"
 853 then
 854         GIT_EXEC_PATH=$($GIT_TEST_INSTALLED/git --exec-path)  ||
 855         error "Cannot run git from $GIT_TEST_INSTALLED."
 856         PATH=$GIT_TEST_INSTALLED:$GIT_BUILD_DIR:$PATH
 857         GIT_EXEC_PATH=${GIT_TEST_EXEC_PATH:-$GIT_EXEC_PATH}
 858 else # normal case, use ../bin-wrappers only unless $with_dashes:
 859         git_bin_dir="$GIT_BUILD_DIR/bin-wrappers"
 860         if ! test -x "$git_bin_dir/git"
 861         then
 862                 if test -z "$with_dashes"
 863                 then
 864                         say "$git_bin_dir/git is not executable; using GIT_EXEC_PATH"
 865                 fi
 866                 with_dashes=t
 867         fi
 868         PATH="$git_bin_dir:$PATH"
 869         GIT_EXEC_PATH=$GIT_BUILD_DIR
 870         if test -n "$with_dashes"
 871         then
 872                 PATH="$GIT_BUILD_DIR:$PATH"
 873         fi
 874 fi
 875 GIT_TEMPLATE_DIR="$GIT_BUILD_DIR"/templates/blt
 876 GIT_CONFIG_NOSYSTEM=1
 877 GIT_ATTR_NOSYSTEM=1
 878 export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG_NOSYSTEM GIT_ATTR_NOSYSTEM
 879
 880 if test -z "$GIT_TEST_CMP"
 881 then
 882         if test -n "$GIT_TEST_CMP_USE_COPIED_CONTEXT"
 883         then
 884                 GIT_TEST_CMP="$DIFF -c"
 885         else
 886                 GIT_TEST_CMP="$DIFF -u"
 887         fi
 888 fi
 889
 890 GITPERLLIB="$GIT_BUILD_DIR"/perl/blib/lib:"$GIT_BUILD_DIR"/perl/blib/arch/auto/Git
 891 export GITPERLLIB
 892 test -d "$GIT_BUILD_DIR"/templates/blt || {
 893         error "You haven't built things yet, have you?"
 894 }
 895
 896 if ! test -x "$GIT_BUILD_DIR"/test-chmtime
 897 then
 898         echo >&2 'You need to build test-chmtime:'
 899         echo >&2 'Run "make test-chmtime" in the source (toplevel) directory'
 900         exit 1
 901 fi
 902
 903 # Test repository
 904 TRASH_DIRECTORY="trash directory.$(basename "$0" .sh)"
 905 test -n "$root" && TRASH_DIRECTORY="$root/$TRASH_DIRECTORY"
 906 case "$TRASH_DIRECTORY" in
 907 /*) ;; # absolute path is good
 908  *) TRASH_DIRECTORY="$TEST_OUTPUT_DIRECTORY/$TRASH_DIRECTORY" ;;
 909 esac
 910 test ! -z "$debug" || remove_trash=$TRASH_DIRECTORY
 911 rm -fr "$TRASH_DIRECTORY" || {
 912         GIT_EXIT_OK=t
 913         echo >&5 "FATAL: Cannot prepare test area"
 914         exit 1
 915 }
 916
 917 HOME="$TRASH_DIRECTORY"
 918 GNUPGHOME="$HOME/gnupg-home-not-used"
 919 export HOME GNUPGHOME
 920
 921 if test -z "$TEST_NO_CREATE_REPO"
 922 then
 923         test_create_repo "$TRASH_DIRECTORY"
 924 else
 925         mkdir -p "$TRASH_DIRECTORY"
 926 fi
 927 # Use -P to resolve symlinks in our working directory so that the cwd
 928 # in subprocesses like git equals our $PWD (for pathname comparisons).
 929 cd -P "$TRASH_DIRECTORY" || exit 1
 930
 931 this_test=${0##*/}
 932 this_test=${this_test%%-*}
 933 if match_pattern_list "$this_test" $GIT_SKIP_TESTS
 934 then
 935         say_color info >&3 "skipping test $this_test altogether"
 936         skip_all="skip all tests in $this_test"
 937         test_done
 938 fi
 939
 940 # Provide an implementation of the 'yes' utility
 941 yes () {
 942         if test $# = 0
 943         then
 944                 y=y
 945         else
 946                 y="$*"
 947         fi
 948
 949         i=0
 950         while test $i -lt 99
 951         do
 952                 echo "$y"
 953                 i=$(($i+1))
 954         done
 955 }
 956
 957 # Fix some commands on Windows
 958 case $(uname -s) in
 959 *MINGW*)
 960         # Windows has its own (incompatible) sort and find
 961         sort () {
 962                 /usr/bin/sort "$@"
 963         }
 964         find () {
 965                 /usr/bin/find "$@"
 966         }
 967         sum () {
 968                 md5sum "$@"
 969         }
 970         # git sees Windows-style pwd
 971         pwd () {
 972                 builtin pwd -W
 973         }
 974         # no POSIX permissions
 975         # backslashes in pathspec are converted to '/'
 976         # exec does not inherit the PID
 977         test_set_prereq MINGW
 978         test_set_prereq NATIVE_CRLF
 979         test_set_prereq SED_STRIPS_CR
 980         test_set_prereq GREP_STRIPS_CR
 981         GIT_TEST_CMP=mingw_test_cmp
 982         ;;
 983 *CYGWIN*)
 984         test_set_prereq POSIXPERM
 985         test_set_prereq EXECKEEPSPID
 986         test_set_prereq CYGWIN
 987         test_set_prereq SED_STRIPS_CR
 988         test_set_prereq GREP_STRIPS_CR
 989         ;;
 990 *)
 991         test_set_prereq POSIXPERM
 992         test_set_prereq BSLASHPSPEC
 993         test_set_prereq EXECKEEPSPID
 994         ;;
 995 esac
 996
 997 ( COLUMNS=1 && test $COLUMNS = 1 ) && test_set_prereq COLUMNS_CAN_BE_1
 998 test -z "$NO_PERL" && test_set_prereq PERL
 999 test -z "$NO_PYTHON" && test_set_prereq PYTHON
1000 test -n "$USE_LIBPCRE" && test_set_prereq LIBPCRE
1001 test -z "$NO_GETTEXT" && test_set_prereq GETTEXT
1002
1003 # Can we rely on git's output in the C locale?
1004 if test -n "$GETTEXT_POISON"
1005 then
1006         GIT_GETTEXT_POISON=YesPlease
1007         export GIT_GETTEXT_POISON
1008         test_set_prereq GETTEXT_POISON
1009 else
1010         test_set_prereq C_LOCALE_OUTPUT
1011 fi
1012
1013 # Use this instead of test_cmp to compare files that contain expected and
1014 # actual output from git commands that can be translated.  When running
1015 # under GETTEXT_POISON this pretends that the command produced expected
1016 # results.
1017 test_i18ncmp () {
1018         test -n "$GETTEXT_POISON" || test_cmp "$@"
1019 }
1020
1021 # Use this instead of "grep expected-string actual" to see if the
1022 # output from a git command that can be translated either contains an
1023 # expected string, or does not contain an unwanted one.  When running
1024 # under GETTEXT_POISON this pretends that the command produced expected
1025 # results.
1026 test_i18ngrep () {
1027         if test -n "$GETTEXT_POISON"
1028         then
1029             : # pretend success
1030         elif test "x!" = "x$1"
1031         then
1032                 shift
1033                 ! grep "$@"
1034         else
1035                 grep "$@"
1036         fi
1037 }
1038
1039 test_lazy_prereq PIPE '
1040         # test whether the filesystem supports FIFOs
1041         case $(uname -s) in
1042         CYGWIN*|MINGW*)
1043                 false
1044                 ;;
1045         *)
1046                 rm -f testfifo && mkfifo testfifo
1047                 ;;
1048         esac
1049 '
1050
1051 test_lazy_prereq SYMLINKS '
1052         # test whether the filesystem supports symbolic links
1053         ln -s x y && test -h y
1054 '
1055
1056 test_lazy_prereq FILEMODE '
1057         test "$(git config --bool core.filemode)" = true
1058 '
1059
1060 test_lazy_prereq CASE_INSENSITIVE_FS '
1061         echo good >CamelCase &&
1062         echo bad >camelcase &&
1063         test "$(cat CamelCase)" != good
1064 '
1065
1066 test_lazy_prereq UTF8_NFD_TO_NFC '
1067         # check whether FS converts nfd unicode to nfc
1068         auml=$(printf "\303\244")
1069         aumlcdiar=$(printf "\141\314\210")
1070         >"$auml" &&
1071         case "$(echo *)" in
1072         "$aumlcdiar")
1073                 true ;;
1074         *)
1075                 false ;;
1076         esac
1077 '
1078
1079 test_lazy_prereq AUTOIDENT '
1080         sane_unset GIT_AUTHOR_NAME &&
1081         sane_unset GIT_AUTHOR_EMAIL &&
1082         git var GIT_AUTHOR_IDENT
1083 '
1084
1085 test_lazy_prereq EXPENSIVE '
1086         test -n "$GIT_TEST_LONG"
1087 '
1088
1089 test_lazy_prereq USR_BIN_TIME '
1090         test -x /usr/bin/time
1091 '
1092
1093 test_lazy_prereq NOT_ROOT '
1094         uid=$(id -u) &&
1095         test "$uid" != 0
1096 '
1097
1098 # SANITY is about "can you correctly predict what the filesystem would
1099 # do by only looking at the permission bits of the files and
1100 # directories?"  A typical example of !SANITY is running the test
1101 # suite as root, where a test may expect "chmod -r file && cat file"
1102 # to fail because file is supposed to be unreadable after a successful
1103 # chmod.  In an environment (i.e. combination of what filesystem is
1104 # being used and who is running the tests) that lacks SANITY, you may
1105 # be able to delete or create a file when the containing directory
1106 # doesn't have write permissions, or access a file even if the
1107 # containing directory doesn't have read or execute permissions.
1108
1109 test_lazy_prereq SANITY '
1110         mkdir SANETESTD.1 SANETESTD.2 &&
1111
1112         chmod +w SANETESTD.1 SANETESTD.2 &&
1113         >SANETESTD.1/x 2>SANETESTD.2/x &&
1114         chmod -w SANETESTD.1 &&
1115         chmod -r SANETESTD.1/x &&
1116         chmod -rx SANETESTD.2 ||
1117         error "bug in test sript: cannot prepare SANETESTD"
1118
1119         ! test -r SANETESTD.1/x &&
1120         ! rm SANETESTD.1/x && ! test -f SANETESTD.2/x
1121         status=$?
1122
1123         chmod +rwx SANETESTD.1 SANETESTD.2 &&
1124         rm -rf SANETESTD.1 SANETESTD.2 ||
1125         error "bug in test sript: cannot clean SANETESTD"
1126         return $status
1127 '
1128
1129 GIT_UNZIP=${GIT_UNZIP:-unzip}
1130 test_lazy_prereq UNZIP '
1131         "$GIT_UNZIP" -v
1132         test $? -ne 127
1133 '
1134
1135 run_with_limited_cmdline () {
1136         (ulimit -s 128 && "$@")
1137 }
1138
1139 test_lazy_prereq CMDLINE_LIMIT 'run_with_limited_cmdline true'