Hide 'test only' tools behind the dedicated flag

Author: Alenar

mithril-common/src/chain_observer/mod.rs

@@ -1,9 +1,11 @@
 //! Tools to request metadata, like the current epoch or the stake distribution, from the Cardano
 
 mod cli_observer;
+#[cfg(any(test, feature = "test_only"))]
 mod fake_observer;
 mod interface;
 
 pub use cli_observer::{CardanoCliChainObserver, CardanoCliRunner};
+#[cfg(any(test, feature = "test_only"))]
 pub use fake_observer::FakeObserver;
 pub use interface::{ChainObserver, ChainObserverError};

mithril-common/src/digesters/dumb_immutable_observer.rs

@@ -0,0 +1,47 @@
+use crate::{
+    digesters::{ImmutableDigester, ImmutableDigesterError},
+    entities::Beacon,
+};
+use async_trait::async_trait;
+use tokio::sync::RwLock;
+
+/// A [ImmutableDigester] returning configurable result for testing purpose.
+pub struct DumbImmutableDigester {
+    digest: RwLock<String>,
+    is_success: bool,
+}
+
+impl DumbImmutableDigester {
+    /// DumbDigester factory
+    pub fn new(digest: &str, is_success: bool) -> Self {
+        let digest = RwLock::new(String::from(digest));
+
+        Self { digest, is_success }
+    }
+
+    /// Update digest returned by [compute_digest][DumbImmutableDigester::compute_digest]
+    pub async fn update_digest(&self, new_digest: String) {
+        let mut digest = self.digest.write().await;
+        *digest = new_digest;
+    }
+}
+
+impl Default for DumbImmutableDigester {
+    fn default() -> Self {
+        Self::new("1234", true)
+    }
+}
+
+#[async_trait]
+impl ImmutableDigester for DumbImmutableDigester {
+    async fn compute_digest(&self, beacon: &Beacon) -> Result<String, ImmutableDigesterError> {
+        if self.is_success {
+            Ok(self.digest.read().await.clone())
+        } else {
+            Err(ImmutableDigesterError::NotEnoughImmutable {
+                expected_number: beacon.immutable_file_number,
+                found_number: None,
+            })
+        }
+    }
+}

mithril-common/src/digesters/dummy_immutable_db_builder.rs

@@ -1,11 +1,11 @@
-#![cfg(test)]
 use crate::{digesters::ImmutableFile, entities::ImmutableFileNumber};
 use std::{
     fs::File,
     io::prelude::Write,
     path::{Path, PathBuf},
 };
 
+/// A [DummyImmutableDb] builder.
 pub struct DummyImmutablesDbBuilder {
     dir: PathBuf,
     immutables_to_write: Vec<ImmutableFileNumber>,
@@ -14,9 +14,13 @@ pub struct DummyImmutablesDbBuilder {
     file_size: Option<u64>,
 }
 
+/// A dummy cardano immutable db.
 pub struct DummyImmutableDb {
+    /// The dummy cardano db directory path.
     pub dir: PathBuf,
+    /// The [immutables files][ImmutableFile] in the dummy cardano db.
     pub immutables_files: Vec<ImmutableFile>,
+    /// Files that doesn't follow the immutable file name scheme in the dummy cardano db.
     pub non_immutables_files: Vec<PathBuf>,
 }
 
@@ -33,11 +37,14 @@ impl DummyImmutablesDbBuilder {
         }
     }
 
+    /// Set the immutables file number that will be used to generate the immutable files, for each
+    /// number three files will be generated (a 'chunk', a 'primary' and a 'secondary' file).
     pub fn with_immutables(&mut self, immutables: &[ImmutableFileNumber]) -> &mut Self {
         self.immutables_to_write = immutables.to_vec();
         self
     }
 
