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