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