fix: validate app.json healthcheck path and scheme

This commit is contained in:
Jose Diaz-Gonzalez committed 2026-09-23 23:12:58 -04:00
1 parent f57b3455c1
commit db42d0a039
11 files changed
+306 -7

No files matched your search

+34
View File
@@ -75,6 +75,20 @@ teardown() {
assert_output "web: 1"
}
@test "(app-json) healthcheck path with whitespace fails deploy" {
run deploy_app python dokku@$DOKKU_DOMAIN:$TEST_APP whitespace_healthcheck_path_callback
echo "output: $output"
echo "status: $status"
assert_failure
assert_output_contains 'Invalid app.json healthcheck web readiness check for process type web: path "/health check" must not contain whitespace, control characters, quotes, or backslashes' 2
run /bin/bash -c "docker ps -a -q --filter label=com.dokku.app-name=$TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
assert_output_not_exists
}
persist_scale_callback_a() {
local APP="$1"
local APP_REPO_DIR="$2"
@@ -114,3 +128,23 @@ negative_formation_callback() {
}
EOF
}
whitespace_healthcheck_path_callback() {
local APP="$1"
local APP_REPO_DIR="$2"
[[ -z "$APP" ]] && local APP="$TEST_APP"
cat >"$APP_REPO_DIR/app.json" <<EOF
{
"healthchecks": {
"web": [
{
"name": "web readiness check",
"path": "/health check",
"type": "readiness"
}
]
}
}
EOF
}
+73
View File
@@ -882,6 +882,61 @@ teardown() {
assert_output_not_exists
}
@test "(traefik) healthcheck path with whitespace fails deploy" {
run /bin/bash -c "dokku proxy:set $TEST_APP traefik"
echo "output: $output"
echo "status: $status"
assert_success
run deploy_app python dokku@$DOKKU_DOMAIN:$TEST_APP setup_traefik_healthcheck_whitespace_path
echo "output: $output"
echo "status: $status"
assert_failure
assert_output_contains 'path "/health check" must not contain whitespace, control characters, quotes, or backslashes' 2
run /bin/bash -c "docker ps -a -q --filter label=com.dokku.app-name=$TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
assert_output_not_exists
}
@test "(traefik) healthcheck invalid scheme fails deploy" {
run /bin/bash -c "dokku proxy:set $TEST_APP traefik"
echo "output: $output"
echo "status: $status"
assert_success
run deploy_app python dokku@$DOKKU_DOMAIN:$TEST_APP setup_traefik_healthcheck_invalid_scheme
echo "output: $output"
echo "status: $status"
assert_failure
assert_output_contains 'scheme "tcp" must be one of http or https' 2
}
@test "(traefik) invalid stored healthcheck path fails restart" {
run /bin/bash -c "dokku proxy:set $TEST_APP traefik"
echo "output: $output"
echo "status: $status"
assert_success
run deploy_app python dokku@$DOKKU_DOMAIN:$TEST_APP setup_traefik_healthcheck
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "jq '.healthchecks.web[0].path = \"/health check\"' /var/lib/dokku/data/app-json/$TEST_APP/app.json > /var/lib/dokku/data/app-json/$TEST_APP/app.json.tmp && mv /var/lib/dokku/data/app-json/$TEST_APP/app.json.tmp /var/lib/dokku/data/app-json/$TEST_APP/app.json"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "dokku ps:restart $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_failure
assert_output_contains "Invalid app.json healthcheck path for traefik" 2
}
setup_traefik_healthcheck() {
local APP="$1"
local APP_REPO_DIR="$2"
@@ -890,3 +945,21 @@ setup_traefik_healthcheck() {
mv "$APP_REPO_DIR/app-traefik.json" "$APP_REPO_DIR/app.json"
}
setup_traefik_healthcheck_whitespace_path() {
local APP="$1"
local APP_REPO_DIR="$2"
[[ -z "$APP" ]] && local APP="$TEST_APP"
APP_REPO_DIR="$(realpath "$APP_REPO_DIR")"
jq '.healthchecks.web[0].path = "/health check"' "$APP_REPO_DIR/app-traefik.json" >"$APP_REPO_DIR/app.json"
}
setup_traefik_healthcheck_invalid_scheme() {
local APP="$1"
local APP_REPO_DIR="$2"
[[ -z "$APP" ]] && local APP="$TEST_APP"
APP_REPO_DIR="$(realpath "$APP_REPO_DIR")"
jq '.healthchecks.web[0].scheme = "tcp"' "$APP_REPO_DIR/app-traefik.json" >"$APP_REPO_DIR/app.json"
}