t / lib-httpd.shon commit Merge branch 'uk/merge-subtree-doc-update' (5d8b3e5)
   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
  33if test -n "$NO_CURL"
  34then
  35        skip_all='skipping test, git built without http support'
  36        test_done
  37fi
  38
  39if test -n "$NO_EXPAT" && test -n "$LIB_HTTPD_DAV"
  40then
  41        skip_all='skipping test, git built without expat support'
  42        test_done
  43fi
  44
  45test_tristate GIT_TEST_HTTPD
  46if test "$GIT_TEST_HTTPD" = false
  47then
  48        skip_all="Network testing disabled (unset GIT_TEST_HTTPD to enable)"
  49        test_done
  50fi
  51
  52if ! test_have_prereq NOT_ROOT; then
  53        test_skip_or_die $GIT_TEST_HTTPD \
  54                "Cannot run httpd tests as root"
  55fi
  56
  57HTTPD_PARA=""
  58
  59for DEFAULT_HTTPD_PATH in '/usr/sbin/httpd' '/usr/sbin/apache2'
  60do
  61        if test -x "$DEFAULT_HTTPD_PATH"
  62        then
  63                break
  64        fi
  65done
  66
  67for DEFAULT_HTTPD_MODULE_PATH in '/usr/libexec/apache2' \
  68                                 '/usr/lib/apache2/modules' \
  69                                 '/usr/lib64/httpd/modules' \
  70                                 '/usr/lib/httpd/modules'
  71do
  72        if test -d "$DEFAULT_HTTPD_MODULE_PATH"
  73        then
  74                break
  75        fi
  76done
  77
  78case $(uname) in
  79        Darwin)
  80                HTTPD_PARA="$HTTPD_PARA -DDarwin"
  81        ;;
  82esac
  83
  84LIB_HTTPD_PATH=${LIB_HTTPD_PATH-"$DEFAULT_HTTPD_PATH"}
  85LIB_HTTPD_PORT=${LIB_HTTPD_PORT-${this_test#t}}
  86
  87TEST_PATH="$TEST_DIRECTORY"/lib-httpd
  88HTTPD_ROOT_PATH="$PWD"/httpd
  89HTTPD_DOCUMENT_ROOT_PATH=$HTTPD_ROOT_PATH/www
  90
  91# hack to suppress apache PassEnv warnings
  92GIT_VALGRIND=$GIT_VALGRIND; export GIT_VALGRIND
  93GIT_VALGRIND_OPTIONS=$GIT_VALGRIND_OPTIONS; export GIT_VALGRIND_OPTIONS
  94GIT_TRACE=$GIT_TRACE; export GIT_TRACE
  95
  96if ! test -x "$LIB_HTTPD_PATH"
  97then
  98        test_skip_or_die $GIT_TEST_HTTPD "no web server found at '$LIB_HTTPD_PATH'"
  99fi
 100
 101HTTPD_VERSION=$($LIB_HTTPD_PATH -v | \
 102        sed -n 's/^Server version: Apache\/\([0-9]*\)\..*$/\1/p; q')
 103
 104if test -n "$HTTPD_VERSION"
 105then
 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
 121else
 122        test_skip_or_die $GIT_TEST_HTTPD \
 123                "Could not identify web server at '$LIB_HTTPD_PATH'"
 124fi
 125
 126install_script () {
 127        write_script "$HTTPD_ROOT_PATH/$1" <"$TEST_PATH/$1"
 128}
 129
 130prepare_httpd() {
 131        mkdir -p "$HTTPD_DOCUMENT_ROOT_PATH"
 132        cp "$TEST_PATH"/passwd "$HTTPD_ROOT_PATH"
 133        install_script broken-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
 174start_httpd() {
 175        prepare_httpd >&3 2>&4
 176
 177        trap 'code=$?; stop_httpd; (exit $code); die' EXIT
 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                trap 'die' EXIT
 186                cat "$HTTPD_ROOT_PATH"/error.log >&4 2>/dev/null
 187                test_skip_or_die $GIT_TEST_HTTPD "web server setup failed"
 188        fi
 189}
 190
 191stop_httpd() {
 192        trap 'die' EXIT
 193
 194        "$LIB_HTTPD_PATH" -d "$HTTPD_ROOT_PATH" \
 195                -f "$TEST_PATH/apache.conf" $HTTPD_PARA -k stop
 196}
 197
 198test_http_push_nonff () {
 199        REMOTE_REPO=$1
 200        LOCAL_REPO=$2
 201        BRANCH=$3
 202        EXPECT_CAS_RESULT=${4-failure}
 203
 204        test_expect_success 'non-fast-forward push fails' '
 205                cd "$REMOTE_REPO" &&
 206                HEAD=$(git rev-parse --verify HEAD) &&
 207
 208                cd "$LOCAL_REPO" &&
 209                git checkout $BRANCH &&
 210                echo "changed" > path2 &&
 211                git commit -a -m path2 --amend &&
 212
 213                test_must_fail git push -v origin >output 2>&1 &&
 214                (cd "$REMOTE_REPO" &&
 215                 test $HEAD = $(git rev-parse --verify HEAD))
 216        '
 217
 218        test_expect_success 'non-fast-forward push show ref status' '
 219                grep "^ ! \[rejected\][ ]*$BRANCH -> $BRANCH (non-fast-forward)$" output
 220        '
 221
 222        test_expect_success 'non-fast-forward push shows help message' '
 223                test_i18ngrep "Updates were rejected because" output
 224        '
 225
 226        test_expect_${EXPECT_CAS_RESULT} 'force with lease aka cas' '
 227                HEAD=$( cd "$REMOTE_REPO" && git rev-parse --verify HEAD ) &&
 228                test_when_finished '\''
 229                        (cd "$REMOTE_REPO" && git update-ref HEAD "$HEAD")
 230                '\'' &&
 231                (
 232                        cd "$LOCAL_REPO" &&
 233                        git push -v --force-with-lease=$BRANCH:$HEAD origin
 234                ) &&
 235                git rev-parse --verify "$BRANCH" >expect &&
 236                (
 237                        cd "$REMOTE_REPO" && git rev-parse --verify HEAD
 238                ) >actual &&
 239                test_cmp expect actual
 240        '
 241}
 242
 243setup_askpass_helper() {
 244        test_expect_success 'setup askpass helper' '
 245                write_script "$TRASH_DIRECTORY/askpass" <<-\EOF &&
 246                echo >>"$TRASH_DIRECTORY/askpass-query" "askpass: $*" &&
 247                case "$*" in
 248                *Username*)
 249                        what=user
 250                        ;;
 251                *Password*)
 252                        what=pass
 253                        ;;
 254                esac &&
 255                cat "$TRASH_DIRECTORY/askpass-$what"
 256                EOF
 257                GIT_ASKPASS="$TRASH_DIRECTORY/askpass" &&
 258                export GIT_ASKPASS &&
 259                export TRASH_DIRECTORY
 260        '
 261}
 262
 263set_askpass() {
 264        >"$TRASH_DIRECTORY/askpass-query" &&
 265        echo "$1" >"$TRASH_DIRECTORY/askpass-user" &&
 266        echo "$2" >"$TRASH_DIRECTORY/askpass-pass"
 267}
 268
 269expect_askpass() {
 270        dest=$HTTPD_DEST${3+/$3}
 271
 272        {
 273                case "$1" in
 274                none)
 275                        ;;
 276                pass)
 277                        echo "askpass: Password for 'http://$2@$dest': "
 278                        ;;
 279                both)
 280                        echo "askpass: Username for 'http://$dest': "
 281                        echo "askpass: Password for 'http://$2@$dest': "
 282                        ;;
 283                *)
 284                        false
 285                        ;;
 286                esac
 287        } >"$TRASH_DIRECTORY/askpass-expect" &&
 288        test_cmp "$TRASH_DIRECTORY/askpass-expect" \
 289                 "$TRASH_DIRECTORY/askpass-query"
 290}
 291
 292strip_access_log() {
 293        sed -e "
 294                s/^.* \"//
 295                s/\"//
 296                s/ [1-9][0-9]*\$//
 297                s/^GET /GET  /
 298        " "$HTTPD_ROOT_PATH"/access.log
 299}
 300
 301# Requires one argument: the name of a file containing the expected stripped
 302# access log entries.
 303check_access_log() {
 304        sort "$1" >"$1".sorted &&
 305        strip_access_log >access.log.stripped &&
 306        sort access.log.stripped >access.log.sorted &&
 307        if ! test_cmp "$1".sorted access.log.sorted
 308        then
 309                test_cmp "$1" access.log.stripped
 310        fi
 311}