refactor: use util functions for reading from portal-spec-tests submodule (#1673)

Author: morph-dev

Cargo.lock

@@ -548,20 +548,21 @@ impl ContentValue for BeaconContentValue {
 
 #[cfg(test)]
 mod test {
-    use std::{fs, str::FromStr};
+    use std::str::FromStr;
 
     use alloy::primitives::Bytes;
     use serde::Deserialize;
     use serde_yaml::Value;
 
     use super::*;
+    use crate::test_utils::read_file_from_tests_submodule;
 
     #[rstest::rstest]
     #[case("capella", 6718368)]
     #[case("deneb", 10248000)]
     fn light_client_bootstrap_encode_decode(#[case] fork_name: &str, #[case] expected_slot: u64) {
-        let file = fs::read_to_string(format!(
-            "./../../portal-spec-tests/tests/mainnet/beacon_chain/light_client/{fork_name}/bootstrap.yaml",
+        let file = read_file_from_tests_submodule(format!(
+            "tests/mainnet/beacon_chain/light_client/{fork_name}/bootstrap.yaml",
         ))
         .unwrap();
 
@@ -589,8 +590,8 @@ mod test {
         #[case] fork_name: &str,
         #[case] expected_slot: u64,
     ) {
-        let file = fs::read_to_string(format!(
-            "./../../portal-spec-tests/tests/mainnet/beacon_chain/light_client/{fork_name}/updates.yaml",
+        let file = read_file_from_tests_submodule(format!(
+            "tests/mainnet/beacon_chain/light_client/{fork_name}/updates.yaml",
         ))
         .unwrap();
 
@@ -622,8 +623,8 @@ mod test {
         #[case] fork_name: &str,
         #[case] expected_slot: u64,
     ) {
-        let file = fs::read_to_string(format!(
-            "./../../portal-spec-tests/tests/mainnet/beacon_chain/light_client/{fork_name}/optimistic_update.yaml",
+        let file = read_file_from_tests_submodule(format!(
+            "tests/mainnet/beacon_chain/light_client/{fork_name}/optimistic_update.yaml",
         ))
         .unwrap();
 
@@ -655,8 +656,8 @@ mod test {
         #[case] fork_name: &str,
         #[case] expected_slot: u64,
     ) {
-        let file = fs::read_to_string(format!(
-            "./../../portal-spec-tests/tests/mainnet/beacon_chain/light_client/{fork_name}/finality_update.yaml"
+        let file = read_file_from_tests_submodule(format!(
+            "tests/mainnet/beacon_chain/light_client/{fork_name}/finality_update.yaml"
         ))
         .unwrap();
 
@@ -683,7 +684,9 @@ mod test {
 
     #[test]
     fn deneb_historical_summaries_with_proof_encode_decode() {
-        let file = fs::read_to_string("./../../portal-spec-tests/tests/mainnet/beacon_chain/historical_summaries_with_proof/deneb/historical_summaries_with_proof.yaml").unwrap();
+        let file = read_file_from_tests_submodule(
+            "tests/mainnet/beacon_chain/historical_summaries_with_proof/deneb/historical_summaries_with_proof.yaml",
+        ).unwrap();
         let value: serde_yaml::Value = serde_yaml::from_str(&file).unwrap();
         let content_key = BeaconContentKey::deserialize(&value["content_key"]).unwrap();
         let content_bytes = RawContentValue::deserialize(&value["content_value"]).unwrap();

crates/ethportal-api/src/assets/test/fluffy_header_with_proofs.json

@@ -57,22 +57,24 @@ impl ContentValue for HistoryContentValue {
 
 #[cfg(test)]
 mod test {
-    use std::fs;
-
     use serde_json::Value;
 
     use super::*;
-    use crate::{utils::bytes::hex_decode, HistoryContentValue};
+    use crate::{
+        test_utils::read_file_from_tests_submodule, utils::bytes::hex_decode, HistoryContentValue,
+    };
 
     #[test]
     fn header_with_proof_encode_decode_fluffy() {
-        let file =
-            fs::read_to_string("../validation/src/assets/fluffy/header_with_proofs.json").unwrap();
+        let file = read_file_from_tests_submodule(
+            "tests/mainnet/history/headers_with_proof/1000001-1000010.json",
+        )
+        .unwrap();
         let json: Value = serde_json::from_str(&file).unwrap();
         let json = json.as_object().unwrap();
         for (block_num, obj) in json {
             let block_num: u64 = block_num.parse().unwrap();
-            let header_with_proof = obj.get("value").unwrap().as_str().unwrap();
+            let header_with_proof = obj.get("content_value").unwrap().as_str().unwrap();
             let header_with_proof_encoded = hex_decode(header_with_proof).unwrap();
             let header_with_proof =
                 HeaderWithProof::from_ssz_bytes(&header_with_proof_encoded).unwrap();

crates/ethportal-api/src/types/content_value/beacon.rs

@@ -184,24 +184,28 @@ impl ssz::Encode for SszNone {
 #[cfg(test)]
 #[allow(clippy::unwrap_used)]
 mod tests {
-    use std::fs;
 
     use serde_json::Value;
     use ssz::Decode;
 
     use super::*;
-    use crate::utils::bytes::{hex_decode, hex_encode};
+    use crate::{
+        test_utils::read_file_from_tests_submodule,
+        utils::bytes::{hex_decode, hex_encode},
+    };
 
     #[test_log::test]
     fn decode_encode_header_with_proofs() {
-        let file =
-            fs::read_to_string("../validation/src/assets/fluffy/header_with_proofs.json").unwrap();
+        let file = read_file_from_tests_submodule(
+            "tests/mainnet/history/headers_with_proof/1000001-1000010.json",
+        )
+        .unwrap();
         let json: Value = serde_json::from_str(&file).unwrap();
         let hwps = json.as_object().unwrap();
         for (block_number, obj) in hwps {
             let _content_key = obj.get("content_key").unwrap();
             let block_number: u64 = block_number.parse().unwrap();
-            let proof = obj.get("value").unwrap().as_str().unwrap();
+            let proof = obj.get("content_value").unwrap().as_str().unwrap();
             let hwp = HeaderWithProof::from_ssz_bytes(&hex_decode(proof).unwrap()).unwrap();
             assert_eq!(block_number, hwp.header.number);
             let encoded = hex_encode(hwp.as_ssz_bytes());

crates/ethportal-api/src/types/content_value/history.rs

@@ -37,4 +37,5 @@ ssz_types.workspace = true
 test-log.workspace = true
 tokio-test.workspace = true
 tracing-subscriber.workspace = true
+trin-utils.workspace = true
 ureq.workspace = true

crates/ethportal-api/src/types/execution/header_with_proof.rs

@@ -122,22 +122,23 @@ impl Validator<HistoryContentKey> for ChainHistoryValidator {
 #[cfg(test)]
 #[allow(clippy::unwrap_used)]
 mod tests {
-    use std::fs;
-
     use alloy::primitives::U256;
     use ethportal_api::utils::bytes::hex_decode;
     use serde_json::Value;
     use ssz::Encode;
+    use trin_utils::submodules::read_portal_spec_tests_file;
 
     use super::*;
 
     fn get_header_with_proof_ssz() -> Vec<u8> {
-        let file = fs::read_to_string("../../validation/src/assets/fluffy/header_with_proofs.json")
-            .unwrap();
+        let file = read_portal_spec_tests_file(
+            "tests/mainnet/history/headers_with_proof/1000001-1000010.json",
+        )
+        .unwrap();
         let json: Value = serde_json::from_str(&file).unwrap();
         let json = json.as_object().unwrap();
         let raw_header = json.get("1000001").unwrap().as_object().unwrap();
-        let raw_header = raw_header.get("value").unwrap().as_str().unwrap();
+        let raw_header = raw_header.get("content_value").unwrap().as_str().unwrap();
         hex_decode(raw_header).unwrap()
     }
 

crates/subnetworks/history/Cargo.toml

@@ -1,12 +1,30 @@
 use std::{
-    fs::read_to_string,
-    io,
+    fs, io,
     path::{Path, PathBuf},
 };
 
-pub const PORTAL_SPEC_TESTS_SUBMODULE_PATH: &str = "../../../portal-spec-tests";
+pub const PORTAL_SPEC_TESTS_SUBMODULE_PATH: [&str; 2] =
+    ["../../portal-spec-tests", "../../../portal-spec-tests"];
 
-/// Reads a file from a "portal-spec-tests" submodule.
+/// Returns a path to a file within "portal-spec-tests" submodule
+pub fn portal_spec_tests_file_path<P: AsRef<Path>>(path: P) -> PathBuf {
+    for submodule_path in PORTAL_SPEC_TESTS_SUBMODULE_PATH {
+        if fs::exists(submodule_path)
+            .expect("we should be able to check whether submodule path exists")
+        {
+            return PathBuf::from(submodule_path).join(path);
+        }
+    }
+
+    panic!("Submodule directory not found!")
+}
+
+/// Reads text file from a "portal-spec-tests" submodule
 pub fn read_portal_spec_tests_file<P: AsRef<Path>>(path: P) -> io::Result<String> {
-    read_to_string(PathBuf::from(PORTAL_SPEC_TESTS_SUBMODULE_PATH).join(path))
+    fs::read_to_string(portal_spec_tests_file_path(path))
+}
+
+/// Reads binary file from a "portal-spec-tests" submodule
+pub fn read_portal_spec_tests_file_as_bytes<P: AsRef<Path>>(path: P) -> io::Result<Vec<u8>> {
+    fs::read(portal_spec_tests_file_path(path))
 }

crates/subnetworks/history/src/validation.rs

@@ -33,4 +33,4 @@ quickcheck.workspace = true
 quickcheck_macros = "1.0.0"
 rstest.workspace = true
 serde_yaml.workspace = true
-
+trin-utils.workspace = true