| 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 | # LIB_HTTPD_PROXY enable proxy |
| 29 | # |
| 30 | # Copyright (c) 2008 Clemens Buchacher <drizzd@aon.at> |
| 31 | # |
| 32 | |
| 33 | if ! test_have_prereq LIBCURL |
| 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 | if ! test_bool_env GIT_TEST_HTTPD true |
| 46 | then |
| 47 | skip_all="Network testing disabled (unset GIT_TEST_HTTPD to enable)" |
| 48 | test_done |
| 49 | fi |
| 50 | |
| 51 | if ! test_have_prereq NOT_ROOT; then |
| 52 | test_skip_or_die GIT_TEST_HTTPD \ |
| 53 | "Cannot run httpd tests as root" |
| 54 | fi |
| 55 | |
| 56 | HTTPD_PARA="" |
| 57 | |
| 58 | for DEFAULT_HTTPD_PATH in '/usr/sbin/httpd' \ |
| 59 | '/usr/sbin/apache2' \ |
| 60 | "$(command -v httpd)" \ |
| 61 | "$(command -v apache2)" |
| 62 | do |
| 63 | if test -n "$DEFAULT_HTTPD_PATH" && test -x "$DEFAULT_HTTPD_PATH" |
| 64 | then |
| 65 | break |
| 66 | fi |
| 67 | done |
| 68 | |
| 69 | if test -x "$DEFAULT_HTTPD_PATH" |
| 70 | then |
| 71 | DETECTED_HTTPD_ROOT="$("$DEFAULT_HTTPD_PATH" -V 2>/dev/null | sed -n 's/^ -D HTTPD_ROOT="\(.*\)"$/\1/p')" |
| 72 | fi |
| 73 | |
| 74 | for DEFAULT_HTTPD_MODULE_PATH in '/usr/libexec/apache2' \ |
| 75 | '/usr/lib/apache2/modules' \ |
| 76 | '/usr/lib64/httpd/modules' \ |
| 77 | '/usr/lib/httpd/modules' \ |
| 78 | '/usr/libexec/httpd' \ |
| 79 | '/usr/lib/apache2' \ |
| 80 | "${DETECTED_HTTPD_ROOT:+${DETECTED_HTTPD_ROOT}/modules}" |
| 81 | do |
| 82 | if test -n "$DEFAULT_HTTPD_MODULE_PATH" && test -d "$DEFAULT_HTTPD_MODULE_PATH" |
| 83 | then |
| 84 | break |
| 85 | fi |
| 86 | done |
| 87 | |
| 88 | case $(uname) in |
| 89 | Darwin) |
| 90 | HTTPD_PARA="$HTTPD_PARA -DDarwin" |
| 91 | ;; |
| 92 | esac |
| 93 | |
| 94 | LIB_HTTPD_PATH=${LIB_HTTPD_PATH-"$DEFAULT_HTTPD_PATH"} |
| 95 | test_set_port LIB_HTTPD_PORT |
| 96 | |
| 97 | TEST_PATH="$TEST_DIRECTORY"/lib-httpd |
| 98 | HTTPD_ROOT_PATH="$PWD"/httpd |
| 99 | HTTPD_DOCUMENT_ROOT_PATH=$HTTPD_ROOT_PATH/www |
| 100 | |
| 101 | # hack to suppress apache PassEnv warnings |
| 102 | GIT_VALGRIND=$GIT_VALGRIND; export GIT_VALGRIND |
| 103 | GIT_VALGRIND_OPTIONS=$GIT_VALGRIND_OPTIONS; export GIT_VALGRIND_OPTIONS |
| 104 | GIT_TEST_SIDEBAND_ALL=$GIT_TEST_SIDEBAND_ALL; export GIT_TEST_SIDEBAND_ALL |
| 105 | GIT_TRACE=$GIT_TRACE; export GIT_TRACE |
| 106 | |
| 107 | if ! test -x "$LIB_HTTPD_PATH" |
| 108 | then |
| 109 | test_skip_or_die GIT_TEST_HTTPD "no web server found at '$LIB_HTTPD_PATH'" |
| 110 | fi |
| 111 | |
| 112 | HTTPD_VERSION=$($LIB_HTTPD_PATH -v | \ |
| 113 | sed -n 's/^Server version: Apache\/\([0-9.]*\).*$/\1/p; q') |
| 114 | HTTPD_VERSION_MAJOR=$(echo $HTTPD_VERSION | cut -d. -f1) |
| 115 | HTTPD_VERSION_MINOR=$(echo $HTTPD_VERSION | cut -d. -f2) |
| 116 | |
| 117 | if test -n "$HTTPD_VERSION_MAJOR" |
| 118 | then |
| 119 | if test -z "$LIB_HTTPD_MODULE_PATH" |
| 120 | then |
| 121 | if ! test "$HTTPD_VERSION_MAJOR" -eq 2 || |
| 122 | ! test "$HTTPD_VERSION_MINOR" -ge 4 |
| 123 | then |
| 124 | test_skip_or_die GIT_TEST_HTTPD \ |
| 125 | "at least Apache version 2.4 is required" |
| 126 | fi |
| 127 | if ! test -d "$DEFAULT_HTTPD_MODULE_PATH" |
| 128 | then |
| 129 | test_skip_or_die GIT_TEST_HTTPD \ |
| 130 | "Apache module directory not found" |
| 131 | fi |
| 132 | |
| 133 | LIB_HTTPD_MODULE_PATH="$DEFAULT_HTTPD_MODULE_PATH" |
| 134 | fi |
| 135 | else |
| 136 | test_skip_or_die GIT_TEST_HTTPD \ |
| 137 | "Could not identify web server at '$LIB_HTTPD_PATH'" |
| 138 | fi |
| 139 | |
| 140 | if test -n "$LIB_HTTPD_DAV" && test -f /etc/os-release |
| 141 | then |
| 142 | case "$(grep "^ID=" /etc/os-release | cut -d= -f2-)" in |
| 143 | alpine) |
| 144 | # The WebDAV module in Alpine Linux is broken at least up to |
| 145 | # Alpine v3.16 as the default DBM driver is missing. |
| 146 | # |
| 147 | # https://gitlab.alpinelinux.org/alpine/aports/-/issues/13112 |
| 148 | test_skip_or_die GIT_TEST_HTTPD \ |
| 149 | "Apache WebDAV module does not have default DBM backend driver" |
| 150 | ;; |
| 151 | esac |
| 152 | fi |
| 153 | |
| 154 | install_script () { |
| 155 | write_script "$HTTPD_ROOT_PATH/$1" <"$TEST_PATH/$1" |
| 156 | } |
| 157 | |
| 158 | prepare_httpd() { |
| 159 | mkdir -p "$HTTPD_DOCUMENT_ROOT_PATH" |
| 160 | cp "$TEST_PATH"/passwd "$HTTPD_ROOT_PATH" |
| 161 | cp "$TEST_PATH"/proxy-passwd "$HTTPD_ROOT_PATH" |
| 162 | # The web server can run any of these CGI scripts for two requests at |
| 163 | # once; a helper that keeps state between requests must do so with an |
| 164 | # atomic operation. See "Writing concurrency-safe helpers" in t/README. |
| 165 | install_script incomplete-length-upload-pack-v2-http.sh |
| 166 | install_script incomplete-body-upload-pack-v2-http.sh |
| 167 | install_script error-no-report.sh |
| 168 | install_script broken-smart-http.sh |
| 169 | install_script error-smart-http.sh |
| 170 | install_script error.sh |
| 171 | install_script apply-one-time-script.sh |
| 172 | install_script nph-custom-auth.sh |
| 173 | install_script http-429.sh |
| 174 | |
| 175 | ln -s "$LIB_HTTPD_MODULE_PATH" "$HTTPD_ROOT_PATH/modules" |
| 176 | |
| 177 | if test -n "$LIB_HTTPD_SSL" |
| 178 | then |
| 179 | HTTPD_PROTO=https |
| 180 | |
| 181 | RANDFILE_PATH="$HTTPD_ROOT_PATH"/.rnd openssl req \ |
| 182 | -config "$TEST_PATH/ssl.cnf" \ |
| 183 | -new -x509 -nodes \ |
| 184 | -out "$HTTPD_ROOT_PATH/httpd.pem" \ |
| 185 | -keyout "$HTTPD_ROOT_PATH/httpd.pem" |
| 186 | GIT_SSL_NO_VERIFY=t |
| 187 | export GIT_SSL_NO_VERIFY |
| 188 | HTTPD_PARA="$HTTPD_PARA -DSSL" |
| 189 | else |
| 190 | HTTPD_PROTO=http |
| 191 | fi |
| 192 | HTTPD_DEST=127.0.0.1:$LIB_HTTPD_PORT |
| 193 | HTTPD_URL=$HTTPD_PROTO://$HTTPD_DEST |
| 194 | HTTPD_URL_USER=$HTTPD_PROTO://user%40host@$HTTPD_DEST |
| 195 | HTTPD_URL_USER_PASS=$HTTPD_PROTO://user%40host:pass%40host@$HTTPD_DEST |
| 196 | |
| 197 | if test -n "$LIB_HTTPD_DAV" || test -n "$LIB_HTTPD_SVN" |
| 198 | then |
| 199 | HTTPD_PARA="$HTTPD_PARA -DDAV" |
| 200 | |
| 201 | if test -n "$LIB_HTTPD_SVN" |
| 202 | then |
| 203 | HTTPD_PARA="$HTTPD_PARA -DSVN" |
| 204 | LIB_HTTPD_SVNPATH="$rawsvnrepo" |
| 205 | svnrepo="http://127.0.0.1:$LIB_HTTPD_PORT/" |
| 206 | svnrepo="$svnrepo$LIB_HTTPD_SVN" |
| 207 | export LIB_HTTPD_SVN LIB_HTTPD_SVNPATH |
| 208 | fi |
| 209 | fi |
| 210 | |
| 211 | if test -n "$LIB_HTTPD_PROXY" |
| 212 | then |
| 213 | HTTPD_PARA="$HTTPD_PARA -DPROXY" |
| 214 | fi |
| 215 | } |
| 216 | |
| 217 | enable_http2 () { |
| 218 | HTTPD_PARA="$HTTPD_PARA -DHTTP2" |
| 219 | test_set_prereq HTTP2 |
| 220 | } |
| 221 | |
| 222 | enable_cgipassauth () { |
| 223 | # We are looking for 2.4.13 or more recent. Since we only support |
| 224 | # 2.4 and up, no need to check for older major/minor. |
| 225 | if test "$HTTPD_VERSION_MAJOR" = 2 && |
| 226 | test "$HTTPD_VERSION_MINOR" = 4 && |
| 227 | test "$(echo $HTTPD_VERSION | cut -d. -f3)" -lt 13 |
| 228 | then |
| 229 | echo >&4 "apache $HTTPD_VERSION too old for CGIPassAuth" |
| 230 | return |
| 231 | fi |
| 232 | HTTPD_PARA="$HTTPD_PARA -DUSE_CGIPASSAUTH" |
| 233 | test_set_prereq CGIPASSAUTH |
| 234 | } |
| 235 | |
| 236 | start_httpd() { |
| 237 | prepare_httpd >&3 2>&4 |
| 238 | |
| 239 | test_atexit stop_httpd |
| 240 | |
| 241 | if ! "$LIB_HTTPD_PATH" -d "$HTTPD_ROOT_PATH" \ |
| 242 | -f "$TEST_PATH/apache.conf" $HTTPD_PARA \ |
| 243 | -c "Listen 127.0.0.1:$LIB_HTTPD_PORT" -k start \ |
| 244 | >&3 2>&4 |
| 245 | then |
| 246 | cat "$HTTPD_ROOT_PATH"/error.log >&4 2>/dev/null |
| 247 | test_skip_or_die GIT_TEST_HTTPD "web server setup failed" |
| 248 | fi |
| 249 | } |
| 250 | |
| 251 | stop_httpd() { |
| 252 | "$LIB_HTTPD_PATH" -d "$HTTPD_ROOT_PATH" \ |
| 253 | -f "$TEST_PATH/apache.conf" $HTTPD_PARA -k stop |
| 254 | } |
| 255 | |
| 256 | test_http_push_nonff () { |
| 257 | REMOTE_REPO=$1 |
| 258 | LOCAL_REPO=$2 |
| 259 | BRANCH=$3 |
| 260 | EXPECT_CAS_RESULT=${4-failure} |
| 261 | |
| 262 | test_expect_success 'non-fast-forward push fails' ' |
| 263 | cd "$REMOTE_REPO" && |
| 264 | HEAD=$(git rev-parse --verify HEAD) && |
| 265 | |
| 266 | cd "$LOCAL_REPO" && |
| 267 | git checkout $BRANCH && |
| 268 | echo "changed" > path2 && |
| 269 | git commit -a -m path2 --amend && |
| 270 | |
| 271 | test_must_fail git push -v origin >output 2>&1 && |
| 272 | ( |
| 273 | cd "$REMOTE_REPO" && |
| 274 | echo "$HEAD" >expect && |
| 275 | git rev-parse --verify HEAD >actual && |
| 276 | test_cmp expect actual |
| 277 | ) |
| 278 | ' |
| 279 | |
| 280 | test_expect_success 'non-fast-forward push show ref status' ' |
| 281 | test_grep "^ ! \[rejected\][ ]*$BRANCH -> $BRANCH (non-fast-forward)$" output |
| 282 | ' |
| 283 | |
| 284 | test_expect_success 'non-fast-forward push shows help message' ' |
| 285 | test_grep "Updates were rejected because" output |
| 286 | ' |
| 287 | |
| 288 | test_expect_${EXPECT_CAS_RESULT} 'force with lease aka cas' ' |
| 289 | HEAD=$( cd "$REMOTE_REPO" && git rev-parse --verify HEAD ) && |
| 290 | test_when_finished '\'' |
| 291 | (cd "$REMOTE_REPO" && git update-ref HEAD "$HEAD") |
| 292 | '\'' && |
| 293 | ( |
| 294 | cd "$LOCAL_REPO" && |
| 295 | git push -v --force-with-lease=$BRANCH:$HEAD origin |
| 296 | ) && |
| 297 | git rev-parse --verify "$BRANCH" >expect && |
| 298 | ( |
| 299 | cd "$REMOTE_REPO" && git rev-parse --verify HEAD |
| 300 | ) >actual && |
| 301 | test_cmp expect actual |
| 302 | ' |
| 303 | } |
| 304 | |
| 305 | setup_askpass_helper() { |
| 306 | test_expect_success 'setup askpass helper' ' |
| 307 | write_script "$TRASH_DIRECTORY/askpass" <<-\EOF && |
| 308 | echo >>"$TRASH_DIRECTORY/askpass-query" "askpass: $*" && |
| 309 | case "$*" in |
| 310 | *Username*) |
| 311 | what=user |
| 312 | ;; |
| 313 | *Password*) |
| 314 | what=pass |
| 315 | ;; |
| 316 | esac && |
| 317 | cat "$TRASH_DIRECTORY/askpass-$what" |
| 318 | EOF |
| 319 | GIT_ASKPASS="$TRASH_DIRECTORY/askpass" && |
| 320 | export GIT_ASKPASS && |
| 321 | export TRASH_DIRECTORY |
| 322 | ' |
| 323 | } |
| 324 | |
| 325 | set_askpass () { |
| 326 | >"$TRASH_DIRECTORY/askpass-query" && |
| 327 | echo "$1" >"$TRASH_DIRECTORY/askpass-user" && |
| 328 | echo "$2" >"$TRASH_DIRECTORY/askpass-pass" |
| 329 | } |
| 330 | |
| 331 | set_netrc () { |
| 332 | # $HOME=$TRASH_DIRECTORY |
| 333 | echo "machine $1 login $2 password $3" >"$TRASH_DIRECTORY/.netrc" |
| 334 | } |
| 335 | |
| 336 | clear_netrc () { |
| 337 | rm -f "$TRASH_DIRECTORY/.netrc" |
| 338 | } |
| 339 | |
| 340 | expect_askpass () { |
| 341 | dest=$HTTPD_DEST${3+/$3} |
| 342 | |
| 343 | { |
| 344 | case "$1" in |
| 345 | none) |
| 346 | ;; |
| 347 | pass) |
| 348 | echo "askpass: Password for '$HTTPD_PROTO://$2@$dest': " |
| 349 | ;; |
| 350 | both) |
| 351 | echo "askpass: Username for '$HTTPD_PROTO://$dest': " |
| 352 | echo "askpass: Password for '$HTTPD_PROTO://$2@$dest': " |
| 353 | ;; |
| 354 | *) |
| 355 | false |
| 356 | ;; |
| 357 | esac |
| 358 | } >"$TRASH_DIRECTORY/askpass-expect" && |
| 359 | test_cmp "$TRASH_DIRECTORY/askpass-expect" \ |
| 360 | "$TRASH_DIRECTORY/askpass-query" |
| 361 | } |
| 362 | |
| 363 | strip_access_log() { |
| 364 | sed -e " |
| 365 | s/^.* \"// |
| 366 | s/\"// |
| 367 | s/ [1-9][0-9]*\$// |
| 368 | s/^GET /GET / |
| 369 | " "$HTTPD_ROOT_PATH"/access.log |
| 370 | } |
| 371 | |
| 372 | # Requires one argument: the name of a file containing the expected stripped |
| 373 | # access log entries. |
| 374 | check_access_log() { |
| 375 | sort "$1" >"$1".sorted && |
| 376 | strip_access_log >access.log.stripped && |
| 377 | sort access.log.stripped >access.log.sorted && |
| 378 | if ! test_cmp "$1".sorted access.log.sorted |
| 379 | then |
| 380 | test_cmp "$1" access.log.stripped |
| 381 | fi |
| 382 | } |