Files
dokku/tests/unit/proxy-route-nginx.bats
T
Jose Diaz-Gonzalez 6dbd9b4d82 fix: make T3 route-removal assertions robust to reload race
T3 in every per-backend file polled the post-removal HTTP response using assert_http_localhost_response_contains, which retries on status code only. After a route is removed, both api and web return 200 for /api/v0/Procfile so the polling exits immediately; the body check then races with the proxy daemon picking up the new state and observes api's response (Procfile content) instead of web's catch-all. The proxy:route:remove output was also unechoed, hiding whether BuildConfig actually fired or was no-op suppressed. Each T3 now echoes the remove output and status, asserts via proxy:route:report that storage was cleared, then polls the body in a hand-rolled retry loop until the api marker is no longer present (timeout 30s). The k3s T3 files similarly retry the kubectl probe so the chart re-render has time to settle.
2026-11-04 14:56:38 -05:00

146 lines
5.5 KiB
Bash

#!/usr/bin/env bats
load test_helper
setup() {
global_setup
create_app
}
teardown() {
dokku proxy:route:clear "$TEST_APP" >/dev/null 2>&1 || true
destroy_app
global_teardown
}
@test "(proxy-route:nginx) basic routing - /api/v0 hits api, / hits web" {
run deploy_app python "dokku@$DOKKU_DOMAIN:$TEST_APP" add_api_process_callback
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "dokku ps:scale $TEST_APP web=1 api=1"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "dokku proxy:route:set $TEST_APP api /api/v0 --port 5001"
echo "output: $output"
echo "status: $status"
assert_success
# Without --strip-prefix, /api/v0/Procfile reaches api as /api/v0/Procfile.
# api (python's http.server) does not have that file on disk and returns
# 404. A 404 here proves the route reaches api - web's catch-all would
# have returned 200 instead.
assert_http_localhost_response_contains "http" "${TEST_APP}.${DOKKU_DOMAIN}" "80" "/api/v0/Procfile" "" "404"
}
@test "(proxy-route:nginx) --strip-prefix toggles upstream path visibility" {
run deploy_app python "dokku@$DOKKU_DOMAIN:$TEST_APP" add_api_process_callback
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "dokku ps:scale $TEST_APP web=1 api=1"
echo "output: $output"
echo "status: $status"
assert_success
# Without --strip-prefix, /api/v0/Procfile is forwarded as-is to api,
# which does not have an /api/v0/Procfile file on disk.
run /bin/bash -c "dokku proxy:route:set $TEST_APP api /api/v0 --port 5001"
assert_success
assert_http_localhost_response_contains "http" "${TEST_APP}.${DOKKU_DOMAIN}" "80" "/api/v0/Procfile" "" "404"
# With --strip-prefix, /api/v0/Procfile becomes /Procfile upstream and api
# returns the Procfile content.
run /bin/bash -c "dokku proxy:route:set $TEST_APP api /api/v0 --port 5001 --strip-prefix"
assert_success
assert_http_localhost_response_contains "http" "${TEST_APP}.${DOKKU_DOMAIN}" "80" "/api/v0/Procfile" "python3 -m http.server"
}
@test "(proxy-route:nginx) removing a route falls back to web" {
run deploy_app python "dokku@$DOKKU_DOMAIN:$TEST_APP" add_api_process_callback
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "dokku ps:scale $TEST_APP web=1 api=1"
assert_success
# First set the route without --strip-prefix so a 404 from api uniquely
# identifies that the route reached api (avoids racing with web's catch-all
# 200 during the brief window before nginx fully reloads).
run /bin/bash -c "dokku proxy:route:set $TEST_APP api /api/v0 --port 5001"
assert_success
assert_http_localhost_response_contains "http" "${TEST_APP}.${DOKKU_DOMAIN}" "80" "/api/v0/Procfile" "" "404"
# Now switch the route to --strip-prefix and assert api serves the Procfile.
run /bin/bash -c "dokku proxy:route:set $TEST_APP api /api/v0 --port 5001 --strip-prefix"
assert_success
assert_http_localhost_response_contains "http" "${TEST_APP}.${DOKKU_DOMAIN}" "80" "/api/v0/Procfile" "python3 -m http.server"
run /bin/bash -c "dokku proxy:route:remove $TEST_APP /api/v0"
echo "output: $output"
echo "status: $status"
assert_success
# Confirm storage was actually mutated; a CommandRouteRemove that returns
# changed=false silently skips BuildConfig and leaves nginx with the old
# route block.
run /bin/bash -c "dokku proxy:route:report $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
assert_output_contains "(none)"
# nginx reload races with the curl after route removal: both api and web
# return 200 for /api/v0/Procfile so the polling loop in
# assert_http_localhost_response_contains exits on status alone before
# nginx picks up the new config. Hand-roll a retry that polls the BODY
# until it no longer contains api's marker.
local body=""
for attempt in $(seq 1 30); do
run curl --connect-to "${TEST_APP}.${DOKKU_DOMAIN}:80:localhost:80" -kSs "http://${TEST_APP}.${DOKKU_DOMAIN}:80/api/v0/Procfile"
body="$output"
if ! grep -q 'python3 -m http.server' <<<"$body"; then
break
fi
sleep 1
done
echo "final body attempt $attempt: $body"
run /bin/bash -c "grep -c 'python3 -m http.server' <<<\"$body\" || true"
assert_output "0"
}
@test "(proxy-route:nginx) websocket upgrade headers are present in rendered config" {
run deploy_app python "dokku@$DOKKU_DOMAIN:$TEST_APP" add_api_process_callback
assert_success
run /bin/bash -c "dokku ps:scale $TEST_APP web=1 api=1"
assert_success
run /bin/bash -c "dokku proxy:route:set $TEST_APP api /api/v0 --port 5001"
assert_success
run /bin/bash -c "dokku nginx:show-config $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
assert_output_contains "location /api/v0"
# These headers appear in both the route's location block AND the existing
# location / block, so allow >= 1 occurrence (count = -1) rather than the
# default exact-count-of-1.
assert_output_contains "proxy_http_version 1.1" -1
assert_output_contains "proxy_set_header Upgrade \$http_upgrade" -1
assert_output_contains "proxy_set_header Connection \$http_connection" -1
}
add_api_process_callback() {
local APP="$1"
local APP_REPO_DIR="$2"
# api serves /app's working directory on port 5001. GET /Procfile returns
# the literal Procfile bytes, which web.py does not serve - this gives the
# HTTP assertions a clear marker for which process handled the request.
echo "api: python3 -m http.server 5001" >>"$APP_REPO_DIR/Procfile"
}