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_set_index_version () {
  36     GIT_INDEX_VERSION="$1"
  37     export GIT_INDEX_VERSION
  38 }
  39
  40 test_decode_color () {
  41         awk '
  42                 function name(n) {
  43                         if (n == 0) return "RESET";
  44                         if (n == 1) return "BOLD";
  45                         if (n == 2) return "FAINT";
  46                         if (n == 3) return "ITALIC";
  47                         if (n == 7) return "REVERSE";
  48                         if (n == 30) return "BLACK";
  49                         if (n == 31) return "RED";
  50                         if (n == 32) return "GREEN";
  51                         if (n == 33) return "YELLOW";
  52                         if (n == 34) return "BLUE";
  53                         if (n == 35) return "MAGENTA";
  54                         if (n == 36) return "CYAN";
  55                         if (n == 37) return "WHITE";
  56                         if (n == 40) return "BLACK";
  57                         if (n == 41) return "BRED";
  58                         if (n == 42) return "BGREEN";
  59                         if (n == 43) return "BYELLOW";
  60                         if (n == 44) return "BBLUE";
  61                         if (n == 45) return "BMAGENTA";
  62                         if (n == 46) return "BCYAN";
  63                         if (n == 47) return "BWHITE";
  64                 }
  65                 {
  66                         while (match($0, /\033\[[0-9;]*m/) != 0) {
  67                                 printf "%s<", substr($0, 1, RSTART-1);
  68                                 codes = substr($0, RSTART+2, RLENGTH-3);
  69                                 if (length(codes) == 0)
  70                                         printf "%s", name(0)
  71                                 else {
  72                                         n = split(codes, ary, ";");
  73                                         sep = "";
  74                                         for (i = 1; i <= n; i++) {
  75                                                 printf "%s%s", sep, name(ary[i]);
  76                                                 sep = ";"
  77                                         }
  78                                 }
  79                                 printf ">";
  80                                 $0 = substr($0, RSTART + RLENGTH, length($0) - RSTART - RLENGTH + 1);
  81                         }
  82                         print
  83                 }
  84         '
  85 }
  86
  87 lf_to_nul () {
  88         perl -pe 'y/\012/\000/'
  89 }
  90
  91 nul_to_q () {
  92         perl -pe 'y/\000/Q/'
  93 }
  94
  95 q_to_nul () {
  96         perl -pe 'y/Q/\000/'
  97 }
  98
  99 q_to_cr () {
 100         tr Q '\015'
 101 }
 102
 103 q_to_tab () {
 104         tr Q '\011'
 105 }
 106
 107 qz_to_tab_space () {
 108         tr QZ '\011\040'
 109 }
 110
 111 append_cr () {
 112         sed -e 's/$/Q/' | tr Q '\015'
 113 }
 114
 115 remove_cr () {
 116         tr '\015' Q | sed -e 's/Q$//'
 117 }
 118
 119 # Generate an output of $1 bytes of all zeroes (NULs, not ASCII zeroes).
 120 # If $1 is 'infinity', output forever or until the receiving pipe stops reading,
 121 # whichever comes first.
 122 generate_zero_bytes () {
 123         test-tool genzeros "$@"
 124 }
 125
 126 # In some bourne shell implementations, the "unset" builtin returns
 127 # nonzero status when a variable to be unset was not set in the first
 128 # place.
 129 #
 130 # Use sane_unset when that should not be considered an error.
 131
 132 sane_unset () {
 133         unset "$@"
 134         return 0
 135 }
 136
 137 test_tick () {
 138         if test -z "${test_tick+set}"
 139         then
 140                 test_tick=1112911993
 141         else
 142                 test_tick=$(($test_tick + 60))
 143         fi
 144         GIT_COMMITTER_DATE="$test_tick -0700"
 145         GIT_AUTHOR_DATE="$test_tick -0700"
 146         export GIT_COMMITTER_DATE GIT_AUTHOR_DATE
 147 }
 148
 149 # Stop execution and start a shell. This is useful for debugging tests.
 150 #
 151 # Be sure to remove all invocations of this command before submitting.
 152
 153 test_pause () {
 154         "$SHELL_PATH" <&6 >&5 2>&7
 155 }
 156
 157 # Wrap git with a debugger. Adding this to a command can make it easier
 158 # to understand what is going on in a failing test.
 159 #
 160 # Examples:
 161 #     debug git checkout master
 162 #     debug --debugger=nemiver git $ARGS
 163 #     debug -d "valgrind --tool=memcheck --track-origins=yes" git $ARGS
 164 debug () {
 165         case "$1" in
 166         -d)
 167                 GIT_DEBUGGER="$2" &&
 168                 shift 2
 169                 ;;
 170         --debugger=*)
 171                 GIT_DEBUGGER="${1#*=}" &&
 172                 shift 1
 173                 ;;
 174         *)
 175                 GIT_DEBUGGER=1
 176                 ;;
 177         esac &&
 178         GIT_DEBUGGER="${GIT_DEBUGGER}" "$@" <&6 >&5 2>&7
 179 }
 180
 181 # Call test_commit with the arguments
 182 # [-C <directory>] <message> [<file> [<contents> [<tag>]]]"
 183 #
 184 # This will commit a file with the given contents and the given commit
 185 # message, and tag the resulting commit with the given tag name.
 186 #
 187 # <file>, <contents>, and <tag> all default to <message>.
 188 #
 189 # If the first argument is "-C", the second argument is used as a path for
 190 # the git invocations.
 191
 192 test_commit () {
 193         notick= &&
 194         signoff= &&
 195         indir= &&
 196         while test $# != 0
 197         do
 198                 case "$1" in
 199                 --notick)
 200                         notick=yes
 201                         ;;
 202                 --signoff)
 203                         signoff="$1"
 204                         ;;
 205                 -C)
 206                         indir="$2"
 207                         shift
 208                         ;;
 209                 *)
 210                         break
 211                         ;;
 212                 esac
 213                 shift
 214         done &&
 215         indir=${indir:+"$indir"/} &&
 216         file=${2:-"$1.t"} &&
 217         echo "${3-$1}" > "$indir$file" &&
 218         git ${indir:+ -C "$indir"} add "$file" &&
 219         if test -z "$notick"
 220         then
 221                 test_tick
 222         fi &&
 223         git ${indir:+ -C "$indir"} commit $signoff -m "$1" &&
 224         git ${indir:+ -C "$indir"} tag "${4:-$1}"
 225 }
 226
 227 # Call test_merge with the arguments "<message> <commit>", where <commit>
 228 # can be a tag pointing to the commit-to-merge.
 229
 230 test_merge () {
 231         label="$1" &&
 232         shift &&
 233         test_tick &&
 234         git merge -m "$label" "$@" &&
 235         git tag "$label"
 236 }
 237
 238 # Efficiently create <nr> commits, each with a unique number (from 1 to <nr>
 239 # by default) in the commit message.
 240 #
 241 # Usage: test_commit_bulk [options] <nr>
 242 #   -C <dir>:
 243 #       Run all git commands in directory <dir>
 244 #   --ref=<n>:
 245 #       ref on which to create commits (default: HEAD)
 246 #   --start=<n>:
 247 #       number commit messages from <n> (default: 1)
 248 #   --message=<msg>:
 249 #       use <msg> as the commit mesasge (default: "commit %s")
 250 #   --filename=<fn>:
 251 #       modify <fn> in each commit (default: %s.t)
 252 #   --contents=<string>:
 253 #       place <string> in each file (default: "content %s")
 254 #   --id=<string>:
 255 #       shorthand to use <string> and %s in message, filename, and contents
 256 #
 257 # The message, filename, and contents strings are evaluated by printf, with the
 258 # first "%s" replaced by the current commit number. So you can do:
 259 #
 260 #   test_commit_bulk --filename=file --contents="modification %s"
 261 #
 262 # to have every commit touch the same file, but with unique content.
 263 #
 264 test_commit_bulk () {
 265         tmpfile=.bulk-commit.input
 266         indir=.
 267         ref=HEAD
 268         n=1
 269         message='commit %s'
 270         filename='%s.t'
 271         contents='content %s'
 272         while test $# -gt 0
 273         do
 274                 case "$1" in
 275                 -C)
 276                         indir=$2
 277                         shift
 278                         ;;
 279                 --ref=*)
 280                         ref=${1#--*=}
 281                         ;;
 282                 --start=*)
 283                         n=${1#--*=}
 284                         ;;
 285                 --message=*)
 286                         message=${1#--*=}
 287                         ;;
 288                 --filename=*)
 289                         filename=${1#--*=}
 290                         ;;
 291                 --contents=*)
 292                         contents=${1#--*=}
 293                         ;;
 294                 --id=*)
 295                         message="${1#--*=} %s"
 296                         filename="${1#--*=}-%s.t"
 297                         contents="${1#--*=} %s"
 298                         ;;
 299                 -*)
 300                         BUG "invalid test_commit_bulk option: $1"
 301                         ;;
 302                 *)
 303                         break
 304                         ;;
 305                 esac
 306                 shift
 307         done
 308         total=$1
 309
 310         add_from=
 311         if git -C "$indir" rev-parse --quiet --verify "$ref"
 312         then
 313                 add_from=t
 314         fi
 315
 316         while test "$total" -gt 0
 317         do
 318                 test_tick &&
 319                 echo "commit $ref"
 320                 printf 'author %s <%s> %s\n' \
 321                         "$GIT_AUTHOR_NAME" \
 322                         "$GIT_AUTHOR_EMAIL" \
 323                         "$GIT_AUTHOR_DATE"
 324                 printf 'committer %s <%s> %s\n' \
 325                         "$GIT_COMMITTER_NAME" \
 326                         "$GIT_COMMITTER_EMAIL" \
 327                         "$GIT_COMMITTER_DATE"
 328                 echo "data <<EOF"
 329                 printf "$message\n" $n
 330                 echo "EOF"
 331                 if test -n "$add_from"
 332                 then
 333                         echo "from $ref^0"
 334                         add_from=
 335                 fi
 336                 printf "M 644 inline $filename\n" $n
 337                 echo "data <<EOF"
 338                 printf "$contents\n" $n
 339                 echo "EOF"
 340                 echo
 341                 n=$((n + 1))
 342                 total=$((total - 1))
 343         done >"$tmpfile"
 344
 345         git -C "$indir" \
 346             -c fastimport.unpacklimit=0 \
 347             fast-import <"$tmpfile" || return 1
 348
 349         # This will be left in place on failure, which may aid debugging.
 350         rm -f "$tmpfile"
 351
 352         # If we updated HEAD, then be nice and update the index and working
 353         # tree, too.
 354         if test "$ref" = "HEAD"
 355         then
 356                 git -C "$indir" checkout -f HEAD || return 1
 357         fi
 358
 359 }
 360
 361 # This function helps systems where core.filemode=false is set.
 362 # Use it instead of plain 'chmod +x' to set or unset the executable bit
 363 # of a file in the working directory and add it to the index.
 364
 365 test_chmod () {
 366         chmod "$@" &&
 367         git update-index --add "--chmod=$@"
 368 }
 369
 370 # Get the modebits from a file.
 371 test_modebits () {
 372         ls -l "$1" | sed -e 's|^\(..........\).*|\1|'
 373 }
 374
 375 # Unset a configuration variable, but don't fail if it doesn't exist.
 376 test_unconfig () {
 377         config_dir=
 378         if test "$1" = -C
 379         then
 380                 shift
 381                 config_dir=$1
 382                 shift
 383         fi
 384         git ${config_dir:+-C "$config_dir"} config --unset-all "$@"
 385         config_status=$?
 386         case "$config_status" in
 387         5) # ok, nothing to unset
 388                 config_status=0
 389                 ;;
 390         esac
 391         return $config_status
 392 }
 393
 394 # Set git config, automatically unsetting it after the test is over.
 395 test_config () {
 396         config_dir=
 397         if test "$1" = -C
 398         then
 399                 shift
 400                 config_dir=$1
 401                 shift
 402         fi
 403         test_when_finished "test_unconfig ${config_dir:+-C '$config_dir'} '$1'" &&
 404         git ${config_dir:+-C "$config_dir"} config "$@"
 405 }
 406
 407 test_config_global () {
 408         test_when_finished "test_unconfig --global '$1'" &&
 409         git config --global "$@"
 410 }
 411
 412 write_script () {
 413         {
 414                 echo "#!${2-"$SHELL_PATH"}" &&
 415                 cat
 416         } >"$1" &&
 417         chmod +x "$1"
 418 }
 419
 420 # Use test_set_prereq to tell that a particular prerequisite is available.
 421 # The prerequisite can later be checked for in two ways:
 422 #
 423 # - Explicitly using test_have_prereq.
 424 #
 425 # - Implicitly by specifying the prerequisite tag in the calls to
 426 #   test_expect_{success,failure,code}.
 427 #
 428 # The single parameter is the prerequisite tag (a simple word, in all
 429 # capital letters by convention).
 430
 431 test_unset_prereq () {
 432         ! test_have_prereq "$1" ||
 433         satisfied_prereq="${satisfied_prereq% $1 *} ${satisfied_prereq#* $1 }"
 434 }
 435
 436 test_set_prereq () {
 437         case "$1" in
 438         !*)
 439                 test_unset_prereq "${1#!}"
 440                 ;;
 441         *)
 442                 satisfied_prereq="$satisfied_prereq$1 "
 443                 ;;
 444         esac
 445 }
 446 satisfied_prereq=" "
 447 lazily_testable_prereq= lazily_tested_prereq=
 448
 449 # Usage: test_lazy_prereq PREREQ 'script'
 450 test_lazy_prereq () {
 451         lazily_testable_prereq="$lazily_testable_prereq$1 "
 452         eval test_prereq_lazily_$1=\$2
 453 }
 454
 455 test_run_lazy_prereq_ () {
 456         script='
 457 mkdir -p "$TRASH_DIRECTORY/prereq-test-dir" &&
 458 (
 459         cd "$TRASH_DIRECTORY/prereq-test-dir" &&'"$2"'
 460 )'
 461         say >&3 "checking prerequisite: $1"
 462         say >&3 "$script"
 463         test_eval_ "$script"
 464         eval_ret=$?
 465         rm -rf "$TRASH_DIRECTORY/prereq-test-dir"
 466         if test "$eval_ret" = 0; then
 467                 say >&3 "prerequisite $1 ok"
 468         else
 469                 say >&3 "prerequisite $1 not satisfied"
 470         fi
 471         return $eval_ret
 472 }
 473
 474 test_have_prereq () {
 475         # prerequisites can be concatenated with ','
 476         save_IFS=$IFS
 477         IFS=,
 478         set -- $*
 479         IFS=$save_IFS
 480
 481         total_prereq=0
 482         ok_prereq=0
 483         missing_prereq=
 484
 485         for prerequisite
 486         do
 487                 case "$prerequisite" in
 488                 !*)
 489                         negative_prereq=t
 490                         prerequisite=${prerequisite#!}
 491                         ;;
 492                 *)
 493                         negative_prereq=
 494                 esac
 495
 496                 case " $lazily_tested_prereq " in
 497                 *" $prerequisite "*)
 498                         ;;
 499                 *)
 500                         case " $lazily_testable_prereq " in
 501                         *" $prerequisite "*)
 502                                 eval "script=\$test_prereq_lazily_$prerequisite" &&
 503                                 if test_run_lazy_prereq_ "$prerequisite" "$script"
 504                                 then
 505                                         test_set_prereq $prerequisite
 506                                 fi
 507                                 lazily_tested_prereq="$lazily_tested_prereq$prerequisite "
 508                         esac
 509                         ;;
 510                 esac
 511
 512                 total_prereq=$(($total_prereq + 1))
 513                 case "$satisfied_prereq" in
 514                 *" $prerequisite "*)
 515                         satisfied_this_prereq=t
 516                         ;;
 517                 *)
 518                         satisfied_this_prereq=
 519                 esac
 520
 521                 case "$satisfied_this_prereq,$negative_prereq" in
 522                 t,|,t)
 523                         ok_prereq=$(($ok_prereq + 1))
 524                         ;;
 525                 *)
 526                         # Keep a list of missing prerequisites; restore
 527                         # the negative marker if necessary.
 528                         prerequisite=${negative_prereq:+!}$prerequisite
 529                         if test -z "$missing_prereq"
 530                         then
 531                                 missing_prereq=$prerequisite
 532                         else
 533                                 missing_prereq="$prerequisite,$missing_prereq"
 534                         fi
 535                 esac
 536         done
 537
 538         test $total_prereq = $ok_prereq
 539 }
 540
 541 test_declared_prereq () {
 542         case ",$test_prereq," in
 543         *,$1,*)
 544                 return 0
 545                 ;;
 546         esac
 547         return 1
 548 }
 549
 550 test_verify_prereq () {
 551         test -z "$test_prereq" ||
 552         expr >/dev/null "$test_prereq" : '[A-Z0-9_,!]*$' ||
 553         BUG "'$test_prereq' does not look like a prereq"
 554 }
 555
 556 test_expect_failure () {
 557         test_start_
 558         test "$#" = 3 && { test_prereq=$1; shift; } || test_prereq=
 559         test "$#" = 2 ||
 560         BUG "not 2 or 3 parameters to test-expect-failure"
 561         test_verify_prereq
 562         export test_prereq
 563         if ! test_skip "$@"
 564         then
 565                 say >&3 "checking known breakage of $TEST_NUMBER.$test_count '$1': $2"
 566                 if test_run_ "$2" expecting_failure
 567                 then
 568                         test_known_broken_ok_ "$1"
 569                 else
 570                         test_known_broken_failure_ "$1"
 571                 fi
 572         fi
 573         test_finish_
 574 }
 575
 576 test_expect_success () {
 577         test_start_
 578         test "$#" = 3 && { test_prereq=$1; shift; } || test_prereq=
 579         test "$#" = 2 ||
 580         BUG "not 2 or 3 parameters to test-expect-success"
 581         test_verify_prereq
 582         export test_prereq
 583         if ! test_skip "$@"
 584         then
 585                 say >&3 "expecting success of $TEST_NUMBER.$test_count '$1': $2"
 586                 if test_run_ "$2"
 587                 then
 588                         test_ok_ "$1"
 589                 else
 590                         test_failure_ "$@"
 591                 fi
 592         fi
 593         test_finish_
 594 }
 595
 596 # test_external runs external test scripts that provide continuous
 597 # test output about their progress, and succeeds/fails on
 598 # zero/non-zero exit code.  It outputs the test output on stdout even
 599 # in non-verbose mode, and announces the external script with "# run
 600 # <n>: ..." before running it.  When providing relative paths, keep in
 601 # mind that all scripts run in "trash directory".
 602 # Usage: test_external description command arguments...
 603 # Example: test_external 'Perl API' perl ../path/to/test.pl
 604 test_external () {
 605         test "$#" = 4 && { test_prereq=$1; shift; } || test_prereq=
 606         test "$#" = 3 ||
 607         BUG "not 3 or 4 parameters to test_external"
 608         descr="$1"
 609         shift
 610         test_verify_prereq
 611         export test_prereq
 612         if ! test_skip "$descr" "$@"
 613         then
 614                 # Announce the script to reduce confusion about the
 615                 # test output that follows.
 616                 say_color "" "# run $test_count: $descr ($*)"
 617                 # Export TEST_DIRECTORY, TRASH_DIRECTORY and GIT_TEST_LONG
 618                 # to be able to use them in script
 619                 export TEST_DIRECTORY TRASH_DIRECTORY GIT_TEST_LONG
 620                 # Run command; redirect its stderr to &4 as in
 621                 # test_run_, but keep its stdout on our stdout even in
 622                 # non-verbose mode.
 623                 "$@" 2>&4
 624                 if test "$?" = 0
 625                 then
 626                         if test $test_external_has_tap -eq 0; then
 627                                 test_ok_ "$descr"
 628                         else
 629                                 say_color "" "# test_external test $descr was ok"
 630                                 test_success=$(($test_success + 1))
 631                         fi
 632                 else
 633                         if test $test_external_has_tap -eq 0; then
 634                                 test_failure_ "$descr" "$@"
 635                         else
 636                                 say_color error "# test_external test $descr failed: $@"
 637                                 test_failure=$(($test_failure + 1))
 638                         fi
 639                 fi
 640         fi
 641 }
 642
 643 # Like test_external, but in addition tests that the command generated
 644 # no output on stderr.
 645 test_external_without_stderr () {
 646         # The temporary file has no (and must have no) security
 647         # implications.
 648         tmp=${TMPDIR:-/tmp}
 649         stderr="$tmp/git-external-stderr.$$.tmp"
 650         test_external "$@" 4> "$stderr"
 651         test -f "$stderr" || error "Internal error: $stderr disappeared."
 652         descr="no stderr: $1"
 653         shift
 654         say >&3 "# expecting no stderr from previous command"
 655         if test ! -s "$stderr"
 656         then
 657                 rm "$stderr"
 658
 659                 if test $test_external_has_tap -eq 0; then
 660                         test_ok_ "$descr"
 661                 else
 662                         say_color "" "# test_external_without_stderr test $descr was ok"
 663                         test_success=$(($test_success + 1))
 664                 fi
 665         else
 666                 if test "$verbose" = t
 667                 then
 668                         output=$(echo; echo "# Stderr is:"; cat "$stderr")
 669                 else
 670                         output=
 671                 fi
 672                 # rm first in case test_failure exits.
 673                 rm "$stderr"
 674                 if test $test_external_has_tap -eq 0; then
 675                         test_failure_ "$descr" "$@" "$output"
 676                 else
 677                         say_color error "# test_external_without_stderr test $descr failed: $@: $output"
 678                         test_failure=$(($test_failure + 1))
 679                 fi
 680         fi
 681 }
 682
 683 # debugging-friendly alternatives to "test [-f|-d|-e]"
 684 # The commands test the existence or non-existence of $1. $2 can be
 685 # given to provide a more precise diagnosis.
 686 test_path_is_file () {
 687         if ! test -f "$1"
 688         then
 689                 echo "File $1 doesn't exist. $2"
 690                 false
 691         fi
 692 }
 693
 694 test_path_is_dir () {
 695         if ! test -d "$1"
 696         then
 697                 echo "Directory $1 doesn't exist. $2"
 698                 false
 699         fi
 700 }
 701
 702 test_path_exists () {
 703         if ! test -e "$1"
 704         then
 705                 echo "Path $1 doesn't exist. $2"
 706                 false
 707         fi
 708 }
 709
 710 # Check if the directory exists and is empty as expected, barf otherwise.
 711 test_dir_is_empty () {
 712         test_path_is_dir "$1" &&
 713         if test -n "$(ls -a1 "$1" | egrep -v '^\.\.?$')"
 714         then
 715                 echo "Directory '$1' is not empty, it contains:"
 716                 ls -la "$1"
 717                 return 1
 718         fi
 719 }
 720
 721 # Check if the file exists and has a size greater than zero
 722 test_file_not_empty () {
 723         if ! test -s "$1"
 724         then
 725                 echo "'$1' is not a non-empty file."
 726                 false
 727         fi
 728 }
 729
 730 test_path_is_missing () {
 731         if test -e "$1"
 732         then
 733                 echo "Path exists:"
 734                 ls -ld "$1"
 735                 if test $# -ge 1
 736                 then
 737                         echo "$*"
 738                 fi
 739                 false
 740         fi
 741 }
 742
 743 # test_line_count checks that a file has the number of lines it
 744 # ought to. For example:
 745 #
 746 #       test_expect_success 'produce exactly one line of output' '
 747 #               do something >output &&
 748 #               test_line_count = 1 output
 749 #       '
 750 #
 751 # is like "test $(wc -l <output) = 1" except that it passes the
 752 # output through when the number of lines is wrong.
 753
 754 test_line_count () {
 755         if test $# != 3
 756         then
 757                 BUG "not 3 parameters to test_line_count"
 758         elif ! test $(wc -l <"$3") "$1" "$2"
 759         then
 760                 echo "test_line_count: line count for $3 !$1 $2"
 761                 cat "$3"
 762                 return 1
 763         fi
 764 }
 765
 766 # Returns success if a comma separated string of keywords ($1) contains a
 767 # given keyword ($2).
 768 # Examples:
 769 # `list_contains "foo,bar" bar` returns 0
 770 # `list_contains "foo" bar` returns 1
 771
 772 list_contains () {
 773         case ",$1," in
 774         *,$2,*)
 775                 return 0
 776                 ;;
 777         esac
 778         return 1
 779 }
 780
 781 # This is not among top-level (test_expect_success | test_expect_failure)
 782 # but is a prefix that can be used in the test script, like:
 783 #
 784 #       test_expect_success 'complain and die' '
 785 #           do something &&
 786 #           do something else &&
 787 #           test_must_fail git checkout ../outerspace
 788 #       '
 789 #
 790 # Writing this as "! git checkout ../outerspace" is wrong, because
 791 # the failure could be due to a segv.  We want a controlled failure.
 792 #
 793 # Accepts the following options:
 794 #
 795 #   ok=<signal-name>[,<...>]:
 796 #     Don't treat an exit caused by the given signal as error.
 797 #     Multiple signals can be specified as a comma separated list.
 798 #     Currently recognized signal names are: sigpipe, success.
 799 #     (Don't use 'success', use 'test_might_fail' instead.)
 800
 801 test_must_fail () {
 802         case "$1" in
 803         ok=*)
 804                 _test_ok=${1#ok=}
 805                 shift
 806                 ;;
 807         *)
 808                 _test_ok=
 809                 ;;
 810         esac
 811         "$@" 2>&7
 812         exit_code=$?
 813         if test $exit_code -eq 0 && ! list_contains "$_test_ok" success
 814         then
 815                 echo >&4 "test_must_fail: command succeeded: $*"
 816                 return 1
 817         elif test_match_signal 13 $exit_code && list_contains "$_test_ok" sigpipe
 818         then
 819                 return 0
 820         elif test $exit_code -gt 129 && test $exit_code -le 192
 821         then
 822                 echo >&4 "test_must_fail: died by signal $(($exit_code - 128)): $*"
 823                 return 1
 824         elif test $exit_code -eq 127
 825         then
 826                 echo >&4 "test_must_fail: command not found: $*"
 827                 return 1
 828         elif test $exit_code -eq 126
 829         then
 830                 echo >&4 "test_must_fail: valgrind error: $*"
 831                 return 1
 832         fi
 833         return 0
 834 } 7>&2 2>&4
 835
 836 # Similar to test_must_fail, but tolerates success, too.  This is
 837 # meant to be used in contexts like:
 838 #
 839 #       test_expect_success 'some command works without configuration' '
 840 #               test_might_fail git config --unset all.configuration &&
 841 #               do something
 842 #       '
 843 #
 844 # Writing "git config --unset all.configuration || :" would be wrong,
 845 # because we want to notice if it fails due to segv.
 846 #
 847 # Accepts the same options as test_must_fail.
 848
 849 test_might_fail () {
 850         test_must_fail ok=success "$@" 2>&7
 851 } 7>&2 2>&4
 852
 853 # Similar to test_must_fail and test_might_fail, but check that a
 854 # given command exited with a given exit code. Meant to be used as:
 855 #
 856 #       test_expect_success 'Merge with d/f conflicts' '
 857 #               test_expect_code 1 git merge "merge msg" B master
 858 #       '
 859
 860 test_expect_code () {
 861         want_code=$1
 862         shift
 863         "$@" 2>&7
 864         exit_code=$?
 865         if test $exit_code = $want_code
 866         then
 867                 return 0
 868         fi
 869
 870         echo >&4 "test_expect_code: command exited with $exit_code, we wanted $want_code $*"
 871         return 1
 872 } 7>&2 2>&4
 873
 874 # test_cmp is a helper function to compare actual and expected output.
 875 # You can use it like:
 876 #
 877 #       test_expect_success 'foo works' '
 878 #               echo expected >expected &&
 879 #               foo >actual &&
 880 #               test_cmp expected actual
 881 #       '
 882 #
 883 # This could be written as either "cmp" or "diff -u", but:
 884 # - cmp's output is not nearly as easy to read as diff -u
 885 # - not all diff versions understand "-u"
 886
 887 test_cmp() {
 888         $GIT_TEST_CMP "$@"
 889 }
 890
 891 # Check that the given config key has the expected value.
 892 #
 893 #    test_cmp_config [-C <dir>] <expected-value>
 894 #                    [<git-config-options>...] <config-key>
 895 #
 896 # for example to check that the value of core.bar is foo
 897 #
 898 #    test_cmp_config foo core.bar
 899 #
 900 test_cmp_config() {
 901         local GD &&
 902         if test "$1" = "-C"
 903         then
 904                 shift &&
 905                 GD="-C $1" &&
 906                 shift
 907         fi &&
 908         printf "%s\n" "$1" >expect.config &&
 909         shift &&
 910         git $GD config "$@" >actual.config &&
 911         test_cmp expect.config actual.config
 912 }
 913
 914 # test_cmp_bin - helper to compare binary files
 915
 916 test_cmp_bin() {
 917         cmp "$@"
 918 }
 919
 920 # Use this instead of test_cmp to compare files that contain expected and
 921 # actual output from git commands that can be translated.  When running
 922 # under GIT_TEST_GETTEXT_POISON this pretends that the command produced expected
 923 # results.
 924 test_i18ncmp () {
 925         ! test_have_prereq C_LOCALE_OUTPUT || test_cmp "$@"
 926 }
 927
 928 # Use this instead of "grep expected-string actual" to see if the
 929 # output from a git command that can be translated either contains an
 930 # expected string, or does not contain an unwanted one.  When running
 931 # under GIT_TEST_GETTEXT_POISON this pretends that the command produced expected
 932 # results.
 933 test_i18ngrep () {
 934         eval "last_arg=\${$#}"
 935
 936         test -f "$last_arg" ||
 937         BUG "test_i18ngrep requires a file to read as the last parameter"
 938
 939         if test $# -lt 2 ||
 940            { test "x!" = "x$1" && test $# -lt 3 ; }
 941         then
 942                 BUG "too few parameters to test_i18ngrep"
 943         fi
 944
 945         if test_have_prereq !C_LOCALE_OUTPUT
 946         then
 947                 # pretend success
 948                 return 0
 949         fi
 950
 951         if test "x!" = "x$1"
 952         then
 953                 shift
 954                 ! grep "$@" && return 0
 955
 956                 echo >&4 "error: '! grep $@' did find a match in:"
 957         else
 958                 grep "$@" && return 0
 959
 960                 echo >&4 "error: 'grep $@' didn't find a match in:"
 961         fi
 962
 963         if test -s "$last_arg"
 964         then
 965                 cat >&4 "$last_arg"
 966         else
 967                 echo >&4 "<File '$last_arg' is empty>"
 968         fi
 969
 970         return 1
 971 }
 972
 973 # Call any command "$@" but be more verbose about its
 974 # failure. This is handy for commands like "test" which do
 975 # not output anything when they fail.
 976 verbose () {
 977         "$@" && return 0
 978         echo >&4 "command failed: $(git rev-parse --sq-quote "$@")"
 979         return 1
 980 }
 981
 982 # Check if the file expected to be empty is indeed empty, and barfs
 983 # otherwise.
 984
 985 test_must_be_empty () {
 986         test_path_is_file "$1" &&
 987         if test -s "$1"
 988         then
 989                 echo "'$1' is not empty, it contains:"
 990                 cat "$1"
 991                 return 1
 992         fi
 993 }
 994
 995 # Tests that its two parameters refer to the same revision, or if '!' is
 996 # provided first, that its other two parameters refer to different
 997 # revisions.
 998 test_cmp_rev () {
 999         local op='=' wrong_result=different
1000
1001         if test $# -ge 1 && test "x$1" = 'x!'
1002         then
1003             op='!='
1004             wrong_result='the same'
1005             shift
1006         fi
1007         if test $# != 2
1008         then
1009                 error "bug in the test script: test_cmp_rev requires two revisions, but got $#"
1010         else
1011                 local r1 r2
1012                 r1=$(git rev-parse --verify "$1") &&
1013                 r2=$(git rev-parse --verify "$2") || return 1
1014
1015                 if ! test "$r1" "$op" "$r2"
1016                 then
1017                         cat >&4 <<-EOF
1018                         error: two revisions point to $wrong_result objects:
1019                           '$1': $r1
1020                           '$2': $r2
1021                         EOF
1022                         return 1
1023                 fi
1024         fi
1025 }
1026
1027 # Compare paths respecting core.ignoreCase
1028 test_cmp_fspath () {
1029         if test "x$1" = "x$2"
1030         then
1031                 return 0
1032         fi
1033
1034         if test true != "$(git config --get --type=bool core.ignorecase)"
1035         then
1036                 return 1
1037         fi
1038
1039         test "x$(echo "$1" | tr A-Z a-z)" =  "x$(echo "$2" | tr A-Z a-z)"
1040 }
1041
1042 # Print a sequence of integers in increasing order, either with
1043 # two arguments (start and end):
1044 #
1045 #     test_seq 1 5 -- outputs 1 2 3 4 5 one line at a time
1046 #
1047 # or with one argument (end), in which case it starts counting
1048 # from 1.
1049
1050 test_seq () {
1051         case $# in
1052         1)      set 1 "$@" ;;
1053         2)      ;;
1054         *)      BUG "not 1 or 2 parameters to test_seq" ;;
1055         esac
1056         test_seq_counter__=$1
1057         while test "$test_seq_counter__" -le "$2"
1058         do
1059                 echo "$test_seq_counter__"
1060                 test_seq_counter__=$(( $test_seq_counter__ + 1 ))
1061         done
1062 }
1063
1064 # This function can be used to schedule some commands to be run
1065 # unconditionally at the end of the test to restore sanity:
1066 #
1067 #       test_expect_success 'test core.capslock' '
1068 #               git config core.capslock true &&
1069 #               test_when_finished "git config --unset core.capslock" &&
1070 #               hello world
1071 #       '
1072 #
1073 # That would be roughly equivalent to
1074 #
1075 #       test_expect_success 'test core.capslock' '
1076 #               git config core.capslock true &&
1077 #               hello world
1078 #               git config --unset core.capslock
1079 #       '
1080 #
1081 # except that the greeting and config --unset must both succeed for
1082 # the test to pass.
1083 #
1084 # Note that under --immediate mode, no clean-up is done to help diagnose
1085 # what went wrong.
1086
1087 test_when_finished () {
1088         # We cannot detect when we are in a subshell in general, but by
1089         # doing so on Bash is better than nothing (the test will
1090         # silently pass on other shells).
1091         test "${BASH_SUBSHELL-0}" = 0 ||
1092         BUG "test_when_finished does nothing in a subshell"
1093         test_cleanup="{ $*
1094                 } && (exit \"\$eval_ret\"); eval_ret=\$?; $test_cleanup"
1095 }
1096
1097 # This function can be used to schedule some commands to be run
1098 # unconditionally at the end of the test script, e.g. to stop a daemon:
1099 #
1100 #       test_expect_success 'test git daemon' '
1101 #               git daemon &
1102 #               daemon_pid=$! &&
1103 #               test_atexit 'kill $daemon_pid' &&
1104 #               hello world
1105 #       '
1106 #
1107 # The commands will be executed before the trash directory is removed,
1108 # i.e. the atexit commands will still be able to access any pidfiles or
1109 # socket files.
1110 #
1111 # Note that these commands will be run even when a test script run
1112 # with '--immediate' fails.  Be careful with your atexit commands to
1113 # minimize any changes to the failed state.
1114
1115 test_atexit () {
1116         # We cannot detect when we are in a subshell in general, but by
1117         # doing so on Bash is better than nothing (the test will
1118         # silently pass on other shells).
1119         test "${BASH_SUBSHELL-0}" = 0 ||
1120         error "bug in test script: test_atexit does nothing in a subshell"
1121         test_atexit_cleanup="{ $*
1122                 } && (exit \"\$eval_ret\"); eval_ret=\$?; $test_atexit_cleanup"
1123 }
1124
1125 # Most tests can use the created repository, but some may need to create more.
1126 # Usage: test_create_repo <directory>
1127 test_create_repo () {
1128         test "$#" = 1 ||
1129         BUG "not 1 parameter to test-create-repo"
1130         repo="$1"
1131         mkdir -p "$repo"
1132         (
1133                 cd "$repo" || error "Cannot setup test environment"
1134                 git -c init.defaultBranch=master init >&3 2>&4 ||
1135                 error "cannot run git init"
1136                 echo "empty start" |
1137                     git commit-tree $(git write-tree) >.git/refs/heads/master 2>&4 ||
1138                     error "cannot run git commit"
1139                 mv .git/hooks .git/hooks-disabled
1140                 echo ".coverage.*" >> .git/info/exclude
1141         ) || exit
1142 }
1143
1144 # This function helps on symlink challenged file systems when it is not
1145 # important that the file system entry is a symbolic link.
1146 # Use test_ln_s_add instead of "ln -s x y && git add y" to add a
1147 # symbolic link entry y to the index.
1148
1149 test_ln_s_add () {
1150         if test_have_prereq SYMLINKS
1151         then
1152                 ln -s "$1" "$2" &&
1153                 git update-index --add "$2"
1154         else
1155                 printf '%s' "$1" >"$2" &&
1156                 ln_s_obj=$(git hash-object -w "$2") &&
1157                 git update-index --add --cacheinfo 120000 $ln_s_obj "$2" &&
1158                 # pick up stat info from the file
1159                 git update-index "$2"
1160         fi
1161 }
1162
1163 # This function writes out its parameters, one per line
1164 test_write_lines () {
1165         printf "%s\n" "$@"
1166 }
1167
1168 perl () {
1169         command "$PERL_PATH" "$@" 2>&7
1170 } 7>&2 2>&4
1171
1172 # Given the name of an environment variable with a bool value, normalize
1173 # its value to a 0 (true) or 1 (false or empty string) return code.
1174 #
1175 #   test_bool_env GIT_TEST_HTTPD <default-value>
1176 #
1177 # Return with code corresponding to the given default value if the variable
1178 # is unset.
1179 # Abort the test script if either the value of the variable or the default
1180 # are not valid bool values.
1181
1182 test_bool_env () {
1183         if test $# != 2
1184         then
1185                 BUG "test_bool_env requires two parameters (variable name and default value)"
1186         fi
1187
1188         git env--helper --type=bool --default="$2" --exit-code "$1"
1189         ret=$?
1190         case $ret in
1191         0|1)    # unset or valid bool value
1192                 ;;
1193         *)      # invalid bool value or something unexpected
1194                 error >&7 "test_bool_env requires bool values both for \$$1 and for the default fallback"
1195                 ;;
1196         esac
1197         return $ret
1198 }
1199
1200 # Exit the test suite, either by skipping all remaining tests or by
1201 # exiting with an error. If our prerequisite variable $1 falls back
1202 # on a default assume we were opportunistically trying to set up some
1203 # tests and we skip. If it is explicitly "true", then we report a failure.
1204 #
1205 # The error/skip message should be given by $2.
1206 #
1207 test_skip_or_die () {
1208         if ! test_bool_env "$1" false
1209         then
1210                 skip_all=$2
1211                 test_done
1212         fi
1213         error "$2"
1214 }
1215
1216 # The following mingw_* functions obey POSIX shell syntax, but are actually
1217 # bash scripts, and are meant to be used only with bash on Windows.
1218
1219 # A test_cmp function that treats LF and CRLF equal and avoids to fork
1220 # diff when possible.
1221 mingw_test_cmp () {
1222         # Read text into shell variables and compare them. If the results
1223         # are different, use regular diff to report the difference.
1224         local test_cmp_a= test_cmp_b=
1225
1226         # When text came from stdin (one argument is '-') we must feed it
1227         # to diff.
1228         local stdin_for_diff=
1229
1230         # Since it is difficult to detect the difference between an
1231         # empty input file and a failure to read the files, we go straight
1232         # to diff if one of the inputs is empty.
1233         if test -s "$1" && test -s "$2"
1234         then
1235                 # regular case: both files non-empty
1236                 mingw_read_file_strip_cr_ test_cmp_a <"$1"
1237                 mingw_read_file_strip_cr_ test_cmp_b <"$2"
1238         elif test -s "$1" && test "$2" = -
1239         then
1240                 # read 2nd file from stdin
1241                 mingw_read_file_strip_cr_ test_cmp_a <"$1"
1242                 mingw_read_file_strip_cr_ test_cmp_b
1243                 stdin_for_diff='<<<"$test_cmp_b"'
1244         elif test "$1" = - && test -s "$2"
1245         then
1246                 # read 1st file from stdin
1247                 mingw_read_file_strip_cr_ test_cmp_a
1248                 mingw_read_file_strip_cr_ test_cmp_b <"$2"
1249                 stdin_for_diff='<<<"$test_cmp_a"'
1250         fi
1251         test -n "$test_cmp_a" &&
1252         test -n "$test_cmp_b" &&
1253         test "$test_cmp_a" = "$test_cmp_b" ||
1254         eval "diff -u \"\$@\" $stdin_for_diff"
1255 }
1256
1257 # $1 is the name of the shell variable to fill in
1258 mingw_read_file_strip_cr_ () {
1259         # Read line-wise using LF as the line separator
1260         # and use IFS to strip CR.
1261         local line
1262         while :
1263         do
1264                 if IFS=$'\r' read -r -d $'\n' line
1265                 then
1266                         # good
1267                         line=$line$'\n'
1268                 else
1269                         # we get here at EOF, but also if the last line
1270                         # was not terminated by LF; in the latter case,
1271                         # some text was read
1272                         if test -z "$line"
1273                         then
1274                                 # EOF, really
1275                                 break
1276                         fi
1277                 fi
1278                 eval "$1=\$$1\$line"
1279         done
1280 }
1281
1282 # Like "env FOO=BAR some-program", but run inside a subshell, which means
1283 # it also works for shell functions (though those functions cannot impact
1284 # the environment outside of the test_env invocation).
1285 test_env () {
1286         (
1287                 while test $# -gt 0
1288                 do
1289                         case "$1" in
1290                         *=*)
1291                                 eval "${1%%=*}=\${1#*=}"
1292                                 eval "export ${1%%=*}"
1293                                 shift
1294                                 ;;
1295                         *)
1296                                 "$@" 2>&7
1297                                 exit
1298                                 ;;
1299                         esac
1300                 done
1301         )
1302 } 7>&2 2>&4
1303
1304 # Returns true if the numeric exit code in "$2" represents the expected signal
1305 # in "$1". Signals should be given numerically.
1306 test_match_signal () {
1307         if test "$2" = "$((128 + $1))"
1308         then
1309                 # POSIX
1310                 return 0
1311         elif test "$2" = "$((256 + $1))"
1312         then
1313                 # ksh
1314                 return 0
1315         fi
1316         return 1
1317 }
1318
1319 # Read up to "$1" bytes (or to EOF) from stdin and write them to stdout.
1320 test_copy_bytes () {
1321         perl -e '
1322                 my $len = $ARGV[1];
1323                 while ($len > 0) {
1324                         my $s;
1325                         my $nread = sysread(STDIN, $s, $len);
1326                         die "cannot read: $!" unless defined($nread);
1327                         last unless $nread;
1328                         print $s;
1329                         $len -= $nread;
1330                 }
1331         ' - "$1"
1332 }
1333
1334 # run "$@" inside a non-git directory
1335 nongit () {
1336         test -d non-repo ||
1337         mkdir non-repo ||
1338         return 1
1339
1340         (
1341                 GIT_CEILING_DIRECTORIES=$(pwd) &&
1342                 export GIT_CEILING_DIRECTORIES &&
1343                 cd non-repo &&
1344                 "$@" 2>&7
1345         )
1346 } 7>&2 2>&4
1347
1348 # convert stdin to pktline representation; note that empty input becomes an
1349 # empty packet, not a flush packet (for that you can just print 0000 yourself).
1350 packetize() {
1351         cat >packetize.tmp &&
1352         len=$(wc -c <packetize.tmp) &&
1353         printf '%04x%s' "$(($len + 4))" &&
1354         cat packetize.tmp &&
1355         rm -f packetize.tmp
1356 }
1357
1358 # Parse the input as a series of pktlines, writing the result to stdout.
1359 # Sideband markers are removed automatically, and the output is routed to
1360 # stderr if appropriate.
1361 #
1362 # NUL bytes are converted to "\\0" for ease of parsing with text tools.
1363 depacketize () {
1364         perl -e '
1365                 while (read(STDIN, $len, 4) == 4) {
1366                         if ($len eq "0000") {
1367                                 print "FLUSH\n";
1368                         } else {
1369                                 read(STDIN, $buf, hex($len) - 4);
1370                                 $buf =~ s/\0/\\0/g;
1371                                 if ($buf =~ s/^[\x2\x3]//) {
1372                                         print STDERR $buf;
1373                                 } else {
1374                                         $buf =~ s/^\x1//;
1375                                         print $buf;
1376                                 }
1377                         }
1378                 }
1379         '
1380 }
1381
1382 # Converts base-16 data into base-8. The output is given as a sequence of
1383 # escaped octals, suitable for consumption by 'printf'.
1384 hex2oct () {
1385         perl -ne 'printf "\\%03o", hex for /../g'
1386 }
1387
1388 # Set the hash algorithm in use to $1.  Only useful when testing the testsuite.
1389 test_set_hash () {
1390         test_hash_algo="$1"
1391 }
1392
1393 # Detect the hash algorithm in use.
1394 test_detect_hash () {
1395         # Currently we only support SHA-1, but in the future this function will
1396         # actually detect the algorithm in use.
1397         test_hash_algo='sha1'
1398 }
1399
1400 # Load common hash metadata and common placeholder object IDs for use with
1401 # test_oid.
1402 test_oid_init () {
1403         test -n "$test_hash_algo" || test_detect_hash &&
1404         test_oid_cache <"$TEST_DIRECTORY/oid-info/hash-info" &&
1405         test_oid_cache <"$TEST_DIRECTORY/oid-info/oid"
1406 }
1407
1408 # Load key-value pairs from stdin suitable for use with test_oid.  Blank lines
1409 # and lines starting with "#" are ignored.  Keys must be shell identifier
1410 # characters.
1411 #
1412 # Examples:
1413 # rawsz sha1:20
1414 # rawsz sha256:32
1415 test_oid_cache () {
1416         local tag rest k v &&
1417
1418         { test -n "$test_hash_algo" || test_detect_hash; } &&
1419         while read tag rest
1420         do
1421                 case $tag in
1422                 \#*)
1423                         continue;;
1424                 ?*)
1425                         # non-empty
1426                         ;;
1427                 *)
1428                         # blank line
1429                         continue;;
1430                 esac &&
1431
1432                 k="${rest%:*}" &&
1433                 v="${rest#*:}" &&
1434
1435                 if ! expr "$k" : '[a-z0-9][a-z0-9]*$' >/dev/null
1436                 then
1437                         BUG 'bad hash algorithm'
1438                 fi &&
1439                 eval "test_oid_${k}_$tag=\"\$v\""
1440         done
1441 }
1442
1443 # Look up a per-hash value based on a key ($1).  The value must have been loaded
1444 # by test_oid_init or test_oid_cache.
1445 test_oid () {
1446         local var="test_oid_${test_hash_algo}_$1" &&
1447
1448         # If the variable is unset, we must be missing an entry for this
1449         # key-hash pair, so exit with an error.
1450         if eval "test -z \"\${$var+set}\""
1451         then
1452                 BUG "undefined key '$1'"
1453         fi &&
1454         eval "printf '%s' \"\${$var}\""
1455 }
1456
1457 # Insert a slash into an object ID so it can be used to reference a location
1458 # under ".git/objects".  For example, "deadbeef..." becomes "de/adbeef..".
1459 test_oid_to_path () {
1460         local basename=${1#??}
1461         echo "${1%$basename}/$basename"
1462 }
1463
1464 # Choose a port number based on the test script's number and store it in
1465 # the given variable name, unless that variable already contains a number.
1466 test_set_port () {
1467         local var=$1 port
1468
1469         if test $# -ne 1 || test -z "$var"
1470         then
1471                 BUG "test_set_port requires a variable name"
1472         fi
1473
1474         eval port=\$$var
1475         case "$port" in
1476         "")
1477                 # No port is set in the given env var, use the test
1478                 # number as port number instead.
1479                 # Remove not only the leading 't', but all leading zeros
1480                 # as well, so the arithmetic below won't (mis)interpret
1481                 # a test number like '0123' as an octal value.
1482                 port=${this_test#${this_test%%[1-9]*}}
1483                 if test "${port:-0}" -lt 1024
1484                 then
1485                         # root-only port, use a larger one instead.
1486                         port=$(($port + 10000))
1487                 fi
1488                 ;;
1489         *[!0-9]*|0*)
1490                 error >&7 "invalid port number: $port"
1491                 ;;
1492         *)
1493                 # The user has specified the port.
1494                 ;;
1495         esac
1496
1497         # Make sure that parallel '--stress' test jobs get different
1498         # ports.
1499         port=$(($port + ${GIT_TEST_STRESS_JOB_NR:-0}))
1500         eval $var=$port
1501 }
1502
1503 # When running an StGit command that should exit with an error, use
1504 # these instead of testing for any non-zero exit code with !.
1505 general_error () { test_expect_code 1 "$@" ; }
1506 command_error () { test_expect_code 2 "$@" ; }
1507 conflict () { test_expect_code 3 "$@" ; }