trace2: document the supported values of GIT_TRACE2* env variables
[git] / t / lib-httpd.sh
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.
4 #
5 # Usage:
6 #
7 #       . ./test-lib.sh
8 #       . "$TEST_DIRECTORY"/lib-httpd.sh
9 #       start_httpd
10 #
11 #       test_expect_success '...' '
12 #               ...
13 #       '
14 #
15 #       test_expect_success ...
16 #
17 #       test_done
18 #
19 # Can be configured using the following variables.
20 #
21 #    GIT_TEST_HTTPD              enable HTTPD tests
22 #    LIB_HTTPD_PATH              web server path
23 #    LIB_HTTPD_MODULE_PATH       web server modules path
24 #    LIB_HTTPD_PORT              listening port
25 #    LIB_HTTPD_DAV               enable DAV
26 #    LIB_HTTPD_SVN               enable SVN at given location (e.g. "svn")
27 #    LIB_HTTPD_SSL               enable SSL
28 #
29 # Copyright (c) 2008 Clemens Buchacher <drizzd@aon.at>
30 #
31
32 if test -n "$NO_CURL"
33 then
34         skip_all='skipping test, git built without http support'
35         test_done
36 fi
37
38 if test -n "$NO_EXPAT" && test -n "$LIB_HTTPD_DAV"
39 then
40         skip_all='skipping test, git built without expat support'
41         test_done
42 fi
43
44 test_tristate GIT_TEST_HTTPD
45 if test "$GIT_TEST_HTTPD" = false
46 then
47         skip_all="Network testing disabled (unset GIT_TEST_HTTPD to enable)"
48         test_done
49 fi
50
51 if ! test_have_prereq NOT_ROOT; then
52         test_skip_or_die $GIT_TEST_HTTPD \
53                 "Cannot run httpd tests as root"
54 fi
55
56 HTTPD_PARA=""
57
58 for DEFAULT_HTTPD_PATH in '/usr/sbin/httpd' '/usr/sbin/apache2'
59 do
60         if test -x "$DEFAULT_HTTPD_PATH"
61         then
62                 break
63         fi
64 done
65
66 for DEFAULT_HTTPD_MODULE_PATH in '/usr/libexec/apache2' \
67                                  '/usr/lib/apache2/modules' \
68                                  '/usr/lib64/httpd/modules' \
69                                  '/usr/lib/httpd/modules'
70 do
71         if test -d "$DEFAULT_HTTPD_MODULE_PATH"
72         then
73                 break
74         fi
75 done
76
77 case $(uname) in
78         Darwin)
79                 HTTPD_PARA="$HTTPD_PARA -DDarwin"
80         ;;
81 esac
82
83 LIB_HTTPD_PATH=${LIB_HTTPD_PATH-"$DEFAULT_HTTPD_PATH"}
84 test_set_port LIB_HTTPD_PORT
85
86 TEST_PATH="$TEST_DIRECTORY"/lib-httpd
87 HTTPD_ROOT_PATH="$PWD"/httpd
88 HTTPD_DOCUMENT_ROOT_PATH=$HTTPD_ROOT_PATH/www
89
90 # hack to suppress apache PassEnv warnings
91 GIT_VALGRIND=$GIT_VALGRIND; export GIT_VALGRIND
92 GIT_VALGRIND_OPTIONS=$GIT_VALGRIND_OPTIONS; export GIT_VALGRIND_OPTIONS
93 GIT_TEST_SIDEBAND_ALL=$GIT_TEST_SIDEBAND_ALL; export GIT_TEST_SIDEBAND_ALL
94 GIT_TRACE=$GIT_TRACE; export GIT_TRACE
95
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'"
99 fi
100
101 HTTPD_VERSION=$($LIB_HTTPD_PATH -v | \
102         sed -n 's/^Server version: Apache\/\([0-9]*\)\..*$/\1/p; q')
103
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"
112                 fi
113                 if ! test -d "$DEFAULT_HTTPD_MODULE_PATH"
114                 then
115                         test_skip_or_die $GIT_TEST_HTTPD \
116                                 "Apache module directory not found"
117                 fi
118
119                 LIB_HTTPD_MODULE_PATH="$DEFAULT_HTTPD_MODULE_PATH"
120         fi
121 else
122         test_skip_or_die $GIT_TEST_HTTPD \
123                 "Could not identify web server at '$LIB_HTTPD_PATH'"
124 fi
125
126 install_script () {
127         write_script "$HTTPD_ROOT_PATH/$1" <"$TEST_PATH/$1"
128 }
129
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-smart-http.sh
135         install_script error.sh
136         install_script apply-one-time-sed.sh
137
138         ln -s "$LIB_HTTPD_MODULE_PATH" "$HTTPD_ROOT_PATH/modules"
139
140         if test -n "$LIB_HTTPD_SSL"
141         then
142                 HTTPD_PROTO=https
143
144                 RANDFILE_PATH="$HTTPD_ROOT_PATH"/.rnd openssl req \
145                         -config "$TEST_PATH/ssl.cnf" \
146                         -new -x509 -nodes \
147                         -out "$HTTPD_ROOT_PATH/httpd.pem" \
148                         -keyout "$HTTPD_ROOT_PATH/httpd.pem"
149                 GIT_SSL_NO_VERIFY=t
150                 export GIT_SSL_NO_VERIFY
151                 HTTPD_PARA="$HTTPD_PARA -DSSL"
152         else
153                 HTTPD_PROTO=http
154         fi
155         HTTPD_DEST=127.0.0.1:$LIB_HTTPD_PORT
156         HTTPD_URL=$HTTPD_PROTO://$HTTPD_DEST
157         HTTPD_URL_USER=$HTTPD_PROTO://user%40host@$HTTPD_DEST
158         HTTPD_URL_USER_PASS=$HTTPD_PROTO://user%40host:pass%40host@$HTTPD_DEST
159
160         if test -n "$LIB_HTTPD_DAV" || test -n "$LIB_HTTPD_SVN"
161         then
162                 HTTPD_PARA="$HTTPD_PARA -DDAV"
163
164                 if test -n "$LIB_HTTPD_SVN"
165                 then
166                         HTTPD_PARA="$HTTPD_PARA -DSVN"
167                         LIB_HTTPD_SVNPATH="$rawsvnrepo"
168                         svnrepo="http://127.0.0.1:$LIB_HTTPD_PORT/"
169                         svnrepo="$svnrepo$LIB_HTTPD_SVN"
170                         export LIB_HTTPD_SVN LIB_HTTPD_SVNPATH
171                 fi
172         fi
173 }
174
175 start_httpd() {
176         prepare_httpd >&3 2>&4
177
178         test_atexit stop_httpd
179
180         "$LIB_HTTPD_PATH" -d "$HTTPD_ROOT_PATH" \
181                 -f "$TEST_PATH/apache.conf" $HTTPD_PARA \
182                 -c "Listen 127.0.0.1:$LIB_HTTPD_PORT" -k start \
183                 >&3 2>&4
184         if test $? -ne 0
185         then
186                 cat "$HTTPD_ROOT_PATH"/error.log >&4 2>/dev/null
187                 test_skip_or_die $GIT_TEST_HTTPD "web server setup failed"
188         fi
189 }
190
191 stop_httpd() {
192         "$LIB_HTTPD_PATH" -d "$HTTPD_ROOT_PATH" \
193                 -f "$TEST_PATH/apache.conf" $HTTPD_PARA -k stop
194 }
195
196 test_http_push_nonff () {
197         REMOTE_REPO=$1
198         LOCAL_REPO=$2
199         BRANCH=$3
200         EXPECT_CAS_RESULT=${4-failure}
201
202         test_expect_success 'non-fast-forward push fails' '
203                 cd "$REMOTE_REPO" &&
204                 HEAD=$(git rev-parse --verify HEAD) &&
205
206                 cd "$LOCAL_REPO" &&
207                 git checkout $BRANCH &&
208                 echo "changed" > path2 &&
209                 git commit -a -m path2 --amend &&
210
211                 test_must_fail git push -v origin >output 2>&1 &&
212                 (cd "$REMOTE_REPO" &&
213                  test $HEAD = $(git rev-parse --verify HEAD))
214         '
215
216         test_expect_success 'non-fast-forward push show ref status' '
217                 grep "^ ! \[rejected\][ ]*$BRANCH -> $BRANCH (non-fast-forward)$" output
218         '
219
220         test_expect_success 'non-fast-forward push shows help message' '
221                 test_i18ngrep "Updates were rejected because" output
222         '
223
224         test_expect_${EXPECT_CAS_RESULT} 'force with lease aka cas' '
225                 HEAD=$( cd "$REMOTE_REPO" && git rev-parse --verify HEAD ) &&
226                 test_when_finished '\''
227                         (cd "$REMOTE_REPO" && git update-ref HEAD "$HEAD")
228                 '\'' &&
229                 (
230                         cd "$LOCAL_REPO" &&
231                         git push -v --force-with-lease=$BRANCH:$HEAD origin
232                 ) &&
233                 git rev-parse --verify "$BRANCH" >expect &&
234                 (
235                         cd "$REMOTE_REPO" && git rev-parse --verify HEAD
236                 ) >actual &&
237                 test_cmp expect actual
238         '
239 }
240
241 setup_askpass_helper() {
242         test_expect_success 'setup askpass helper' '
243                 write_script "$TRASH_DIRECTORY/askpass" <<-\EOF &&
244                 echo >>"$TRASH_DIRECTORY/askpass-query" "askpass: $*" &&
245                 case "$*" in
246                 *Username*)
247                         what=user
248                         ;;
249                 *Password*)
250                         what=pass
251                         ;;
252                 esac &&
253                 cat "$TRASH_DIRECTORY/askpass-$what"
254                 EOF
255                 GIT_ASKPASS="$TRASH_DIRECTORY/askpass" &&
256                 export GIT_ASKPASS &&
257                 export TRASH_DIRECTORY
258         '
259 }
260
261 set_askpass() {
262         >"$TRASH_DIRECTORY/askpass-query" &&
263         echo "$1" >"$TRASH_DIRECTORY/askpass-user" &&
264         echo "$2" >"$TRASH_DIRECTORY/askpass-pass"
265 }
266
267 expect_askpass() {
268         dest=$HTTPD_DEST${3+/$3}
269
270         {
271                 case "$1" in
272                 none)
273                         ;;
274                 pass)
275                         echo "askpass: Password for 'http://$2@$dest': "
276                         ;;
277                 both)
278                         echo "askpass: Username for 'http://$dest': "
279                         echo "askpass: Password for 'http://$2@$dest': "
280                         ;;
281                 *)
282                         false
283                         ;;
284                 esac
285         } >"$TRASH_DIRECTORY/askpass-expect" &&
286         test_cmp "$TRASH_DIRECTORY/askpass-expect" \
287                  "$TRASH_DIRECTORY/askpass-query"
288 }
289
290 strip_access_log() {
291         sed -e "
292                 s/^.* \"//
293                 s/\"//
294                 s/ [1-9][0-9]*\$//
295                 s/^GET /GET  /
296         " "$HTTPD_ROOT_PATH"/access.log
297 }
298
299 # Requires one argument: the name of a file containing the expected stripped
300 # access log entries.
301 check_access_log() {
302         sort "$1" >"$1".sorted &&
303         strip_access_log >access.log.stripped &&
304         sort access.log.stripped >access.log.sorted &&
305         if ! test_cmp "$1".sorted access.log.sorted
306         then
307                 test_cmp "$1" access.log.stripped
308         fi
309 }