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