refactor(common): 'test_setups' sub-module in 'kes' module

Author: jpraynaud

mithril-common/src/crypto_helper/cardano/kes/mod.rs

@@ -2,13 +2,12 @@ mod error;
 mod interface;
 mod signer_fake;
 mod signer_with_key;
-#[cfg(test)]
-pub(crate) mod tests_setup;
-
+pub mod tests_setup;
 mod verifier_standard;
 
 pub use error::*;
 pub use interface::*;
 pub use signer_fake::*;
 pub use signer_with_key::*;
+pub use tests_setup::*;
 pub use verifier_standard::*;

mithril-common/src/crypto_helper/cardano/kes/signer_fake.rs

@@ -5,8 +5,11 @@ use std::sync::Mutex;
 
 use crate::{
     crypto_helper::{
-        cardano::{create_kes_cryptographic_material, KesSignerStandard},
-        KESPeriod, KesSigner, OpCert,
+        cardano::{
+            create_kes_cryptographic_material, KesCryptographicMaterialForTest,
+            KesPartyIndexForTest, KesSignerStandard,
+        },
+        KesPeriod, KesSigner, OpCert,
     },
     StdResult,
 };
@@ -28,12 +31,15 @@ impl KesSignerFake {
 
     /// Returns a dummy signature result that is always successful.
     pub fn dummy_signature() -> (Sum6KesSig, OpCert) {
-        let (_party_id, operational_certificate_file, kes_secret_key_file) =
-            create_kes_cryptographic_material(
-                1,
-                0 as KESPeriod,
-                "fake_kes_signer_returns_signature_batches_in_expected_order",
-            );
+        let KesCryptographicMaterialForTest {
+            party_id: _,
+            operational_certificate_file,
+            kes_secret_key_file,
+        } = create_kes_cryptographic_material(
+            1 as KesPartyIndexForTest,
+            0 as KesPeriod,
+            "fake_kes_signer_returns_signature_batches_in_expected_order",
+        );
         let message = b"Test message for KES signing";
         let kes_signer = KesSignerStandard::new(kes_secret_key_file, operational_certificate_file);
         let kes_signing_period = 1;
@@ -51,7 +57,7 @@ impl KesSignerFake {
 }
 
 impl KesSigner for KesSignerFake {
-    fn sign(&self, _message: &[u8], _kes_period: KESPeriod) -> KesSignatureResult {
+    fn sign(&self, _message: &[u8], _kes_period: KesPeriod) -> KesSignatureResult {
         let mut results = self.results.lock().unwrap();
 
         results.pop_front().unwrap()
@@ -64,12 +70,15 @@ mod tests {
 
     #[test]
     fn fake_kes_signer_returns_signature_batches_in_expected_order() {
-        let (_party_id, operational_certificate_file, kes_secret_key_file) =
-            create_kes_cryptographic_material(
-                1,
-                0 as KESPeriod,
-                "fake_kes_signer_returns_signature_batches_in_expected_order",
-            );
+        let KesCryptographicMaterialForTest {
+            party_id: _,
+            operational_certificate_file,
+            kes_secret_key_file,
+        } = create_kes_cryptographic_material(
+            1 as KesPartyIndexForTest,
+            0 as KesPeriod,
+            "fake_kes_signer_returns_signature_batches_in_expected_order",
+        );
         let message = b"Test message for KES signing";
         let kes_signer = KesSignerStandard::new(kes_secret_key_file, operational_certificate_file);
         let kes_signing_period = 1;

mithril-common/src/crypto_helper/cardano/kes/signer_with_key.rs

@@ -66,20 +66,18 @@ mod tests {
     use super::*;
 
     use crate::crypto_helper::cardano::{
-        kes::tests_setup::create_kes_cryptographic_material,
-        tests_setup::KesCryptographicMaterialForTest, KesVerifier, KesVerifierStandard,
+        kes::tests_setup::{create_kes_cryptographic_material, KesCryptographicMaterialForTest},
+        KesPartyIndexForTest, KesVerifier, KesVerifierStandard,
     };
 
-    type PartyIndex = u64;
-
     #[test]
     fn create_valid_signature_for_message() {
         let KesCryptographicMaterialForTest {
             party_id: _,
             operational_certificate_file,
             kes_secret_key_file,
         } = create_kes_cryptographic_material(
-            1 as PartyIndex,
+            1 as KesPartyIndexForTest,
             0 as KesPeriod,
             "create_valid_signature_for_message",
         );
@@ -103,7 +101,7 @@ mod tests {
             operational_certificate_file,
             kes_secret_key_file,
         } = create_kes_cryptographic_material(
-            1 as PartyIndex,
+            1 as KesPartyIndexForTest,
             0 as KesPeriod,
             "create_invalid_signature_for_different_message",
         );
@@ -133,7 +131,7 @@ mod tests {
             operational_certificate_file,
             kes_secret_key_file,
         } = create_kes_cryptographic_material(
-            1 as PartyIndex,
+            1 as KesPartyIndexForTest,
             kes_period_start,
             "create_invalid_signature_for_invalid_kes_period",
         );

mithril-common/src/crypto_helper/cardano/kes/tests_setup.rs

@@ -6,16 +6,20 @@ use kes_summed_ed25519::traits::KesSk;
 use crate::crypto_helper::{cardano::ColdKeyGenerator, OpCert};
 use crate::crypto_helper::{KesPeriod, ProtocolPartyId, SerDeShelleyFileFormat, Sum6KesBytes};
 
+/// A type alias for the party index used in KES cryptographic material.
+pub type KesPartyIndexForTest = u64;
+
 /// A struct to hold KES cryptographic material for testing purposes.
 pub(crate) struct KesCryptographicMaterialForTest {
+    #[allow(dead_code)]
     pub party_id: ProtocolPartyId,
     pub operational_certificate_file: PathBuf,
     pub kes_secret_key_file: PathBuf,
 }
 
 /// Create KES cryptographic material for testing purposes.
-pub(crate) fn create_kes_cryptographic_material(
-    party_idx: u64,
+pub fn create_kes_cryptographic_material(
+    party_idx: KesPartyIndexForTest,
     kes_period: KesPeriod,
     test_directory: &str,
 ) -> KesCryptographicMaterialForTest {

mithril-common/src/crypto_helper/cardano/kes/verifier_standard.rs

@@ -48,8 +48,8 @@ impl KesVerifier for KesVerifierStandard {
 #[cfg(test)]
 mod tests {
     use crate::crypto_helper::cardano::{
-        kes::tests_setup::create_kes_cryptographic_material,
-        tests_setup::KesCryptographicMaterialForTest, KesSigner, KesSignerStandard,
+        kes::tests_setup::{create_kes_cryptographic_material, KesCryptographicMaterialForTest},
+        KesPartyIndexForTest, KesSigner, KesSignerStandard,
     };
 
     use super::*;
@@ -60,7 +60,11 @@ mod tests {
             party_id: _,
             operational_certificate_file,
             kes_secret_key_file,
-        } = create_kes_cryptographic_material(1, 0 as KesPeriod, "verify_valid_signature_succeeds");
+        } = create_kes_cryptographic_material(
+            1 as KesPartyIndexForTest,
+            0 as KesPeriod,
+            "verify_valid_signature_succeeds",
+        );
         let message = b"Test message for KES signing";
         let kes_signer = KesSignerStandard::new(kes_secret_key_file, operational_certificate_file);
         let kes_signing_period = 1;
@@ -79,7 +83,11 @@ mod tests {
             party_id: _,
             operational_certificate_file,
             kes_secret_key_file,
-        } = create_kes_cryptographic_material(1, 0 as KesPeriod, "verify_invalid_signature_fails");
+        } = create_kes_cryptographic_material(
+            1 as KesPartyIndexForTest,
+            0 as KesPeriod,
+            "verify_invalid_signature_fails",
+        );
         let message = b"Test message for KES signing";
         let kes_signer = KesSignerStandard::new(kes_secret_key_file, operational_certificate_file);
         let kes_signing_period = 1;

mithril-common/src/crypto_helper/cardano/key_certification.rs

@@ -300,9 +300,9 @@ impl KeyRegWrapper {
 #[cfg(test)]
 mod test {
     use super::*;
-    use crate::crypto_helper::cardano::tests_setup::KesCryptographicMaterialForTest;
     use crate::crypto_helper::cardano::{
-        tests_setup::create_kes_cryptographic_material, KesSignerStandard,
+        kes::tests_setup::{create_kes_cryptographic_material, KesCryptographicMaterialForTest},
+        KesPartyIndexForTest, KesSignerStandard,
     };
     use crate::crypto_helper::{OpCert, SerDeShelleyFileFormat};
 
@@ -321,12 +321,20 @@ mod test {
             party_id: party_id_1,
             operational_certificate_file: operational_certificate_file_1,
             kes_secret_key_file: kes_secret_key_file_1,
-        } = create_kes_cryptographic_material(1, 0 as KesPeriod, "test_vector_key_reg");
+        } = create_kes_cryptographic_material(
+            1 as KesPartyIndexForTest,
+            0 as KesPeriod,
+            "test_vector_key_reg",
+        );
         let KesCryptographicMaterialForTest {
             party_id: party_id_2,
             operational_certificate_file: operational_certificate_file_2,
             kes_secret_key_file: kes_secret_key_file_2,
-        } = create_kes_cryptographic_material(2, 0 as KesPeriod, "test_vector_key_reg");
+        } = create_kes_cryptographic_material(
+            2 as KesPartyIndexForTest,
+            0 as KesPeriod,
+            "test_vector_key_reg",
+        );
 
         let mut key_reg = KeyRegWrapper::init(&vec![(party_id_1, 10), (party_id_2, 3)]);