fix: clean up stale extracted files on deploy

A failed deploy could leave a non-empty extraction directory behind, such as the scheduler-k3s `kustomization` directory, which caused every following deploy to fail. Leftovers from previous deploys are now fully removed, removing a directory such as `config/kustomize` from the repository now removes the stored copy, and openresty includes now persist across restarts.
This commit is contained in:
Jose Diaz-Gonzalez committed 2026-10-23 14:37:49 -04:00
1 parent a73e6b67bc
commit 0690a9b655
12 files changed
+315 -41

No files matched your search

+19
View File
@@ -129,3 +129,22 @@ teardown() {
docker image rm dokku-test/$TEST_APP:latest dokku-test/$TEST_APP:v2 || true
}
@test "(nginx-vhosts) deploy removes stale nginx.conf.sigil files" {
local DATA_DIR="/var/lib/dokku/data/nginx-vhosts/app-$TEST_APP"
mkdir -p "$DATA_DIR"
echo "# stale" >"$DATA_DIR/nginx.conf.sigil.99999999"
touch "$DATA_DIR/nginx.conf.sigil.99999998.missing"
chown -R dokku:dokku "$DATA_DIR"
run deploy_app python dokku@$DOKKU_DOMAIN:$TEST_APP
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "find $DATA_DIR -maxdepth 1 -name 'nginx.conf.sigil.*'"
echo "output: $output"
echo "status: $status"
assert_success
assert_output_not_exists
}
+136
View File
@@ -0,0 +1,136 @@
#!/usr/bin/env bats
load test_helper
setup() {
global_setup
dokku nginx:stop
dokku openresty:set --global letsencrypt-server https://acme-staging-v02.api.letsencrypt.org/directory
dokku openresty:set --global letsencrypt-email
dokku openresty:start
create_app
}
teardown() {
global_teardown
destroy_app
dokku openresty:stop
dokku nginx:start
}
@test "(openresty) includes persist across ps:restart" {
run /bin/bash -c "dokku proxy:set $TEST_APP openresty"
echo "output: $output"
echo "status: $status"
assert_success
run deploy_app python dokku@$DOKKU_DOMAIN:$TEST_APP add_openresty_include
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "docker inspect $TEST_APP.web.1 --format '{{ index .Config.Labels \"openresty.include-http-example.conf\" }}'"
echo "output: $output"
echo "status: $status"
assert_success
assert_output "IyBmb3JjZSB0aGUgY2hhcmFjdGVyIHNldCB0byB1dGYtOApjaGFyc2V0IFVURi04Owo="
run /bin/bash -c "dokku ps:restart $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "docker inspect $TEST_APP.web.1 --format '{{ index .Config.Labels \"openresty.include-http-example.conf\" }}'"
echo "output: $output"
echo "status: $status"
assert_success
assert_output "IyBmb3JjZSB0aGUgY2hhcmFjdGVyIHNldCB0byB1dGYtOApjaGFyc2V0IFVURi04Owo="
run /bin/bash -c "docker inspect $TEST_APP.web.1 --format '{{ index .Config.Labels \"openresty.include-location-http-example.conf\" }}'"
echo "output: $output"
echo "status: $status"
assert_success
assert_output "IyBsb2NhdGlvbi1ibG9jawo="
}
@test "(openresty) includes are removed when deleted from the repo" {
local DATA_DIR="/var/lib/dokku/data/openresty-vhosts/app-$TEST_APP"
local CUSTOM_TMP=$(mktemp -d "/tmp/${DOKKU_DOMAIN}.XXXXX")
trap 'popd &>/dev/null || true; rm -rf "$CUSTOM_TMP"' INT TERM
run /bin/bash -c "dokku proxy:set $TEST_APP openresty"
echo "output: $output"
echo "status: $status"
assert_success
CUSTOM_TMP="$CUSTOM_TMP" run deploy_app python dokku@$DOKKU_DOMAIN:$TEST_APP add_openresty_include
echo "output: $output"
echo "status: $status"
assert_success
run git -C "$CUSTOM_TMP" rm -r openresty
echo "output: $output"
echo "status: $status"
assert_success
run git -C "$CUSTOM_TMP" commit -m 'Remove openresty includes'
echo "output: $output"
echo "status: $status"
assert_success
run git -C "$CUSTOM_TMP" push target master:master
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "docker inspect $TEST_APP.web.1 --format '{{ index .Config.Labels \"openresty.include-http-example.conf\" }}'"
echo "output: $output"
echo "status: $status"
assert_success
assert_output_not_exists
run /bin/bash -c "find $DATA_DIR -maxdepth 1 -name 'openresty-*-includes*'"
echo "output: $output"
echo "status: $status"
assert_success
assert_output_not_exists
rm -rf "$CUSTOM_TMP"
}
@test "(openresty) deploy removes stale include markers and directories" {
local DATA_DIR="/var/lib/dokku/data/openresty-vhosts/app-$TEST_APP"
mkdir -p "$DATA_DIR/openresty-http-includes.99999999" "$DATA_DIR/openresty-location-includes.99999999"
echo "charset UTF-8;" >"$DATA_DIR/openresty-http-includes.99999999/example.conf"
echo "# location-block" >"$DATA_DIR/openresty-location-includes.99999999/example.conf"
touch "$DATA_DIR/openresty-http-includes.99999998.missing" "$DATA_DIR/openresty-location-includes.99999998.missing"
chown -R dokku:dokku "$DATA_DIR"
run /bin/bash -c "dokku proxy:set $TEST_APP openresty"
echo "output: $output"
echo "status: $status"
assert_success
run deploy_app python dokku@$DOKKU_DOMAIN:$TEST_APP
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "find $DATA_DIR -maxdepth 1 -name 'openresty-*-includes*'"
echo "output: $output"
echo "status: $status"
assert_success
assert_output_not_exists
}
add_openresty_include() {
local APP="$1"
local APP_REPO_DIR="$2"
[[ -z "$APP" ]] && local APP="$TEST_APP"
mkdir -p "$APP_REPO_DIR/openresty/http-includes"
echo "# force the character set to utf-8" >>"$APP_REPO_DIR/openresty/http-includes/example.conf"
echo "charset UTF-8;" >>"$APP_REPO_DIR/openresty/http-includes/example.conf"
mkdir -p "$APP_REPO_DIR/openresty/http-location-includes"
echo "# location-block" >>"$APP_REPO_DIR/openresty/http-location-includes/example.conf"
}
+25
View File
@@ -588,6 +588,31 @@ teardown() {
assert_output_contains "Unable to parse command"
}
@test "(scheduler-docker-local) deploy removes stale CHECKS files" {
local DATA_DIR="/var/lib/dokku/data/scheduler-docker-local/$TEST_APP"
run create_app
echo "output: $output"
echo "status: $status"
assert_success
mkdir -p "$DATA_DIR"
echo "/ python/http.server" >"$DATA_DIR/CHECKS.99999999"
touch "$DATA_DIR/CHECKS.99999998.missing"
chown -R dokku:dokku "$DATA_DIR"
run deploy_app python dokku@$DOKKU_DOMAIN:$TEST_APP
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "find $DATA_DIR -maxdepth 1 -name 'CHECKS.*'"
echo "output: $output"
echo "status: $status"
assert_success
assert_output_not_exists
}
quoted_procfile_callback() {
local APP="$1"
local APP_REPO_DIR="$2"
+88
View File
@@ -0,0 +1,88 @@
#!/usr/bin/env bats
load test_helper
setup() {
global_setup
create_app
}
teardown() {
destroy_app
global_teardown
}
@test "(scheduler-k3s) [kustomize] deploy removes a stale non-empty kustomization directory" {
local DATA_DIR="/var/lib/dokku/data/scheduler-k3s/$TEST_APP"
mkdir -p "$DATA_DIR/kustomization.99999999"
echo "kind: Kustomization" >"$DATA_DIR/kustomization.99999999/kustomization.yaml"
chown -R dokku:dokku "$DATA_DIR"
run deploy_app python dokku@$DOKKU_DOMAIN:$TEST_APP
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "find $DATA_DIR -maxdepth 1 -name 'kustomization.*'"
echo "output: $output"
echo "status: $status"
assert_success
assert_output_not_exists
}
@test "(scheduler-k3s) [kustomize] deploy removes the stored kustomization when the repo no longer has one" {
local DATA_DIR="/var/lib/dokku/data/scheduler-k3s/$TEST_APP"
local CUSTOM_TMP=$(mktemp -d "/tmp/${DOKKU_DOMAIN}.XXXXX")
trap 'popd &>/dev/null || true; rm -rf "$CUSTOM_TMP"' INT TERM
CUSTOM_TMP="$CUSTOM_TMP" run deploy_app python dokku@$DOKKU_DOMAIN:$TEST_APP inject_kustomization_yaml
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "test -f $DATA_DIR/kustomization/kustomization.yaml"
echo "output: $output"
echo "status: $status"
assert_success
run git -C "$CUSTOM_TMP" rm -r config/kustomize
echo "output: $output"
echo "status: $status"
assert_success
run git -C "$CUSTOM_TMP" commit -m 'Remove kustomization'
echo "output: $output"
echo "status: $status"
assert_success
run git -C "$CUSTOM_TMP" push target master:master
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "test -e $DATA_DIR/kustomization"
echo "output: $output"
echo "status: $status"
assert_failure
run /bin/bash -c "find $DATA_DIR -maxdepth 1 -name 'kustomization.*'"
echo "output: $output"
echo "status: $status"
assert_success
assert_output_not_exists
rm -rf "$CUSTOM_TMP"
}
inject_kustomization_yaml() {
local APP="$1"
local APP_REPO_DIR="$2"
[[ -z "$APP" ]] && local APP="$TEST_APP"
mkdir -p "$APP_REPO_DIR/config/kustomize"
cat <<EOF >"$APP_REPO_DIR/config/kustomize/kustomization.yaml"
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization
resources:
- rendered.yaml
EOF
}