evidence-source/docs/ADR-0002-fixture-ownership.md

44 lines
1.8 KiB
Markdown
Raw Normal View History

# ADR-0002 — Fixture corpus ownership
- **Status:** accepted
- **Date:** 2026-07-08
- **Workplan:** ESRC-WP-0001 (T05)
## Context
The PDF ingest contract tests are driven by a fixture corpus
(`fixtures/pdfs/` + `manifest.json`) currently owned by `citation-evidence`.
The corpus is made of **real** personal and legal documents — utility-cost
statements, a settlement letter, court correspondence, cemetery admission
forms — containing names, addresses, and case details.
The workplan (T05) asks us to either copy the corpus into this repo or define a
stable shared-fixture path.
## Decision
Do **not** copy the corpus into `evidence-source`. Resolve it from the sibling
`citation-evidence` checkout instead:
- default: `<repo>/../citation-evidence/fixtures/pdfs`
- override: `EVIDENCE_SOURCE_FIXTURE_DIR` environment variable
## Rationale
- **Privacy.** `evidence-source` advertises reusable ingest capability and is a
candidate for wider distribution. Duplicating real PII into it multiplies the
places that data lives and can be leaked.
- **Single ownership.** The corpus and its `manifest.json` (page counts,
known-good quotes) were curated and re-verified upstream. One owner avoids
drift between two copies.
- **Consistent coupling.** This repo already assumes a sibling checkout for its
`@citation-evidence/engine` (`link:../citation-engine`) dependency. Reading
fixtures from `../citation-evidence` is the same coupling model, not a new one.
## Consequences
- Tests require a sibling `citation-evidence` checkout. In CI or a standalone
clone, point `EVIDENCE_SOURCE_FIXTURE_DIR` at wherever the corpus is mounted.
- When the corpus is absent, the fixture-driven suites skip with a clear message
rather than failing spuriously, so unit tests that need no corpus still run.