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