t/test-lib.sh

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