Andrew's git / gitweb.git / t/test-lib-functions.sh
?
t / test-lib-functions.shon commit revision: new rev^-n shorthand for rev^n..rev (8779351)
   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.
  28test_set_editor () {
  29        FAKE_EDITOR="$1"
  30        export FAKE_EDITOR
  31        EDITOR='"$FAKE_EDITOR"'
  32        export EDITOR
  33}
  34
  35test_set_index_version () {
  36    GIT_INDEX_VERSION="$1"
  37    export GIT_INDEX_VERSION
  38}
  39
  40test_decode_color () {
  41        awk '
  42                function name(n) {
  43                        if (n == 0) return "RESET";
  44                        if (n == 1) return "BOLD";
  45                        if (n == 30) return "BLACK";
  46                        if (n == 31) return "RED";
  47                        if (n == 32) return "GREEN";
  48                        if (n == 33) return "YELLOW";
  49                        if (n == 34) return "BLUE";
  50                        if (n == 35) return "MAGENTA";
  51                        if (n == 36) return "CYAN";
  52                        if (n == 37) return "WHITE";
  53                        if (n == 40) return "BLACK";
  54                        if (n == 41) return "BRED";
  55                        if (n == 42) return "BGREEN";
  56                        if (n == 43) return "BYELLOW";
  57                        if (n == 44) return "BBLUE";
  58                        if (n == 45) return "BMAGENTA";
  59                        if (n == 46) return "BCYAN";
  60                        if (n == 47) return "BWHITE";
  61                }
  62                {
  63                        while (match($0, /\033\[[0-9;]*m/) != 0) {
  64                                printf "%s<", substr($0, 1, RSTART-1);
  65                                codes = substr($0, RSTART+2, RLENGTH-3);
  66                                if (length(codes) == 0)
  67                                        printf "%s", name(0)
  68                                else {
  69                                        n = split(codes, ary, ";");
  70                                        sep = "";
  71                                        for (i = 1; i <= n; i++) {
  72                                                printf "%s%s", sep, name(ary[i]);
  73                                                sep = ";"
  74                                        }
  75                                }
  76                                printf ">";
  77                                $0 = substr($0, RSTART + RLENGTH, length($0) - RSTART - RLENGTH + 1);
  78                        }
  79                        print
  80                }
  81        '
  82}
  83
  84nul_to_q () {
  85        perl -pe 'y/\000/Q/'
  86}
  87
  88q_to_nul () {
  89        perl -pe 'y/Q/\000/'
  90}
  91
  92q_to_cr () {
  93        tr Q '\015'
  94}
  95
  96q_to_tab () {
  97        tr Q '\011'
  98}
  99
 100qz_to_tab_space () {
 101        tr QZ '\011\040'
 102}
 103
 104append_cr () {
 105        sed -e 's/$/Q/' | tr Q '\015'
 106}
 107
 108remove_cr () {
 109        tr '\015' Q | sed -e 's/Q$//'
 110}
 111
 112# In some bourne shell implementations, the "unset" builtin returns
 113# nonzero status when a variable to be unset was not set in the first
 114# place.
 115#
 116# Use sane_unset when that should not be considered an error.
 117
 118sane_unset () {
 119        unset "$@"
 120        return 0
 121}
 122
 123test_tick () {
 124        if test -z "${test_tick+set}"
 125        then
 126                test_tick=1112911993
 127        else
 128                test_tick=$(($test_tick + 60))
 129        fi
 130        GIT_COMMITTER_DATE="$test_tick -0700"
 131        GIT_AUTHOR_DATE="$test_tick -0700"
 132        export GIT_COMMITTER_DATE GIT_AUTHOR_DATE
 133}
 134
 135# Stop execution and start a shell. This is useful for debugging tests and
 136# only makes sense together with "-v".
 137#
 138# Be sure to remove all invocations of this command before submitting.
 139
 140test_pause () {
 141        if test "$verbose" = t; then
 142                "$SHELL_PATH" <&6 >&3 2>&4
 143        else
 144                error >&5 "test_pause requires --verbose"
 145        fi
 146}
 147
 148# Wrap git in gdb. Adding this to a command can make it easier to
 149# understand what is going on in a failing test.
 150#
 151# Example: "debug git checkout master".
 152debug () {
 153         GIT_TEST_GDB=1 "$@"
 154}
 155
 156# Call test_commit with the arguments "<message> [<file> [<contents> [<tag>]]]"
 157#
 158# This will commit a file with the given contents and the given commit
 159# message, and tag the resulting commit with the given tag name.
 160#
 161# <file>, <contents>, and <tag> all default to <message>.
 162
 163test_commit () {
 164        notick= &&
 165        signoff= &&
 166        while test $# != 0
 167        do
 168                case "$1" in
 169                --notick)
 170                        notick=yes
 171                        ;;
 172                --signoff)
 173                        signoff="$1"
 174                        ;;
 175                *)
 176                        break
 177                        ;;
 178                esac
 179                shift
 180        done &&
 181        file=${2:-"$1.t"} &&
 182        echo "${3-$1}" > "$file" &&
 183        git add "$file" &&
 184        if test -z "$notick"
 185        then
 186                test_tick
 187        fi &&
 188        git commit $signoff -m "$1" &&
 189        git tag "${4:-$1}"
 190}
 191
 192# Call test_merge with the arguments "<message> <commit>", where <commit>
 193# can be a tag pointing to the commit-to-merge.
 194
 195test_merge () {
 196        test_tick &&
 197        git merge -m "$1" "$2" &&
 198        git tag "$1"
 199}
 200
 201# This function helps systems where core.filemode=false is set.
 202# Use it instead of plain 'chmod +x' to set or unset the executable bit
 203# of a file in the working directory and add it to the index.
 204
 205test_chmod () {
 206        chmod "$@" &&
 207        git update-index --add "--chmod=$@"
 208}
 209
 210# Unset a configuration variable, but don't fail if it doesn't exist.
 211test_unconfig () {
 212        config_dir=
 213        if test "$1" = -C
 214        then
 215                shift
 216                config_dir=$1
 217                shift
 218        fi
 219        git ${config_dir:+-C "$config_dir"} config --unset-all "$@"
 220        config_status=$?
 221        case "$config_status" in
 222        5) # ok, nothing to unset
 223                config_status=0
 224                ;;
 225        esac
 226        return $config_status
 227}
 228
 229# Set git config, automatically unsetting it after the test is over.
 230test_config () {
 231        config_dir=
 232        if test "$1" = -C
 233        then
 234                shift
 235                config_dir=$1
 236                shift
 237        fi
 238        test_when_finished "test_unconfig ${config_dir:+-C '$config_dir'} '$1'" &&
 239        git ${config_dir:+-C "$config_dir"} config "$@"
 240}
 241
 242test_config_global () {
 243        test_when_finished "test_unconfig --global '$1'" &&
 244        git config --global "$@"
 245}
 246
 247write_script () {
 248        {
 249                echo "#!${2-"$SHELL_PATH"}" &&
 250                cat
 251        } >"$1" &&
 252        chmod +x "$1"
 253}
 254
 255# Use test_set_prereq to tell that a particular prerequisite is available.
 256# The prerequisite can later be checked for in two ways:
 257#
 258# - Explicitly using test_have_prereq.
 259#
 260# - Implicitly by specifying the prerequisite tag in the calls to
 261#   test_expect_{success,failure,code}.
 262#
 263# The single parameter is the prerequisite tag (a simple word, in all
 264# capital letters by convention).
 265
 266test_set_prereq () {
 267        satisfied_prereq="$satisfied_prereq$1 "
 268}
 269satisfied_prereq=" "
 270lazily_testable_prereq= lazily_tested_prereq=
 271
 272# Usage: test_lazy_prereq PREREQ 'script'
 273test_lazy_prereq () {
 274        lazily_testable_prereq="$lazily_testable_prereq$1 "
 275        eval test_prereq_lazily_$1=\$2
 276}
 277
 278test_run_lazy_prereq_ () {
 279        script='
 280mkdir -p "$TRASH_DIRECTORY/prereq-test-dir" &&
 281(
 282        cd "$TRASH_DIRECTORY/prereq-test-dir" &&'"$2"'
 283)'
 284        say >&3 "checking prerequisite: $1"
 285        say >&3 "$script"
 286        test_eval_ "$script"
 287        eval_ret=$?
 288        rm -rf "$TRASH_DIRECTORY/prereq-test-dir"
 289        if test "$eval_ret" = 0; then
 290                say >&3 "prerequisite $1 ok"
 291        else
 292                say >&3 "prerequisite $1 not satisfied"
 293        fi
 294        return $eval_ret
 295}
 296
 297test_have_prereq () {
 298        # prerequisites can be concatenated with ','
 299        save_IFS=$IFS
 300        IFS=,
 301        set -- $*
 302        IFS=$save_IFS
 303
 304        total_prereq=0
 305        ok_prereq=0
 306        missing_prereq=
 307
 308        for prerequisite
 309        do
 310                case "$prerequisite" in
 311                !*)
 312                        negative_prereq=t
 313                        prerequisite=${prerequisite#!}
 314                        ;;
 315                *)
 316                        negative_prereq=
 317                esac
 318
 319                case " $lazily_tested_prereq " in
 320                *" $prerequisite "*)
 321                        ;;
 322                *)
 323                        case " $lazily_testable_prereq " in
 324                        *" $prerequisite "*)
 325                                eval "script=\$test_prereq_lazily_$prerequisite" &&
 326                                if test_run_lazy_prereq_ "$prerequisite" "$script"
 327                                then
 328                                        test_set_prereq $prerequisite
 329                                fi
 330                                lazily_tested_prereq="$lazily_tested_prereq$prerequisite "
 331                        esac
 332                        ;;
 333                esac
 334
 335                total_prereq=$(($total_prereq + 1))
 336                case "$satisfied_prereq" in
 337                *" $prerequisite "*)
 338                        satisfied_this_prereq=t
 339                        ;;
 340                *)
 341                        satisfied_this_prereq=
 342                esac
 343
 344                case "$satisfied_this_prereq,$negative_prereq" in
 345                t,|,t)
 346                        ok_prereq=$(($ok_prereq + 1))
 347                        ;;
 348                *)
 349                        # Keep a list of missing prerequisites; restore
 350                        # the negative marker if necessary.
 351                        prerequisite=${negative_prereq:+!}$prerequisite
 352                        if test -z "$missing_prereq"
 353                        then
 354                                missing_prereq=$prerequisite
 355                        else
 356                                missing_prereq="$prerequisite,$missing_prereq"
 357                        fi
 358                esac
 359        done
 360
 361        test $total_prereq = $ok_prereq
 362}
 363
 364test_declared_prereq () {
 365        case ",$test_prereq," in
 366        *,$1,*)
 367                return 0
 368                ;;
 369        esac
 370        return 1
 371}
 372
 373test_verify_prereq () {
 374        test -z "$test_prereq" ||
 375        expr >/dev/null "$test_prereq" : '[A-Z0-9_,!]*$' ||
 376        error "bug in the test script: '$test_prereq' does not look like a prereq"
 377}
 378
 379test_expect_failure () {
 380        test_start_
 381        test "$#" = 3 && { test_prereq=$1; shift; } || test_prereq=
 382        test "$#" = 2 ||
 383        error "bug in the test script: not 2 or 3 parameters to test-expect-failure"
 384        test_verify_prereq
 385        export test_prereq
 386        if ! test_skip "$@"
 387        then
 388                say >&3 "checking known breakage: $2"
 389                if test_run_ "$2" expecting_failure
 390                then
 391                        test_known_broken_ok_ "$1"
 392                else
 393                        test_known_broken_failure_ "$1"
 394                fi
 395        fi
 396        test_finish_
 397}
 398
 399test_expect_success () {
 400        test_start_
 401        test "$#" = 3 && { test_prereq=$1; shift; } || test_prereq=
 402        test "$#" = 2 ||
 403        error "bug in the test script: not 2 or 3 parameters to test-expect-success"
 404        test_verify_prereq
 405        export test_prereq
 406        if ! test_skip "$@"
 407        then
 408                say >&3 "expecting success: $2"
 409                if test_run_ "$2"
 410                then
 411                        test_ok_ "$1"
 412                else
 413                        test_failure_ "$@"
 414                fi
 415        fi
 416        test_finish_
 417}
 418
 419# test_external runs external test scripts that provide continuous
 420# test output about their progress, and succeeds/fails on
 421# zero/non-zero exit code.  It outputs the test output on stdout even
 422# in non-verbose mode, and announces the external script with "# run
 423# <n>: ..." before running it.  When providing relative paths, keep in
 424# mind that all scripts run in "trash directory".
 425# Usage: test_external description command arguments...
 426# Example: test_external 'Perl API' perl ../path/to/test.pl
 427test_external () {
 428        test "$#" = 4 && { test_prereq=$1; shift; } || test_prereq=
 429        test "$#" = 3 ||
 430        error >&5 "bug in the test script: not 3 or 4 parameters to test_external"
 431        descr="$1"
 432        shift
 433        test_verify_prereq
 434        export test_prereq
 435        if ! test_skip "$descr" "$@"
 436        then
 437                # Announce the script to reduce confusion about the
 438                # test output that follows.
 439                say_color "" "# run $test_count: $descr ($*)"
 440                # Export TEST_DIRECTORY, TRASH_DIRECTORY and GIT_TEST_LONG
 441                # to be able to use them in script
 442                export TEST_DIRECTORY TRASH_DIRECTORY GIT_TEST_LONG
 443                # Run command; redirect its stderr to &4 as in
 444                # test_run_, but keep its stdout on our stdout even in
 445                # non-verbose mode.
 446                "$@" 2>&4
 447                if test "$?" = 0
 448                then
 449                        if test $test_external_has_tap -eq 0; then
 450                                test_ok_ "$descr"
 451                        else
 452                                say_color "" "# test_external test $descr was ok"
 453                                test_success=$(($test_success + 1))
 454                        fi
 455                else
 456                        if test $test_external_has_tap -eq 0; then
 457                                test_failure_ "$descr" "$@"
 458                        else
 459                                say_color error "# test_external test $descr failed: $@"
 460                                test_failure=$(($test_failure + 1))
 461                        fi
 462                fi
 463        fi
 464}
 465
 466# Like test_external, but in addition tests that the command generated
 467# no output on stderr.
 468test_external_without_stderr () {
 469        # The temporary file has no (and must have no) security
 470        # implications.
 471        tmp=${TMPDIR:-/tmp}
 472        stderr="$tmp/git-external-stderr.$$.tmp"
 473        test_external "$@" 4> "$stderr"
 474        test -f "$stderr" || error "Internal error: $stderr disappeared."
 475        descr="no stderr: $1"
 476        shift
 477        say >&3 "# expecting no stderr from previous command"
 478        if test ! -s "$stderr"
 479        then
 480                rm "$stderr"
 481
 482                if test $test_external_has_tap -eq 0; then
 483                        test_ok_ "$descr"
 484                else
 485                        say_color "" "# test_external_without_stderr test $descr was ok"
 486                        test_success=$(($test_success + 1))
 487                fi
 488        else
 489                if test "$verbose" = t
 490                then
 491                        output=$(echo; echo "# Stderr is:"; cat "$stderr")
 492                else
 493                        output=
 494                fi
 495                # rm first in case test_failure exits.
 496                rm "$stderr"
 497                if test $test_external_has_tap -eq 0; then
 498                        test_failure_ "$descr" "$@" "$output"
 499                else
 500                        say_color error "# test_external_without_stderr test $descr failed: $@: $output"
 501                        test_failure=$(($test_failure + 1))
 502                fi
 503        fi
 504}
 505
 506# debugging-friendly alternatives to "test [-f|-d|-e]"
 507# The commands test the existence or non-existence of $1. $2 can be
 508# given to provide a more precise diagnosis.
 509test_path_is_file () {
 510        if ! test -f "$1"
 511        then
 512                echo "File $1 doesn't exist. $2"
 513                false
 514        fi
 515}
 516
 517test_path_is_dir () {
 518        if ! test -d "$1"
 519        then
 520                echo "Directory $1 doesn't exist. $2"
 521                false
 522        fi
 523}
 524
 525# Check if the directory exists and is empty as expected, barf otherwise.
 526test_dir_is_empty () {
 527        test_path_is_dir "$1" &&
 528        if test -n "$(ls -a1 "$1" | egrep -v '^\.\.?$')"
 529        then
 530                echo "Directory '$1' is not empty, it contains:"
 531                ls -la "$1"
 532                return 1
 533        fi
 534}
 535
 536test_path_is_missing () {
 537        if test -e "$1"
 538        then
 539                echo "Path exists:"
 540                ls -ld "$1"
 541                if test $# -ge 1
 542                then
 543                        echo "$*"
 544                fi
 545                false
 546        fi
 547}
 548
 549# test_line_count checks that a file has the number of lines it
 550# ought to. For example:
 551#
 552#       test_expect_success 'produce exactly one line of output' '
 553#               do something >output &&
 554#               test_line_count = 1 output
 555#       '
 556#
 557# is like "test $(wc -l <output) = 1" except that it passes the
 558# output through when the number of lines is wrong.
 559
 560test_line_count () {
 561        if test $# != 3
 562        then
 563                error "bug in the test script: not 3 parameters to test_line_count"
 564        elif ! test $(wc -l <"$3") "$1" "$2"
 565        then
 566                echo "test_line_count: line count for $3 !$1 $2"
 567                cat "$3"
 568                return 1
 569        fi
 570}
 571
 572# Returns success if a comma separated string of keywords ($1) contains a
 573# given keyword ($2).
 574# Examples:
 575# `list_contains "foo,bar" bar` returns 0
 576# `list_contains "foo" bar` returns 1
 577
 578list_contains () {
 579        case ",$1," in
 580        *,$2,*)
 581                return 0
 582                ;;
 583        esac
 584        return 1
 585}
 586
 587# This is not among top-level (test_expect_success | test_expect_failure)
 588# but is a prefix that can be used in the test script, like:
 589#
 590#       test_expect_success 'complain and die' '
 591#           do something &&
 592#           do something else &&
 593#           test_must_fail git checkout ../outerspace
 594#       '
 595#
 596# Writing this as "! git checkout ../outerspace" is wrong, because
 597# the failure could be due to a segv.  We want a controlled failure.
 598
 599test_must_fail () {
 600        case "$1" in
 601        ok=*)
 602                _test_ok=${1#ok=}
 603                shift
 604                ;;
 605        *)
 606                _test_ok=
 607                ;;
 608        esac
 609        "$@"
 610        exit_code=$?
 611        if test $exit_code -eq 0 && ! list_contains "$_test_ok" success
 612        then
 613                echo >&2 "test_must_fail: command succeeded: $*"
 614                return 1
 615        elif test_match_signal 13 $exit_code && list_contains "$_test_ok" sigpipe
 616        then
 617                return 0
 618        elif test $exit_code -gt 129 && test $exit_code -le 192
 619        then
 620                echo >&2 "test_must_fail: died by signal $(($exit_code - 128)): $*"
 621                return 1
 622        elif test $exit_code -eq 127
 623        then
 624                echo >&2 "test_must_fail: command not found: $*"
 625                return 1
 626        elif test $exit_code -eq 126
 627        then
 628                echo >&2 "test_must_fail: valgrind error: $*"
 629                return 1
 630        fi
 631        return 0
 632}
 633
 634# Similar to test_must_fail, but tolerates success, too.  This is
 635# meant to be used in contexts like:
 636#
 637#       test_expect_success 'some command works without configuration' '
 638#               test_might_fail git config --unset all.configuration &&
 639#               do something
 640#       '
 641#
 642# Writing "git config --unset all.configuration || :" would be wrong,
 643# because we want to notice if it fails due to segv.
 644
 645test_might_fail () {
 646        test_must_fail ok=success "$@"
 647}
 648
 649# Similar to test_must_fail and test_might_fail, but check that a
 650# given command exited with a given exit code. Meant to be used as:
 651#
 652#       test_expect_success 'Merge with d/f conflicts' '
 653#               test_expect_code 1 git merge "merge msg" B master
 654#       '
 655
 656test_expect_code () {
 657        want_code=$1
 658        shift
 659        "$@"
 660        exit_code=$?
 661        if test $exit_code = $want_code
 662        then
 663                return 0
 664        fi
 665
 666        echo >&2 "test_expect_code: command exited with $exit_code, we wanted $want_code $*"
 667        return 1
 668}
 669
 670# test_cmp is a helper function to compare actual and expected output.
 671# You can use it like:
 672#
 673#       test_expect_success 'foo works' '
 674#               echo expected >expected &&
 675#               foo >actual &&
 676#               test_cmp expected actual
 677#       '
 678#
 679# This could be written as either "cmp" or "diff -u", but:
 680# - cmp's output is not nearly as easy to read as diff -u
 681# - not all diff versions understand "-u"
 682
 683test_cmp() {
 684        $GIT_TEST_CMP "$@"
 685}
 686
 687# test_cmp_bin - helper to compare binary files
 688
 689test_cmp_bin() {
 690        cmp "$@"
 691}
 692
 693# Call any command "$@" but be more verbose about its
 694# failure. This is handy for commands like "test" which do
 695# not output anything when they fail.
 696verbose () {
 697        "$@" && return 0
 698        echo >&2 "command failed: $(git rev-parse --sq-quote "$@")"
 699        return 1
 700}
 701
 702# Check if the file expected to be empty is indeed empty, and barfs
 703# otherwise.
 704
 705test_must_be_empty () {
 706        if test -s "$1"
 707        then
 708                echo "'$1' is not empty, it contains:"
 709                cat "$1"
 710                return 1
 711        fi
 712}
 713
 714# Tests that its two parameters refer to the same revision
 715test_cmp_rev () {
 716        git rev-parse --verify "$1" >expect.rev &&
 717        git rev-parse --verify "$2" >actual.rev &&
 718        test_cmp expect.rev actual.rev
 719}
 720
 721# Print a sequence of integers in increasing order, either with
 722# two arguments (start and end):
 723#
 724#     test_seq 1 5 -- outputs 1 2 3 4 5 one line at a time
 725#
 726# or with one argument (end), in which case it starts counting
 727# from 1.
 728
 729test_seq () {
 730        case $# in
 731        1)      set 1 "$@" ;;
 732        2)      ;;
 733        *)      error "bug in the test script: not 1 or 2 parameters to test_seq" ;;
 734        esac
 735        test_seq_counter__=$1
 736        while test "$test_seq_counter__" -le "$2"
 737        do
 738                echo "$test_seq_counter__"
 739                test_seq_counter__=$(( $test_seq_counter__ + 1 ))
 740        done
 741}
 742
 743# This function can be used to schedule some commands to be run
 744# unconditionally at the end of the test to restore sanity:
 745#
 746#       test_expect_success 'test core.capslock' '
 747#               git config core.capslock true &&
 748#               test_when_finished "git config --unset core.capslock" &&
 749#               hello world
 750#       '
 751#
 752# That would be roughly equivalent to
 753#
 754#       test_expect_success 'test core.capslock' '
 755#               git config core.capslock true &&
 756#               hello world
 757#               git config --unset core.capslock
 758#       '
 759#
 760# except that the greeting and config --unset must both succeed for
 761# the test to pass.
 762#
 763# Note that under --immediate mode, no clean-up is done to help diagnose
 764# what went wrong.
 765
 766test_when_finished () {
 767        # We cannot detect when we are in a subshell in general, but by
 768        # doing so on Bash is better than nothing (the test will
 769        # silently pass on other shells).
 770        test "${BASH_SUBSHELL-0}" = 0 ||
 771        error "bug in test script: test_when_finished does nothing in a subshell"
 772        test_cleanup="{ $*
 773                } && (exit \"\$eval_ret\"); eval_ret=\$?; $test_cleanup"
 774}
 775
 776# Most tests can use the created repository, but some may need to create more.
 777# Usage: test_create_repo <directory>
 778test_create_repo () {
 779        test "$#" = 1 ||
 780        error "bug in the test script: not 1 parameter to test-create-repo"
 781        repo="$1"
 782        mkdir -p "$repo"
 783        (
 784                cd "$repo" || error "Cannot setup test environment"
 785                "$GIT_EXEC_PATH/git-init" "--template=$GIT_BUILD_DIR/templates/blt/" >&3 2>&4 ||
 786                error "cannot run git init -- have you built things yet?"
 787                mv .git/hooks .git/hooks-disabled
 788        ) || exit
 789}
 790
 791# This function helps on symlink challenged file systems when it is not
 792# important that the file system entry is a symbolic link.
 793# Use test_ln_s_add instead of "ln -s x y && git add y" to add a
 794# symbolic link entry y to the index.
 795
 796test_ln_s_add () {
 797        if test_have_prereq SYMLINKS
 798        then
 799                ln -s "$1" "$2" &&
 800                git update-index --add "$2"
 801        else
 802                printf '%s' "$1" >"$2" &&
 803                ln_s_obj=$(git hash-object -w "$2") &&
 804                git update-index --add --cacheinfo 120000 $ln_s_obj "$2" &&
 805                # pick up stat info from the file
 806                git update-index "$2"
 807        fi
 808}
 809
 810# This function writes out its parameters, one per line
 811test_write_lines () {
 812        printf "%s\n" "$@"
 813}
 814
 815perl () {
 816        command "$PERL_PATH" "$@"
 817}
 818
 819# Is the value one of the various ways to spell a boolean true/false?
 820test_normalize_bool () {
 821        git -c magic.variable="$1" config --bool magic.variable 2>/dev/null
 822}
 823
 824# Given a variable $1, normalize the value of it to one of "true",
 825# "false", or "auto" and store the result to it.
 826#
 827#     test_tristate GIT_TEST_HTTPD
 828#
 829# A variable set to an empty string is set to 'false'.
 830# A variable set to 'false' or 'auto' keeps its value.
 831# Anything else is set to 'true'.
 832# An unset variable defaults to 'auto'.
 833#
 834# The last rule is to allow people to set the variable to an empty
 835# string and export it to decline testing the particular feature
 836# for versions both before and after this change.  We used to treat
 837# both unset and empty variable as a signal for "do not test" and
 838# took any non-empty string as "please test".
 839
 840test_tristate () {
 841        if eval "test x\"\${$1+isset}\" = xisset"
 842        then
 843                # explicitly set
 844                eval "
 845                        case \"\$$1\" in
 846                        '')     $1=false ;;
 847                        auto)   ;;
 848                        *)      $1=\$(test_normalize_bool \$$1 || echo true) ;;
 849                        esac
 850                "
 851        else
 852                eval "$1=auto"
 853        fi
 854}
 855
 856# Exit the test suite, either by skipping all remaining tests or by
 857# exiting with an error. If "$1" is "auto", we then we assume we were
 858# opportunistically trying to set up some tests and we skip. If it is
 859# "true", then we report a failure.
 860#
 861# The error/skip message should be given by $2.
 862#
 863test_skip_or_die () {
 864        case "$1" in
 865        auto)
 866                skip_all=$2
 867                test_done
 868                ;;
 869        true)
 870                error "$2"
 871                ;;
 872        *)
 873                error "BUG: test tristate is '$1' (real error: $2)"
 874        esac
 875}
 876
 877# The following mingw_* functions obey POSIX shell syntax, but are actually
 878# bash scripts, and are meant to be used only with bash on Windows.
 879
 880# A test_cmp function that treats LF and CRLF equal and avoids to fork
 881# diff when possible.
 882mingw_test_cmp () {
 883        # Read text into shell variables and compare them. If the results
 884        # are different, use regular diff to report the difference.
 885        local test_cmp_a= test_cmp_b=
 886
 887        # When text came from stdin (one argument is '-') we must feed it
 888        # to diff.
 889        local stdin_for_diff=
 890
 891        # Since it is difficult to detect the difference between an
 892        # empty input file and a failure to read the files, we go straight
 893        # to diff if one of the inputs is empty.
 894        if test -s "$1" && test -s "$2"
 895        then
 896                # regular case: both files non-empty
 897                mingw_read_file_strip_cr_ test_cmp_a <"$1"
 898                mingw_read_file_strip_cr_ test_cmp_b <"$2"
 899        elif test -s "$1" && test "$2" = -
 900        then
 901                # read 2nd file from stdin
 902                mingw_read_file_strip_cr_ test_cmp_a <"$1"
 903                mingw_read_file_strip_cr_ test_cmp_b
 904                stdin_for_diff='<<<"$test_cmp_b"'
 905        elif test "$1" = - && test -s "$2"
 906        then
 907                # read 1st file from stdin
 908                mingw_read_file_strip_cr_ test_cmp_a
 909                mingw_read_file_strip_cr_ test_cmp_b <"$2"
 910                stdin_for_diff='<<<"$test_cmp_a"'
 911        fi
 912        test -n "$test_cmp_a" &&
 913        test -n "$test_cmp_b" &&
 914        test "$test_cmp_a" = "$test_cmp_b" ||
 915        eval "diff -u \"\$@\" $stdin_for_diff"
 916}
 917
 918# $1 is the name of the shell variable to fill in
 919mingw_read_file_strip_cr_ () {
 920        # Read line-wise using LF as the line separator
 921        # and use IFS to strip CR.
 922        local line
 923        while :
 924        do
 925                if IFS=$'\r' read -r -d $'\n' line
 926                then
 927                        # good
 928                        line=$line$'\n'
 929                else
 930                        # we get here at EOF, but also if the last line
 931                        # was not terminated by LF; in the latter case,
 932                        # some text was read
 933                        if test -z "$line"
 934                        then
 935                                # EOF, really
 936                                break
 937                        fi
 938                fi
 939                eval "$1=\$$1\$line"
 940        done
 941}
 942
 943# Like "env FOO=BAR some-program", but run inside a subshell, which means
 944# it also works for shell functions (though those functions cannot impact
 945# the environment outside of the test_env invocation).
 946test_env () {
 947        (
 948                while test $# -gt 0
 949                do
 950                        case "$1" in
 951                        *=*)
 952                                eval "${1%%=*}=\${1#*=}"
 953                                eval "export ${1%%=*}"
 954                                shift
 955                                ;;
 956                        *)
 957                                "$@"
 958                                exit
 959                                ;;
 960                        esac
 961                done
 962        )
 963}
 964
 965# Returns true if the numeric exit code in "$2" represents the expected signal
 966# in "$1". Signals should be given numerically.
 967test_match_signal () {
 968        if test "$2" = "$((128 + $1))"
 969        then
 970                # POSIX
 971                return 0
 972        elif test "$2" = "$((256 + $1))"
 973        then
 974                # ksh
 975                return 0
 976        fi
 977        return 1
 978}
 979
 980# Read up to "$1" bytes (or to EOF) from stdin and write them to stdout.
 981test_copy_bytes () {
 982        perl -e '
 983                my $len = $ARGV[1];
 984                while ($len > 0) {
 985                        my $s;
 986                        my $nread = sysread(STDIN, $s, $len);
 987                        die "cannot read: $!" unless defined($nread);
 988                        print $s;
 989                        $len -= $nread;
 990                }
 991        ' - "$1"
 992}