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

feat: migrate environment variables to plugin properties

Browse Source 
Standardize how environment variables are migrated to properties during
install triggers and migrate all remaining DOKKU_* config vars to their
appropriate plugin properties.

Adds a reusable MigrateConfigToProperties() function in the common
package with Transform callback and ListProperty support, plus a
migrate-config-to-property subcommand for the prop binary so shell
plugins can use the same code path.

Migrated variables and their new property owners:
- DOKKU_APP_PROXY_TYPE/DOKKU_PROXY_TYPE → proxy type
- DOKKU_DISABLE_PROXY → proxy disabled
- DOKKU_PROXY_PORT → ports proxy-port
- DOKKU_PROXY_SSL_PORT → ports proxy-ssl-port
- DOKKU_APP_RESTORE → ps restore
- DOKKU_SKIP_DEPLOY → ps skip-deploy
- DOKKU_START_CMD → ps start-cmd
- DOKKU_DOCKERFILE_START_CMD → ps dockerfile-start-cmd
- DOKKU_DISABLE_APP_AUTOCREATION → apps disable-autocreation
- DOKKU_APP_SHELL → scheduler shell
- DOKKU_SKIP_CLEANUP → builder skip-cleanup
- DOKKU_CHECKS_DISABLED → checks disabled
- DOKKU_CHECKS_SKIPPED → checks skipped
- DOKKU_CHECKS_WAIT → checks wait
- DOKKU_CHECKS_TIMEOUT → checks timeout
- DOKKU_CHECKS_ATTEMPTS → checks attempts
- DOKKU_DEFAULT_CHECKS_WAIT → checks default-wait
- DOKKU_SKIP_ALL_CHECKS → checks disabled (legacy)
- DOKKU_SKIP_DEFAULT_CHECKS → checks skipped (legacy)

Also refactors existing bespoke migration loops in scheduler, ports, ps,
builder, and nginx-vhosts plugins to use the standardized utility.

Removes DOKKU_PARALLEL_ARGUMENTS from documentation (unused in core).
Deprecates fn-migrate-config-to-property bash function.

closes #1558
This commit is contained in:
Jose Diaz-Gonzalez
2026-04-25 05:11:07 -04:00
parent 71ec612fbd
commit 1308e21947
45 changed files with 604 additions and 468 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
tests/unit/apps_1.bats
View File

