Andrew's git - gitweb.git/blob

e6a7bb1b45e75b7f28a193364a705e51c7f9a154
   1#!/bin/sh
   2#
   3# Copyright (c) 2005 Junio C Hamano
   4#
   5
   6# if --tee was passed, write the output not only to the terminal, but
   7# additionally to the file test-results/$BASENAME.out, too.
   8case "$GIT_TEST_TEE_STARTED, $* " in
   9done,*)
  10        # do not redirect again
  11        ;;
  12*' --tee '*|*' --va'*)
  13        mkdir -p test-results
  14        BASE=test-results/$(basename "$0" .sh)
  15        (GIT_TEST_TEE_STARTED=done ${SHELL-sh} "$0" "$@" 2>&1;
  16         echo $? > $BASE.exit) | tee $BASE.out
  17        test "$(cat $BASE.exit)" = 0
  18        exit
  19        ;;
  20esac
  21
  22# Keep the original TERM for say_color
  23ORIGINAL_TERM=$TERM
  24
  25# For repeatability, reset the environment to known value.
  26LANG=C
  27LC_ALL=C
  28PAGER=cat
  29TZ=UTC
  30TERM=dumb
  31export LANG LC_ALL PAGER TERM TZ
  32EDITOR=:
  33VISUAL=:
  34unset GIT_EDITOR
  35unset AUTHOR_DATE
  36unset AUTHOR_EMAIL
  37unset AUTHOR_NAME
  38unset COMMIT_AUTHOR_EMAIL
  39unset COMMIT_AUTHOR_NAME
  40unset EMAIL
  41unset GIT_ALTERNATE_OBJECT_DIRECTORIES
  42unset GIT_AUTHOR_DATE
  43GIT_AUTHOR_EMAIL=author@example.com
  44GIT_AUTHOR_NAME='A U Thor'
  45unset GIT_COMMITTER_DATE
  46GIT_COMMITTER_EMAIL=committer@example.com
  47GIT_COMMITTER_NAME='C O Mitter'
  48unset GIT_DIFF_OPTS
  49unset GIT_DIR
  50unset GIT_WORK_TREE
  51unset GIT_EXTERNAL_DIFF
  52unset GIT_INDEX_FILE
  53unset GIT_OBJECT_DIRECTORY
  54unset GIT_CEILING_DIRECTORIES
  55unset SHA1_FILE_DIRECTORIES
  56unset SHA1_FILE_DIRECTORY
  57GIT_MERGE_VERBOSITY=5
  58export GIT_MERGE_VERBOSITY
  59export GIT_AUTHOR_EMAIL GIT_AUTHOR_NAME
  60export GIT_COMMITTER_EMAIL GIT_COMMITTER_NAME
  61export EDITOR VISUAL
  62GIT_TEST_CMP=${GIT_TEST_CMP:-diff -u}
  63
  64# Protect ourselves from common misconfiguration to export
  65# CDPATH into the environment
  66unset CDPATH
  67
  68case $(echo $GIT_TRACE |tr "[A-Z]" "[a-z]") in
  69        1|2|true)
  70                echo "* warning: Some tests will not work if GIT_TRACE" \
  71                        "is set as to trace on STDERR ! *"
  72                echo "* warning: Please set GIT_TRACE to something" \
  73                        "other than 1, 2 or true ! *"
  74                ;;
  75esac
  76
  77# Each test should start with something like this, after copyright notices:
  78#
  79# test_description='Description of this test...
  80# This test checks if command xyzzy does the right thing...
  81# '
  82# . ./test-lib.sh
  83[ "x$ORIGINAL_TERM" != "xdumb" ] && (
  84                TERM=$ORIGINAL_TERM &&
  85                export TERM &&
  86                [ -t 1 ] &&
  87                tput bold >/dev/null 2>&1 &&
  88                tput setaf 1 >/dev/null 2>&1 &&
  89                tput sgr0 >/dev/null 2>&1
  90        ) &&
  91        color=t
  92
  93while test "$#" -ne 0
  94do
  95        case "$1" in
  96        -d|--d|--de|--deb|--debu|--debug)
  97                debug=t; shift ;;
  98        -i|--i|--im|--imm|--imme|--immed|--immedi|--immedia|--immediat|--immediate)
  99                immediate=t; shift ;;
 100        -l|--l|--lo|--lon|--long|--long-|--long-t|--long-te|--long-tes|--long-test|--long-tests)
 101                GIT_TEST_LONG=t; export GIT_TEST_LONG; shift ;;
 102        -h|--h|--he|--hel|--help)
 103                help=t; shift ;;
 104        -v|--v|--ve|--ver|--verb|--verbo|--verbos|--verbose)
 105                verbose=t; shift ;;
 106        -q|--q|--qu|--qui|--quie|--quiet)
 107                quiet=t; shift ;;
 108        --no-color)
 109                color=; shift ;;
 110        --no-python)
 111                # noop now...
 112                shift ;;
 113        --va|--val|--valg|--valgr|--valgri|--valgrin|--valgrind)
 114                valgrind=t; verbose=t; shift ;;
 115        --tee)
 116                shift ;; # was handled already
 117        *)
 118                echo "error: unknown test option '$1'" >&2; exit 1 ;;
 119        esac
 120done
 121
 122if test -n "$color"; then
 123        say_color () {
 124                (
 125                TERM=$ORIGINAL_TERM
 126                export TERM
 127                case "$1" in
 128                        error) tput bold; tput setaf 1;; # bold red
 129                        skip)  tput bold; tput setaf 2;; # bold green
 130                        pass)  tput setaf 2;;            # green
 131                        info)  tput setaf 3;;            # brown
 132                        *) test -n "$quiet" && return;;
 133                esac
 134                shift
 135                printf "* %s" "$*"
 136                tput sgr0
 137                echo
 138                )
 139        }
 140else
 141        say_color() {
 142                test -z "$1" && test -n "$quiet" && return
 143                shift
 144                echo "* $*"
 145        }
 146fi
 147
 148error () {
 149        say_color error "error: $*"
 150        GIT_EXIT_OK=t
 151        exit 1
 152}
 153
 154say () {
 155        say_color info "$*"
 156}
 157
 158test "${test_description}" != "" ||
 159error "Test script did not set test_description."
 160
 161if test "$help" = "t"
 162then
 163        echo "$test_description"
 164        exit 0
 165fi
 166
 167exec 5>&1
 168if test "$verbose" = "t"
 169then
 170        exec 4>&2 3>&1
 171else
 172        exec 4>/dev/null 3>/dev/null
 173fi
 174
 175test_failure=0
 176test_count=0
 177test_fixed=0
 178test_broken=0
 179test_success=0
 180
 181die () {
 182        code=$?
 183        if test -n "$GIT_EXIT_OK"
 184        then
 185                exit $code
 186        else
 187                echo >&5 "FATAL: Unexpected exit with code $code"
 188                exit 1
 189        fi
 190}
 191
 192GIT_EXIT_OK=
 193trap 'die' EXIT
 194
 195# The semantics of the editor variables are that of invoking
 196# sh -c "$EDITOR \"$@\"" files ...
 197#
 198# If our trash directory contains shell metacharacters, they will be
 199# interpreted if we just set $EDITOR directly, so do a little dance with
 200# environment variables to work around this.
 201#
 202# In particular, quoting isn't enough, as the path may contain the same quote
 203# that we're using.
 204test_set_editor () {
 205        FAKE_EDITOR="$1"
 206        export FAKE_EDITOR
 207        VISUAL='"$FAKE_EDITOR"'
 208        export VISUAL
 209}
 210
 211test_tick () {
 212        if test -z "${test_tick+set}"
 213        then
 214                test_tick=1112911993
 215        else
 216                test_tick=$(($test_tick + 60))
 217        fi
 218        GIT_COMMITTER_DATE="$test_tick -0700"
 219        GIT_AUTHOR_DATE="$test_tick -0700"
 220        export GIT_COMMITTER_DATE GIT_AUTHOR_DATE
 221}
 222
 223# Call test_commit with the arguments "<message> [<file> [<contents>]]"
 224#
 225# This will commit a file with the given contents and the given commit
 226# message.  It will also add a tag with <message> as name.
 227#
 228# Both <file> and <contents> default to <message>.
 229
 230test_commit () {
 231        file=${2:-"$1.t"}
 232        echo "${3-$1}" > "$file" &&
 233        git add "$file" &&
 234        test_tick &&
 235        git commit -m "$1" &&
 236        git tag "$1"
 237}
 238
 239# Call test_merge with the arguments "<message> <commit>", where <commit>
 240# can be a tag pointing to the commit-to-merge.
 241
 242test_merge () {
 243        test_tick &&
 244        git merge -m "$1" "$2" &&
 245        git tag "$1"
 246}
 247
 248# This function helps systems where core.filemode=false is set.
 249# Use it instead of plain 'chmod +x' to set or unset the executable bit
 250# of a file in the working directory and add it to the index.
 251
 252test_chmod () {
 253        chmod "$@" &&
 254        git update-index --add "--chmod=$@"
 255}
 256
 257# Use test_set_prereq to tell that a particular prerequisite is available.
 258# The prerequisite can later be checked for in two ways:
 259#
 260# - Explicitly using test_have_prereq.
 261#
 262# - Implicitly by specifying the prerequisite tag in the calls to
 263#   test_expect_{success,failure,code}.
 264#
 265# The single parameter is the prerequisite tag (a simple word, in all
 266# capital letters by convention).
 267
 268test_set_prereq () {
 269        satisfied="$satisfied$1 "
 270}
 271satisfied=" "
 272
 273test_have_prereq () {
 274        case $satisfied in
 275        *" $1 "*)
 276                : yes, have it ;;
 277        *)
 278                ! : nope ;;
 279        esac
 280}
 281
 282# You are not expected to call test_ok_ and test_failure_ directly, use
 283# the text_expect_* functions instead.
 284
 285test_ok_ () {
 286        test_success=$(($test_success + 1))
 287        say_color "" "  ok $test_count: $@"
 288}
 289
 290test_failure_ () {
 291        test_failure=$(($test_failure + 1))
 292        say_color error "FAIL $test_count: $1"
 293        shift
 294        echo "$@" | sed -e 's/^/        /'
 295        test "$immediate" = "" || { GIT_EXIT_OK=t; exit 1; }
 296}
 297
 298test_known_broken_ok_ () {
 299        test_fixed=$(($test_fixed+1))
 300        say_color "" "  FIXED $test_count: $@"
 301}
 302
 303test_known_broken_failure_ () {
 304        test_broken=$(($test_broken+1))
 305        say_color skip "  still broken $test_count: $@"
 306}
 307
 308test_debug () {
 309        test "$debug" = "" || eval "$1"
 310}
 311
 312test_run_ () {
 313        eval >&3 2>&4 "$1"
 314        eval_ret="$?"
 315        return 0
 316}
 317
 318test_skip () {
 319        test_count=$(($test_count+1))
 320        to_skip=
 321        for skp in $GIT_SKIP_TESTS
 322        do
 323                case $this_test.$test_count in
 324                $skp)
 325                        to_skip=t
 326                esac
 327        done
 328        if test -z "$to_skip" && test -n "$prereq" &&
 329           ! test_have_prereq "$prereq"
 330        then
 331                to_skip=t
 332        fi
 333        case "$to_skip" in
 334        t)
 335                say_color skip >&3 "skipping test: $@"
 336                say_color skip "skip $test_count: $1"
 337                : true
 338                ;;
 339        *)
 340                false
 341                ;;
 342        esac
 343}
 344
 345test_expect_failure () {
 346        test "$#" = 3 && { prereq=$1; shift; } || prereq=
 347        test "$#" = 2 ||
 348        error "bug in the test script: not 2 or 3 parameters to test-expect-failure"
 349        if ! test_skip "$@"
 350        then
 351                say >&3 "checking known breakage: $2"
 352                test_run_ "$2"
 353                if [ "$?" = 0 -a "$eval_ret" = 0 ]
 354                then
 355                        test_known_broken_ok_ "$1"
 356                else
 357                        test_known_broken_failure_ "$1"
 358                fi
 359        fi
 360        echo >&3 ""
 361}
 362
 363test_expect_success () {
 364        test "$#" = 3 && { prereq=$1; shift; } || prereq=
 365        test "$#" = 2 ||
 366        error "bug in the test script: not 2 or 3 parameters to test-expect-success"
 367        if ! test_skip "$@"
 368        then
 369                say >&3 "expecting success: $2"
 370                test_run_ "$2"
 371                if [ "$?" = 0 -a "$eval_ret" = 0 ]
 372                then
 373                        test_ok_ "$1"
 374                else
 375                        test_failure_ "$@"
 376                fi
 377        fi
 378        echo >&3 ""
 379}
 380
 381test_expect_code () {
 382        test "$#" = 4 && { prereq=$1; shift; } || prereq=
 383        test "$#" = 3 ||
 384        error "bug in the test script: not 3 or 4 parameters to test-expect-code"
 385        if ! test_skip "$@"
 386        then
 387                say >&3 "expecting exit code $1: $3"
 388                test_run_ "$3"
 389                if [ "$?" = 0 -a "$eval_ret" = "$1" ]
 390                then
 391                        test_ok_ "$2"
 392                else
 393                        test_failure_ "$@"
 394                fi
 395        fi
 396        echo >&3 ""
 397}
 398
 399# test_external runs external test scripts that provide continuous
 400# test output about their progress, and succeeds/fails on
 401# zero/non-zero exit code.  It outputs the test output on stdout even
 402# in non-verbose mode, and announces the external script with "* run
 403# <n>: ..." before running it.  When providing relative paths, keep in
 404# mind that all scripts run in "trash directory".
 405# Usage: test_external description command arguments...
 406# Example: test_external 'Perl API' perl ../path/to/test.pl
 407test_external () {
 408        test "$#" = 4 && { prereq=$1; shift; } || prereq=
 409        test "$#" = 3 ||
 410        error >&5 "bug in the test script: not 3 or 4 parameters to test_external"
 411        descr="$1"
 412        shift
 413        if ! test_skip "$descr" "$@"
 414        then
 415                # Announce the script to reduce confusion about the
 416                # test output that follows.
 417                say_color "" " run $test_count: $descr ($*)"
 418                # Run command; redirect its stderr to &4 as in
 419                # test_run_, but keep its stdout on our stdout even in
 420                # non-verbose mode.
 421                "$@" 2>&4
 422                if [ "$?" = 0 ]
 423                then
 424                        test_ok_ "$descr"
 425                else
 426                        test_failure_ "$descr" "$@"
 427                fi
 428        fi
 429}
 430
 431# Like test_external, but in addition tests that the command generated
 432# no output on stderr.
 433test_external_without_stderr () {
 434        # The temporary file has no (and must have no) security
 435        # implications.
 436        tmp="$TMPDIR"; if [ -z "$tmp" ]; then tmp=/tmp; fi
 437        stderr="$tmp/git-external-stderr.$$.tmp"
 438        test_external "$@" 4> "$stderr"
 439        [ -f "$stderr" ] || error "Internal error: $stderr disappeared."
 440        descr="no stderr: $1"
 441        shift
 442        say >&3 "expecting no stderr from previous command"
 443        if [ ! -s "$stderr" ]; then
 444                rm "$stderr"
 445                test_ok_ "$descr"
 446        else
 447                if [ "$verbose" = t ]; then
 448                        output=`echo; echo Stderr is:; cat "$stderr"`
 449                else
 450                        output=
 451                fi
 452                # rm first in case test_failure exits.
 453                rm "$stderr"
 454                test_failure_ "$descr" "$@" "$output"
 455        fi
 456}
 457
 458# This is not among top-level (test_expect_success | test_expect_failure)
 459# but is a prefix that can be used in the test script, like:
 460#
 461#       test_expect_success 'complain and die' '
 462#           do something &&
 463#           do something else &&
 464#           test_must_fail git checkout ../outerspace
 465#       '
 466#
 467# Writing this as "! git checkout ../outerspace" is wrong, because
 468# the failure could be due to a segv.  We want a controlled failure.
 469
 470test_must_fail () {
 471        "$@"
 472        test $? -gt 0 -a $? -le 129 -o $? -gt 192
 473}
 474
 475# test_cmp is a helper function to compare actual and expected output.
 476# You can use it like:
 477#
 478#       test_expect_success 'foo works' '
 479#               echo expected >expected &&
 480#               foo >actual &&
 481#               test_cmp expected actual
 482#       '
 483#
 484# This could be written as either "cmp" or "diff -u", but:
 485# - cmp's output is not nearly as easy to read as diff -u
 486# - not all diff versions understand "-u"
 487
 488test_cmp() {
 489        $GIT_TEST_CMP "$@"
 490}
 491
 492# Most tests can use the created repository, but some may need to create more.
 493# Usage: test_create_repo <directory>
 494test_create_repo () {
 495        test "$#" = 1 ||
 496        error "bug in the test script: not 1 parameter to test-create-repo"
 497        owd=`pwd`
 498        repo="$1"
 499        mkdir -p "$repo"
 500        cd "$repo" || error "Cannot setup test environment"
 501        "$GIT_EXEC_PATH/git-init" "--template=$TEST_DIRECTORY/../templates/blt/" >&3 2>&4 ||
 502        error "cannot run git init -- have you built things yet?"
 503        mv .git/hooks .git/hooks-disabled
 504        cd "$owd"
 505}
 506
 507test_done () {
 508        GIT_EXIT_OK=t
 509        test_results_dir="$TEST_DIRECTORY/test-results"
 510        mkdir -p "$test_results_dir"
 511        test_results_path="$test_results_dir/${0%.sh}-$$"
 512
 513        echo "total $test_count" >> $test_results_path
 514        echo "success $test_success" >> $test_results_path
 515        echo "fixed $test_fixed" >> $test_results_path
 516        echo "broken $test_broken" >> $test_results_path
 517        echo "failed $test_failure" >> $test_results_path
 518        echo "" >> $test_results_path
 519
 520        if test "$test_fixed" != 0
 521        then
 522                say_color pass "fixed $test_fixed known breakage(s)"
 523        fi
 524        if test "$test_broken" != 0
 525        then
 526                say_color error "still have $test_broken known breakage(s)"
 527                msg="remaining $(($test_count-$test_broken)) test(s)"
 528        else
 529                msg="$test_count test(s)"
 530        fi
 531        case "$test_failure" in
 532        0)
 533                say_color pass "passed all $msg"
 534
 535                test -d "$remove_trash" &&
 536                cd "$(dirname "$remove_trash")" &&
 537                rm -rf "$(basename "$remove_trash")"
 538
 539                exit 0 ;;
 540
 541        *)
 542                say_color error "failed $test_failure among $msg"
 543                exit 1 ;;
 544
 545        esac
 546}
 547
 548# Test the binaries we have just built.  The tests are kept in
 549# t/ subdirectory and are run in 'trash directory' subdirectory.
 550TEST_DIRECTORY=$(pwd)
 551if test -z "$valgrind"
 552then
 553        if test -z "$GIT_TEST_INSTALLED"
 554        then
 555                PATH=$TEST_DIRECTORY/..:$PATH
 556                GIT_EXEC_PATH=$TEST_DIRECTORY/..
 557        else
 558                GIT_EXEC_PATH=$($GIT_TEST_INSTALLED/git --exec-path)  ||
 559                error "Cannot run git from $GIT_TEST_INSTALLED."
 560                PATH=$GIT_TEST_INSTALLED:$TEST_DIRECTORY/..:$PATH
 561                GIT_EXEC_PATH=${GIT_TEST_EXEC_PATH:-$GIT_EXEC_PATH}
 562        fi
 563else
 564        make_symlink () {
 565                test -h "$2" &&
 566                test "$1" = "$(readlink "$2")" || {
 567                        # be super paranoid
 568                        if mkdir "$2".lock
 569                        then
 570                                rm -f "$2" &&
 571                                ln -s "$1" "$2" &&
 572                                rm -r "$2".lock
 573                        else
 574                                while test -d "$2".lock
 575                                do
 576                                        say "Waiting for lock on $2."
 577                                        sleep 1
 578                                done
 579                        fi
 580                }
 581        }
 582
 583        make_valgrind_symlink () {
 584                # handle only executables
 585                test -x "$1" || return
 586
 587                base=$(basename "$1")
 588                symlink_target=$TEST_DIRECTORY/../$base
 589                # do not override scripts
 590                if test -x "$symlink_target" &&
 591                    test ! -d "$symlink_target" &&
 592                    test "#!" != "$(head -c 2 < "$symlink_target")"
 593                then
 594                        symlink_target=../valgrind.sh
 595                fi
 596                case "$base" in
 597                *.sh|*.perl)
 598                        symlink_target=../unprocessed-script
 599                esac
 600                # create the link, or replace it if it is out of date
 601                make_symlink "$symlink_target" "$GIT_VALGRIND/bin/$base" || exit
 602        }
 603
 604        # override all git executables in TEST_DIRECTORY/..
 605        GIT_VALGRIND=$TEST_DIRECTORY/valgrind
 606        mkdir -p "$GIT_VALGRIND"/bin
 607        for file in $TEST_DIRECTORY/../git* $TEST_DIRECTORY/../test-*
 608        do
 609                make_valgrind_symlink $file
 610        done
 611        OLDIFS=$IFS
 612        IFS=:
 613        for path in $PATH
 614        do
 615                ls "$path"/git-* 2> /dev/null |
 616                while read file
 617                do
 618                        make_valgrind_symlink "$file"
 619                done
 620        done
 621        IFS=$OLDIFS
 622        PATH=$GIT_VALGRIND/bin:$PATH
 623        GIT_EXEC_PATH=$GIT_VALGRIND/bin
 624        export GIT_VALGRIND
 625fi
 626GIT_TEMPLATE_DIR=$(pwd)/../templates/blt
 627unset GIT_CONFIG
 628GIT_CONFIG_NOSYSTEM=1
 629GIT_CONFIG_NOGLOBAL=1
 630export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG_NOSYSTEM GIT_CONFIG_NOGLOBAL
 631
 632GITPERLLIB=$(pwd)/../perl/blib/lib:$(pwd)/../perl/blib/arch/auto/Git
 633export GITPERLLIB
 634test -d ../templates/blt || {
 635        error "You haven't built things yet, have you?"
 636}
 637
 638if ! test -x ../test-chmtime; then
 639        echo >&2 'You need to build test-chmtime:'
 640        echo >&2 'Run "make test-chmtime" in the source (toplevel) directory'
 641        exit 1
 642fi
 643
 644. ../GIT-BUILD-OPTIONS
 645
 646# Test repository
 647test="trash directory.$(basename "$0" .sh)"
 648TRASH_DIRECTORY="$TEST_DIRECTORY/$test"
 649test ! -z "$debug" || remove_trash=$TRASH_DIRECTORY
 650rm -fr "$test" || {
 651        GIT_EXIT_OK=t
 652        echo >&5 "FATAL: Cannot prepare test area"
 653        exit 1
 654}
 655
 656test_create_repo "$test"
 657# Use -P to resolve symlinks in our working directory so that the cwd
 658# in subprocesses like git equals our $PWD (for pathname comparisons).
 659cd -P "$test" || exit 1
 660
 661this_test=${0##*/}
 662this_test=${this_test%%-*}
 663for skp in $GIT_SKIP_TESTS
 664do
 665        to_skip=
 666        for skp in $GIT_SKIP_TESTS
 667        do
 668                case "$this_test" in
 669                $skp)
 670                        to_skip=t
 671                esac
 672        done
 673        case "$to_skip" in
 674        t)
 675                say_color skip >&3 "skipping test $this_test altogether"
 676                say_color skip "skip all tests in $this_test"
 677                test_done
 678        esac
 679done
 680
 681# Fix some commands on Windows
 682case $(uname -s) in
 683*MINGW*)
 684        # Windows has its own (incompatible) sort and find
 685        sort () {
 686                /usr/bin/sort "$@"
 687        }
 688        find () {
 689                /usr/bin/find "$@"
 690        }
 691        sum () {
 692                md5sum "$@"
 693        }
 694        # git sees Windows-style pwd
 695        pwd () {
 696                builtin pwd -W
 697        }
 698        # no POSIX permissions
 699        # backslashes in pathspec are converted to '/'
 700        # exec does not inherit the PID
 701        ;;
 702*)
 703        test_set_prereq POSIXPERM
 704        test_set_prereq BSLASHPSPEC
 705        test_set_prereq EXECKEEPSPID
 706        ;;
 707esac
 708
 709test -z "$NO_PERL" && test_set_prereq PERL
 710
 711# test whether the filesystem supports symbolic links
 712ln -s x y 2>/dev/null && test -h y 2>/dev/null && test_set_prereq SYMLINKS
 713rm -f y