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