feat: basic validation of CAR files #3591
Merged
Conversation
This file contains 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
lemmih
requested review from
hanabi1224 and
LesnyRumcajs
and removed request for
a team
hanabi1224
reviewed
Oct 13, 2023
src/tool/subcommands/car_cmd.rs
Outdated
Comment on lines
121
to
234
| async fn validate_junk_car() { | ||
| let mut temp_path = NamedTempFile::new_in(".").unwrap(); | ||
| temp_path.write_all(&[0xde, 0xad, 0xbe, 0xef]).unwrap(); | ||
| assert!(validate(&temp_path.into_temp_path(), false, false) | ||
| .await | ||
| .is_err()); | ||
| } | ||
|
|
||
| #[tokio::test] | ||
| async fn validate_empty_car() { | ||
| let temp_path = NamedTempFile::new_in(".").unwrap(); | ||
| assert!(validate(&temp_path.into_temp_path(), false, false) | ||
| .await | ||
| .is_err()); | ||
| } | ||
|
|
||
| #[tokio::test] | ||
| async fn validate_mainnet_genesis() { | ||
| let mut temp_path = NamedTempFile::new_in(".").unwrap(); | ||
| temp_path.write_all(mainnet::DEFAULT_GENESIS).unwrap(); | ||
| assert!(validate(&temp_path.into_temp_path(), false, true) | ||
| .await | ||
| .is_ok()); | ||
| } | ||
|
|
||
| #[tokio::test] | ||
| async fn validate_calibnet_genesis() { | ||
| let mut temp_path = NamedTempFile::new_in(".").unwrap(); | ||
| temp_path.write_all(calibnet::DEFAULT_GENESIS).unwrap(); | ||
| assert!(validate(&temp_path.into_temp_path(), false, true) | ||
| .await | ||
| .is_ok()); | ||
| } | ||
|
|
||
| async fn create_raw_car_file(car_blocks: Vec<CarBlock>, ignored_cids: Vec<Cid>) -> TempPath { | ||
| let temp_path = NamedTempFile::new_in(".").unwrap().into_temp_path(); | ||
| let mut writer = tokio::fs::File::create(&temp_path).await.unwrap(); | ||
|
|
||
| let frames = forest::Encoder::compress_stream_default(iter(car_blocks).map(Ok)).map_ok( | ||
| |(cids, bytes)| { | ||
| ( | ||
| cids.into_iter() | ||
| .filter(|cid| !ignored_cids.contains(cid)) | ||
| .collect(), | ||
| bytes, | ||
| ) | ||
| }, | ||
| ); | ||
|
|
||
| // Write zstd frames and include a skippable index | ||
| forest::Encoder::write(&mut writer, vec![], frames) | ||
| .await | ||
| .unwrap(); | ||
|
|
||
| // Flush to ensure everything has been successfully written | ||
| writer.flush().await.unwrap(); | ||
| writer.shutdown().await.unwrap(); | ||
| temp_path | ||
| } | ||
|
|
||
| // Sanity check to verify that we can create valid forest.car.zst files | ||
| #[tokio::test] | ||
| async fn validate_valid_file() { | ||
| let data = "this data _does_ match the CID".as_bytes().to_vec(); | ||
| let temp_path = create_raw_car_file( | ||
| vec![CarBlock { | ||
| cid: Cid::new_v1(0, Code::Blake2b256.digest(&data)), | ||
| data, | ||
| }], | ||
| vec![], | ||
| ) | ||
| .await; | ||
|
|
||
| assert!(validate(&temp_path, false, false).await.is_ok()); | ||
| } | ||
|
|
||
| #[tokio::test] | ||
| async fn validate_invalid_blocks() { | ||
| let temp_path = create_raw_car_file( | ||
| vec![CarBlock { | ||
| cid: Cid::new_v1(0, Code::Identity.digest(&[10])), | ||
| data: "this data doesn't match the CID".as_bytes().to_vec(), | ||
| }], | ||
| vec![], | ||
| ) | ||
| .await; | ||
|
|
||
| assert!(validate(&temp_path, false, false).await.is_err()); | ||
| } | ||
|
|
||
| // If a CarBlock exist that isn't referenced in the index, this is an error. | ||
| #[tokio::test] | ||
| async fn validate_invalid_index() { | ||
| let data = "this data _does_ match the CID".as_bytes().to_vec(); | ||
| let cid = Cid::new_v1(0, Code::Blake2b256.digest(&data)); | ||
| let temp_path = create_raw_car_file(vec![CarBlock { cid, data }], vec![cid]).await; | ||
|
|
||
| assert!(validate(&temp_path, false, false).await.is_err()); | ||
| } | ||
| } |
There was a problem hiding this comment.
Short, concise tests. That's just code porn.
hanabi1224
approved these changes
Oct 16, 2023
LesnyRumcajs
approved these changes
Oct 16, 2023
Done. |
LesnyRumcajs
approved these changes
Oct 17, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary of changes
Changes introduced in this pull request:
forest-tool car validatecommand.This new command verifies the invariants expected to be true for all CAR files (not just Filecoin CAR files).
Reference issue to close (if applicable)
Closes
Other information and links
Change checklist