test(common): add APIVersionProviderTestExtension

To enable testing with canned `openapi.yml` version or setting up a
always failing provider

Author: Alenar

internal/mithril-aggregator-client/src/client.rs

@@ -68,6 +68,8 @@ mod tests {
     use http::StatusCode;
     use httpmock::MockServer;
 
+    use mithril_common::test::api_version_extensions::ApiVersionProviderTestExtension;
+
     use crate::test::TestLogger;
 
     use super::*;

mithril-aggregator/src/services/aggregator_client.rs

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

mithril-common/src/api_version.rs

@@ -63,14 +63,6 @@ impl APIVersionProvider {
         versions.sort();
         versions
     }
-
-    /// Update open api versions. Test only
-    pub fn update_open_api_versions(
-        &mut self,
-        open_api_versions: HashMap<OpenAPIFileName, Version>,
-    ) {
-        self.open_api_versions = open_api_versions;
-    }
 }
 
 impl Default for APIVersionProvider {
@@ -87,8 +79,31 @@ impl Default for APIVersionProvider {
     }
 }
 
+#[cfg(any(test, feature = "test_tools"))]
+impl crate::test::api_version_extensions::ApiVersionProviderTestExtension for APIVersionProvider {
+    fn update_open_api_versions(&mut self, open_api_versions: HashMap<OpenAPIFileName, Version>) {
+        self.open_api_versions = open_api_versions;
+    }
+
+    fn new_with_default_version(version: Version) -> APIVersionProvider {
+        Self {
+            open_api_versions: HashMap::from([("openapi.yaml".to_string(), version)]),
+            ..Self::default()
+        }
+    }
+
+    fn new_failing() -> APIVersionProvider {
+        Self {
+            // Leverage the error raised if the default api version is missing
+            open_api_versions: HashMap::new(),
+            ..Self::default()
+        }
+    }
+}
+
 #[cfg(test)]
 mod test {
+    use crate::test::api_version_extensions::ApiVersionProviderTestExtension;
     use crate::test::double::DummyApiVersionDiscriminantSource;
 
     use super::*;
@@ -177,4 +192,18 @@ mod test {
             &version
         );
     }
+
+    #[test]
+    fn building_provider_with_canned_default_openapi_version() {
+        let provider = APIVersionProvider::new_with_default_version(Version::new(1, 2, 3));
+        let version = provider.compute_current_version().unwrap();
+
+        assert_eq!(Version::new(1, 2, 3), version);
+    }
+
+    #[test]
+    fn building_provider_that_fails_compute_current_version() {
+        let provider = APIVersionProvider::new_failing();
+        provider.compute_current_version().expect_err("Should fail");
+    }
 }

mithril-common/src/test/api_version_extensions.rs

@@ -0,0 +1,18 @@
+//! A set of extension traits to add test utilities to this crate `APIVersionProvider`
+
+use semver::Version;
+use std::collections::HashMap;
+
+use crate::api_version::{APIVersionProvider, OpenAPIFileName};
+
+/// Extension trait adding test utilities to [APIVersionProvider]
+pub trait ApiVersionProviderTestExtension {
+    /// `TEST ONLY` - Replace the open api versions
+    fn update_open_api_versions(&mut self, open_api_versions: HashMap<OpenAPIFileName, Version>);
+
+    /// `TEST ONLY` - Set up an ` APIVersionProvider ` with the given version for the `openapi.yaml` file
+    fn new_with_default_version(version: Version) -> APIVersionProvider;
+
+    /// `TEST ONLY` - Set up an ` APIVersionProvider ` that fails to compute api versions
+    fn new_failing() -> APIVersionProvider;
+}

mithril-common/src/test/mod.rs

@@ -12,6 +12,7 @@
 //! * `temp_dir`: Temporary directory management for tests
 //!
 
+pub mod api_version_extensions;
 pub mod builder;
 pub mod crypto_helper;
 pub mod double;

mithril-signer/src/services/aggregator_client.rs

@@ -1057,6 +1057,8 @@ mod tests {
     }
 
     mod warn_if_api_version_mismatch {
+        use mithril_common::test::api_version_extensions::ApiVersionProviderTestExtension;
+
         use super::*;
 
         fn version_provider_with_open_api_version<V: Into<String>>(