@@ -113,7 +113,7 @@ teardown() {
}
@test "(apps) app autocreate disabled" {
run /bin/bash -c "dokku config:set --no-restart --global DOKKU_DISABLE_APP_AUTOCREATION='true'"
run /bin/bash -c "dokku apps:set --global disable-autocreation true"
echo "output: $output"
echo "status: $status"
assert_success
@@ -122,7 +122,7 @@ teardown() {
echo "output: $output"
echo "status: $status"
assert_failure
run /bin/bash -c "dokku config:unset --no-restart --global DOKKU_DISABLE_APP_AUTOCREATION"
run /bin/bash -c "dokku apps:set --global disable-autocreation"
}
@test "(apps) apps:destroy" {

6
tests/unit/apps_2.bats
View File

@@ -116,7 +116,7 @@ teardown() {
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "dokku config:set --no-restart $TEST_APP DOKKU_PROXY_SSL_PORT=443"
run /bin/bash -c "dokku ports:set $TEST_APP proxy-ssl-port 443"
echo "output: $output"
echo "status: $status"
assert_success
@@ -132,10 +132,6 @@ teardown() {
echo "output: $output"
echo "status: $status"
assert_output "http 80 5000"
run /bin/bash -c "dokku config:get app-without-ssl DOKKU_PROXY_SSL_PORT"
echo "output: $output"
echo "status: $status"
assert_output_not_exists
run /bin/bash -c "dokku --force apps:destroy app-without-ssl"
echo "output: $output"
echo "status: $status"

52
tests/unit/checks.bats
View File

@@ -36,7 +36,7 @@ teardown() {
echo "status: $status"
assert_success
run /bin/bash -c "dokku config:get $TEST_APP DOKKU_CHECKS_DISABLED"
run /bin/bash -c "dokku checks:report $TEST_APP --checks-disabled-list"
echo "output: $output"
echo "status: $status"
assert_output "_all_"
@@ -48,30 +48,30 @@ teardown() {
echo "status: $status"
assert_success
run /bin/bash -c "dokku config:get $TEST_APP DOKKU_CHECKS_DISABLED"
run /bin/bash -c "dokku checks:report $TEST_APP --checks-disabled-list"
echo "output: $output"
echo "status: $status"
assert_output "_all_"
run /bin/bash -c "dokku config:get $TEST_APP DOKKU_CHECKS_SKIPPED"
run /bin/bash -c "dokku checks:report $TEST_APP --checks-skipped-list"
echo "output: $output"
echo "status: $status"
assert_output_not_exists
assert_output "none"
run /bin/bash -c "dokku checks:enable $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "dokku config:get $TEST_APP DOKKU_CHECKS_DISABLED"
run /bin/bash -c "dokku checks:report $TEST_APP --checks-disabled-list"
echo "output: $output"
echo "status: $status"
assert_output_not_exists
assert_output "none"
run /bin/bash -c "dokku config:get $TEST_APP DOKKU_CHECKS_SKIPPED"
run /bin/bash -c "dokku checks:report $TEST_APP --checks-skipped-list"
echo "output: $output"
echo "status: $status"
assert_output_not_exists
assert_output "none"
}
@test "(checks) checks:disable -> checks:skip" {
@@ -80,27 +80,27 @@ teardown() {
echo "status: $status"
assert_success
run /bin/bash -c "dokku config:get $TEST_APP DOKKU_CHECKS_DISABLED"
run /bin/bash -c "dokku checks:report $TEST_APP --checks-disabled-list"
echo "output: $output"
echo "status: $status"
assert_output "web,worker,urgentworker,notifications"
run /bin/bash -c "dokku config:get $TEST_APP DOKKU_CHECKS_SKIPPED"
run /bin/bash -c "dokku checks:report $TEST_APP --checks-skipped-list"
echo "output: $output"
echo "status: $status"
assert_output_not_exists
assert_output "none"
run /bin/bash -c "dokku checks:skip $TEST_APP urgentworker,worker"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "dokku config:get $TEST_APP DOKKU_CHECKS_SKIPPED"
run /bin/bash -c "dokku checks:report $TEST_APP --checks-skipped-list"
echo "output: $output"
echo "status: $status"
assert_output "urgentworker,worker"
run /bin/bash -c "dokku config:get $TEST_APP DOKKU_CHECKS_DISABLED"
run /bin/bash -c "dokku checks:report $TEST_APP --checks-disabled-list"
echo "output: $output"
echo "status: $status"
assert_output "web,notifications"
@@ -112,7 +112,7 @@ teardown() {
echo "status: $status"
assert_success
run /bin/bash -c "dokku config:get $TEST_APP DOKKU_CHECKS_SKIPPED"
run /bin/bash -c "dokku checks:report $TEST_APP --checks-skipped-list"
echo "output: $output"
echo "status: $status"
assert_output "_all_"
@@ -124,30 +124,30 @@ teardown() {
echo "status: $status"
assert_success
run /bin/bash -c "dokku config:get $TEST_APP DOKKU_CHECKS_SKIPPED"
run /bin/bash -c "dokku checks:report $TEST_APP --checks-skipped-list"
echo "output: $output"
echo "status: $status"
assert_output "_all_"
run /bin/bash -c "dokku config:get $TEST_APP DOKKU_CHECKS_DISABLED"
run /bin/bash -c "dokku checks:report $TEST_APP --checks-disabled-list"
echo "output: $output"
echo "status: $status"
assert_output_not_exists
assert_output "none"
run /bin/bash -c "dokku checks:enable $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "dokku config:get $TEST_APP DOKKU_CHECKS_SKIPPED"
run /bin/bash -c "dokku checks:report $TEST_APP --checks-skipped-list"
echo "output: $output"
echo "status: $status"
assert_output_not_exists
assert_output "none"
run /bin/bash -c "dokku config:get $TEST_APP DOKKU_CHECKS_DISABLED"
run /bin/bash -c "dokku checks:report $TEST_APP --checks-disabled-list"
echo "output: $output"
echo "status: $status"
assert_output_not_exists
assert_output "none"
}
@test "(checks) checks:skip -> checks:disable" {
@@ -156,27 +156,27 @@ teardown() {
echo "status: $status"
assert_success
run /bin/bash -c "dokku config:get $TEST_APP DOKKU_CHECKS_SKIPPED"
run /bin/bash -c "dokku checks:report $TEST_APP --checks-skipped-list"
echo "output: $output"
echo "status: $status"
assert_output "web,worker,urgentworker,notifications"
run /bin/bash -c "dokku config:get $TEST_APP DOKKU_CHECKS_DISABLED"
run /bin/bash -c "dokku checks:report $TEST_APP --checks-disabled-list"
echo "output: $output"
echo "status: $status"
assert_output_not_exists
assert_output "none"
run /bin/bash -c "dokku checks:disable $TEST_APP urgentworker,worker"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "dokku config:get $TEST_APP DOKKU_CHECKS_DISABLED"
run /bin/bash -c "dokku checks:report $TEST_APP --checks-disabled-list"
echo "output: $output"
echo "status: $status"
assert_output "urgentworker,worker"
run /bin/bash -c "dokku config:get $TEST_APP DOKKU_CHECKS_SKIPPED"
run /bin/bash -c "dokku checks:report $TEST_APP --checks-skipped-list"
echo "output: $output"
echo "status: $status"
assert_output "web,notifications"

6
tests/unit/nginx-vhosts_5.bats
View File

@@ -60,9 +60,9 @@ teardown() {
assert_success
}
@test "(nginx-vhosts) proxy:build-config (global DOKKU_PROXY_PORT)" {
@test "(nginx-vhosts) proxy:build-config (global proxy-port)" {
local GLOBAL_PORT=30999
run /bin/bash -c "dokku config:set --global DOKKU_PROXY_PORT=${GLOBAL_PORT}"
run /bin/bash -c "dokku ports:set --global proxy-port ${GLOBAL_PORT}"
echo "output: $output"
echo "status: $status"
assert_success
@@ -74,7 +74,7 @@ teardown() {
check_urls "http://${TEST_APP}.${DOKKU_DOMAIN}:${GLOBAL_PORT}"
assert_http_success "http://${TEST_APP}.${DOKKU_DOMAIN}:${GLOBAL_PORT}"
run /bin/bash -c "dokku config:unset --global DOKKU_PROXY_PORT"
run /bin/bash -c "dokku ports:set --global proxy-port"
echo "output: $output"
echo "status: $status"
assert_success