Add outgoing signers tests

Signed-off-by: Jacinta Ferrant <[email protected]>

Author: jferrant

.github/workflows/bitcoin-tests.yml

@@ -137,6 +137,7 @@ jobs:
           - tests::signer::v0::global_acceptance_depends_on_block_announcement
           - tests::signer::v0::no_reorg_due_to_successive_block_validation_ok
           - tests::signer::v0::incoming_signers_ignore_block_proposals
+          - tests::signer::v0::outgoing_signers_ignore_block_proposals
           - tests::nakamoto_integrations::burn_ops_integration_test
           - tests::nakamoto_integrations::check_block_heights
           - tests::nakamoto_integrations::clarity_burn_state

stacks-signer/src/runloop.rs

@@ -26,6 +26,8 @@ use stacks_common::{debug, error, info, warn};
 use crate::chainstate::SortitionsView;
 use crate::client::{retry_with_exponential_backoff, ClientError, StacksClient};
 use crate::config::{GlobalConfig, SignerConfig};
+#[cfg(any(test, feature = "testing"))]
+use crate::v0::tests::TEST_SKIP_SIGNER_CLEANUP;
 use crate::Signer as SignerTrait;
 
 #[derive(thiserror::Error, Debug)]
@@ -423,6 +425,11 @@ impl<Signer: SignerTrait<T>, T: StacksMessageCodec + Clone + Send + Debug> RunLo
     }
 
     fn cleanup_stale_signers(&mut self, current_reward_cycle: u64) {
+        #[cfg(any(test, feature = "testing"))]
+        if TEST_SKIP_SIGNER_CLEANUP.get() {
+            warn!("Skipping signer cleanup due to testing directive.");
+            return;
+        }
         let mut to_delete = Vec::new();
         for (idx, signer) in &mut self.stacks_signers {
             let reward_cycle = signer.reward_cycle();

stacks-signer/src/v0/tests.rs

@@ -45,6 +45,9 @@ pub static TEST_SKIP_BLOCK_BROADCAST: LazyLock<TestFlag<bool>> = LazyLock::new(T
 pub static TEST_STALL_BLOCK_VALIDATION_SUBMISSION: LazyLock<TestFlag<bool>> =
     LazyLock::new(TestFlag::default);
 
+/// A global variable that can be used to prevent signer cleanup
+pub static TEST_SKIP_SIGNER_CLEANUP: LazyLock<TestFlag<bool>> = LazyLock::new(TestFlag::default);
+
 impl Signer {
     /// Skip the block broadcast if the TEST_SKIP_BLOCK_BROADCAST flag is set
     pub fn test_skip_block_broadcast(&self, block: &NakamotoBlock) -> bool {

testnet/stacks-node/src/tests/signer/v0.rs

@@ -10346,10 +10346,6 @@ fn outgoing_signers_ignore_block_proposals() {
     let mined_blocks = signer_test.running_nodes.nakamoto_blocks_mined.clone();
     let blocks_before = mined_blocks.load(Ordering::SeqCst);
 
-    let old_signature_hash = test_observer::get_mined_nakamoto_blocks()
-        .last()
-        .unwrap()
-        .signer_signature_hash;
     test_observer::clear();
 
     info!("------------------------- Test Mine A Valid Block -------------------------");
@@ -10371,6 +10367,10 @@ fn outgoing_signers_ignore_block_proposals() {
     })
     .expect("Timed out waiting for a block to be mined");
 
+    let new_signature_hash = test_observer::get_mined_nakamoto_blocks()
+        .last()
+        .unwrap()
+        .signer_signature_hash;
     let blocks_before = mined_blocks.load(Ordering::SeqCst);
     let mut stackerdb = StackerDB::new(
         &signer_test.running_nodes.conf.node.rpc_bind,
@@ -10386,7 +10386,7 @@ fn outgoing_signers_ignore_block_proposals() {
         .map(|id| id.0)
         .collect();
 
-    let mut old_signers_ignore_block_proposals = || {
+    let mut old_signers_ignore_block_proposals = |hash| {
         let _ = wait_for(10, || {
             for slot_id in old_signer_slot_ids.iter() {
                 let latest_msgs = StackerDB::get_messages::<SignerMessage>(
@@ -10398,14 +10398,14 @@ fn outgoing_signers_ignore_block_proposals() {
                 .expect("Failed to get message from stackerdb");
                 for msg in latest_msgs.iter() {
                     if let SignerMessage::BlockResponse(response) = msg {
-                        assert_eq!(response.get_signer_signature_hash(), old_signature_hash);
+                        assert_ne!(response.get_signer_signature_hash(), hash);
                     }
                 }
             }
             Ok(false)
         });
     };
-    old_signers_ignore_block_proposals();
+    old_signers_ignore_block_proposals(new_signature_hash);
 
     let proposal_conf = ProposalEvalConfig {
         first_proposal_burn_block_timing: Duration::from_secs(0),
@@ -10434,7 +10434,7 @@ fn outgoing_signers_ignore_block_proposals() {
     signer_test
         .wait_for_block_rejections(30, &all_signers)
         .expect("Timed out waiting for block rejections");
-    old_signers_ignore_block_proposals();
+    old_signers_ignore_block_proposals(signer_signature_hash_1);
     test_observer::clear();
 
     // Propose a block to the signers that passes initial checks but will be rejected by the stacks node
@@ -10453,7 +10453,7 @@ fn outgoing_signers_ignore_block_proposals() {
     signer_test
         .wait_for_block_rejections(30, &all_signers)
         .expect("Timed out waiting for block rejections");
-    old_signers_ignore_block_proposals();
+    old_signers_ignore_block_proposals(signer_signature_hash_2);
 
     assert_eq!(blocks_before, mined_blocks.load(Ordering::SeqCst));
     signer_test.shutdown();