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 TEST_COMMITTER_LOCALNAME=committer
 445 TEST_COMMITTER_DOMAIN=example.com
 446 GIT_COMMITTER_EMAIL=${TEST_COMMITTER_LOCALNAME}@${TEST_COMMITTER_DOMAIN}
 447 GIT_COMMITTER_NAME='C O Mitter'
 448 GIT_MERGE_VERBOSITY=5
 449 GIT_MERGE_AUTOEDIT=no
 450 export GIT_MERGE_VERBOSITY GIT_MERGE_AUTOEDIT
 451 export GIT_AUTHOR_EMAIL GIT_AUTHOR_NAME
 452 export GIT_COMMITTER_EMAIL GIT_COMMITTER_NAME
 453 export EDITOR
 454
 455 # Tests using GIT_TRACE typically don't want <timestamp> <file>:<line> output
 456 GIT_TRACE_BARE=1
 457 export GIT_TRACE_BARE
 458
 459 check_var_migration () {
 460         # the warnings and hints given from this helper depends
 461         # on end-user settings, which will disrupt the self-test
 462         # done on the test framework itself.
 463         case "$GIT_TEST_FRAMEWORK_SELFTEST" in
 464         t)      return ;;
 465         esac
 466
 467         old_name=$1 new_name=$2
 468         eval "old_isset=\${${old_name}:+isset}"
 469         eval "new_isset=\${${new_name}:+isset}"
 470
 471         case "$old_isset,$new_isset" in
 472         isset,)
 473                 echo >&2 "warning: $old_name is now $new_name"
 474                 echo >&2 "hint: set $new_name too during the transition period"
 475                 eval "$new_name=\$$old_name"
 476                 ;;
 477         isset,isset)
 478                 # do this later
 479                 # echo >&2 "warning: $old_name is now $new_name"
 480                 # echo >&2 "hint: remove $old_name"
 481                 ;;
 482         esac
 483 }
 484
 485 check_var_migration GIT_FSMONITOR_TEST GIT_TEST_FSMONITOR
 486 check_var_migration TEST_GIT_INDEX_VERSION GIT_TEST_INDEX_VERSION
 487 check_var_migration GIT_FORCE_PRELOAD_TEST GIT_TEST_PRELOAD_INDEX
 488
 489 # Use specific version of the index file format
 490 if test -n "${GIT_TEST_INDEX_VERSION:+isset}"
 491 then
 492         GIT_INDEX_VERSION="$GIT_TEST_INDEX_VERSION"
 493         export GIT_INDEX_VERSION
 494 fi
 495
 496 # Add libc MALLOC and MALLOC_PERTURB test
 497 # only if we are not executing the test with valgrind
 498 if test -n "$valgrind" ||
 499    test -n "$TEST_NO_MALLOC_CHECK"
 500 then
 501         setup_malloc_check () {
 502                 : nothing
 503         }
 504         teardown_malloc_check () {
 505                 : nothing
 506         }
 507 else
 508         setup_malloc_check () {
 509                 MALLOC_CHECK_=3 MALLOC_PERTURB_=165
 510                 export MALLOC_CHECK_ MALLOC_PERTURB_
 511         }
 512         teardown_malloc_check () {
 513                 unset MALLOC_CHECK_ MALLOC_PERTURB_
 514         }
 515 fi
 516
 517 # Protect ourselves from common misconfiguration to export
 518 # CDPATH into the environment
 519 unset CDPATH
 520
 521 unset GREP_OPTIONS
 522 unset UNZIP
 523
 524 case $(echo $GIT_TRACE |tr "[A-Z]" "[a-z]") in
 525 1|2|true)
 526         GIT_TRACE=4
 527         ;;
 528 esac
 529
 530 # Line feed
 531 LF='
 532 '
 533
 534 # Single quote
 535 SQ=\'
 536
 537 # UTF-8 ZERO WIDTH NON-JOINER, which HFS+ ignores
 538 # when case-folding filenames
 539 u200c=$(printf '\342\200\214')
 540
 541 export _x05 _x35 _x40 _z40 LF u200c EMPTY_TREE EMPTY_BLOB ZERO_OID OID_REGEX
 542
 543 # Each test should start with something like this, after copyright notices:
 544 #
 545 # test_description='Description of this test...
 546 # This test checks if command xyzzy does the right thing...
 547 # '
 548 # . ./test-lib.sh
 549 test "x$TERM" != "xdumb" && (
 550                 test -t 1 &&
 551                 tput bold >/dev/null 2>&1 &&
 552                 tput setaf 1 >/dev/null 2>&1 &&
 553                 tput sgr0 >/dev/null 2>&1
 554         ) &&
 555         color=t
 556
 557 if test -n "$color"
 558 then
 559         # Save the color control sequences now rather than run tput
 560         # each time say_color() is called.  This is done for two
 561         # reasons:
 562         #   * TERM will be changed to dumb
 563         #   * HOME will be changed to a temporary directory and tput
 564         #     might need to read ~/.terminfo from the original HOME
 565         #     directory to get the control sequences
 566         # Note:  This approach assumes the control sequences don't end
 567         # in a newline for any terminal of interest (command
 568         # substitutions strip trailing newlines).  Given that most
 569         # (all?) terminals in common use are related to ECMA-48, this
 570         # shouldn't be a problem.
 571         say_color_error=$(tput bold; tput setaf 1) # bold red
 572         say_color_skip=$(tput setaf 4) # blue
 573         say_color_warn=$(tput setaf 3) # brown/yellow
 574         say_color_pass=$(tput setaf 2) # green
 575         say_color_info=$(tput setaf 6) # cyan
 576         say_color_reset=$(tput sgr0)
 577         say_color_="" # no formatting for normal text
 578         say_color () {
 579                 test -z "$1" && test -n "$quiet" && return
 580                 eval "say_color_color=\$say_color_$1"
 581                 shift
 582                 printf "%s\\n" "$say_color_color$*$say_color_reset"
 583         }
 584 else
 585         say_color() {
 586                 test -z "$1" && test -n "$quiet" && return
 587                 shift
 588                 printf "%s\n" "$*"
 589         }
 590 fi
 591
 592 TERM=dumb
 593 export TERM
 594
 595 error () {
 596         say_color error "error: $*"
 597         finalize_junit_xml
 598         GIT_EXIT_OK=t
 599         exit 1
 600 }
 601
 602 BUG () {
 603         error >&7 "bug in the test script: $*"
 604 }
 605
 606 say () {
 607         say_color info "$*"
 608 }
 609
 610 if test -n "$HARNESS_ACTIVE"
 611 then
 612         if test "$verbose" = t || test -n "$verbose_only"
 613         then
 614                 printf 'Bail out! %s\n' \
 615                  'verbose mode forbidden under TAP harness; try --verbose-log'
 616                 exit 1
 617         fi
 618 fi
 619
 620 test "${test_description}" != "" ||
 621 error "Test script did not set test_description."
 622
 623 if test "$help" = "t"
 624 then
 625         printf '%s\n' "$test_description"
 626         exit 0
 627 fi
 628
 629 exec 5>&1
 630 exec 6<&0
 631 exec 7>&2
 632 if test "$verbose_log" = "t"
 633 then
 634         exec 3>>"$GIT_TEST_TEE_OUTPUT_FILE" 4>&3
 635 elif test "$verbose" = "t"
 636 then
 637         exec 4>&2 3>&1
 638 else
 639         exec 4>/dev/null 3>/dev/null
 640 fi
 641
 642 # Send any "-x" output directly to stderr to avoid polluting tests
 643 # which capture stderr. We can do this unconditionally since it
 644 # has no effect if tracing isn't turned on.
 645 #
 646 # Note that this sets up the trace fd as soon as we assign the variable, so it
 647 # must come after the creation of descriptor 4 above. Likewise, we must never
 648 # unset this, as it has the side effect of closing descriptor 4, which we
 649 # use to show verbose tests to the user.
 650 #
 651 # Note also that we don't need or want to export it. The tracing is local to
 652 # this shell, and we would not want to influence any shells we exec.
 653 BASH_XTRACEFD=4
 654
 655 test_failure=0
 656 test_count=0
 657 test_fixed=0
 658 test_broken=0
 659 test_success=0
 660
 661 test_external_has_tap=0
 662
 663 die () {
 664         code=$?
 665         # This is responsible for running the atexit commands even when a
 666         # test script run with '--immediate' fails, or when the user hits
 667         # ctrl-C, i.e. when 'test_done' is not invoked at all.
 668         test_atexit_handler || code=$?
 669         if test -n "$GIT_EXIT_OK"
 670         then
 671                 exit $code
 672         else
 673                 echo >&5 "FATAL: Unexpected exit with code $code"
 674                 exit 1
 675         fi
 676 }
 677
 678 file_lineno () {
 679         test -z "$GIT_TEST_FRAMEWORK_SELFTEST" && test -n "$BASH" || return 0
 680         local i
 681         for i in ${!BASH_SOURCE[*]}
 682         do
 683                 case $i,"${BASH_SOURCE[$i]##*/}" in
 684                 0,t[0-9]*.sh) echo "t/${BASH_SOURCE[$i]}:$LINENO: ${1+$1: }"; return;;
 685                 *,t[0-9]*.sh) echo "t/${BASH_SOURCE[$i]}:${BASH_LINENO[$(($i-1))]}: ${1+$1: }"; return;;
 686                 esac
 687         done
 688 }
 689
 690 GIT_EXIT_OK=
 691 trap 'die' EXIT
 692 # Disable '-x' tracing, because with some shells, notably dash, it
 693 # prevents running the cleanup commands when a test script run with
 694 # '--verbose-log -x' is interrupted.
 695 trap '{ code=$?; set +x; } 2>/dev/null; exit $code' INT TERM HUP
 696
 697 # The user-facing functions are loaded from a separate file so that
 698 # test_perf subshells can have them too
 699 . "$TEST_DIRECTORY/test-lib-functions.sh"
 700
 701 # You are not expected to call test_ok_ and test_failure_ directly, use
 702 # the test_expect_* functions instead.
 703
 704 test_ok_ () {
 705         if test -n "$write_junit_xml"
 706         then
 707                 write_junit_xml_testcase "$*"
 708         fi
 709         test_success=$(($test_success + 1))
 710         say_color "" "ok $test_count - $@"
 711 }
 712
 713 test_failure_ () {
 714         if test -n "$write_junit_xml"
 715         then
 716                 junit_insert="<failure message=\"not ok $test_count -"
 717                 junit_insert="$junit_insert $(xml_attr_encode "$1")\">"
 718                 junit_insert="$junit_insert $(xml_attr_encode \
 719                         "$(if test -n "$GIT_TEST_TEE_OUTPUT_FILE"
 720                            then
 721                                 test-tool path-utils skip-n-bytes \
 722                                         "$GIT_TEST_TEE_OUTPUT_FILE" $GIT_TEST_TEE_OFFSET
 723                            else
 724                                 printf '%s\n' "$@" | sed 1d
 725                            fi)")"
 726                 junit_insert="$junit_insert</failure>"
 727                 if test -n "$GIT_TEST_TEE_OUTPUT_FILE"
 728                 then
 729                         junit_insert="$junit_insert<system-err>$(xml_attr_encode \
 730                                 "$(cat "$GIT_TEST_TEE_OUTPUT_FILE")")</system-err>"
 731                 fi
 732                 write_junit_xml_testcase "$1" "      $junit_insert"
 733         fi
 734         test_failure=$(($test_failure + 1))
 735         say_color error "$(file_lineno error)not ok $test_count - $1"
 736         shift
 737         printf '%s\n' "$*" | sed -e 's/^/#      /'
 738         test "$immediate" = "" || { finalize_junit_xml; GIT_EXIT_OK=t; exit 1; }
 739 }
 740
 741 test_known_broken_ok_ () {
 742         if test -n "$write_junit_xml"
 743         then
 744                 write_junit_xml_testcase "$* (breakage fixed)"
 745         fi
 746         test_fixed=$(($test_fixed+1))
 747         say_color error "ok $test_count - $@ # TODO known breakage vanished"
 748 }
 749
 750 test_known_broken_failure_ () {
 751         if test -n "$write_junit_xml"
 752         then
 753                 write_junit_xml_testcase "$* (known breakage)"
 754         fi
 755         test_broken=$(($test_broken+1))
 756         say_color warn "not ok $test_count - $@ # TODO known breakage"
 757 }
 758
 759 test_debug () {
 760         test "$debug" = "" || eval "$1"
 761 }
 762
 763 match_pattern_list () {
 764         arg="$1"
 765         shift
 766         test -z "$*" && return 1
 767         for pattern_
 768         do
 769                 case "$arg" in
 770                 $pattern_)
 771                         return 0
 772                 esac
 773         done
 774         return 1
 775 }
 776
 777 match_test_selector_list () {
 778         title="$1"
 779         shift
 780         arg="$1"
 781         shift
 782         test -z "$1" && return 0
 783
 784         # Both commas and whitespace are accepted as separators.
 785         OLDIFS=$IFS
 786         IFS='   ,'
 787         set -- $1
 788         IFS=$OLDIFS
 789
 790         # If the first selector is negative we include by default.
 791         include=
 792         case "$1" in
 793                 !*) include=t ;;
 794         esac
 795
 796         for selector
 797         do
 798                 orig_selector=$selector
 799
 800                 positive=t
 801                 case "$selector" in
 802                         !*)
 803                                 positive=
 804                                 selector=${selector##?}
 805                                 ;;
 806                 esac
 807
 808                 test -z "$selector" && continue
 809
 810                 case "$selector" in
 811                         *-*)
 812                                 if expr "z${selector%%-*}" : "z[0-9]*[^0-9]" >/dev/null
 813                                 then
 814                                         echo "error: $title: invalid non-numeric in range" \
 815                                                 "start: '$orig_selector'" >&2
 816                                         exit 1
 817                                 fi
 818                                 if expr "z${selector#*-}" : "z[0-9]*[^0-9]" >/dev/null
 819                                 then
 820                                         echo "error: $title: invalid non-numeric in range" \
 821                                                 "end: '$orig_selector'" >&2
 822                                         exit 1
 823                                 fi
 824                                 ;;
 825                         *)
 826                                 if expr "z$selector" : "z[0-9]*[^0-9]" >/dev/null
 827                                 then
 828                                         echo "error: $title: invalid non-numeric in test" \
 829                                                 "selector: '$orig_selector'" >&2
 830                                         exit 1
 831                                 fi
 832                 esac
 833
 834                 # Short cut for "obvious" cases
 835                 test -z "$include" && test -z "$positive" && continue
 836                 test -n "$include" && test -n "$positive" && continue
 837
 838                 case "$selector" in
 839                         -*)
 840                                 if test $arg -le ${selector#-}
 841                                 then
 842                                         include=$positive
 843                                 fi
 844                                 ;;
 845                         *-)
 846                                 if test $arg -ge ${selector%-}
 847                                 then
 848                                         include=$positive
 849                                 fi
 850                                 ;;
 851                         *-*)
 852                                 if test ${selector%%-*} -le $arg \
 853                                         && test $arg -le ${selector#*-}
 854                                 then
 855                                         include=$positive
 856                                 fi
 857                                 ;;
 858                         *)
 859                                 if test $arg -eq $selector
 860                                 then
 861                                         include=$positive
 862                                 fi
 863                                 ;;
 864                 esac
 865         done
 866
 867         test -n "$include"
 868 }
 869
 870 maybe_teardown_verbose () {
 871         test -z "$verbose_only" && return
 872         exec 4>/dev/null 3>/dev/null
 873         verbose=
 874 }
 875
 876 last_verbose=t
 877 maybe_setup_verbose () {
 878         test -z "$verbose_only" && return
 879         if match_pattern_list $test_count $verbose_only
 880         then
 881                 exec 4>&2 3>&1
 882                 # Emit a delimiting blank line when going from
 883                 # non-verbose to verbose.  Within verbose mode the
 884                 # delimiter is printed by test_expect_*.  The choice
 885                 # of the initial $last_verbose is such that before
 886                 # test 1, we do not print it.
 887                 test -z "$last_verbose" && echo >&3 ""
 888                 verbose=t
 889         else
 890                 exec 4>/dev/null 3>/dev/null
 891                 verbose=
 892         fi
 893         last_verbose=$verbose
 894 }
 895
 896 maybe_teardown_valgrind () {
 897         test -z "$GIT_VALGRIND" && return
 898         GIT_VALGRIND_ENABLED=
 899 }
 900
 901 maybe_setup_valgrind () {
 902         test -z "$GIT_VALGRIND" && return
 903         if test -z "$valgrind_only"
 904         then
 905                 GIT_VALGRIND_ENABLED=t
 906                 return
 907         fi
 908         GIT_VALGRIND_ENABLED=
 909         if match_pattern_list $test_count $valgrind_only
 910         then
 911                 GIT_VALGRIND_ENABLED=t
 912         fi
 913 }
 914
 915 trace_level_=0
 916 want_trace () {
 917         test "$trace" = t && {
 918                 test "$verbose" = t || test "$verbose_log" = t
 919         }
 920 }
 921
 922 # This is a separate function because some tests use
 923 # "return" to end a test_expect_success block early
 924 # (and we want to make sure we run any cleanup like
 925 # "set +x").
 926 test_eval_inner_ () {
 927         # Do not add anything extra (including LF) after '$*'
 928         eval "
 929                 want_trace && trace_level_=$(($trace_level_+1)) && set -x
 930                 $*"
 931 }
 932
 933 test_eval_ () {
 934         # If "-x" tracing is in effect, then we want to avoid polluting stderr
 935         # with non-test commands. But once in "set -x" mode, we cannot prevent
 936         # the shell from printing the "set +x" to turn it off (nor the saving
 937         # of $? before that). But we can make sure that the output goes to
 938         # /dev/null.
 939         #
 940         # There are a few subtleties here:
 941         #
 942         #   - we have to redirect descriptor 4 in addition to 2, to cover
 943         #     BASH_XTRACEFD
 944         #
 945         #   - the actual eval has to come before the redirection block (since
 946         #     it needs to see descriptor 4 to set up its stderr)
 947         #
 948         #   - likewise, any error message we print must be outside the block to
 949         #     access descriptor 4
 950         #
 951         #   - checking $? has to come immediately after the eval, but it must
 952         #     be _inside_ the block to avoid polluting the "set -x" output
 953         #
 954
 955         test_eval_inner_ "$@" </dev/null >&3 2>&4
 956         {
 957                 test_eval_ret_=$?
 958                 if want_trace
 959                 then
 960                         test 1 = $trace_level_ && set +x
 961                         trace_level_=$(($trace_level_-1))
 962                 fi
 963         } 2>/dev/null 4>&2
 964
 965         if test "$test_eval_ret_" != 0 && want_trace
 966         then
 967                 say_color error >&4 "error: last command exited with \$?=$test_eval_ret_"
 968         fi
 969         return $test_eval_ret_
 970 }
 971
 972 test_run_ () {
 973         test_cleanup=:
 974         expecting_failure=$2
 975
 976         if test "${GIT_TEST_CHAIN_LINT:-1}" != 0; then
 977                 # turn off tracing for this test-eval, as it simply creates
 978                 # confusing noise in the "-x" output
 979                 trace_tmp=$trace
 980                 trace=
 981                 # 117 is magic because it is unlikely to match the exit
 982                 # code of other programs
 983                 if $(printf '%s\n' "$1" | sed -f "$GIT_BUILD_DIR/t/chainlint.sed" | grep -q '?![A-Z][A-Z]*?!') ||
 984                         test "OK-117" != "$(test_eval_ "(exit 117) && $1${LF}${LF}echo OK-\$?" 3>&1)"
 985                 then
 986                         BUG "broken &&-chain or run-away HERE-DOC: $1"
 987                 fi
 988                 trace=$trace_tmp
 989         fi
 990
 991         setup_malloc_check
 992         test_eval_ "$1"
 993         eval_ret=$?
 994         teardown_malloc_check
 995
 996         if test -z "$immediate" || test $eval_ret = 0 ||
 997            test -n "$expecting_failure" && test "$test_cleanup" != ":"
 998         then
 999                 setup_malloc_check
1000                 test_eval_ "$test_cleanup"
1001                 teardown_malloc_check
1002         fi
1003         if test "$verbose" = "t" && test -n "$HARNESS_ACTIVE"
1004         then
1005                 echo ""
1006         fi
1007         return "$eval_ret"
1008 }
1009
1010 test_start_ () {
1011         test_count=$(($test_count+1))
1012         maybe_setup_verbose
1013         maybe_setup_valgrind
1014         if test -n "$write_junit_xml"
1015         then
1016                 junit_start=$(test-tool date getnanos)
1017         fi
1018 }
1019
1020 test_finish_ () {
1021         echo >&3 ""
1022         maybe_teardown_valgrind
1023         maybe_teardown_verbose
1024         if test -n "$GIT_TEST_TEE_OFFSET"
1025         then
1026                 GIT_TEST_TEE_OFFSET=$(test-tool path-utils file-size \
1027                         "$GIT_TEST_TEE_OUTPUT_FILE")
1028         fi
1029 }
1030
1031 test_skip () {
1032         to_skip=
1033         skipped_reason=
1034         if match_pattern_list $this_test.$test_count $GIT_SKIP_TESTS
1035         then
1036                 to_skip=t
1037                 skipped_reason="GIT_SKIP_TESTS"
1038         fi
1039         if test -z "$to_skip" && test -n "$run_list" &&
1040            ! match_test_selector_list '--run' $test_count "$run_list"
1041         then
1042                 to_skip=t
1043                 skipped_reason="--run"
1044         fi
1045         if test -z "$to_skip" && test -n "$test_prereq" &&
1046            ! test_have_prereq "$test_prereq"
1047         then
1048                 to_skip=t
1049
1050                 of_prereq=
1051                 if test "$missing_prereq" != "$test_prereq"
1052                 then
1053                         of_prereq=" of $test_prereq"
1054                 fi
1055                 skipped_reason="missing $missing_prereq${of_prereq}"
1056         fi
1057
1058         case "$to_skip" in
1059         t)
1060                 if test -n "$write_junit_xml"
1061                 then
1062                         message="$(xml_attr_encode "$skipped_reason")"
1063                         write_junit_xml_testcase "$1" \
1064                                 "      <skipped message=\"$message\" />"
1065                 fi
1066
1067                 say_color skip >&3 "skipping test: $@"
1068                 say_color skip "ok $test_count # skip $1 ($skipped_reason)"
1069                 : true
1070                 ;;
1071         *)
1072                 false
1073                 ;;
1074         esac
1075 }
1076
1077 # stub; perf-lib overrides it
1078 test_at_end_hook_ () {
1079         :
1080 }
1081
1082 write_junit_xml () {
1083         case "$1" in
1084         --truncate)
1085                 >"$junit_xml_path"
1086                 junit_have_testcase=
1087                 shift
1088                 ;;
1089         esac
1090         printf '%s\n' "$@" >>"$junit_xml_path"
1091 }
1092
1093 xml_attr_encode () {
1094         printf '%s\n' "$@" | test-tool xml-encode
1095 }
1096
1097 write_junit_xml_testcase () {
1098         junit_attrs="name=\"$(xml_attr_encode "$this_test.$test_count $1")\""
1099         shift
1100         junit_attrs="$junit_attrs classname=\"$this_test\""
1101         junit_attrs="$junit_attrs time=\"$(test-tool \
1102                 date getnanos $junit_start)\""
1103         write_junit_xml "$(printf '%s\n' \
1104                 "    <testcase $junit_attrs>" "$@" "    </testcase>")"
1105         junit_have_testcase=t
1106 }
1107
1108 finalize_junit_xml () {
1109         if test -n "$write_junit_xml" && test -n "$junit_xml_path"
1110         then
1111                 test -n "$junit_have_testcase" || {
1112                         junit_start=$(test-tool date getnanos)
1113                         write_junit_xml_testcase "all tests skipped"
1114                 }
1115
1116                 # adjust the overall time
1117                 junit_time=$(test-tool date getnanos $junit_suite_start)
1118                 sed -e "s/\(<testsuite.*\) time=\"[^\"]*\"/\1/" \
1119                         -e "s/<testsuite [^>]*/& time=\"$junit_time\"/" \
1120                         -e '/^ *<\/testsuite/d' \
1121                         <"$junit_xml_path" >"$junit_xml_path.new"
1122                 mv "$junit_xml_path.new" "$junit_xml_path"
1123
1124                 write_junit_xml "  </testsuite>" "</testsuites>"
1125                 write_junit_xml=
1126         fi
1127 }
1128
1129 test_atexit_cleanup=:
1130 test_atexit_handler () {
1131         # In a succeeding test script 'test_atexit_handler' is invoked
1132         # twice: first from 'test_done', then from 'die' in the trap on
1133         # EXIT.
1134         # This condition and resetting 'test_atexit_cleanup' below makes
1135         # sure that the registered cleanup commands are run only once.
1136         test : != "$test_atexit_cleanup" || return 0
1137
1138         setup_malloc_check
1139         test_eval_ "$test_atexit_cleanup"
1140         test_atexit_cleanup=:
1141         teardown_malloc_check
1142 }
1143
1144 test_done () {
1145         GIT_EXIT_OK=t
1146
1147         # Run the atexit commands _before_ the trash directory is
1148         # removed, so the commands can access pidfiles and socket files.
1149         test_atexit_handler
1150
1151         finalize_junit_xml
1152
1153         if test -z "$HARNESS_ACTIVE"
1154         then
1155                 mkdir -p "$TEST_RESULTS_DIR"
1156
1157                 cat >"$TEST_RESULTS_BASE.counts" <<-EOF
1158                 total $test_count
1159                 success $test_success
1160                 fixed $test_fixed
1161                 broken $test_broken
1162                 failed $test_failure
1163
1164                 EOF
1165         fi
1166
1167         if test "$test_fixed" != 0
1168         then
1169                 say_color error "# $test_fixed known breakage(s) vanished; please update test(s)"
1170         fi
1171         if test "$test_broken" != 0
1172         then
1173                 say_color warn "# still have $test_broken known breakage(s)"
1174         fi
1175         if test "$test_broken" != 0 || test "$test_fixed" != 0
1176         then
1177                 test_remaining=$(( $test_count - $test_broken - $test_fixed ))
1178                 msg="remaining $test_remaining test(s)"
1179         else
1180                 test_remaining=$test_count
1181                 msg="$test_count test(s)"
1182         fi
1183         case "$test_failure" in
1184         0)
1185                 if test $test_external_has_tap -eq 0
1186                 then
1187                         if test $test_remaining -gt 0
1188                         then
1189                                 say_color pass "# passed all $msg"
1190                         fi
1191
1192                         # Maybe print SKIP message
1193                         test -z "$skip_all" || skip_all="# SKIP $skip_all"
1194                         case "$test_count" in
1195                         0)
1196                                 say "1..$test_count${skip_all:+ $skip_all}"
1197                                 ;;
1198                         *)
1199                                 test -z "$skip_all" ||
1200                                 say_color warn "$skip_all"
1201                                 say "1..$test_count"
1202                                 ;;
1203                         esac
1204                 fi
1205
1206                 if test -z "$debug"
1207                 then
1208                         test -d "$TRASH_DIRECTORY" ||
1209                         error "Tests passed but trash directory already removed before test cleanup; aborting"
1210
1211                         cd "$TRASH_DIRECTORY/.." &&
1212                         rm -fr "$TRASH_DIRECTORY" || {
1213                                 # try again in a bit
1214                                 sleep 5;
1215                                 rm -fr "$TRASH_DIRECTORY"
1216                         } ||
1217                         error "Tests passed but test cleanup failed; aborting"
1218                 fi
1219                 test_at_end_hook_
1220
1221                 exit 0 ;;
1222
1223         *)
1224                 if test $test_external_has_tap -eq 0
1225                 then
1226                         say_color error "# failed $test_failure among $msg"
1227                         say "1..$test_count"
1228                 fi
1229
1230                 exit 1 ;;
1231
1232         esac
1233 }
1234
1235 if test -n "$valgrind"
1236 then
1237         make_symlink () {
1238                 test -h "$2" &&
1239                 test "$1" = "$(readlink "$2")" || {
1240                         # be super paranoid
1241                         if mkdir "$2".lock
1242                         then
1243                                 rm -f "$2" &&
1244                                 ln -s "$1" "$2" &&
1245                                 rm -r "$2".lock
1246                         else
1247                                 while test -d "$2".lock
1248                                 do
1249                                         say "Waiting for lock on $2."
1250                                         sleep 1
1251                                 done
1252                         fi
1253                 }
1254         }
1255
1256         make_valgrind_symlink () {
1257                 # handle only executables, unless they are shell libraries that
1258                 # need to be in the exec-path.
1259                 test -x "$1" ||
1260                 test "# " = "$(test_copy_bytes 2 <"$1")" ||
1261                 return;
1262
1263                 base=$(basename "$1")
1264                 case "$base" in
1265                 test-*)
1266                         symlink_target="$GIT_BUILD_DIR/t/helper/$base"
1267                         ;;
1268                 *)
1269                         symlink_target="$GIT_BUILD_DIR/$base"
1270                         ;;
1271                 esac
1272                 # do not override scripts
1273                 if test -x "$symlink_target" &&
1274                     test ! -d "$symlink_target" &&
1275                     test "#!" != "$(test_copy_bytes 2 <"$symlink_target")"
1276                 then
1277                         symlink_target=../valgrind.sh
1278                 fi
1279                 case "$base" in
1280                 *.sh|*.perl)
1281                         symlink_target=../unprocessed-script
1282                 esac
1283                 # create the link, or replace it if it is out of date
1284                 make_symlink "$symlink_target" "$GIT_VALGRIND/bin/$base" || exit
1285         }
1286
1287         # override all git executables in TEST_DIRECTORY/..
1288         GIT_VALGRIND=$TEST_DIRECTORY/valgrind
1289         mkdir -p "$GIT_VALGRIND"/bin
1290         for file in $GIT_BUILD_DIR/git* $GIT_BUILD_DIR/t/helper/test-*
1291         do
1292                 make_valgrind_symlink $file
1293         done
1294         # special-case the mergetools loadables
1295         make_symlink "$GIT_BUILD_DIR"/mergetools "$GIT_VALGRIND/bin/mergetools"
1296         OLDIFS=$IFS
1297         IFS=:
1298         for path in $PATH
1299         do
1300                 ls "$path"/git-* 2> /dev/null |
1301                 while read file
1302                 do
1303                         make_valgrind_symlink "$file"
1304                 done
1305         done
1306         IFS=$OLDIFS
1307         PATH=$GIT_VALGRIND/bin:$PATH
1308         GIT_EXEC_PATH=$GIT_VALGRIND/bin
1309         export GIT_VALGRIND
1310         GIT_VALGRIND_MODE="$valgrind"
1311         export GIT_VALGRIND_MODE
1312         GIT_VALGRIND_ENABLED=t
1313         test -n "$valgrind_only" && GIT_VALGRIND_ENABLED=
1314         export GIT_VALGRIND_ENABLED
1315 elif test -n "$GIT_TEST_INSTALLED"
1316 then
1317         GIT_EXEC_PATH=$($GIT_TEST_INSTALLED/git --exec-path)  ||
1318         error "Cannot run git from $GIT_TEST_INSTALLED."
1319         PATH=$GIT_TEST_INSTALLED:$GIT_BUILD_DIR/t/helper:$PATH
1320         GIT_EXEC_PATH=${GIT_TEST_EXEC_PATH:-$GIT_EXEC_PATH}
1321 else # normal case, use ../bin-wrappers only unless $with_dashes:
1322         if test -n "$no_bin_wrappers"
1323         then
1324                 with_dashes=t
1325         else
1326                 git_bin_dir="$GIT_BUILD_DIR/bin-wrappers"
1327                 if ! test -x "$git_bin_dir/git"
1328                 then
1329                         if test -z "$with_dashes"
1330                         then
1331                                 say "$git_bin_dir/git is not executable; using GIT_EXEC_PATH"
1332                         fi
1333                         with_dashes=t
1334                 fi
1335                 PATH="$git_bin_dir:$PATH"
1336         fi
1337         GIT_EXEC_PATH=$GIT_BUILD_DIR
1338         if test -n "$with_dashes"
1339         then
1340                 PATH="$GIT_BUILD_DIR:$GIT_BUILD_DIR/t/helper:$PATH"
1341         fi
1342 fi
1343 GIT_TEMPLATE_DIR="$GIT_BUILD_DIR"/templates/blt
1344 GIT_CONFIG_NOSYSTEM=1
1345 GIT_ATTR_NOSYSTEM=1
1346 export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG_NOSYSTEM GIT_ATTR_NOSYSTEM
1347
1348 if test -z "$GIT_TEST_CMP"
1349 then
1350         if test -n "$GIT_TEST_CMP_USE_COPIED_CONTEXT"
1351         then
1352                 GIT_TEST_CMP="$DIFF -c"
1353         else
1354                 GIT_TEST_CMP="$DIFF -u"
1355         fi
1356 fi
1357
1358 GITPERLLIB="$GIT_BUILD_DIR"/perl/build/lib
1359 export GITPERLLIB
1360 test -d "$GIT_BUILD_DIR"/templates/blt || {
1361         error "You haven't built things yet, have you?"
1362 }
1363
1364 if ! test -x "$GIT_BUILD_DIR"/t/helper/test-tool$X
1365 then
1366         echo >&2 'You need to build test-tool:'
1367         echo >&2 'Run "make t/helper/test-tool" in the source (toplevel) directory'
1368         exit 1
1369 fi
1370
1371 # Test repository
1372 rm -fr "$TRASH_DIRECTORY" || {
1373         GIT_EXIT_OK=t
1374         echo >&5 "FATAL: Cannot prepare test area"
1375         exit 1
1376 }
1377
1378 HOME="$TRASH_DIRECTORY"
1379 GNUPGHOME="$HOME/gnupg-home-not-used"
1380 export HOME GNUPGHOME
1381
1382 if test -z "$TEST_NO_CREATE_REPO"
1383 then
1384         test_create_repo "$TRASH_DIRECTORY"
1385 else
1386         mkdir -p "$TRASH_DIRECTORY"
1387 fi
1388
1389 # Use -P to resolve symlinks in our working directory so that the cwd
1390 # in subprocesses like git equals our $PWD (for pathname comparisons).
1391 cd -P "$TRASH_DIRECTORY" || exit 1
1392
1393 this_test=${0##*/}
1394 this_test=${this_test%%-*}
1395 if match_pattern_list "$this_test" $GIT_SKIP_TESTS
1396 then
1397         say_color info >&3 "skipping test $this_test altogether"
1398         skip_all="skip all tests in $this_test"
1399         test_done
1400 fi
1401
1402 if test -n "$write_junit_xml"
1403 then
1404         junit_xml_dir="$TEST_OUTPUT_DIRECTORY/out"
1405         mkdir -p "$junit_xml_dir"
1406         junit_xml_base=${0##*/}
1407         junit_xml_path="$junit_xml_dir/TEST-${junit_xml_base%.sh}.xml"
1408         junit_attrs="name=\"${junit_xml_base%.sh}\""
1409         junit_attrs="$junit_attrs timestamp=\"$(TZ=UTC \
1410                 date +%Y-%m-%dT%H:%M:%S)\""
1411         write_junit_xml --truncate "<testsuites>" "  <testsuite $junit_attrs>"
1412         junit_suite_start=$(test-tool date getnanos)
1413         if test -n "$GIT_TEST_TEE_OUTPUT_FILE"
1414         then
1415                 GIT_TEST_TEE_OFFSET=0
1416         fi
1417 fi
1418
1419 # Convenience
1420 # A regexp to match 5, 35 and 40 hexdigits
1421 _x05='[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
1422 _x35="$_x05$_x05$_x05$_x05$_x05$_x05$_x05"
1423 _x40="$_x35$_x05"
1424
1425 test_oid_init
1426
1427 ZERO_OID=$(test_oid zero)
1428 OID_REGEX=$(echo $ZERO_OID | sed -e 's/0/[0-9a-f]/g')
1429 EMPTY_TREE=$(test_oid empty_tree)
1430 EMPTY_BLOB=$(test_oid empty_blob)
1431 _z40=$ZERO_OID
1432
1433 # Provide an implementation of the 'yes' utility; the upper bound
1434 # limit is there to help Windows that cannot stop this loop from
1435 # wasting cycles when the downstream stops reading, so do not be
1436 # tempted to turn it into an infinite loop. cf. 6129c930 ("test-lib:
1437 # limit the output of the yes utility", 2016-02-02)
1438 yes () {
1439         if test $# = 0
1440         then
1441                 y=y
1442         else
1443                 y="$*"
1444         fi
1445
1446         i=0
1447         while test $i -lt 99
1448         do
1449                 echo "$y"
1450                 i=$(($i+1))
1451         done
1452 }
1453
1454 # The GIT_TEST_FAIL_PREREQS code hooks into test_set_prereq(), and
1455 # thus needs to be set up really early, and set an internal variable
1456 # for convenience so the hot test_set_prereq() codepath doesn't need
1457 # to call "git env--helper" (via test_bool_env). Only do that work
1458 # if needed by seeing if GIT_TEST_FAIL_PREREQS is set at all.
1459 GIT_TEST_FAIL_PREREQS_INTERNAL=
1460 if test -n "$GIT_TEST_FAIL_PREREQS"
1461 then
1462         if test_bool_env GIT_TEST_FAIL_PREREQS false
1463         then
1464                 GIT_TEST_FAIL_PREREQS_INTERNAL=true
1465                 test_set_prereq FAIL_PREREQS
1466         fi
1467 else
1468         test_lazy_prereq FAIL_PREREQS '
1469                 test_bool_env GIT_TEST_FAIL_PREREQS false
1470         '
1471 fi
1472
1473 # Fix some commands on Windows, and other OS-specific things
1474 uname_s=$(uname -s)
1475 case $uname_s in
1476 *MINGW*)
1477         # Windows has its own (incompatible) sort and find
1478         sort () {
1479                 /usr/bin/sort "$@"
1480         }
1481         find () {
1482                 /usr/bin/find "$@"
1483         }
1484         # git sees Windows-style pwd
1485         pwd () {
1486                 builtin pwd -W
1487         }
1488         # no POSIX permissions
1489         # backslashes in pathspec are converted to '/'
1490         # exec does not inherit the PID
1491         test_set_prereq MINGW
1492         test_set_prereq NATIVE_CRLF
1493         test_set_prereq SED_STRIPS_CR
1494         test_set_prereq GREP_STRIPS_CR
1495         GIT_TEST_CMP=mingw_test_cmp
1496         ;;
1497 *CYGWIN*)
1498         test_set_prereq POSIXPERM
1499         test_set_prereq EXECKEEPSPID
1500         test_set_prereq CYGWIN
1501         test_set_prereq SED_STRIPS_CR
1502         test_set_prereq GREP_STRIPS_CR
1503         ;;
1504 FreeBSD)
1505         test_set_prereq REGEX_ILLSEQ
1506         test_set_prereq POSIXPERM
1507         test_set_prereq BSLASHPSPEC
1508         test_set_prereq EXECKEEPSPID
1509         ;;
1510 *)
1511         test_set_prereq POSIXPERM
1512         test_set_prereq BSLASHPSPEC
1513         test_set_prereq EXECKEEPSPID
1514         ;;
1515 esac
1516
1517 ( COLUMNS=1 && test $COLUMNS = 1 ) && test_set_prereq COLUMNS_CAN_BE_1
1518 test -z "$NO_PERL" && test_set_prereq PERL
1519 test -z "$NO_PTHREADS" && test_set_prereq PTHREADS
1520 test -z "$NO_PYTHON" && test_set_prereq PYTHON
1521 test -n "$USE_LIBPCRE1$USE_LIBPCRE2" && test_set_prereq PCRE
1522 test -n "$USE_LIBPCRE1" && test_set_prereq LIBPCRE1
1523 test -n "$USE_LIBPCRE2" && test_set_prereq LIBPCRE2
1524 test -z "$NO_GETTEXT" && test_set_prereq GETTEXT
1525
1526 if test -n "$GIT_TEST_GETTEXT_POISON_ORIG"
1527 then
1528         GIT_TEST_GETTEXT_POISON=$GIT_TEST_GETTEXT_POISON_ORIG
1529         export GIT_TEST_GETTEXT_POISON
1530         unset GIT_TEST_GETTEXT_POISON_ORIG
1531 fi
1532
1533 test_lazy_prereq C_LOCALE_OUTPUT '
1534         ! test_bool_env GIT_TEST_GETTEXT_POISON false
1535 '
1536
1537 if test -z "$GIT_TEST_CHECK_CACHE_TREE"
1538 then
1539         GIT_TEST_CHECK_CACHE_TREE=true
1540         export GIT_TEST_CHECK_CACHE_TREE
1541 fi
1542
1543 test_lazy_prereq PIPE '
1544         # test whether the filesystem supports FIFOs
1545         test_have_prereq !MINGW,!CYGWIN &&
1546         rm -f testfifo && mkfifo testfifo
1547 '
1548
1549 test_lazy_prereq SYMLINKS '
1550         # test whether the filesystem supports symbolic links
1551         ln -s x y && test -h y
1552 '
1553
1554 test_lazy_prereq FILEMODE '
1555         test "$(git config --bool core.filemode)" = true
1556 '
1557
1558 test_lazy_prereq CASE_INSENSITIVE_FS '
1559         echo good >CamelCase &&
1560         echo bad >camelcase &&
1561         test "$(cat CamelCase)" != good
1562 '
1563
1564 test_lazy_prereq FUNNYNAMES '
1565         test_have_prereq !MINGW &&
1566         touch -- \
1567                 "FUNNYNAMES tab embedded" \
1568                 "FUNNYNAMES \"quote embedded\"" \
1569                 "FUNNYNAMES newline
1570 embedded" 2>/dev/null &&
1571         rm -- \
1572                 "FUNNYNAMES tab embedded" \
1573                 "FUNNYNAMES \"quote embedded\"" \
1574                 "FUNNYNAMES newline
1575 embedded" 2>/dev/null
1576 '
1577
1578 test_lazy_prereq UTF8_NFD_TO_NFC '
1579         # check whether FS converts nfd unicode to nfc
1580         auml=$(printf "\303\244")
1581         aumlcdiar=$(printf "\141\314\210")
1582         >"$auml" &&
1583         test -f "$aumlcdiar"
1584 '
1585
1586 test_lazy_prereq AUTOIDENT '
1587         sane_unset GIT_AUTHOR_NAME &&
1588         sane_unset GIT_AUTHOR_EMAIL &&
1589         git var GIT_AUTHOR_IDENT
1590 '
1591
1592 test_lazy_prereq EXPENSIVE '
1593         test -n "$GIT_TEST_LONG"
1594 '
1595
1596 test_lazy_prereq EXPENSIVE_ON_WINDOWS '
1597         test_have_prereq EXPENSIVE || test_have_prereq !MINGW,!CYGWIN
1598 '
1599
1600 test_lazy_prereq USR_BIN_TIME '
1601         test -x /usr/bin/time
1602 '
1603
1604 test_lazy_prereq NOT_ROOT '
1605         uid=$(id -u) &&
1606         test "$uid" != 0
1607 '
1608
1609 test_lazy_prereq JGIT '
1610         jgit --version
1611 '
1612
1613 # SANITY is about "can you correctly predict what the filesystem would
1614 # do by only looking at the permission bits of the files and
1615 # directories?"  A typical example of !SANITY is running the test
1616 # suite as root, where a test may expect "chmod -r file && cat file"
1617 # to fail because file is supposed to be unreadable after a successful
1618 # chmod.  In an environment (i.e. combination of what filesystem is
1619 # being used and who is running the tests) that lacks SANITY, you may
1620 # be able to delete or create a file when the containing directory
1621 # doesn't have write permissions, or access a file even if the
1622 # containing directory doesn't have read or execute permissions.
1623
1624 test_lazy_prereq SANITY '
1625         mkdir SANETESTD.1 SANETESTD.2 &&
1626
1627         chmod +w SANETESTD.1 SANETESTD.2 &&
1628         >SANETESTD.1/x 2>SANETESTD.2/x &&
1629         chmod -w SANETESTD.1 &&
1630         chmod -r SANETESTD.1/x &&
1631         chmod -rx SANETESTD.2 ||
1632         BUG "cannot prepare SANETESTD"
1633
1634         ! test -r SANETESTD.1/x &&
1635         ! rm SANETESTD.1/x && ! test -f SANETESTD.2/x
1636         status=$?
1637
1638         chmod +rwx SANETESTD.1 SANETESTD.2 &&
1639         rm -rf SANETESTD.1 SANETESTD.2 ||
1640         BUG "cannot clean SANETESTD"
1641         return $status
1642 '
1643
1644 test FreeBSD != $uname_s || GIT_UNZIP=${GIT_UNZIP:-/usr/local/bin/unzip}
1645 GIT_UNZIP=${GIT_UNZIP:-unzip}
1646 test_lazy_prereq UNZIP '
1647         "$GIT_UNZIP" -v
1648         test $? -ne 127
1649 '
1650
1651 run_with_limited_cmdline () {
1652         (ulimit -s 128 && "$@")
1653 }
1654
1655 test_lazy_prereq CMDLINE_LIMIT '
1656         test_have_prereq !MINGW,!CYGWIN &&
1657         run_with_limited_cmdline true
1658 '
1659
1660 run_with_limited_stack () {
1661         (ulimit -s 128 && "$@")
1662 }
1663
1664 test_lazy_prereq ULIMIT_STACK_SIZE '
1665         test_have_prereq !MINGW,!CYGWIN &&
1666         run_with_limited_stack true
1667 '
1668
1669 build_option () {
1670         git version --build-options |
1671         sed -ne "s/^$1: //p"
1672 }
1673
1674 test_lazy_prereq LONG_IS_64BIT '
1675         test 8 -le "$(build_option sizeof-long)"
1676 '
1677
1678 test_lazy_prereq TIME_IS_64BIT 'test-tool date is64bit'
1679 test_lazy_prereq TIME_T_IS_64BIT 'test-tool date time_t-is64bit'
1680
1681 test_lazy_prereq CURL '
1682         curl --version
1683 '
1684
1685 # SHA1 is a test if the hash algorithm in use is SHA-1.  This is both for tests
1686 # which will not work with other hash algorithms and tests that work but don't
1687 # test anything meaningful (e.g. special values which cause short collisions).
1688 test_lazy_prereq SHA1 '
1689         test $(git hash-object /dev/null) = e69de29bb2d1d6434b8b29ae775ad8c2e48c5391
1690 '
1691
1692 test_lazy_prereq REBASE_P '
1693         test -z "$GIT_TEST_SKIP_REBASE_P"
1694 '