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