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

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