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