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