From 0b3ff48c52d5b47d3f881b95ce224b8172539caa Mon Sep 17 00:00:00 2001 From: Jamie Chapman <104535858+bilbospocketses@users.noreply.github.com> Date: Wed, 26 Aug 2026 15:59:30 -0400 Subject: [PATCH] docs: correct test count and the DB-update readiness step Wrap-up doc sweep (T2). Grepped 20 identifiers changed this session across README, CONTRIBUTING, SECURITY, TECHNICAL_GUIDE, the manual test checklist and fresh-vm-smoke; 13 had hits and 3 were stale. Test count 713 -> 726 in README and TECHNICAL_GUIDE. The count moved twice after those files were last touched: the liveness interval-gate tests and the Jellyfin readiness tests. The manual test checklist still described Step 4 as waiting for "Startup complete" via stderr, which is exactly the mechanism that turned out not to work -- docker logs --since returns nothing on a long-lived container. It now describes what the step actually does (healthcheck, or a log marker timestamped after this start, 120s budget) and, more usefully for a tester, records that a failure there means "started but never reported ready" rather than docker refusing to start. TECHNICAL_GUIDE's WaitForContainerReadyAsync row already read "Poll until container is healthy", which was aspirational before and is now accurate. Left as-is. --- README.md | 2 +- docs/TECHNICAL_GUIDE.md | 2 +- docs/manual-test-checklist.md | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 9051b955..58297a22 100644 --- a/README.md +++ b/README.md @@ -67,7 +67,7 @@ Open http://localhost:5159 in your browser. The first-run wizard will guide you dotnet test ``` -713 tests covering services, modules, the launcher, and integrations (across `ControlMenu.Tests`, `ControlMenu.Common.Tests`, and `ControlMenuLauncher.Tests`). +726 tests covering services, modules, the launcher, and integrations (across `ControlMenu.Tests`, `ControlMenu.Common.Tests`, and `ControlMenuLauncher.Tests`). ## Architecture diff --git a/docs/TECHNICAL_GUIDE.md b/docs/TECHNICAL_GUIDE.md index eacc07a8..8ba641dc 100644 --- a/docs/TECHNICAL_GUIDE.md +++ b/docs/TECHNICAL_GUIDE.md @@ -1064,7 +1064,7 @@ All paths resolve under `` via `IDataPathResolver` — `C:\ProgramData - **xUnit** -- test runner - **Moq** -- mocking framework - **bunit** -- Blazor (Razor) component testing -- **713 tests** (all green on net10.0) across three projects — `ControlMenu.Tests` (app), `ControlMenu.Common.Tests`, and `ControlMenuLauncher.Tests` — run together via `ControlMenu.sln` +- **726 tests** (all green on net10.0) across three projects — `ControlMenu.Tests` (app), `ControlMenu.Common.Tests`, and `ControlMenuLauncher.Tests` — run together via `ControlMenu.sln` ### Test Database diff --git a/docs/manual-test-checklist.md b/docs/manual-test-checklist.md index a3e6b406..d98b36fd 100644 --- a/docs/manual-test-checklist.md +++ b/docs/manual-test-checklist.md @@ -275,7 +275,7 @@ Post-audit verification. Run the app with `dotnet run` from `src/ControlMenu/`. - [ ] Step 1: Container stops (shows truncated container ID) - [ ] Step 2: Backup created - [ ] Step 3: SQL update runs - - [ ] Step 4: Container starts, **waits for "Startup complete"** (should now actually detect it via stderr) + - [ ] Step 4: Container starts, then **waits for Jellyfin to be ready** — the container healthcheck reporting `healthy`, or `Startup complete` in logs timestamped *after* this start. Budget 120s. A failure here means "started but never reported ready", which is NOT `docker start` failing — the step text distinguishes the two - [ ] Step 5: Old backups cleaned - [ ] All steps show green checkmarks on success - [ ] If any step fails: error shows immediately (red X), **container is restarted** on failure @@ -397,7 +397,7 @@ If you're short on time, just hit these: 4. [ ] Settings > General: SMTP fields save without reverting 5. [ ] Settings > Cameras: save a camera, verify name shows in sidebar after refresh 6. [ ] Settings > Dependencies: badges are styled, disabled buttons are dimmed -7. [ ] Jellyfin > DB Date Update: start a run, verify Step 4 detects "Startup complete" +7. [ ] Jellyfin > DB Date Update: start a run, verify Step 4 reports Jellyfin online (healthcheck or post-start log marker), not a false "failed to start" 8. [ ] Edit a device, cancel — verify original values unchanged 9. [ ] Google TV mirror: clicks work, survive stream refresh 10. [ ] Cast & Crew update sends email on completion (if notification email set)