t/test-lib-functions.sh

   1 # Library of functions shared by all tests scripts, included by
   2 # test-lib.sh.
   3 #
   4 # Copyright (c) 2005 Junio C Hamano
   5 #
   6 # This program is free software: you can redistribute it and/or modify
   7 # it under the terms of the GNU General Public License as published by
   8 # the Free Software Foundation, either version 2 of the License, or
   9 # (at your option) any later version.
  10 #
  11 # This program is distributed in the hope that it will be useful,
  12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 # GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License
  17 # along with this program.  If not, see http://www.gnu.org/licenses/ .
  18
  19 # The semantics of the editor variables are that of invoking
  20 # sh -c "$EDITOR \"$@\"" files ...
  21 #
  22 # If our trash directory contains shell metacharacters, they will be
  23 # interpreted if we just set $EDITOR directly, so do a little dance with
  24 # environment variables to work around this.
  25 #
  26 # In particular, quoting isn't enough, as the path may contain the same quote
  27 # that we're using.
  28 test_set_editor () {
  29         FAKE_EDITOR="$1"
  30         export FAKE_EDITOR
  31         EDITOR='"$FAKE_EDITOR"'
  32         export EDITOR
  33 }
  34
  35 test_set_index_version () {
  36     GIT_INDEX_VERSION="$1"
  37     export GIT_INDEX_VERSION
  38 }
  39
  40 test_decode_color () {
  41         awk '
  42                 function name(n) {
  43                         if (n == 0) return "RESET";
  44                         if (n == 1) return "BOLD";
  45                         if (n == 2) return "FAINT";
  46                         if (n == 3) return "ITALIC";
  47                         if (n == 7) return "REVERSE";
  48                         if (n == 30) return "BLACK";
  49                         if (n == 31) return "RED";
  50                         if (n == 32) return "GREEN";
  51                         if (n == 33) return "YELLOW";
  52                         if (n == 34) return "BLUE";
  53                         if (n == 35) return "MAGENTA";
  54                         if (n == 36) return "CYAN";
  55                         if (n == 37) return "WHITE";
  56                         if (n == 40) return "BLACK";
  57                         if (n == 41) return "BRED";
  58                         if (n == 42) return "BGREEN";
  59                         if (n == 43) return "BYELLOW";
  60                         if (n == 44) return "BBLUE";
  61                         if (n == 45) return "BMAGENTA";
  62                         if (n == 46) return "BCYAN";
  63                         if (n == 47) return "BWHITE";
  64                 }
  65                 {
  66                         while (match($0, /\033\[[0-9;]*m/) != 0) {
  67                                 printf "%s<", substr($0, 1, RSTART-1);
  68                                 codes = substr($0, RSTART+2, RLENGTH-3);
  69                                 if (length(codes) == 0)
  70                                         printf "%s", name(0)
  71                                 else {
  72                                         n = split(codes, ary, ";");
  73                                         sep = "";
  74                                         for (i = 1; i <= n; i++) {
  75                                                 printf "%s%s", sep, name(ary[i]);
  76                                                 sep = ";"
  77                                         }
  78                                 }
  79                                 printf ">";
  80                                 $0 = substr($0, RSTART + RLENGTH, length($0) - RSTART - RLENGTH + 1);
  81                         }
  82                         print
  83                 }
  84         '
  85 }
  86
  87 lf_to_nul () {
  88         perl -pe 'y/\012/\000/'
  89 }
  90
  91 nul_to_q () {
  92         perl -pe 'y/\000/Q/'
  93 }
  94
  95 q_to_nul () {
  96         perl -pe 'y/Q/\000/'
  97 }
  98
  99 q_to_cr () {
 100         tr Q '\015'
 101 }
 102
 103 q_to_tab () {
 104         tr Q '\011'
 105 }
 106
 107 qz_to_tab_space () {
 108         tr QZ '\011\040'
 109 }
 110
 111 append_cr () {
 112         sed -e 's/$/Q/' | tr Q '\015'
 113 }
 114
 115 remove_cr () {
 116         tr '\015' Q | sed -e 's/Q$//'
 117 }
 118
 119 # Generate an output of $1 bytes of all zeroes (NULs, not ASCII zeroes).
 120 # If $1 is 'infinity', output forever or until the receiving pipe stops reading,
 121 # whichever comes first.
 122 generate_zero_bytes () {
 123         test-tool genzeros "$@"
 124 }
 125
 126 # In some bourne shell implementations, the "unset" builtin returns
 127 # nonzero status when a variable to be unset was not set in the first
 128 # place.
 129 #
 130 # Use sane_unset when that should not be considered an error.
 131
 132 sane_unset () {
 133         unset "$@"
 134         return 0
 135 }
 136
 137 test_tick () {
 138         if test -z "${test_tick+set}"
 139         then
 140                 test_tick=1112911993
 141         else
 142                 test_tick=$(($test_tick + 60))
 143         fi
 144         GIT_COMMITTER_DATE="$test_tick -0700"
 145         GIT_AUTHOR_DATE="$test_tick -0700"
 146         export GIT_COMMITTER_DATE GIT_AUTHOR_DATE
 147 }
 148
 149 # Stop execution and start a shell. This is useful for debugging tests.
 150 #
 151 # Be sure to remove all invocations of this command before submitting.
 152
 153 test_pause () {
 154         "$SHELL_PATH" <&6 >&5 2>&7
 155 }
 156
 157 # Wrap git with a debugger. Adding this to a command can make it easier
 158 # to understand what is going on in a failing test.
 159 #
 160 # Examples:
 161 #     debug git checkout master
 162 #     debug --debugger=nemiver git $ARGS
 163 #     debug -d "valgrind --tool=memcheck --track-origins=yes" git $ARGS
 164 debug () {
 165         case "$1" in
 166         -d)
 167                 GIT_DEBUGGER="$2" &&
 168                 shift 2
 169                 ;;
 170         --debugger=*)
 171                 GIT_DEBUGGER="${1#*=}" &&
 172                 shift 1
 173                 ;;
 174         *)
 175                 GIT_DEBUGGER=1
 176                 ;;
 177         esac &&
 178         GIT_DEBUGGER="${GIT_DEBUGGER}" "$@" <&6 >&5 2>&7
 179 }
 180
 181 # Usage: test_commit [options] <message> [<file> [<contents> [<tag>]]]
 182 #   -C <dir>:
 183 #       Run all git commands in directory <dir>
 184 #   --notick
 185 #       Do not call test_tick before making a commit
 186 #   --signoff
 187 #       Invoke "git commit" with --signoff
 188 #
 189 # This will commit a file with the given contents and the given commit
 190 # message, and tag the resulting commit with the given tag name.
 191 #
 192 # <file>, <contents>, and <tag> all default to <message>.
 193
 194 test_commit () {
 195         notick= &&
 196         signoff= &&
 197         indir= &&
 198         while test $# != 0
 199         do
 200                 case "$1" in
 201                 --notick)
 202                         notick=yes
 203                         ;;
 204                 --signoff)
 205                         signoff="$1"
 206                         ;;
 207                 -C)
 208                         indir="$2"
 209                         shift
 210                         ;;
 211                 *)
 212                         break
 213                         ;;
 214                 esac
 215                 shift
 216         done &&
 217         indir=${indir:+"$indir"/} &&
 218         file=${2:-"$1.t"} &&
 219         echo "${3-$1}" > "$indir$file" &&
 220         git ${indir:+ -C "$indir"} add "$file" &&
 221         if test -z "$notick"
 222         then
 223                 test_tick
 224         fi &&
 225         git ${indir:+ -C "$indir"} commit $signoff -m "$1" &&
 226         git ${indir:+ -C "$indir"} tag "${4:-$1}"
 227 }
 228
 229 # Call test_merge with the arguments "<message> <commit>", where <commit>
 230 # can be a tag pointing to the commit-to-merge.
 231
 232 test_merge () {
 233         label="$1" &&
 234         shift &&
 235         test_tick &&
 236         git merge -m "$label" "$@" &&
 237         git tag "$label"
 238 }
 239
 240 # Efficiently create <nr> commits, each with a unique number (from 1 to <nr>
 241 # by default) in the commit message.
 242 #
 243 # Usage: test_commit_bulk [options] <nr>
 244 #   -C <dir>:
 245 #       Run all git commands in directory <dir>
 246 #   --ref=<n>:
 247 #       ref on which to create commits (default: HEAD)
 248 #   --start=<n>:
 249 #       number commit messages from <n> (default: 1)
 250 #   --message=<msg>:
 251 #       use <msg> as the commit mesasge (default: "commit %s")
 252 #   --filename=<fn>:
 253 #       modify <fn> in each commit (default: %s.t)
 254 #   --contents=<string>:
 255 #       place <string> in each file (default: "content %s")
 256 #   --id=<string>:
 257 #       shorthand to use <string> and %s in message, filename, and contents
 258 #
 259 # The message, filename, and contents strings are evaluated by printf, with the
 260 # first "%s" replaced by the current commit number. So you can do:
 261 #
 262 #   test_commit_bulk --filename=file --contents="modification %s"
 263 #
 264 # to have every commit touch the same file, but with unique content.
 265 #
 266 test_commit_bulk () {
 267         tmpfile=.bulk-commit.input
 268         indir=.
 269         ref=HEAD
 270         n=1
 271         message='commit %s'
 272         filename='%s.t'
 273         contents='content %s'
 274         while test $# -gt 0
 275         do
 276                 case "$1" in
 277                 -C)
 278                         indir=$2
 279                         shift
 280                         ;;
 281                 --ref=*)
 282                         ref=${1#--*=}
 283                         ;;
 284                 --start=*)
 285                         n=${1#--*=}
 286                         ;;
 287                 --message=*)
 288                         message=${1#--*=}
 289                         ;;
 290                 --filename=*)
 291                         filename=${1#--*=}
 292                         ;;
 293                 --contents=*)
 294                         contents=${1#--*=}
 295                         ;;
 296                 --id=*)
 297                         message="${1#--*=} %s"
 298                         filename="${1#--*=}-%s.t"
 299                         contents="${1#--*=} %s"
 300                         ;;
 301                 -*)
 302                         BUG "invalid test_commit_bulk option: $1"
 303                         ;;
 304                 *)
 305                         break
 306                         ;;
 307                 esac
 308                 shift
 309         done
 310         total=$1
 311
 312         add_from=
 313         if git -C "$indir" rev-parse --quiet --verify "$ref"
 314         then
 315                 add_from=t
 316         fi
 317
 318         while test "$total" -gt 0
 319         do
 320                 test_tick &&
 321                 echo "commit $ref"
 322                 printf 'author %s <%s> %s\n' \
 323                         "$GIT_AUTHOR_NAME" \
 324                         "$GIT_AUTHOR_EMAIL" \
 325                         "$GIT_AUTHOR_DATE"
 326                 printf 'committer %s <%s> %s\n' \
 327                         "$GIT_COMMITTER_NAME" \
 328                         "$GIT_COMMITTER_EMAIL" \
 329                         "$GIT_COMMITTER_DATE"
 330                 echo "data <<EOF"
 331                 printf "$message\n" $n
 332                 echo "EOF"
 333                 if test -n "$add_from"
 334                 then
 335                         echo "from $ref^0"
 336                         add_from=
 337                 fi
 338                 printf "M 644 inline $filename\n" $n
 339                 echo "data <<EOF"
 340                 printf "$contents\n" $n
 341                 echo "EOF"
 342                 echo
 343                 n=$((n + 1))
 344                 total=$((total - 1))
 345         done >"$tmpfile"
 346
 347         git -C "$indir" \
 348             -c fastimport.unpacklimit=0 \
 349             fast-import <"$tmpfile" || return 1
 350
 351         # This will be left in place on failure, which may aid debugging.
 352         rm -f "$tmpfile"
 353
 354         # If we updated HEAD, then be nice and update the index and working
 355         # tree, too.
 356         if test "$ref" = "HEAD"
 357         then
 358                 git -C "$indir" checkout -f HEAD || return 1
 359         fi
 360
 361 }
 362
 363 # This function helps systems where core.filemode=false is set.
 364 # Use it instead of plain 'chmod +x' to set or unset the executable bit
 365 # of a file in the working directory and add it to the index.
 366
 367 test_chmod () {
 368         chmod "$@" &&
 369         git update-index --add "--chmod=$@"
 370 }
 371
 372 # Get the modebits from a file or directory.
 373 test_modebits () {
 374         ls -ld "$1" | sed -e 's|^\(..........\).*|\1|'
 375 }
 376
 377 # Unset a configuration variable, but don't fail if it doesn't exist.
 378 test_unconfig () {
 379         config_dir=
 380         if test "$1" = -C
 381         then
 382                 shift
 383                 config_dir=$1
 384                 shift
 385         fi
 386         git ${config_dir:+-C "$config_dir"} config --unset-all "$@"
 387         config_status=$?
 388         case "$config_status" in
 389         5) # ok, nothing to unset
 390                 config_status=0
 391                 ;;
 392         esac
 393         return $config_status
 394 }
 395
 396 # Set git config, automatically unsetting it after the test is over.
 397 test_config () {
 398         config_dir=
 399         if test "$1" = -C
 400         then
 401                 shift
 402                 config_dir=$1
 403                 shift
 404         fi
 405         test_when_finished "test_unconfig ${config_dir:+-C '$config_dir'} '$1'" &&
 406         git ${config_dir:+-C "$config_dir"} config "$@"
 407 }
 408
 409 test_config_global () {
 410         test_when_finished "test_unconfig --global '$1'" &&
 411         git config --global "$@"
 412 }
 413
 414 write_script () {
 415         {
 416                 echo "#!${2-"$SHELL_PATH"}" &&
 417                 cat
 418         } >"$1" &&
 419         chmod +x "$1"
 420 }
 421
 422 # Use test_set_prereq to tell that a particular prerequisite is available.
 423 # The prerequisite can later be checked for in two ways:
 424 #
 425 # - Explicitly using test_have_prereq.
 426 #
 427 # - Implicitly by specifying the prerequisite tag in the calls to
 428 #   test_expect_{success,failure} and test_external{,_without_stderr}.
 429 #
 430 # The single parameter is the prerequisite tag (a simple word, in all
 431 # capital letters by convention).
 432
 433 test_unset_prereq () {
 434         ! test_have_prereq "$1" ||
 435         satisfied_prereq="${satisfied_prereq% $1 *} ${satisfied_prereq#* $1 }"
 436 }
 437
 438 test_set_prereq () {
 439         if test -n "$GIT_TEST_FAIL_PREREQS_INTERNAL"
 440         then
 441                 case "$1" in
 442                 # The "!" case is handled below with
 443                 # test_unset_prereq()
 444                 !*)
 445                         ;;
 446                 # (Temporary?) whitelist of things we can't easily
 447                 # pretend not to support
 448                 SYMLINKS)
 449                         ;;
 450                 # Inspecting whether GIT_TEST_FAIL_PREREQS is on
 451                 # should be unaffected.
 452                 FAIL_PREREQS)
 453                         ;;
 454                 *)
 455                         return
 456                 esac
 457         fi
 458
 459         case "$1" in
 460         !*)
 461                 test_unset_prereq "${1#!}"
 462                 ;;
 463         *)
 464                 satisfied_prereq="$satisfied_prereq$1 "
 465                 ;;
 466         esac
 467 }
 468 satisfied_prereq=" "
 469 lazily_testable_prereq= lazily_tested_prereq=
 470
 471 # Usage: test_lazy_prereq PREREQ 'script'
 472 test_lazy_prereq () {
 473         lazily_testable_prereq="$lazily_testable_prereq$1 "
 474         eval test_prereq_lazily_$1=\$2
 475 }
 476
 477 test_run_lazy_prereq_ () {
 478         script='
 479 mkdir -p "$TRASH_DIRECTORY/prereq-test-dir-'"$1"'" &&
 480 (
 481         cd "$TRASH_DIRECTORY/prereq-test-dir-'"$1"'" &&'"$2"'
 482 )'
 483         say >&3 "checking prerequisite: $1"
 484         say >&3 "$script"
 485         test_eval_ "$script"
 486         eval_ret=$?
 487         rm -rf "$TRASH_DIRECTORY/prereq-test-dir-$1"
 488         if test "$eval_ret" = 0; then
 489                 say >&3 "prerequisite $1 ok"
 490         else
 491                 say >&3 "prerequisite $1 not satisfied"
 492         fi
 493         return $eval_ret
 494 }
 495
 496 test_have_prereq () {
 497         # prerequisites can be concatenated with ','
 498         save_IFS=$IFS
 499         IFS=,
 500         set -- $*
 501         IFS=$save_IFS
 502
 503         total_prereq=0
 504         ok_prereq=0
 505         missing_prereq=
 506
 507         for prerequisite
 508         do
 509                 case "$prerequisite" in
 510                 !*)
 511                         negative_prereq=t
 512                         prerequisite=${prerequisite#!}
 513                         ;;
 514                 *)
 515                         negative_prereq=
 516                 esac
 517
 518                 case " $lazily_tested_prereq " in
 519                 *" $prerequisite "*)
 520                         ;;
 521                 *)
 522                         case " $lazily_testable_prereq " in
 523                         *" $prerequisite "*)
 524                                 eval "script=\$test_prereq_lazily_$prerequisite" &&
 525                                 if test_run_lazy_prereq_ "$prerequisite" "$script"
 526                                 then
 527                                         test_set_prereq $prerequisite
 528                                 fi
 529                                 lazily_tested_prereq="$lazily_tested_prereq$prerequisite "
 530                         esac
 531                         ;;
 532                 esac
 533
 534                 total_prereq=$(($total_prereq + 1))
 535                 case "$satisfied_prereq" in
 536                 *" $prerequisite "*)
 537                         satisfied_this_prereq=t
 538                         ;;
 539                 *)
 540                         satisfied_this_prereq=
 541                 esac
 542
 543                 case "$satisfied_this_prereq,$negative_prereq" in
 544                 t,|,t)
 545                         ok_prereq=$(($ok_prereq + 1))
 546                         ;;
 547                 *)
 548                         # Keep a list of missing prerequisites; restore
 549                         # the negative marker if necessary.
 550                         prerequisite=${negative_prereq:+!}$prerequisite
 551                         if test -z "$missing_prereq"
 552                         then
 553                                 missing_prereq=$prerequisite
 554                         else
 555                                 missing_prereq="$prerequisite,$missing_prereq"
 556                         fi
 557                 esac
 558         done
 559
 560         test $total_prereq = $ok_prereq
 561 }
 562
 563 test_declared_prereq () {
 564         case ",$test_prereq," in
 565         *,$1,*)
 566                 return 0
 567                 ;;
 568         esac
 569         return 1
 570 }
 571
 572 test_verify_prereq () {
 573         test -z "$test_prereq" ||
 574         expr >/dev/null "$test_prereq" : '[A-Z0-9_,!]*$' ||
 575         BUG "'$test_prereq' does not look like a prereq"
 576 }
 577
 578 test_expect_failure () {
 579         test_start_
 580         test "$#" = 3 && { test_prereq=$1; shift; } || test_prereq=
 581         test "$#" = 2 ||
 582         BUG "not 2 or 3 parameters to test-expect-failure"
 583         test_verify_prereq
 584         export test_prereq
 585         if ! test_skip "$@"
 586         then
 587                 say >&3 "checking known breakage of $TEST_NUMBER.$test_count '$1': $2"
 588                 if test_run_ "$2" expecting_failure
 589                 then
 590                         test_known_broken_ok_ "$1"
 591                 else
 592                         test_known_broken_failure_ "$1"
 593                 fi
 594         fi
 595         test_finish_
 596 }
 597
 598 test_expect_success () {
 599         test_start_
 600         test "$#" = 3 && { test_prereq=$1; shift; } || test_prereq=
 601         test "$#" = 2 ||
 602         BUG "not 2 or 3 parameters to test-expect-success"
 603         test_verify_prereq
 604         export test_prereq
 605         if ! test_skip "$@"
 606         then
 607                 say >&3 "expecting success of $TEST_NUMBER.$test_count '$1': $2"
 608                 if test_run_ "$2"
 609                 then
 610                         test_ok_ "$1"
 611                 else
 612                         test_failure_ "$@"
 613                 fi
 614         fi
 615         test_finish_
 616 }
 617
 618 # test_external runs external test scripts that provide continuous
 619 # test output about their progress, and succeeds/fails on
 620 # zero/non-zero exit code.  It outputs the test output on stdout even
 621 # in non-verbose mode, and announces the external script with "# run
 622 # <n>: ..." before running it.  When providing relative paths, keep in
 623 # mind that all scripts run in "trash directory".
 624 # Usage: test_external description command arguments...
 625 # Example: test_external 'Perl API' perl ../path/to/test.pl
 626 test_external () {
 627         test "$#" = 4 && { test_prereq=$1; shift; } || test_prereq=
 628         test "$#" = 3 ||
 629         BUG "not 3 or 4 parameters to test_external"
 630         descr="$1"
 631         shift
 632         test_verify_prereq
 633         export test_prereq
 634         if ! test_skip "$descr" "$@"
 635         then
 636                 # Announce the script to reduce confusion about the
 637                 # test output that follows.
 638                 say_color "" "# run $test_count: $descr ($*)"
 639                 # Export TEST_DIRECTORY, TRASH_DIRECTORY and GIT_TEST_LONG
 640                 # to be able to use them in script
 641                 export TEST_DIRECTORY TRASH_DIRECTORY GIT_TEST_LONG
 642                 # Run command; redirect its stderr to &4 as in
 643                 # test_run_, but keep its stdout on our stdout even in
 644                 # non-verbose mode.
 645                 "$@" 2>&4
 646                 if test "$?" = 0
 647                 then
 648                         if test $test_external_has_tap -eq 0; then
 649                                 test_ok_ "$descr"
 650                         else
 651                                 say_color "" "# test_external test $descr was ok"
 652                                 test_success=$(($test_success + 1))
 653                         fi
 654                 else
 655                         if test $test_external_has_tap -eq 0; then
 656                                 test_failure_ "$descr" "$@"
 657                         else
 658                                 say_color error "# test_external test $descr failed: $@"
 659                                 test_failure=$(($test_failure + 1))
 660                         fi
 661                 fi
 662         fi
 663 }
 664
 665 # Like test_external, but in addition tests that the command generated
 666 # no output on stderr.
 667 test_external_without_stderr () {
 668         # The temporary file has no (and must have no) security
 669         # implications.
 670         tmp=${TMPDIR:-/tmp}
 671         stderr="$tmp/git-external-stderr.$$.tmp"
 672         test_external "$@" 4> "$stderr"
 673         test -f "$stderr" || error "Internal error: $stderr disappeared."
 674         descr="no stderr: $1"
 675         shift
 676         say >&3 "# expecting no stderr from previous command"
 677         if test ! -s "$stderr"
 678         then
 679                 rm "$stderr"
 680
 681                 if test $test_external_has_tap -eq 0; then
 682                         test_ok_ "$descr"
 683                 else
 684                         say_color "" "# test_external_without_stderr test $descr was ok"
 685                         test_success=$(($test_success + 1))
 686                 fi
 687         else
 688                 if test "$verbose" = t
 689                 then
 690                         output=$(echo; echo "# Stderr is:"; cat "$stderr")
 691                 else
 692                         output=
 693                 fi
 694                 # rm first in case test_failure exits.
 695                 rm "$stderr"
 696                 if test $test_external_has_tap -eq 0; then
 697                         test_failure_ "$descr" "$@" "$output"
 698                 else
 699                         say_color error "# test_external_without_stderr test $descr failed: $@: $output"
 700                         test_failure=$(($test_failure + 1))
 701                 fi
 702         fi
 703 }
 704
 705 # debugging-friendly alternatives to "test [-f|-d|-e]"
 706 # The commands test the existence or non-existence of $1. $2 can be
 707 # given to provide a more precise diagnosis.
 708 test_path_is_file () {
 709         if ! test -f "$1"
 710         then
 711                 echo "File $1 doesn't exist. $2"
 712                 false
 713         fi
 714 }
 715
 716 test_path_is_dir () {
 717         if ! test -d "$1"
 718         then
 719                 echo "Directory $1 doesn't exist. $2"
 720                 false
 721         fi
 722 }
 723
 724 test_path_exists () {
 725         if ! test -e "$1"
 726         then
 727                 echo "Path $1 doesn't exist. $2"
 728                 false
 729         fi
 730 }
 731
 732 # Check if the directory exists and is empty as expected, barf otherwise.
 733 test_dir_is_empty () {
 734         test_path_is_dir "$1" &&
 735         if test -n "$(ls -a1 "$1" | egrep -v '^\.\.?$')"
 736         then
 737                 echo "Directory '$1' is not empty, it contains:"
 738                 ls -la "$1"
 739                 return 1
 740         fi
 741 }
 742
 743 # Check if the file exists and has a size greater than zero
 744 test_file_not_empty () {
 745         if ! test -s "$1"
 746         then
 747                 echo "'$1' is not a non-empty file."
 748                 false
 749         fi
 750 }
 751
 752 test_path_is_missing () {
 753         if test -e "$1"
 754         then
 755                 echo "Path exists:"
 756                 ls -ld "$1"
 757                 if test $# -ge 1
 758                 then
 759                         echo "$*"
 760                 fi
 761                 false
 762         fi
 763 }
 764
 765 # test_line_count checks that a file has the number of lines it
 766 # ought to. For example:
 767 #
 768 #       test_expect_success 'produce exactly one line of output' '
 769 #               do something >output &&
 770 #               test_line_count = 1 output
 771 #       '
 772 #
 773 # is like "test $(wc -l <output) = 1" except that it passes the
 774 # output through when the number of lines is wrong.
 775
 776 test_line_count () {
 777         if test $# != 3
 778         then
 779                 BUG "not 3 parameters to test_line_count"
 780         elif ! test $(wc -l <"$3") "$1" "$2"
 781         then
 782                 echo "test_line_count: line count for $3 !$1 $2"
 783                 cat "$3"
 784                 return 1
 785         fi
 786 }
 787
 788 test_file_size () {
 789         test-tool path-utils file-size "$1"
 790 }
 791
 792 # Returns success if a comma separated string of keywords ($1) contains a
 793 # given keyword ($2).
 794 # Examples:
 795 # `list_contains "foo,bar" bar` returns 0
 796 # `list_contains "foo" bar` returns 1
 797
 798 list_contains () {
 799         case ",$1," in
 800         *,$2,*)
 801                 return 0
 802                 ;;
 803         esac
 804         return 1
 805 }
 806
 807 # Returns success if the arguments indicate that a command should be
 808 # accepted by test_must_fail(). If the command is run with env, the env
 809 # and its corresponding variable settings will be stripped before we
 810 # test the command being run.
 811 test_must_fail_acceptable () {
 812         if test "$1" = "env"
 813         then
 814                 shift
 815                 while test $# -gt 0
 816                 do
 817                         case "$1" in
 818                         *?=*)
 819                                 shift
 820                                 ;;
 821                         *)
 822                                 break
 823                                 ;;
 824                         esac
 825                 done
 826         fi
 827
 828         case "$1" in
 829         git|__git*|test-tool|test_terminal)
 830                 return 0
 831                 ;;
 832         *)
 833                 return 1
 834                 ;;
 835         esac
 836 }
 837
 838 # This is not among top-level (test_expect_success | test_expect_failure)
 839 # but is a prefix that can be used in the test script, like:
 840 #
 841 #       test_expect_success 'complain and die' '
 842 #           do something &&
 843 #           do something else &&
 844 #           test_must_fail git checkout ../outerspace
 845 #       '
 846 #
 847 # Writing this as "! git checkout ../outerspace" is wrong, because
 848 # the failure could be due to a segv.  We want a controlled failure.
 849 #
 850 # Accepts the following options:
 851 #
 852 #   ok=<signal-name>[,<...>]:
 853 #     Don't treat an exit caused by the given signal as error.
 854 #     Multiple signals can be specified as a comma separated list.
 855 #     Currently recognized signal names are: sigpipe, success.
 856 #     (Don't use 'success', use 'test_might_fail' instead.)
 857 #
 858 # Do not use this to run anything but "git" and other specific testable
 859 # commands (see test_must_fail_acceptable()).  We are not in the
 860 # business of vetting system supplied commands -- in other words, this
 861 # is wrong:
 862 #
 863 #    test_must_fail grep pattern output
 864 #
 865 # Instead use '!':
 866 #
 867 #    ! grep pattern output
 868
 869 test_must_fail () {
 870         case "$1" in
 871         ok=*)
 872                 _test_ok=${1#ok=}
 873                 shift
 874                 ;;
 875         *)
 876                 _test_ok=
 877                 ;;
 878         esac
 879         if ! test_must_fail_acceptable "$@"
 880         then
 881                 echo >&7 "test_must_fail: only 'git' is allowed: $*"
 882                 return 1
 883         fi
 884         "$@" 2>&7
 885         exit_code=$?
 886         if test $exit_code -eq 0 && ! list_contains "$_test_ok" success
 887         then
 888                 echo >&4 "test_must_fail: command succeeded: $*"
 889                 return 1
 890         elif test_match_signal 13 $exit_code && list_contains "$_test_ok" sigpipe
 891         then
 892                 return 0
 893         elif test $exit_code -gt 129 && test $exit_code -le 192
 894         then
 895                 echo >&4 "test_must_fail: died by signal $(($exit_code - 128)): $*"
 896                 return 1
 897         elif test $exit_code -eq 127
 898         then
 899                 echo >&4 "test_must_fail: command not found: $*"
 900                 return 1
 901         elif test $exit_code -eq 126
 902         then
 903                 echo >&4 "test_must_fail: valgrind error: $*"
 904                 return 1
 905         fi
 906         return 0
 907 } 7>&2 2>&4
 908
 909 # Similar to test_must_fail, but tolerates success, too.  This is
 910 # meant to be used in contexts like:
 911 #
 912 #       test_expect_success 'some command works without configuration' '
 913 #               test_might_fail git config --unset all.configuration &&
 914 #               do something
 915 #       '
 916 #
 917 # Writing "git config --unset all.configuration || :" would be wrong,
 918 # because we want to notice if it fails due to segv.
 919 #
 920 # Accepts the same options as test_must_fail.
 921
 922 test_might_fail () {
 923         test_must_fail ok=success "$@" 2>&7
 924 } 7>&2 2>&4
 925
 926 # Similar to test_must_fail and test_might_fail, but check that a
 927 # given command exited with a given exit code. Meant to be used as:
 928 #
 929 #       test_expect_success 'Merge with d/f conflicts' '
 930 #               test_expect_code 1 git merge "merge msg" B master
 931 #       '
 932
 933 test_expect_code () {
 934         want_code=$1
 935         shift
 936         "$@" 2>&7
 937         exit_code=$?
 938         if test $exit_code = $want_code
 939         then
 940                 return 0
 941         fi
 942
 943         echo >&4 "test_expect_code: command exited with $exit_code, we wanted $want_code $*"
 944         return 1
 945 } 7>&2 2>&4
 946
 947 # test_cmp is a helper function to compare actual and expected output.
 948 # You can use it like:
 949 #
 950 #       test_expect_success 'foo works' '
 951 #               echo expected >expected &&
 952 #               foo >actual &&
 953 #               test_cmp expected actual
 954 #       '
 955 #
 956 # This could be written as either "cmp" or "diff -u", but:
 957 # - cmp's output is not nearly as easy to read as diff -u
 958 # - not all diff versions understand "-u"
 959
 960 test_cmp () {
 961         eval "$GIT_TEST_CMP" '"$@"'
 962 }
 963
 964 # Check that the given config key has the expected value.
 965 #
 966 #    test_cmp_config [-C <dir>] <expected-value>
 967 #                    [<git-config-options>...] <config-key>
 968 #
 969 # for example to check that the value of core.bar is foo
 970 #
 971 #    test_cmp_config foo core.bar
 972 #
 973 test_cmp_config () {
 974         local GD &&
 975         if test "$1" = "-C"
 976         then
 977                 shift &&
 978                 GD="-C $1" &&
 979                 shift
 980         fi &&
 981         printf "%s\n" "$1" >expect.config &&
 982         shift &&
 983         git $GD config "$@" >actual.config &&
 984         test_cmp expect.config actual.config
 985 }
 986
 987 # test_cmp_bin - helper to compare binary files
 988
 989 test_cmp_bin () {
 990         cmp "$@"
 991 }
 992
 993 # Use this instead of test_cmp to compare files that contain expected and
 994 # actual output from git commands that can be translated.  When running
 995 # under GIT_TEST_GETTEXT_POISON this pretends that the command produced expected
 996 # results.
 997 test_i18ncmp () {
 998         ! test_have_prereq C_LOCALE_OUTPUT || test_cmp "$@"
 999 }
