Files
ngit-grasp/docs/how-to/test-fixtures.md
T
DanConwayDev d47b9929d5 test(sync): reuse repository identity across relay fixtures
Paired setup calls constructed separate announcements, state events and Git
commits for the same owner/identifier. Discovery could exchange those
replaceable events while setup waited for an exact ID, making fixture
identity depend on timestamp and event-ID ordering.

Prepare one RepositoryFixture and install its unchanged signed events and
Git data on each relay. Migrate all sixteen paired scenarios in descendant,
discovery, live-sync, metrics and tag-variation tests. Historic tests retain
the target listener reservation before seeding the source, so the original
announcement can list both endpoints without starting target sync early.

Keep exact-ID visibility checks, their deadlines and failure diagnostics.
Add a wire-level regression checking both event IDs and remote Git refs
after repeated installation. Production replacement policy, dependencies,
intentional revision tests and concurrency remain unchanged.

Validation: rustfmt and whitespace checks pass; paired setup callers audited.
The new regression and migrated scenarios await CI execution, per the request
to keep Cargo tests on CI/host. The preceding diagnostic CI revision stopped
at a GitHub archive HTTP 504 before Rust tests and gave no further evidence
about the original setup failure.

Assisted-by: Codex (GPT-6)
2026-09-15 07:45:52 +00:00

3.0 KiB

Reliable test fixtures

Run tests through the repository development shell. Keep parallel checks enabled: each fixture owns its socket, tasks, subprocesses and temporary data.

Socket ownership

Allocate loopback port zero and transfer the bound listener into the server. Do not bind, inspect the port, drop the socket and bind that port again. Subprocess fixtures pass NGIT_TEST_LISTENER_FD with NGIT_TEST=1 on Unix. The binary advertises this private protocol through --internal-test-listener-support; it is not deployment configuration and is not exposed through the NixOS module or example service environment.

TestRelay retains a parent copy across same-address restarts. Offline relay scenarios use UnavailableEndpoint, which accepts and closes connections while retaining the socket, then transfers that socket to the recovered server. This prevents another parallel test from taking the offline address.

Observable readiness and shutdown

Wait for HTTP readiness, connected-state metrics, or the expected event with a bounded deadline. A successful TCP connection, a connection attempt counter, and an arbitrary grace period do not prove that a server is ready.

Connection tasks belong to their fixture's accept loop. Stopping the fixture cancels and joins them; dropping it cancels the owner. Git fixture subprocesses are cancelled with their request, and all three pipes are driven concurrently.

Shared repository identity

setup_announcement_on_relay returns an announcement and a RepositoryFixture. Prepare it once for each logical repository, then call fixture.install(&relay) for every other relay. It reuses the signed announcement, signed state event, and Git commit. Repeating setup independently can create competing replaceable events at the same owner/identifier and different Git histories.

List all participating domains when preparing the fixture. If historic tests must seed a source before starting the syncing relay, reserve the target's listener first and transfer it into the target after seeding. Do not use sleeps or fabricated future timestamps to order copies of the same fixture. Tests of actual repository revisions should construct those revisions explicitly.

The sync regression reinstalling_shared_repository_preserves_event_ids_and_git_refs checks exact announcement/state IDs and remote Git refs across installation and reinstallation on two relays.

Time and streaming assertions

Age private cache timestamps explicitly and bracket wall-clock timestamps before and after the operation. Streaming tests coordinate fake Git with an owned loopback gate, collect bytes independently of HTTP frame boundaries, and retain assertions about terminal flush and post-push promotion ordering. Fixed sleeps remain appropriate only when elapsed time is itself under test; polling an observable condition must always have a bounded deadline.

Targeted regressions include fixture_lifecycle, relay_identity, git_response_streaming, and the shared Git-server tests in sync. Full package validation remains necessary after these scoped checks.