Gate prune's local-cleanup output on --json, and make make build build (closes #108)
All checks were successful
check / check (push) Successful in 2m16s
All checks were successful
check / check (push) Successful in 2m16s
Closes #110. CleanupLocalSnapshots wrote three prose lines to stdout with no --json awareness, covering every branch, so `vaultik prune --json | jq` failed on any input. -q never helped either: printlnStdout and stdoutf write straight to v.Stdout and never consult v.UI, which is what SetQuiet affects. It now takes *PruneOptions, symmetric with its sibling phase PruneBlobs, and gates all three writes. Threading opts.JSON was chosen over moving the lines to log.Info, because internal/log/log.go defaults the level to Warn: log.Info would not have relocated them to stderr, it would have deleted them from a plain `vaultik prune`, and "Removing stale local record" narrates the deletion of local index rows. The stale-record count is deliberately not added to PruneBlobsResult - every field there is blob-scoped and produced by the phase that runs after this reconciliation, so adding it would change a published --json schema as a side effect of a stream fix. Note for anyone reading the --json contract: under --json the stale-record removal now produces no signal in either stream. stdout is correctly gated, stderr is level-pinned to Warn because --json sets Quiet, and the count is not in the document. That is inherited behaviour - PruneBlobs' own log.Info calls are equally invisible under --json - not something this change introduced, and it is tracked separately. make build exited 0 and produced nothing: .PHONY listed build with no build: rule, and a phony target with no prerequisites and no recipe is considered already satisfied, which turns what would be a hard error into a silent success. In a repo where `make build` is the documented way to build, a caller checking the exit code concluded the build worked. Now `build: vaultik`, verified in both directions - a clean build produces the binary, a deliberately broken one exits non-zero and produces none. All 19 .PHONY names were audited; build was the only one lacking a rule. TestPhonyTargetsAllHaveRules keeps that true for names added later, so the class is closed rather than the instance.
This commit was merged in pull request #111.
This commit is contained in:
56
TODO.md
56
TODO.md
@@ -25,6 +25,62 @@ release" is exactly the contradiction
|
||||
|
||||
# Completed Steps
|
||||
|
||||
- 2026-08-09: Finished the `--json` stdout contract and gave `make build`
|
||||
a rule ([issue #108](https://git.eeqj.de/sneak/vaultik/issues/108),
|
||||
[issue #110](https://git.eeqj.de/sneak/vaultik/issues/110)). Two
|
||||
unrelated defects of the same shape — a command reporting something it
|
||||
did not do — landed together because both are small.
|
||||
|
||||
`CleanupLocalSnapshots` wrote three prose lines to stdout with no
|
||||
`--json` awareness, covering every branch of the function, so no input
|
||||
avoided them and `vaultik prune --json | jq` failed even after
|
||||
[issue #106](https://git.eeqj.de/sneak/vaultik/issues/106) removed the
|
||||
banner. `-q` never helped either: `printlnStdout` and `stdoutf` write
|
||||
straight to `Vaultik.Stdout` and never consult `Vaultik.UI`, which is
|
||||
what `SetQuiet` affects. The issue offered three fixes and asked for a
|
||||
decision. Taken: thread `*PruneOptions` into the function and gate each
|
||||
write on `!opts.JSON`, matching `PruneBlobs` (its sibling phase, which
|
||||
already takes the same struct), `RemoveSnapshot` and `remote info`, so
|
||||
the package has one pattern rather than two. Rejected: moving the lines
|
||||
to `log.Info`, because the logger's default level is `slog.LevelWarn`,
|
||||
so that would not relocate them to stderr — it would delete them from a
|
||||
plain `vaultik prune`, and the removal of rows from the local index is
|
||||
not something to narrate only under `--verbose`. Also rejected: putting
|
||||
the stale-record count into `PruneBlobsResult`, whose every field is
|
||||
blob-scoped and which is produced by the later phase; a prune document
|
||||
covering both phases is a reasonable thing to want, but it is a schema
|
||||
design question and not a stream-hygiene fix. The narration is
|
||||
duplicated as `log.Info` records, which `PruneBlobs` already does
|
||||
alongside its own prints, so the events survive on stderr for anyone
|
||||
running `--verbose`.
|
||||
|
||||
`make build` printed "Nothing to be done for 'build'" and exited 0
|
||||
without producing a binary: `build` was listed in `.PHONY` with no
|
||||
`build:` rule anywhere, and declaring a name phony is exactly what
|
||||
converts make's "No rule to make target" error into a silent success.
|
||||
Fixed with `build: vaultik`, keeping `vaultik:` as the file rule. The
|
||||
audit the issue asked for covers all 19 `.PHONY` names; `build` was the
|
||||
only one without a rule, and `vaultik` is correctly absent from
|
||||
`.PHONY`, being a real file target.
|
||||
|
||||
Tests, each verified to fail with the fix reverted rather than assumed
|
||||
to: `CleanupLocalSnapshots` leaves stdout untouched under `--json` in
|
||||
all three branches (stale records, none, empty index) and still emits
|
||||
every line without it, so the guard cannot be satisfied by deleting the
|
||||
output; `prune --json` run end to end through `Entry`, cobra and fx
|
||||
over the process's real stdout descriptor against a `file://` store,
|
||||
asserting exactly one JSON document, in both the stale and non-stale
|
||||
branches; and a parse of the `Makefile` asserting every `.PHONY` name
|
||||
has a rule and that `build` reaches the rule that produces the binary,
|
||||
which keeps the audit true for names added later. That last one is a
|
||||
parse rather than an invocation of `make`, since `make test` is what
|
||||
runs it and shelling back into `make build` would nest a build inside
|
||||
the test run. The property a parse cannot establish — that the recipe
|
||||
still fails when the build fails — was verified by hand against a
|
||||
deliberately broken tree: `make build` exits 2 and produces nothing.
|
||||
`cmd/vaultik` gains its first test file, so `make test` now reports 16
|
||||
packages `ok` where it reported 15.
|
||||
|
||||
- 2026-08-09: Stopped the startup banner from contaminating `--json`
|
||||
documents ([issue #106](https://git.eeqj.de/sneak/vaultik/issues/106)).
|
||||
`Entry` writes the banner to stdout before cobra parses anything, and
|
||||
|
||||
Reference in New Issue
Block a user