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