glossary: define the term shallow clone
[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 #       stop_httpd
18 #       test_done
19 #
20 # Can be configured using the following variables.
21 #
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
29 #
30 # Copyright (c) 2008 Clemens Buchacher <drizzd@aon.at>
31 #
32
33 test_tristate GIT_TEST_HTTPD
34 if test "$GIT_TEST_HTTPD" = false
35 then
36         skip_all="Network testing disabled (unset GIT_TEST_HTTPD to enable)"
37         test_done
38 fi
39
40 HTTPD_PARA=""
41
42 for DEFAULT_HTTPD_PATH in '/usr/sbin/httpd' '/usr/sbin/apache2'
43 do
44         if test -x "$DEFAULT_HTTPD_PATH"
45         then
46                 break
47         fi
48 done
49
50 for DEFAULT_HTTPD_MODULE_PATH in '/usr/libexec/apache2' \
51                                  '/usr/lib/apache2/modules' \
52                                  '/usr/lib64/httpd/modules' \
53                                  '/usr/lib/httpd/modules'
54 do
55         if test -d "$DEFAULT_HTTPD_MODULE_PATH"
56         then
57                 break
58         fi
59 done
60
61 case $(uname) in
62         Darwin)
63                 HTTPD_PARA="$HTTPD_PARA -DDarwin"
64         ;;
65 esac
66
67 LIB_HTTPD_PATH=${LIB_HTTPD_PATH-"$DEFAULT_HTTPD_PATH"}
68 LIB_HTTPD_PORT=${LIB_HTTPD_PORT-${this_test#t}}
69
70 TEST_PATH="$TEST_DIRECTORY"/lib-httpd
71 HTTPD_ROOT_PATH="$PWD"/httpd
72 HTTPD_DOCUMENT_ROOT_PATH=$HTTPD_ROOT_PATH/www
73
74 # hack to suppress apache PassEnv warnings
75 GIT_VALGRIND=$GIT_VALGRIND; export GIT_VALGRIND
76 GIT_VALGRIND_OPTIONS=$GIT_VALGRIND_OPTIONS; export GIT_VALGRIND_OPTIONS
77
78 if ! test -x "$LIB_HTTPD_PATH"
79 then
80         test_skip_or_die $GIT_TEST_HTTPD "no web server found at '$LIB_HTTPD_PATH'"
81 fi
82
83 HTTPD_VERSION=`$LIB_HTTPD_PATH -v | \
84         sed -n 's/^Server version: Apache\/\([0-9]*\)\..*$/\1/p; q'`
85
86 if test -n "$HTTPD_VERSION"
87 then
88         if test -z "$LIB_HTTPD_MODULE_PATH"
89         then
90                 if ! test $HTTPD_VERSION -ge 2
91                 then
92                         test_skip_or_die $GIT_TEST_HTTPD \
93                                 "at least Apache version 2 is required"
94                 fi
95                 if ! test -d "$DEFAULT_HTTPD_MODULE_PATH"
96                 then
97                         test_skip_or_die $GIT_TEST_HTTPD \
98                                 "Apache module directory not found"
99                 fi
100
101                 LIB_HTTPD_MODULE_PATH="$DEFAULT_HTTPD_MODULE_PATH"
102         fi
103 else
104         test_skip_or_die $GIT_TEST_HTTPD \
105                 "Could not identify web server at '$LIB_HTTPD_PATH'"
106 fi
107
108 prepare_httpd() {
109         mkdir -p "$HTTPD_DOCUMENT_ROOT_PATH"
110         cp "$TEST_PATH"/passwd "$HTTPD_ROOT_PATH"
111         cp "$TEST_PATH"/broken-smart-http.sh "$HTTPD_ROOT_PATH"
112
113         ln -s "$LIB_HTTPD_MODULE_PATH" "$HTTPD_ROOT_PATH/modules"
114
115         if test -n "$LIB_HTTPD_SSL"
116         then
117                 HTTPD_PROTO=https
118
119                 RANDFILE_PATH="$HTTPD_ROOT_PATH"/.rnd openssl req \
120                         -config "$TEST_PATH/ssl.cnf" \
121                         -new -x509 -nodes \
122                         -out "$HTTPD_ROOT_PATH/httpd.pem" \
123                         -keyout "$HTTPD_ROOT_PATH/httpd.pem"
124                 GIT_SSL_NO_VERIFY=t
125                 export GIT_SSL_NO_VERIFY
126                 HTTPD_PARA="$HTTPD_PARA -DSSL"
127         else
128                 HTTPD_PROTO=http
129         fi
130         HTTPD_DEST=127.0.0.1:$LIB_HTTPD_PORT
131         HTTPD_URL=$HTTPD_PROTO://$HTTPD_DEST
132         HTTPD_URL_USER=$HTTPD_PROTO://user%40host@$HTTPD_DEST
133         HTTPD_URL_USER_PASS=$HTTPD_PROTO://user%40host:pass%40host@$HTTPD_DEST
134
135         if test -n "$LIB_HTTPD_DAV" -o -n "$LIB_HTTPD_SVN"
136         then
137                 HTTPD_PARA="$HTTPD_PARA -DDAV"
138
139                 if test -n "$LIB_HTTPD_SVN"
140                 then
141                         HTTPD_PARA="$HTTPD_PARA -DSVN"
142                         rawsvnrepo="$HTTPD_ROOT_PATH/svnrepo"
143                         svnrepo="http://127.0.0.1:$LIB_HTTPD_PORT/svn"
144                 fi
145         fi
146 }
147
148 start_httpd() {
149         prepare_httpd >&3 2>&4
150
151         trap 'code=$?; stop_httpd; (exit $code); die' EXIT
152
153         "$LIB_HTTPD_PATH" -d "$HTTPD_ROOT_PATH" \
154                 -f "$TEST_PATH/apache.conf" $HTTPD_PARA \
155                 -c "Listen 127.0.0.1:$LIB_HTTPD_PORT" -k start \
156                 >&3 2>&4
157         if test $? -ne 0
158         then
159                 trap 'die' EXIT
160                 test_skip_or_die $GIT_TEST_HTTPD "web server setup failed"
161         fi
162 }
163
164 stop_httpd() {
165         trap 'die' EXIT
166
167         "$LIB_HTTPD_PATH" -d "$HTTPD_ROOT_PATH" \
168                 -f "$TEST_PATH/apache.conf" $HTTPD_PARA -k stop
169 }
170
171 test_http_push_nonff () {
172         REMOTE_REPO=$1
173         LOCAL_REPO=$2
174         BRANCH=$3
175         EXPECT_CAS_RESULT=${4-failure}
176
177         test_expect_success 'non-fast-forward push fails' '
178                 cd "$REMOTE_REPO" &&
179                 HEAD=$(git rev-parse --verify HEAD) &&
180
181                 cd "$LOCAL_REPO" &&
182                 git checkout $BRANCH &&
183                 echo "changed" > path2 &&
184                 git commit -a -m path2 --amend &&
185
186                 test_must_fail git push -v origin >output 2>&1 &&
187                 (cd "$REMOTE_REPO" &&
188                  test $HEAD = $(git rev-parse --verify HEAD))
189         '
190
191         test_expect_success 'non-fast-forward push show ref status' '
192                 grep "^ ! \[rejected\][ ]*$BRANCH -> $BRANCH (non-fast-forward)$" output
193         '
194
195         test_expect_success 'non-fast-forward push shows help message' '
196                 test_i18ngrep "Updates were rejected because" output
197         '
198
199         test_expect_${EXPECT_CAS_RESULT} 'force with lease aka cas' '
200                 HEAD=$( cd "$REMOTE_REPO" && git rev-parse --verify HEAD ) &&
201                 test_when_finished '\''
202                         (cd "$REMOTE_REPO" && git update-ref HEAD "$HEAD")
203                 '\'' &&
204                 (
205                         cd "$LOCAL_REPO" &&
206                         git push -v --force-with-lease=$BRANCH:$HEAD origin
207                 ) &&
208                 git rev-parse --verify "$BRANCH" >expect &&
209                 (
210                         cd "$REMOTE_REPO" && git rev-parse --verify HEAD
211                 ) >actual &&
212                 test_cmp expect actual
213         '
214 }
215
216 setup_askpass_helper() {
217         test_expect_success 'setup askpass helper' '
218                 write_script "$TRASH_DIRECTORY/askpass" <<-\EOF &&
219                 echo >>"$TRASH_DIRECTORY/askpass-query" "askpass: $*" &&
220                 case "$*" in
221                 *Username*)
222                         what=user
223                         ;;
224                 *Password*)
225                         what=pass
226                         ;;
227                 esac &&
228                 cat "$TRASH_DIRECTORY/askpass-$what"
229                 EOF
230                 GIT_ASKPASS="$TRASH_DIRECTORY/askpass" &&
231                 export GIT_ASKPASS &&
232                 export TRASH_DIRECTORY
233         '
234 }
235
236 set_askpass() {
237         >"$TRASH_DIRECTORY/askpass-query" &&
238         echo "$1" >"$TRASH_DIRECTORY/askpass-user" &&
239         echo "$2" >"$TRASH_DIRECTORY/askpass-pass"
240 }
241
242 expect_askpass() {
243         dest=$HTTPD_DEST${3+/$3}
244
245         {
246                 case "$1" in
247                 none)
248                         ;;
249                 pass)
250                         echo "askpass: Password for 'http://$2@$dest': "
251                         ;;
252                 both)
253                         echo "askpass: Username for 'http://$dest': "
254                         echo "askpass: Password for 'http://$2@$dest': "
255                         ;;
256                 *)
257                         false
258                         ;;
259                 esac
260         } >"$TRASH_DIRECTORY/askpass-expect" &&
261         test_cmp "$TRASH_DIRECTORY/askpass-expect" \
262                  "$TRASH_DIRECTORY/askpass-query"
263 }