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         test_when_finished "test_unconfig ${config_dir:+-C '$config_dir'} '$1'" &&
 546         git ${config_dir:+-C "$config_dir"} config "$@"
 547 }
 548
 549 test_config_global () {
 550         test_when_finished "test_unconfig --global '$1'" &&
 551         git config --global "$@"
 552 }
 553
 554 write_script () {
 555         {
 556                 echo "#!${2-"$SHELL_PATH"}" &&
 557                 cat
 558         } >"$1" &&
 559         chmod +x "$1"
 560 }
 561
 562 # Usage: test_hook [options] <hook-name> <<-\EOF
 563 #
 564 #   -C <dir>:
 565 #       Run all git commands in directory <dir>
 566 #   --setup
 567 #       Setup a hook for subsequent tests, i.e. don't remove it in a
 568 #       "test_when_finished"
 569 #   --clobber
 570 #       Overwrite an existing <hook-name>, if it exists. Implies
 571 #       --setup (i.e. the "test_when_finished" is assumed to have been
 572 #       set up already).
 573 #    --disable
 574 #       Disable (chmod -x) an existing <hook-name>, which must exist.
 575 #    --remove
 576 #       Remove (rm -f) an existing <hook-name>, which must exist.
 577 test_hook () {
 578         setup= &&
 579         clobber= &&
 580         disable= &&
 581         remove= &&
 582         indir= &&
 583         while test $# != 0
 584         do
 585                 case "$1" in
 586                 -C)
 587                         indir="$2" &&
 588                         shift
 589                         ;;
 590                 --setup)
 591                         setup=t
 592                         ;;
 593                 --clobber)
 594                         clobber=t
 595                         ;;
 596                 --disable)
 597                         disable=t
 598                         ;;
 599                 --remove)
 600                         remove=t
 601                         ;;
 602                 -*)
 603                         BUG "invalid argument: $1"
 604                         ;;
 605                 *)
 606                         break
 607                         ;;
 608                 esac &&
 609                 shift
 610         done &&
 611
 612         git_dir=$(git -C "$indir" rev-parse --absolute-git-dir) &&
 613         hook_dir="$git_dir/hooks" &&
 614         hook_file="$hook_dir/$1" &&
 615         if test -n "$disable$remove"
 616         then
 617                 test_path_is_file "$hook_file" &&
 618                 if test -n "$disable"
 619                 then
 620                         chmod -x "$hook_file"
 621                 elif test -n "$remove"
 622                 then
 623                         rm -f "$hook_file"
 624                 fi &&
 625                 return 0
 626         fi &&
 627         if test -z "$clobber"
 628         then
 629                 test_path_is_missing "$hook_file"
 630         fi &&
 631         if test -z "$setup$clobber"
 632         then
 633                 test_when_finished "rm \"$hook_file\""
 634         fi &&
 635         write_script "$hook_file"
 636 }
 637
 638 # Use test_set_prereq to tell that a particular prerequisite is available.
 639 # The prerequisite can later be checked for in two ways:
 640 #
 641 # - Explicitly using test_have_prereq.
 642 #
 643 # - Implicitly by specifying the prerequisite tag in the calls to
 644 #   test_expect_{success,failure}
 645 #
 646 # The single parameter is the prerequisite tag (a simple word, in all
 647 # capital letters by convention).
 648
 649 test_unset_prereq () {
 650         ! test_have_prereq "$1" ||
 651         satisfied_prereq="${satisfied_prereq% $1 *} ${satisfied_prereq#* $1 }"
 652 }
 653
 654 test_set_prereq () {
 655         if test -n "$GIT_TEST_FAIL_PREREQS_INTERNAL"
 656         then
 657                 case "$1" in
 658                 # The "!" case is handled below with
 659                 # test_unset_prereq()
 660                 !*)
 661                         ;;
 662                 # List of things we can't easily pretend to not support
 663                 SYMLINKS)
 664                         ;;
 665                 # Inspecting whether GIT_TEST_FAIL_PREREQS is on
 666                 # should be unaffected.
 667                 FAIL_PREREQS)
 668                         ;;
 669                 *)
 670                         return
 671                 esac
 672         fi
 673
 674         case "$1" in
 675         !*)
 676                 test_unset_prereq "${1#!}"
 677                 ;;
 678         *)
 679                 satisfied_prereq="$satisfied_prereq$1 "
 680                 ;;
 681         esac
 682 }
 683 satisfied_prereq=" "
 684 lazily_testable_prereq= lazily_tested_prereq=
 685
 686 # Usage: test_lazy_prereq PREREQ 'script'
 687 test_lazy_prereq () {
 688         lazily_testable_prereq="$lazily_testable_prereq$1 "
 689         eval test_prereq_lazily_$1=\$2
 690 }
 691
 692 test_run_lazy_prereq_ () {
 693         script='
 694 mkdir -p "$TRASH_DIRECTORY/prereq-test-dir-'"$1"'" &&
 695 (
 696         cd "$TRASH_DIRECTORY/prereq-test-dir-'"$1"'" &&'"$2"'
 697 )'
 698         say >&3 "checking prerequisite: $1"
 699         say >&3 "$script"
 700         test_eval_ "$script"
 701         eval_ret=$?
 702         rm -rf "$TRASH_DIRECTORY/prereq-test-dir-$1"
 703         if test "$eval_ret" = 0; then
 704                 say >&3 "prerequisite $1 ok"
 705         else
 706                 say >&3 "prerequisite $1 not satisfied"
 707         fi
 708         return $eval_ret
 709 }
 710
 711 test_have_prereq () {
 712         # prerequisites can be concatenated with ','
 713         save_IFS=$IFS
 714         IFS=,
 715         set -- $*
 716         IFS=$save_IFS
 717
 718         total_prereq=0
 719         ok_prereq=0
 720         missing_prereq=
 721
 722         for prerequisite
 723         do
 724                 case "$prerequisite" in
 725                 !*)
 726                         negative_prereq=t
 727                         prerequisite=${prerequisite#!}
 728                         ;;
 729                 *)
 730                         negative_prereq=
 731                 esac
 732
 733                 case " $lazily_tested_prereq " in
 734                 *" $prerequisite "*)
 735                         ;;
 736                 *)
 737                         case " $lazily_testable_prereq " in
 738                         *" $prerequisite "*)
 739                                 eval "script=\$test_prereq_lazily_$prerequisite" &&
 740                                 if test_run_lazy_prereq_ "$prerequisite" "$script"
 741                                 then
 742                                         test_set_prereq $prerequisite
 743                                 fi
 744                                 lazily_tested_prereq="$lazily_tested_prereq$prerequisite "
 745                         esac
 746                         ;;
 747                 esac
 748
 749                 total_prereq=$(($total_prereq + 1))
 750                 case "$satisfied_prereq" in
 751                 *" $prerequisite "*)
 752                         satisfied_this_prereq=t
 753                         ;;
 754                 *)
 755                         satisfied_this_prereq=
 756                 esac
 757
 758                 case "$satisfied_this_prereq,$negative_prereq" in
 759                 t,|,t)
 760                         ok_prereq=$(($ok_prereq + 1))
 761                         ;;
 762                 *)
 763                         # Keep a list of missing prerequisites; restore
 764                         # the negative marker if necessary.
 765                         prerequisite=${negative_prereq:+!}$prerequisite
 766
 767                         # Abort if this prereq was marked as required
 768                         if test -n "$GIT_TEST_REQUIRE_PREREQ"
 769                         then
 770                                 case " $GIT_TEST_REQUIRE_PREREQ " in
 771                                 *" $prerequisite "*)
 772                                         BAIL_OUT "required prereq $prerequisite failed"
 773                                         ;;
 774                                 esac
 775                         fi
 776
 777                         if test -z "$missing_prereq"
 778                         then
 779                                 missing_prereq=$prerequisite
 780                         else
 781                                 missing_prereq="$prerequisite,$missing_prereq"
 782                         fi
 783                 esac
 784         done
 785
 786         test $total_prereq = $ok_prereq
 787 }
 788
 789 test_declared_prereq () {
 790         case ",$test_prereq," in
 791         *,$1,*)
 792                 return 0
 793                 ;;
 794         esac
 795         return 1
 796 }
 797
 798 test_verify_prereq () {
 799         test -z "$test_prereq" ||
 800         expr >/dev/null "$test_prereq" : '[A-Z0-9_,!]*$' ||
 801         BUG "'$test_prereq' does not look like a prereq"
 802 }
 803
 804 test_expect_failure () {
 805         test_start_ "$@"
 806         test "$#" = 3 && { test_prereq=$1; shift; } || test_prereq=
 807         test "$#" = 2 ||
 808         BUG "not 2 or 3 parameters to test-expect-failure"
 809         test_verify_prereq
 810         export test_prereq
 811         if ! test_skip "$@"
 812         then
 813                 test -n "$test_skip_test_preamble" ||
 814                 say >&3 "checking known breakage of $TEST_NUMBER.$test_count '$1': $2"
 815                 if test_run_ "$2" expecting_failure
 816                 then
 817                         test_known_broken_ok_ "$1"
 818                 else
 819                         test_known_broken_failure_ "$1"
 820                 fi
 821         fi
 822         test_finish_
 823 }
 824
 825 test_expect_success () {
 826         test_start_ "$@"
 827         test "$#" = 3 && { test_prereq=$1; shift; } || test_prereq=
 828         test "$#" = 2 ||
 829         BUG "not 2 or 3 parameters to test-expect-success"
 830         test_verify_prereq
 831         export test_prereq
 832         if ! test_skip "$@"
 833         then
 834                 test -n "$test_skip_test_preamble" ||
 835                 say >&3 "expecting success of $TEST_NUMBER.$test_count '$1': $2"
 836                 if test_run_ "$2"
 837                 then
 838                         test_ok_ "$1"
 839                 else
 840                         test_failure_ "$@"
 841                 fi
 842         fi
 843         test_finish_
 844 }
 845
 846 # debugging-friendly alternatives to "test [-f|-d|-e]"
 847 # The commands test the existence or non-existence of $1
 848 test_path_is_file () {
 849         test "$#" -ne 1 && BUG "1 param"
 850         if ! test -f "$1"
 851         then
 852                 echo "File $1 doesn't exist"
 853                 false
 854         fi
 855 }
 856
 857 test_path_is_file_not_symlink () {
 858         test "$#" -ne 1 && BUG "1 param"
 859         test_path_is_file "$1" &&
 860         if test -h "$1"
 861         then
 862                 echo "$1 shouldn't be a symbolic link"
 863                 false
 864         fi
 865 }
 866
 867 test_path_is_dir () {
 868         test "$#" -ne 1 && BUG "1 param"
 869         if ! test -d "$1"
 870         then
 871                 echo "Directory $1 doesn't exist"
 872                 false
 873         fi
 874 }
 875
 876 test_path_is_dir_not_symlink () {
 877         test "$#" -ne 1 && BUG "1 param"
 878         test_path_is_dir "$1" &&
 879         if test -h "$1"
 880         then
 881                 echo "$1 shouldn't be a symbolic link"
 882                 false
 883         fi
 884 }
 885
 886 test_path_exists () {
 887         test "$#" -ne 1 && BUG "1 param"
 888         if ! test -e "$1"
 889         then
 890                 echo "Path $1 doesn't exist"
 891                 false
 892         fi
 893 }
 894
 895 test_path_is_symlink () {
 896         test "$#" -ne 1 && BUG "1 param"
 897         if ! test -h "$1"
 898         then
 899                 echo "Symbolic link $1 doesn't exist"
 900                 false
 901         fi
 902 }
 903
 904 # Check if the directory exists and is empty as expected, barf otherwise.
 905 test_dir_is_empty () {
 906         test "$#" -ne 1 && BUG "1 param"
 907         test_path_is_dir "$1" &&
 908         if test -n "$(ls -a1 "$1" | grep -E -v '^\.\.?$')"
 909         then
 910                 echo "Directory '$1' is not empty, it contains:"
 911                 ls -la "$1"
 912                 return 1
 913         fi
 914 }
 915
 916 # Check if the file exists and has a size greater than zero
 917 test_file_not_empty () {
 918         test "$#" = 2 && BUG "2 param"
 919         if ! test -s "$1"
 920         then
 921                 echo "'$1' is not a non-empty file."
 922                 false
 923         fi
 924 }
 925
 926 test_path_is_missing () {
 927         test "$#" -ne 1 && BUG "1 param"
 928         if test -e "$1"
 929         then
 930                 echo "Path exists:"
 931                 ls -ld "$1"
 932                 false
 933         fi
 934 }
 935
 936 # test_line_count checks that a file has the number of lines it
 937 # ought to. For example:
 938 #
 939 #       test_expect_success 'produce exactly one line of output' '
 940 #               do something >output &&
 941 #               test_line_count = 1 output
 942 #       '
 943 #
 944 # is like "test $(wc -l <output) = 1" except that it passes the
 945 # output through when the number of lines is wrong.
 946
 947 test_line_count () {
 948         if test $# != 3
 949         then
 950                 BUG "not 3 parameters to test_line_count"
 951         elif ! test $(wc -l <"$3") "$1" "$2"
 952         then
 953                 echo "test_line_count: line count for $3 !$1 $2"
 954                 cat "$3"
 955                 return 1
 956         fi
 957 }
 958
 959 # SYNOPSIS:
 960 #       test_stdout_line_count <bin-ops> <value> <cmd> [<args>...]
 961 #
 962 # test_stdout_line_count checks that the output of a command has the number
 963 # of lines it ought to. For example:
 964 #
 965 # test_stdout_line_count = 3 git ls-files -u
 966 # test_stdout_line_count -gt 10 ls
 967 test_stdout_line_count () {
 968         local ops val trashdir &&
 969         if test "$#" -le 3
 970         then
 971                 BUG "expect 3 or more arguments"
 972         fi &&
 973         ops="$1" &&
 974         val="$2" &&
 975         shift 2 &&
 976         if ! trashdir="$(git rev-parse --git-dir)/trash"; then
 977                 BUG "expect to be run inside a worktree"
 978         fi &&
 979         mkdir -p "$trashdir" &&
 980         "$@" >"$trashdir/output" &&
 981         test_line_count "$ops" "$val" "$trashdir/output"
 982 }
 983
 984
 985 test_file_size () {
 986         test "$#" -ne 1 && BUG "1 param"
 987         test-tool path-utils file-size "$1"
 988 }
 989
 990 # Returns success if a comma separated string of keywords ($1) contains a
 991 # given keyword ($2).
 992 # Examples:
 993 # `list_contains "foo,bar" bar` returns 0
 994 # `list_contains "foo" bar` returns 1
 995
 996 list_contains () {
 997         case ",$1," in
 998         *,$2,*)
 999                 return 0
