Merge pull request #3486 from massalabs/benph/reinstate-pool-tests

Reinstate pool tests

massa-execution-exports/src/test_exports/mock.rs

@@ -35,7 +35,7 @@ use std::{
 /// and is emitted in a thread-safe way by the mock whenever that method is called.
 /// Some variants wait for a response on their `response_tx` field, if present.
 /// See the documentation of `ExecutionController` for details on parameters and return values.
-#[derive(Clone)]
+#[derive(Debug, Clone)]
 pub enum MockExecutionControllerMessage {
     /// update blockclique status
     UpdateBlockcliqueStatus {

massa-pool-worker/src/operation_pool.rs

@@ -182,6 +182,10 @@ impl OperationPool {
     }
 
     /// get operations for block creation
+    ///
+    /// Searches the available operations, and selects the sub-set of operations that:
+    /// - fit inside the block
+    /// - is the most profitable for block producer
     pub fn get_block_operations(&self, slot: &Slot) -> (Vec<OperationId>, Storage) {
         // init list of selected operation IDs
         let mut op_ids = Vec::new();

massa-pool-worker/src/tests/operation_pool_tests.rs

@@ -19,7 +19,9 @@
 //!
 use super::tools::{create_some_operations, operation_pool_test};
 use crate::operation_pool::OperationPool;
-use massa_execution_exports::test_exports::MockExecutionController;
+use massa_execution_exports::test_exports::{
+    MockExecutionController, MockExecutionControllerMessage,
+};
 use massa_models::{
     address::Address,
     amount::Amount,
@@ -31,7 +33,7 @@ use massa_models::{
 use massa_pool_exports::{PoolChannels, PoolConfig};
 use massa_signature::KeyPair;
 use massa_storage::Storage;
-use std::str::FromStr;
+use std::{str::FromStr, time::Duration};
 use tokio::sync::broadcast;
 
 #[test]
@@ -76,9 +78,8 @@ fn get_transaction(expire_period: u64, fee: u64) -> SecureShareOperation {
 
 /// TODO refactor old tests
 #[test]
-#[ignore]
 fn test_pool() {
-    let (execution_controller, _execution_receiver) = MockExecutionController::new_with_receiver();
+    let (execution_controller, execution_receiver) = MockExecutionController::new_with_receiver();
     let pool_config = PoolConfig::default();
     let storage_base = Storage::create_root();
     let operation_sender = broadcast::channel(pool_config.broadcast_operations_capacity).0;
@@ -117,6 +118,26 @@ fn test_pool() {
             .get_thread(pool_config.thread_count);
         thread_tx_lists[op_thread as usize].push((op, start_period..=expire_period));
     }
+    std::thread::spawn(move || loop {
+        match execution_receiver.recv_timeout(Duration::from_millis(100)) {
+            // forward on the operations
+            Ok(MockExecutionControllerMessage::UnexecutedOpsAmong {
+                ops, response_tx, ..
+            }) => {
+                response_tx.send(ops).unwrap();
+            }
+            // we want the operations to be paid for...
+            Ok(MockExecutionControllerMessage::GetFinalAndCandidateBalance {
+                response_tx, ..
+            }) => response_tx
+                .send(vec![(
+                    Some(Amount::from_raw(60 * 1000000000)),
+                    Some(Amount::from_raw(60 * 1000000000)),
+                )])
+                .unwrap(),
+            _ => {}
+        }
+    });
 
     // sort from bigger fee to smaller and truncate
     for lst in thread_tx_lists.iter_mut() {
@@ -130,6 +151,7 @@ fn test_pool() {
             let target_slot = Slot::new(period, thread);
             let max_count = 3;
             let (ids, storage) = pool.get_block_operations(&target_slot);
+
             assert!(ids
                 .iter()
                 .map(|id| (
@@ -189,7 +211,7 @@ fn test_pool() {
         let fee = 1000;
         let expire_period: u64 = 300;
         let op = get_transaction(expire_period, fee);
-        let mut storage = Storage::create_root();
+        let mut storage = storage_base.clone_without_refs();
         storage.store_operations(vec![op.clone()]);
         pool.add_operations(storage);
         //TODO: compare

massa-pool-worker/src/tests/scenario.rs

@@ -19,6 +19,7 @@ use crate::tests::tools::create_some_operations;
 use crate::tests::tools::pool_test;
 use massa_execution_exports::test_exports::MockExecutionControllerMessage as ControllerMsg;
 use massa_models::address::Address;
+use massa_models::amount::Amount;
 use massa_models::operation::OperationId;
 use massa_models::prehash::PreHashSet;
 use massa_models::slot::Slot;
@@ -44,7 +45,6 @@ use massa_signature::KeyPair;
 /// The block operation storage built for all threads is expected to have the
 /// same length than those added previously.
 #[test]
-#[ignore]
 fn test_simple_get_operations() {
     let config = PoolConfig::default();
     pool_test(
@@ -58,14 +58,14 @@ fn test_simple_get_operations() {
             let unexecuted_ops = storage.get_op_refs().clone();
             pool_controller.add_operations(storage);
 
-            // start mock execution thread
+            // Start mock execution thread.
+            // Provides the data for `pool_controller.get_block_operations`
             std::thread::spawn(move || {
-                // TODO following behavior is not valid anymore
                 match execution_receiver.recv_timeout(Duration::from_millis(100)) {
                     Ok(ControllerMsg::UnexecutedOpsAmong { response_tx, .. }) => {
                         response_tx.send(unexecuted_ops.clone()).unwrap();
                     }
-                    Ok(_) => panic!("unexpected controller request"),
+                    Ok(op) => panic!("Expected `ControllerMsg::UnexecutedOpsAmong`, got {:?}", op),
                     Err(_) => panic!("execution never called"),
                 }
                 match execution_receiver.recv_timeout(Duration::from_millis(100)) {
@@ -76,22 +76,31 @@ fn test_simple_get_operations() {
                     }) => {
                         assert_eq!(addresses.len(), 1);
                         assert_eq!(addresses[0], creator_address);
-                        response_tx.send(vec![]).unwrap();
+                        response_tx
+                            .send(vec![(Some(Amount::from_raw(1)), Some(Amount::from_raw(1)))])
+                            .unwrap();
                     }
-                    Ok(_) => panic!("unexpected controller request"),
+                    Ok(op) => panic!(
+                        "Expected `ControllerMsg::GetFinalAndCandidateBalance`, got {:?}",
+                        op
+                    ),
                     Err(_) => panic!("execution never called"),
                 }
+
                 (0..9).for_each(|_| {
                     match execution_receiver.recv_timeout(Duration::from_millis(100)) {
                         Ok(ControllerMsg::UnexecutedOpsAmong { response_tx, .. }) => {
                             response_tx.send(unexecuted_ops.clone()).unwrap();
                         }
-                        Ok(_) => panic!("unexpected controller request"),
+                        Ok(op) => {
+                            panic!("Expected `ControllerMsg::UnexecutedOpsAmong`, got {:?}", op)
+                        }
                         Err(_) => panic!("execution never called"),
                     }
                 })
             });
 
+            // This is what we are testing....
             let block_operations_storage = pool_controller
                 .get_block_operations(&Slot::new(1, creator_thread))
                 .1;
@@ -114,12 +123,22 @@ fn launch_basic_get_block_operation_execution_mock(
         use ControllerMsg::GetFinalAndCandidateBalance as GetFinal;
         use ControllerMsg::UnexecutedOpsAmong as Unexecuted;
 
-        if let Ok(Unexecuted { response_tx, .. }) = receive(&recvr) {
-            response_tx.send(unexecuted_ops.clone()).unwrap();
+        match receive(&recvr) {
+            Ok(Unexecuted { response_tx, .. }) => response_tx.send(unexecuted_ops.clone()).unwrap(),
+            Ok(op) => panic!("Expected `ControllerMsg::UnexecutedOpsAmong`, got {:?}", op),
+            Err(_) => panic!("execution never called"),
         }
-        if let Ok(GetFinal { response_tx, .. }) = receive(&recvr) {
-            response_tx.send(vec![]).unwrap();
+        match receive(&recvr) {
+            Ok(GetFinal { response_tx, .. }) => response_tx
+                .send(vec![(Some(Amount::from_raw(1)), Some(Amount::from_raw(1)))])
+                .unwrap(),
+            Ok(op) => panic!(
+                "Expected `ControllerMsg::GetFinalAndCandidateBalance`, got {:?}",
+                op
+            ),
+            Err(_) => panic!("execution never called"),
         }
+
         (1..operations_len).for_each(|_| {
             if let Ok(Unexecuted { response_tx, .. }) = receive(&recvr) {
                 response_tx.send(unexecuted_ops.clone()).unwrap();
@@ -143,7 +162,6 @@ fn launch_basic_get_block_operation_execution_mock(
 /// The block operation storage built for all threads is expected to have
 /// only 5 operations.
 #[test]
-#[ignore]
 fn test_get_operations_overflow() {
     static OP_LEN: usize = 10;
     static MAX_OP_LEN: usize = 5;

massa-pool-worker/src/tests/tools.rs

@@ -52,6 +52,7 @@ pub fn create_some_operations(
         .collect()
 }
 
+/// Creates module mocks, providing the environment needed to run the provided closure
 pub fn pool_test<F>(cfg: PoolConfig, test: F)
 where
     F: FnOnce(