Documentation: explain optional arguments better
[git.git] / t / lib-httpd.sh
blobe9714467d05e57eded6f37c3d5f07b91f63cc9fc
1 # Shell library to run an HTTP server for use in tests.
2 # Ends the test early if httpd tests should not be run,
3 # for example because the user has not enabled them.
5 # Usage:
7 # . ./test-lib.sh
8 # . "$TEST_DIRECTORY"/lib-httpd.sh
9 # start_httpd
11 # test_expect_success '...' '
12 # ...
13 # '
15 # test_expect_success ...
17 # stop_httpd
18 # test_done
20 # Can be configured using the following variables.
22 # GIT_TEST_HTTPD enable HTTPD tests
23 # LIB_HTTPD_PATH web server path
24 # LIB_HTTPD_MODULE_PATH web server modules path
25 # LIB_HTTPD_PORT listening port
26 # LIB_HTTPD_DAV enable DAV
27 # LIB_HTTPD_SVN enable SVN
28 # LIB_HTTPD_SSL enable SSL
30 # Copyright (c) 2008 Clemens Buchacher <drizzd@aon.at>
33 if test -n "$NO_CURL"
34 then
35 skip_all='skipping test, git built without http support'
36 test_done
39 if test -n "$NO_EXPAT" && test -n "$LIB_HTTPD_DAV"
40 then
41 skip_all='skipping test, git built without expat support'
42 test_done
45 test_tristate GIT_TEST_HTTPD
46 if test "$GIT_TEST_HTTPD" = false
47 then
48 skip_all="Network testing disabled (unset GIT_TEST_HTTPD to enable)"
49 test_done
52 if ! test_have_prereq NOT_ROOT; then
53 test_skip_or_die $GIT_TEST_HTTPD \
54 "Cannot run httpd tests as root"
57 HTTPD_PARA=""
59 for DEFAULT_HTTPD_PATH in '/usr/sbin/httpd' '/usr/sbin/apache2'
61 if test -x "$DEFAULT_HTTPD_PATH"
62 then
63 break
65 done
67 for DEFAULT_HTTPD_MODULE_PATH in '/usr/libexec/apache2' \
68 '/usr/lib/apache2/modules' \
69 '/usr/lib64/httpd/modules' \
70 '/usr/lib/httpd/modules'
72 if test -d "$DEFAULT_HTTPD_MODULE_PATH"
73 then
74 break
76 done
78 case $(uname) in
79 Darwin)
80 HTTPD_PARA="$HTTPD_PARA -DDarwin"
82 esac
84 LIB_HTTPD_PATH=${LIB_HTTPD_PATH-"$DEFAULT_HTTPD_PATH"}
85 LIB_HTTPD_PORT=${LIB_HTTPD_PORT-${this_test#t}}
87 TEST_PATH="$TEST_DIRECTORY"/lib-httpd
88 HTTPD_ROOT_PATH="$PWD"/httpd
89 HTTPD_DOCUMENT_ROOT_PATH=$HTTPD_ROOT_PATH/www
91 # hack to suppress apache PassEnv warnings
92 GIT_VALGRIND=$GIT_VALGRIND; export GIT_VALGRIND
93 GIT_VALGRIND_OPTIONS=$GIT_VALGRIND_OPTIONS; export GIT_VALGRIND_OPTIONS
94 GIT_TRACE=$GIT_TRACE; export GIT_TRACE
96 if ! test -x "$LIB_HTTPD_PATH"
97 then
98 test_skip_or_die $GIT_TEST_HTTPD "no web server found at '$LIB_HTTPD_PATH'"
101 HTTPD_VERSION=`$LIB_HTTPD_PATH -v | \
102 sed -n 's/^Server version: Apache\/\([0-9]*\)\..*$/\1/p; q'`
104 if test -n "$HTTPD_VERSION"
105 then
106 if test -z "$LIB_HTTPD_MODULE_PATH"
107 then
108 if ! test $HTTPD_VERSION -ge 2
109 then
110 test_skip_or_die $GIT_TEST_HTTPD \
111 "at least Apache version 2 is required"
113 if ! test -d "$DEFAULT_HTTPD_MODULE_PATH"
114 then
115 test_skip_or_die $GIT_TEST_HTTPD \
116 "Apache module directory not found"
119 LIB_HTTPD_MODULE_PATH="$DEFAULT_HTTPD_MODULE_PATH"
121 else
122 test_skip_or_die $GIT_TEST_HTTPD \
123 "Could not identify web server at '$LIB_HTTPD_PATH'"
126 install_script () {
127 write_script "$HTTPD_ROOT_PATH/$1" <"$TEST_PATH/$1"
130 prepare_httpd() {
131 mkdir -p "$HTTPD_DOCUMENT_ROOT_PATH"
132 cp "$TEST_PATH"/passwd "$HTTPD_ROOT_PATH"
133 install_script broken-smart-http.sh
134 install_script error.sh
136 ln -s "$LIB_HTTPD_MODULE_PATH" "$HTTPD_ROOT_PATH/modules"
138 if test -n "$LIB_HTTPD_SSL"
139 then
140 HTTPD_PROTO=https
142 RANDFILE_PATH="$HTTPD_ROOT_PATH"/.rnd openssl req \
143 -config "$TEST_PATH/ssl.cnf" \
144 -new -x509 -nodes \
145 -out "$HTTPD_ROOT_PATH/httpd.pem" \
146 -keyout "$HTTPD_ROOT_PATH/httpd.pem"
147 GIT_SSL_NO_VERIFY=t
148 export GIT_SSL_NO_VERIFY
149 HTTPD_PARA="$HTTPD_PARA -DSSL"
150 else
151 HTTPD_PROTO=http
153 HTTPD_DEST=127.0.0.1:$LIB_HTTPD_PORT
154 HTTPD_URL=$HTTPD_PROTO://$HTTPD_DEST
155 HTTPD_URL_USER=$HTTPD_PROTO://user%40host@$HTTPD_DEST
156 HTTPD_URL_USER_PASS=$HTTPD_PROTO://user%40host:pass%40host@$HTTPD_DEST
158 if test -n "$LIB_HTTPD_DAV" || test -n "$LIB_HTTPD_SVN"
159 then
160 HTTPD_PARA="$HTTPD_PARA -DDAV"
162 if test -n "$LIB_HTTPD_SVN"
163 then
164 HTTPD_PARA="$HTTPD_PARA -DSVN"
165 rawsvnrepo="$HTTPD_ROOT_PATH/svnrepo"
166 svnrepo="http://127.0.0.1:$LIB_HTTPD_PORT/svn"
171 start_httpd() {
172 prepare_httpd >&3 2>&4
174 trap 'code=$?; stop_httpd; (exit $code); die' EXIT
176 "$LIB_HTTPD_PATH" -d "$HTTPD_ROOT_PATH" \
177 -f "$TEST_PATH/apache.conf" $HTTPD_PARA \
178 -c "Listen 127.0.0.1:$LIB_HTTPD_PORT" -k start \
179 >&3 2>&4
180 if test $? -ne 0
181 then
182 trap 'die' EXIT
183 test_skip_or_die $GIT_TEST_HTTPD "web server setup failed"
187 stop_httpd() {
188 trap 'die' EXIT
190 "$LIB_HTTPD_PATH" -d "$HTTPD_ROOT_PATH" \
191 -f "$TEST_PATH/apache.conf" $HTTPD_PARA -k stop
194 test_http_push_nonff () {
195 REMOTE_REPO=$1
196 LOCAL_REPO=$2
197 BRANCH=$3
198 EXPECT_CAS_RESULT=${4-failure}
200 test_expect_success 'non-fast-forward push fails' '
201 cd "$REMOTE_REPO" &&
202 HEAD=$(git rev-parse --verify HEAD) &&
204 cd "$LOCAL_REPO" &&
205 git checkout $BRANCH &&
206 echo "changed" > path2 &&
207 git commit -a -m path2 --amend &&
209 test_must_fail git push -v origin >output 2>&1 &&
210 (cd "$REMOTE_REPO" &&
211 test $HEAD = $(git rev-parse --verify HEAD))
214 test_expect_success 'non-fast-forward push show ref status' '
215 grep "^ ! \[rejected\][ ]*$BRANCH -> $BRANCH (non-fast-forward)$" output
218 test_expect_success 'non-fast-forward push shows help message' '
219 test_i18ngrep "Updates were rejected because" output
222 test_expect_${EXPECT_CAS_RESULT} 'force with lease aka cas' '
223 HEAD=$( cd "$REMOTE_REPO" && git rev-parse --verify HEAD ) &&
224 test_when_finished '\''
225 (cd "$REMOTE_REPO" && git update-ref HEAD "$HEAD")
226 '\'' &&
228 cd "$LOCAL_REPO" &&
229 git push -v --force-with-lease=$BRANCH:$HEAD origin
230 ) &&
231 git rev-parse --verify "$BRANCH" >expect &&
233 cd "$REMOTE_REPO" && git rev-parse --verify HEAD
234 ) >actual &&
235 test_cmp expect actual
239 setup_askpass_helper() {
240 test_expect_success 'setup askpass helper' '
241 write_script "$TRASH_DIRECTORY/askpass" <<-\EOF &&
242 echo >>"$TRASH_DIRECTORY/askpass-query" "askpass: $*" &&
243 case "$*" in
244 *Username*)
245 what=user
247 *Password*)
248 what=pass
250 esac &&
251 cat "$TRASH_DIRECTORY/askpass-$what"
253 GIT_ASKPASS="$TRASH_DIRECTORY/askpass" &&
254 export GIT_ASKPASS &&
255 export TRASH_DIRECTORY
259 set_askpass() {
260 >"$TRASH_DIRECTORY/askpass-query" &&
261 echo "$1" >"$TRASH_DIRECTORY/askpass-user" &&
262 echo "$2" >"$TRASH_DIRECTORY/askpass-pass"
265 expect_askpass() {
266 dest=$HTTPD_DEST${3+/$3}
269 case "$1" in
270 none)
272 pass)
273 echo "askpass: Password for 'http://$2@$dest': "
275 both)
276 echo "askpass: Username for 'http://$dest': "
277 echo "askpass: Password for 'http://$2@$dest': "
280 false
282 esac
283 } >"$TRASH_DIRECTORY/askpass-expect" &&
284 test_cmp "$TRASH_DIRECTORY/askpass-expect" \
285 "$TRASH_DIRECTORY/askpass-query"