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