test: refactor integration test to simplify understanding

Co-authored-by: Sébastien Fauvel <[email protected]>

Author: dlachaume

mithril-signer/tests/create_cardano_transaction_single_signature.rs

@@ -58,20 +58,20 @@ async fn test_create_cardano_transaction_single_signature() {
         .cycle_unregistered().await.unwrap()
 
         .comment("signer can now create a single signature → ReadyToSign")
-        .cycle_ready_to_sign().await.unwrap()
+        .cycle_ready_to_sign_no_registration().await.unwrap()
 
         .comment("creating a new certificate pending with a cardano transaction signed entity → ReadyToSign")
         .increase_block_number_and_slot_number(70, SlotNumber(80), BlockNumber(170)).await.unwrap()
-        .cycle_ready_to_sign().await.unwrap()
+        .cycle_ready_to_sign_with_signature_registration().await.unwrap()
 
         .comment("more cycles do not change the state = ReadyToSign")
-        .cycle_ready_to_sign().await.unwrap()
-        .cycle_ready_to_sign().await.unwrap()
+        .cycle_ready_to_sign_no_registration().await.unwrap()
+        .cycle_ready_to_sign_no_registration().await.unwrap()
 
         .comment("new blocks means a new signature with the same stake distribution → ReadyToSign")
         .increase_block_number_and_slot_number(125, SlotNumber(205), BlockNumber(295)).await.unwrap()
         .cardano_chain_send_rollback(SlotNumber(205), BlockNumber(230)).await.unwrap()
-        .cycle_ready_to_sign().await.unwrap()
+        .cycle_ready_to_sign_with_signature_registration().await.unwrap()
 
         .comment("metrics should be correctly computed")
         .check_metrics(total_signer_registrations_expected,total_signature_registrations_expected).await.unwrap()

mithril-signer/tests/create_immutable_files_full_single_signature.rs

@@ -81,38 +81,29 @@ async fn test_create_immutable_files_full_single_signature() {
         .cycle_unregistered().await.unwrap()
         .check_era_checker_last_updated_at(Epoch(4)).await.unwrap()
 
-        .comment("creating a new certificate pending with new signers and new beacon → ReadyToSign")
-        .cycle_ready_to_sign().await.unwrap()
+        .comment("signer can now create a single signature → ReadyToSign")
+        .cycle_ready_to_sign_no_registration().await.unwrap()
         .check_protocol_initializer(Epoch(4)).await.unwrap()
 
-        .comment("signer can now create a single signature → ReadyToSign")
-        .cycle_ready_to_sign().await.unwrap()
         .comment("signer signs a single signature = ReadyToSign")
-        .cycle_ready_to_sign().await.unwrap()
-        // TODO?
-        // .expect_new_signature()
+        .cycle_ready_to_sign_with_signature_registration().await.unwrap()
 
-        // Should we remove this case?
-        //.comment("more cycles do not change the state = ReadyToSign")
-        //.cycle_ready_to_sign().await.unwrap()
-        // .cycle_ready_to_sign().await.unwrap()
+        .comment("more cycles do not change the state = ReadyToSign")
+        .cycle_ready_to_sign_no_registration().await.unwrap()
 
         .comment("new immutable means a new signature with the same stake distribution → ReadyToSign")
         .increase_immutable(1, 9).await.unwrap()
-        .cycle_ready_to_sign().await.unwrap()
-        // TODO?
-        // .expect_new_signature()
+        .cycle_ready_to_sign_with_signature_registration().await.unwrap()
 
         .comment("changing epoch changes the state → Unregistered")
         .increase_epoch(5).await.unwrap()
         .cycle_unregistered().await.unwrap()
         .check_era_checker_last_updated_at(Epoch(5)).await.unwrap()
         .comment("signer should be able to create a single signature → ReadyToSign")
-        .cycle_ready_to_sign().await.unwrap()
-        .cycle_ready_to_sign().await.unwrap()
-        // TODO?
-        // .expect_new_signature()
-        //.check_total_signature_registrations_metrics(3).await.unwrap()
+
+        .check_total_signature_registrations_metrics(2).unwrap()
+        .cycle_ready_to_sign_no_registration().await.unwrap()
+        .cycle_ready_to_sign_with_signature_registration().await.unwrap()
         .check_protocol_initializer(Epoch(5)).await.unwrap()
 
         .comment("metrics should be correctly computed")

mithril-signer/tests/test_extensions/state_machine_tester.rs

@@ -334,6 +334,28 @@ impl StateMachineTester {
         )
     }
 
+    pub async fn cycle_ready_to_sign_no_registration(&mut self) -> Result<&mut Self> {
+        let metric_before = self
+            .metrics_service
+            .signature_registration_success_since_startup_counter_get();
+
+        self.cycle_ready_to_sign().await?;
+
+        let expected_metric = metric_before;
+        self.check_total_signature_registrations_metrics(expected_metric)
+    }
+
+    pub async fn cycle_ready_to_sign_with_signature_registration(&mut self) -> Result<&mut Self> {
+        let metric_before = self
+            .metrics_service
+            .signature_registration_success_since_startup_counter_get();
+
+        self.cycle_ready_to_sign().await?;
+
+        let expected_metric = metric_before + 1;
+        self.check_total_signature_registrations_metrics(expected_metric)
+    }
+
     /// cycle the state machine and test the resulting state
     pub async fn cycle_registered_not_able_to_sign(&mut self) -> Result<&mut Self> {
         self.cycle().await?;
@@ -623,6 +645,20 @@ impl StateMachineTester {
         .collect::<BTreeMap<_, _>>())
     }
 
+    pub fn check_total_signature_registrations_metrics(
+        &mut self,
+        expected_metric: u32,
+    ) -> Result<&mut Self> {
+        let metric = self
+            .metrics_service
+            .signature_registration_success_since_startup_counter_get();
+
+        self.assert(
+            expected_metric == metric,
+            format!("Total signature registrations metric: given {metric:?}, expected {expected_metric:?}"),
+        )
+    }
+
     // Check that the metrics service exports the expected metrics
     pub async fn check_metrics(
         &mut self,