feat: update portal-spec-tests and refactor reading from test files#1797
Merged
Conversation
KolbyML
reviewed
May 1, 2025
Member
KolbyML
left a comment
KolbyML
left a comment
There was a problem hiding this comment.
Most of the PR looks good, I just have questions on the types we already have defined
Comment on lines
+8
to
+20
| /// A common type used in test files. | ||
| #[derive(Debug, Clone, Serialize, Deserialize)] | ||
| pub struct ContentItem<K: OverlayContentKey> { | ||
| pub content_key: K, | ||
| #[serde(rename = "content_value")] | ||
| pub raw_content_value: RawContentValue, | ||
| } | ||
|
|
||
| impl<K: OverlayContentKey> ContentItem<K> { | ||
| pub fn content_value<V: ContentValue<TContentKey = K>>(&self) -> Result<V, ContentValueError> { | ||
| V::decode(&self.content_key, &self.raw_content_value) | ||
| } | ||
| } |
Member
There was a problem hiding this comment.
Isn't this type already defined in crates/utils/src/testing.rs, shouldn't we only define it once?
Comment on lines
+24
to
+51
|
|
||
| /// Reads json file from a "portal-spec-tests" submodule | ||
| pub fn read_json_portal_spec_tests_file<T>(path: impl AsRef<Path>) -> anyhow::Result<T> | ||
| where | ||
| T: DeserializeOwned, | ||
| { | ||
| let reader = BufReader::new(File::open(portal_spec_tests_path(path))?); | ||
| Ok(serde_json::from_reader(reader)?) | ||
| } | ||
|
|
||
| /// Reads yaml file from a "portal-spec-tests" submodule | ||
| pub fn read_yaml_portal_spec_tests_file<T>(path: impl AsRef<Path>) -> anyhow::Result<T> | ||
| where | ||
| T: DeserializeOwned, | ||
| { | ||
| let reader = BufReader::new(File::open(portal_spec_tests_path(path))?); | ||
| Ok(serde_yaml::from_reader(reader)?) | ||
| } | ||
|
|
||
| /// Reads ssz file from a "portal-spec-tests" submodule | ||
| pub fn read_ssz_portal_spec_tests_file<T: Decode>(path: impl AsRef<Path>) -> anyhow::Result<T> { | ||
| let bytes = read_binary_portal_spec_tests_file(&path)?; | ||
| T::from_ssz_bytes(&bytes).map_err(|err| { | ||
| anyhow!( | ||
| "Error decoding ssz file: {}. Error: {err:?}", | ||
| path.as_ref().display() | ||
| ) | ||
| }) |
Member
There was a problem hiding this comment.
Isn't this code already defined in crates/utils/src/submodules.rs shouldn't we only define it once?
KolbyML
approved these changes
May 1, 2025
Member
KolbyML
left a comment
KolbyML
left a comment
There was a problem hiding this comment.
looks good. Milos messaged me on discord for context
Collaborator
Author
For context for others, these files and logic is duplicated because we don't want to put it in
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
What was wrong?
We were missing test vectors around fork boundaries. These were added to portal-spec-tests in ethereum/portal-spec-tests#49
How was it fixed?
Updated portal-spec-tests submodule, and simplified/refactored some tests in ehtportal-api crate.
To-Do