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