Add logger_for_tests to common to factorize test logger creation

Author: Alenar

mithril-common/src/digesters/cardano_immutable_digester.rs

@@ -178,19 +178,12 @@ mod tests {
             ImmutableDigesterError,
         },
         entities::{CardanoDbBeacon, ImmutableFileNumber},
+        test_utils::logger_for_tests,
     };
     use sha2::Sha256;
-    use slog::Drain;
     use std::{collections::BTreeMap, io, sync::Arc};
     use tokio::time::Instant;
 
-    fn create_logger() -> slog::Logger {
-        let decorator = slog_term::PlainDecorator::new(slog_term::TestStdoutWriter);
-        let drain = slog_term::CompactFormat::new(decorator).build().fuse();
-        let drain = slog_async::Async::new(drain).build().fuse();
-        slog::Logger::root(Arc::new(drain), slog::o!())
-    }
-
     fn db_builder(dir_name: &str) -> DummyImmutablesDbBuilder {
         DummyImmutablesDbBuilder::new(&format!("cardano_immutable_digester/{dir_name}"))
     }
@@ -224,7 +217,7 @@ mod tests {
     #[tokio::test]
     async fn fail_if_no_file_in_folder() {
         let immutable_db = db_builder("fail_if_no_file_in_folder").build();
-        let digester = CardanoImmutableDigester::new(None, create_logger());
+        let digester = CardanoImmutableDigester::new(None, logger_for_tests());
         let beacon = CardanoDbBeacon::new("devnet".to_string(), 1, 1);
 
         let result = digester
@@ -250,7 +243,7 @@ mod tests {
         let immutable_db = db_builder("fail_if_no_immutable_exist")
             .with_non_immutables(&["not_immutable"])
             .build();
-        let digester = CardanoImmutableDigester::new(None, create_logger());
+        let digester = CardanoImmutableDigester::new(None, logger_for_tests());
         let beacon = CardanoDbBeacon::new("devnet".to_string(), 1, 1);
 
         assert!(digester
@@ -264,7 +257,7 @@ mod tests {
         let immutable_db = db_builder("fail_if_theres_only_the_uncompleted_immutable_trio")
             .append_immutable_trio()
             .build();
-        let digester = CardanoImmutableDigester::new(None, create_logger());
+        let digester = CardanoImmutableDigester::new(None, logger_for_tests());
         let beacon = CardanoDbBeacon::new("devnet".to_string(), 1, 1);
 
         let result = digester
@@ -291,7 +284,7 @@ mod tests {
             .with_immutables(&[1, 2, 3, 4, 5])
             .append_immutable_trio()
             .build();
-        let digester = CardanoImmutableDigester::new(None, create_logger());
+        let digester = CardanoImmutableDigester::new(None, logger_for_tests());
         let beacon = CardanoDbBeacon::new("devnet".to_string(), 1, 10);
 
         let result = digester
@@ -318,7 +311,7 @@ mod tests {
             .with_immutables(&(1..=100).collect::<Vec<ImmutableFileNumber>>())
             .append_immutable_trio()
             .build();
-        let logger = create_logger();
+        let logger = logger_for_tests();
         let digester = CardanoImmutableDigester::new(
             Some(Arc::new(MemoryImmutableFileDigestCacheProvider::default())),
             logger.clone(),
@@ -344,7 +337,7 @@ mod tests {
             .build();
         let immutables = immutable_db.immutables_files;
         let cache = Arc::new(MemoryImmutableFileDigestCacheProvider::default());
-        let logger = create_logger();
+        let logger = logger_for_tests();
         let digester = CardanoImmutableDigester::new(Some(cache.clone()), logger.clone());
         let beacon = CardanoDbBeacon::new("devnet".to_string(), 1, 2);
 
@@ -376,7 +369,7 @@ mod tests {
         .with_immutables(&[1, 2, 3])
         .append_immutable_trio()
         .build();
-        let logger = create_logger();
+        let logger = logger_for_tests();
         let no_cache_digester = CardanoImmutableDigester::new(None, logger.clone());
         let cache_digester = CardanoImmutableDigester::new(
             Some(Arc::new(MemoryImmutableFileDigestCacheProvider::default())),
@@ -418,7 +411,7 @@ mod tests {
             .set_file_size(65536)
             .build();
         let cache = MemoryImmutableFileDigestCacheProvider::default();
-        let logger = create_logger();
+        let logger = logger_for_tests();
         let digester = CardanoImmutableDigester::new(Some(Arc::new(cache)), logger.clone());
         let beacon = CardanoDbBeacon::new("devnet".to_string(), 1, 50);
 
@@ -460,7 +453,7 @@ mod tests {
                 ImmutableDigesterCacheStoreError::Io(io::Error::new(io::ErrorKind::Other, "error")),
             ))
         });
-        let logger = create_logger();
+        let logger = logger_for_tests();
         let digester = CardanoImmutableDigester::new(Some(Arc::new(cache)), logger.clone());
         let beacon = CardanoDbBeacon::new("devnet".to_string(), 1, 3);
 
@@ -483,7 +476,7 @@ mod tests {
             ))
         });
         cache.expect_store().returning(|_| Ok(()));
-        let logger = create_logger();
+        let logger = logger_for_tests();
         let digester = CardanoImmutableDigester::new(Some(Arc::new(cache)), logger.clone());
         let beacon = CardanoDbBeacon::new("devnet".to_string(), 1, 3);
 

mithril-common/src/signable_builder/cardano_immutable_full_signable_builder.rs

@@ -62,14 +62,14 @@ impl SignableBuilder<CardanoDbBeacon> for CardanoImmutableFilesFullSignableBuild
 
 #[cfg(test)]
 mod tests {
+    use async_trait::async_trait;
     use std::path::Path;
 
-    use super::*;
-
     use crate::digesters::{ImmutableDigester, ImmutableDigesterError};
     use crate::entities::CardanoDbBeacon;
-    use async_trait::async_trait;
-    use slog::Drain;
+    use crate::test_utils::logger_for_tests;
+
+    use super::*;
 
     #[derive(Default)]
     pub struct ImmutableDigesterImpl;
@@ -85,19 +85,13 @@ mod tests {
         }
     }
 
-    fn create_logger() -> slog::Logger {
-        let decorator = slog_term::PlainDecorator::new(slog_term::TestStdoutWriter);
-        let drain = slog_term::CompactFormat::new(decorator).build().fuse();
-        let drain = slog_async::Async::new(drain).build().fuse();
-        slog::Logger::root(Arc::new(drain), slog::o!())
-    }
     #[tokio::test]
     async fn compute_signable() {
         let digester = ImmutableDigesterImpl;
         let signable_builder = CardanoImmutableFilesFullSignableBuilder::new(
             Arc::new(digester),
             Path::new(""),
-            create_logger(),
+            logger_for_tests(),
         );
         let protocol_message = signable_builder
             .compute_protocol_message(CardanoDbBeacon::default())

mithril-common/src/signable_builder/cardano_transactions.rs

@@ -117,15 +117,9 @@ impl SignableBuilder<CardanoDbBeacon> for CardanoTransactionsSignableBuilder {
 
 #[cfg(test)]
 mod tests {
-    use super::*;
-    use slog::Drain;
+    use crate::test_utils::logger_for_tests;
 
-    fn create_logger() -> slog::Logger {
-        let decorator = slog_term::PlainDecorator::new(slog_term::TestStdoutWriter);
-        let drain = slog_term::CompactFormat::new(decorator).build().fuse();
-        let drain = slog_async::Async::new(drain).build().fuse();
-        slog::Logger::root(Arc::new(drain), slog::o!())
-    }
+    use super::*;
 
     #[tokio::test]
     async fn test_compute_merkle_root_in_same_block_range() {
@@ -148,7 +142,7 @@ mod tests {
 
         let cardano_transaction_signable_builder = CardanoTransactionsSignableBuilder::new(
             Arc::new(MockTransactionsImporter::new()),
-            create_logger(),
+            logger_for_tests(),
         );
 
         let merkle_root_reference = cardano_transaction_signable_builder
@@ -209,7 +203,7 @@ mod tests {
 
         let cardano_transaction_signable_builder = CardanoTransactionsSignableBuilder::new(
             Arc::new(MockTransactionsImporter::new()),
-            create_logger(),
+            logger_for_tests(),
         );
 
         let merkle_root_reference = cardano_transaction_signable_builder
@@ -242,7 +236,7 @@ mod tests {
             .return_once(move |_| Ok(imported_transactions));
         let cardano_transactions_signable_builder = CardanoTransactionsSignableBuilder::new(
             Arc::new(transaction_importer),
-            create_logger(),
+            logger_for_tests(),
         );
 
         // Action
@@ -276,7 +270,7 @@ mod tests {
             .return_once(|_| Ok(vec![]));
         let cardano_transactions_signable_builder = CardanoTransactionsSignableBuilder::new(
             Arc::new(transaction_importer),
-            create_logger(),
+            logger_for_tests(),
         );
 
         let result = cardano_transactions_signable_builder

mithril-common/src/test_utils/mod.rs

@@ -25,3 +25,14 @@ pub mod test_http_server;
 pub use fixture_builder::{MithrilFixtureBuilder, StakeDistributionGenerationMethod};
 pub use mithril_fixture::{MithrilFixture, SignerFixture};
 pub use temp_dir::*;
+
+#[cfg(test)]
+pub(crate) fn logger_for_tests() -> slog::Logger {
+    use slog::Drain;
+    use std::sync::Arc;
+
+    let decorator = slog_term::PlainDecorator::new(slog_term::TestStdoutWriter);
+    let drain = slog_term::CompactFormat::new(decorator).build().fuse();
+    let drain = slog_async::Async::new(drain).build().fuse();
+    slog::Logger::root(Arc::new(drain), slog::o!())
+}