feat: Make YAML helpers fallible

Author: Techassi

Cargo.lock

@@ -391,33 +391,41 @@ impl VersionedStruct {
 
                 /// Generates and writes a merged CRD which contains all versions defined using the `#[versioned()]`
                 /// macro to a file located at `path`.
-                pub fn write_merged_crd<P>(path: P, stored_apiversion: Self, operator_version: &str)
+                pub fn write_merged_crd<P>(path: P, stored_apiversion: Self, operator_version: &str) -> Result<(), ::stackable_versioned::Error>
                     where P: AsRef<::std::path::Path>
                 {
                     use ::stackable_shared::yaml::{YamlSchema, SerializeOptions};
 
-                    let merged_crd = Self::merged_crd(stored_apiversion).unwrap();
+                    let merged_crd = Self::merged_crd(stored_apiversion).map_err(|err| ::stackable_versioned::Error::MergeCrd {
+                        source: err,
+                    })?;
 
                     YamlSchema::write_yaml_schema(
                         &merged_crd,
                         path,
                         operator_version,
                         SerializeOptions::default()
-                    ).unwrap();
+                    ).map_err(|err| ::stackable_versioned::Error::SerializeYaml {
+                        source: err,
+                    })
                 }
 
                 /// Generates and writes a merged CRD which contains all versions defined using the `#[versioned()]`
                 /// macro to stdout.
-                pub fn print_merged_crd(stored_apiversion: Self, operator_version: &str) {
+                pub fn print_merged_crd(stored_apiversion: Self, operator_version: &str) -> Result<(), ::stackable_versioned::Error> {
                     use ::stackable_shared::yaml::{YamlSchema, SerializeOptions};
 
-                    let merged_crd = Self::merged_crd(stored_apiversion).unwrap();
+                    let merged_crd = Self::merged_crd(stored_apiversion).map_err(|err| ::stackable_versioned::Error::MergeCrd {
+                        source: err,
+                    })?;
 
                     YamlSchema::print_yaml_schema(
                         &merged_crd,
                         operator_version,
                         SerializeOptions::default()
-                    ).unwrap();
+                    ).map_err(|err| ::stackable_versioned::Error::SerializeYaml {
+                        source: err,
+                    })
                 }
             }
         }

crates/stackable-versioned-macros/src/codegen/vstruct/mod.rs

@@ -12,8 +12,16 @@ all-features = true
 
 [features]
 full = ["k8s"]
-# Forward the k8s feature to the underlying macro crate
-k8s = ["stackable-versioned-macros/k8s"]
+k8s = [
+  "stackable-versioned-macros/k8s", # Forward the k8s feature to the underlying macro crate
+  "dep:stackable-shared",
+  "dep:snafu",
+  "dep:kube",
+]
 
 [dependencies]
+stackable-shared = { path = "../stackable-shared", version = "0.0.1", optional = true }
 stackable-versioned-macros = { path = "../stackable-versioned-macros" }
+
+kube = { workspace = true, optional = true }
+snafu = { workspace = true, optional = true }

crates/stackable-versioned/Cargo.toml

@@ -12,8 +12,21 @@
 //! See [`versioned`] for an in-depth usage guide and a list of supported
 //! parameters.
 
+// Re-export macro
 pub use stackable_versioned_macros::*;
 
+#[cfg(feature = "k8s")]
+#[derive(Debug, snafu::Snafu)]
+pub enum Error {
+    #[snafu(display("failed to merge CRDs"))]
+    MergeCrd { source: kube::core::crd::MergeError },
+
+    #[snafu(display("failed to serialize YAML"))]
+    SerializeYaml {
+        source: stackable_shared::yaml::Error,
+    },
+}
+
 // Unused for now, might get picked up again in the future.
 #[doc(hidden)]
 pub trait AsVersionStr {