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