t/test-lib-functions.sh

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