From e1ba7fdabb8045858150cd129d5ede8e1bacd02b Mon Sep 17 00:00:00 2001 From: Sulthan Zaki Date: Sun, 23 Aug 2026 13:14:49 +0700 Subject: [PATCH] fix: pgtest left an anonymous volume behind on every run (#175) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ## Problem `go test ./...` leaked one Docker volume per test package. `pgtest.Main` tore its throwaway container down with `docker rm -f` — no `-v`. The `postgres:17-alpine` image declares a `VOLUME` for `/var/lib/postgresql/data`, and an explicit `rm` without `-v` orphans that anonymous volume even though the container was created with `--rm`. Found in passing: a 13-hour-old orphaned pgtest container (AutoRemove, `fsync=off`, one mount) still running from a killed test binary — the same leak's other half. Removed on the dev machine. ## Change - `backend/internal/pgtest/pgtest.go`: `-v` on all three `docker rm -f` teardown sites (`Main`'s defer, and both error paths in `start`). - `AGENTS.md`: cleanup expectation under Commands — `docker compose down -v` for a stack, `docker rm -f -v` for a hand-run container, then check `docker volume ls` and `docker system df`. Explicitly out of bounds: removing the user's `postgres-data` volume, or a blanket `docker system prune` of their images and build cache. ## Verification `docker volume ls` snapshot diffed across a real `./internal/store` run: no new volumes, `docker system df` reports 0 local volumes. Reviewed-on: https://gitea.violetcrown.my.id/sulthan/mangaBookmark/pulls/175 Co-authored-by: Sulthan Zaki Co-committed-by: Sulthan Zaki --- AGENTS.md | 9 +++++++++ backend/internal/pgtest/pgtest.go | 8 +++++--- 2 files changed, 14 insertions(+), 3 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 7ac1467..5548bfd 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -50,6 +50,15 @@ Backend (`cd backend`): Local stack: `docker compose up` (bookmark-api + postgres only; `postgres-data` named volume, `restart: unless-stopped`). No browser — without `BROWSER_WS_URL` the poller logs and skips kagane and comix. To run one: `cd chrome && BROWSER_BIND_ADDR=172.17.0.1 docker compose up -d --build`, then `BROWSER_WS_URL=ws://172.17.0.1:9222` in the root `.env` (bridge gateway, so the API container can name it by IP). +**Clean up Docker after testing.** Storage on the dev machine is scarce, so +anything you started for a test you also tear down before calling the work +done: `docker compose down -v` for a stack you brought up, `docker rm -f -v` +for a container you ran by hand (`-v`, or the image's anonymous data volume +survives). Then check `docker volume ls` and `docker system df` for leftovers +and reclaim them — a dangling volume nobody notices is the leak that fills the +disk. Never remove the `postgres-data` volume of a stack the user is actually +running, and never blanket-`docker system prune` their images or build cache. + Live CDP proof (needs that browser and network, skipped otherwise): `SMOKE_BROWSER_WS_URL=ws://: go test -run 'TestSmokeKagane|TestSmokeComix' ./internal/latest` — fetches a real kagane and comix cover and chapter list. A red run means the challenge is diff --git a/backend/internal/pgtest/pgtest.go b/backend/internal/pgtest/pgtest.go index b4271a7..bed98ff 100644 --- a/backend/internal/pgtest/pgtest.go +++ b/backend/internal/pgtest/pgtest.go @@ -40,7 +40,9 @@ func Main(m *testing.M) int { fmt.Println("pgtest:", err) return 1 } - defer exec.Command("docker", "rm", "-f", id).Run() + // -v: the postgres image declares a VOLUME, so an explicit rm without it + // leaves the anonymous data volume behind on every test run. + defer exec.Command("docker", "rm", "-f", "-v", id).Run() adminURL = url return m.Run() @@ -85,7 +87,7 @@ func start() (id, url string, err error) { port, err := exec.Command("docker", "port", id, "5432/tcp").Output() if err != nil { - exec.Command("docker", "rm", "-f", id).Run() + exec.Command("docker", "rm", "-f", "-v", id).Run() return "", "", fmt.Errorf("docker port: %w", err) } // "0.0.0.0:32768" (and possibly a second, IPv6 line); the port is all we want. @@ -94,7 +96,7 @@ func start() (id, url string, err error) { first[strings.LastIndex(first, ":")+1:]) if err := waitReady(url); err != nil { - exec.Command("docker", "rm", "-f", id).Run() + exec.Command("docker", "rm", "-f", "-v", id).Run() return "", "", err } return id, url, nil