t/test-lib.sh

   1 #!/bin/sh
   2 #
   3 # Copyright (c) 2005 Junio C Hamano
   4 #
   5
   6 # Keep the original TERM for say_color
   7 ORIGINAL_TERM=$TERM
   8
   9 # For repeatability, reset the environment to known value.
  10 LANG=C
  11 LC_ALL=C
  12 PAGER=cat
  13 TZ=UTC
  14 TERM=dumb
  15 export LANG LC_ALL PAGER TERM TZ
  16 EDITOR=:
  17 VISUAL=:
  18 unset GIT_EDITOR
  19 unset AUTHOR_DATE
  20 unset AUTHOR_EMAIL
  21 unset AUTHOR_NAME
  22 unset COMMIT_AUTHOR_EMAIL
  23 unset COMMIT_AUTHOR_NAME
  24 unset EMAIL
  25 unset GIT_ALTERNATE_OBJECT_DIRECTORIES
  26 unset GIT_AUTHOR_DATE
  27 GIT_AUTHOR_EMAIL=author@example.com
  28 GIT_AUTHOR_NAME='A U Thor'
  29 unset GIT_COMMITTER_DATE
  30 GIT_COMMITTER_EMAIL=committer@example.com
  31 GIT_COMMITTER_NAME='C O Mitter'
  32 unset GIT_DIFF_OPTS
  33 unset GIT_DIR
  34 unset GIT_WORK_TREE
  35 unset GIT_EXTERNAL_DIFF
  36 unset GIT_INDEX_FILE
  37 unset GIT_OBJECT_DIRECTORY
  38 unset SHA1_FILE_DIRECTORIES
  39 unset SHA1_FILE_DIRECTORY
  40 GIT_MERGE_VERBOSITY=5
  41 export GIT_MERGE_VERBOSITY
  42 export GIT_AUTHOR_EMAIL GIT_AUTHOR_NAME
  43 export GIT_COMMITTER_EMAIL GIT_COMMITTER_NAME
  44 export EDITOR VISUAL
  45 GIT_TEST_CMP=${GIT_TEST_CMP:-diff -u}
  46
  47 # Protect ourselves from common misconfiguration to export
  48 # CDPATH into the environment
  49 unset CDPATH
  50
  51 case $(echo $GIT_TRACE |tr "[A-Z]" "[a-z]") in
  52         1|2|true)
  53                 echo "* warning: Some tests will not work if GIT_TRACE" \
  54                         "is set as to trace on STDERR ! *"
  55                 echo "* warning: Please set GIT_TRACE to something" \
  56                         "other than 1, 2 or true ! *"
  57                 ;;
  58 esac
  59
  60 # Each test should start with something like this, after copyright notices:
  61 #
  62 # test_description='Description of this test...
  63 # This test checks if command xyzzy does the right thing...
  64 # '
  65 # . ./test-lib.sh
  66 [ "x$ORIGINAL_TERM" != "xdumb" ] && (
  67                 TERM=$ORIGINAL_TERM &&
  68                 export TERM &&
  69                 [ -t 1 ] &&
  70                 tput bold >/dev/null 2>&1 &&
  71                 tput setaf 1 >/dev/null 2>&1 &&
  72                 tput sgr0 >/dev/null 2>&1
  73         ) &&
  74         color=t
  75
  76 while test "$#" -ne 0
  77 do
  78         case "$1" in
  79         -d|--d|--de|--deb|--debu|--debug)
  80                 debug=t; shift ;;
  81         -i|--i|--im|--imm|--imme|--immed|--immedi|--immedia|--immediat|--immediate)
  82                 immediate=t; shift ;;
  83         -h|--h|--he|--hel|--help)
  84                 help=t; shift ;;
  85         -v|--v|--ve|--ver|--verb|--verbo|--verbos|--verbose)
  86                 verbose=t; shift ;;
  87         -q|--q|--qu|--qui|--quie|--quiet)
  88                 quiet=t; shift ;;
  89         --no-color)
  90                 color=; shift ;;
  91         --no-python)
  92                 # noop now...
  93                 shift ;;
  94         *)
  95                 break ;;
  96         esac
  97 done
  98
  99 if test -n "$color"; then
 100         say_color () {
 101                 (
 102                 TERM=$ORIGINAL_TERM
 103                 export TERM
 104                 case "$1" in
 105                         error) tput bold; tput setaf 1;; # bold red
 106                         skip)  tput bold; tput setaf 2;; # bold green
 107                         pass)  tput setaf 2;;            # green
 108                         info)  tput setaf 3;;            # brown
 109                         *) test -n "$quiet" && return;;
 110                 esac
 111                 shift
 112                 echo "* $*"
 113                 tput sgr0
 114                 )
 115         }
 116 else
 117         say_color() {
 118                 test -z "$1" && test -n "$quiet" && return
 119                 shift
 120                 echo "* $*"
 121         }
 122 fi
 123
 124 error () {
 125         say_color error "error: $*"
 126         trap - exit
 127         exit 1
 128 }
 129
 130 say () {
 131         say_color info "$*"
 132 }
 133
 134 test "${test_description}" != "" ||
 135 error "Test script did not set test_description."
 136
 137 if test "$help" = "t"
 138 then
 139         echo "$test_description"
 140         exit 0
 141 fi
 142
 143 exec 5>&1
 144 if test "$verbose" = "t"
 145 then
 146         exec 4>&2 3>&1
 147 else
 148         exec 4>/dev/null 3>/dev/null
 149 fi
 150
 151 test_failure=0
 152 test_count=0
 153 test_fixed=0
 154 test_broken=0
 155 test_success=0
 156
 157 die () {
 158         echo >&5 "FATAL: Unexpected exit with code $?"
 159         exit 1
 160 }
 161
 162 trap 'die' exit
 163
 164 # The semantics of the editor variables are that of invoking
 165 # sh -c "$EDITOR \"$@\"" files ...
 166 #
 167 # If our trash directory contains shell metacharacters, they will be
 168 # interpreted if we just set $EDITOR directly, so do a little dance with
 169 # environment variables to work around this.
 170 #
 171 # In particular, quoting isn't enough, as the path may contain the same quote
 172 # that we're using.
 173 test_set_editor () {
 174         FAKE_EDITOR="$1"
 175         export FAKE_EDITOR
 176         VISUAL='"$FAKE_EDITOR"'
 177         export VISUAL
 178 }
 179
 180 test_tick () {
 181         if test -z "${test_tick+set}"
 182         then
 183                 test_tick=1112911993
 184         else
 185                 test_tick=$(($test_tick + 60))
 186         fi
 187         GIT_COMMITTER_DATE="$test_tick -0700"
 188         GIT_AUTHOR_DATE="$test_tick -0700"
 189         export GIT_COMMITTER_DATE GIT_AUTHOR_DATE
 190 }
 191
 192 # You are not expected to call test_ok_ and test_failure_ directly, use
 193 # the text_expect_* functions instead.
 194
 195 test_ok_ () {
 196         test_count=$(expr "$test_count" + 1)
 197         test_success=$(expr "$test_success" + 1)
 198         say_color "" "  ok $test_count: $@"
 199 }
 200
 201 test_failure_ () {
 202         test_count=$(expr "$test_count" + 1)
 203         test_failure=$(expr "$test_failure" + 1);
 204         say_color error "FAIL $test_count: $1"
 205         shift
 206         echo "$@" | sed -e 's/^/        /'
 207         test "$immediate" = "" || { trap - exit; exit 1; }
 208 }
 209
 210 test_known_broken_ok_ () {
 211         test_count=$(expr "$test_count" + 1)
 212         test_fixed=$(($test_fixed+1))
 213         say_color "" "  FIXED $test_count: $@"
 214 }
 215
 216 test_known_broken_failure_ () {
 217         test_count=$(expr "$test_count" + 1)
 218         test_broken=$(($test_broken+1))
 219         say_color skip "  still broken $test_count: $@"
 220 }
 221
 222 test_debug () {
 223         test "$debug" = "" || eval "$1"
 224 }
 225
 226 test_run_ () {
 227         eval >&3 2>&4 "$1"
 228         eval_ret="$?"
 229         return 0
 230 }
 231
 232 test_skip () {
 233         this_test=$(expr "./$0" : '.*/\(t[0-9]*\)-[^/]*$')
 234         this_test="$this_test.$(expr "$test_count" + 1)"
 235         to_skip=
 236         for skp in $GIT_SKIP_TESTS
 237         do
 238                 case "$this_test" in
 239                 $skp)
 240                         to_skip=t
 241                 esac
 242         done
 243         case "$to_skip" in
 244         t)
 245                 say_color skip >&3 "skipping test: $@"
 246                 test_count=$(expr "$test_count" + 1)
 247                 say_color skip "skip $test_count: $1"
 248                 : true
 249                 ;;
 250         *)
 251                 false
 252                 ;;
 253         esac
 254 }
 255
 256 test_expect_failure () {
 257         test "$#" = 2 ||
 258         error "bug in the test script: not 2 parameters to test-expect-failure"
 259         if ! test_skip "$@"
 260         then
 261                 say >&3 "checking known breakage: $2"
 262                 test_run_ "$2"
 263                 if [ "$?" = 0 -a "$eval_ret" = 0 ]
 264                 then
 265                         test_known_broken_ok_ "$1"
 266                 else
 267                     test_known_broken_failure_ "$1"
 268                 fi
 269         fi
 270         echo >&3 ""
 271 }
 272
 273 test_expect_success () {
 274         test "$#" = 2 ||
 275         error "bug in the test script: not 2 parameters to test-expect-success"
 276         if ! test_skip "$@"
 277         then
 278                 say >&3 "expecting success: $2"
 279                 test_run_ "$2"
 280                 if [ "$?" = 0 -a "$eval_ret" = 0 ]
 281                 then
 282                         test_ok_ "$1"
 283                 else
 284                         test_failure_ "$@"
 285                 fi
 286         fi
 287         echo >&3 ""
 288 }
 289
 290 test_expect_code () {
 291         test "$#" = 3 ||
 292         error "bug in the test script: not 3 parameters to test-expect-code"
 293         if ! test_skip "$@"
 294         then
 295                 say >&3 "expecting exit code $1: $3"
 296                 test_run_ "$3"
 297                 if [ "$?" = 0 -a "$eval_ret" = "$1" ]
 298                 then
 299                         test_ok_ "$2"
 300                 else
 301                         test_failure_ "$@"
 302                 fi
 303         fi
 304         echo >&3 ""
 305 }
 306
 307 # This is not among top-level (test_expect_success | test_expect_failure)
 308 # but is a prefix that can be used in the test script, like:
 309 #
 310 #       test_expect_success 'complain and die' '
 311 #           do something &&
 312 #           do something else &&
 313 #           test_must_fail git checkout ../outerspace
 314 #       '
 315 #
 316 # Writing this as "! git checkout ../outerspace" is wrong, because
 317 # the failure could be due to a segv.  We want a controlled failure.
 318
 319 test_must_fail () {
 320         "$@"
 321         test $? -gt 0 -a $? -le 129
 322 }
 323
 324 # test_cmp is a helper function to compare actual and expected output.
 325 # You can use it like:
 326 #
 327 #       test_expect_success 'foo works' '
 328 #               echo expected >expected &&
 329 #               foo >actual &&
 330 #               test_cmp expected actual
 331 #       '
 332 #
 333 # This could be written as either "cmp" or "diff -u", but:
 334 # - cmp's output is not nearly as easy to read as diff -u
 335 # - not all diff versions understand "-u"
 336
 337 test_cmp() {
 338         $GIT_TEST_CMP "$@"
 339 }
 340
 341 # Most tests can use the created repository, but some may need to create more.
 342 # Usage: test_create_repo <directory>
 343 test_create_repo () {
 344         test "$#" = 1 ||
 345         error "bug in the test script: not 1 parameter to test-create-repo"
 346         owd=`pwd`
 347         repo="$1"
 348         mkdir "$repo"
 349         cd "$repo" || error "Cannot setup test environment"
 350         "$GIT_EXEC_PATH/git" init "--template=$GIT_EXEC_PATH/templates/blt/" >/dev/null 2>&1 ||
 351         error "cannot run git init -- have you built things yet?"
 352         mv .git/hooks .git/hooks-disabled
 353         cd "$owd"
 354 }
 355
 356 test_done () {
 357         trap - exit
 358         test_results_dir="$TEST_DIRECTORY/test-results"
 359         mkdir -p "$test_results_dir"
 360         test_results_path="$test_results_dir/${0%-*}-$$"
 361
 362         echo "total $test_count" >> $test_results_path
 363         echo "success $test_success" >> $test_results_path
 364         echo "fixed $test_fixed" >> $test_results_path
 365         echo "broken $test_broken" >> $test_results_path
 366         echo "failed $test_failure" >> $test_results_path
 367         echo "" >> $test_results_path
 368
 369         if test "$test_fixed" != 0
 370         then
 371                 say_color pass "fixed $test_fixed known breakage(s)"
 372         fi
 373         if test "$test_broken" != 0
 374         then
 375                 say_color error "still have $test_broken known breakage(s)"
 376                 msg="remaining $(($test_count-$test_broken)) test(s)"
 377         else
 378                 msg="$test_count test(s)"
 379         fi
 380         case "$test_failure" in
 381         0)
 382                 # We could:
 383                 # cd .. && rm -fr 'trash directory'
 384                 # but that means we forbid any tests that use their own
 385                 # subdirectory from calling test_done without coming back
 386                 # to where they started from.
 387                 # The Makefile provided will clean this test area so
 388                 # we will leave things as they are.
 389
 390                 say_color pass "passed all $msg"
 391                 exit 0 ;;
 392
 393         *)
 394                 say_color error "failed $test_failure among $msg"
 395                 exit 1 ;;
 396
 397         esac
 398 }
 399
 400 # Test the binaries we have just built.  The tests are kept in
 401 # t/ subdirectory and are run in trash subdirectory.
 402 TEST_DIRECTORY=$(pwd)
 403 PATH=$TEST_DIRECTORY/..:$PATH
 404 GIT_EXEC_PATH=$(pwd)/..
 405 GIT_TEMPLATE_DIR=$(pwd)/../templates/blt
 406 unset GIT_CONFIG
 407 unset GIT_CONFIG_LOCAL
 408 GIT_CONFIG_NOSYSTEM=1
 409 GIT_CONFIG_NOGLOBAL=1
 410 export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG_NOSYSTEM GIT_CONFIG_NOGLOBAL
 411
 412 GITPERLLIB=$(pwd)/../perl/blib/lib:$(pwd)/../perl/blib/arch/auto/Git
 413 export GITPERLLIB
 414 test -d ../templates/blt || {
 415         error "You haven't built things yet, have you?"
 416 }
 417
 418 if ! test -x ../test-chmtime; then
 419         echo >&2 'You need to build test-chmtime:'
 420         echo >&2 'Run "make test-chmtime" in the source (toplevel) directory'
 421         exit 1
 422 fi
 423
 424 . ../GIT-BUILD-OPTIONS
 425
 426 # Test repository
 427 test="trash directory"
 428 rm -fr "$test" || {
 429         trap - exit
 430         echo >&5 "FATAL: Cannot prepare test area"
 431         exit 1
 432 }
 433
 434 test_create_repo "$test"
 435 # Use -P to resolve symlinks in our working directory so that the cwd
 436 # in subprocesses like git equals our $PWD (for pathname comparisons).
 437 cd -P "$test" || exit 1
 438
 439 this_test=$(expr "./$0" : '.*/\(t[0-9]*\)-[^/]*$')
 440 for skp in $GIT_SKIP_TESTS
 441 do
 442         to_skip=
 443         for skp in $GIT_SKIP_TESTS
 444         do
 445                 case "$this_test" in
 446                 $skp)
 447                         to_skip=t
 448                 esac
 449         done
 450         case "$to_skip" in
 451         t)
 452                 say_color skip >&3 "skipping test $this_test altogether"
 453                 say_color skip "skip all tests in $this_test"
 454                 test_done
 455         esac
 456 done