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

refactor: convert filesystem migration markers to plugin properties

Browse Source 
The docker-options DOCKER_OPTIONS_<PHASE>.migrated sentinels and the storage data/storage-registry/migrations/<app> flag files are now stored as per-app properties (`migrated-<phase>` and `legacy-mounts-migrated` respectively), so they survive a property-store backup/restore and align with the existing `migrated-from-files`, `env-migrated`, and `nginx-conf-sigil-migrated` patterns. The new markers are written only when a non-empty legacy source was actually migrated, distinguishing apps that never had legacy state from apps that did and were drained. A one-cycle upgrade-cycle conversion drains any leftover filesystem sentinels into the new properties and removes the files; for docker-options the conversion deliberately runs before the global `migrated-from-files` short-circuit so installs upgrading from the previous release still get their `.migrated` files converted.
This commit is contained in:
Jose Diaz-Gonzalez
2026-05-23 23:47:58 -04:00
parent 5df399273a
commit b2320121fe
9 changed files with 381 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
tests/unit/docker-options-2.bats
View File

@@ -264,3 +264,4 @@ web: python3 -u web.py
worker: python3 -u worker.py
EOF
}

48
tests/unit/storage.bats
View File

@@ -420,6 +420,13 @@ teardown() {
assert_success
assert_output "1"
# Property marker is set after a successful migration with mounts.
run /bin/bash -c "sudo test -f /var/lib/dokku/config/storage/$TEST_APP/legacy-mounts-migrated"
assert_success
run /bin/bash -c "sudo cat /var/lib/dokku/config/storage/$TEST_APP/legacy-mounts-migrated"
assert_success
assert_output "true"
# Cleanup: unmount + destroy the synthesized legacy entry. We need
# the entry name from list-entries since legacy-<hash> is content-derived.
legacy_name=$(dokku storage:list-entries --format json | jq -r '.[] | select(.name | startswith("legacy-")) | .name' | head -1)
@@ -438,3 +445,44 @@ teardown() {
assert_success
assert_output_contains "deprecated"
}
@test "(storage:migrate) leaves legacy-mounts-migrated unset for apps with no legacy -v lines" {
# Fresh app with no -v lines: storage:migrate must NOT write the
# legacy-mounts-migrated property. Distinguishes "never had legacy
# state" from "had legacy state, drained".
sudo rm -f "/var/lib/dokku/config/storage/$TEST_APP/legacy-mounts-migrated"
run /bin/bash -c "dokku storage:migrate $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "sudo test -f /var/lib/dokku/config/storage/$TEST_APP/legacy-mounts-migrated"
assert_failure
}
@test "(storage:migrate) converts legacy migration flag file into property" {
# Stage an upgrade-from-old-code scenario: a leftover flag file under
# data/storage-registry/migrations/<app>. storage:migrate (which runs
# convertLegacyMigrationFlag before migrateApp) must drain it into
# the property and remove the file.
flag_dir="/var/lib/dokku/data/storage-registry/migrations"
sudo mkdir -p "$flag_dir"
sudo touch "$flag_dir/$TEST_APP"
sudo chown dokku:dokku "$flag_dir/$TEST_APP"
sudo rm -f "/var/lib/dokku/config/storage/$TEST_APP/legacy-mounts-migrated"
run /bin/bash -c "dokku storage:migrate $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "sudo test -f /var/lib/dokku/config/storage/$TEST_APP/legacy-mounts-migrated"
assert_success
run /bin/bash -c "sudo cat /var/lib/dokku/config/storage/$TEST_APP/legacy-mounts-migrated"
assert_success
assert_output "true"
run /bin/bash -c "sudo test -e $flag_dir/$TEST_APP"
assert_failure
}