aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authortv <tv@krebsco.de>2026-11-16 14:38:16 +0000
committertv <tv@krebsco.de>2026-11-16 16:26:55 +0100
commitf2ed3e1e9e9c6199fb0bc3b1e2efb4eeb5f89b05 (patch)
tree4ccdd3eb355ec436dd5f9eb32b1fcc32780577bb /README.md
parent0dde043f1e8c6e8c99a876b4d0dffdd499a9c961 (diff)
docs/federation-tests: how the store and the federation are tested
A plan, the contract the code is built to: the fold and the store tested as pure code, events in and verdicts and states out; a model written plainly from the design, which the store is checked against; every rule by its smallest scenarios; every attack row a test named by its table and number, and a test that every row has one; the promises as properties over generated histories, every order for small ones and seeded ones beyond, cut down before they are printed; the store on Automerge checked against the store in memory; simulations with an adversary node; fixed vectors for every encoding; fuzzing and mutants in longer runs. All of it behind the `federation` feature, by stage.
Diffstat (limited to 'README.md')
-rw-r--r--README.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/README.md b/README.md
index 817ff75..179141f 100644
--- a/README.md
+++ b/README.md
@@ -95,6 +95,8 @@ curl -u alice:secret localhost:3000/peers # who is out there
don't trust each other. Not built.
* [`docs/store.md`](docs/store.md): a design for a store of events, each judged where it
was written, generic over what they read as; the federation rests on it. Not built.
+* [`docs/federation-tests.md`](docs/federation-tests.md): how the store and the
+ federation are to be tested. Not built.
* [`docs/topology.md`](docs/topology.md): who syncs with whom, and how a change passes on: the
choices, which combine well, and what they cost.
* [`docs/measurements.md`](docs/measurements.md): `/admin/stats` and its Prometheus metrics.