-
Notifications
You must be signed in to change notification settings - Fork 0
test: add canonical append-log example #23
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| //! Canonical example: Append-only log with crash-consistency verification. | ||
| //! | ||
| //! This test validates the FIRST API by performing a simple append-log | ||
| //! workload with explicit crash points and invariant checking. | ||
|
|
||
| use std::fs::File; | ||
| use std::io::{Read, Write}; | ||
|
|
||
| #[test] | ||
| fn append_log_atomicity() { | ||
| first::test() | ||
| .run(|env| { | ||
| let path = env.path("append.log"); | ||
|
|
||
| // Write record 1 | ||
| let mut file = File::create(&path).unwrap(); | ||
| file.write_all(b"RECORD1\n").unwrap(); | ||
| first::crash_point("after_write_1"); | ||
|
|
||
| // Write record 2 | ||
| file.write_all(b"RECORD2\n").unwrap(); | ||
| first::crash_point("after_write_2"); | ||
|
|
||
| // Fsync to make durable | ||
| file.sync_all().unwrap(); | ||
| first::crash_point("after_fsync"); | ||
| }) | ||
| .verify(|env, crash_info| { | ||
| let path = env.path("append.log"); | ||
|
|
||
| // Read whatever survived | ||
| let mut contents = String::new(); | ||
| if let Ok(mut f) = File::open(&path) { | ||
| f.read_to_string(&mut contents).ok(); | ||
| } | ||
|
|
||
| let records: Vec<_> = contents.lines().collect(); | ||
|
|
||
| // INVARIANT: Records are prefix-consistent | ||
| // Either: [], ["RECORD1"], or ["RECORD1", "RECORD2"] | ||
| // Never: ["RECORD2"] alone (would violate append-only semantics) | ||
|
|
||
| match records.as_slice() { | ||
| [] => { /* Nothing persisted - fine */ } | ||
| ["RECORD1"] => { /* Partial - fine */ } | ||
| ["RECORD1", "RECORD2"] => { /* Complete - fine */ } | ||
| other => { | ||
| panic!( | ||
| "Invariant violation at '{}': unexpected log state {:?}", | ||
| crash_info.label, other | ||
| ); | ||
| } | ||
| } | ||
| }) | ||
| .execute(); | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The invariant currently allows
[]or"RECORD1"even when the crash happens at the explicitafter_fsyncpoint. At that pointfsync()has returned, so the log should be fully durable under FIRST’s model; accepting empty/partial states will let durability regressions (e.g., missing/ignored fsync) pass undetected. Consider usingcrash_info.label(or point id) to require"RECORD1","RECORD2"when the crash is atafter_fsync.Useful? React with 👍 / 👎.