1000                 ;;
1001         esac
1002         return 1
1003 }
1004
1005 # Returns success if the arguments indicate that a command should be
1006 # accepted by test_must_fail(). If the command is run with env, the env
1007 # and its corresponding variable settings will be stripped before we
1008 # test the command being run.
1009 test_must_fail_acceptable () {
1010         if test "$1" = "env"
1011         then
1012                 shift
1013                 while test $# -gt 0
1014                 do
1015                         case "$1" in
1016                         *?=*)
1017                                 shift
1018                                 ;;
1019                         *)
1020                                 break
1021                                 ;;
1022                         esac
1023                 done
1024         fi
1025
1026         case "$1" in
1027         git|__git*|scalar|test-tool|test_terminal)
1028                 return 0
1029                 ;;
1030         *)
1031                 return 1
1032                 ;;
1033         esac
1034 }
1035
1036 # This is not among top-level (test_expect_success | test_expect_failure)
1037 # but is a prefix that can be used in the test script, like:
1038 #
1039 #       test_expect_success 'complain and die' '
1040 #           do something &&
1041 #           do something else &&
1042 #           test_must_fail git checkout ../outerspace
1043 #       '
1044 #
1045 # Writing this as "! git checkout ../outerspace" is wrong, because
1046 # the failure could be due to a segv.  We want a controlled failure.
1047 #
1048 # Accepts the following options:
1049 #
1050 #   ok=<signal-name>[,<...>]:
1051 #     Don't treat an exit caused by the given signal as error.
1052 #     Multiple signals can be specified as a comma separated list.
1053 #     Currently recognized signal names are: sigpipe, success.
1054 #     (Don't use 'success', use 'test_might_fail' instead.)
1055 #
1056 # Do not use this to run anything but "git" and other specific testable
1057 # commands (see test_must_fail_acceptable()).  We are not in the
1058 # business of vetting system supplied commands -- in other words, this
1059 # is wrong:
1060 #
1061 #    test_must_fail grep pattern output
1062 #
1063 # Instead use '!':
1064 #
1065 #    ! grep pattern output
1066
1067 test_must_fail () {
1068         case "$1" in
1069         ok=*)
1070                 _test_ok=${1#ok=}
1071                 shift
1072                 ;;
1073         *)
1074                 _test_ok=
1075                 ;;
1076         esac
1077         if ! test_must_fail_acceptable "$@"
1078         then
1079                 echo >&7 "test_must_fail: only 'git' is allowed: $*"
1080                 return 1
1081         fi
1082         "$@" 2>&7
1083         exit_code=$?
1084         if test $exit_code -eq 0 && ! list_contains "$_test_ok" success
1085         then
1086                 echo >&4 "test_must_fail: command succeeded: $*"
1087                 return 1
1088         elif test_match_signal 13 $exit_code && list_contains "$_test_ok" sigpipe
1089         then
1090                 return 0
1091         elif test $exit_code -gt 129 && test $exit_code -le 192
1092         then
1093                 echo >&4 "test_must_fail: died by signal $(($exit_code - 128)): $*"
1094                 return 1
1095         elif test $exit_code -eq 127
1096         then
1097                 echo >&4 "test_must_fail: command not found: $*"
1098                 return 1
1099         elif test $exit_code -eq 126
1100         then
1101                 echo >&4 "test_must_fail: valgrind error: $*"
1102                 return 1
1103         fi
1104         return 0
1105 } 7>&2 2>&4
1106
1107 # Similar to test_must_fail, but tolerates success, too.  This is
1108 # meant to be used in contexts like:
1109 #
1110 #       test_expect_success 'some command works without configuration' '
1111 #               test_might_fail git config --unset all.configuration &&
1112 #               do something
1113 #       '
1114 #
1115 # Writing "git config --unset all.configuration || :" would be wrong,
1116 # because we want to notice if it fails due to segv.
1117 #
1118 # Accepts the same options as test_must_fail.
1119
1120 test_might_fail () {
1121         test_must_fail ok=success "$@" 2>&7
1122 } 7>&2 2>&4
1123
1124 # Similar to test_must_fail and test_might_fail, but check that a
1125 # given command exited with a given exit code. Meant to be used as:
1126 #
1127 #       test_expect_success 'Merge with d/f conflicts' '
1128 #               test_expect_code 1 git merge "merge msg" B master
1129 #       '
1130
1131 test_expect_code () {
1132         want_code=$1
1133         shift
1134         "$@" 2>&7
1135         exit_code=$?
1136         if test $exit_code = $want_code
1137         then
1138                 return 0
1139         fi
1140
1141         echo >&4 "test_expect_code: command exited with $exit_code, we wanted $want_code $*"
1142         return 1
1143 } 7>&2 2>&4
1144
1145 # test_cmp is a helper function to compare actual and expected output.
1146 # You can use it like:
1147 #
1148 #       test_expect_success 'foo works' '
1149 #               echo expected >expected &&
1150 #               foo >actual &&
1151 #               test_cmp expected actual
1152 #       '
1153 #
1154 # This could be written as either "cmp" or "diff -u", but:
1155 # - cmp's output is not nearly as easy to read as diff -u
1156 # - not all diff versions understand "-u"
1157
1158 test_cmp () {
1159         test "$#" -ne 2 && BUG "2 param"
1160         eval "$GIT_TEST_CMP" '"$@"'
1161 }
1162
1163 # Check that the given config key has the expected value.
1164 #
1165 #    test_cmp_config [-C <dir>] <expected-value>
1166 #                    [<git-config-options>...] <config-key>
1167 #
1168 # for example to check that the value of core.bar is foo
1169 #
1170 #    test_cmp_config foo core.bar
1171 #
1172 test_cmp_config () {
1173         local GD &&
1174         if test "$1" = "-C"
1175         then
1176                 shift &&
1177                 GD="-C $1" &&
1178                 shift
1179         fi &&
1180         printf "%s\n" "$1" >expect.config &&
1181         shift &&
1182         git $GD config "$@" >actual.config &&
1183         test_cmp expect.config actual.config
1184 }
1185
1186 # test_cmp_bin - helper to compare binary files
1187
1188 test_cmp_bin () {
1189         test "$#" -ne 2 && BUG "2 param"
1190         cmp "$@"
1191 }
1192
1193 # Wrapper for grep which used to be used for
1194 # GIT_TEST_GETTEXT_POISON=false. Only here as a shim for other
1195 # in-flight changes. Should not be used and will be removed soon.
1196 test_i18ngrep () {
1197         eval "last_arg=\${$#}"
1198
1199         test -f "$last_arg" ||
1200         BUG "test_i18ngrep requires a file to read as the last parameter"
1201
1202         if test $# -lt 2 ||
1203            { test "x!" = "x$1" && test $# -lt 3 ; }
1204         then
1205                 BUG "too few parameters to test_i18ngrep"
1206         fi
1207
1208         if test "x!" = "x$1"
1209         then
1210                 shift
1211                 ! grep "$@" && return 0
1212
1213                 echo >&4 "error: '! grep $@' did find a match in:"
1214         else
1215                 grep "$@" && return 0
1216
1217                 echo >&4 "error: 'grep $@' didn't find a match in:"
1218         fi
1219
1220         if test -s "$last_arg"
1221         then
1222                 cat >&4 "$last_arg"
1223         else
1224                 echo >&4 "<File '$last_arg' is empty>"
1225         fi
1226
1227         return 1
1228 }
1229
1230 # Check if the file expected to be empty is indeed empty, and barfs
1231 # otherwise.
1232
1233 test_must_be_empty () {
1234         test "$#" -ne 1 && BUG "1 param"
1235         test_path_is_file "$1" &&
1236         if test -s "$1"
1237         then
1238                 echo "'$1' is not empty, it contains:"
1239                 cat "$1"
1240                 return 1
1241         fi
1242 }
1243
1244 # Tests that its two parameters refer to the same revision, or if '!' is
1245 # provided first, that its other two parameters refer to different
1246 # revisions.
1247 test_cmp_rev () {
1248         local op='=' wrong_result=different
1249
1250         if test $# -ge 1 && test "x$1" = 'x!'
1251         then
1252             op='!='
1253             wrong_result='the same'
1254             shift
1255         fi
1256         if test $# != 2
1257         then
1258                 BUG "test_cmp_rev requires two revisions, but got $#"
1259         else
1260                 local r1 r2
1261                 r1=$(git rev-parse --verify "$1") &&
1262                 r2=$(git rev-parse --verify "$2") || return 1
1263
1264                 if ! test "$r1" "$op" "$r2"
1265                 then
1266                         cat >&4 <<-EOF
1267                         error: two revisions point to $wrong_result objects:
1268                           '$1': $r1
1269                           '$2': $r2
1270                         EOF
1271                         return 1
1272                 fi
1273         fi
1274 }
1275
1276 # Compare paths respecting core.ignoreCase
1277 test_cmp_fspath () {
1278         if test "x$1" = "x$2"
1279         then
1280                 return 0
1281         fi
1282
1283         if test true != "$(git config --get --type=bool core.ignorecase)"
1284         then
1285                 return 1
1286         fi
1287
1288         test "x$(echo "$1" | tr A-Z a-z)" =  "x$(echo "$2" | tr A-Z a-z)"
1289 }
1290
1291 # Print a sequence of integers in increasing order, either with
1292 # two arguments (start and end):
1293 #
1294 #     test_seq 1 5 -- outputs 1 2 3 4 5 one line at a time
1295 #
1296 # or with one argument (end), in which case it starts counting
1297 # from 1.
1298
1299 test_seq () {
1300         case $# in
1301         1)      set 1 "$@" ;;
1302         2)      ;;
1303         *)      BUG "not 1 or 2 parameters to test_seq" ;;
1304         esac
1305         test_seq_counter__=$1
1306         while test "$test_seq_counter__" -le "$2"
1307         do
1308                 echo "$test_seq_counter__"
1309                 test_seq_counter__=$(( $test_seq_counter__ + 1 ))
1310         done
1311 }
1312
1313 # This function can be used to schedule some commands to be run
1314 # unconditionally at the end of the test to restore sanity:
1315 #
1316 #       test_expect_success 'test core.capslock' '
1317 #               git config core.capslock true &&
1318 #               test_when_finished "git config --unset core.capslock" &&
1319 #               hello world
1320 #       '
1321 #
1322 # That would be roughly equivalent to
1323 #
1324 #       test_expect_success 'test core.capslock' '
1325 #               git config core.capslock true &&
1326 #               hello world
1327 #               git config --unset core.capslock
1328 #       '
1329 #
1330 # except that the greeting and config --unset must both succeed for
1331 # the test to pass.
1332 #
1333 # Note that under --immediate mode, no clean-up is done to help diagnose
1334 # what went wrong.
1335
1336 test_when_finished () {
1337         # We cannot detect when we are in a subshell in general, but by
1338         # doing so on Bash is better than nothing (the test will
1339         # silently pass on other shells).
1340         test "${BASH_SUBSHELL-0}" = 0 ||
1341         BUG "test_when_finished does nothing in a subshell"
1342         test_cleanup="{ $*
1343                 } && (exit \"\$eval_ret\"); eval_ret=\$?; $test_cleanup"
1344 }
1345
1346 # This function can be used to schedule some commands to be run
1347 # unconditionally at the end of the test script, e.g. to stop a daemon:
1348 #
1349 #       test_expect_success 'test git daemon' '
1350 #               git daemon &
1351 #               daemon_pid=$! &&
1352 #               test_atexit 'kill $daemon_pid' &&
1353 #               hello world
1354 #       '
1355 #
1356 # The commands will be executed before the trash directory is removed,
1357 # i.e. the atexit commands will still be able to access any pidfiles or
1358 # socket files.
1359 #
1360 # Note that these commands will be run even when a test script run
1361 # with '--immediate' fails.  Be careful with your atexit commands to
1362 # minimize any changes to the failed state.
1363
1364 test_atexit () {
1365         # We cannot detect when we are in a subshell in general, but by
1366         # doing so on Bash is better than nothing (the test will
1367         # silently pass on other shells).
1368         test "${BASH_SUBSHELL-0}" = 0 ||
1369         BUG "test_atexit does nothing in a subshell"
1370         test_atexit_cleanup="{ $*
1371                 } && (exit \"\$eval_ret\"); eval_ret=\$?; $test_atexit_cleanup"
1372 }
1373
1374 # Deprecated wrapper for "git init", use "git init" directly instead
1375 # Usage: test_create_repo <directory>
1376 test_create_repo () {
1377         git init "$@"
1378 }
1379
1380 # This function helps on symlink challenged file systems when it is not
1381 # important that the file system entry is a symbolic link.
1382 # Use test_ln_s_add instead of "ln -s x y && git add y" to add a
1383 # symbolic link entry y to the index.
1384
1385 test_ln_s_add () {
1386         if test_have_prereq SYMLINKS
1387         then
1388                 ln -s "$1" "$2" &&
1389                 git update-index --add "$2"
1390         else
1391                 printf '%s' "$1" >"$2" &&
1392                 ln_s_obj=$(git hash-object -w "$2") &&
1393                 git update-index --add --cacheinfo 120000 $ln_s_obj "$2" &&
1394                 # pick up stat info from the file
1395                 git update-index "$2"
1396         fi
1397 }
1398
1399 # This function writes out its parameters, one per line
1400 test_write_lines () {
1401         printf "%s\n" "$@"
1402 }
1403
1404 perl () {
1405         command "$PERL_PATH" "$@" 2>&7
1406 } 7>&2 2>&4
1407
1408 # Given the name of an environment variable with a bool value, normalize
1409 # its value to a 0 (true) or 1 (false or empty string) return code.
1410 #
1411 #   test_bool_env GIT_TEST_HTTPD <default-value>
1412 #
1413 # Return with code corresponding to the given default value if the variable
1414 # is unset.
1415 # Abort the test script if either the value of the variable or the default
1416 # are not valid bool values.
1417
1418 test_bool_env () {
1419         if test $# != 2
1420         then
1421                 BUG "test_bool_env requires two parameters (variable name and default value)"
1422         fi
1423
1424         test-tool env-helper --type=bool --default="$2" --exit-code "$1"
1425         ret=$?
1426         case $ret in
1427         0|1)    # unset or valid bool value
1428                 ;;
1429         *)      # invalid bool value or something unexpected
1430                 error >&7 "test_bool_env requires bool values both for \$$1 and for the default fallback"
1431                 ;;
1432         esac
1433         return $ret
1434 }
1435
1436 # Exit the test suite, either by skipping all remaining tests or by
1437 # exiting with an error. If our prerequisite variable $1 falls back
1438 # on a default assume we were opportunistically trying to set up some
1439 # tests and we skip. If it is explicitly "true", then we report a failure.
1440 #
1441 # The error/skip message should be given by $2.
1442 #
1443 test_skip_or_die () {
1444         if ! test_bool_env "$1" false
1445         then
1446                 skip_all=$2
1447                 test_done
1448         fi
1449         error "$2"
1450 }
1451
1452 # Like "env FOO=BAR some-program", but run inside a subshell, which means
1453 # it also works for shell functions (though those functions cannot impact
1454 # the environment outside of the test_env invocation).
1455 test_env () {
1456         (
1457                 while test $# -gt 0
1458                 do
1459                         case "$1" in
1460                         *=*)
1461                                 eval "${1%%=*}=\${1#*=}"
1462                                 eval "export ${1%%=*}"
1463                                 shift
1464                                 ;;
1465                         *)
1466                                 "$@" 2>&7
1467                                 exit
1468                                 ;;
1469                         esac
1470                 done
1471         )
1472 } 7>&2 2>&4
1473
1474 # Returns true if the numeric exit code in "$2" represents the expected signal
1475 # in "$1". Signals should be given numerically.
1476 test_match_signal () {
1477         if test "$2" = "$((128 + $1))"
1478         then
1479                 # POSIX
1480                 return 0
1481         elif test "$2" = "$((256 + $1))"
1482         then
1483                 # ksh
1484                 return 0
1485         fi
1486         return 1
1487 }
1488
1489 # Read up to "$1" bytes (or to EOF) from stdin and write them to stdout.
1490 test_copy_bytes () {
1491         perl -e '
1492                 my $len = $ARGV[1];
1493                 while ($len > 0) {
1494                         my $s;
1495                         my $nread = sysread(STDIN, $s, $len);
1496                         die "cannot read: $!" unless defined($nread);
1497                         last unless $nread;
1498                         print $s;
1499                         $len -= $nread;
1500                 }
1501         ' - "$1"
1502 }
1503
1504 # run "$@" inside a non-git directory
1505 nongit () {
1506         test -d non-repo ||
1507         mkdir non-repo ||
1508         return 1
1509
1510         (
1511                 GIT_CEILING_DIRECTORIES=$(pwd) &&
1512                 export GIT_CEILING_DIRECTORIES &&
1513                 cd non-repo &&
1514                 "$@" 2>&7
1515         )
1516 } 7>&2 2>&4
1517
1518 # These functions are historical wrappers around "test-tool pkt-line"
1519 # for older tests. Use "test-tool pkt-line" itself in new tests.
1520 packetize () {
1521         if test $# -gt 0
1522         then
1523                 packet="$*"
1524                 printf '%04x%s' "$((4 + ${#packet}))" "$packet"
1525         else
1526                 test-tool pkt-line pack
1527         fi
1528 }
1529
1530 packetize_raw () {
1531         test-tool pkt-line pack-raw-stdin
1532 }
1533
1534 depacketize () {
1535         test-tool pkt-line unpack
1536 }
1537
1538 # Converts base-16 data into base-8. The output is given as a sequence of
1539 # escaped octals, suitable for consumption by 'printf'.
1540 hex2oct () {
1541         perl -ne 'printf "\\%03o", hex for /../g'
1542 }
1543
1544 # Set the hash algorithm in use to $1.  Only useful when testing the testsuite.
1545 test_set_hash () {
1546         test_hash_algo="$1"
1547 }
1548
1549 # Detect the hash algorithm in use.
1550 test_detect_hash () {
1551         test_hash_algo="${GIT_TEST_DEFAULT_HASH:-sha1}"
1552 }
1553
1554 # Load common hash metadata and common placeholder object IDs for use with
1555 # test_oid.
1556 test_oid_init () {
1557         test -n "$test_hash_algo" || test_detect_hash &&
1558         test_oid_cache <"$TEST_DIRECTORY/oid-info/hash-info" &&
1559         test_oid_cache <"$TEST_DIRECTORY/oid-info/oid"
1560 }
1561
1562 # Load key-value pairs from stdin suitable for use with test_oid.  Blank lines
1563 # and lines starting with "#" are ignored.  Keys must be shell identifier
1564 # characters.
1565 #
1566 # Examples:
1567 # rawsz sha1:20
1568 # rawsz sha256:32
1569 test_oid_cache () {
1570         local tag rest k v &&
1571
1572         { test -n "$test_hash_algo" || test_detect_hash; } &&
1573         while read tag rest
1574         do
1575                 case $tag in
1576                 \#*)
1577                         continue;;
1578                 ?*)
1579                         # non-empty
1580                         ;;
1581                 *)
1582                         # blank line
1583                         continue;;
1584                 esac &&
1585
1586                 k="${rest%:*}" &&
1587                 v="${rest#*:}" &&
1588
1589                 if ! expr "$k" : '[a-z0-9][a-z0-9]*$' >/dev/null
1590                 then
1591                         BUG 'bad hash algorithm'
1592                 fi &&
1593                 eval "test_oid_${k}_$tag=\"\$v\""
1594         done
1595 }
1596
1597 # Look up a per-hash value based on a key ($1).  The value must have been loaded
1598 # by test_oid_init or test_oid_cache.
1599 test_oid () {
1600         local algo="${test_hash_algo}" &&
1601
1602         case "$1" in
1603         --hash=*)
1604                 algo="${1#--hash=}" &&
1605                 shift;;
1606         *)
1607                 ;;
1608         esac &&
1609
1610         local var="test_oid_${algo}_$1" &&
1611
1612         # If the variable is unset, we must be missing an entry for this
1613         # key-hash pair, so exit with an error.
1614         if eval "test -z \"\${$var+set}\""
1615         then
1616                 BUG "undefined key '$1'"
1617         fi &&
1618         eval "printf '%s\n' \"\${$var}\""
1619 }
1620
1621 # Insert a slash into an object ID so it can be used to reference a location
1622 # under ".git/objects".  For example, "deadbeef..." becomes "de/adbeef..".
1623 test_oid_to_path () {
1624         local basename=${1#??}
1625         echo "${1%$basename}/$basename"
1626 }
1627
1628 # Parse oids from git ls-files --staged output
1629 test_parse_ls_files_stage_oids () {
1630         awk '{print $2}' -
1631 }
1632
1633 # Parse oids from git ls-tree output
1634 test_parse_ls_tree_oids () {
1635         awk '{print $3}' -
1636 }
1637
1638 # Choose a port number based on the test script's number and store it in
1639 # the given variable name, unless that variable already contains a number.
1640 test_set_port () {
1641         local var=$1 port
1642
1643         if test $# -ne 1 || test -z "$var"
1644         then
1645                 BUG "test_set_port requires a variable name"
1646         fi
1647
1648         eval port=\$$var
1649         case "$port" in
1650         "")
1651                 # No port is set in the given env var, use the test
1652                 # number as port number instead.
1653                 # Remove not only the leading 't', but all leading zeros
1654                 # as well, so the arithmetic below won't (mis)interpret
1655                 # a test number like '0123' as an octal value.
1656                 port=${this_test#${this_test%%[1-9]*}}
1657                 if test "${port:-0}" -lt 1024
1658                 then
1659                         # root-only port, use a larger one instead.
1660                         port=$(($port + 10000))
1661                 fi
1662                 ;;
1663         *[!0-9]*|0*)
1664                 error >&7 "invalid port number: $port"
1665                 ;;
1666         *)
1667                 # The user has specified the port.
1668                 ;;
1669         esac
1670
1671         # Make sure that parallel '--stress' test jobs get different
1672         # ports.
1673         port=$(($port + ${GIT_TEST_STRESS_JOB_NR:-0}))
1674         eval $var=$port
1675 }
1676
1677 # Tests for the hidden file attribute on Windows
1678 test_path_is_hidden () {
1679         test_have_prereq MINGW ||
1680         BUG "test_path_is_hidden can only be used on Windows"
1681
1682         # Use the output of `attrib`, ignore the absolute path
1683         case "$("$SYSTEMROOT"/system32/attrib "$1")" in *H*?:*) return 0;; esac
1684         return 1
1685 }
1686
1687 # Poor man's URI escaping. Good enough for the test suite whose trash
1688 # directory has a space in it. See 93c3fcbe4d4 (git-svn: attempt to
1689 # mimic SVN 1.7 URL canonicalization, 2012-07-28) for prior art.
1690 test_uri_escape() {
1691         sed 's/ /%20/g'
1692 }
1693
1694 # Check that the given command was invoked as part of the
1695 # trace2-format trace on stdin.
1696 #
1697 #       test_subcommand [!] <command> <args>... < <trace>
1698 #
1699 # For example, to look for an invocation of "git upload-pack
1700 # /path/to/repo"
1701 #
1702 #       GIT_TRACE2_EVENT=event.log git fetch ... &&
1703 #       test_subcommand git upload-pack "$PATH" <event.log
1704 #
1705 # If the first parameter passed is !, this instead checks that
1706 # the given command was not called.
1707 #
1708 test_subcommand () {
1709         local negate=
1710         if test "$1" = "!"
1711         then
1712                 negate=t
1713                 shift
1714         fi
1715
1716         local expr=$(printf '"%s",' "$@")
1717         expr="${expr%,}"
1718
1719         if test -n "$negate"
1720         then
1721                 ! grep "\[$expr\]"
1722         else
1723                 grep "\[$expr\]"
1724         fi
1725 }
1726
1727 # Check that the given command was invoked as part of the
1728 # trace2-format trace on stdin.
1729 #
1730 #       test_region [!] <category> <label> git <command> <args>...
1731 #
1732 # For example, to look for trace2_region_enter("index", "do_read_index", repo)
1733 # in an invocation of "git checkout HEAD~1", run
1734 #
1735 #       GIT_TRACE2_EVENT="$(pwd)/trace.txt" GIT_TRACE2_EVENT_NESTING=10 \
1736 #               git checkout HEAD~1 &&
1737 #       test_region index do_read_index <trace.txt
1738 #
1739 # If the first parameter passed is !, this instead checks that
1740 # the given region was not entered.
1741 #
1742 test_region () {
1743         local expect_exit=0
1744         if test "$1" = "!"
1745         then
1746                 expect_exit=1
1747                 shift
1748         fi
1749
1750         grep -e '"region_enter".*"category":"'"$1"'","label":"'"$2"\" "$3"
1751         exitcode=$?
1752
1753         if test $exitcode != $expect_exit
1754         then
1755                 return 1
1756         fi
1757
1758         grep -e '"region_leave".*"category":"'"$1"'","label":"'"$2"\" "$3"
1759         exitcode=$?
1760
1761         if test $exitcode != $expect_exit
1762         then
1763                 return 1
1764         fi
1765
1766         return 0
1767 }
1768
1769 # Given a GIT_TRACE2_EVENT log over stdin, writes to stdout a list of URLs
1770 # sent to git-remote-https child processes.
1771 test_remote_https_urls() {
1772         grep -e '"event":"child_start".*"argv":\["git-remote-https",".*"\]' |
1773                 sed -e 's/{"event":"child_start".*"argv":\["git-remote-https","//g' \
1774                     -e 's/"\]}//g'
1775 }
1776
1777 # Print the destination of symlink(s) provided as arguments. Basically
1778 # the same as the readlink command, but it's not available everywhere.
1779 test_readlink () {
1780         perl -le 'print readlink($_) for @ARGV' "$@"
1781 }
1782
1783 # Set mtime to a fixed "magic" timestamp in mid February 2009, before we
1784 # run an operation that may or may not touch the file.  If the file was
1785 # touched, its timestamp will not accidentally have such an old timestamp,
1786 # as long as your filesystem clock is reasonably correct.  To verify the
1787 # timestamp, follow up with test_is_magic_mtime.
1788 #
1789 # An optional increment to the magic timestamp may be specified as second
1790 # argument.
1791 test_set_magic_mtime () {
1792         local inc=${2:-0} &&
1793         local mtime=$((1234567890 + $inc)) &&
1794         test-tool chmtime =$mtime "$1" &&
1795         test_is_magic_mtime "$1" $inc
1796 }
1797
1798 # Test whether the given file has the "magic" mtime set.  This is meant to
1799 # be used in combination with test_set_magic_mtime.
1800 #
1801 # An optional increment to the magic timestamp may be specified as second
1802 # argument.  Usually, this should be the same increment which was used for
1803 # the associated test_set_magic_mtime.
1804 test_is_magic_mtime () {
1805         local inc=${2:-0} &&
1806         local mtime=$((1234567890 + $inc)) &&
1807         echo $mtime >.git/test-mtime-expect &&
1808         test-tool chmtime --get "$1" >.git/test-mtime-actual &&
1809         test_cmp .git/test-mtime-expect .git/test-mtime-actual
1810         local ret=$?
1811         rm -f .git/test-mtime-expect
1812         rm -f .git/test-mtime-actual
1813         return $ret
1814 }
1815
1816 # Given two filenames, parse both using 'git config --list --file'
1817 # and compare the sorted output of those commands. Useful when
1818 # wanting to ignore whitespace differences and sorting concerns.
1819 test_cmp_config_output () {
1820         git config --list --file="$1" >config-expect &&
1821         git config --list --file="$2" >config-actual &&
1822         sort config-expect >sorted-expect &&
1823         sort config-actual >sorted-actual &&
1824         test_cmp sorted-expect sorted-actual
1825 }
1826
1827 # Given a filename, extract its trailing hash as a hex string
1828 test_trailing_hash () {
1829         local file="$1" &&
1830         tail -c $(test_oid rawsz) "$file" |
1831                 test-tool hexdump |
1832                 sed "s/ //g"
1833 }