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