t/test-lib.sh

   1 #!/bin/sh
   2 #
   3 # Copyright (c) 2005 Junio C Hamano
   4 #
   5
   6 # For repeatability, reset the environment to known value.
   7 LANG=C
   8 TZ=UTC
   9 export LANG TZ
  10 unset AUTHOR_DATE
  11 unset AUTHOR_EMAIL
  12 unset AUTHOR_NAME
  13 unset COMMIT_AUTHOR_EMAIL
  14 unset COMMIT_AUTHOR_NAME
  15 unset GIT_ALTERNATE_OBJECT_DIRECTORIES
  16 unset GIT_AUTHOR_DATE
  17 unset GIT_AUTHOR_EMAIL
  18 unset GIT_AUTHOR_NAME
  19 unset GIT_COMMITTER_EMAIL
  20 unset GIT_COMMITTER_NAME
  21 unset GIT_DIFF_OPTS
  22 unset GIT_DIR
  23 unset GIT_EXTERNAL_DIFF
  24 unset GIT_INDEX_FILE
  25 unset GIT_OBJECT_DIRECTORY
  26 unset SHA1_FILE_DIRECTORIES
  27 unset SHA1_FILE_DIRECTORY
  28
  29 # Each test should start with something like this, after copyright notices:
  30 #
  31 # test_description='Description of this test...
  32 # This test checks if command xyzzy does the right thing...
  33 # '
  34 # . ./test-lib.sh
  35
  36 error () {
  37         echo "* error: $*"
  38         exit 1
  39 }
  40
  41 say () {
  42         echo "* $*"
  43 }
  44
  45 test "${test_description}" != "" ||
  46 error "Test script did not set test_description."
  47
  48 while test "$#" -ne 0
  49 do
  50         case "$1" in
  51         -d|--d|--de|--deb|--debu|--debug)
  52                 debug=t; shift ;;
  53         -i|--i|--im|--imm|--imme|--immed|--immedi|--immedia|--immediat|--immediate)
  54                 immediate=t; shift ;;
  55         -h|--h|--he|--hel|--help)
  56                 echo "$test_description"
  57                 exit 0 ;;
  58         -v|--v|--ve|--ver|--verb|--verbo|--verbos|--verbose)
  59                 verbose=t; shift ;;
  60         *)
  61                 break ;;
  62         esac
  63 done
  64
  65 if test "$verbose" = "t"
  66 then
  67         exec 4>&2 3>&1
  68 else
  69         exec 4>/dev/null 3>/dev/null
  70 fi
  71
  72 test_failure=0
  73 test_count=0
  74
  75
  76 # You are not expected to call test_ok_ and test_failure_ directly, use
  77 # the text_expect_* functions instead.
  78
  79 test_ok_ () {
  80         test_count=$(expr "$test_count" + 1)
  81         say "  ok $test_count: $@"
  82 }
  83
  84 test_failure_ () {
  85         test_count=$(expr "$test_count" + 1)
  86         test_failure=$(expr "$test_failure" + 1);
  87         say "FAIL $test_count: $@"
  88         test "$immediate" == "" || exit 1
  89 }
  90
  91
  92 test_debug () {
  93         test "$debug" == "" || eval "$1"
  94 }
  95
  96 test_expect_failure () {
  97         test "$#" == 2 ||
  98         error "bug in the test script: not 2 parameters to test-expect-failure"
  99         say >&3 "expecting failure: $2"
 100         if eval >&3 2>&4 "$2"
 101         then
 102                 test_failure_ "$@"
 103         else
 104                 test_ok_ "$1"
 105         fi
 106 }
 107
 108 test_expect_success () {
 109         test "$#" == 2 ||
 110         error "bug in the test script: not 2 parameters to test-expect-success"
 111         say >&3 "expecting success: $2"
 112         if eval >&3 2>&4 "$2"
 113         then
 114                 test_ok_ "$1"
 115         else
 116                 test_failure_ "$@"
 117         fi
 118 }
 119
 120 test_done () {
 121         case "$test_failure" in
 122         0)
 123                 # We could:
 124                 # cd .. && rm -fr trash
 125                 # but that means we forbid any tests that use their own
 126                 # subdirectory from calling test_done without coming back
 127                 # to where they started from.
 128                 # The Makefile provided will clean this test area so
 129                 # we will leave things as they are.
 130
 131                 say "passed all $test_count test(s)"
 132                 exit 0 ;;
 133
 134         *)
 135                 say "failed $test_failure among $test_count test(s)"
 136                 exit 1 ;;
 137
 138         esac
 139 }
 140
 141 # Test the binaries we have just built.  The tests are kept in
 142 # t/ subdirectory and are run in trash subdirectory.
 143 PATH=$(pwd)/..:$PATH
 144
 145 # Test repository
 146 test=trash
 147 rm -fr "$test"
 148 mkdir "$test"
 149 cd "$test"
 150 git-init-db 2>/dev/null || error "cannot run git-init-db"