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