feature(protocol-config): add test double on MithrilNetworkConfigurationProvider

Author: turmelclem

internal/mithril-protocol-config/src/lib.rs

@@ -3,6 +3,7 @@ const HTTP_REQUEST_TIMEOUT_DURATION: u64 = 30000;
 pub mod http_client;
 pub mod interface;
 pub mod model;
+pub mod test;
 
 #[cfg(test)]
 pub(crate) mod test_tools {

internal/mithril-protocol-config/src/model.rs

@@ -4,12 +4,14 @@ use mithril_common::entities::{
     CardanoTransactionsSigningConfig, Epoch, ProtocolParameters, SignedEntityTypeDiscriminants,
 };
 
+#[derive(PartialEq, Clone, Debug)]
 pub enum SignedEntityTypeConfiguration {
     /// Cardano Transactions
     CardanoTransactions(CardanoTransactionsSigningConfig),
 }
 
 /// A Mithril network configuration
+#[derive(PartialEq, Clone, Debug)]
 pub struct MithrilNetworkConfiguration {
     /// Epoch
     pub epoch: Epoch,

internal/mithril-protocol-config/src/test/double/fake_data.rs

@@ -0,0 +1,24 @@
+use std::collections::{BTreeSet, HashMap};
+
+use mithril_common::entities::{Epoch, ProtocolParameters, SignedEntityTypeDiscriminants};
+
+use crate::model::{MithrilNetworkConfiguration, SignedEntityTypeConfiguration};
+
+pub fn mithril_network_configuration(
+    epoch: u64,
+    k: u64,
+    m: u64,
+    phi_f: f64,
+    available_signed_entity_types: BTreeSet<SignedEntityTypeDiscriminants>,
+    signed_entity_types_config: HashMap<
+        SignedEntityTypeDiscriminants,
+        SignedEntityTypeConfiguration,
+    >,
+) -> MithrilNetworkConfiguration {
+    MithrilNetworkConfiguration {
+        epoch: Epoch(epoch),
+        signer_registration_protocol_parameters: ProtocolParameters { k, m, phi_f },
+        available_signed_entity_types,
+        signed_entity_types_config,
+    }
+}

internal/mithril-protocol-config/src/test/double/mithril_network_configuration_provider.rs

@@ -0,0 +1,68 @@
+use crate::{interface::MithrilNetworkConfigurationProvider, model::MithrilNetworkConfiguration};
+use async_trait::async_trait;
+use mithril_common::StdResult;
+
+/// A fake [MithrilNetworkConfigurationProvider] that return [MithrilNetworkConfiguration]
+pub struct FakeMithrilNetworkConfigurationProvider {
+    configuration: MithrilNetworkConfiguration,
+}
+
+impl FakeMithrilNetworkConfigurationProvider {
+    /// Create a new [FakeMithrilNetworkConfigurationProvider]
+    pub fn from_mithril_network_configuration(configuration: MithrilNetworkConfiguration) -> Self {
+        Self { configuration }
+    }
+}
+
+#[cfg_attr(target_family = "wasm", async_trait(?Send))]
+#[cfg_attr(not(target_family = "wasm"), async_trait)]
+impl MithrilNetworkConfigurationProvider for FakeMithrilNetworkConfigurationProvider {
+    async fn get(&self) -> StdResult<MithrilNetworkConfiguration> {
+        Ok(self.configuration.clone())
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use std::collections::{BTreeSet, HashMap};
+
+    use mithril_common::{
+        StdResult,
+        entities::{BlockNumber, CardanoTransactionsSigningConfig, SignedEntityTypeDiscriminants},
+    };
+
+    use super::*;
+    use crate::{model::SignedEntityTypeConfiguration, test::double::fake_data};
+
+    #[tokio::test]
+    async fn fake_mithril_network_configuration_provider_returns_configuration() -> StdResult<()> {
+        let mut available_signed_entity_types = BTreeSet::new();
+        available_signed_entity_types.insert(SignedEntityTypeDiscriminants::CardanoTransactions);
+
+        let mut signed_entity_types_config = HashMap::new();
+        signed_entity_types_config.insert(
+            SignedEntityTypeDiscriminants::CardanoTransactions,
+            SignedEntityTypeConfiguration::CardanoTransactions(CardanoTransactionsSigningConfig {
+                security_parameter: BlockNumber(13),
+                step: BlockNumber(26),
+            }),
+        );
+
+        let configuration = fake_data::mithril_network_configuration(
+            42,
+            1,
+            2,
+            0.123,
+            available_signed_entity_types,
+            signed_entity_types_config,
+        );
+        let provider = FakeMithrilNetworkConfigurationProvider::from_mithril_network_configuration(
+            configuration.clone(),
+        );
+
+        let retrieved_configuration = provider.get().await?;
+
+        assert_eq!(configuration, retrieved_configuration);
+        Ok(())
+    }
+}

internal/mithril-protocol-config/src/test/double/mod.rs

@@ -0,0 +1,2 @@
+mod fake_data;
+mod mithril_network_configuration_provider;

internal/mithril-protocol-config/src/test/mod.rs

@@ -0,0 +1 @@
+pub mod double;