Skip to content

testing.md

Latest commit

 

History

History
95 lines (65 loc) · 3.22 KB

testing.md

File metadata and controls

95 lines (65 loc) · 3.22 KB

Testing

Midge has unit tests in src/ and integration tests in tests/. For early-adopter trust work, the important question is not raw test count, but which guarantees are actually proven.

Running Tests

cargo test

Run a specific integration file:

cargo test --test durability_recovery

Run the trust-critical smoke suite:

cargo test --test external_adopter_smoke

Validate naming and AAA structure:

cntryl-tools validate-tests

Trust Matrix

Use this matrix when updating guarantees or reviewing whether Midge is safe enough to evaluate.

Guarantee Representative tests
restart after committed writes restores state tests/durability_recovery.rs, tests/durability_wal.rs
truncated WAL tail keeps valid prefix only src/wal/recovery.rs, tests/durability_wal.rs
corrupted durable WAL prefix fails strict recovery src/wal/recovery.rs, tests/durability_wal.rs
flush failure does not publish orphan SST state tests/failure_injection.rs
flush restart recovers from WAL after interrupted publish tests/failure_injection.rs
compaction crash before publish keeps input SSTs authoritative tests/chaos_compaction.rs, tests/failure_injection.rs
compaction crash after publish keeps data visible and cleanup idempotent tests/chaos_compaction.rs, tests/failure_injection.rs
iterators honor tombstones and latest-version resolution across SST boundaries tests/engine_iterators.rs, tests/engine_compaction.rs
strict vs salvage recovery is explicit tests/failure_injection.rs, tests/durability_wal.rs
released-format fixtures open and future-format fixtures fail with CompatibilityError tests/compatibility_fixtures.rs, src/metadata/format.rs

External-Adopter Gate

Before inviting external evaluators, run at least:

cargo test --test external_adopter_smoke
cargo test --test durability_wal
cargo test --test failure_injection
cargo test --test chaos_compaction
cargo test --test engine_iterators
cargo test --test compatibility_fixtures

This is the minimum “safe enough to try” gate for local-disk evaluation.

Where To Add Tests

  • src/**: unit tests for WAL parsing, corruption detection, sequence ordering, and other local invariants
  • tests/**: end-to-end recovery, flush publication, compaction publication, iterator correctness, and restart behavior

Prefer extending an existing file when the guarantee already has a home. Add a new file only when it becomes a clearer public test category.

Naming

Use:

  • should_<behavior>_given_<context>_when_<condition>

The test name should state the promised behavior, not just the API call being made.

AAA Structure

For non-trivial tests, use a visible Arrange / Act / Assert structure.

#[test]
fn should_preserve_valid_prefix_given_truncated_wal_tail_when_recovering() {
    // Arrange

    // Act

    // Assert
}

Notes

  • Legacy tests still exist and are being tightened gradually.
  • Prefer durable local-disk coverage for trust-critical tests unless the behavior is specifically cloud-only.
  • Informational tests that only print status are not sufficient for trust guarantees; each guarantee should have an asserted outcome.