upstream-archive/VoiceStudio
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: correct the CI and mirror-path claims in STRUCTURE.md

Browse Source 
Both points from the review are right:

- The three test homes do not each get their own CI job. `ci.yml` runs all
  three as steps of the single `test` job (`Run pytest`, `Run pytest
  (backend/tests, isolated)`, `Run Vitest`); what makes `backend/tests/`
  separate is the pytest session, not the job.
- `tests/backend/services/test_dub_pipeline*.py` does not exist — that
  regression test is flat, at `tests/backend/test_dub_pipeline_wav.py`.
  The mirroring example now uses a path that exists
  (`backend/services/ffmpeg_utils.py` ->
  `tests/backend/services/test_ffmpeg_utils.py`) and says that
  backend-wide and cross-cutting suites stay flat.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01LDyC6prbjFydox9XQGhyny
This commit is contained in:
Dawcraft
2026-09-10 13:32:07 +09:00
co-authored by Claude Opus 5
parent 638392994a
commit 71d4114354
1 changed files with 4 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/STRUCTURE.md
+4 -3
View File
@@ -151,12 +151,13 @@ VoiceStudio/
## Where tests live
Three homes, each with its own runner and its own CI job. The split is deliberate, not drift:
Three homes, each with its own runner. CI runs all three inside the single `test` job in
`ci.yml`, as separate steps. The split is deliberate, not drift:
| Home | Runner | Why it's separate |
|---|---|---|
| `tests/` | `pytest tests/` — the `testpaths` default | The main suite. Its `conftest.py` points `OMNIVOICE_DATA_DIR` at a throwaway dir so a run can never touch the developer's real app state (#878). |
| `backend/tests/` | `pytest backend/tests/` — its own CI job | Runs as an isolated session against `backend/`'s bare imports. Its `conftest.py` sets the same hermetic data dir; **never** reintroduce module-level `sys.modules` stubs there — they leak process-wide at collection time and poison mixed runs. |
| `backend/tests/` | `pytest backend/tests/` — its own pytest session (the `Run pytest (backend/tests, isolated)` step) | Runs as an isolated session against `backend/`'s bare imports. Its `conftest.py` sets the same hermetic data dir; **never** reintroduce module-level `sys.modules` stubs there — they leak process-wide at collection time and poison mixed runs. |
| `frontend/src/**/*.test.{js,jsx,ts,tsx}` | `bun run test` (vitest, jsdom) | Co-located with the component under test. `frontend/e2e*/` hold the Playwright suites; `tests/frontend/` is the older `node:test` set. |
## What lives where
@@ -235,6 +236,6 @@ Migrate when adding the second `apps/*` or the second `packages/*`. Not before.
## Conventions
- **Filenames:** snake_case for Python, kebab-case or PascalCase for JS/TS components, lowercase for Markdown.
- **Tests mirror source paths** where a mirror exists: `backend/services/dub_pipeline.py` → `tests/backend/services/test_dub_pipeline*.py` (`tests/backend/` mirrors `api/ core/ engines/ services/`). Cross-cutting suites stay flat as `tests/test_*.py`. A React component's test sits next to the component.
- **Tests mirror source paths** where a mirror exists: `tests/backend/` mirrors `api/ core/ engines/ services/`, so `backend/services/ffmpeg_utils.py` → `tests/backend/services/test_ffmpeg_utils.py`. Everything else stays flat — `tests/backend/test_*.py` for backend-wide cases, `tests/test_*.py` for cross-cutting ones. A React component's test sits next to the component.
- **One-off scripts** go into `scripts/` with a descriptive name, not `test_*.py` at the root.
- **New top-level directories** require a PR that updates *this file*.