refactor(common): add define_test_logger macro for unified TestLogger creation

Also move this new and the existing test logging utilities to a
`test::logging` module.

Author: Alenar

mithril-aggregator/src/services/aggregator_client.rs

@@ -813,7 +813,7 @@ mod tests {
     mod warn_if_api_version_mismatch {
         use std::collections::HashMap;
 
-        use mithril_common::test::MemoryDrainForTestInspector;
+        use mithril_common::test::logging::MemoryDrainForTestInspector;
 
         use super::*;
 

mithril-client/src/aggregator_client.rs

@@ -877,7 +877,7 @@ mod tests {
     mod warn_if_api_version_mismatch {
         use http::response::Builder as HttpResponseBuilder;
 
-        use mithril_common::test::MemoryDrainForTestInspector;
+        use mithril_common::test::logging::MemoryDrainForTestInspector;
 
         use super::*;
 

mithril-common/src/test/memory_logger.rs renamed to mithril-common/src/test/logging/memory_logger.rs

@@ -0,0 +1,56 @@
+//! Logging utilities for tests
+//!
+mod memory_logger;
+
+pub use memory_logger::*;
+
+/// Creates a test-specific `TestLogger` struct that can creates preconfigured logger instances.
+///
+/// This macro avoids direct `slog_async` and `slog_term` dependencies in library crates
+/// by letting dependents add them as `dev-dependencies` only.
+///
+/// ## Methods
+///
+/// - `TestLogger::stdout()` - Logger that outputs to stdout.
+/// - `TestLogger::memory()` - Logger that stores messages in memory for inspection.
+///   Returns `(Logger, MemoryDrainForTestInspector)` tuple
+///
+/// Requires: `slog`, `slog_async`, `slog_term`
+#[macro_export]
+macro_rules! define_test_logger {
+    () => {
+        #[cfg(test)]
+        pub(crate) struct TestLogger;
+
+        #[cfg(test)]
+        mod test_logger_impl {
+            use std::io;
+            use std::sync::Arc;
+
+            use slog::{Drain, Logger};
+            use slog_async::Async;
+            use slog_term::{CompactFormat, PlainDecorator};
+
+            use $crate::test::logging::{MemoryDrainForTest, MemoryDrainForTestInspector};
+
+            impl super::TestLogger {
+                fn from_writer<W: io::Write + Send + 'static>(writer: W) -> Logger {
+                    let decorator = PlainDecorator::new(writer);
+                    let drain = CompactFormat::new(decorator).build().fuse();
+                    let drain = Async::new(drain).build().fuse();
+                    Logger::root(Arc::new(drain), slog::o!())
+                }
+
+                pub(crate) fn stdout() -> Logger {
+                    Self::from_writer(slog_term::TestStdoutWriter)
+                }
+
+                pub(crate) fn memory() -> (Logger, MemoryDrainForTestInspector) {
+                    let (drain, inspector) = MemoryDrainForTest::new();
+                    (Logger::root(drain.fuse(), slog::o!()), inspector)
+                }
+            }
+        }
+    };
+}
+pub use define_test_logger;

mithril-common/src/test/logging/mod.rs

@@ -8,17 +8,16 @@
 
 pub mod builder;
 pub mod double;
+pub mod logging;
 pub mod mock_extensions;
 
 mod assert;
-mod memory_logger;
 mod temp_dir;
 
 pub use assert::*;
-pub use memory_logger::*;
 pub use temp_dir::*;
-#[cfg(test)]
-pub(crate) use utils::*;
+
+logging::define_test_logger!();
 
 /// Return the path of the given function.
 /// If the last function is `f`, it is removed.
@@ -66,37 +65,10 @@ pub use current_function_path;
 
 #[cfg(test)]
 mod utils {
-    use std::io;
     use std::path::Path;
-    use std::sync::Arc;
-
-    use slog::{Drain, Logger};
-    use slog_async::Async;
-    use slog_term::{CompactFormat, PlainDecorator};
 
     use super::*;
 
-    pub struct TestLogger;
-
-    #[cfg(test)]
-    impl TestLogger {
-        fn from_writer<W: io::Write + Send + 'static>(writer: W) -> Logger {
-            let decorator = PlainDecorator::new(writer);
-            let drain = CompactFormat::new(decorator).build().fuse();
-            let drain = Async::new(drain).build().fuse();
-            Logger::root(Arc::new(drain), slog::o!())
-        }
-
-        pub fn stdout() -> Logger {
-            Self::from_writer(slog_term::TestStdoutWriter)
-        }
-
-        pub fn memory() -> (Logger, MemoryDrainForTestInspector) {
-            let (drain, inspector) = MemoryDrainForTest::new();
-            (Logger::root(drain.fuse(), slog::o!()), inspector)
-        }
-    }
-
     #[test]
     fn test_current_function_extract_function_name() {
         let name = current_function!();

mithril-common/src/test/mod.rs

@@ -474,8 +474,8 @@ mod tests {
     use mithril_common::entities::Epoch;
     use mithril_common::messages::TryFromMessageAdapter;
     use mithril_common::test::{
-        MemoryDrainForTestInspector,
         double::{Dummy, fake_data},
+        logging::MemoryDrainForTestInspector,
     };
 
     use crate::test_tools::TestLogger;