github/dokku
0
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

fix: expose remaining settable properties via :report

Browse Source 
Adds the missing raw/global/computed report keys for ten settable properties across the ps, builder, scheduler, proxy, openresty, nginx, and scheduler-k3s plugins so external tooling can verify drift through `:report --format json`. The scheduler-k3s `token` is masked as `*******` in default stdout output and only unmasked when the report is requested via `--format json` or when the flag is queried explicitly by name; the same explicit-query unmasking rule is extended to the existing traefik `dns-provider-<env_var>` keys.
This commit is contained in:
Jose Diaz-Gonzalez
2026-05-27 04:26:12 -04:00
parent fd9e06d56b
commit 2b5d2e10ea
28 changed files with 734 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
tests/unit/builder.bats
View File

@@ -7,6 +7,7 @@ setup() {
}
teardown() {
dokku builder:set --global skip-cleanup >/dev/null 2>/dev/null || true
destroy_app
}
@@ -307,6 +308,55 @@ teardown() {
assert_success
}
@test "(builder:report) skip-cleanup raw vs computed vs global" {
run /bin/bash -c "dokku builder:set --global skip-cleanup"
assert_success
run /bin/bash -c "dokku builder:report $TEST_APP --builder-skip-cleanup"
assert_success
assert_output_not_exists
run /bin/bash -c "dokku builder:report $TEST_APP --builder-global-skip-cleanup"
assert_success
assert_output_not_exists
run /bin/bash -c "dokku builder:report $TEST_APP --builder-computed-skip-cleanup"
assert_success
assert_output "false"
run /bin/bash -c "dokku builder:set --global skip-cleanup true"
assert_success
run /bin/bash -c "dokku builder:report $TEST_APP --builder-global-skip-cleanup"
assert_success
assert_output "true"
run /bin/bash -c "dokku builder:report $TEST_APP --builder-computed-skip-cleanup"
assert_success
assert_output "true"
run /bin/bash -c "dokku builder:set $TEST_APP skip-cleanup false"
assert_success
run /bin/bash -c "dokku builder:report $TEST_APP --builder-skip-cleanup"
assert_success
assert_output "false"
run /bin/bash -c "dokku builder:report $TEST_APP --builder-global-skip-cleanup"
assert_success
assert_output "true"
run /bin/bash -c "dokku builder:report $TEST_APP --builder-computed-skip-cleanup"
assert_success
assert_output "false"
run /bin/bash -c "dokku builder:set $TEST_APP skip-cleanup"
assert_success
run /bin/bash -c "dokku builder:set --global skip-cleanup"
assert_success
}
@test "(builder:set)" {
run deploy_app python
echo "output: $output"

1
tests/unit/nginx-vhosts_properties.bats
View File

@@ -105,4 +105,5 @@ assert_nginx_property_set_get() {
assert_nginx_property_set_get "underscore-in-headers" "on" "off"
assert_nginx_property_set_get "proxy-keepalive" "8" "16"
assert_nginx_property_set_get "nginx-conf-sigil-path" "custom.sigil" "global.sigil"
assert_nginx_property_set_get "nginx-service-command" "/usr/sbin/nginx-app" "/usr/sbin/nginx-global"
}

61
tests/unit/openresty.bats
View File

@@ -12,6 +12,7 @@ setup() {
}
teardown() {
dokku openresty:set --global log-level >/dev/null 2>&1 || true
global_teardown
destroy_app
dokku openresty:stop
@@ -151,6 +152,66 @@ teardown() {
assert_output_exists
}
@test "(openresty:report) --global log-level raw vs computed" {
run /bin/bash -c "dokku openresty:report --global --openresty-global-log-level"
echo "output: $output"
echo "status: $status"
assert_success
assert_output ""
run /bin/bash -c "dokku openresty:report --global --openresty-computed-log-level"
echo "output: $output"
echo "status: $status"
assert_success
assert_output "ERROR"
run /bin/bash -c "dokku openresty:set --global log-level DEBUG"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "dokku openresty:report --global --openresty-global-log-level"
echo "output: $output"
echo "status: $status"
assert_success
assert_output "DEBUG"
run /bin/bash -c "dokku openresty:report --global --openresty-computed-log-level"
echo "output: $output"
echo "status: $status"
assert_success
assert_output "DEBUG"
run /bin/bash -c "dokku openresty:report --global --format json | jq -r '.\"global-log-level\"'"
echo "output: $output"
echo "status: $status"
assert_success
assert_output "DEBUG"
run /bin/bash -c "dokku openresty:report --global --format json | jq -r '.\"computed-log-level\"'"
echo "output: $output"
echo "status: $status"
assert_success
assert_output "DEBUG"
run /bin/bash -c "dokku openresty:set --global log-level"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "dokku openresty:report --global --openresty-global-log-level"
echo "output: $output"
echo "status: $status"
assert_success
assert_output ""
run /bin/bash -c "dokku openresty:report --global --openresty-computed-log-level"
echo "output: $output"
echo "status: $status"
assert_success
assert_output "ERROR"
}
@test "(openresty) global-only keys" {
for key in allowed-letsencrypt-domains-func-base64 image log-level letsencrypt-email letsencrypt-server; do
run /bin/bash -c "dokku openresty:set $TEST_APP $key somevalue"

150
tests/unit/proxy.bats
View File

@@ -9,6 +9,8 @@ setup() {
}
teardown() {
dokku proxy:set --global proxy-port >/dev/null 2>&1 || true
dokku proxy:set --global proxy-ssl-port >/dev/null 2>&1 || true
destroy_app
[[ -f "$DOKKU_ROOT/VHOST.bak" ]] && mv "$DOKKU_ROOT/VHOST.bak" "$DOKKU_ROOT/VHOST" && chown dokku:dokku "$DOKKU_ROOT/VHOST"
global_teardown
@@ -125,6 +127,154 @@ teardown() {
assert_success
}
@test "(proxy:report) proxy-port raw vs computed vs global" {
run /bin/bash -c "dokku proxy:set --global proxy-port"
assert_success
run /bin/bash -c "dokku proxy:set $TEST_APP proxy-port"
assert_success
run /bin/bash -c "dokku proxy:report $TEST_APP --format json | jq -r '.\"proxy-proxy-port\"'"
assert_success
assert_output ""
run /bin/bash -c "dokku proxy:report $TEST_APP --format json | jq -r '.\"proxy-global-proxy-port\"'"
assert_success
assert_output ""
run /bin/bash -c "dokku proxy:report $TEST_APP --format json | jq -r '.\"proxy-computed-proxy-port\"'"
assert_success
assert_output ""
run /bin/bash -c "dokku proxy:set --global proxy-port 5000"
assert_success
run /bin/bash -c "dokku proxy:report $TEST_APP --format json | jq -r '.\"proxy-global-proxy-port\"'"
assert_success
assert_output "5000"
run /bin/bash -c "dokku proxy:report $TEST_APP --format json | jq -r '.\"proxy-computed-proxy-port\"'"
assert_success
assert_output "5000"
run /bin/bash -c "dokku proxy:set $TEST_APP proxy-port 6000"
assert_success
run /bin/bash -c "dokku proxy:report $TEST_APP --format json | jq -r '.\"proxy-proxy-port\"'"
assert_success
assert_output "6000"
run /bin/bash -c "dokku proxy:report $TEST_APP --format json | jq -r '.\"proxy-global-proxy-port\"'"
assert_success
assert_output "5000"
run /bin/bash -c "dokku proxy:report $TEST_APP --format json | jq -r '.\"proxy-computed-proxy-port\"'"
assert_success
assert_output "6000"
run /bin/bash -c "dokku proxy:set $TEST_APP proxy-port"
assert_success
run /bin/bash -c "dokku proxy:set --global proxy-port"
assert_success
}
@test "(proxy:report) proxy-ssl-port raw vs computed vs global" {
run /bin/bash -c "dokku proxy:set --global proxy-ssl-port"
assert_success
run /bin/bash -c "dokku proxy:set $TEST_APP proxy-ssl-port"
assert_success
run /bin/bash -c "dokku proxy:report $TEST_APP --format json | jq -r '.\"proxy-proxy-ssl-port\"'"
assert_success
assert_output ""
run /bin/bash -c "dokku proxy:report $TEST_APP --format json | jq -r '.\"proxy-global-proxy-ssl-port\"'"
assert_success
assert_output ""
run /bin/bash -c "dokku proxy:report $TEST_APP --format json | jq -r '.\"proxy-computed-proxy-ssl-port\"'"
assert_success
assert_output ""
run /bin/bash -c "dokku proxy:set --global proxy-ssl-port 5443"
assert_success
run /bin/bash -c "dokku proxy:report $TEST_APP --format json | jq -r '.\"proxy-global-proxy-ssl-port\"'"
assert_success
assert_output "5443"
run /bin/bash -c "dokku proxy:report $TEST_APP --format json | jq -r '.\"proxy-computed-proxy-ssl-port\"'"
assert_success
assert_output "5443"
run /bin/bash -c "dokku proxy:set $TEST_APP proxy-ssl-port 6443"
assert_success
run /bin/bash -c "dokku proxy:report $TEST_APP --format json | jq -r '.\"proxy-proxy-ssl-port\"'"
assert_success
assert_output "6443"
run /bin/bash -c "dokku proxy:report $TEST_APP --format json | jq -r '.\"proxy-global-proxy-ssl-port\"'"
assert_success
assert_output "5443"
run /bin/bash -c "dokku proxy:report $TEST_APP --format json | jq -r '.\"proxy-computed-proxy-ssl-port\"'"
assert_success
assert_output "6443"
run /bin/bash -c "dokku proxy:set $TEST_APP proxy-ssl-port"
assert_success
run /bin/bash -c "dokku proxy:set --global proxy-ssl-port"
assert_success
}
@test "(proxy:report) disabled raw and computed match disabled state" {
run /bin/bash -c "dokku proxy:report $TEST_APP --format json | jq -r '.\"proxy-disabled\"'"
assert_success
assert_output ""
run /bin/bash -c "dokku proxy:report $TEST_APP --format json | jq -r '.\"proxy-computed-disabled\"'"
assert_success
assert_output "false"
run /bin/bash -c "dokku proxy:report $TEST_APP --format json | jq -r '.\"proxy-enabled\"'"
assert_success
assert_output "true"
run /bin/bash -c "dokku proxy:disable $TEST_APP"
assert_success
run /bin/bash -c "dokku proxy:report $TEST_APP --format json | jq -r '.\"proxy-disabled\"'"
assert_success
assert_output "true"
run /bin/bash -c "dokku proxy:report $TEST_APP --format json | jq -r '.\"proxy-computed-disabled\"'"
assert_success
assert_output "true"
run /bin/bash -c "dokku proxy:report $TEST_APP --format json | jq -r '.\"proxy-enabled\"'"
assert_success
assert_output "false"
run /bin/bash -c "dokku proxy:enable $TEST_APP"
assert_success
run /bin/bash -c "dokku proxy:report $TEST_APP --format json | jq -r '.\"proxy-disabled\"'"
assert_success
assert_output ""
run /bin/bash -c "dokku proxy:report $TEST_APP --format json | jq -r '.\"proxy-computed-disabled\"'"
assert_success
assert_output "false"
run /bin/bash -c "dokku proxy:report $TEST_APP --format json | jq -r '.\"proxy-enabled\"'"
assert_success
assert_output "true"
}
@test "(proxy:set) invalid port mapping set" {
run /bin/bash -c "dokku proxy:set $TEST_APP http:80:80"
echo "output: $output"

108
tests/unit/ps-general-1.bats
View File

@@ -93,6 +93,114 @@ teardown() {
assert_success
}
@test "(ps:set) skip-deploy raw/global/computed" {
run /bin/bash -c "dokku ps:report $TEST_APP --format json | jq -r '.\"ps-computed-skip-deploy\"'"
echo "output: $output"
echo "status: $status"
assert_output "false"
assert_success
run /bin/bash -c "dokku ps:set --global skip-deploy true"
assert_success
run /bin/bash -c "dokku ps:report $TEST_APP --format json | jq -r '.\"ps-global-skip-deploy\"'"
assert_success
assert_output "true"
run /bin/bash -c "dokku ps:report $TEST_APP --format json | jq -r '.\"ps-computed-skip-deploy\"'"
assert_success
assert_output "true"
run /bin/bash -c "dokku ps:report $TEST_APP --format json | jq -r '.\"ps-skip-deploy\"'"
assert_success
assert_output ""
run /bin/bash -c "dokku ps:set $TEST_APP skip-deploy false"
assert_success
run /bin/bash -c "dokku ps:report $TEST_APP --format json | jq -r '.\"ps-skip-deploy\"'"
assert_success
assert_output "false"
run /bin/bash -c "dokku ps:report $TEST_APP --format json | jq -r '.\"ps-global-skip-deploy\"'"
assert_success
assert_output "true"
run /bin/bash -c "dokku ps:report $TEST_APP --format json | jq -r '.\"ps-computed-skip-deploy\"'"
assert_success
assert_output "false"
run /bin/bash -c "dokku ps:set $TEST_APP skip-deploy"
assert_success
run /bin/bash -c "dokku ps:set --global skip-deploy"
assert_success
run /bin/bash -c "dokku ps:report $TEST_APP --format json | jq -r '.\"ps-global-skip-deploy\"'"
assert_success
assert_output ""
run /bin/bash -c "dokku ps:report $TEST_APP --format json | jq -r '.\"ps-computed-skip-deploy\"'"
assert_success
assert_output "false"
}
@test "(ps:set) dockerfile-start-cmd raw and computed" {
run /bin/bash -c "dokku ps:report $TEST_APP --format json | jq -r '.\"ps-dockerfile-start-cmd\"'"
assert_success
assert_output ""
run /bin/bash -c "dokku ps:report $TEST_APP --format json | jq -r '.\"ps-computed-dockerfile-start-cmd\"'"
assert_success
assert_output ""
run /bin/bash -c "dokku ps:set $TEST_APP dockerfile-start-cmd 'node app.js'"
assert_success
run /bin/bash -c "dokku ps:report $TEST_APP --format json | jq -r '.\"ps-dockerfile-start-cmd\"'"
assert_success
assert_output "node app.js"
run /bin/bash -c "dokku ps:report $TEST_APP --format json | jq -r '.\"ps-computed-dockerfile-start-cmd\"'"
assert_success
assert_output "node app.js"
run /bin/bash -c "dokku ps:set $TEST_APP dockerfile-start-cmd"
assert_success
run /bin/bash -c "dokku ps:report $TEST_APP --format json | jq -r '.\"ps-dockerfile-start-cmd\"'"
assert_success
assert_output ""
}
@test "(ps:set) start-cmd raw and computed" {
run /bin/bash -c "dokku ps:report $TEST_APP --format json | jq -r '.\"ps-start-cmd\"'"
assert_success
assert_output ""
run /bin/bash -c "dokku ps:report $TEST_APP --format json | jq -r '.\"ps-computed-start-cmd\"'"
assert_success
assert_output ""
run /bin/bash -c "dokku ps:set $TEST_APP start-cmd 'bundle exec rails server'"
assert_success
run /bin/bash -c "dokku ps:report $TEST_APP --format json | jq -r '.\"ps-start-cmd\"'"
assert_success
assert_output "bundle exec rails server"
run /bin/bash -c "dokku ps:report $TEST_APP --format json | jq -r '.\"ps-computed-start-cmd\"'"
assert_success
assert_output "bundle exec rails server"
run /bin/bash -c "dokku ps:set $TEST_APP start-cmd"
assert_success
run /bin/bash -c "dokku ps:report $TEST_APP --format json | jq -r '.\"ps-start-cmd\"'"
assert_success
assert_output ""
}
@test "(ps:scale) procfile commands extraction" {
source "$PLUGIN_CORE_AVAILABLE_PATH/ps/functions"
cat <<EOF >"$DOKKU_LIB_ROOT/data/ps/$TEST_APP/Procfile"

38
tests/unit/scheduler-k3s-report.bats
View File

@@ -7,7 +7,7 @@ setup() {
}
teardown() {
for prop in deploy-timeout image-pull-secrets ingress-class kubeconfig-path kube-context kustomize-root-path namespace network-interface rollback-on-failure shm-size; do
for prop in deploy-timeout image-pull-secrets ingress-class kubeconfig-path kube-context kustomize-root-path namespace network-interface rollback-on-failure shm-size token; do
dokku scheduler-k3s:set --global "$prop" >/dev/null 2>/dev/null || true
done
global_teardown
@@ -122,3 +122,39 @@ assert_k3s_global_unset_set() {
assert_success
assert_output ""
}
@test "(scheduler-k3s:report --global) token masked in stdout but exposed via json or explicit flag" {
run /bin/bash -c "dokku scheduler-k3s:set --global token"
assert_success
run /bin/bash -c "dokku scheduler-k3s:report --global --format json | jq -e 'has(\"scheduler-k3s-global-token\")'"
assert_success
assert_output "true"
run /bin/bash -c "dokku scheduler-k3s:report --global --format json | jq -r '.\"scheduler-k3s-global-token\"'"
assert_success
assert_output ""
run /bin/bash -c "dokku scheduler-k3s:report --global --scheduler-k3s-global-token"
assert_success
assert_output ""
run /bin/bash -c "dokku scheduler-k3s:set --global token sometoken"
assert_success
run /bin/bash -c "dokku scheduler-k3s:report --global"
assert_success
assert_output_contains "*******"
assert_output_not_contains "sometoken"
run /bin/bash -c "dokku scheduler-k3s:report --global --format json | jq -r '.\"scheduler-k3s-global-token\"'"
assert_success
assert_output "sometoken"
run /bin/bash -c "dokku scheduler-k3s:report --global --scheduler-k3s-global-token"
assert_success
assert_output "sometoken"
run /bin/bash -c "dokku scheduler-k3s:set --global token"
assert_success
}

50
tests/unit/scheduler.bats
View File

@@ -9,6 +9,7 @@ setup() {
teardown() {
dokku scheduler:set --global selected >/dev/null 2>&1 || true
dokku scheduler:set --global shell >/dev/null 2>&1 || true
destroy_app
global_teardown
}
@@ -76,6 +77,55 @@ teardown() {
assert_success
}
@test "(scheduler:report) shell raw vs computed vs global" {
run /bin/bash -c "dokku scheduler:set --global shell"
assert_success
run /bin/bash -c "dokku scheduler:report $TEST_APP --format json | jq -r '.\"scheduler-shell\"'"
assert_success
assert_output ""
run /bin/bash -c "dokku scheduler:report $TEST_APP --format json | jq -r '.\"scheduler-global-shell\"'"
assert_success
assert_output ""
run /bin/bash -c "dokku scheduler:report $TEST_APP --format json | jq -r '.\"scheduler-computed-shell\"'"
assert_success
assert_output ""
run /bin/bash -c "dokku scheduler:set --global shell sh"
assert_success
run /bin/bash -c "dokku scheduler:report $TEST_APP --format json | jq -r '.\"scheduler-global-shell\"'"
assert_success
assert_output "sh"
run /bin/bash -c "dokku scheduler:report $TEST_APP --format json | jq -r '.\"scheduler-computed-shell\"'"
assert_success
assert_output "sh"
run /bin/bash -c "dokku scheduler:set $TEST_APP shell bash"
assert_success
run /bin/bash -c "dokku scheduler:report $TEST_APP --format json | jq -r '.\"scheduler-shell\"'"
assert_success
assert_output "bash"
run /bin/bash -c "dokku scheduler:report $TEST_APP --format json | jq -r '.\"scheduler-global-shell\"'"
assert_success
assert_output "sh"
run /bin/bash -c "dokku scheduler:report $TEST_APP --format json | jq -r '.\"scheduler-computed-shell\"'"
assert_success
assert_output "bash"
run /bin/bash -c "dokku scheduler:set $TEST_APP shell"
assert_success
run /bin/bash -c "dokku scheduler:set --global shell"
assert_success
}
@test "(scheduler:report) --global --format json" {
run /bin/bash -c "dokku scheduler:set --global selected"
assert_success

8
tests/unit/traefik.bats
View File

@@ -549,7 +549,13 @@ teardown() {
echo "output: $output"
echo "status: $status"
assert_success
assert_output "*******"
assert_output "test@example.com"
run /bin/bash -c "dokku traefik:report $TEST_APP --traefik-dns-provider-cf_api_key"
echo "output: $output"
echo "status: $status"
assert_success
assert_output "secret-key"
run /bin/bash -c "dokku traefik:set --global dns-provider-cf_api_email"
echo "output: $output"