git.oblomov.eu Git - git/blob - t/test-lib.sh

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