refactor: replace manual mocks with mockall in producer #3192
+164
−116
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -28,7 +28,6 @@ use fuel_core_types::{ | |
| }, | ||
| fuel_tx::Transaction, | ||
| fuel_types::{ | ||
| BlockHeight, | ||
| Bytes32, | ||
| ChainId, | ||
|
|
@@ -53,65 +52,161 @@ use std::{ | |
| Mutex, | ||
| }, | ||
| }; | ||
| // Mockall-generated mocks for testing | ||
| #[cfg(feature = "test-helpers")] | ||
| use mockall::mock; | ||
|
|
||
| #[cfg(feature = "test-helpers")] | ||
| mock! { | ||
| pub Relayer {} | ||
|
|
||
| #[async_trait::async_trait] | ||
| impl Relayer for Relayer { | ||
| async fn wait_for_at_least_height( | ||
| &self, | ||
| height: &DaBlockHeight, | ||
| ) -> anyhow::Result<DaBlockHeight>; | ||
|
|
||
| async fn get_cost_and_transactions_number_for_block( | ||
| &self, | ||
| height: &DaBlockHeight, | ||
| ) -> anyhow::Result<RelayerBlockInfo>; | ||
| } | ||
| } | ||
|
|
||
| // Re-export for backward compatibility during migration | ||
| #[cfg(feature = "test-helpers")] | ||
| pub use MockRelayer as MockRelayerLegacy; | ||
|
There was a problem hiding this comment. Unused
|
||
|
|
||
| // Helper function to create a MockRelayer with default behavior | ||
| #[cfg(feature = "test-helpers")] | ||
| pub fn create_mock_relayer( | ||
| latest_height: DaBlockHeight, | ||
| blocks_with_costs: HashMap<DaBlockHeight, (u64, u64)>, | ||
| ) -> MockRelayer { | ||
| let mut mock = MockRelayer::new(); | ||
|
|
||
| // Default behavior: return the latest height | ||
| mock.expect_wait_for_at_least_height() | ||
| .returning(move |_| Ok(latest_height)); | ||
|
|
||
| // Default behavior: return gas cost and tx count from the map | ||
| mock.expect_get_cost_and_transactions_number_for_block() | ||
| .returning(move |height| { | ||
| let (gas_cost, tx_count) = | ||
| blocks_with_costs.get(height).cloned().unwrap_or_default(); | ||
| Ok(RelayerBlockInfo { gas_cost, tx_count }) | ||
| }); | ||
|
|
||
| mock | ||
| } | ||
|
|
||
| // MockTxPool with associated type | ||
| #[cfg(feature = "test-helpers")] | ||
| mock! { | ||
| pub TxPool {} | ||
|
|
||
| impl TxPool for TxPool { | ||
| type TxSource = Vec<Transaction>; | ||
|
|
||
| async fn get_source(&self, gas_price: u64, block_height: BlockHeight) -> anyhow::Result<Vec<Transaction>>; | ||
| } | ||
| } | ||
|
|
||
| // Helper function to create a MockTxPool with default behavior | ||
| #[cfg(feature = "test-helpers")] | ||
| pub fn create_mock_txpool(transactions: Vec<Transaction>) -> MockTxPool { | ||
| let mut mock = MockTxPool::new(); | ||
|
|
||
| // Default behavior: return the transactions | ||
| mock.expect_get_source() | ||
| .returning(move |_, _| Ok(transactions.clone())); | ||
|
|
||
| mock | ||
| } | ||
|
|
||
| // MockExecutor - BlockProducer implementation | ||
| #[cfg(feature = "test-helpers")] | ||
| mock! { | ||
| pub Executor {} | ||
|
|
||
| impl BlockProducer<Vec<Transaction>> for Executor { | ||
| type Deadline = (); | ||
|
|
||
| async fn produce_without_commit( | ||
| &self, | ||
| component: Components<Vec<Transaction>>, | ||
| deadline: (), | ||
| ) -> ExecutorResult<UncommittedResult<Changes>>; | ||
| } | ||
| } | ||
|
|
||
| // Helper function to create a MockExecutor with default successful behavior | ||
| #[cfg(feature = "test-helpers")] | ||
| pub fn create_mock_executor(db: MockDb) -> MockExecutor { | ||
| let mut mock = MockExecutor::new(); | ||
|
|
||
| // Default behavior: create a block and insert it into the database | ||
| mock.expect_produce_without_commit() | ||
| .returning(move |component, _| { | ||
| let block = arc_pool_tx_comp_to_block(&component); | ||
| // simulate executor inserting a block | ||
| let mut block_db = db.blocks.lock().unwrap(); | ||
| block_db.insert( | ||
| *block.header().height(), | ||
| block.compress(&ChainId::default()), | ||
| ); | ||
| Ok(UncommittedResult::new( | ||
| ExecutionResult { | ||
| block, | ||
| skipped_transactions: vec![], | ||
| tx_status: vec![], | ||
| events: vec![], | ||
| }, | ||
| Default::default(), | ||
| )) | ||
| }); | ||
|
|
||
| mock | ||
| } | ||
|
|
||
| // Helper function to create a failing MockExecutor | ||
| // This replaces the old FailingMockExecutor struct | ||
| // Fails once with the provided error, then succeeds on subsequent calls | ||
| #[cfg(feature = "test-helpers")] | ||
| pub fn create_failing_mock_executor(error: ExecutorError, db: MockDb) -> MockExecutor { | ||
| let mut mock = MockExecutor::new(); | ||
|
|
||
| // First call: fail with the provided error | ||
| mock.expect_produce_without_commit() | ||
| .times(1) | ||
| .return_once(move |_, _| Err(error)); | ||
|
|
||
| // Subsequent calls: succeed with standard executor logic | ||
| mock.expect_produce_without_commit() | ||
| .returning(move |component, _| { | ||
| let block = arc_pool_tx_comp_to_block(&component); | ||
| let mut block_db = db.blocks.lock().unwrap(); | ||
| block_db.insert( | ||
| *block.header().height(), | ||
| block.compress(&ChainId::default()), | ||
| ); | ||
| Ok(UncommittedResult::new( | ||
| ExecutionResult { | ||
| block, | ||
| skipped_transactions: vec![], | ||
| tx_status: vec![], | ||
| events: vec![], | ||
| }, | ||
| Default::default(), | ||
| )) | ||
| }); | ||
|
|
||
| mock | ||
| } | ||
|
raushan728 marked this conversation as resolved.
|
||
|
|
||
| // Helper functions for block creation (used by mocks) | ||
| #[cfg(feature = "test-helpers")] | ||
| fn arc_pool_tx_comp_to_block(component: &Components<Vec<Transaction>>) -> Block { | ||
| let transactions = component.transactions_source.clone(); | ||
| Block::new( | ||
|
|
@@ -125,59 +220,15 @@ fn arc_pool_tx_comp_to_block(component: &Components<Vec<Transaction>>) -> Block | |
| .unwrap() | ||
| } | ||
|
|
||
| impl AsMut<MockDb> for MockDb { | ||
| fn as_mut(&mut self) -> &mut MockDb { | ||
| self | ||
| } | ||
| } | ||
|
|
||
| impl AsRef<MockDb> for MockDb { | ||
| fn as_ref(&self) -> &MockDb { | ||
| self | ||
| } | ||
| } | ||
|
|
||
|
|
||
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.
Uh oh!
There was an error while loading. Please reload this page.