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         install_script nph-custom-auth.sh
 146
 147         ln -s "$LIB_HTTPD_MODULE_PATH" "$HTTPD_ROOT_PATH/modules"
 148
 149         if test -n "$LIB_HTTPD_SSL"
 150         then
 151                 HTTPD_PROTO=https
 152
 153                 RANDFILE_PATH="$HTTPD_ROOT_PATH"/.rnd openssl req \
 154                         -config "$TEST_PATH/ssl.cnf" \
 155                         -new -x509 -nodes \
 156                         -out "$HTTPD_ROOT_PATH/httpd.pem" \
 157                         -keyout "$HTTPD_ROOT_PATH/httpd.pem"
 158                 GIT_SSL_NO_VERIFY=t
 159                 export GIT_SSL_NO_VERIFY
 160                 HTTPD_PARA="$HTTPD_PARA -DSSL"
 161         else
 162                 HTTPD_PROTO=http
 163         fi
 164         HTTPD_DEST=127.0.0.1:$LIB_HTTPD_PORT
 165         HTTPD_URL=$HTTPD_PROTO://$HTTPD_DEST
 166         HTTPD_URL_USER=$HTTPD_PROTO://user%40host@$HTTPD_DEST
 167         HTTPD_URL_USER_PASS=$HTTPD_PROTO://user%40host:pass%40host@$HTTPD_DEST
 168
 169         if test -n "$LIB_HTTPD_DAV" || test -n "$LIB_HTTPD_SVN"
 170         then
 171                 HTTPD_PARA="$HTTPD_PARA -DDAV"
 172
 173                 if test -n "$LIB_HTTPD_SVN"
 174                 then
 175                         HTTPD_PARA="$HTTPD_PARA -DSVN"
 176                         LIB_HTTPD_SVNPATH="$rawsvnrepo"
 177                         svnrepo="http://127.0.0.1:$LIB_HTTPD_PORT/"
 178                         svnrepo="$svnrepo$LIB_HTTPD_SVN"
 179                         export LIB_HTTPD_SVN LIB_HTTPD_SVNPATH
 180                 fi
 181         fi
 182
 183         if test -n "$LIB_HTTPD_PROXY"
 184         then
 185                 HTTPD_PARA="$HTTPD_PARA -DPROXY"
 186         fi
 187 }
 188
 189 enable_http2 () {
 190         HTTPD_PARA="$HTTPD_PARA -DHTTP2"
 191         test_set_prereq HTTP2
 192 }
 193
 194 enable_cgipassauth () {
 195         # We are looking for 2.4.13 or more recent. Since we only support
 196         # 2.4 and up, no need to check for older major/minor.
 197         if test "$HTTPD_VERSION_MAJOR" = 2 &&
 198            test "$HTTPD_VERSION_MINOR" = 4 &&
 199            test "$(echo $HTTPD_VERSION | cut -d. -f3)" -lt 13
 200         then
 201                 echo >&4 "apache $HTTPD_VERSION too old for CGIPassAuth"
 202                 return
 203         fi
 204         HTTPD_PARA="$HTTPD_PARA -DUSE_CGIPASSAUTH"
 205         test_set_prereq CGIPASSAUTH
 206 }
 207
 208 start_httpd() {
 209         prepare_httpd >&3 2>&4
 210
 211         test_atexit stop_httpd
 212
 213         "$LIB_HTTPD_PATH" -d "$HTTPD_ROOT_PATH" \
 214                 -f "$TEST_PATH/apache.conf" $HTTPD_PARA \
 215                 -c "Listen 127.0.0.1:$LIB_HTTPD_PORT" -k start \
 216                 >&3 2>&4
 217         if test $? -ne 0
 218         then
 219                 cat "$HTTPD_ROOT_PATH"/error.log >&4 2>/dev/null
 220                 test_skip_or_die GIT_TEST_HTTPD "web server setup failed"
 221         fi
 222 }
 223
 224 stop_httpd() {
 225         "$LIB_HTTPD_PATH" -d "$HTTPD_ROOT_PATH" \
 226                 -f "$TEST_PATH/apache.conf" $HTTPD_PARA -k stop
 227 }
 228
 229 test_http_push_nonff () {
 230         REMOTE_REPO=$1
 231         LOCAL_REPO=$2
 232         BRANCH=$3
 233         EXPECT_CAS_RESULT=${4-failure}
 234
 235         test_expect_success 'non-fast-forward push fails' '
 236                 cd "$REMOTE_REPO" &&
 237                 HEAD=$(git rev-parse --verify HEAD) &&
 238
 239                 cd "$LOCAL_REPO" &&
 240                 git checkout $BRANCH &&
 241                 echo "changed" > path2 &&
 242                 git commit -a -m path2 --amend &&
 243
 244                 test_must_fail git push -v origin >output 2>&1 &&
 245                 (
 246                         cd "$REMOTE_REPO" &&
 247                         echo "$HEAD" >expect &&
 248                         git rev-parse --verify HEAD >actual &&
 249                         test_cmp expect actual
 250                 )
 251         '
 252
 253         test_expect_success 'non-fast-forward push show ref status' '
 254                 grep "^ ! \[rejected\][ ]*$BRANCH -> $BRANCH (non-fast-forward)$" output
 255         '
 256
 257         test_expect_success 'non-fast-forward push shows help message' '
 258                 test_i18ngrep "Updates were rejected because" output
 259         '
 260
 261         test_expect_${EXPECT_CAS_RESULT} 'force with lease aka cas' '
 262                 HEAD=$( cd "$REMOTE_REPO" && git rev-parse --verify HEAD ) &&
 263                 test_when_finished '\''
 264                         (cd "$REMOTE_REPO" && git update-ref HEAD "$HEAD")
 265                 '\'' &&
 266                 (
 267                         cd "$LOCAL_REPO" &&
 268                         git push -v --force-with-lease=$BRANCH:$HEAD origin
 269                 ) &&
 270                 git rev-parse --verify "$BRANCH" >expect &&
 271                 (
 272                         cd "$REMOTE_REPO" && git rev-parse --verify HEAD
 273                 ) >actual &&
 274                 test_cmp expect actual
 275         '
 276 }
 277
 278 setup_askpass_helper() {
 279         test_expect_success 'setup askpass helper' '
 280                 write_script "$TRASH_DIRECTORY/askpass" <<-\EOF &&
 281                 echo >>"$TRASH_DIRECTORY/askpass-query" "askpass: $*" &&
 282                 case "$*" in
 283                 *Username*)
 284                         what=user
 285                         ;;
 286                 *Password*)
 287                         what=pass
 288                         ;;
 289                 esac &&
 290                 cat "$TRASH_DIRECTORY/askpass-$what"
 291                 EOF
 292                 GIT_ASKPASS="$TRASH_DIRECTORY/askpass" &&
 293                 export GIT_ASKPASS &&
 294                 export TRASH_DIRECTORY
 295         '
 296 }
 297
 298 set_askpass() {
 299         >"$TRASH_DIRECTORY/askpass-query" &&
 300         echo "$1" >"$TRASH_DIRECTORY/askpass-user" &&
 301         echo "$2" >"$TRASH_DIRECTORY/askpass-pass"
 302 }
 303
 304 expect_askpass() {
 305         dest=$HTTPD_DEST${3+/$3}
 306
 307         {
 308                 case "$1" in
 309                 none)
 310                         ;;
 311                 pass)
 312                         echo "askpass: Password for '$HTTPD_PROTO://$2@$dest': "
 313                         ;;
 314                 both)
 315                         echo "askpass: Username for '$HTTPD_PROTO://$dest': "
 316                         echo "askpass: Password for '$HTTPD_PROTO://$2@$dest': "
 317                         ;;
 318                 *)
 319                         false
 320                         ;;
 321                 esac
 322         } >"$TRASH_DIRECTORY/askpass-expect" &&
 323         test_cmp "$TRASH_DIRECTORY/askpass-expect" \
 324                  "$TRASH_DIRECTORY/askpass-query"
 325 }
 326
 327 strip_access_log() {
 328         sed -e "
 329                 s/^.* \"//
 330                 s/\"//
 331                 s/ [1-9][0-9]*\$//
 332                 s/^GET /GET  /
 333         " "$HTTPD_ROOT_PATH"/access.log
 334 }
 335
 336 # Requires one argument: the name of a file containing the expected stripped
 337 # access log entries.
 338 check_access_log() {
 339         sort "$1" >"$1".sorted &&
 340         strip_access_log >access.log.stripped &&
 341         sort access.log.stripped >access.log.sorted &&
 342         if ! test_cmp "$1".sorted access.log.sorted
 343         then
 344                 test_cmp "$1" access.log.stripped
 345         fi
 346 }