test: reuse cache for fork mode tests (#4897)

agostbiro · web-flow · commit 23d102c5f567 · 2024-02-20T19:47:43.000-06:00
diff --git a/.github/workflows/hardhat-core-ci.yml b/.github/workflows/hardhat-core-ci.yml
@@ -197,6 +197,13 @@ jobs:
 
       - uses: Swatinem/rust-cache@v2
 
+      - name: Cache EDR RPC cache
+        uses: actions/cache@v2
+        with:
+          path: |
+            **/edr-cache
+          key: edr-rs-rpc-cache-v1
+
       - name: Run cargo test
         uses: actions-rs/cargo@v1
         env:
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/crates/edr_eth/Cargo.toml b/crates/edr_eth/Cargo.toml
@@ -33,6 +33,7 @@ url = "2.4.1"
 [dev-dependencies]
 anyhow = "1.0.75"
 assert-json-diff = "2.0.2"
+edr_defaults = { version = "0.2.0-dev", path = "../edr_defaults" }
 lazy_static = "1.4.0"
 mockito = { version = "1.0.2", default-features = false }
 paste = { version = "1.0.14", default-features = false }
diff --git a/crates/edr_eth/tests/receipt.rs b/crates/edr_eth/tests/receipt.rs
@@ -1,13 +1,6 @@
 #[cfg(feature = "test-remote")]
 mod remote {
-    use lazy_static::lazy_static;
     use serial_test::serial;
-    use tempfile::TempDir;
-
-    lazy_static! {
-        // Use same cache dir for all tests
-        static ref CACHE_DIR: TempDir = TempDir::new().unwrap();
-    }
 
     macro_rules! impl_test_remote_block_receipt_root {
         ($(
@@ -21,7 +14,7 @@ mod remote {
                         use edr_eth::{remote::{RpcClient, PreEip1898BlockSpec}, trie::ordered_trie_root};
                         use edr_test_utils::env::get_alchemy_url;
 
-                        let client = RpcClient::new(&get_alchemy_url(), CACHE_DIR.path().into(), None).expect("url ok");
+                        let client = RpcClient::new(&get_alchemy_url(), edr_defaults::CACHE_DIR.into(), None).expect("url ok");
 
                         let block = client
                             .get_block_by_number_with_transaction_data(PreEip1898BlockSpec::Number($block_number))
diff --git a/crates/edr_evm/tests/blockchain.rs b/crates/edr_evm/tests/blockchain.rs
@@ -15,14 +15,7 @@ use edr_evm::{
     test_utils::dummy_eip155_transaction,
     HashSet, LocalBlock, Log, SpecId, SyncBlock,
 };
-use lazy_static::lazy_static;
 use serial_test::serial;
-use tempfile::TempDir;
-
-lazy_static! {
-    // Use same cache dir for all tests
-    static ref CACHE_DIR: TempDir = TempDir::new().unwrap();
-}
 
 #[cfg(feature = "test-remote")]
 const REMOTE_BLOCK_NUMBER: u64 = 10_496_585;
@@ -48,8 +41,8 @@ async fn create_forked_dummy_blockchain(
     use edr_test_utils::env::get_alchemy_url;
     use parking_lot::Mutex;
 
-    let cache_dir = CACHE_DIR.path().into();
-    let rpc_client = RpcClient::new(&get_alchemy_url(), cache_dir, None).expect("url ok");
+    let rpc_client =
+        RpcClient::new(&get_alchemy_url(), edr_defaults::CACHE_DIR.into(), None).expect("url ok");
 
     Box::new(
         ForkedBlockchain::new(
diff --git a/crates/edr_evm/tests/transaction.rs b/crates/edr_evm/tests/transaction.rs
@@ -14,10 +14,8 @@ mod alchemy {
                         };
                         use edr_evm::ExecutableTransaction;
                         use edr_test_utils::env::get_alchemy_url;
-                        use tempfile::TempDir;
 
-                        let tempdir = TempDir::new().unwrap();
-                        let client = RpcClient::new(&get_alchemy_url(), tempdir.path().into(), None).expect("url ok");
+                        let client = RpcClient::new(&get_alchemy_url(), edr_defaults::CACHE_DIR.into(), None).expect("url ok");
 
                         let block = client
                             .get_block_by_number_with_transaction_data(PreEip1898BlockSpec::Number($block_number))
diff --git a/crates/edr_provider/Cargo.toml b/crates/edr_provider/Cargo.toml
@@ -29,6 +29,7 @@ lru = "0.12.2"
 anyhow = "1.0.75"
 edr_test_utils = { version = "0.2.0-dev", path = "../edr_test_utils" }
 paste = { version = "1.0.14", default-features = false }
+serial_test = "2.0.0"
 tempfile = "3.7.1"
 
 [build-dependencies]
diff --git a/crates/edr_provider/src/data.rs b/crates/edr_provider/src/data.rs
@@ -2365,7 +2365,6 @@ pub(crate) mod test_utils {
     use anyhow::anyhow;
     use edr_eth::transaction::{Eip155TransactionRequest, TransactionKind, TransactionRequest};
     use edr_test_utils::env::get_alchemy_url;
-    use tempfile::TempDir;
 
     use super::*;
     use crate::{
@@ -2397,8 +2396,6 @@ pub(crate) mod test_utils {
     }
 
     pub(crate) struct ProviderTestFixture {
-        // We need to keep the tempdir and runtime alive for the duration of the test
-        _cache_dir: TempDir,
         _runtime: runtime::Runtime,
         pub config: ProviderConfig,
         pub provider_data: ProviderData<Infallible>,
@@ -2425,21 +2422,19 @@ pub(crate) mod test_utils {
                 }
             });
 
-            let cache_dir = TempDir::new()?;
-            let config = create_test_config_with_fork(cache_dir.path().to_path_buf(), fork);
+            let config = create_test_config_with_fork(fork);
 
             let runtime = runtime::Builder::new_multi_thread()
                 .worker_threads(1)
                 .enable_all()
                 .thread_name("provider-data-test")
                 .build()?;
 
-            Self::new(runtime, cache_dir, config)
+            Self::new(runtime, config)
         }
 
         pub fn new(
             runtime: tokio::runtime::Runtime,
-            cache_dir: TempDir,
             mut config: ProviderConfig,
         ) -> anyhow::Result<Self> {
             let logger = Box::<NoopLogger>::default();
@@ -2466,7 +2461,6 @@ pub(crate) mod test_utils {
             provider_data.impersonate_account(impersonated_account);
 
             Ok(Self {
-                _cache_dir: cache_dir,
                 _runtime: runtime,
                 config,
                 provider_data,
@@ -2539,13 +2533,14 @@ mod tests {
     use edr_evm::{hex, MineOrdering, RemoteBlock, TransactionError};
     use edr_test_utils::env::get_alchemy_url;
     use serde_json::json;
-    use tempfile::TempDir;
 
     use super::{test_utils::ProviderTestFixture, *};
     use crate::{
         data::inspector::tests::{deploy_console_log_contract, ConsoleLogTransaction},
         requests::eth::resolve_call_request,
-        test_utils::{create_test_config_with_fork, one_ether, FORK_BLOCK_NUMBER},
+        test_utils::{
+            create_test_config, create_test_config_with_fork, one_ether, FORK_BLOCK_NUMBER,
+        },
         MemPoolConfig, MiningConfig, ProviderConfig,
     };
 
@@ -3052,8 +3047,7 @@ mod tests {
 
     #[test]
     fn mine_and_commit_block_fifo_ordering() -> anyhow::Result<()> {
-        let cache_dir = TempDir::new()?;
-        let default_config = create_test_config_with_fork(cache_dir.path().to_path_buf(), None);
+        let default_config = create_test_config();
         let config = ProviderConfig {
             mining: MiningConfig {
                 mem_pool: MemPoolConfig {
@@ -3070,7 +3064,7 @@ mod tests {
             .thread_name("provider-data-test")
             .build()?;
 
-        let mut fixture = ProviderTestFixture::new(runtime, cache_dir, config)?;
+        let mut fixture = ProviderTestFixture::new(runtime, config)?;
 
         let transaction1 = fixture.signed_dummy_transaction(0, None)?;
         let transaction2 = fixture.signed_dummy_transaction(1, None)?;
@@ -3144,8 +3138,7 @@ mod tests {
 
     #[test]
     fn mine_and_commit_block_rewards_miner() -> anyhow::Result<()> {
-        let cache_dir = TempDir::new()?;
-        let default_config = create_test_config_with_fork(cache_dir.path().to_path_buf(), None);
+        let default_config = create_test_config();
         let config = ProviderConfig {
             hardfork: SpecId::BERLIN,
             ..default_config
@@ -3157,7 +3150,7 @@ mod tests {
             .thread_name("provider-data-test")
             .build()?;
 
-        let mut fixture = ProviderTestFixture::new(runtime, cache_dir, config)?;
+        let mut fixture = ProviderTestFixture::new(runtime, config)?;
 
         let miner = fixture.provider_data.beneficiary;
         let previous_miner_balance = fixture
@@ -3559,16 +3552,11 @@ mod tests {
             .thread_name("provider-data-test")
             .build()?;
 
-        let cache_dir = TempDir::new()?;
-
-        let default_config = create_test_config_with_fork(
-            cache_dir.path().to_path_buf(),
-            Some(ForkConfig {
-                json_rpc_url: get_alchemy_url(),
-                block_number: Some(EIP_1559_ACTIVATION_BLOCK),
-                http_headers: None,
-            }),
-        );
+        let default_config = create_test_config_with_fork(Some(ForkConfig {
+            json_rpc_url: get_alchemy_url(),
+            block_number: Some(EIP_1559_ACTIVATION_BLOCK),
+            http_headers: None,
+        }));
 
         let config = ProviderConfig {
             block_gas_limit: 1_000_000,
@@ -3579,7 +3567,7 @@ mod tests {
             ..default_config
         };
 
-        let mut fixture = ProviderTestFixture::new(runtime, cache_dir, config)?;
+        let mut fixture = ProviderTestFixture::new(runtime, config)?;
 
         let default_call = CallRequest {
             from: Some(fixture.nth_local_account(0)?),
@@ -3677,6 +3665,7 @@ mod tests {
         )+) => {
             $(
                 paste::item! {
+                    #[serial_test::serial]
                     #[test]
                     fn [<full_block_ $name>]() -> anyhow::Result<()> {
                         let url = $url;
@@ -3727,15 +3716,20 @@ mod tests {
     }
 
     fn run_full_block(url: String, block_number: u64, chain_id: u64) -> anyhow::Result<()> {
+        let default_config = create_test_config_with_fork(Some(ForkConfig {
+            json_rpc_url: url.clone(),
+            block_number: Some(block_number - 1),
+            http_headers: None,
+        }));
+
         let runtime = runtime::Builder::new_multi_thread()
             .worker_threads(1)
             .enable_all()
             .thread_name("provider-data-test")
             .build()?;
 
-        let cache_dir = TempDir::new()?;
         let replay_block = {
-            let rpc_client = RpcClient::new(&url, cache_dir.path().to_path_buf(), None)?;
+            let rpc_client = RpcClient::new(&url, default_config.cache_dir.clone(), None)?;
 
             let block = runtime.block_on(rpc_client.get_block_by_number_with_transaction_data(
                 PreEip1898BlockSpec::Number(block_number),
@@ -3751,15 +3745,6 @@ mod tests {
             .hardfork_at_block_number(block_number)
             .ok_or(anyhow!("Unsupported block number"))?;
 
-        let default_config = create_test_config_with_fork(
-            cache_dir.path().to_path_buf(),
-            Some(ForkConfig {
-                json_rpc_url: url,
-                block_number: Some(block_number - 1),
-                http_headers: None,
-            }),
-        );
-
         let replay_header = replay_block.header();
         let block_gas_limit = replay_header.gas_limit;
 
@@ -3781,7 +3766,7 @@ mod tests {
             ..default_config
         };
 
-        let mut fixture = ProviderTestFixture::new(runtime, cache_dir, config)?;
+        let mut fixture = ProviderTestFixture::new(runtime, config)?;
 
         for transaction in replay_block.transactions() {
             fixture
diff --git a/crates/edr_provider/src/test_utils.rs b/crates/edr_provider/src/test_utils.rs
@@ -1,4 +1,4 @@
-use std::{convert::Infallible, path::PathBuf, time::SystemTime};
+use std::{convert::Infallible, time::SystemTime};
 
 use edr_eth::{
     block::BlobGas, signature::secret_key_from_str, trie::KECCAK_NULL_RLP, Address, HashMap,
@@ -19,18 +19,15 @@ pub const TEST_SECRET_KEY_SIGN_TYPED_DATA_V4: &str =
 pub const FORK_BLOCK_NUMBER: u64 = 18_725_000;
 
 /// Constructs a test config with a single account with 1 ether
-pub fn create_test_config(cache_dir: PathBuf) -> ProviderConfig {
-    create_test_config_with_fork(cache_dir, None)
+pub fn create_test_config() -> ProviderConfig {
+    create_test_config_with_fork(None)
 }
 
 pub fn one_ether() -> U256 {
     U256::from(10).pow(U256::from(18))
 }
 
-pub fn create_test_config_with_fork(
-    cache_dir: PathBuf,
-    fork: Option<ForkConfig>,
-) -> ProviderConfig {
+pub fn create_test_config_with_fork(fork: Option<ForkConfig>) -> ProviderConfig {
     ProviderConfig {
         accounts: vec![
             AccountConfig {
@@ -65,7 +62,7 @@ pub fn create_test_config_with_fork(
         min_gas_price: U256::ZERO,
         mining: MiningConfig::default(),
         network_id: 123,
-        cache_dir,
+        cache_dir: edr_defaults::CACHE_DIR.into(),
     }
 }
 
