t / test-lib.shon commit test-lib.sh: Add check for invalid use of 'skip_all' facility (bf4b721)
   1#!/bin/sh
   2#
   3# Copyright (c) 2005 Junio C Hamano
   4#
   5# This program is free software: you can redistribute it and/or modify
   6# it under the terms of the GNU General Public License as published by
   7# the Free Software Foundation, either version 2 of the License, or
   8# (at your option) any later version.
   9#
  10# This program is distributed in the hope that it will be useful,
  11# but WITHOUT ANY WARRANTY; without even the implied warranty of
  12# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13# GNU General Public License for more details.
  14#
  15# You should have received a copy of the GNU General Public License
  16# along with this program.  If not, see http://www.gnu.org/licenses/ .
  17
  18# if --tee was passed, write the output not only to the terminal, but
  19# additionally to the file test-results/$BASENAME.out, too.
  20case "$GIT_TEST_TEE_STARTED, $* " in
  21done,*)
  22        # do not redirect again
  23        ;;
  24*' --tee '*|*' --va'*)
  25        mkdir -p test-results
  26        BASE=test-results/$(basename "$0" .sh)
  27        (GIT_TEST_TEE_STARTED=done ${SHELL-sh} "$0" "$@" 2>&1;
  28         echo $? > $BASE.exit) | tee $BASE.out
  29        test "$(cat $BASE.exit)" = 0
  30        exit
  31        ;;
  32esac
  33
  34# Keep the original TERM for say_color
  35ORIGINAL_TERM=$TERM
  36
  37# Test the binaries we have just built.  The tests are kept in
  38# t/ subdirectory and are run in 'trash directory' subdirectory.
  39if test -z "$TEST_DIRECTORY"
  40then
  41        # We allow tests to override this, in case they want to run tests
  42        # outside of t/, e.g. for running tests on the test library
  43        # itself.
  44        TEST_DIRECTORY=$(pwd)
  45fi
  46if test -z "$TEST_OUTPUT_DIRECTORY"
  47then
  48        # Similarly, override this to store the test-results subdir
  49        # elsewhere
  50        TEST_OUTPUT_DIRECTORY=$TEST_DIRECTORY
  51fi
  52GIT_BUILD_DIR="$TEST_DIRECTORY"/..
  53
  54. "$GIT_BUILD_DIR"/GIT-BUILD-OPTIONS
  55export PERL_PATH SHELL_PATH
  56
  57# For repeatability, reset the environment to known value.
  58LANG=C
  59LC_ALL=C
  60PAGER=cat
  61TZ=UTC
  62TERM=dumb
  63export LANG LC_ALL PAGER TERM TZ
  64EDITOR=:
  65# A call to "unset" with no arguments causes at least Solaris 10
  66# /usr/xpg4/bin/sh and /bin/ksh to bail out.  So keep the unsets
  67# deriving from the command substitution clustered with the other
  68# ones.
  69unset VISUAL EMAIL LANGUAGE COLUMNS $("$PERL_PATH" -e '
  70        my @env = keys %ENV;
  71        my $ok = join("|", qw(
  72                TRACE
  73                DEBUG
  74                USE_LOOKUP
  75                TEST
  76                .*_TEST
  77                PROVE
  78                VALGRIND
  79                PERF_AGGREGATING_LATER
  80        ));
  81        my @vars = grep(/^GIT_/ && !/^GIT_($ok)/o, @env);
  82        print join("\n", @vars);
  83')
  84unset XDG_CONFIG_HOME
  85GIT_AUTHOR_EMAIL=author@example.com
  86GIT_AUTHOR_NAME='A U Thor'
  87GIT_COMMITTER_EMAIL=committer@example.com
  88GIT_COMMITTER_NAME='C O Mitter'
  89GIT_MERGE_VERBOSITY=5
  90GIT_MERGE_AUTOEDIT=no
  91export GIT_MERGE_VERBOSITY GIT_MERGE_AUTOEDIT
  92export GIT_AUTHOR_EMAIL GIT_AUTHOR_NAME
  93export GIT_COMMITTER_EMAIL GIT_COMMITTER_NAME
  94export EDITOR
  95
  96# Protect ourselves from common misconfiguration to export
  97# CDPATH into the environment
  98unset CDPATH
  99
 100unset GREP_OPTIONS
 101
 102case $(echo $GIT_TRACE |tr "[A-Z]" "[a-z]") in
 1031|2|true)
 104        echo "* warning: Some tests will not work if GIT_TRACE" \
 105                "is set as to trace on STDERR ! *"
 106        echo "* warning: Please set GIT_TRACE to something" \
 107                "other than 1, 2 or true ! *"
 108        ;;
 109esac
 110
 111# Convenience
 112#
 113# A regexp to match 5 and 40 hexdigits
 114_x05='[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
 115_x40="$_x05$_x05$_x05$_x05$_x05$_x05$_x05$_x05"
 116
 117# Zero SHA-1
 118_z40=0000000000000000000000000000000000000000
 119
 120# Line feed
 121LF='
 122'
 123
 124export _x05 _x40 _z40 LF
 125
 126# Each test should start with something like this, after copyright notices:
 127#
 128# test_description='Description of this test...
 129# This test checks if command xyzzy does the right thing...
 130# '
 131# . ./test-lib.sh
 132[ "x$ORIGINAL_TERM" != "xdumb" ] && (
 133                TERM=$ORIGINAL_TERM &&
 134                export TERM &&
 135                [ -t 1 ] &&
 136                tput bold >/dev/null 2>&1 &&
 137                tput setaf 1 >/dev/null 2>&1 &&
 138                tput sgr0 >/dev/null 2>&1
 139        ) &&
 140        color=t
 141
 142while test "$#" -ne 0
 143do
 144        case "$1" in
 145        -d|--d|--de|--deb|--debu|--debug)
 146                debug=t; shift ;;
 147        -i|--i|--im|--imm|--imme|--immed|--immedi|--immedia|--immediat|--immediate)
 148                immediate=t; shift ;;
 149        -l|--l|--lo|--lon|--long|--long-|--long-t|--long-te|--long-tes|--long-test|--long-tests)
 150                GIT_TEST_LONG=t; export GIT_TEST_LONG; shift ;;
 151        -h|--h|--he|--hel|--help)
 152                help=t; shift ;;
 153        -v|--v|--ve|--ver|--verb|--verbo|--verbos|--verbose)
 154                verbose=t; shift ;;
 155        -q|--q|--qu|--qui|--quie|--quiet)
 156                # Ignore --quiet under a TAP::Harness. Saying how many tests
 157                # passed without the ok/not ok details is always an error.
 158                test -z "$HARNESS_ACTIVE" && quiet=t; shift ;;
 159        --with-dashes)
 160                with_dashes=t; shift ;;
 161        --no-color)
 162                color=; shift ;;
 163        --va|--val|--valg|--valgr|--valgri|--valgrin|--valgrind)
 164                valgrind=t; verbose=t; shift ;;
 165        --tee)
 166                shift ;; # was handled already
 167        --root=*)
 168                root=$(expr "z$1" : 'z[^=]*=\(.*\)')
 169                shift ;;
 170        *)
 171                echo "error: unknown test option '$1'" >&2; exit 1 ;;
 172        esac
 173done
 174
 175if test -n "$color"
 176then
 177        say_color () {
 178                (
 179                TERM=$ORIGINAL_TERM
 180                export TERM
 181                case "$1" in
 182                error)
 183                        tput bold; tput setaf 1;; # bold red
 184                skip)
 185                        tput bold; tput setaf 2;; # bold green
 186                pass)
 187                        tput setaf 2;;            # green
 188                info)
 189                        tput setaf 3;;            # brown
 190                *)
 191                        test -n "$quiet" && return;;
 192                esac
 193                shift
 194                printf "%s" "$*"
 195                tput sgr0
 196                echo
 197                )
 198        }
 199else
 200        say_color() {
 201                test -z "$1" && test -n "$quiet" && return
 202                shift
 203                echo "$*"
 204        }
 205fi
 206
 207error () {
 208        say_color error "error: $*"
 209        GIT_EXIT_OK=t
 210        exit 1
 211}
 212
 213say () {
 214        say_color info "$*"
 215}
 216
 217test "${test_description}" != "" ||
 218error "Test script did not set test_description."
 219
 220if test "$help" = "t"
 221then
 222        echo "$test_description"
 223        exit 0
 224fi
 225
 226exec 5>&1
 227exec 6<&0
 228if test "$verbose" = "t"
 229then
 230        exec 4>&2 3>&1
 231else
 232        exec 4>/dev/null 3>/dev/null
 233fi
 234
 235test_failure=0
 236test_count=0
 237test_fixed=0
 238test_broken=0
 239test_success=0
 240
 241test_external_has_tap=0
 242
 243die () {
 244        code=$?
 245        if test -n "$GIT_EXIT_OK"
 246        then
 247                exit $code
 248        else
 249                echo >&5 "FATAL: Unexpected exit with code $code"
 250                exit 1
 251        fi
 252}
 253
 254GIT_EXIT_OK=
 255trap 'die' EXIT
 256
 257# The user-facing functions are loaded from a separate file so that
 258# test_perf subshells can have them too
 259. "$TEST_DIRECTORY/test-lib-functions.sh"
 260
 261# You are not expected to call test_ok_ and test_failure_ directly, use
 262# the text_expect_* functions instead.
 263
 264test_ok_ () {
 265        test_success=$(($test_success + 1))
 266        say_color "" "ok $test_count - $@"
 267}
 268
 269test_failure_ () {
 270        test_failure=$(($test_failure + 1))
 271        say_color error "not ok - $test_count $1"
 272        shift
 273        echo "$@" | sed -e 's/^/#       /'
 274        test "$immediate" = "" || { GIT_EXIT_OK=t; exit 1; }
 275}
 276
 277test_known_broken_ok_ () {
 278        test_fixed=$(($test_fixed+1))
 279        say_color "" "ok $test_count - $@ # TODO known breakage"
 280}
 281
 282test_known_broken_failure_ () {
 283        test_broken=$(($test_broken+1))
 284        say_color skip "not ok $test_count - $@ # TODO known breakage"
 285}
 286
 287test_debug () {
 288        test "$debug" = "" || eval "$1"
 289}
 290
 291test_eval_ () {
 292        # This is a separate function because some tests use
 293        # "return" to end a test_expect_success block early.
 294        eval </dev/null >&3 2>&4 "$*"
 295}
 296
 297test_run_ () {
 298        test_cleanup=:
 299        expecting_failure=$2
 300        test_eval_ "$1"
 301        eval_ret=$?
 302
 303        if test -z "$immediate" || test $eval_ret = 0 || test -n "$expecting_failure"
 304        then
 305                test_eval_ "$test_cleanup"
 306        fi
 307        if test "$verbose" = "t" && test -n "$HARNESS_ACTIVE"
 308        then
 309                echo ""
 310        fi
 311        return "$eval_ret"
 312}
 313
 314test_skip () {
 315        test_count=$(($test_count+1))
 316        to_skip=
 317        for skp in $GIT_SKIP_TESTS
 318        do
 319                case $this_test.$test_count in
 320                $skp)
 321                        to_skip=t
 322                        break
 323                esac
 324        done
 325        if test -z "$to_skip" && test -n "$test_prereq" &&
 326           ! test_have_prereq "$test_prereq"
 327        then
 328                to_skip=t
 329        fi
 330        case "$to_skip" in
 331        t)
 332                of_prereq=
 333                if test "$missing_prereq" != "$test_prereq"
 334                then
 335                        of_prereq=" of $test_prereq"
 336                fi
 337
 338                say_color skip >&3 "skipping test: $@"
 339                say_color skip "ok $test_count # skip $1 (missing $missing_prereq${of_prereq})"
 340                : true
 341                ;;
 342        *)
 343                false
 344                ;;
 345        esac
 346}
 347
 348# stub; perf-lib overrides it
 349test_at_end_hook_ () {
 350        :
 351}
 352
 353test_done () {
 354        GIT_EXIT_OK=t
 355
 356        if test -z "$HARNESS_ACTIVE"
 357        then
 358                test_results_dir="$TEST_OUTPUT_DIRECTORY/test-results"
 359                mkdir -p "$test_results_dir"
 360                test_results_path="$test_results_dir/${0%.sh}-$$.counts"
 361
 362                cat >>"$test_results_path" <<-EOF
 363                total $test_count
 364                success $test_success
 365                fixed $test_fixed
 366                broken $test_broken
 367                failed $test_failure
 368
 369                EOF
 370        fi
 371
 372        if test "$test_fixed" != 0
 373        then
 374                say_color pass "# fixed $test_fixed known breakage(s)"
 375        fi
 376        if test "$test_broken" != 0
 377        then
 378                say_color error "# still have $test_broken known breakage(s)"
 379                msg="remaining $(($test_count-$test_broken)) test(s)"
 380        else
 381                msg="$test_count test(s)"
 382        fi
 383        case "$test_failure" in
 384        0)
 385                # Maybe print SKIP message
 386                if test -n "$skip_all" && test $test_count -gt 0
 387                then
 388                        error "Can't use skip_all after running some tests"
 389                fi
 390                [ -z "$skip_all" ] || skip_all=" # SKIP $skip_all"
 391
 392                if test $test_external_has_tap -eq 0
 393                then
 394                        say_color pass "# passed all $msg"
 395                        say "1..$test_count$skip_all"
 396                fi
 397
 398                test -d "$remove_trash" &&
 399                cd "$(dirname "$remove_trash")" &&
 400                rm -rf "$(basename "$remove_trash")"
 401
 402                test_at_end_hook_
 403
 404                exit 0 ;;
 405
 406        *)
 407                if test $test_external_has_tap -eq 0
 408                then
 409                        say_color error "# failed $test_failure among $msg"
 410                        say "1..$test_count"
 411                fi
 412
 413                exit 1 ;;
 414
 415        esac
 416}
 417
 418if test -n "$valgrind"
 419then
 420        make_symlink () {
 421                test -h "$2" &&
 422                test "$1" = "$(readlink "$2")" || {
 423                        # be super paranoid
 424                        if mkdir "$2".lock
 425                        then
 426                                rm -f "$2" &&
 427                                ln -s "$1" "$2" &&
 428                                rm -r "$2".lock
 429                        else
 430                                while test -d "$2".lock
 431                                do
 432                                        say "Waiting for lock on $2."
 433                                        sleep 1
 434                                done
 435                        fi
 436                }
 437        }
 438
 439        make_valgrind_symlink () {
 440                # handle only executables, unless they are shell libraries that
 441                # need to be in the exec-path.  We will just use "#!" as a
 442                # guess for a shell-script, since we have no idea what the user
 443                # may have configured as the shell path.
 444                test -x "$1" ||
 445                test "#!" = "$(head -c 2 <"$1")" ||
 446                return;
 447
 448                base=$(basename "$1")
 449                symlink_target=$GIT_BUILD_DIR/$base
 450                # do not override scripts
 451                if test -x "$symlink_target" &&
 452                    test ! -d "$symlink_target" &&
 453                    test "#!" != "$(head -c 2 < "$symlink_target")"
 454                then
 455                        symlink_target=../valgrind.sh
 456                fi
 457                case "$base" in
 458                *.sh|*.perl)
 459                        symlink_target=../unprocessed-script
 460                esac
 461                # create the link, or replace it if it is out of date
 462                make_symlink "$symlink_target" "$GIT_VALGRIND/bin/$base" || exit
 463        }
 464
 465        # override all git executables in TEST_DIRECTORY/..
 466        GIT_VALGRIND=$TEST_DIRECTORY/valgrind
 467        mkdir -p "$GIT_VALGRIND"/bin
 468        for file in $GIT_BUILD_DIR/git* $GIT_BUILD_DIR/test-*
 469        do
 470                make_valgrind_symlink $file
 471        done
 472        # special-case the mergetools loadables
 473        make_symlink "$GIT_BUILD_DIR"/mergetools "$GIT_VALGRIND/bin/mergetools"
 474        OLDIFS=$IFS
 475        IFS=:
 476        for path in $PATH
 477        do
 478                ls "$path"/git-* 2> /dev/null |
 479                while read file
 480                do
 481                        make_valgrind_symlink "$file"
 482                done
 483        done
 484        IFS=$OLDIFS
 485        PATH=$GIT_VALGRIND/bin:$PATH
 486        GIT_EXEC_PATH=$GIT_VALGRIND/bin
 487        export GIT_VALGRIND
 488elif test -n "$GIT_TEST_INSTALLED"
 489then
 490        GIT_EXEC_PATH=$($GIT_TEST_INSTALLED/git --exec-path)  ||
 491        error "Cannot run git from $GIT_TEST_INSTALLED."
 492        PATH=$GIT_TEST_INSTALLED:$GIT_BUILD_DIR:$PATH
 493        GIT_EXEC_PATH=${GIT_TEST_EXEC_PATH:-$GIT_EXEC_PATH}
 494else # normal case, use ../bin-wrappers only unless $with_dashes:
 495        git_bin_dir="$GIT_BUILD_DIR/bin-wrappers"
 496        if ! test -x "$git_bin_dir/git"
 497        then
 498                if test -z "$with_dashes"
 499                then
 500                        say "$git_bin_dir/git is not executable; using GIT_EXEC_PATH"
 501                fi
 502                with_dashes=t
 503        fi
 504        PATH="$git_bin_dir:$PATH"
 505        GIT_EXEC_PATH=$GIT_BUILD_DIR
 506        if test -n "$with_dashes"
 507        then
 508                PATH="$GIT_BUILD_DIR:$PATH"
 509        fi
 510fi
 511GIT_TEMPLATE_DIR="$GIT_BUILD_DIR"/templates/blt
 512unset GIT_CONFIG
 513GIT_CONFIG_NOSYSTEM=1
 514GIT_ATTR_NOSYSTEM=1
 515export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG_NOSYSTEM GIT_ATTR_NOSYSTEM
 516
 517if test -z "$GIT_TEST_CMP"
 518then
 519        if test -n "$GIT_TEST_CMP_USE_COPIED_CONTEXT"
 520        then
 521                GIT_TEST_CMP="$DIFF -c"
 522        else
 523                GIT_TEST_CMP="$DIFF -u"
 524        fi
 525fi
 526
 527GITPERLLIB="$GIT_BUILD_DIR"/perl/blib/lib:"$GIT_BUILD_DIR"/perl/blib/arch/auto/Git
 528export GITPERLLIB
 529test -d "$GIT_BUILD_DIR"/templates/blt || {
 530        error "You haven't built things yet, have you?"
 531}
 532
 533if test -z "$GIT_TEST_INSTALLED" && test -z "$NO_PYTHON"
 534then
 535        GITPYTHONLIB="$GIT_BUILD_DIR/git_remote_helpers/build/lib"
 536        export GITPYTHONLIB
 537        test -d "$GIT_BUILD_DIR"/git_remote_helpers/build || {
 538                error "You haven't built git_remote_helpers yet, have you?"
 539        }
 540fi
 541
 542if ! test -x "$GIT_BUILD_DIR"/test-chmtime
 543then
 544        echo >&2 'You need to build test-chmtime:'
 545        echo >&2 'Run "make test-chmtime" in the source (toplevel) directory'
 546        exit 1
 547fi
 548
 549# Test repository
 550test="trash directory.$(basename "$0" .sh)"
 551test -n "$root" && test="$root/$test"
 552case "$test" in
 553/*) TRASH_DIRECTORY="$test" ;;
 554 *) TRASH_DIRECTORY="$TEST_OUTPUT_DIRECTORY/$test" ;;
 555esac
 556test ! -z "$debug" || remove_trash=$TRASH_DIRECTORY
 557rm -fr "$test" || {
 558        GIT_EXIT_OK=t
 559        echo >&5 "FATAL: Cannot prepare test area"
 560        exit 1
 561}
 562
 563HOME="$TRASH_DIRECTORY"
 564export HOME
 565
 566if test -z "$TEST_NO_CREATE_REPO"
 567then
 568        test_create_repo "$test"
 569else
 570        mkdir -p "$test"
 571fi
 572# Use -P to resolve symlinks in our working directory so that the cwd
 573# in subprocesses like git equals our $PWD (for pathname comparisons).
 574cd -P "$test" || exit 1
 575
 576this_test=${0##*/}
 577this_test=${this_test%%-*}
 578for skp in $GIT_SKIP_TESTS
 579do
 580        case "$this_test" in
 581        $skp)
 582                say_color skip >&3 "skipping test $this_test altogether"
 583                skip_all="skip all tests in $this_test"
 584                test_done
 585        esac
 586done
 587
 588# Provide an implementation of the 'yes' utility
 589yes () {
 590        if test $# = 0
 591        then
 592                y=y
 593        else
 594                y="$*"
 595        fi
 596
 597        while echo "$y"
 598        do
 599                :
 600        done
 601}
 602
 603# Fix some commands on Windows
 604case $(uname -s) in
 605*MINGW*)
 606        # Windows has its own (incompatible) sort and find
 607        sort () {
 608                /usr/bin/sort "$@"
 609        }
 610        find () {
 611                /usr/bin/find "$@"
 612        }
 613        sum () {
 614                md5sum "$@"
 615        }
 616        # git sees Windows-style pwd
 617        pwd () {
 618                builtin pwd -W
 619        }
 620        # no POSIX permissions
 621        # backslashes in pathspec are converted to '/'
 622        # exec does not inherit the PID
 623        test_set_prereq MINGW
 624        test_set_prereq SED_STRIPS_CR
 625        ;;
 626*CYGWIN*)
 627        test_set_prereq POSIXPERM
 628        test_set_prereq EXECKEEPSPID
 629        test_set_prereq NOT_MINGW
 630        test_set_prereq SED_STRIPS_CR
 631        ;;
 632*)
 633        test_set_prereq POSIXPERM
 634        test_set_prereq BSLASHPSPEC
 635        test_set_prereq EXECKEEPSPID
 636        test_set_prereq NOT_MINGW
 637        ;;
 638esac
 639
 640( COLUMNS=1 && test $COLUMNS = 1 ) && test_set_prereq COLUMNS_CAN_BE_1
 641test -z "$NO_PERL" && test_set_prereq PERL
 642test -z "$NO_PYTHON" && test_set_prereq PYTHON
 643test -n "$USE_LIBPCRE" && test_set_prereq LIBPCRE
 644test -z "$NO_GETTEXT" && test_set_prereq GETTEXT
 645
 646# Can we rely on git's output in the C locale?
 647if test -n "$GETTEXT_POISON"
 648then
 649        GIT_GETTEXT_POISON=YesPlease
 650        export GIT_GETTEXT_POISON
 651        test_set_prereq GETTEXT_POISON
 652else
 653        test_set_prereq C_LOCALE_OUTPUT
 654fi
 655
 656# Use this instead of test_cmp to compare files that contain expected and
 657# actual output from git commands that can be translated.  When running
 658# under GETTEXT_POISON this pretends that the command produced expected
 659# results.
 660test_i18ncmp () {
 661        test -n "$GETTEXT_POISON" || test_cmp "$@"
 662}
 663
 664# Use this instead of "grep expected-string actual" to see if the
 665# output from a git command that can be translated either contains an
 666# expected string, or does not contain an unwanted one.  When running
 667# under GETTEXT_POISON this pretends that the command produced expected
 668# results.
 669test_i18ngrep () {
 670        if test -n "$GETTEXT_POISON"
 671        then
 672            : # pretend success
 673        elif test "x!" = "x$1"
 674        then
 675                shift
 676                ! grep "$@"
 677        else
 678                grep "$@"
 679        fi
 680}
 681
 682# test whether the filesystem supports symbolic links
 683ln -s x y 2>/dev/null && test -h y 2>/dev/null && test_set_prereq SYMLINKS
 684rm -f y
 685
 686# When the tests are run as root, permission tests will report that
 687# things are writable when they shouldn't be.
 688test -w / || test_set_prereq SANITY