chore: Use shared YAML code

Author: Techassi

Cargo.lock

@@ -11,7 +11,8 @@ repository.workspace = true
 time = ["dep:time"]
 
 [dependencies]
-stackable-operator-derive = { path = "../stackable-operator-derive" }
+stackable-operator-derive = { path = "../stackable-operator-derive", version = "0.3.1" }
+stackable-shared = { path = "../stackable-shared", version = "0.0.1" }
 
 chrono.workspace = true
 clap.workspace = true

crates/stackable-operator/Cargo.toml

@@ -2,40 +2,7 @@ use std::marker::PhantomData;
 
 use derivative::Derivative;
 use schemars::JsonSchema;
-use semver::Version;
 use serde::{Deserialize, Serialize};
-use snafu::{ResultExt, Snafu};
-
-use crate::yaml;
-use std::fs::File;
-use std::io::Write;
-use std::path::Path;
-
-const DOCS_HOME_URL_PLACEHOLDER: &str = "DOCS_BASE_URL_PLACEHOLDER";
-const DOCS_HOME_BASE_URL: &str = "https://docs.stackable.tech/home";
-
-type Result<T, E = Error> = std::result::Result<T, E>;
-
-#[derive(Debug, Snafu)]
-pub enum Error {
-    #[snafu(display("cannot parse version {version:?} as a semantic version"))]
-    InvalidSemverVersion {
-        source: semver::Error,
-        version: String,
-    },
-
-    #[snafu(display("error converting CRD byte array to UTF-8"))]
-    ConvertByteArrayToUtf8 { source: std::string::FromUtf8Error },
-
-    #[snafu(display("failed to serialize YAML"))]
-    SerializeYaml { source: yaml::Error },
-
-    #[snafu(display("failed to write YAML"))]
-    WriteYamlSchema { source: std::io::Error },
-
-    #[snafu(display("failed to create YAML file"))]
-    CreateYamlFile { source: std::io::Error },
-}
 
 /// A reference to a product cluster (for example, a `ZookeeperCluster`)
 ///
@@ -96,83 +63,6 @@ pub trait HasApplication {
     fn get_application_name() -> &'static str;
 }
 
-/// Takes an operator version and returns a docs version
-fn docs_version(operator_version: &str) -> Result<String> {
-    if operator_version == "0.0.0-dev" {
-        Ok("nightly".to_owned())
-    } else {
-        let v = Version::parse(operator_version).context(InvalidSemverVersionSnafu {
-            version: operator_version.to_owned(),
-        })?;
-        Ok(format!("{}.{}", v.major, v.minor))
-    }
-}
-
-/// Given an operator version like 0.0.0-dev or 23.1.1, generate a docs home
-/// component base URL like `https://docs.stackable.tech/home/nightly/` or
-/// `https://docs.stackable.tech/home/23.1/`.
-fn docs_home_versioned_base_url(operator_version: &str) -> Result<String> {
-    Ok(format!(
-        "{}/{}",
-        DOCS_HOME_BASE_URL,
-        docs_version(operator_version)?
-    ))
-}
-
-/// This trait can be implemented to allow automatic handling
-/// (e.g. creation) of `CustomResourceDefinition`s in Kubernetes.
-pub trait CustomResourceExt: kube::CustomResourceExt {
-    /// Generates a YAML CustomResourceDefinition and writes it to a `Write`.
-    ///
-    /// The generated YAML string is an explicit document with leading dashes (`---`).
-    fn generate_yaml_schema<W>(mut writer: W, operator_version: &str) -> Result<()>
-    where
-        W: Write,
-    {
-        let mut buffer = Vec::new();
-        yaml::serialize_to_explicit_document(&mut buffer, &Self::crd())
-            .context(SerializeYamlSnafu)?;
-
-        let yaml_schema = String::from_utf8(buffer)
-            .context(ConvertByteArrayToUtf8Snafu)?
-            .replace(
-                DOCS_HOME_URL_PLACEHOLDER,
-                &docs_home_versioned_base_url(operator_version)?,
-            );
-
-        writer
-            .write_all(yaml_schema.as_bytes())
-            .context(WriteYamlSchemaSnafu)
-    }
-
-    /// Generates a YAML CustomResourceDefinition and writes it to the specified file.
-    ///
-    /// The written YAML string is an explicit document with leading dashes (`---`).
-    fn write_yaml_schema<P: AsRef<Path>>(path: P, operator_version: &str) -> Result<()> {
-        let writer = File::create(path).context(CreateYamlFileSnafu)?;
-        Self::generate_yaml_schema(writer, operator_version)
-    }
-
-    /// Generates a YAML CustomResourceDefinition and prints it to stdout.
-    ///
-    /// The printed YAML string is an explicit document with leading dashes (`---`).
-    fn print_yaml_schema(operator_version: &str) -> Result<()> {
-        let writer = std::io::stdout();
-        Self::generate_yaml_schema(writer, operator_version)
-    }
-
-    /// Returns the YAML schema of this CustomResourceDefinition as a string.
-    ///
-    /// The written YAML string is an explicit document with leading dashes (`---`).
-    fn yaml_schema(operator_version: &str) -> Result<String> {
-        let mut writer = Vec::new();
-        Self::generate_yaml_schema(&mut writer, operator_version)?;
-        String::from_utf8(writer).context(ConvertByteArrayToUtf8Snafu)
-    }
-}
-
-impl<T> CustomResourceExt for T where T: kube::CustomResourceExt {}
-
 #[cfg(test)]
 mod tests {
     use k8s_openapi::api::core::v1::ConfigMap;

crates/stackable-operator/src/crd.rs

@@ -79,7 +79,7 @@ mod tests {
 
     use rstest::rstest;
 
-    use crate::yaml::serialize_to_explicit_document;
+    use stackable_shared::yaml::{serialize as ser, SerializeOptions};
 
     use super::*;
 
@@ -102,7 +102,7 @@ mod tests {
         let expected = std::fs::read_to_string("fixtures/helm/output.yaml").unwrap();
 
         let mut output = Vec::new();
-        serialize_to_explicit_document(&mut output, &values).unwrap();
+        ser(&values, &mut output, SerializeOptions::default()).unwrap();
 
         assert_eq!(std::str::from_utf8(&output).unwrap(), expected);
     }

crates/stackable-operator/src/helm/mod.rs

@@ -20,10 +20,11 @@ pub mod status;
 pub mod time;
 pub mod utils;
 pub mod validation;
-pub mod yaml;
 
-pub use crate::crd::CustomResourceExt;
+// Internal re-exports
+pub use stackable_shared::yaml::CustomResourceExt;
 
+// External re-exports
 pub use ::k8s_openapi;
 pub use ::kube;
 pub use ::schemars;