t/test-lib.sh

   1 #!/bin/sh
   2 #
   3 # Copyright (c) 2005 Junio C Hamano
   4 # Copyright (c) 2006 Yann Dirson - tuning for stgit
   5 #
   6
   7 # Keep the original TERM for say_color
   8 ORIGINAL_TERM=$TERM
   9
  10 # For repeatability, reset the environment to known value.
  11 LANG=C
  12 LC_ALL=C
  13 PAGER=cat
  14 TZ=UTC
  15 TERM=dumb
  16 export LANG LC_ALL PAGER TERM TZ
  17 unset EDITOR
  18 unset VISUAL
  19 unset GIT_EDITOR
  20 unset AUTHOR_DATE
  21 unset AUTHOR_EMAIL
  22 unset AUTHOR_NAME
  23 unset COMMIT_AUTHOR_EMAIL
  24 unset COMMIT_AUTHOR_NAME
  25 unset EMAIL
  26 unset GIT_ALTERNATE_OBJECT_DIRECTORIES
  27 unset GIT_AUTHOR_DATE
  28 GIT_AUTHOR_EMAIL=author@example.com
  29 GIT_AUTHOR_NAME='A U Thor'
  30 unset GIT_COMMITTER_DATE
  31 GIT_COMMITTER_EMAIL=committer@example.com
  32 GIT_COMMITTER_NAME='C O Mitter'
  33 unset GIT_DIFF_OPTS
  34 unset GIT_DIR
  35 unset GIT_WORK_TREE
  36 unset GIT_EXTERNAL_DIFF
  37 unset GIT_INDEX_FILE
  38 unset GIT_OBJECT_DIRECTORY
  39 unset SHA1_FILE_DIRECTORIES
  40 unset SHA1_FILE_DIRECTORY
  41 GIT_MERGE_VERBOSITY=5
  42 export GIT_MERGE_VERBOSITY
  43 export GIT_AUTHOR_EMAIL GIT_AUTHOR_NAME
  44 export GIT_COMMITTER_EMAIL GIT_COMMITTER_NAME
  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                 export STGIT_DEBUG_LEVEL="-1"
  87                 verbose=t; shift ;;
  88         -q|--q|--qu|--qui|--quie|--quiet)
  89                 quiet=t; shift ;;
  90         --no-color)
  91                 color=; shift ;;
  92         *)
  93                 break ;;
  94         esac
  95 done
  96
  97 if test -n "$color"; then
  98         say_color () {
  99                 (
 100                 TERM=$ORIGINAL_TERM
 101                 export TERM
 102                 case "$1" in
 103                         error) tput bold; tput setaf 1;; # bold red
 104                         skip)  tput bold; tput setaf 2;; # bold green
 105                         pass)  tput setaf 2;;            # green
 106                         info)  tput setaf 3;;            # brown
 107                         *) test -n "$quiet" && return;;
 108                 esac
 109                 shift
 110                 echo "* $*"
 111                 tput sgr0
 112                 )
 113         }
 114 else
 115         say_color() {
 116                 test -z "$1" && test -n "$quiet" && return
 117                 shift
 118                 echo "* $*"
 119         }
 120 fi
 121
 122 error () {
 123         say_color error "error: $*"
 124         trap - exit
 125         exit 1
 126 }
 127
 128 say () {
 129         say_color info "$*"
 130 }
 131
 132 test "${test_description}" != "" ||
 133 error "Test script did not set test_description."
 134
 135 if test "$help" = "t"
 136 then
 137         echo "$test_description"
 138         exit 0
 139 fi
 140
 141 exec 5>&1
 142 if test "$verbose" = "t"
 143 then
 144         exec 4>&2 3>&1
 145 else
 146         exec 4>/dev/null 3>/dev/null
 147 fi
 148
 149 test_failure=0
 150 test_count=0
 151 test_fixed=0
 152 test_broken=0
 153
 154 die () {
 155         echo >&5 "FATAL: Unexpected exit with code $?"
 156         exit 1
 157 }
 158
 159 trap 'die' exit
 160
 161 test_tick () {
 162         if test -z "${test_tick+set}"
 163         then
 164                 test_tick=1112911993
 165         else
 166                 test_tick=$(($test_tick + 60))
 167         fi
 168         GIT_COMMITTER_DATE="$test_tick -0700"
 169         GIT_AUTHOR_DATE="$test_tick -0700"
 170         export GIT_COMMITTER_DATE GIT_AUTHOR_DATE
 171 }
 172
 173 # You are not expected to call test_ok_ and test_failure_ directly, use
 174 # the text_expect_* functions instead.
 175
 176 test_ok_ () {
 177         test_count=$(expr "$test_count" + 1)
 178         say_color "" "  ok $test_count: $@"
 179 }
 180
 181 test_failure_ () {
 182         test_count=$(expr "$test_count" + 1)
 183         test_failure=$(expr "$test_failure" + 1);
 184         say_color error "FAIL $test_count: $1"
 185         shift
 186         echo "$@" | sed -e 's/^/        /'
 187         test "$immediate" = "" || { trap - exit; exit 1; }
 188 }
 189
 190 test_known_broken_ok_ () {
 191         test_count=$(expr "$test_count" + 1)
 192         test_fixed=$(($test_fixed+1))
 193         say_color "" "  FIXED $test_count: $@"
 194 }
 195
 196 test_known_broken_failure_ () {
 197         test_count=$(expr "$test_count" + 1)
 198         test_broken=$(($test_broken+1))
 199         say_color skip "  still broken $test_count: $@"
 200 }
 201
 202 test_debug () {
 203         test "$debug" = "" || eval "$1"
 204 }
 205
 206 test_run_ () {
 207         eval >&3 2>&4 "$1"
 208         eval_ret="$?"
 209         return 0
 210 }
 211
 212 test_skip () {
 213         this_test=$(expr "./$0" : '.*/\(t[0-9]*\)-[^/]*$')
 214         this_test="$this_test.$(expr "$test_count" + 1)"
 215         to_skip=
 216         for skp in $GIT_SKIP_TESTS
 217         do
 218                 case "$this_test" in
 219                 $skp)
 220                         to_skip=t
 221                 esac
 222         done
 223         case "$to_skip" in
 224         t)
 225                 say_color skip >&3 "skipping test: $@"
 226                 test_count=$(expr "$test_count" + 1)
 227                 say_color skip "skip $test_count: $1"
 228                 : true
 229                 ;;
 230         *)
 231                 false
 232                 ;;
 233         esac
 234 }
 235
 236 test_expect_failure () {
 237         test "$#" = 2 ||
 238         error "bug in the test script: not 2 parameters to test-expect-failure"
 239         if ! test_skip "$@"
 240         then
 241                 say >&3 "checking known breakage: $2"
 242                 test_run_ "$2"
 243                 if [ "$?" = 0 -a "$eval_ret" = 0 ]
 244                 then
 245                         test_known_broken_ok_ "$1"
 246                 else
 247                     test_known_broken_failure_ "$1"
 248                 fi
 249         fi
 250         echo >&3 ""
 251 }
 252
 253 test_expect_success () {
 254         test "$#" = 2 ||
 255         error "bug in the test script: not 2 parameters to test-expect-success"
 256         if ! test_skip "$@"
 257         then
 258                 say >&3 "expecting success: $2"
 259                 test_run_ "$2"
 260                 if [ "$?" = 0 -a "$eval_ret" = 0 ]
 261                 then
 262                         test_ok_ "$1"
 263                 else
 264                         test_failure_ "$@"
 265                 fi
 266         fi
 267         echo >&3 ""
 268 }
 269
 270 test_expect_code () {
 271         test "$#" = 3 ||
 272         error "bug in the test script: not 3 parameters to test-expect-code"
 273         if ! test_skip "$@"
 274         then
 275                 say >&3 "expecting exit code $1: $3"
 276                 test_run_ "$3"
 277                 if [ "$?" = 0 -a "$eval_ret" = "$1" ]
 278                 then
 279                         test_ok_ "$2"
 280                 else
 281                         test_failure_ "$@"
 282                 fi
 283         fi
 284         echo >&3 ""
 285 }
 286
 287 # When running an StGit command that should exit with an error, use
 288 # these instead of testing for any non-zero exit code with !.
 289 exit_code () {
 290         expected=$1
 291         shift
 292         "$@"
 293         test $? -eq $expected
 294 }
 295 general_error () { exit_code 1 "$@" ; }
 296 command_error () { exit_code 2 "$@" ; }
 297 conflict () { exit_code 3 "$@" ; }
 298
 299 # Old-infrastructure commands don't exit with the proper value on
 300 # conflicts. But we don't want half the tests to fail because of that,
 301 # so use this instead of "conflict" for them.
 302 conflict_old () { command_error "$@" ; }
 303
 304 # Same thing, but for other commands that StGit where we just want to
 305 # make sure that they fail instead of crashing.
 306 must_fail () {
 307         "$@"
 308         test $? -gt 0 -a $? -le 129
 309 }
 310
 311 # test_cmp is a helper function to compare actual and expected output.
 312 # You can use it like:
 313 #
 314 #       test_expect_success 'foo works' '
 315 #               echo expected >expected &&
 316 #               foo >actual &&
 317 #               test_cmp expected actual
 318 #       '
 319 #
 320 # This could be written as either "cmp" or "diff -u", but:
 321 # - cmp's output is not nearly as easy to read as diff -u
 322 # - not all diff versions understand "-u"
 323
 324 test_cmp() {
 325         $GIT_TEST_CMP "$@"
 326 }
 327
 328 # Most tests can use the created repository, but some may need to create more.
 329 # Usage: test_create_repo <directory>
 330 test_create_repo () {
 331         test "$#" = 1 ||
 332         error "bug in the test script: not 1 parameter to test-create-repo"
 333         owd=$(pwd)
 334         repo="$1"
 335         mkdir "$repo"
 336         cd "$repo" || error "Cannot setup test environment"
 337         git init >/dev/null 2>&1 || error "cannot run git init"
 338         echo "empty start" | \
 339             git commit-tree $(git write-tree) >.git/refs/heads/master 2>&4 || \
 340             error "cannot run git commit"
 341         mv .git/hooks .git/hooks-disabled
 342         cd "$owd"
 343 }
 344
 345 test_done () {
 346         trap - exit
 347
 348         if test "$test_fixed" != 0
 349         then
 350                 say_color pass "fixed $test_fixed known breakage(s)"
 351         fi
 352         if test "$test_broken" != 0
 353         then
 354                 say_color error "still have $test_broken known breakage(s)"
 355                 msg="remaining $(($test_count-$test_broken)) test(s)"
 356         else
 357                 msg="$test_count test(s)"
 358         fi
 359         case "$test_failure" in
 360         0)
 361                 # We could:
 362                 # cd .. && rm -fr trash
 363                 # but that means we forbid any tests that use their own
 364                 # subdirectory from calling test_done without coming back
 365                 # to where they started from.
 366                 # The Makefile provided will clean this test area so
 367                 # we will leave things as they are.
 368
 369                 say_color pass "passed all $msg"
 370                 exit 0 ;;
 371
 372         *)
 373                 say_color error "failed $test_failure among $msg"
 374                 exit 1 ;;
 375
 376         esac
 377 }
 378
 379 # Test the binaries we have just built.  The tests are kept in
 380 # t/ subdirectory and are run in trash subdirectory.
 381 PATH=$(pwd)/..:$PATH
 382 HOME=$(pwd)/trash
 383 GIT_CONFIG=.git/config
 384 export PATH HOME GIT_CONFIG
 385
 386 # Test repository
 387 test=trash
 388 rm -fr "$test" || {
 389         trap - exit
 390         echo >&5 "FATAL: Cannot prepare test area"
 391         exit 1
 392 }
 393
 394 test_create_repo $test
 395 cd "$test"
 396
 397 this_test=$(expr "./$0" : '.*/\(t[0-9]*\)-[^/]*$')
 398 for skp in $GIT_SKIP_TESTS
 399 do
 400         to_skip=
 401         for skp in $GIT_SKIP_TESTS
 402         do
 403                 case "$this_test" in
 404                 $skp)
 405                         to_skip=t
 406                 esac
 407         done
 408         case "$to_skip" in
 409         t)
 410                 say_color skip >&3 "skipping test $this_test altogether"
 411                 say_color skip "skip all tests in $this_test"
 412                 test_done
 413         esac
 414 done