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 #       stop_httpd
  18 #       test_done
  19 #
  20 # Can be configured using the following variables.
  21 #
  22 #    GIT_TEST_HTTPD              enable HTTPD tests
  23 #    LIB_HTTPD_PATH              web server path
  24 #    LIB_HTTPD_MODULE_PATH       web server modules path
  25 #    LIB_HTTPD_PORT              listening port
  26 #    LIB_HTTPD_DAV               enable DAV
  27 #    LIB_HTTPD_SVN               enable SVN at given location (e.g. "svn")
  28 #    LIB_HTTPD_SSL               enable SSL
  29 #
  30 # Copyright (c) 2008 Clemens Buchacher <drizzd@aon.at>
  31 #
  32
  33 if test -n "$NO_CURL"
  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 test_tristate GIT_TEST_HTTPD
  46 if test "$GIT_TEST_HTTPD" = false
  47 then
  48         skip_all="Network testing disabled (unset GIT_TEST_HTTPD to enable)"
  49         test_done
  50 fi
  51
  52 if ! test_have_prereq NOT_ROOT; then
  53         test_skip_or_die $GIT_TEST_HTTPD \
  54                 "Cannot run httpd tests as root"
  55 fi
  56
  57 HTTPD_PARA=""
  58
  59 for DEFAULT_HTTPD_PATH in '/usr/sbin/httpd' '/usr/sbin/apache2'
  60 do
  61         if test -x "$DEFAULT_HTTPD_PATH"
  62         then
  63                 break
  64         fi
  65 done
  66
  67 for DEFAULT_HTTPD_MODULE_PATH in '/usr/libexec/apache2' \
  68                                  '/usr/lib/apache2/modules' \
  69                                  '/usr/lib64/httpd/modules' \
  70                                  '/usr/lib/httpd/modules'
  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
 105 if test -n "$HTTPD_VERSION"
 106 then
 107         if test -z "$LIB_HTTPD_MODULE_PATH"
 108         then
 109                 if ! test $HTTPD_VERSION -ge 2
 110                 then
 111                         test_skip_or_die $GIT_TEST_HTTPD \
 112                                 "at least Apache version 2 is required"
 113                 fi
 114                 if ! test -d "$DEFAULT_HTTPD_MODULE_PATH"
 115                 then
 116                         test_skip_or_die $GIT_TEST_HTTPD \
 117                                 "Apache module directory not found"
 118                 fi
 119
 120                 LIB_HTTPD_MODULE_PATH="$DEFAULT_HTTPD_MODULE_PATH"
 121         fi
 122 else
 123         test_skip_or_die $GIT_TEST_HTTPD \
 124                 "Could not identify web server at '$LIB_HTTPD_PATH'"
 125 fi
 126
 127 install_script () {
 128         write_script "$HTTPD_ROOT_PATH/$1" <"$TEST_PATH/$1"
 129 }
 130
 131 prepare_httpd() {
 132         mkdir -p "$HTTPD_DOCUMENT_ROOT_PATH"
 133         cp "$TEST_PATH"/passwd "$HTTPD_ROOT_PATH"
 134         install_script broken-smart-http.sh
 135         install_script error-smart-http.sh
 136         install_script error.sh
 137         install_script apply-one-time-sed.sh
 138
 139         ln -s "$LIB_HTTPD_MODULE_PATH" "$HTTPD_ROOT_PATH/modules"
 140
 141         if test -n "$LIB_HTTPD_SSL"
 142         then
 143                 HTTPD_PROTO=https
 144
 145                 RANDFILE_PATH="$HTTPD_ROOT_PATH"/.rnd openssl req \
 146                         -config "$TEST_PATH/ssl.cnf" \
 147                         -new -x509 -nodes \
 148                         -out "$HTTPD_ROOT_PATH/httpd.pem" \
 149                         -keyout "$HTTPD_ROOT_PATH/httpd.pem"
 150                 GIT_SSL_NO_VERIFY=t
 151                 export GIT_SSL_NO_VERIFY
 152                 HTTPD_PARA="$HTTPD_PARA -DSSL"
 153         else
 154                 HTTPD_PROTO=http
 155         fi
 156         HTTPD_DEST=127.0.0.1:$LIB_HTTPD_PORT
 157         HTTPD_URL=$HTTPD_PROTO://$HTTPD_DEST
 158         HTTPD_URL_USER=$HTTPD_PROTO://user%40host@$HTTPD_DEST
 159         HTTPD_URL_USER_PASS=$HTTPD_PROTO://user%40host:pass%40host@$HTTPD_DEST
 160
 161         if test -n "$LIB_HTTPD_DAV" || test -n "$LIB_HTTPD_SVN"
 162         then
 163                 HTTPD_PARA="$HTTPD_PARA -DDAV"
 164
 165                 if test -n "$LIB_HTTPD_SVN"
 166                 then
 167                         HTTPD_PARA="$HTTPD_PARA -DSVN"
 168                         LIB_HTTPD_SVNPATH="$rawsvnrepo"
 169                         svnrepo="http://127.0.0.1:$LIB_HTTPD_PORT/"
 170                         svnrepo="$svnrepo$LIB_HTTPD_SVN"
 171                         export LIB_HTTPD_SVN LIB_HTTPD_SVNPATH
 172                 fi
 173         fi
 174 }
 175
 176 start_httpd() {
 177         prepare_httpd >&3 2>&4
 178
 179         trap 'code=$?; stop_httpd; (exit $code); die' EXIT
 180
 181         "$LIB_HTTPD_PATH" -d "$HTTPD_ROOT_PATH" \
 182                 -f "$TEST_PATH/apache.conf" $HTTPD_PARA \
 183                 -c "Listen 127.0.0.1:$LIB_HTTPD_PORT" -k start \
 184                 >&3 2>&4
 185         if test $? -ne 0
 186         then
 187                 trap 'die' EXIT
 188                 cat "$HTTPD_ROOT_PATH"/error.log >&4 2>/dev/null
 189                 test_skip_or_die $GIT_TEST_HTTPD "web server setup failed"
 190         fi
 191 }
 192
 193 stop_httpd() {
 194         trap 'die' EXIT
 195
 196         "$LIB_HTTPD_PATH" -d "$HTTPD_ROOT_PATH" \
 197                 -f "$TEST_PATH/apache.conf" $HTTPD_PARA -k stop
 198 }
 199
 200 test_http_push_nonff () {
 201         REMOTE_REPO=$1
 202         LOCAL_REPO=$2
 203         BRANCH=$3
 204         EXPECT_CAS_RESULT=${4-failure}
 205
 206         test_expect_success 'non-fast-forward push fails' '
 207                 cd "$REMOTE_REPO" &&
 208                 HEAD=$(git rev-parse --verify HEAD) &&
 209
 210                 cd "$LOCAL_REPO" &&
 211                 git checkout $BRANCH &&
 212                 echo "changed" > path2 &&
 213                 git commit -a -m path2 --amend &&
 214
 215                 test_must_fail git push -v origin >output 2>&1 &&
 216                 (cd "$REMOTE_REPO" &&
 217                  test $HEAD = $(git rev-parse --verify HEAD))
 218         '
 219
 220         test_expect_success 'non-fast-forward push show ref status' '
 221                 grep "^ ! \[rejected\][ ]*$BRANCH -> $BRANCH (non-fast-forward)$" output
 222         '
 223
 224         test_expect_success 'non-fast-forward push shows help message' '
 225                 test_i18ngrep "Updates were rejected because" output
 226         '
 227
 228         test_expect_${EXPECT_CAS_RESULT} 'force with lease aka cas' '
 229                 HEAD=$( cd "$REMOTE_REPO" && git rev-parse --verify HEAD ) &&
 230                 test_when_finished '\''
 231                         (cd "$REMOTE_REPO" && git update-ref HEAD "$HEAD")
 232                 '\'' &&
 233                 (
 234                         cd "$LOCAL_REPO" &&
 235                         git push -v --force-with-lease=$BRANCH:$HEAD origin
 236                 ) &&
 237                 git rev-parse --verify "$BRANCH" >expect &&
 238                 (
 239                         cd "$REMOTE_REPO" && git rev-parse --verify HEAD
 240                 ) >actual &&
 241                 test_cmp expect actual
 242         '
 243 }
 244
 245 setup_askpass_helper() {
 246         test_expect_success 'setup askpass helper' '
 247                 write_script "$TRASH_DIRECTORY/askpass" <<-\EOF &&
 248                 echo >>"$TRASH_DIRECTORY/askpass-query" "askpass: $*" &&
 249                 case "$*" in
 250                 *Username*)
 251                         what=user
 252                         ;;
 253                 *Password*)
 254                         what=pass
 255                         ;;
 256                 esac &&
 257                 cat "$TRASH_DIRECTORY/askpass-$what"
 258                 EOF
 259                 GIT_ASKPASS="$TRASH_DIRECTORY/askpass" &&
 260                 export GIT_ASKPASS &&
 261                 export TRASH_DIRECTORY
 262         '
 263 }
 264
 265 set_askpass() {
 266         >"$TRASH_DIRECTORY/askpass-query" &&
 267         echo "$1" >"$TRASH_DIRECTORY/askpass-user" &&
 268         echo "$2" >"$TRASH_DIRECTORY/askpass-pass"
 269 }
 270
 271 expect_askpass() {
 272         dest=$HTTPD_DEST${3+/$3}
 273
 274         {
 275                 case "$1" in
 276                 none)
 277                         ;;
 278                 pass)
 279                         echo "askpass: Password for 'http://$2@$dest': "
 280                         ;;
 281                 both)
 282                         echo "askpass: Username for 'http://$dest': "
 283                         echo "askpass: Password for 'http://$2@$dest': "
 284                         ;;
 285                 *)
 286                         false
 287                         ;;
 288                 esac
 289         } >"$TRASH_DIRECTORY/askpass-expect" &&
 290         test_cmp "$TRASH_DIRECTORY/askpass-expect" \
 291                  "$TRASH_DIRECTORY/askpass-query"
 292 }
 293
 294 strip_access_log() {
 295         sed -e "
 296                 s/^.* \"//
 297                 s/\"//
 298                 s/ [1-9][0-9]*\$//
 299                 s/^GET /GET  /
 300         " "$HTTPD_ROOT_PATH"/access.log
 301 }
 302
 303 # Requires one argument: the name of a file containing the expected stripped
 304 # access log entries.
 305 check_access_log() {
 306         sort "$1" >"$1".sorted &&
 307         strip_access_log >access.log.stripped &&
 308         sort access.log.stripped >access.log.sorted &&
 309         if ! test_cmp "$1".sorted access.log.sorted
 310         then
 311                 test_cmp "$1" access.log.stripped
 312         fi
 313 }