refactor(common): move crypto_helper test utilities to test::crypto_helper

Alenar · Alenar · commit 34ba51934770 · 2025-07-24T18:03:12.000+02:00
diff --git a/internal/mithril-dmq/src/message.rs b/internal/mithril-dmq/src/message.rs
@@ -92,9 +92,9 @@ impl DmqMessageBuilder {
 mod tests {
     use mithril_cardano_node_chain::test::double::FakeChainObserver;
     use mithril_common::{
-        crypto_helper::{KesSignerFake, TryToBytes},
+        crypto_helper::TryToBytes,
         entities::{BlockNumber, ChainPoint, TimePoint},
-        test::double::Dummy,
+        test::{crypto_helper::KesSignerFake, double::Dummy},
     };
 
     use super::*;
diff --git a/internal/mithril-dmq/src/publisher/pallas.rs b/internal/mithril-dmq/src/publisher/pallas.rs
@@ -91,9 +91,8 @@ mod tests {
 
     use mithril_cardano_node_chain::test::double::FakeChainObserver;
     use mithril_common::{
-        crypto_helper::KesSignerFake,
         current_function,
-        test::{TempDir, double::Dummy},
+        test::{TempDir, crypto_helper::KesSignerFake, double::Dummy},
     };
 
     use crate::test::{TestLogger, payload::DmqMessageTestPayload};
diff --git a/mithril-aggregator/src/database/query/certificate/get_certificate.rs b/mithril-aggregator/src/database/query/certificate/get_certificate.rs
@@ -60,8 +60,8 @@ impl Query for GetCertificateRecordQuery {
 #[cfg(test)]
 mod tests {
     use mithril_common::crypto_helper::ProtocolParameters;
-    use mithril_common::crypto_helper::tests_setup::setup_certificate_chain;
     use mithril_common::test::builder::CertificateChainBuilder;
+    use mithril_common::test::crypto_helper::setup_certificate_chain;
 
     use mithril_persistence::sqlite::ConnectionExtensions;
 
diff --git a/mithril-aggregator/src/database/query/certificate/insert_certificate.rs b/mithril-aggregator/src/database/query/certificate/insert_certificate.rs
@@ -40,7 +40,7 @@ impl Query for InsertCertificateRecordQuery {
 
 #[cfg(test)]
 mod tests {
-    use mithril_common::crypto_helper::tests_setup::setup_certificate_chain;
+    use mithril_common::test::crypto_helper::setup_certificate_chain;
     use mithril_persistence::sqlite::ConnectionExtensions;
 
     use crate::database::test_helper::main_db_connection;
diff --git a/mithril-aggregator/src/database/query/certificate/insert_or_replace_certificate.rs b/mithril-aggregator/src/database/query/certificate/insert_or_replace_certificate.rs
@@ -38,9 +38,8 @@ impl Query for InsertOrReplaceCertificateRecordQuery {
 mod tests {
     use std::collections::HashMap;
 
-    use mithril_common::crypto_helper::tests_setup::setup_certificate_chain;
     use mithril_common::entities::Epoch;
-    use mithril_common::test::double::fake_data;
+    use mithril_common::test::{crypto_helper::setup_certificate_chain, double::fake_data};
     use mithril_persistence::sqlite::ConnectionExtensions;
 
     use crate::database::query::{GetCertificateRecordQuery, InsertCertificateRecordQuery};
diff --git a/mithril-aggregator/src/database/record/certificate.rs b/mithril-aggregator/src/database/record/certificate.rs
@@ -384,7 +384,7 @@ impl SqLiteEntity for CertificateRecord {
 
 #[cfg(test)]
 mod tests {
-    use mithril_common::crypto_helper::tests_setup::setup_certificate_chain;
+    use mithril_common::test::crypto_helper::setup_certificate_chain;
 
     use super::*;
 
diff --git a/mithril-aggregator/src/database/repository/certificate_repository.rs b/mithril-aggregator/src/database/repository/certificate_repository.rs
@@ -164,7 +164,7 @@ impl SynchronizedCertificateStorer for CertificateRepository {
 
 #[cfg(test)]
 mod tests {
-    use mithril_common::crypto_helper::tests_setup::setup_certificate_chain;
+    use mithril_common::test::crypto_helper::setup_certificate_chain;
 
     use crate::database::test_helper::{insert_certificate_records, main_db_connection};
 
diff --git a/mithril-aggregator/src/message_adapters/to_cardano_transactions_proof_message.rs b/mithril-aggregator/src/message_adapters/to_cardano_transactions_proof_message.rs
@@ -60,6 +60,7 @@ fn try_adapt_set_proof_message(
 #[cfg(test)]
 mod tests {
     use mithril_common::crypto_helper::MKProof;
+    use mithril_common::test::crypto_helper::MKProofTestExtension;
     use mithril_common::test::double::Dummy;
 
     use super::*;
diff --git a/mithril-aggregator/src/multi_signer.rs b/mithril-aggregator/src/multi_signer.rs
@@ -143,11 +143,11 @@ mod tests {
     use std::sync::Arc;
     use tokio::sync::RwLock;
 
-    use mithril_common::crypto_helper::tests_setup::*;
     use mithril_common::entities::{CardanoDbBeacon, Epoch, SignedEntityType, SignerWithStake};
     use mithril_common::protocol::ToMessage;
     use mithril_common::test::{
         builder::MithrilFixtureBuilder,
+        crypto_helper::setup_message,
         double::{Dummy, fake_data},
     };
 
diff --git a/mithril-client/tests/extensions/fake_aggregator/cardano_transaction.rs b/mithril-client/tests/extensions/fake_aggregator/cardano_transaction.rs
@@ -1,6 +1,7 @@
 use mithril_client::common::{BlockNumber, ProtocolMessagePartKey};
 use mithril_client::{CardanoTransactionsProofs, CardanoTransactionsSetProof, MithrilCertificate};
 use mithril_common::crypto_helper::{MKProof, ProtocolMkProof};
+use mithril_common::test::crypto_helper::MKProofTestExtension;
 use mithril_common::test::double::Dummy;
 
 use crate::extensions::routes;
diff --git a/mithril-common/src/certificate_chain/certificate_verifier.rs b/mithril-common/src/certificate_chain/certificate_verifier.rs
@@ -423,13 +423,16 @@ mod tests {
     use async_trait::async_trait;
     use tokio::sync::Mutex;
 
-    use crate::certificate_chain::certificate_retriever::MockCertificateRetriever;
-    use crate::crypto_helper::{ProtocolClerk, tests_setup::*};
-    use crate::test::TestLogger;
-    use crate::test::builder::{
-        CertificateChainBuilder, CertificateChainBuilderContext, MithrilFixtureBuilder,
+    use crate::test::{
+        TestLogger,
+        builder::{CertificateChainBuilder, CertificateChainBuilderContext, MithrilFixtureBuilder},
+        crypto_helper::{setup_certificate_chain, setup_message, setup_protocol_parameters},
+        double::FakeCertificaterRetriever,
+    };
+    use crate::{
+        certificate_chain::certificate_retriever::MockCertificateRetriever,
+        crypto_helper::ProtocolClerk,
     };
-    use crate::test::double::FakeCertificaterRetriever;
 
     use super::*;
 
diff --git a/mithril-common/src/crypto_helper/cardano/kes/mod.rs b/mithril-common/src/crypto_helper/cardano/kes/mod.rs
@@ -7,10 +7,3 @@ pub use error::*;
 pub use interface::*;
 pub use signer_with_key::*;
 pub use verifier_standard::*;
-
-cfg_test_tools! {
-    mod signer_fake;
-    pub mod tests_setup;
-
-    pub use signer_fake::*;
-}
diff --git a/mithril-common/src/crypto_helper/cardano/kes/signer_with_key.rs b/mithril-common/src/crypto_helper/cardano/kes/signer_with_key.rs
@@ -64,12 +64,9 @@ impl KesSigner for KesSignerStandard {
 mod tests {
     use super::*;
 
-    use crate::crypto_helper::cardano::kes::{
-        KesVerifier, KesVerifierStandard,
-        tests_setup::{
-            KesCryptographicMaterialForTest, KesPartyIndexForTest,
-            create_kes_cryptographic_material,
-        },
+    use crate::crypto_helper::cardano::kes::{KesVerifier, KesVerifierStandard};
+    use crate::test::crypto_helper::{
+        KesCryptographicMaterialForTest, KesPartyIndexForTest, create_kes_cryptographic_material,
     };
 
     #[test]
diff --git a/mithril-common/src/crypto_helper/cardano/kes/verifier_standard.rs b/mithril-common/src/crypto_helper/cardano/kes/verifier_standard.rs
@@ -47,12 +47,9 @@ impl KesVerifier for KesVerifierStandard {
 
 #[cfg(test)]
 mod tests {
-    use crate::crypto_helper::cardano::kes::{
-        KesSigner, KesSignerStandard,
-        tests_setup::{
-            KesCryptographicMaterialForTest, KesPartyIndexForTest,
-            create_kes_cryptographic_material,
-        },
+    use crate::crypto_helper::cardano::kes::{KesSigner, KesSignerStandard};
+    use crate::test::crypto_helper::{
+        KesCryptographicMaterialForTest, KesPartyIndexForTest, create_kes_cryptographic_material,
     };
 
     use super::*;
diff --git a/mithril-common/src/crypto_helper/cardano/key_certification.rs b/mithril-common/src/crypto_helper/cardano/key_certification.rs
@@ -101,7 +101,7 @@ pub enum ProtocolInitializerErrorWrapper {
 #[derive(Debug, Clone, Serialize, Deserialize)]
 pub struct StmInitializerWrapper {
     /// The Initializer
-    stm_initializer: Initializer,
+    pub(crate) stm_initializer: Initializer,
 
     /// The KES signature over the Mithril key
     ///
@@ -214,13 +214,6 @@ impl StmInitializerWrapper {
             kes_signature,
         })
     }
-
-    cfg_test_tools! {
-        /// Override the protocol parameters of the `Initializer` for testing purposes only.
-        pub fn override_protocol_parameters(&mut self, protocol_parameters: &ProtocolParameters) {
-            self.stm_initializer.params = protocol_parameters.to_owned();
-        }
-    }
 }
 
 /// Wrapper structure for [MithrilStm:KeyRegistration](mithril_stm::key_reg::KeyRegistration).
@@ -301,14 +294,11 @@ impl KeyRegWrapper {
 
 #[cfg(test)]
 mod test {
-    use crate::crypto_helper::cardano::kes::{
-        KesSignerStandard,
-        tests_setup::{
-            KesCryptographicMaterialForTest, KesPartyIndexForTest,
-            create_kes_cryptographic_material,
-        },
-    };
+    use crate::crypto_helper::cardano::kes::KesSignerStandard;
     use crate::crypto_helper::{OpCert, SerDeShelleyFileFormat};
+    use crate::test::crypto_helper::{
+        KesCryptographicMaterialForTest, KesPartyIndexForTest, create_kes_cryptographic_material,
+    };
 
     use rand_chacha::ChaCha20Rng;
     use rand_core::SeedableRng;
diff --git a/mithril-common/src/crypto_helper/merkle_tree.rs b/mithril-common/src/crypto_helper/merkle_tree.rs
@@ -169,33 +169,6 @@ impl MKProof {
             .collect::<Vec<_>>()
     }
 
-    cfg_test_tools! {
-        /// Build a [MKProof] based on the given leaves (*Test only*).
-        pub fn from_leaves<T: Into<MKTreeNode> + Clone>(
-            leaves: &[T],
-        ) -> StdResult<MKProof> {
-            Self::from_subset_of_leaves(leaves, leaves)
-        }
-
-        /// Build a [MKProof] based on the given leaves (*Test only*).
-        pub fn from_subset_of_leaves<T: Into<MKTreeNode> + Clone>(
-            leaves: &[T],
-            leaves_to_verify: &[T],
-        ) -> StdResult<MKProof> {
-            let leaves = Self::list_to_mknode(leaves);
-            let leaves_to_verify =
-                Self::list_to_mknode(leaves_to_verify);
-
-            let mktree =
-                MKTree::<MKTreeStoreInMemory>::new(&leaves).with_context(|| "MKTree creation should not fail")?;
-            mktree.compute_proof(&leaves_to_verify)
-        }
-
-        fn list_to_mknode<T: Into<MKTreeNode> + Clone>(hashes: &[T]) -> Vec<MKTreeNode> {
-            hashes.iter().map(|h| h.clone().into()).collect()
-        }
-    }
-
     /// Convert the proof to bytes
     pub fn to_bytes(&self) -> StdResult<Bytes> {
         bincode::serde::encode_to_vec(self, bincode::config::standard()).map_err(|e| e.into())
@@ -465,6 +438,8 @@ impl<S: MKTreeStorer> Clone for MKTree<S> {
 
 #[cfg(test)]
 mod tests {
+    use crate::test::crypto_helper::MKProofTestExtension;
+
     use super::*;
 
     fn generate_leaves(total_leaves: usize) -> Vec<MKTreeNode> {
diff --git a/mithril-common/src/crypto_helper/mod.rs b/mithril-common/src/crypto_helper/mod.rs
@@ -9,20 +9,13 @@ mod merkle_map;
 mod merkle_tree;
 mod types;
 
-cfg_test_tools! {
-    pub mod tests_setup;
-}
-
 pub use cardano::ColdKeyGenerator;
 
 pub use cardano::{
     KesPeriod, KesSigner, KesSignerStandard, KesVerifier, KesVerifierStandard, KesVerifyError,
     OpCert, ProtocolInitializerErrorWrapper, ProtocolRegistrationErrorWrapper,
     SerDeShelleyFileFormat, Sum6KesBytes,
 };
-cfg_test_tools! {
-    pub use cardano::KesSignerFake;
-}
 pub use codec::*;
 pub use ed25519_alias::{era::*, genesis::*, manifest::*};
 pub use merkle_map::{MKMap, MKMapKey, MKMapNode, MKMapProof, MKMapValue};
diff --git a/mithril-common/src/entities/single_signature.rs b/mithril-common/src/entities/single_signature.rs
@@ -109,8 +109,9 @@ impl Debug for SingleSignature {
 
 #[cfg(test)]
 mod tests {
+    use crate::test::{builder::MithrilFixtureBuilder, crypto_helper::setup_message};
+
     use super::*;
-    use crate::{crypto_helper::tests_setup::setup_message, test::builder::MithrilFixtureBuilder};
 
     #[test]
     fn single_signatures_should_convert_to_protocol_signatures() {
diff --git a/mithril-common/src/messages/cardano_transactions_proof.rs b/mithril-common/src/messages/cardano_transactions_proof.rs
@@ -189,6 +189,7 @@ mod tests {
         CardanoTransactionsSignableBuilder, MockBlockRangeRootRetriever, MockTransactionsImporter,
         SignableBuilder,
     };
+    use crate::test::crypto_helper::MKProofTestExtension;
     use crate::test::double::Dummy;
 
     use super::*;
diff --git a/mithril-common/src/test/builder/fixture_builder.rs b/mithril-common/src/test/builder/fixture_builder.rs
@@ -5,11 +5,11 @@ use rand_core::{RngCore, SeedableRng};
 use crate::{
     crypto_helper::{
         ColdKeyGenerator, OpCert, ProtocolStakeDistribution, SerDeShelleyFileFormat, Sum6KesBytes,
-        tests_setup, tests_setup::setup_temp_directory_for_signer,
     },
     entities::{PartyId, ProtocolParameters, Stake, StakeDistribution},
     test::{
         builder::MithrilFixture,
+        crypto_helper,
         double::{fake_data, precomputed_kes_key},
     },
 };
@@ -96,7 +96,7 @@ impl MithrilFixtureBuilder {
     /// Transform the specified parameters to a [MithrilFixture].
     pub fn build(self) -> MithrilFixture {
         let protocol_stake_distribution = self.generate_stake_distribution();
-        let signers = tests_setup::setup_signers_from_stake_distribution(
+        let signers = crypto_helper::setup_signers_from_stake_distribution(
             &protocol_stake_distribution,
             &self.protocol_parameters.clone().into(),
         );
@@ -208,7 +208,7 @@ impl MithrilFixtureBuilder {
         let party_id = operational_certificate
             .compute_protocol_party_id()
             .expect("compute protocol party id should not fail");
-        let temp_dir = setup_temp_directory_for_signer(&party_id, true)
+        let temp_dir = crypto_helper::setup_temp_directory_for_signer(&party_id, true)
             .expect("setup temp directory should return a value");
         if !temp_dir.join("kes.sk").exists() {
             kes_bytes
diff --git a/mithril-common/src/test/builder/mithril_fixture.rs b/mithril-common/src/test/builder/mithril_fixture.rs
@@ -19,6 +19,7 @@ use crate::{
         Signer, SignerWithStake, SingleSignature, Stake, StakeDistribution, StakeDistributionParty,
     },
     protocol::{SignerBuilder, ToMessage},
+    test::crypto_helper::ProtocolInitializerTestExtension,
 };
 
 /// A fixture of Mithril data types.
diff --git a/mithril-common/src/test/crypto_helper/cardano/extensions.rs b/mithril-common/src/test/crypto_helper/cardano/extensions.rs
@@ -0,0 +1,52 @@
+use anyhow::Context;
+
+use crate::StdResult;
+use crate::crypto_helper::{
+    MKProof, MKTree, MKTreeNode, MKTreeStoreInMemory, ProtocolInitializer, ProtocolParameters,
+};
+
+/// Extension trait adding test utilities to [ProtocolInitializer]
+pub trait ProtocolInitializerTestExtension {
+    /// `TEST ONLY` - Override the protocol parameters of the `Initializer`
+    fn override_protocol_parameters(&mut self, protocol_parameters: &ProtocolParameters);
+}
+
+impl ProtocolInitializerTestExtension for ProtocolInitializer {
+    fn override_protocol_parameters(&mut self, protocol_parameters: &ProtocolParameters) {
+        self.stm_initializer.params = protocol_parameters.to_owned();
+    }
+}
+
+/// Extension trait adding test utilities to [MKProof]
+pub trait MKProofTestExtension {
+    /// `TEST ONLY` - Build a [MKProof] based on the given leaves
+    fn from_leaves<T: Into<MKTreeNode> + Clone>(leaves: &[T]) -> StdResult<MKProof>;
+
+    /// `TEST ONLY` - Build a [MKProof] based on the given leaves
+    fn from_subset_of_leaves<T: Into<MKTreeNode> + Clone>(
+        leaves: &[T],
+        leaves_to_verify: &[T],
+    ) -> StdResult<MKProof>;
+}
+
+impl MKProofTestExtension for MKProof {
+    fn from_leaves<T: Into<MKTreeNode> + Clone>(leaves: &[T]) -> StdResult<MKProof> {
+        Self::from_subset_of_leaves(leaves, leaves)
+    }
+
+    fn from_subset_of_leaves<T: Into<MKTreeNode> + Clone>(
+        leaves: &[T],
+        leaves_to_verify: &[T],
+    ) -> StdResult<MKProof> {
+        fn list_to_mknode<T: Into<MKTreeNode> + Clone>(hashes: &[T]) -> Vec<MKTreeNode> {
+            hashes.iter().map(|h| h.clone().into()).collect()
+        }
+
+        let leaves = list_to_mknode(leaves);
+        let leaves_to_verify = list_to_mknode(leaves_to_verify);
+
+        let mktree = MKTree::<MKTreeStoreInMemory>::new(&leaves)
+            .with_context(|| "MKTree creation should not fail")?;
+        mktree.compute_proof(&leaves_to_verify)
+    }
+}
diff --git a/mithril-common/src/test/crypto_helper/cardano/kes/mod.rs b/mithril-common/src/test/crypto_helper/cardano/kes/mod.rs
@@ -0,0 +1,5 @@
+mod setup;
+mod signer_fake;
+
+pub(crate) use setup::*;
+pub use signer_fake::*;
diff --git a/mithril-common/src/test/crypto_helper/cardano/kes/setup.rs b/mithril-common/src/test/crypto_helper/cardano/kes/setup.rs
diff --git a/mithril-common/src/test/crypto_helper/cardano/kes/signer_fake.rs b/mithril-common/src/test/crypto_helper/cardano/kes/signer_fake.rs
diff --git a/mithril-common/src/test/crypto_helper/cardano/mod.rs b/mithril-common/src/test/crypto_helper/cardano/mod.rs
diff --git a/mithril-common/src/test/crypto_helper/mod.rs b/mithril-common/src/test/crypto_helper/mod.rs
diff --git a/mithril-common/src/test/crypto_helper/setup.rs b/mithril-common/src/test/crypto_helper/setup.rs
diff --git a/mithril-common/src/test/mod.rs b/mithril-common/src/test/mod.rs
diff --git a/mithril-signer/src/configuration.rs b/mithril-signer/src/configuration.rs
diff --git a/mithril-signer/tests/create_cardano_transaction_single_signature.rs b/mithril-signer/tests/create_cardano_transaction_single_signature.rs
diff --git a/mithril-signer/tests/create_immutable_files_full_single_signature.rs b/mithril-signer/tests/create_immutable_files_full_single_signature.rs
diff --git a/mithril-signer/tests/era_switch.rs b/mithril-signer/tests/era_switch.rs