+    /// Set filenames to write to the db that doesn't follow the immutable file name scheme.
     pub fn with_non_immutables(&mut self, non_immutables: &[&str]) -> &mut Self {
         self.non_immutables_to_write = non_immutables.iter().map(|f| f.to_string()).collect();
         self
@@ -59,6 +66,7 @@ impl DummyImmutablesDbBuilder {
         self
     }
 
+    /// Build a [DummyImmutableDb].
     pub fn build(&self) -> DummyImmutableDb {
         let mut non_immutables_files = vec![];
         let mut immutable_numbers = self.immutables_to_write.clone();

mithril-common/src/digesters/immutable_digester.rs

@@ -5,7 +5,6 @@ use crate::{
 use async_trait::async_trait;
 use std::io;
 use thiserror::Error;
-use tokio::sync::RwLock;
 
 /// A digester than can compute the digest used for mithril signatures
 ///
@@ -68,44 +67,3 @@ pub enum ImmutableDigesterError {
     #[error("Digest computation failed: {0}")]
     DigestComputationError(#[from] io::Error),
 }
-
-/// A [ImmutableDigester] returning configurable result for testing purpose.
-pub struct DumbImmutableDigester {
-    digest: RwLock<String>,
-    is_success: bool,
-}
-
-impl DumbImmutableDigester {
-    /// DumbDigester factory
-    pub fn new(digest: &str, is_success: bool) -> Self {
-        let digest = RwLock::new(String::from(digest));
-
-        Self { digest, is_success }
-    }
-
-    /// Update digest returned by [compute_digest][DumbImmutableDigester::compute_digest]
-    pub async fn update_digest(&self, new_digest: String) {
-        let mut digest = self.digest.write().await;
-        *digest = new_digest;
-    }
-}
-
-impl Default for DumbImmutableDigester {
-    fn default() -> Self {
-        Self::new("1234", true)
-    }
-}
-
-#[async_trait]
-impl ImmutableDigester for DumbImmutableDigester {
-    async fn compute_digest(&self, beacon: &Beacon) -> Result<String, ImmutableDigesterError> {
-        if self.is_success {
-            Ok(self.digest.read().await.clone())
-        } else {
-            Err(ImmutableDigesterError::NotEnoughImmutable {
-                expected_number: beacon.immutable_file_number,
-                found_number: None,
-            })
-        }
-    }
-}

mithril-common/src/digesters/mod.rs

@@ -2,18 +2,23 @@
 
 pub mod cache;
 mod cardano_immutable_digester;
+#[cfg(any(test, feature = "test_only"))]
+mod dumb_immutable_observer;
+#[cfg(any(test, feature = "test_only"))]
 mod dummy_immutable_db_builder;
 mod immutable_digester;
 mod immutable_file;
 mod immutable_file_observer;
 
 pub use cardano_immutable_digester::CardanoImmutableDigester;
-pub use immutable_digester::{DumbImmutableDigester, ImmutableDigester, ImmutableDigesterError};
+pub use immutable_digester::{ImmutableDigester, ImmutableDigesterError};
 pub use immutable_file::{ImmutableFile, ImmutableFileCreationError, ImmutableFileListingError};
 pub use immutable_file_observer::{
     DumbImmutableFileObserver, ImmutableFileObserver, ImmutableFileObserverError,
     ImmutableFileSystemObserver,
 };
 
-#[cfg(test)]
-pub use dummy_immutable_db_builder::DummyImmutablesDbBuilder;
+#[cfg(any(test, feature = "test_only"))]
+pub use dumb_immutable_observer::DumbImmutableDigester;
+#[cfg(any(test, feature = "test_only"))]
+pub use dummy_immutable_db_builder::{DummyImmutableDb, DummyImmutablesDbBuilder};

mithril-common/src/lib.rs

@@ -9,9 +9,8 @@
 //! lib with the [crypto_helper].
 //! - A [certificate chain] used to validate the Certificate Chain created by an aggregator
 //! - The [entities] used by, and exchanged between, the aggregator, signers and client.
-//! - useful test utilities including stubs, [fake data][fake_data] builders, a tool validate
-//! conformity to an open api specification ([apispec]).
 
+#[cfg(any(test, feature = "test_only"))]
 pub mod apispec;
 mod beacon_provider;
 pub mod certificate_chain;
@@ -20,6 +19,7 @@ pub mod crypto_helper;
 pub mod database;
 pub mod digesters;
 pub mod entities;
+#[cfg(any(test, feature = "test_only"))]
 pub mod fake_data;
 pub mod sqlite;
 pub mod store;

mithril-common/src/store/adapter/mod.rs

@@ -1,6 +1,5 @@
 //! Define a generic way to store data with the [Store Adapter][store_adapter::StoreAdapter], with
-//! an adapter ([in memory][MemoryAdapter] and two more for testing ([a stub with one
-//! record][DumbStoreAdapter] and one which [always fails][FailStoreAdapter]).
+//! an adapter [in memory][MemoryAdapter] and another [sqlite][SQLiteAdapter].
 
 mod memory_adapter;
 mod sqlite_adapter;
@@ -10,7 +9,11 @@ pub use memory_adapter::MemoryAdapter;
 pub use sqlite_adapter::{SQLiteAdapter, SQLiteResultIterator};
 pub use store_adapter::*;
 
+#[cfg(any(test, feature = "test_only"))]
 mod dumb_adapter;
+#[cfg(any(test, feature = "test_only"))]
 pub use dumb_adapter::DumbStoreAdapter;
+#[cfg(any(test, feature = "test_only"))]
 mod fail_adapter;
+#[cfg(any(test, feature = "test_only"))]
 pub use fail_adapter::FailStoreAdapter;