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