57 lines
2.9 KiB
Markdown
57 lines
2.9 KiB
Markdown
# The semantic oracle: how we prove the books are right
|
|
|
|
storytold's clones are verified with a *pixel oracle*: re-render a PSD and
|
|
diff it against Photoshop's own embedded merged composite, passing at
|
|
≤ 2/255 per channel. We steal the shape of that idea and change the domain:
|
|
our oracle is *semantic*, not visual.
|
|
|
|
## The core loop
|
|
|
|
1. **Fixture books.** A canonical set of journal entries exercising a feature
|
|
(the January 2026 fixture company in `tests/invariants.rs` is the first).
|
|
2. **Two engines.** The same fixtures go through our engine and through
|
|
**GnuCash** — the open-source, double-entry reference implementation with
|
|
open file formats. GnuCash is both the spec and the oracle.
|
|
3. **Exact diff.** `reports::snapshot()` renders trial balance, P&L, and
|
|
balance sheet as canonical JSON. The outputs must be **identical** —
|
|
decimal strings, no floats, no locale, no epsilon. Where storytold allows
|
|
2/255 of perceptual slop, we allow zero: accounting has no "close enough".
|
|
|
|
## The three oracle layers (today → future)
|
|
|
|
**Layer 1 — Golden files (live now).** `tests/golden/*.json` hold
|
|
hand-verified expected reports for canonical fixtures. The golden test fails
|
|
on any behavior change, intentional or not. Intentional changes require
|
|
recomputing the goldens *by hand from accounting principles* and documenting
|
|
the recomputation in the commit. This is the seed of everything below.
|
|
|
|
**Layer 2 — Property tests (live now, growing).**
|
|
`random_balanced_journals_preserve_invariants` posts hundreds of random
|
|
balanced entries and asserts the accounting laws still hold: trial balance
|
|
balances, the accounting equation holds, and the sum of all account movements
|
|
is exactly zero. New invariants get new properties. (Later: graduate to
|
|
`proptest` with shrinking.)
|
|
|
|
**Layer 3 — GnuCash diff harness (roadmap phase 3).** A `ledger-oracle` crate
|
|
will: import fixture books into GnuCash's XML format (or drive GnuCash
|
|
headless), run both engines, and diff `snapshot()` output automatically —
|
|
`cargo xtask oracle`. This is the direct analog of storytold's
|
|
`cargo xtask corpus` / `oracle_diff`. Until it exists, Layers 1 and 2 are
|
|
the oracle, and they are not optional.
|
|
|
|
## What the oracle does NOT cover (yet)
|
|
|
|
- **Workflows**, only semantics: that an invoice *posts the right lines* is
|
|
oracle-covered; that the invoice *screen* is usable is a UI concern for the
|
|
egui phase, where storytold's screenshot-in-the-loop comes back.
|
|
- **Tax law.** The engine computes what you tell it; it does not know the
|
|
tax code. Tax-adjacent logic gets its own fixtures and its own goldens
|
|
when it arrives, sourced from IRS publications — never from memory.
|
|
|
|
## Clean-room boundary
|
|
|
|
GnuCash is GPL. We read its documentation, its file formats, and its
|
|
*behavior*. We never copy its code, and no GPL code enters this repo
|
|
(MIT OR Apache-2.0). If an agent is ever unsure whether something is
|
|
"learning from behavior" vs "copying implementation", it stops and asks.
|