t/test-lib-functions.sh

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