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