fix: address PR issues

- fix incorrect paths in tests
- fix making pub(crate) previously internal fields for test extension
  traits by implementing the trait alongside the type (at the cost of
  mixing tests tools code with production code, but we keep the benefit
  of the trait import tagged as a test tool)
- update `mithril_common::test` module doc
- fix `FakeCertificaterRetriever` async trait use in wasm
- remove `cfg_test_tools` macro to limit additional uses until the
  `test_tools` feature is removed

Author: Alenar

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
-    pub(crate) stm_initializer: Initializer,
+    stm_initializer: Initializer,
 
     /// The KES signature over the Mithril key
     ///
@@ -292,6 +292,19 @@ impl KeyRegWrapper {
     }
 }
 
+#[cfg(any(test, feature = "test_tools"))]
+mod test_extensions {
+    use crate::test::crypto_helper::ProtocolInitializerTestExtension;
+
+    use super::*;
+
+    impl ProtocolInitializerTestExtension for StmInitializerWrapper {
+        fn override_protocol_parameters(&mut self, protocol_parameters: &ProtocolParameters) {
+            self.stm_initializer.params = protocol_parameters.to_owned();
+        }
+    }
+}
+
 #[cfg(test)]
 mod test {
     use crate::crypto_helper::cardano::kes::KesSignerStandard;

mithril-common/src/entities/block_range.rs

@@ -19,7 +19,7 @@ pub type BlockRangeLength = BlockNumber;
 /// BlockRange for the Cardano chain
 #[derive(Serialize, Deserialize, Clone, Eq, PartialEq, Debug, Hash)]
 pub struct BlockRange {
-    pub(crate) inner_range: Range<BlockNumber>,
+    inner_range: Range<BlockNumber>,
 }
 
 impl BlockRange {
@@ -201,6 +201,38 @@ impl ExactSizeIterator for BlockRangesSequence {
     }
 }
 
+#[cfg(any(test, feature = "test_tools"))]
+mod test_extensions {
+    use crate::test::entities_extensions::BlockRangeTestExtension;
+
+    use super::*;
+
+    impl BlockRangeTestExtension for BlockRange {
+        fn new(start: u64, end: u64) -> Self {
+            Self {
+                inner_range: BlockNumber(start)..BlockNumber(end),
+            }
+        }
+
+        fn try_add(&self, other: &BlockRange) -> StdResult<BlockRange> {
+            if self.inner_range.end.max(other.inner_range.end)
+                < self.inner_range.start.min(other.inner_range.start)
+            {
+                return Err(anyhow!(
+                    "BlockRange cannot be added as they don't strictly overlap"
+                ));
+            }
+
+            Ok(Self {
+                inner_range: Range {
+                    start: self.inner_range.start.min(other.inner_range.start),
+                    end: self.inner_range.end.max(other.inner_range.end),
+                },
+            })
+        }
+    }
+}
+
 #[cfg(test)]
 mod tests {
     use std::ops::Not;
@@ -234,6 +266,22 @@ mod tests {
         assert!(BlockRange::new(1, 11) < BlockRange::new(2, 10));
     }
 
+    #[test]
+    fn test_block_range_try_add() {
+        assert_eq!(
+            BlockRange::new(1, 10).try_add(&BlockRange::new(1, 10)).unwrap(),
+            BlockRange::new(1, 10)
+        );
+        assert_eq!(
+            BlockRange::new(1, 10).try_add(&BlockRange::new(1, 11)).unwrap(),
+            BlockRange::new(1, 11)
+        );
+        assert_eq!(
+            BlockRange::new(1, 10).try_add(&BlockRange::new(2, 10)).unwrap(),
+            BlockRange::new(1, 10)
+        );
+    }
+
     #[test]
     fn test_block_range_start() {
         assert_eq!(BlockRange::start(BlockNumber(0)), 0);

mithril-common/src/lib.rs

@@ -9,16 +9,6 @@
 //! - [certificate chain][certificate_chain] used to validate the Certificate Chain created by an aggregator
 //! - The [entities] used by, and exchanged between, the aggregator, signers and client.
 
-macro_rules! cfg_test_tools {
-    ($($item:item)*) => {
-        $(
-            #[cfg(any(test, feature = "test_tools"))]
-            #[cfg_attr(docsrs, doc(cfg(feature = "test_tools")))]
-            $item
-        )*
-    }
-}
-
 pub mod api_version;
 pub mod certificate_chain;
 pub mod crypto_helper;
@@ -28,9 +18,9 @@ pub mod messages;
 pub mod protocol;
 pub mod signable_builder;
 
-cfg_test_tools! {
-    pub mod test;
-}
+#[cfg(any(test, feature = "test_tools"))]
+#[cfg_attr(docsrs, doc(cfg(feature = "test_tools")))]
+pub mod test;
 
 pub use entities::{CardanoNetwork, MagicId};
 

mithril-common/src/test/crypto_helper/cardano/extensions.rs

@@ -1,22 +1,14 @@
 use anyhow::Context;
 
 use crate::StdResult;
-use crate::crypto_helper::{
-    MKProof, MKTree, MKTreeNode, MKTreeStoreInMemory, ProtocolInitializer, ProtocolParameters,
-};
+use crate::crypto_helper::{MKProof, MKTree, MKTreeNode, MKTreeStoreInMemory, ProtocolParameters};
 
-/// Extension trait adding test utilities to [ProtocolInitializer]
+/// Extension trait adding test utilities to [ProtocolInitializer][crate::crypto_helper::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

mithril-common/src/test/double/certificate_retriever.rs

@@ -27,7 +27,8 @@ impl FakeCertificaterRetriever {
     }
 }
 
-#[async_trait]
+#[cfg_attr(target_family = "wasm", async_trait(?Send))]
+#[cfg_attr(not(target_family = "wasm"), async_trait)]
 impl CertificateRetriever for FakeCertificaterRetriever {
     async fn get_certificate_details(
         &self,

mithril-common/src/test/entities_extensions.rs

@@ -1,9 +1,6 @@
 //! A set of extension traits to add test utilities to this crate `entities`
 
 use std::collections::HashMap;
-use std::ops::Range;
-
-use anyhow::anyhow;
 
 use crate::StdResult;
 use crate::crypto_helper::{
@@ -24,31 +21,6 @@ pub trait BlockRangeTestExtension {
     fn try_add(&self, other: &BlockRange) -> StdResult<BlockRange>;
 }
 
-impl BlockRangeTestExtension for BlockRange {
-    fn new(start: u64, end: u64) -> Self {
-        Self {
-            inner_range: BlockNumber(start)..BlockNumber(end),
-        }
-    }
-
-    fn try_add(&self, other: &BlockRange) -> StdResult<BlockRange> {
-        if self.inner_range.end.max(other.inner_range.end)
-            < self.inner_range.start.min(other.inner_range.start)
-        {
-            return Err(anyhow!(
-                "BlockRange cannot be added as they don't strictly overlap"
-            ));
-        }
-
-        Ok(Self {
-            inner_range: Range {
-                start: self.inner_range.start.min(other.inner_range.start),
-                end: self.inner_range.end.max(other.inner_range.end),
-            },
-        })
-    }
-}
-
 /// Extension trait adding test utilities to [CardanoTransactionsSetProof]
 pub trait CardanoTransactionsSetProofTestExtension {
     /// `TEST ONLY` - Helper to create a proof from a list of leaves
@@ -126,24 +98,3 @@ impl SingleSignatureTestExtension for SingleSignature {
         }
     }
 }
-
-#[cfg(test)]
-mod tests {
-    use super::*;
-
-    #[test]
-    fn test_block_range_try_add() {
-        assert_eq!(
-            BlockRange::new(1, 10).try_add(&BlockRange::new(1, 10)).unwrap(),
-            BlockRange::new(1, 10)
-        );
-        assert_eq!(
-            BlockRange::new(1, 10).try_add(&BlockRange::new(1, 11)).unwrap(),
-            BlockRange::new(1, 11)
-        );
-        assert_eq!(
-            BlockRange::new(1, 10).try_add(&BlockRange::new(2, 10)).unwrap(),
-            BlockRange::new(1, 10)
-        );
-    }
-}

mithril-common/src/test/mod.rs

@@ -1,9 +1,15 @@
 //! Test utilities
 //!
-//! They contains:
-//! * A Open Api Spec tester
-//! * Some precomputed fake data and keys
-//! * A builder of [MithrilFixture] to generate signers alongside a stake distribution
+//! A collection of testing utilities and helpers:
+//!
+//! * `assert`: Custom assertions for comparing directory structures, iterables, JSON strings and more
+//! * `builder`: Test data builders and fixtures
+//! * `crypto_helper`: Cryptographic utilities for testing
+//! * `double`: Test doubles (mocks, fakes, dummies, ...)
+//! * `entities_extensions`: Extension traits adding test-specific methods for [crate::entities]
+//! * `logging`: Test logging infrastructure
+//! * `mock_extensions`: Additional mocking utilities
+//! * `temp_dir`: Temporary directory management for tests
 //!
 
 pub mod builder;
@@ -89,7 +95,7 @@ mod utils {
     #[test]
     fn test_format_function_path_from_given_function() {
         assert_eq!(
-            "mithril_common/test_utils/utils/test_format_function_path_from_given_function",
+            "mithril_common/test/utils/test_format_function_path_from_given_function",
             format_current_function_path(test_format_function_path_from_given_function)
         );
     }
@@ -98,7 +104,7 @@ mod utils {
     fn test_format_function_path_from_given_pseudo_function_f() {
         fn f() {}
         assert_eq!(
-            "mithril_common/test_utils/utils/test_format_function_path_from_given_pseudo_function_f",
+            "mithril_common/test/utils/test_format_function_path_from_given_pseudo_function_f",
             format_current_function_path(f)
         );
     }
@@ -107,7 +113,7 @@ mod utils {
     async fn test_format_function_path_from_given_async_function_f() {
         fn f() {}
         assert_eq!(
-            "mithril_common/test_utils/utils/test_format_function_path_from_given_async_function_f",
+            "mithril_common/test/utils/test_format_function_path_from_given_async_function_f",
             format_current_function_path(f)
         );
     }
@@ -116,7 +122,7 @@ mod utils {
     fn test_build_current_function_path_using_macros() {
         assert_eq!(
             Path::new("mithril_common")
-                .join("test_utils")
+                .join("test")
                 .join("utils")
                 .join("test_build_current_function_path_using_macros"),
             current_function_path!()
@@ -127,7 +133,7 @@ mod utils {
     async fn test_build_current_async_function_path_using_macros() {
         assert_eq!(
             Path::new("mithril_common")
-                .join("test_utils")
+                .join("test")
                 .join("utils")
                 .join("test_build_current_async_function_path_using_macros"),
             current_function_path!()

mithril-common/src/test/temp_dir.rs

@@ -258,7 +258,7 @@ mod tests {
             std::env::temp_dir()
                 .join(TEMP_DIR_ROOT_NAME)
                 .join("mithril_common")
-                .join("test_utils")
+                .join("test")
                 .join("temp_dir")
                 .join("creating_temp_dir_base_on_current_function"),
             temp_dir!(),
@@ -271,7 +271,7 @@ mod tests {
             std::env::temp_dir()
                 .join(TEMP_DIR_ROOT_NAME)
                 .join("mithril_common")
-                .join("test_utils")
+                .join("test")
                 .join("temp_dir")
                 .join("creating_temp_dir_base_on_current_async_function"),
             temp_dir!(),