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