Merge pull request #1341 from input-output-hk/djo/simplify_common_deps

Alenar · web-flow · commit 25d3c9ce3112 · 2023-11-13T16:31:14.000+01:00
Simplify common deps
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/mithril-aggregator/Cargo.toml b/mithril-aggregator/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "mithril-aggregator"
-version = "0.4.7"
+version = "0.4.8"
 description = "A Mithril Aggregator server"
 authors = { workspace = true }
 edition = { workspace = true }
@@ -48,6 +48,7 @@ zstd = { version = "0.13.0", features = ["zstdmt"] }
 httpmock = "0.6.8"
 mithril-common = { path = "../mithril-common", features = [
     "allow_skip_signer_certification",
+    "test_tools"
 ] }
 mockall = "0.11.4"
 slog-term = "2.9.0"
diff --git a/mithril-aggregator/src/dependency_injection/builder.rs b/mithril-aggregator/src/dependency_injection/builder.rs
@@ -534,6 +534,7 @@ impl DependenciesBuilder {
             &self.configuration.data_stores_directory,
             &format!("immutables_digests_{}.json", self.configuration.network),
         )
+        .with_logger(self.get_logger().await?)
         .should_reset_digests_cache(self.configuration.reset_digests_cache)
         .build()
         .await?;
diff --git a/mithril-aggregator/src/services/stake_distribution.rs b/mithril-aggregator/src/services/stake_distribution.rs
@@ -228,7 +228,7 @@ impl StakeDistributionService for MithrilStakeDistributionService {
 #[cfg(test)]
 mod tests {
     use crate::dependency_injection::DependenciesBuilder;
-    use mithril_common::chain_observer::MockChainObserver;
+    use crate::tools::mocks::MockChainObserver;
 
     use super::*;
 
diff --git a/mithril-aggregator/src/services/ticker.rs b/mithril-aggregator/src/services/ticker.rs
@@ -91,7 +91,8 @@ impl TickerService for MithrilTickerService {
 
 #[cfg(test)]
 mod tests {
-    use mithril_common::{chain_observer::MockChainObserver, digesters::DumbImmutableFileObserver};
+    use crate::tools::mocks::MockChainObserver;
+    use mithril_common::digesters::DumbImmutableFileObserver;
 
     use super::*;
 
diff --git a/mithril-aggregator/src/tools/mocks.rs b/mithril-aggregator/src/tools/mocks.rs
@@ -0,0 +1,28 @@
+use async_trait::async_trait;
+use mithril_common::chain_observer::{ChainAddress, ChainObserver, ChainObserverError, TxDatum};
+use mithril_common::crypto_helper::{KESPeriod, OpCert};
+use mithril_common::entities::{Epoch, StakeDistribution};
+use mockall::mock;
+
+mock! {
+    pub ChainObserver {}
+
+    #[async_trait]
+    impl ChainObserver for ChainObserver {
+        async fn get_current_datums(
+            &self,
+            address: &ChainAddress,
+        ) -> Result<Vec<TxDatum>, ChainObserverError>;
+
+        async fn get_current_epoch(&self) -> Result<Option<Epoch>, ChainObserverError>;
+
+        async fn get_current_stake_distribution(
+            &self,
+        ) -> Result<Option<StakeDistribution>, ChainObserverError>;
+
+        async fn get_current_kes_period(
+            &self,
+            opcert: &OpCert,
+        ) -> Result<Option<KESPeriod>, ChainObserverError>;
+    }
+}
diff --git a/mithril-aggregator/src/tools/mod.rs b/mithril-aggregator/src/tools/mod.rs
@@ -2,6 +2,8 @@ mod certificates_hash_migrator;
 mod digest_helpers;
 mod era;
 mod genesis;
+#[cfg(test)]
+pub mod mocks;
 mod remote_file_uploader;
 mod signer_importer;
 
diff --git a/mithril-client-cli/Cargo.toml b/mithril-client-cli/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "mithril-client-cli"
-version = "0.5.3"
+version = "0.5.4"
 description = "A Mithril Client"
 authors = { workspace = true }
 edition = { workspace = true }
@@ -58,7 +58,7 @@ zstd = "0.13.0"
 
 [dev-dependencies]
 httpmock = "0.6.8"
-mithril-common = { path = "../mithril-common" }
+mithril-common = { path = "../mithril-common", features = ["test_http_server"] }
 mockall = "0.11.4"
 warp = "0.3"
 
diff --git a/mithril-client/Cargo.toml b/mithril-client/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "mithril-client"
-version = "0.5.3"
+version = "0.5.4"
 description = "Mithril Client library"
 authors = { workspace = true }
 edition = { workspace = true }
@@ -35,6 +35,7 @@ zstd = "0.13.0"
 [dev-dependencies]
 httpmock = "0.6.8"
 indicatif = { version = "0.17.7", features = ["tokio"] }
+mithril-common = { path = "../mithril-common", features = ["test_http_server"] }
 mockall = "0.11.4"
 slog-async = "2.8.0"
 slog-scope = "4.4.0"
diff --git a/mithril-common/Cargo.toml b/mithril-common/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "mithril-common"
-version = "0.2.132"
+version = "0.2.133"
 authors = { workspace = true }
 edition = { workspace = true }
 documentation = { workspace = true }
@@ -24,18 +24,17 @@ chrono = { version = "0.4.31", features = ["serde"] }
 digest = "0.10.7"
 ed25519-dalek = { version = "2.0.0", features = ["rand_core", "serde"] }
 fixed = "1.24.0"
-glob = "0.3.1"
+glob = { version = "0.3.1", optional = true }
 hex = "0.4.3"
-http = "0.2.9"
-jsonschema = "0.17.1"
+http = { version = "0.2.9", optional = true }
+jsonschema = { version = "0.17.1", optional = true }
 kes-summed-ed25519 = { version = "0.2.1", features = [
     "serde_enabled",
     "sk_clone_enabled",
 ] }
-mockall = "0.11.4"
 nom = "7.1.3"
 rand_chacha = "0.3.1"
-rand_core = "0.6.4"
+rand_core = { version = "0.6.4", features = ["getrandom"] }
 rayon = "1.8.0"
 semver = "1.0.19"
 serde = { version = "1.0.188", features = ["derive"] }
@@ -45,18 +44,14 @@ serde_json = "1.0.107"
 serde_with = "3.3.0"
 serde_yaml = "0.9.25"
 sha2 = "0.10.8"
-slog = { version = "2.7.0", features = [
-    "max_level_trace",
-    "release_max_level_debug",
-] }
-slog-scope = "4.4.0"
+slog = "2.7.0"
 sqlite = { version = "0.31.1", features = ["bundled"] }
 strum = { version = "0.25.0", features = ["derive"] }
 thiserror = "1.0.49"
-tokio = { version = "1.32.0", features = ["full"] }
+tokio = { version = "1.32.0", features = ["fs", "io-util", "process", "rt", "sync"] }
 typetag = "0.2.13"
 walkdir = "2.4.0"
-warp = "0.3.6"
+warp = { version = "0.3.6", optional = true }
 
 [target.'cfg(not(windows))'.dependencies]
 # non-windows: use default rug backend
@@ -70,10 +65,12 @@ mithril-stm = { path = "../mithril-stm", default-features = false, features = [
 
 [dev-dependencies]
 criterion = { version = "0.5.1", features = ["html_reports", "async_tokio"] }
+mockall = "0.11.4"
 reqwest = { version = "0.11.22", features = ["json"] }
 slog-async = "2.8.0"
 slog-scope = "4.4.0"
 slog-term = "2.9.0"
+tokio = { version = "1.32.0", features = ["macros", "time"] }
 
 [build-dependencies]
 glob = "0.3.1"
@@ -83,7 +80,15 @@ serde_yaml = "0.9.25"
 
 [features]
 default = []
+
+allow_skip_signer_certification = []
+# portable feature avoids SIGILL crashes on CPUs not supporting Intel ADX instruction set when built on CPUs that support it
 portable = [
     "mithril-stm/portable",
-] # portable feature avoids SIGILL crashes on CPUs not supporting Intel ADX instruction set when built on CPUs that support it
-allow_skip_signer_certification = []
+]
+
+# Enable all tests tools
+test_tools = ["apispec", "test_http_server"]
+# Enable tools to helps validate conformity to an OpenAPI specification
+apispec = ["glob", "http", "jsonschema", "warp"]
+test_http_server = ["warp"]
diff --git a/mithril-common/src/chain_observer/interface.rs b/mithril-common/src/chain_observer/interface.rs
@@ -4,9 +4,11 @@ use crate::{
     StdError,
 };
 use async_trait::async_trait;
-use mockall::automock;
 use thiserror::Error;
 
+#[cfg(test)]
+use mockall::automock;
+
 use super::{ChainAddress, TxDatum};
 
 /// [ChainObserver] related errors.
@@ -22,10 +24,10 @@ pub enum ChainObserverError {
 }
 
 /// Retrieve data from the cardano network
-#[automock]
+#[cfg_attr(test, automock)]
 #[async_trait]
 pub trait ChainObserver: Sync + Send {
-    /// Retrieve the datums associated to and address
+    /// Retrieve the datums associated to an address
     async fn get_current_datums(
         &self,
         address: &ChainAddress,
diff --git a/mithril-common/src/chain_observer/mod.rs b/mithril-common/src/chain_observer/mod.rs
@@ -7,7 +7,9 @@ mod model;
 
 pub use cli_observer::{CardanoCliChainObserver, CardanoCliRunner};
 pub use fake_observer::FakeObserver;
-pub use interface::{ChainObserver, ChainObserverError, MockChainObserver};
+#[cfg(test)]
+pub use interface::MockChainObserver;
+pub use interface::{ChainObserver, ChainObserverError};
 pub use model::{
     ChainAddress, TxDatum, TxDatumBuilder, TxDatumError, TxDatumFieldTypeName, TxDatumFieldValue,
 };
diff --git a/mithril-common/src/digesters/cache/json_provider_builder.rs b/mithril-common/src/digesters/cache/json_provider_builder.rs
@@ -3,7 +3,7 @@ use crate::{
     StdResult,
 };
 use anyhow::Context;
-use slog_scope::info;
+use slog::{info, Logger};
 use std::path::Path;
 use tokio::fs;
 
@@ -13,6 +13,7 @@ pub struct JsonImmutableFileDigestCacheProviderBuilder<'a> {
     filename: &'a str,
     ensure_dir_exist: bool,
     reset_digests_cache: bool,
+    logger: Logger,
 }
 
 impl<'a> JsonImmutableFileDigestCacheProviderBuilder<'a> {
@@ -23,6 +24,7 @@ impl<'a> JsonImmutableFileDigestCacheProviderBuilder<'a> {
             filename,
             ensure_dir_exist: false,
             reset_digests_cache: false,
+            logger: Logger::root(slog::Discard, slog::o!()),
         }
     }
 
@@ -38,6 +40,12 @@ impl<'a> JsonImmutableFileDigestCacheProviderBuilder<'a> {
         self
     }
 
+    /// Set the [Logger] to use.
+    pub fn with_logger(&mut self, logger: Logger) -> &mut Self {
+        self.logger = logger;
+        self
+    }
+
     /// Build a [JsonImmutableFileDigestCacheProvider] based on the parameters previously set.
     pub async fn build(&self) -> StdResult<JsonImmutableFileDigestCacheProvider> {
         let cache_file = self.cache_dir.join(self.filename);
@@ -62,6 +70,7 @@ impl<'a> JsonImmutableFileDigestCacheProviderBuilder<'a> {
         }
 
         info!(
+            self.logger,
             "Storing/Getting immutables digests cache from: {}",
             cache_file.display()
         );
diff --git a/mithril-common/src/test_utils/mod.rs b/mithril-common/src/test_utils/mod.rs
@@ -6,11 +6,13 @@
 //! * A builder of [MithrilFixture] to generate signers alongside a stake distribution
 //!
 
+#[cfg(feature = "apispec")]
 pub mod apispec;
 pub mod fake_data;
 pub mod fake_keys;
 mod fixture_builder;
 mod mithril_fixture;
+#[cfg(feature = "test_http_server")]
 pub mod test_http_server;
 
 pub use fixture_builder::{MithrilFixtureBuilder, StakeDistributionGenerationMethod};
diff --git a/mithril-common/src/test_utils/test_http_server.rs b/mithril-common/src/test_utils/test_http_server.rs
@@ -85,7 +85,7 @@ where
 #[cfg(test)]
 mod tests {
     use super::*;
-    use http::StatusCode;
+    use reqwest::StatusCode;
     use serde::Deserialize;
 
     #[tokio::test]
diff --git a/mithril-signer/Cargo.toml b/mithril-signer/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "mithril-signer"
-version = "0.2.88"
+version = "0.2.89"
 description = "A Mithril Signer"
 authors = { workspace = true }
 edition = { workspace = true }
diff --git a/mithril-signer/src/runtime/signer_services.rs b/mithril-signer/src/runtime/signer_services.rs
@@ -130,6 +130,7 @@ impl<'a> ProductionServiceBuilder<'a> {
             &format!("immutables_digests_{}.json", self.config.network),
         )
         .should_reset_digests_cache(self.config.reset_digests_cache)
+        .with_logger(slog_scope::logger())
         .build()
         .await?;
 

Original file line number	Diff line number	Diff line change
`@@ -534,6 +534,7 @@ impl DependenciesBuilder {`
`534`	`534`	`&self.configuration.data_stores_directory,`
`535`	`535`	`&format!("immutables_digests_{}.json", self.configuration.network),`
`536`	`536`	`)`
	`537`	`+ .with_logger(self.get_logger().await?)`
`537`	`538`	`.should_reset_digests_cache(self.configuration.reset_digests_cache)`
`538`	`539`	`.build()`
`539`	`540`	`.await?;`