Add test-chmtime: a utility to change mtime on files
[git/git.git] / t / test-lib.sh
CommitLineData
e1970ce4
JH
1#!/bin/sh
2#
3# Copyright (c) 2005 Junio C Hamano
4#
5
6# For repeatability, reset the environment to known value.
7LANG=C
899460f3 8LC_ALL=C
d9bdd39e 9PAGER=cat
e1970ce4 10TZ=UTC
899460f3 11export LANG LC_ALL PAGER TZ
8ff99e74
EW
12EDITOR=:
13VISUAL=:
e1970ce4
JH
14unset AUTHOR_DATE
15unset AUTHOR_EMAIL
16unset AUTHOR_NAME
17unset COMMIT_AUTHOR_EMAIL
18unset COMMIT_AUTHOR_NAME
19unset GIT_ALTERNATE_OBJECT_DIRECTORIES
20unset GIT_AUTHOR_DATE
29e55cd5
JH
21GIT_AUTHOR_EMAIL=author@example.com
22GIT_AUTHOR_NAME='A U Thor'
6677c466 23unset GIT_COMMITTER_DATE
29e55cd5
JH
24GIT_COMMITTER_EMAIL=committer@example.com
25GIT_COMMITTER_NAME='C O Mitter'
e1970ce4
JH
26unset GIT_DIFF_OPTS
27unset GIT_DIR
28unset GIT_EXTERNAL_DIFF
29unset GIT_INDEX_FILE
30unset GIT_OBJECT_DIRECTORY
31unset SHA1_FILE_DIRECTORIES
32unset SHA1_FILE_DIRECTORY
8d0fc48f
SP
33GIT_MERGE_VERBOSITY=5
34export GIT_MERGE_VERBOSITY
29e55cd5
JH
35export GIT_AUTHOR_EMAIL GIT_AUTHOR_NAME
36export GIT_COMMITTER_EMAIL GIT_COMMITTER_NAME
8ff99e74 37export EDITOR VISUAL
e1970ce4 38
3d5c0cc9 39case $(echo $GIT_TRACE |tr "[A-Z]" "[a-z]") in
6ce4e61f
CC
40 1|2|true)
41 echo "* warning: Some tests will not work if GIT_TRACE" \
42 "is set as to trace on STDERR ! *"
43 echo "* warning: Please set GIT_TRACE to something" \
44 "other than 1, 2 or true ! *"
45 ;;
46esac
47
e1970ce4
JH
48# Each test should start with something like this, after copyright notices:
49#
50# test_description='Description of this test...
51# This test checks if command xyzzy does the right thing...
52# '
53# . ./test-lib.sh
54
55error () {
56 echo "* error: $*"
41184273 57 trap - exit
e1970ce4
JH
58 exit 1
59}
60
61say () {
62 echo "* $*"
63}
64
65test "${test_description}" != "" ||
66error "Test script did not set test_description."
67
68while test "$#" -ne 0
69do
70 case "$1" in
71 -d|--d|--de|--deb|--debu|--debug)
72 debug=t; shift ;;
886856ab
JH
73 -i|--i|--im|--imm|--imme|--immed|--immedi|--immedia|--immediat|--immediate)
74 immediate=t; shift ;;
e1970ce4
JH
75 -h|--h|--he|--hel|--help)
76 echo "$test_description"
77 exit 0 ;;
78 -v|--v|--ve|--ver|--verb|--verbo|--verbos|--verbose)
79 verbose=t; shift ;;
abb7c7b3 80 --no-python)
7cdbff14
JH
81 # noop now...
82 shift ;;
e1970ce4
JH
83 *)
84 break ;;
85 esac
86done
87
4d9d62fa 88exec 5>&1
e1970ce4
JH
89if test "$verbose" = "t"
90then
91 exec 4>&2 3>&1
92else
93 exec 4>/dev/null 3>/dev/null
94fi
95
96test_failure=0
97test_count=0
98
41184273
PR
99trap 'echo >&5 "FATAL: Unexpected exit with code $?"; exit 1' exit
100
04509738
JH
101test_tick () {
102 if test -z "${test_tick+set}"
103 then
21afc41c 104 test_tick=1112911993
04509738
JH
105 else
106 test_tick=$(($test_tick + 60))
107 fi
21afc41c
JH
108 GIT_COMMITTER_DATE="$test_tick -0700"
109 GIT_AUTHOR_DATE="$test_tick -0700"
04509738
JH
110 export GIT_COMMITTER_DATE GIT_AUTHOR_DATE
111}
e1970ce4 112
886856ab
JH
113# You are not expected to call test_ok_ and test_failure_ directly, use
114# the text_expect_* functions instead.
115
116test_ok_ () {
e1970ce4 117 test_count=$(expr "$test_count" + 1)
94e8afa2 118 say " ok $test_count: $@"
e1970ce4
JH
119}
120
886856ab 121test_failure_ () {
e1970ce4
JH
122 test_count=$(expr "$test_count" + 1)
123 test_failure=$(expr "$test_failure" + 1);
bf0dd8a8
JH
124 say "FAIL $test_count: $1"
125 shift
126 echo "$@" | sed -e 's/^/ /'
41184273 127 test "$immediate" = "" || { trap - exit; exit 1; }
886856ab
JH
128}
129
130
131test_debug () {
8e832ebc 132 test "$debug" = "" || eval "$1"
e1970ce4
JH
133}
134
4d9d62fa 135test_run_ () {
4d9d62fa
PR
136 eval >&3 2>&4 "$1"
137 eval_ret="$?"
4d9d62fa
PR
138 return 0
139}
140
04ece593
JH
141test_skip () {
142 this_test=$(expr "./$0" : '.*/\(t[0-9]*\)-[^/]*$')
143 this_test="$this_test.$(expr "$test_count" + 1)"
144 to_skip=
145 for skp in $GIT_SKIP_TESTS
146 do
147 case "$this_test" in
148 $skp)
149 to_skip=t
150 esac
151 done
152 case "$to_skip" in
153 t)
154 say >&3 "skipping test: $@"
155 test_count=$(expr "$test_count" + 1)
156 say "skip $test_count: $1"
157 : true
158 ;;
159 *)
160 false
161 ;;
162 esac
163}
164
e1970ce4 165test_expect_failure () {
8e832ebc 166 test "$#" = 2 ||
e1970ce4 167 error "bug in the test script: not 2 parameters to test-expect-failure"
04ece593 168 if ! test_skip "$@"
e1970ce4 169 then
04ece593
JH
170 say >&3 "expecting failure: $2"
171 test_run_ "$2"
172 if [ "$?" = 0 -a "$eval_ret" != 0 -a "$eval_ret" -lt 129 ]
173 then
174 test_ok_ "$1"
175 else
176 test_failure_ "$@"
177 fi
e1970ce4 178 fi
7a0cf2d0 179 echo >&3 ""
e1970ce4
JH
180}
181
182test_expect_success () {
8e832ebc 183 test "$#" = 2 ||
e1970ce4 184 error "bug in the test script: not 2 parameters to test-expect-success"
04ece593 185 if ! test_skip "$@"
e1970ce4 186 then
04ece593
JH
187 say >&3 "expecting success: $2"
188 test_run_ "$2"
189 if [ "$?" = 0 -a "$eval_ret" = 0 ]
190 then
191 test_ok_ "$1"
192 else
193 test_failure_ "$@"
194 fi
e1970ce4 195 fi
7a0cf2d0 196 echo >&3 ""
e1970ce4
JH
197}
198
d3bfdb75
FK
199test_expect_code () {
200 test "$#" = 3 ||
201 error "bug in the test script: not 3 parameters to test-expect-code"
04ece593 202 if ! test_skip "$@"
d3bfdb75 203 then
04ece593
JH
204 say >&3 "expecting exit code $1: $3"
205 test_run_ "$3"
206 if [ "$?" = 0 -a "$eval_ret" = "$1" ]
207 then
208 test_ok_ "$2"
209 else
210 test_failure_ "$@"
211 fi
d3bfdb75 212 fi
7a0cf2d0 213 echo >&3 ""
d3bfdb75
FK
214}
215
eedf8f97
CW
216# Most tests can use the created repository, but some amy need to create more.
217# Usage: test_create_repo <directory>
218test_create_repo () {
219 test "$#" = 1 ||
220 error "bug in the test script: not 1 parameter to test-create-repo"
221 owd=`pwd`
222 repo="$1"
223 mkdir "$repo"
224 cd "$repo" || error "Cannot setup test environment"
5c94f87e
NP
225 "$GIT_EXEC_PATH/git" init --template=$GIT_EXEC_PATH/templates/blt/ >/dev/null 2>&1 ||
226 error "cannot run git init -- have you built things yet?"
eedf8f97
CW
227 mv .git/hooks .git/hooks-disabled
228 cd "$owd"
229}
230
e1970ce4 231test_done () {
41184273 232 trap - exit
e1970ce4 233 case "$test_failure" in
10b94e28 234 0)
e1970ce4
JH
235 # We could:
236 # cd .. && rm -fr trash
237 # but that means we forbid any tests that use their own
238 # subdirectory from calling test_done without coming back
239 # to where they started from.
240 # The Makefile provided will clean this test area so
241 # we will leave things as they are.
242
243 say "passed all $test_count test(s)"
244 exit 0 ;;
245
246 *)
247 say "failed $test_failure among $test_count test(s)"
248 exit 1 ;;
249
250 esac
251}
252
253# Test the binaries we have just built. The tests are kept in
254# t/ subdirectory and are run in trash subdirectory.
255PATH=$(pwd)/..:$PATH
a0fa2a10 256GIT_EXEC_PATH=$(pwd)/..
8683a45d 257GIT_TEMPLATE_DIR=$(pwd)/../templates/blt
8565d2d8
JS
258GIT_CONFIG=.git/config
259export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG
49ccb087 260
6fcca938
PB
261GITPERLLIB=$(pwd)/../perl/blib/lib:$(pwd)/../perl/blib/arch/auto/Git
262export GITPERLLIB
eea42069
JH
263test -d ../templates/blt || {
264 error "You haven't built things yet, have you?"
265}
e1970ce4
JH
266
267# Test repository
268test=trash
269rm -fr "$test"
eedf8f97
CW
270test_create_repo $test
271cd "$test"
04ece593
JH
272
273this_test=$(expr "./$0" : '.*/\(t[0-9]*\)-[^/]*$')
274for skp in $GIT_SKIP_TESTS
275do
276 to_skip=
277 for skp in $GIT_SKIP_TESTS
278 do
279 case "$this_test" in
280 $skp)
281 to_skip=t
282 esac
283 done
284 case "$to_skip" in
285 t)
286 say >&3 "skipping test $this_test altogether"
287 say "skip all tests in $this_test"
288 test_done
289 esac
290done