Make the project's documentation match the code and remove the sprawl. The docs
claimed Phase 2.8 (drug interactions) was 'planning/0%' and the backend '~91%
complete' — both wrong: 2.8 is implemented and live, plus the P0/P1 security
and test work is done. Five root CI/CD docs described a 'docker-build' CI job
that was removed; ~18 backend/ status snapshots and ~24 docs/implementation
duplicates cluttered the tree.
Deletions (85 files):
- Root: 4 stale CI/CD reports (CI-CD-{COMPLETION-REPORT,IMPLEMENTATION-SUMMARY,
STATUS-REPORT,FINAL-STATUS}.md) — all describe the removed docker-build job.
- backend/: 18 phase/build/fix snapshots and code-dump .txt files.
- docs/: the 3 one-time reorg reports; ~17 docs/implementation duplicates and
process artifacts; 4 stale docs/development CI docs + git snapshots;
redundant deployment/testing files.
- thoughts/: STATUS.md (said Phase 2.4 in-progress), superseded phase notes and
duplicative research inputs. tmp/ (928KB of CI debug logs, gitignored).
Moves (18 files):
- 9 genuine decision records -> docs/adr/ (Architecture Decision Records),
date-prefixes stripped, with an index README.
- 8 historical-but-valuable phase plans/specs + the old CI-CD-FINAL-SOLUTION ->
docs/archive/ (now-populated, with a README explaining it's superseded
material). thoughts/ tree removed.
Rewrites (13 files) to match reality:
- Drop the fake '% complete' figures everywhere in favor of Implemented /
In-Progress / Planned with concrete endpoint/feature lists.
- Phase 2.8 -> Implemented; add /api/interactions/* and /api/auth/{refresh,
logout} to the endpoint lists; fix 'Rust 1.93' -> edition 2021.
- Add a Security section (token_version validation, hashed refresh-token
persistence, fail-fast config, real-IP audit) and correct the test-coverage
and deployment claims to reality.
- New canonical docs/development/CI-CD.md (4 jobs: format/clippy/build/test,
mongo service, no docker-build + why).
- README, docs/README, product/{STATUS,ROADMAP,PROGRESS,README,introduction},
implementation/README, development/README, testing/README, AI_AGENT_GUIDE,
.cursorrules, .gooserules all updated.
Verified: greps for 'Phase 2.8 (Planning)', 'PLANNING (0%)', 'Rust 1.93',
'91%/10%/85% complete', and 'docker-build' return nothing outside docs/archive;
all internal doc links resolve; backend/src untouched (cargo build clean).
48 lines
1.9 KiB
Markdown
48 lines
1.9 KiB
Markdown
# Testing Documentation
|
|
|
|
Test scripts, test notes, and the layout of the automated test suite.
|
|
|
|
## Automated test suite (`backend/`)
|
|
|
|
The authoritative tests live in the backend crate and run via `cargo test`:
|
|
|
|
- **Unit tests** (`cargo test --lib`) — 18 tests in `src/`: client-IP resolution,
|
|
JWT round-trips, refresh-token hashing, token-version cache, services.
|
|
- **Integration tests** (`cargo test --test auth_tests --test medication_tests`) —
|
|
13 tests in `tests/`, built in-process against an isolated per-run MongoDB
|
|
database via the shared `tests/common/mod.rs` helper. They **skip gracefully**
|
|
when MongoDB is unreachable, so `cargo test` stays green without a database.
|
|
Cover: register, login (right/wrong password), auth enforcement, refresh
|
|
rotation + reuse detection, logout, password-change invalidation, and
|
|
medication CRUD/auth flows.
|
|
|
|
To run the integration tests for real, start a MongoDB first:
|
|
|
|
```bash
|
|
docker run -d -p 27017:27017 --name mongo-test mongo:7
|
|
cd backend && cargo test --test auth_tests --test medication_tests
|
|
```
|
|
|
|
CI runs the full suite with a `mongo:7` service container — see
|
|
[../development/CI-CD.md](../development/CI-CD.md).
|
|
|
|
## Manual / smoke test scripts
|
|
|
|
- **[test-api-endpoints.sh](./test-api-endpoints.sh)** - Comprehensive API endpoint testing
|
|
- **[test-medication-api.sh](./test-medication-api.sh)** - Medication-specific API tests
|
|
- **[test-mvp-phase-2.7.sh](./test-mvp-phase-2.7.sh)** - Phase 2.7 MVP comprehensive tests
|
|
- **[solaria-test.sh](./solaria-test.sh)** - Solaria deployment testing
|
|
- **[check-solaria-logs.sh](./check-solaria-logs.sh)** - Log checking utility
|
|
- **[quick-test.sh](./quick-test.sh)** - Fast smoke test
|
|
|
|
> Historical test-run snapshots are in [../archive/](../archive/README.md).
|
|
|
|
## Notes
|
|
|
|
- Manual scripts that hit a live server need MongoDB running and (for protected
|
|
routes) a valid JWT.
|
|
- Solaria tests require network access to the Solaria server.
|
|
|
|
---
|
|
|
|
*Last Updated: 2026-06-27*
|