refactor(starknet_integration_tests): wrap the storage handles in a sub-struct

Author: nadin-Starkware

crates/starknet_integration_tests/src/flow_test_setup.rs

@@ -49,12 +49,11 @@ use starknet_sequencer_node::servers::run_component_servers;
 use starknet_sequencer_node::utils::create_node_modules;
 use starknet_state_sync::config::StateSyncConfig;
 use starknet_types_core::felt::Felt;
-use tempfile::TempDir;
 use tokio::sync::Mutex;
 use tracing::{debug, instrument};
 use url::Url;
 
-use crate::state_reader::StorageTestSetup;
+use crate::state_reader::{StorageTestHandles, StorageTestSetup};
 use crate::utils::{
     create_consensus_manager_configs_from_network_configs,
     create_mempool_p2p_configs,
@@ -179,9 +178,7 @@ pub struct FlowSequencerSetup {
     pub add_tx_http_client: HttpTestClient,
 
     // Handlers for the storage files, maintained so the files are not deleted.
-    pub batcher_storage_file_handle: Option<TempDir>,
-    pub state_sync_storage_file_handle: Option<TempDir>,
-    pub class_manager_storage_file_handles: Option<starknet_class_manager::test_utils::FileHandles>,
+    pub storage_handles: StorageTestHandles,
 
     // Node configuration.
     pub node_config: SequencerNodeConfig,
@@ -210,12 +207,8 @@ impl FlowSequencerSetup {
         block_max_capacity_sierra_gas: GasAmount,
     ) -> Self {
         let path = None;
-        let StorageTestSetup {
-            storage_config,
-            batcher_storage_handle,
-            state_sync_storage_handle,
-            class_manager_storage_handles,
-        } = StorageTestSetup::new(accounts, &chain_info, path);
+        let StorageTestSetup { storage_config, storage_handles } =
+            StorageTestSetup::new(accounts, &chain_info, path);
 
         let (recorder_url, _join_handle) =
             spawn_local_success_recorder(available_ports.get_next_port());
@@ -264,9 +257,7 @@ impl FlowSequencerSetup {
         Self {
             node_index,
             add_tx_http_client,
-            batcher_storage_file_handle: batcher_storage_handle,
-            state_sync_storage_file_handle: state_sync_storage_handle,
-            class_manager_storage_file_handles: class_manager_storage_handles,
+            storage_handles,
             node_config,
             monitoring_client,
             clients,

crates/starknet_integration_tests/src/integration_test_manager.rs

@@ -21,7 +21,6 @@ use starknet_api::core::{ChainId, Nonce};
 use starknet_api::execution_resources::GasAmount;
 use starknet_api::rpc_transaction::RpcTransaction;
 use starknet_api::transaction::TransactionHash;
-use starknet_class_manager::test_utils::FileHandles;
 use starknet_http_server::config::HttpServerConfig;
 use starknet_http_server::test_utils::HttpTestClient;
 use starknet_infra_utils::test_utils::{AvailablePortsGenerator, TestIdentifier};
@@ -36,7 +35,6 @@ use starknet_sequencer_node::config::node_config::{
     CONFIG_NON_POINTERS_WHITELIST,
 };
 use starknet_sequencer_node::test_utils::node_runner::{get_node_executable_path, spawn_run_node};
-use tempfile::TempDir;
 use tokio::join;
 use tokio::task::JoinHandle;
 use tracing::info;
@@ -55,6 +53,7 @@ use crate::node_component_configs::{
     NodeComponentConfigs,
 };
 use crate::sequencer_simulator_utils::SequencerSimulator;
+use crate::state_reader::StorageTestHandles;
 use crate::storage::{get_integration_test_storage, CustomPaths};
 use crate::utils::{
     create_consensus_manager_configs_from_network_configs,
@@ -91,11 +90,7 @@ pub struct NodeSetup {
     // these are only maintained to avoid dropping the handlers, private visibility suffices, and
     // as such, the '#[allow(dead_code)]' attributes are used to suppress the warning.
     #[allow(dead_code)]
-    batcher_storage_handle: Option<TempDir>,
-    #[allow(dead_code)]
-    state_sync_storage_handle: Option<TempDir>,
-    #[allow(dead_code)]
-    class_manager_storage_handles: Option<FileHandles>,
+    storage_handles: StorageTestHandles,
 }
 
 // TODO(Nadin): reduce the number of arguments.
@@ -107,9 +102,7 @@ impl NodeSetup {
         http_server_index: usize,
         state_sync_index: usize,
         add_tx_http_client: HttpTestClient,
-        batcher_storage_handle: Option<TempDir>,
-        state_sync_storage_handle: Option<TempDir>,
-        class_manager_storage_handles: Option<FileHandles>,
+        storage_handles: StorageTestHandles,
     ) -> Self {
         let len = executables.len();
 
@@ -133,9 +126,7 @@ impl NodeSetup {
             http_server_index,
             state_sync_index,
             add_tx_http_client,
-            batcher_storage_handle,
-            state_sync_storage_handle,
-            class_manager_storage_handles,
+            storage_handles,
         }
     }
 
@@ -807,9 +798,7 @@ pub async fn get_sequencer_setup_configs(
             http_server_index,
             state_sync_index,
             add_tx_http_client,
-            storage_setup.batcher_storage_handle,
-            storage_setup.state_sync_storage_handle,
-            storage_setup.class_manager_storage_handles,
+            storage_setup.storage_handles,
         ));
     }
 

crates/starknet_integration_tests/src/state_reader.rs

@@ -79,14 +79,28 @@ impl StorageTestConfig {
 }
 
 #[derive(Debug)]
-pub struct StorageTestSetup {
-    pub storage_config: StorageTestConfig,
-    // TODO(Nadin): wrap the handles in a sub-struct.
+pub struct StorageTestHandles {
     pub batcher_storage_handle: Option<TempDir>,
     pub state_sync_storage_handle: Option<TempDir>,
     pub class_manager_storage_handles: Option<TempDirHandlePair>,
 }
 
+impl StorageTestHandles {
+    pub fn new(
+        batcher_storage_handle: Option<TempDir>,
+        state_sync_storage_handle: Option<TempDir>,
+        class_manager_storage_handles: Option<TempDirHandlePair>,
+    ) -> Self {
+        Self { batcher_storage_handle, state_sync_storage_handle, class_manager_storage_handles }
+    }
+}
+
+#[derive(Debug)]
+pub struct StorageTestSetup {
+    pub storage_config: StorageTestConfig,
+    pub storage_handles: StorageTestHandles,
+}
+
 impl StorageTestSetup {
     pub fn new(
         test_defined_accounts: Vec<AccountTransactionGenerator>,
@@ -156,9 +170,11 @@ impl StorageTestSetup {
                 state_sync_storage_config,
                 class_manager_storage_config,
             ),
-            batcher_storage_handle,
-            state_sync_storage_handle,
-            class_manager_storage_handles,
+            storage_handles: StorageTestHandles::new(
+                batcher_storage_handle,
+                state_sync_storage_handle,
+                class_manager_storage_handles,
+            ),
         }
     }
 }

crates/starknet_integration_tests/src/storage.rs

@@ -115,12 +115,8 @@ pub fn get_integration_test_storage(
         })
     });
 
-    let StorageTestSetup {
-        mut storage_config,
-        batcher_storage_handle,
-        state_sync_storage_handle,
-        class_manager_storage_handles,
-    } = StorageTestSetup::new(accounts, chain_info, storage_exec_paths);
+    let StorageTestSetup { mut storage_config, storage_handles } =
+        StorageTestSetup::new(accounts, chain_info, storage_exec_paths);
 
     // Allow overriding the path with a custom prefix for Docker mode in system tests.
     if let Some(paths) = custom_paths {
@@ -156,8 +152,6 @@ pub fn get_integration_test_storage(
             storage_config.state_sync_storage_config,
             storage_config.class_manager_storage_config,
         ),
-        batcher_storage_handle,
-        state_sync_storage_handle,
-        class_manager_storage_handles,
+        storage_handles,
     }
 }