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