( + 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) + .map_err(|err| ::stackable_versioned::Error::MergeCrd { + source: err, + })?; + YamlSchema::write_yaml_schema( + &merged_crd, + path, + operator_version, + SerializeOptions::default(), + ) + .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, + ) -> Result<(), ::stackable_versioned::Error> { + use ::stackable_shared::yaml::{YamlSchema, SerializeOptions}; + 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(), + ) + .map_err(|err| ::stackable_versioned::Error::SerializeYaml { + source: err, + }) + } } diff --git a/crates/stackable-versioned-macros/src/codegen/vstruct/mod.rs b/crates/stackable-versioned-macros/src/codegen/vstruct/mod.rs index f48a80c2..6de44835 100644 --- a/crates/stackable-versioned-macros/src/codegen/vstruct/mod.rs +++ b/crates/stackable-versioned-macros/src/codegen/vstruct/mod.rs @@ -382,13 +382,51 @@ impl VersionedStruct { #[automatically_derived] impl #enum_ident { - /// Generates a merged CRD which contains all versions defined using the - /// `#[versioned()]` macro. + /// Generates a merged CRD which contains all versions defined using the `#[versioned()]` macro. pub fn merged_crd( stored_apiversion: Self ) -> ::std::result::Result<::k8s_openapi::apiextensions_apiserver::pkg::apis::apiextensions::v1::CustomResourceDefinition, ::kube::core::crd::MergeError> { ::kube::core::crd::merge_crds(vec![#(#crd_fn_calls),*], &stored_apiversion.to_string()) } + + /// 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
(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).map_err(|err| ::stackable_versioned::Error::MergeCrd { + source: err, + })?; + + YamlSchema::write_yaml_schema( + &merged_crd, + path, + operator_version, + SerializeOptions::default() + ).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) -> Result<(), ::stackable_versioned::Error> { + use ::stackable_shared::yaml::{YamlSchema, SerializeOptions}; + + 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() + ).map_err(|err| ::stackable_versioned::Error::SerializeYaml { + source: err, + }) + } } } } diff --git a/crates/stackable-versioned/CHANGELOG.md b/crates/stackable-versioned/CHANGELOG.md index 2158638b..18f13541 100644 --- a/crates/stackable-versioned/CHANGELOG.md +++ b/crates/stackable-versioned/CHANGELOG.md @@ -6,9 +6,12 @@ All notable changes to this project will be documented in this file. ### Added +- Add YAML serialization for merged CRD schema. The schema can now be printed to stdout or written + to file ([#884]). - Add snapshot tests to verify generated code matches expected output ([#881]). [#881]: https://github.com/stackabletech/operator-rs/pull/881 +[#884]: https://github.com/stackabletech/operator-rs/pull/884 ## [0.3.0] - 2024-09-26 diff --git a/crates/stackable-versioned/Cargo.toml b/crates/stackable-versioned/Cargo.toml index c95a3b3e..2004914d 100644 --- a/crates/stackable-versioned/Cargo.toml +++ b/crates/stackable-versioned/Cargo.toml @@ -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-versioned-macros = { path = "../stackable-versioned-macros" } +stackable-shared = { path = "../stackable-shared", optional = true } + +kube = { workspace = true, optional = true } +snafu = { workspace = true, optional = true } diff --git a/crates/stackable-versioned/src/lib.rs b/crates/stackable-versioned/src/lib.rs index 1f2d99d1..6352ed30 100644 --- a/crates/stackable-versioned/src/lib.rs +++ b/crates/stackable-versioned/src/lib.rs @@ -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 {