Files
dokku/tests/unit/checks.bats
Jose Diaz-Gonzalez 1308e21947 feat: migrate environment variables to plugin properties
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
2026-04-25 05:11:07 -04:00

289 lines
7.5 KiB
Bash

#!/usr/bin/env bats
load test_helper
#!/usr/bin/env bats
load test_helper
setup() {
global_setup
create_app
}
teardown() {
destroy_app
global_teardown
}
@test "(checks) checks:help" {
run /bin/bash -c "dokku checks"
echo "output: $output"
echo "status: $status"
assert_output_contains "Manage zero-downtime settings"
help_output="$output"
run /bin/bash -c "dokku checks:help"
echo "output: $output"
echo "status: $status"
assert_output_contains "Manage zero-downtime settings"
assert_output "$help_output"
}
@test "(checks) checks:disable" {
run /bin/bash -c "dokku checks:disable $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "dokku checks:report $TEST_APP --checks-disabled-list"
echo "output: $output"
echo "status: $status"
assert_output "_all_"
}
@test "(checks) checks:disable -> checks:enable" {
run /bin/bash -c "dokku checks:disable $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
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 checks:report $TEST_APP --checks-skipped-list"
echo "output: $output"
echo "status: $status"
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 checks:report $TEST_APP --checks-disabled-list"
echo "output: $output"
echo "status: $status"
assert_output "none"
run /bin/bash -c "dokku checks:report $TEST_APP --checks-skipped-list"
echo "output: $output"
echo "status: $status"
assert_output "none"
}
@test "(checks) checks:disable -> checks:skip" {
run /bin/bash -c "dokku checks:disable $TEST_APP web,worker,urgentworker,notifications"
echo "output: $output"
echo "status: $status"
assert_success
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 checks:report $TEST_APP --checks-skipped-list"
echo "output: $output"
echo "status: $status"
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 checks:report $TEST_APP --checks-skipped-list"
echo "output: $output"
echo "status: $status"
assert_output "urgentworker,worker"
run /bin/bash -c "dokku checks:report $TEST_APP --checks-disabled-list"
echo "output: $output"
echo "status: $status"
assert_output "web,notifications"
}
@test "(checks) checks:skip" {
run /bin/bash -c "dokku checks:skip $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "dokku checks:report $TEST_APP --checks-skipped-list"
echo "output: $output"
echo "status: $status"
assert_output "_all_"
}
@test "(checks) checks:skip -> checks:enable" {
run /bin/bash -c "dokku checks:skip $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
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 checks:report $TEST_APP --checks-disabled-list"
echo "output: $output"
echo "status: $status"
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 checks:report $TEST_APP --checks-skipped-list"
echo "output: $output"
echo "status: $status"
assert_output "none"
run /bin/bash -c "dokku checks:report $TEST_APP --checks-disabled-list"
echo "output: $output"
echo "status: $status"
assert_output "none"
}
@test "(checks) checks:skip -> checks:disable" {
run /bin/bash -c "dokku checks:skip $TEST_APP web,worker,urgentworker,notifications"
echo "output: $output"
echo "status: $status"
assert_success
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 checks:report $TEST_APP --checks-disabled-list"
echo "output: $output"
echo "status: $status"
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 checks:report $TEST_APP --checks-disabled-list"
echo "output: $output"
echo "status: $status"
assert_output "urgentworker,worker"
run /bin/bash -c "dokku checks:report $TEST_APP --checks-skipped-list"
echo "output: $output"
echo "status: $status"
assert_output "web,notifications"
}
@test "(checks) checks:run" {
run /bin/bash -c "dokku ps:scale $TEST_APP worker=1"
echo "output: $output"
echo "status: $status"
assert_success
run deploy_app
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "dokku checks:run $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "dokku checks:run $TEST_APP web"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "dokku checks:run $TEST_APP web,worker"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "dokku checks:run $TEST_APP worker.1"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "dokku checks:run $TEST_APP web2"
echo "output: $output"
echo "status: $status"
assert_failure
run /bin/bash -c "dokku checks:run $TEST_APP web.2"
echo "output: $output"
echo "status: $status"
assert_failure
}
@test "(checks) checks:disable -> app start with missing containers" {
run /bin/bash -c "dokku ps:scale $TEST_APP worker=1"
echo "output: $output"
echo "status: $status"
assert_success
run deploy_app
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "dokku checks:disable $TEST_APP worker"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "dokku ps:stop $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "dokku cleanup"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "dokku ps:start $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
}
@test "(checks) checks:templated" {
run /bin/bash -c "dokku config:set $TEST_APP HEALTHCHECK_ENDPOINT=/healthcheck"
echo "output: $output"
echo "status: $status"
assert_success
run deploy_app nodejs-express dokku@$DOKKU_DOMAIN:$TEST_APP template_checks_file
echo "output: $output"
echo "status: $status"
assert_output_contains "/healthcheck"
assert_success
}
@test "(checks) listening checks" {
if [[ "$TERM_PROGRAM" == "vscode" ]]; then
skip "environment must be running in the host namespace"
fi
run /bin/bash -c "dokku config:set $TEST_APP ALT_PORT=5001"
echo "output: $output"
echo "status: $status"
assert_success
run deploy_app
echo "output: $output"
echo "status: $status"
assert_failure
assert_output_contains "Failure in name='port listening check': container listening on expected IPv4 interface with an unexpected port: expected=5000 actual=5001"
assert_output_contains "Running healthcheck name='port listening check' attempts=3 port=5000 retries=2 timeout=5 type='listening' wait=5"
}