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