refactor: consolidate test fixtures into test-utils crate (#260)

* refactor: consolidate test fixtures into test-utils crate

- Add fixtures module to test-utils with shared test data
- Move BLOCK_INFO_TXN, BLOCK_INFO_TXN_HASH constants to fixtures
- Move load_genesis() and create_provider_factory() to fixtures
- Update flashblocks and rpc tests to use test-utils fixtures
- Remove duplicate genesis.json files from flashblocks and rpc
- Remove duplicate common modules from test directories

Closes #244

* fix(ci): style fix

---------

Co-authored-by: refcell <abigger87@gmail.com>

Author: Himess

crates/flashblocks/tests/assets/genesis.json

@@ -1,7 +1,5 @@
 //! Integration tests that stress Flashblocks state handling.
 
-mod common;
-
 use std::{sync::Arc, time::Duration};
 
 use alloy_consensus::{Receipt, Transaction};
@@ -12,9 +10,11 @@ use base_reth_flashblocks::{
     Flashblock, FlashblocksAPI, FlashblocksState, Metadata, PendingBlocksAPI,
 };
 use base_reth_test_utils::{
-    accounts::TestAccounts, flashblocks_harness::FlashblocksHarness, node::LocalNodeProvider,
+    accounts::TestAccounts,
+    fixtures::{BLOCK_INFO_TXN, BLOCK_INFO_TXN_HASH},
+    flashblocks_harness::FlashblocksHarness,
+    node::LocalNodeProvider,
 };
-use common::{BLOCK_INFO_TXN, BLOCK_INFO_TXN_HASH};
 use op_alloy_consensus::OpDepositReceipt;
 use op_alloy_network::BlockResponse;
 use reth::{

crates/flashblocks/tests/common/mod.rs

@@ -1,7 +1,5 @@
 //! Integration tests covering the Flashblocks RPC surface area.
 
-mod common;
-
 use std::str::FromStr;
 
 use alloy_consensus::{Receipt, Transaction};
@@ -16,8 +14,10 @@ use alloy_rpc_types_engine::PayloadId;
 use alloy_rpc_types_eth::{TransactionInput, error::EthRpcErrorCode};
 use alloy_sol_macro::sol;
 use base_reth_flashblocks::{Flashblock, Metadata};
-use base_reth_test_utils::flashblocks_harness::FlashblocksHarness;
-use common::{BLOCK_INFO_TXN, BLOCK_INFO_TXN_HASH};
+use base_reth_test_utils::{
+    fixtures::{BLOCK_INFO_TXN, BLOCK_INFO_TXN_HASH},
+    flashblocks_harness::FlashblocksHarness,
+};
 use eyre::Result;
 use futures_util::{SinkExt, StreamExt};
 use op_alloy_consensus::OpDepositReceipt;

crates/flashblocks/tests/state.rs

@@ -1,13 +1,13 @@
 //! Integration tests covering the Metering logic surface area.
-mod common;
+
 use std::sync::Arc;
 
 use alloy_consensus::crypto::secp256k1::public_key_to_address;
 use alloy_eips::Encodable2718;
 use alloy_genesis::GenesisAccount;
 use alloy_primitives::{Address, B256, Bytes, U256, keccak256};
 use base_reth_rpc::meter_bundle;
-use common::create_provider_factory;
+use base_reth_test_utils::fixtures::create_provider_factory;
 use eyre::Context;
 use op_alloy_consensus::OpTxEnvelope;
 use rand::{SeedableRng, rngs::StdRng};

crates/rpc/tests/common/genesis.json

@@ -1,13 +1,12 @@
 //! Integration tests covering the Metering RPC surface area.
-mod common;
+
 use std::{any::Any, net::SocketAddr, sync::Arc};
 
 use alloy_eips::Encodable2718;
 use alloy_primitives::{Bytes, U256, address, b256, bytes};
 use alloy_rpc_client::RpcClient;
 use base_reth_rpc::{MeterBundleResponse, MeteringApiImpl, MeteringApiServer};
-use base_reth_test_utils::tracing::init_silenced_tracing;
-use common::load_genesis;
+use base_reth_test_utils::{fixtures::load_genesis, tracing::init_silenced_tracing};
 use op_alloy_consensus::OpTxEnvelope;
 use reth::{
     args::{DiscoveryArgs, NetworkArgs, RpcServerArgs},

crates/rpc/tests/flashblocks_rpc.rs

@@ -1,4 +1,4 @@
-#![allow(dead_code)]
+//! Shared fixtures and test data reused by integration tests across the Base codebase.
 
 use std::sync::Arc;
 
@@ -11,15 +11,23 @@ use reth_db::{
     test_utils::{ERROR_DB_CREATION, TempDatabase, create_test_static_files_dir, tempdir_path},
 };
 use reth_provider::{ProviderFactory, providers::StaticFileProvider};
-use serde_json;
 
-pub(crate) const BLOCK_INFO_TXN: Bytes = bytes!(
+/// Sample L1 block info transaction used in tests.
+pub const BLOCK_INFO_TXN: Bytes = bytes!(
     "0x7ef90104a06c0c775b6b492bab9d7e81abdf27f77cafb698551226455a82f559e0f93fea3794deaddeaddeaddeaddeaddeaddeaddeaddead00019442000000000000000000000000000000000000158080830f424080b8b0098999be000008dd00101c1200000000000000020000000068869d6300000000015f277f000000000000000000000000000000000000000000000000000000000d42ac290000000000000000000000000000000000000000000000000000000000000001abf52777e63959936b1bf633a2a643f0da38d63deffe49452fed1bf8a44975d50000000000000000000000005050f69a9786f081509234f1a7f4684b5e5b76c9000000000000000000000000"
 );
-pub(crate) const BLOCK_INFO_TXN_HASH: B256 =
+
+/// Hash of the sample L1 block info transaction.
+pub const BLOCK_INFO_TXN_HASH: B256 =
     b256!("0xba56c8b0deb460ff070f8fca8e2ee01e51a3db27841cc862fdd94cc1a47662b6");
 
-pub(crate) fn create_provider_factory<N: NodeTypes>(
+/// Loads the shared test genesis configuration.
+pub fn load_genesis() -> Genesis {
+    serde_json::from_str(include_str!("../assets/genesis.json")).unwrap()
+}
+
+/// Creates a provider factory for tests with the given chain spec.
+pub fn create_provider_factory<N: NodeTypes>(
     chain_spec: Arc<N::ChainSpec>,
 ) -> ProviderFactory<NodeTypesWithDBAdapter<N, Arc<TempDatabase<DatabaseEnv>>>> {
     let (static_dir, _) = create_test_static_files_dir();
@@ -31,10 +39,7 @@ pub(crate) fn create_provider_factory<N: NodeTypes>(
     )
 }
 
-pub(crate) fn load_genesis() -> Genesis {
-    serde_json::from_str(include_str!("genesis.json")).unwrap()
-}
-
+/// Creates a temporary test database.
 fn create_test_db() -> Arc<TempDatabase<DatabaseEnv>> {
     let path = tempdir_path();
     let emsg = format!("{ERROR_DB_CREATION}: {path:?}");

crates/rpc/tests/meter.rs

@@ -5,6 +5,8 @@
 pub mod accounts;
 /// Ergonomic wrapper around the Engine API clients used by the harness.
 pub mod engine;
+/// Shared fixtures and test data reused by integration tests.
+pub mod fixtures;
 /// Flashblocks-aware harness helpers.
 pub mod flashblocks_harness;
 /// High-level façade for interacting with a local Base node.