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