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 # Keep the original TERM for say_color
  19 ORIGINAL_TERM=$TERM
  20
  21 # Test the binaries we have just built.  The tests are kept in
  22 # t/ subdirectory and are run in 'trash directory' subdirectory.
  23 if test -z "$TEST_DIRECTORY"
  24 then
  25         # We allow tests to override this, in case they want to run tests
  26         # outside of t/, e.g. for running tests on the test library
  27         # itself.
  28         TEST_DIRECTORY=$(pwd)
  29 else
  30         # ensure that TEST_DIRECTORY is an absolute path so that it
  31         # is valid even if the current working directory is changed
  32         TEST_DIRECTORY=$(cd "$TEST_DIRECTORY" && pwd) || exit 1
  33 fi
  34 if test -z "$TEST_OUTPUT_DIRECTORY"
  35 then
  36         # Similarly, override this to store the test-results subdir
  37         # elsewhere
  38         TEST_OUTPUT_DIRECTORY=$TEST_DIRECTORY
  39 fi
  40 GIT_BUILD_DIR="$TEST_DIRECTORY"/..
  41
  42 ################################################################
  43 # It appears that people try to run tests without building...
  44 "$GIT_BUILD_DIR/git" >/dev/null
  45 if test $? != 1
  46 then
  47         echo >&2 'error: you do not seem to have built git yet.'
  48         exit 1
  49 fi
  50
  51 . "$GIT_BUILD_DIR"/GIT-BUILD-OPTIONS
  52 export PERL_PATH SHELL_PATH
  53
  54 # if --tee was passed, write the output not only to the terminal, but
  55 # additionally to the file test-results/$BASENAME.out, too.
  56 case "$GIT_TEST_TEE_STARTED, $* " in
  57 done,*)
  58         # do not redirect again
  59         ;;
  60 *' --tee '*|*' --va'*)
  61         mkdir -p "$TEST_OUTPUT_DIRECTORY/test-results"
  62         BASE="$TEST_OUTPUT_DIRECTORY/test-results/$(basename "$0" .sh)"
  63         (GIT_TEST_TEE_STARTED=done ${SHELL_PATH} "$0" "$@" 2>&1;
  64          echo $? > $BASE.exit) | tee $BASE.out
  65         test "$(cat $BASE.exit)" = 0
  66         exit
  67         ;;
  68 esac
  69
  70 # For repeatability, reset the environment to known value.
  71 LANG=C
  72 LC_ALL=C
  73 PAGER=cat
  74 TZ=UTC
  75 TERM=dumb
  76 export LANG LC_ALL PAGER TERM TZ
  77 EDITOR=:
  78 # A call to "unset" with no arguments causes at least Solaris 10
  79 # /usr/xpg4/bin/sh and /bin/ksh to bail out.  So keep the unsets
  80 # deriving from the command substitution clustered with the other
  81 # ones.
  82 unset VISUAL EMAIL LANGUAGE COLUMNS $("$PERL_PATH" -e '
  83         my @env = keys %ENV;
  84         my $ok = join("|", qw(
  85                 TRACE
  86                 DEBUG
  87                 USE_LOOKUP
  88                 TEST
  89                 .*_TEST
  90                 PROVE
  91                 VALGRIND
  92                 UNZIP
  93                 PERF_
  94                 CURL_VERBOSE
  95         ));
  96         my @vars = grep(/^GIT_/ && !/^GIT_($ok)/o, @env);
  97         print join("\n", @vars);
  98 ')
  99 unset XDG_CONFIG_HOME
 100 unset GITPERLLIB
 101 GIT_AUTHOR_EMAIL=author@example.com
 102 GIT_AUTHOR_NAME='A U Thor'
 103 GIT_COMMITTER_EMAIL=committer@example.com
 104 GIT_COMMITTER_NAME='C O Mitter'
 105 GIT_MERGE_VERBOSITY=5
 106 GIT_MERGE_AUTOEDIT=no
 107 export GIT_MERGE_VERBOSITY GIT_MERGE_AUTOEDIT
 108 export GIT_AUTHOR_EMAIL GIT_AUTHOR_NAME
 109 export GIT_COMMITTER_EMAIL GIT_COMMITTER_NAME
 110 export EDITOR
 111
 112 # Tests using GIT_TRACE typically don't want <timestamp> <file>:<line> output
 113 GIT_TRACE_BARE=1
 114 export GIT_TRACE_BARE
 115
 116 if test -n "${TEST_GIT_INDEX_VERSION:+isset}"
 117 then
 118         GIT_INDEX_VERSION="$TEST_GIT_INDEX_VERSION"
 119         export GIT_INDEX_VERSION
 120 fi
 121
 122 # Add libc MALLOC and MALLOC_PERTURB test
 123 # only if we are not executing the test with valgrind
 124 if expr " $GIT_TEST_OPTS " : ".* --valgrind " >/dev/null ||
 125    test -n "$TEST_NO_MALLOC_CHECK"
 126 then
 127         setup_malloc_check () {
 128                 : nothing
 129         }
 130         teardown_malloc_check () {
 131                 : nothing
 132         }
 133 else
 134         setup_malloc_check () {
 135                 MALLOC_CHECK_=3 MALLOC_PERTURB_=165
 136                 export MALLOC_CHECK_ MALLOC_PERTURB_
 137         }
 138         teardown_malloc_check () {
 139                 unset MALLOC_CHECK_ MALLOC_PERTURB_
 140         }
 141 fi
 142
 143 # Protect ourselves from common misconfiguration to export
 144 # CDPATH into the environment
 145 unset CDPATH
 146
 147 unset GREP_OPTIONS
 148 unset UNZIP
 149
 150 case $(echo $GIT_TRACE |tr "[A-Z]" "[a-z]") in
 151 1|2|true)
 152         echo "* warning: Some tests will not work if GIT_TRACE" \
 153                 "is set as to trace on STDERR ! *"
 154         echo "* warning: Please set GIT_TRACE to something" \
 155                 "other than 1, 2 or true ! *"
 156         ;;
 157 esac
 158
 159 # Convenience
 160 #
 161 # A regexp to match 5 and 40 hexdigits
 162 _x05='[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
 163 _x40="$_x05$_x05$_x05$_x05$_x05$_x05$_x05$_x05"
 164
 165 # Zero SHA-1
 166 _z40=0000000000000000000000000000000000000000
 167
 168 # Line feed
 169 LF='
 170 '
 171
 172 export _x05 _x40 _z40 LF
 173
 174 # Each test should start with something like this, after copyright notices:
 175 #
 176 # test_description='Description of this test...
 177 # This test checks if command xyzzy does the right thing...
 178 # '
 179 # . ./test-lib.sh
 180 [ "x$ORIGINAL_TERM" != "xdumb" ] && (
 181                 TERM=$ORIGINAL_TERM &&
 182                 export TERM &&
 183                 [ -t 1 ] &&
 184                 tput bold >/dev/null 2>&1 &&
 185                 tput setaf 1 >/dev/null 2>&1 &&
 186                 tput sgr0 >/dev/null 2>&1
 187         ) &&
 188         color=t
 189
 190 while test "$#" -ne 0
 191 do
 192         case "$1" in
 193         -d|--d|--de|--deb|--debu|--debug)
 194                 debug=t; shift ;;
 195         -i|--i|--im|--imm|--imme|--immed|--immedi|--immedia|--immediat|--immediate)
 196                 immediate=t; shift ;;
 197         -l|--l|--lo|--lon|--long|--long-|--long-t|--long-te|--long-tes|--long-test|--long-tests)
 198                 GIT_TEST_LONG=t; export GIT_TEST_LONG; shift ;;
 199         -r)
 200                 shift; test "$#" -ne 0 || {
 201                         echo 'error: -r requires an argument' >&2;
 202                         exit 1;
 203                 }
 204                 run_list=$1; shift ;;
 205         --run=*)
 206                 run_list=$(expr "z$1" : 'z[^=]*=\(.*\)'); shift ;;
 207         -h|--h|--he|--hel|--help)
 208                 help=t; shift ;;
 209         -v|--v|--ve|--ver|--verb|--verbo|--verbos|--verbose)
 210                 verbose=t; shift ;;
 211         --verbose-only=*)
 212                 verbose_only=$(expr "z$1" : 'z[^=]*=\(.*\)')
 213                 shift ;;
 214         -q|--q|--qu|--qui|--quie|--quiet)
 215                 # Ignore --quiet under a TAP::Harness. Saying how many tests
 216                 # passed without the ok/not ok details is always an error.
 217                 test -z "$HARNESS_ACTIVE" && quiet=t; shift ;;
 218         --with-dashes)
 219                 with_dashes=t; shift ;;
 220         --no-color)
 221                 color=; shift ;;
 222         --va|--val|--valg|--valgr|--valgri|--valgrin|--valgrind)
 223                 valgrind=memcheck
 224                 shift ;;
 225         --valgrind=*)
 226                 valgrind=$(expr "z$1" : 'z[^=]*=\(.*\)')
 227                 shift ;;
 228         --valgrind-only=*)
 229                 valgrind_only=$(expr "z$1" : 'z[^=]*=\(.*\)')
 230                 shift ;;
 231         --tee)
 232                 shift ;; # was handled already
 233         --root=*)
 234                 root=$(expr "z$1" : 'z[^=]*=\(.*\)')
 235                 shift ;;
 236         *)
 237                 echo "error: unknown test option '$1'" >&2; exit 1 ;;
 238         esac
 239 done
 240
 241 if test -n "$valgrind_only"
 242 then
 243         test -z "$valgrind" && valgrind=memcheck
 244         test -z "$verbose" && verbose_only="$valgrind_only"
 245 elif test -n "$valgrind"
 246 then
 247         verbose=t
 248 fi
 249
 250 if test -n "$color"
 251 then
 252         say_color () {
 253                 (
 254                 TERM=$ORIGINAL_TERM
 255                 export TERM
 256                 case "$1" in
 257                 error)
 258                         tput bold; tput setaf 1;; # bold red
 259                 skip)
 260                         tput setaf 4;; # blue
 261                 warn)
 262                         tput setaf 3;; # brown/yellow
 263                 pass)
 264                         tput setaf 2;; # green
 265                 info)
 266                         tput setaf 6;; # cyan
 267                 *)
 268                         test -n "$quiet" && return;;
 269                 esac
 270                 shift
 271                 printf "%s" "$*"
 272                 tput sgr0
 273                 echo
 274                 )
 275         }
 276 else
 277         say_color() {
 278                 test -z "$1" && test -n "$quiet" && return
 279                 shift
 280                 printf "%s\n" "$*"
 281         }
 282 fi
 283
 284 error () {
 285         say_color error "error: $*"
 286         GIT_EXIT_OK=t
 287         exit 1
 288 }
 289
 290 say () {
 291         say_color info "$*"
 292 }
 293
 294 test "${test_description}" != "" ||
 295 error "Test script did not set test_description."
 296
 297 if test "$help" = "t"
 298 then
 299         printf '%s\n' "$test_description"
 300         exit 0
 301 fi
 302
 303 exec 5>&1
 304 exec 6<&0
 305 if test "$verbose" = "t"
 306 then
 307         exec 4>&2 3>&1
 308 else
 309         exec 4>/dev/null 3>/dev/null
 310 fi
 311
 312 test_failure=0
 313 test_count=0
 314 test_fixed=0
 315 test_broken=0
 316 test_success=0
 317
 318 test_external_has_tap=0
 319
 320 die () {
 321         code=$?
 322         if test -n "$GIT_EXIT_OK"
 323         then
 324                 exit $code
 325         else
 326                 echo >&5 "FATAL: Unexpected exit with code $code"
 327                 exit 1
 328         fi
 329 }
 330
 331 GIT_EXIT_OK=
 332 trap 'die' EXIT
 333
 334 # The user-facing functions are loaded from a separate file so that
 335 # test_perf subshells can have them too
 336 . "$TEST_DIRECTORY/test-lib-functions.sh"
 337
 338 # You are not expected to call test_ok_ and test_failure_ directly, use
 339 # the test_expect_* functions instead.
 340
 341 test_ok_ () {
 342         test_success=$(($test_success + 1))
 343         say_color "" "ok $test_count - $@"
 344 }
 345
 346 test_failure_ () {
 347         test_failure=$(($test_failure + 1))
 348         say_color error "not ok $test_count - $1"
 349         shift
 350         printf '%s\n' "$*" | sed -e 's/^/#      /'
 351         test "$immediate" = "" || { GIT_EXIT_OK=t; exit 1; }
 352 }
 353
 354 test_known_broken_ok_ () {
 355         test_fixed=$(($test_fixed+1))
 356         say_color error "ok $test_count - $@ # TODO known breakage vanished"
 357 }
 358
 359 test_known_broken_failure_ () {
 360         test_broken=$(($test_broken+1))
 361         say_color warn "not ok $test_count - $@ # TODO known breakage"
 362 }
 363
 364 test_debug () {
 365         test "$debug" = "" || eval "$1"
 366 }
 367
 368 match_pattern_list () {
 369         arg="$1"
 370         shift
 371         test -z "$*" && return 1
 372         for pattern_
 373         do
 374                 case "$arg" in
 375                 $pattern_)
 376                         return 0
 377                 esac
 378         done
 379         return 1
 380 }
 381
 382 match_test_selector_list () {
 383         title="$1"
 384         shift
 385         arg="$1"
 386         shift
 387         test -z "$1" && return 0
 388
 389         # Both commas and whitespace are accepted as separators.
 390         OLDIFS=$IFS
 391         IFS='   ,'
 392         set -- $1
 393         IFS=$OLDIFS
 394
 395         # If the first selector is negative we include by default.
 396         include=
 397         case "$1" in
 398                 !*) include=t ;;
 399         esac
 400
 401         for selector
 402         do
 403                 orig_selector=$selector
 404
 405                 positive=t
 406                 case "$selector" in
 407                         !*)
 408                                 positive=
 409                                 selector=${selector##?}
 410                                 ;;
 411                 esac
 412
 413                 test -z "$selector" && continue
 414
 415                 case "$selector" in
 416                         *-*)
 417                                 if expr "z${selector%%-*}" : "z[0-9]*[^0-9]" >/dev/null
 418                                 then
 419                                         echo "error: $title: invalid non-numeric in range" \
 420                                                 "start: '$orig_selector'" >&2
 421                                         exit 1
 422                                 fi
 423                                 if expr "z${selector#*-}" : "z[0-9]*[^0-9]" >/dev/null
 424                                 then
 425                                         echo "error: $title: invalid non-numeric in range" \
 426                                                 "end: '$orig_selector'" >&2
 427                                         exit 1
 428                                 fi
 429                                 ;;
 430                         *)
 431                                 if expr "z$selector" : "z[0-9]*[^0-9]" >/dev/null
 432                                 then
 433                                         echo "error: $title: invalid non-numeric in test" \
 434                                                 "selector: '$orig_selector'" >&2
 435                                         exit 1
 436                                 fi
 437                 esac
 438
 439                 # Short cut for "obvious" cases
 440                 test -z "$include" && test -z "$positive" && continue
 441                 test -n "$include" && test -n "$positive" && continue
 442
 443                 case "$selector" in
 444                         -*)
 445                                 if test $arg -le ${selector#-}
 446                                 then
 447                                         include=$positive
 448                                 fi
 449                                 ;;
 450                         *-)
 451                                 if test $arg -ge ${selector%-}
 452                                 then
 453                                         include=$positive
 454                                 fi
 455                                 ;;
 456                         *-*)
 457                                 if test ${selector%%-*} -le $arg \
 458                                         && test $arg -le ${selector#*-}
 459                                 then
 460                                         include=$positive
 461                                 fi
 462                                 ;;
 463                         *)
 464                                 if test $arg -eq $selector
 465                                 then
 466                                         include=$positive
 467                                 fi
 468                                 ;;
 469                 esac
 470         done
 471
 472         test -n "$include"
 473 }
 474
 475 maybe_teardown_verbose () {
 476         test -z "$verbose_only" && return
 477         exec 4>/dev/null 3>/dev/null
 478         verbose=
 479 }
 480
 481 last_verbose=t
 482 maybe_setup_verbose () {
 483         test -z "$verbose_only" && return
 484         if match_pattern_list $test_count $verbose_only
 485         then
 486                 exec 4>&2 3>&1
 487                 # Emit a delimiting blank line when going from
 488                 # non-verbose to verbose.  Within verbose mode the
 489                 # delimiter is printed by test_expect_*.  The choice
 490                 # of the initial $last_verbose is such that before
 491                 # test 1, we do not print it.
 492                 test -z "$last_verbose" && echo >&3 ""
 493                 verbose=t
 494         else
 495                 exec 4>/dev/null 3>/dev/null
 496                 verbose=
 497         fi
 498         last_verbose=$verbose
 499 }
 500
 501 maybe_teardown_valgrind () {
 502         test -z "$GIT_VALGRIND" && return
 503         GIT_VALGRIND_ENABLED=
 504 }
 505
 506 maybe_setup_valgrind () {
 507         test -z "$GIT_VALGRIND" && return
 508         if test -z "$valgrind_only"
 509         then
 510                 GIT_VALGRIND_ENABLED=t
 511                 return
 512         fi
 513         GIT_VALGRIND_ENABLED=
 514         if match_pattern_list $test_count $valgrind_only
 515         then
 516                 GIT_VALGRIND_ENABLED=t
 517         fi
 518 }
 519
 520 test_eval_ () {
 521         # This is a separate function because some tests use
 522         # "return" to end a test_expect_success block early.
 523         if command -v test_eval_override >/dev/null 2>&1
 524         then
 525                 test_eval_override "$*"
 526         else
 527                 eval "$*"
 528         fi </dev/null >&3 2>&4
 529 }
 530
 531 test_run_ () {
 532         test_cleanup=:
 533         expecting_failure=$2
 534         setup_malloc_check
 535         test_eval_ "$1"
 536         eval_ret=$?
 537         teardown_malloc_check
 538
 539         if test -z "$immediate" || test $eval_ret = 0 || test -n "$expecting_failure"
 540         then
 541                 setup_malloc_check
 542                 test_eval_ "$test_cleanup"
 543                 teardown_malloc_check
 544         fi
 545         if test "$verbose" = "t" && test -n "$HARNESS_ACTIVE"
 546         then
 547                 echo ""
 548         fi
 549         return "$eval_ret"
 550 }
 551
 552 test_start_ () {
 553         test_count=$(($test_count+1))
 554         maybe_setup_verbose
 555         maybe_setup_valgrind
 556 }
 557
 558 test_finish_ () {
 559         echo >&3 ""
 560         maybe_teardown_valgrind
 561         maybe_teardown_verbose
 562 }
 563
 564 test_skip () {
 565         to_skip=
 566         skipped_reason=
 567         if match_pattern_list $this_test.$test_count $GIT_SKIP_TESTS
 568         then
 569                 to_skip=t
 570                 skipped_reason="GIT_SKIP_TESTS"
 571         fi
 572         if test -z "$to_skip" && test -n "$test_prereq" &&
 573            ! test_have_prereq "$test_prereq"
 574         then
 575                 to_skip=t
 576
 577                 of_prereq=
 578                 if test "$missing_prereq" != "$test_prereq"
 579                 then
 580                         of_prereq=" of $test_prereq"
 581                 fi
 582                 skipped_reason="missing $missing_prereq${of_prereq}"
 583         fi
 584         if test -z "$to_skip" && test -n "$run_list" &&
 585                 ! match_test_selector_list '--run' $test_count "$run_list"
 586         then
 587                 to_skip=t
 588                 skipped_reason="--run"
 589         fi
 590
 591         case "$to_skip" in
 592         t)
 593                 say_color skip >&3 "skipping test: $@"
 594                 say_color skip "ok $test_count # skip $1 ($skipped_reason)"
 595                 : true
 596                 ;;
 597         *)
 598                 false
 599                 ;;
 600         esac
 601 }
 602
 603 # stub; perf-lib overrides it
 604 test_at_end_hook_ () {
 605         :
 606 }
 607
 608 test_done () {
 609         GIT_EXIT_OK=t
 610
 611         if test -z "$HARNESS_ACTIVE"
 612         then
 613                 test_results_dir="$TEST_OUTPUT_DIRECTORY/test-results"
 614                 mkdir -p "$test_results_dir"
 615                 base=${0##*/}
 616                 test_results_path="$test_results_dir/${base%.sh}-$$.counts"
 617
 618                 cat >>"$test_results_path" <<-EOF
 619                 total $test_count
 620                 success $test_success
 621                 fixed $test_fixed
 622                 broken $test_broken
 623                 failed $test_failure
 624
 625                 EOF
 626         fi
 627
 628         if test "$test_fixed" != 0
 629         then
 630                 say_color error "# $test_fixed known breakage(s) vanished; please update test(s)"
 631         fi
 632         if test "$test_broken" != 0
 633         then
 634                 say_color warn "# still have $test_broken known breakage(s)"
 635         fi
 636         if test "$test_broken" != 0 || test "$test_fixed" != 0
 637         then
 638                 test_remaining=$(( $test_count - $test_broken - $test_fixed ))
 639                 msg="remaining $test_remaining test(s)"
 640         else
 641                 test_remaining=$test_count
 642                 msg="$test_count test(s)"
 643         fi
 644         case "$test_failure" in
 645         0)
 646                 # Maybe print SKIP message
 647                 if test -n "$skip_all" && test $test_count -gt 0
 648                 then
 649                         error "Can't use skip_all after running some tests"
 650                 fi
 651                 [ -z "$skip_all" ] || skip_all=" # SKIP $skip_all"
 652
 653                 if test $test_external_has_tap -eq 0
 654                 then
 655                         if test $test_remaining -gt 0
 656                         then
 657                                 say_color pass "# passed all $msg"
 658                         fi
 659                         say "1..$test_count$skip_all"
 660                 fi
 661
 662                 test -d "$remove_trash" &&
 663                 cd "$(dirname "$remove_trash")" &&
 664                 rm -rf "$(basename "$remove_trash")"
 665
 666                 test_at_end_hook_
 667
 668                 exit 0 ;;
 669
 670         *)
 671                 if test $test_external_has_tap -eq 0
 672                 then
 673                         say_color error "# failed $test_failure among $msg"
 674                         say "1..$test_count"
 675                 fi
 676
 677                 exit 1 ;;
 678
 679         esac
 680 }
 681
 682 if test -n "$valgrind"
 683 then
 684         make_symlink () {
 685                 test -h "$2" &&
 686                 test "$1" = "$(readlink "$2")" || {
 687                         # be super paranoid
 688                         if mkdir "$2".lock
 689                         then
 690                                 rm -f "$2" &&
 691                                 ln -s "$1" "$2" &&
 692                                 rm -r "$2".lock
 693                         else
 694                                 while test -d "$2".lock
 695                                 do
 696                                         say "Waiting for lock on $2."
 697                                         sleep 1
 698                                 done
 699                         fi
 700                 }
 701         }
 702
 703         make_valgrind_symlink () {
 704                 # handle only executables, unless they are shell libraries that
 705                 # need to be in the exec-path.
 706                 test -x "$1" ||
 707                 test "# " = "$(head -c 2 <"$1")" ||
 708                 return;
 709
 710                 base=$(basename "$1")
 711                 symlink_target=$GIT_BUILD_DIR/$base
 712                 # do not override scripts
 713                 if test -x "$symlink_target" &&
 714                     test ! -d "$symlink_target" &&
 715                     test "#!" != "$(head -c 2 < "$symlink_target")"
 716                 then
 717                         symlink_target=../valgrind.sh
 718                 fi
 719                 case "$base" in
 720                 *.sh|*.perl)
 721                         symlink_target=../unprocessed-script
 722                 esac
 723                 # create the link, or replace it if it is out of date
 724                 make_symlink "$symlink_target" "$GIT_VALGRIND/bin/$base" || exit
 725         }
 726
 727         # override all git executables in TEST_DIRECTORY/..
 728         GIT_VALGRIND=$TEST_DIRECTORY/valgrind
 729         mkdir -p "$GIT_VALGRIND"/bin
 730         for file in $GIT_BUILD_DIR/git* $GIT_BUILD_DIR/test-*
 731         do
 732                 make_valgrind_symlink $file
 733         done
 734         # special-case the mergetools loadables
 735         make_symlink "$GIT_BUILD_DIR"/mergetools "$GIT_VALGRIND/bin/mergetools"
 736         OLDIFS=$IFS
 737         IFS=:
 738         for path in $PATH
 739         do
 740                 ls "$path"/git-* 2> /dev/null |
 741                 while read file
 742                 do
 743                         make_valgrind_symlink "$file"
 744                 done
 745         done
 746         IFS=$OLDIFS
 747         PATH=$GIT_VALGRIND/bin:$PATH
 748         GIT_EXEC_PATH=$GIT_VALGRIND/bin
 749         export GIT_VALGRIND
 750         GIT_VALGRIND_MODE="$valgrind"
 751         export GIT_VALGRIND_MODE
 752         GIT_VALGRIND_ENABLED=t
 753         test -n "$valgrind_only" && GIT_VALGRIND_ENABLED=
 754         export GIT_VALGRIND_ENABLED
 755 elif test -n "$GIT_TEST_INSTALLED"
 756 then
 757         GIT_EXEC_PATH=$($GIT_TEST_INSTALLED/git --exec-path)  ||
 758         error "Cannot run git from $GIT_TEST_INSTALLED."
 759         PATH=$GIT_TEST_INSTALLED:$GIT_BUILD_DIR:$PATH
 760         GIT_EXEC_PATH=${GIT_TEST_EXEC_PATH:-$GIT_EXEC_PATH}
 761 else # normal case, use ../bin-wrappers only unless $with_dashes:
 762         git_bin_dir="$GIT_BUILD_DIR/bin-wrappers"
 763         if ! test -x "$git_bin_dir/git"
 764         then
 765                 if test -z "$with_dashes"
 766                 then
 767                         say "$git_bin_dir/git is not executable; using GIT_EXEC_PATH"
 768                 fi
 769                 with_dashes=t
 770         fi
 771         PATH="$git_bin_dir:$PATH"
 772         GIT_EXEC_PATH=$GIT_BUILD_DIR
 773         if test -n "$with_dashes"
 774         then
 775                 PATH="$GIT_BUILD_DIR:$PATH"
 776         fi
 777 fi
 778 GIT_TEMPLATE_DIR="$GIT_BUILD_DIR"/templates/blt
 779 GIT_CONFIG_NOSYSTEM=1
 780 GIT_ATTR_NOSYSTEM=1
 781 export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG_NOSYSTEM GIT_ATTR_NOSYSTEM
 782
 783 if test -z "$GIT_TEST_CMP"
 784 then
 785         if test -n "$GIT_TEST_CMP_USE_COPIED_CONTEXT"
 786         then
 787                 GIT_TEST_CMP="$DIFF -c"
 788         else
 789                 GIT_TEST_CMP="$DIFF -u"
 790         fi
 791 fi
 792
 793 GITPERLLIB="$GIT_BUILD_DIR"/perl/blib/lib:"$GIT_BUILD_DIR"/perl/blib/arch/auto/Git
 794 export GITPERLLIB
 795 test -d "$GIT_BUILD_DIR"/templates/blt || {
 796         error "You haven't built things yet, have you?"
 797 }
 798
 799 if ! test -x "$GIT_BUILD_DIR"/test-chmtime
 800 then
 801         echo >&2 'You need to build test-chmtime:'
 802         echo >&2 'Run "make test-chmtime" in the source (toplevel) directory'
 803         exit 1
 804 fi
 805
 806 # Test repository
 807 TRASH_DIRECTORY="trash directory.$(basename "$0" .sh)"
 808 test -n "$root" && TRASH_DIRECTORY="$root/$TRASH_DIRECTORY"
 809 case "$TRASH_DIRECTORY" in
 810 /*) ;; # absolute path is good
 811  *) TRASH_DIRECTORY="$TEST_OUTPUT_DIRECTORY/$TRASH_DIRECTORY" ;;
 812 esac
 813 test ! -z "$debug" || remove_trash=$TRASH_DIRECTORY
 814 rm -fr "$TRASH_DIRECTORY" || {
 815         GIT_EXIT_OK=t
 816         echo >&5 "FATAL: Cannot prepare test area"
 817         exit 1
 818 }
 819
 820 HOME="$TRASH_DIRECTORY"
 821 export HOME
 822
 823 if test -z "$TEST_NO_CREATE_REPO"
 824 then
 825         test_create_repo "$TRASH_DIRECTORY"
 826 else
 827         mkdir -p "$TRASH_DIRECTORY"
 828 fi
 829 # Use -P to resolve symlinks in our working directory so that the cwd
 830 # in subprocesses like git equals our $PWD (for pathname comparisons).
 831 cd -P "$TRASH_DIRECTORY" || exit 1
 832
 833 this_test=${0##*/}
 834 this_test=${this_test%%-*}
 835 if match_pattern_list "$this_test" $GIT_SKIP_TESTS
 836 then
 837         say_color info >&3 "skipping test $this_test altogether"
 838         skip_all="skip all tests in $this_test"
 839         test_done
 840 fi
 841
 842 # Provide an implementation of the 'yes' utility
 843 yes () {
 844         if test $# = 0
 845         then
 846                 y=y
 847         else
 848                 y="$*"
 849         fi
 850
 851         while echo "$y"
 852         do
 853                 :
 854         done
 855 }
 856
 857 # Fix some commands on Windows
 858 case $(uname -s) in
 859 *MINGW*)
 860         # Windows has its own (incompatible) sort and find
 861         sort () {
 862                 /usr/bin/sort "$@"
 863         }
 864         find () {
 865                 /usr/bin/find "$@"
 866         }
 867         sum () {
 868                 md5sum "$@"
 869         }
 870         # git sees Windows-style pwd
 871         pwd () {
 872                 builtin pwd -W
 873         }
 874         # no POSIX permissions
 875         # backslashes in pathspec are converted to '/'
 876         # exec does not inherit the PID
 877         test_set_prereq MINGW
 878         test_set_prereq SED_STRIPS_CR
 879         test_set_prereq GREP_STRIPS_CR
 880         GIT_TEST_CMP=mingw_test_cmp
 881         ;;
 882 *CYGWIN*)
 883         test_set_prereq POSIXPERM
 884         test_set_prereq EXECKEEPSPID
 885         test_set_prereq CYGWIN
 886         test_set_prereq SED_STRIPS_CR
 887         test_set_prereq GREP_STRIPS_CR
 888         ;;
 889 *)
 890         test_set_prereq POSIXPERM
 891         test_set_prereq BSLASHPSPEC
 892         test_set_prereq EXECKEEPSPID
 893         ;;
 894 esac
 895
 896 ( COLUMNS=1 && test $COLUMNS = 1 ) && test_set_prereq COLUMNS_CAN_BE_1
 897 test -z "$NO_PERL" && test_set_prereq PERL
 898 test -z "$NO_PYTHON" && test_set_prereq PYTHON
 899 test -n "$USE_LIBPCRE" && test_set_prereq LIBPCRE
 900 test -z "$NO_GETTEXT" && test_set_prereq GETTEXT
 901
 902 # Can we rely on git's output in the C locale?
 903 if test -n "$GETTEXT_POISON"
 904 then
 905         GIT_GETTEXT_POISON=YesPlease
 906         export GIT_GETTEXT_POISON
 907         test_set_prereq GETTEXT_POISON
 908 else
 909         test_set_prereq C_LOCALE_OUTPUT
 910 fi
 911
 912 # Use this instead of test_cmp to compare files that contain expected and
 913 # actual output from git commands that can be translated.  When running
 914 # under GETTEXT_POISON this pretends that the command produced expected
 915 # results.
 916 test_i18ncmp () {
 917         test -n "$GETTEXT_POISON" || test_cmp "$@"
 918 }
 919
 920 # Use this instead of "grep expected-string actual" to see if the
 921 # output from a git command that can be translated either contains an
 922 # expected string, or does not contain an unwanted one.  When running
 923 # under GETTEXT_POISON this pretends that the command produced expected
 924 # results.
 925 test_i18ngrep () {
 926         if test -n "$GETTEXT_POISON"
 927         then
 928             : # pretend success
 929         elif test "x!" = "x$1"
 930         then
 931                 shift
 932                 ! grep "$@"
 933         else
 934                 grep "$@"
 935         fi
 936 }
 937
 938 test_lazy_prereq PIPE '
 939         # test whether the filesystem supports FIFOs
 940         case $(uname -s) in
 941         CYGWIN*)
 942                 false
 943                 ;;
 944         *)
 945                 rm -f testfifo && mkfifo testfifo
 946                 ;;
 947         esac
 948 '
 949
 950 test_lazy_prereq SYMLINKS '
 951         # test whether the filesystem supports symbolic links
 952         ln -s x y && test -h y
 953 '
 954
 955 test_lazy_prereq FILEMODE '
 956         test "$(git config --bool core.filemode)" = true
 957 '
 958
 959 test_lazy_prereq CASE_INSENSITIVE_FS '
 960         echo good >CamelCase &&
 961         echo bad >camelcase &&
 962         test "$(cat CamelCase)" != good
 963 '
 964
 965 test_lazy_prereq UTF8_NFD_TO_NFC '
 966         # check whether FS converts nfd unicode to nfc
 967         auml=$(printf "\303\244")
 968         aumlcdiar=$(printf "\141\314\210")
 969         >"$auml" &&
 970         case "$(echo *)" in
 971         "$aumlcdiar")
 972                 true ;;
 973         *)
 974                 false ;;
 975         esac
 976 '
 977
 978 test_lazy_prereq AUTOIDENT '
 979         sane_unset GIT_AUTHOR_NAME &&
 980         sane_unset GIT_AUTHOR_EMAIL &&
 981         git var GIT_AUTHOR_IDENT
 982 '
 983
 984 test_lazy_prereq EXPENSIVE '
 985         test -n "$GIT_TEST_LONG"
 986 '
 987
 988 test_lazy_prereq USR_BIN_TIME '
 989         test -x /usr/bin/time
 990 '
 991
 992 # When the tests are run as root, permission tests will report that
 993 # things are writable when they shouldn't be.
 994 test -w / || test_set_prereq SANITY
 995
 996 GIT_UNZIP=${GIT_UNZIP:-unzip}
 997 test_lazy_prereq UNZIP '
 998         "$GIT_UNZIP" -v
 999         test $? -ne 127
1000 '