t/test-lib-functions.sh

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