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