1000
1001 # Use this instead of "grep expected-string actual" to see if the
1002 # output from a git command that can be translated either contains an
1003 # expected string, or does not contain an unwanted one.  When running
1004 # under GIT_TEST_GETTEXT_POISON this pretends that the command produced expected
1005 # results.
1006 test_i18ngrep () {
1007         eval "last_arg=\${$#}"
1008
1009         test -f "$last_arg" ||
1010         BUG "test_i18ngrep requires a file to read as the last parameter"
1011
1012         if test $# -lt 2 ||
1013            { test "x!" = "x$1" && test $# -lt 3 ; }
1014         then
1015                 BUG "too few parameters to test_i18ngrep"
1016         fi
1017
1018         if test_have_prereq !C_LOCALE_OUTPUT
1019         then
1020                 # pretend success
1021                 return 0
1022         fi
1023
1024         if test "x!" = "x$1"
1025         then
1026                 shift
1027                 ! grep "$@" && return 0
1028
1029                 echo >&4 "error: '! grep $@' did find a match in:"
1030         else
1031                 grep "$@" && return 0
1032
1033                 echo >&4 "error: 'grep $@' didn't find a match in:"
1034         fi
1035
1036         if test -s "$last_arg"
1037         then
1038                 cat >&4 "$last_arg"
1039         else
1040                 echo >&4 "<File '$last_arg' is empty>"
1041         fi
1042
1043         return 1
1044 }
1045
1046 # Call any command "$@" but be more verbose about its
1047 # failure. This is handy for commands like "test" which do
1048 # not output anything when they fail.
1049 verbose () {
1050         "$@" && return 0
1051         echo >&4 "command failed: $(git rev-parse --sq-quote "$@")"
1052         return 1
1053 }
1054
1055 # Check if the file expected to be empty is indeed empty, and barfs
1056 # otherwise.
1057
1058 test_must_be_empty () {
1059         test_path_is_file "$1" &&
1060         if test -s "$1"
1061         then
1062                 echo "'$1' is not empty, it contains:"
1063                 cat "$1"
1064                 return 1
1065         fi
1066 }
1067
1068 # Tests that its two parameters refer to the same revision, or if '!' is
1069 # provided first, that its other two parameters refer to different
1070 # revisions.
1071 test_cmp_rev () {
1072         local op='=' wrong_result=different
1073
1074         if test $# -ge 1 && test "x$1" = 'x!'
1075         then
1076             op='!='
1077             wrong_result='the same'
1078             shift
1079         fi
1080         if test $# != 2
1081         then
1082                 error "bug in the test script: test_cmp_rev requires two revisions, but got $#"
1083         else
1084                 local r1 r2
1085                 r1=$(git rev-parse --verify "$1") &&
1086                 r2=$(git rev-parse --verify "$2") || return 1
1087
1088                 if ! test "$r1" "$op" "$r2"
1089                 then
1090                         cat >&4 <<-EOF
1091                         error: two revisions point to $wrong_result objects:
1092                           '$1': $r1
1093                           '$2': $r2
1094                         EOF
1095                         return 1
1096                 fi
1097         fi
1098 }
1099
1100 # Compare paths respecting core.ignoreCase
1101 test_cmp_fspath () {
1102         if test "x$1" = "x$2"
1103         then
1104                 return 0
1105         fi
1106
1107         if test true != "$(git config --get --type=bool core.ignorecase)"
1108         then
1109                 return 1
1110         fi
1111
1112         test "x$(echo "$1" | tr A-Z a-z)" =  "x$(echo "$2" | tr A-Z a-z)"
1113 }
1114
1115 # Print a sequence of integers in increasing order, either with
1116 # two arguments (start and end):
1117 #
1118 #     test_seq 1 5 -- outputs 1 2 3 4 5 one line at a time
1119 #
1120 # or with one argument (end), in which case it starts counting
1121 # from 1.
1122
1123 test_seq () {
1124         case $# in
1125         1)      set 1 "$@" ;;
1126         2)      ;;
1127         *)      BUG "not 1 or 2 parameters to test_seq" ;;
1128         esac
1129         test_seq_counter__=$1
1130         while test "$test_seq_counter__" -le "$2"
1131         do
1132                 echo "$test_seq_counter__"
1133                 test_seq_counter__=$(( $test_seq_counter__ + 1 ))
1134         done
1135 }
1136
1137 # This function can be used to schedule some commands to be run
1138 # unconditionally at the end of the test to restore sanity:
1139 #
1140 #       test_expect_success 'test core.capslock' '
1141 #               git config core.capslock true &&
1142 #               test_when_finished "git config --unset core.capslock" &&
1143 #               hello world
1144 #       '
1145 #
1146 # That would be roughly equivalent to
1147 #
1148 #       test_expect_success 'test core.capslock' '
1149 #               git config core.capslock true &&
1150 #               hello world
1151 #               git config --unset core.capslock
1152 #       '
1153 #
1154 # except that the greeting and config --unset must both succeed for
1155 # the test to pass.
1156 #
1157 # Note that under --immediate mode, no clean-up is done to help diagnose
1158 # what went wrong.
1159
1160 test_when_finished () {
1161         # We cannot detect when we are in a subshell in general, but by
1162         # doing so on Bash is better than nothing (the test will
1163         # silently pass on other shells).
1164         test "${BASH_SUBSHELL-0}" = 0 ||
1165         BUG "test_when_finished does nothing in a subshell"
1166         test_cleanup="{ $*
1167                 } && (exit \"\$eval_ret\"); eval_ret=\$?; $test_cleanup"
1168 }
1169
1170 # This function can be used to schedule some commands to be run
1171 # unconditionally at the end of the test script, e.g. to stop a daemon:
1172 #
1173 #       test_expect_success 'test git daemon' '
1174 #               git daemon &
1175 #               daemon_pid=$! &&
1176 #               test_atexit 'kill $daemon_pid' &&
1177 #               hello world
1178 #       '
1179 #
1180 # The commands will be executed before the trash directory is removed,
1181 # i.e. the atexit commands will still be able to access any pidfiles or
1182 # socket files.
1183 #
1184 # Note that these commands will be run even when a test script run
1185 # with '--immediate' fails.  Be careful with your atexit commands to
1186 # minimize any changes to the failed state.
1187
1188 test_atexit () {
1189         # We cannot detect when we are in a subshell in general, but by
1190         # doing so on Bash is better than nothing (the test will
1191         # silently pass on other shells).
1192         test "${BASH_SUBSHELL-0}" = 0 ||
1193         error "bug in test script: test_atexit does nothing in a subshell"
1194         test_atexit_cleanup="{ $*
1195                 } && (exit \"\$eval_ret\"); eval_ret=\$?; $test_atexit_cleanup"
1196 }
1197
1198 # Most tests can use the created repository, but some may need to create more.
1199 # Usage: test_create_repo <directory>
1200 test_create_repo () {
1201         test "$#" = 1 ||
1202         BUG "not 1 parameter to test-create-repo"
1203         repo="$1"
1204         mkdir -p "$repo"
1205         (
1206                 cd "$repo" || error "Cannot setup test environment"
1207                 "${GIT_TEST_INSTALLED:-$GIT_EXEC_PATH}/git$X" -c \
1208                         init.defaultBranch="${GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME-master}" \
1209                         init \
1210                         "--template=$GIT_BUILD_DIR/templates/blt/" >&3 2>&4 ||
1211                 error "cannot run git init -- have you built things yet?"
1212                 mv .git/hooks .git/hooks-disabled
1213         ) || exit
1214 }
1215
1216 # This function helps on symlink challenged file systems when it is not
1217 # important that the file system entry is a symbolic link.
1218 # Use test_ln_s_add instead of "ln -s x y && git add y" to add a
1219 # symbolic link entry y to the index.
1220
1221 test_ln_s_add () {
1222         if test_have_prereq SYMLINKS
1223         then
1224                 ln -s "$1" "$2" &&
1225                 git update-index --add "$2"
1226         else
1227                 printf '%s' "$1" >"$2" &&
1228                 ln_s_obj=$(git hash-object -w "$2") &&
1229                 git update-index --add --cacheinfo 120000 $ln_s_obj "$2" &&
1230                 # pick up stat info from the file
1231                 git update-index "$2"
1232         fi
1233 }
1234
1235 # This function writes out its parameters, one per line
1236 test_write_lines () {
1237         printf "%s\n" "$@"
1238 }
1239
1240 perl () {
1241         command "$PERL_PATH" "$@" 2>&7
1242 } 7>&2 2>&4
1243
1244 # Given the name of an environment variable with a bool value, normalize
1245 # its value to a 0 (true) or 1 (false or empty string) return code.
1246 #
1247 #   test_bool_env GIT_TEST_HTTPD <default-value>
1248 #
1249 # Return with code corresponding to the given default value if the variable
1250 # is unset.
1251 # Abort the test script if either the value of the variable or the default
1252 # are not valid bool values.
1253
1254 test_bool_env () {
1255         if test $# != 2
1256         then
1257                 BUG "test_bool_env requires two parameters (variable name and default value)"
1258         fi
1259
1260         git env--helper --type=bool --default="$2" --exit-code "$1"
1261         ret=$?
1262         case $ret in
1263         0|1)    # unset or valid bool value
1264                 ;;
1265         *)      # invalid bool value or something unexpected
1266                 error >&7 "test_bool_env requires bool values both for \$$1 and for the default fallback"
1267                 ;;
1268         esac
1269         return $ret
1270 }
1271
1272 # Exit the test suite, either by skipping all remaining tests or by
1273 # exiting with an error. If our prerequisite variable $1 falls back
1274 # on a default assume we were opportunistically trying to set up some
1275 # tests and we skip. If it is explicitly "true", then we report a failure.
1276 #
1277 # The error/skip message should be given by $2.
1278 #
1279 test_skip_or_die () {
1280         if ! test_bool_env "$1" false
1281         then
1282                 skip_all=$2
1283                 test_done
1284         fi
1285         error "$2"
1286 }
1287
1288 # The following mingw_* functions obey POSIX shell syntax, but are actually
1289 # bash scripts, and are meant to be used only with bash on Windows.
1290
1291 # A test_cmp function that treats LF and CRLF equal and avoids to fork
1292 # diff when possible.
1293 mingw_test_cmp () {
1294         # Read text into shell variables and compare them. If the results
1295         # are different, use regular diff to report the difference.
1296         local test_cmp_a= test_cmp_b=
1297
1298         # When text came from stdin (one argument is '-') we must feed it
1299         # to diff.
1300         local stdin_for_diff=
1301
1302         # Since it is difficult to detect the difference between an
1303         # empty input file and a failure to read the files, we go straight
1304         # to diff if one of the inputs is empty.
1305         if test -s "$1" && test -s "$2"
1306         then
1307                 # regular case: both files non-empty
1308                 mingw_read_file_strip_cr_ test_cmp_a <"$1"
1309                 mingw_read_file_strip_cr_ test_cmp_b <"$2"
1310         elif test -s "$1" && test "$2" = -
1311         then
1312                 # read 2nd file from stdin
1313                 mingw_read_file_strip_cr_ test_cmp_a <"$1"
1314                 mingw_read_file_strip_cr_ test_cmp_b
1315                 stdin_for_diff='<<<"$test_cmp_b"'
1316         elif test "$1" = - && test -s "$2"
1317         then
1318                 # read 1st file from stdin
1319                 mingw_read_file_strip_cr_ test_cmp_a
1320                 mingw_read_file_strip_cr_ test_cmp_b <"$2"
1321                 stdin_for_diff='<<<"$test_cmp_a"'
1322         fi
1323         test -n "$test_cmp_a" &&
1324         test -n "$test_cmp_b" &&
1325         test "$test_cmp_a" = "$test_cmp_b" ||
1326         eval "diff -u \"\$@\" $stdin_for_diff"
1327 }
1328
1329 # $1 is the name of the shell variable to fill in
1330 mingw_read_file_strip_cr_ () {
1331         # Read line-wise using LF as the line separator
1332         # and use IFS to strip CR.
1333         local line
1334         while :
1335         do
1336                 if IFS=$'\r' read -r -d $'\n' line
1337                 then
1338                         # good
1339                         line=$line$'\n'
1340                 else
1341                         # we get here at EOF, but also if the last line
1342                         # was not terminated by LF; in the latter case,
1343                         # some text was read
1344                         if test -z "$line"
1345                         then
1346                                 # EOF, really
1347                                 break
1348                         fi
1349                 fi
1350                 eval "$1=\$$1\$line"
1351         done
1352 }
1353
1354 # Like "env FOO=BAR some-program", but run inside a subshell, which means
1355 # it also works for shell functions (though those functions cannot impact
1356 # the environment outside of the test_env invocation).
1357 test_env () {
1358         (
1359                 while test $# -gt 0
1360                 do
1361                         case "$1" in
1362                         *=*)
1363                                 eval "${1%%=*}=\${1#*=}"
1364                                 eval "export ${1%%=*}"
1365                                 shift
1366                                 ;;
1367                         *)
1368                                 "$@" 2>&7
1369                                 exit
1370                                 ;;
1371                         esac
1372                 done
1373         )
1374 } 7>&2 2>&4
1375
1376 # Returns true if the numeric exit code in "$2" represents the expected signal
1377 # in "$1". Signals should be given numerically.
1378 test_match_signal () {
1379         if test "$2" = "$((128 + $1))"
1380         then
1381                 # POSIX
1382                 return 0
1383         elif test "$2" = "$((256 + $1))"
1384         then
1385                 # ksh
1386                 return 0
1387         fi
1388         return 1
1389 }
1390
1391 # Read up to "$1" bytes (or to EOF) from stdin and write them to stdout.
1392 test_copy_bytes () {
1393         perl -e '
1394                 my $len = $ARGV[1];
1395                 while ($len > 0) {
1396                         my $s;
1397                         my $nread = sysread(STDIN, $s, $len);
1398                         die "cannot read: $!" unless defined($nread);
1399                         last unless $nread;
1400                         print $s;
1401                         $len -= $nread;
1402                 }
1403         ' - "$1"
1404 }
1405
1406 # run "$@" inside a non-git directory
1407 nongit () {
1408         test -d non-repo ||
1409         mkdir non-repo ||
1410         return 1
1411
1412         (
1413                 GIT_CEILING_DIRECTORIES=$(pwd) &&
1414                 export GIT_CEILING_DIRECTORIES &&
1415                 cd non-repo &&
1416                 "$@" 2>&7
1417         )
1418 } 7>&2 2>&4
1419
1420 # convert function arguments or stdin (if not arguments given) to pktline
1421 # representation. If multiple arguments are given, they are separated by
1422 # whitespace and put in a single packet. Note that data containing NULs must be
1423 # given on stdin, and that empty input becomes an empty packet, not a flush
1424 # packet (for that you can just print 0000 yourself).
1425 packetize () {
1426         if test $# -gt 0
1427         then
1428                 packet="$*"
1429                 printf '%04x%s' "$((4 + ${#packet}))" "$packet"
1430         else
1431                 perl -e '
1432                         my $packet = do { local $/; <STDIN> };
1433                         printf "%04x%s", 4 + length($packet), $packet;
1434                 '
1435         fi
1436 }
1437
1438 # Parse the input as a series of pktlines, writing the result to stdout.
1439 # Sideband markers are removed automatically, and the output is routed to
1440 # stderr if appropriate.
1441 #
1442 # NUL bytes are converted to "\\0" for ease of parsing with text tools.
1443 depacketize () {
1444         perl -e '
1445                 while (read(STDIN, $len, 4) == 4) {
1446                         if ($len eq "0000") {
1447                                 print "FLUSH\n";
1448                         } else {
1449                                 read(STDIN, $buf, hex($len) - 4);
1450                                 $buf =~ s/\0/\\0/g;
1451                                 if ($buf =~ s/^[\x2\x3]//) {
1452                                         print STDERR $buf;
1453                                 } else {
1454                                         $buf =~ s/^\x1//;
1455                                         print $buf;
1456                                 }
1457                         }
1458                 }
1459         '
1460 }
1461
1462 # Converts base-16 data into base-8. The output is given as a sequence of
1463 # escaped octals, suitable for consumption by 'printf'.
1464 hex2oct () {
1465         perl -ne 'printf "\\%03o", hex for /../g'
1466 }
1467
1468 # Set the hash algorithm in use to $1.  Only useful when testing the testsuite.
1469 test_set_hash () {
1470         test_hash_algo="$1"
1471 }
1472
1473 # Detect the hash algorithm in use.
1474 test_detect_hash () {
1475         test_hash_algo="${GIT_TEST_DEFAULT_HASH:-sha1}"
1476 }
1477
1478 # Load common hash metadata and common placeholder object IDs for use with
1479 # test_oid.
1480 test_oid_init () {
1481         test -n "$test_hash_algo" || test_detect_hash &&
1482         test_oid_cache <"$TEST_DIRECTORY/oid-info/hash-info" &&
1483         test_oid_cache <"$TEST_DIRECTORY/oid-info/oid"
1484 }
1485
1486 # Load key-value pairs from stdin suitable for use with test_oid.  Blank lines
1487 # and lines starting with "#" are ignored.  Keys must be shell identifier
1488 # characters.
1489 #
1490 # Examples:
1491 # rawsz sha1:20
1492 # rawsz sha256:32
1493 test_oid_cache () {
1494         local tag rest k v &&
1495
1496         { test -n "$test_hash_algo" || test_detect_hash; } &&
1497         while read tag rest
1498         do
1499                 case $tag in
1500                 \#*)
1501                         continue;;
1502                 ?*)
1503                         # non-empty
1504                         ;;
1505                 *)
1506                         # blank line
1507                         continue;;
1508                 esac &&
1509
1510                 k="${rest%:*}" &&
1511                 v="${rest#*:}" &&
1512
1513                 if ! expr "$k" : '[a-z0-9][a-z0-9]*$' >/dev/null
1514                 then
1515                         BUG 'bad hash algorithm'
1516                 fi &&
1517                 eval "test_oid_${k}_$tag=\"\$v\""
1518         done
1519 }
1520
1521 # Look up a per-hash value based on a key ($1).  The value must have been loaded
1522 # by test_oid_init or test_oid_cache.
1523 test_oid () {
1524         local algo="${test_hash_algo}" &&
1525
1526         case "$1" in
1527         --hash=*)
1528                 algo="${1#--hash=}" &&
1529                 shift;;
1530         *)
1531                 ;;
1532         esac &&
1533
1534         local var="test_oid_${algo}_$1" &&
1535
1536         # If the variable is unset, we must be missing an entry for this
1537         # key-hash pair, so exit with an error.
1538         if eval "test -z \"\${$var+set}\""
1539         then
1540                 BUG "undefined key '$1'"
1541         fi &&
1542         eval "printf '%s' \"\${$var}\""
1543 }
1544
1545 # Insert a slash into an object ID so it can be used to reference a location
1546 # under ".git/objects".  For example, "deadbeef..." becomes "de/adbeef..".
1547 test_oid_to_path () {
1548         local basename=${1#??}
1549         echo "${1%$basename}/$basename"
1550 }
1551
1552 # Choose a port number based on the test script's number and store it in
1553 # the given variable name, unless that variable already contains a number.
1554 test_set_port () {
1555         local var=$1 port
1556
1557         if test $# -ne 1 || test -z "$var"
1558         then
1559                 BUG "test_set_port requires a variable name"
1560         fi
1561
1562         eval port=\$$var
1563         case "$port" in
1564         "")
1565                 # No port is set in the given env var, use the test
1566                 # number as port number instead.
1567                 # Remove not only the leading 't', but all leading zeros
1568                 # as well, so the arithmetic below won't (mis)interpret
1569                 # a test number like '0123' as an octal value.
1570                 port=${this_test#${this_test%%[1-9]*}}
1571                 if test "${port:-0}" -lt 1024
1572                 then
1573                         # root-only port, use a larger one instead.
1574                         port=$(($port + 10000))
1575                 fi
1576                 ;;
1577         *[!0-9]*|0*)
1578                 error >&7 "invalid port number: $port"
1579                 ;;
1580         *)
1581                 # The user has specified the port.
1582                 ;;
1583         esac
1584
1585         # Make sure that parallel '--stress' test jobs get different
1586         # ports.
1587         port=$(($port + ${GIT_TEST_STRESS_JOB_NR:-0}))
1588         eval $var=$port
1589 }
1590
1591 # Compare a file containing rev-list bitmap traversal output to its non-bitmap
1592 # counterpart. You can't just use test_cmp for this, because the two produce
1593 # subtly different output:
1594 #
1595 #   - regular output is in traversal order, whereas bitmap is split by type,
1596 #     with non-packed objects at the end
1597 #
1598 #   - regular output has a space and the pathname appended to non-commit
1599 #     objects; bitmap output omits this
1600 #
1601 # This function normalizes and compares the two. The second file should
1602 # always be the bitmap output.
1603 test_bitmap_traversal () {
1604         if test "$1" = "--no-confirm-bitmaps"
1605         then
1606                 shift
1607         elif cmp "$1" "$2"
1608         then
1609                 echo >&2 "identical raw outputs; are you sure bitmaps were used?"
1610                 return 1
1611         fi &&
1612         cut -d' ' -f1 "$1" | sort >"$1.normalized" &&
1613         sort "$2" >"$2.normalized" &&
1614         test_cmp "$1.normalized" "$2.normalized" &&
1615         rm -f "$1.normalized" "$2.normalized"
1616 }
1617
1618 # Tests for the hidden file attribute on Windows
1619 test_path_is_hidden () {
1620         test_have_prereq MINGW ||
1621         BUG "test_path_is_hidden can only be used on Windows"
1622
1623         # Use the output of `attrib`, ignore the absolute path
1624         case "$("$SYSTEMROOT"/system32/attrib "$1")" in *H*?:*) return 0;; esac
1625         return 1
1626 }
1627
1628 # Check that the given command was invoked as part of the
1629 # trace2-format trace on stdin.
1630 #
1631 #       test_subcommand [!] <command> <args>... < <trace>
1632 #
1633 # For example, to look for an invocation of "git upload-pack
1634 # /path/to/repo"
1635 #
1636 #       GIT_TRACE2_EVENT=event.log git fetch ... &&
1637 #       test_subcommand git upload-pack "$PATH" <event.log
1638 #
1639 # If the first parameter passed is !, this instead checks that
1640 # the given command was not called.
1641 #
1642 test_subcommand () {
1643         local negate=
1644         if test "$1" = "!"
1645         then
1646                 negate=t
1647                 shift
1648         fi
1649
1650         local expr=$(printf '"%s",' "$@")
1651         expr="${expr%,}"
1652
1653         if test -n "$negate"
1654         then
1655                 ! grep "\[$expr\]"
1656         else
1657                 grep "\[$expr\]"
1658         fi
1659 }