chore: Split CRD and YAML specific code

Author: Techassi

crates/stackable-operator/src/cli.rs

@@ -14,7 +14,7 @@
 //! use kube::CustomResource;
 //! use schemars::JsonSchema;
 //! use serde::{Deserialize, Serialize};
-//! use stackable_operator::{CustomResourceExt, cli, crd};
+//! use stackable_operator::{CustomResourceExt, cli, shared::crd};
 //!
 //! const OPERATOR_VERSION: &str = "23.1.1";
 //!
@@ -106,16 +106,17 @@
 //! ```
 //!
 //!
-use crate::logging::TracingTarget;
-use crate::namespace::WatchNamespace;
-use clap::Args;
-use product_config::ProductConfigManager;
-use snafu::{ResultExt, Snafu};
 use std::{
     ffi::OsStr,
     path::{Path, PathBuf},
 };
 
+use clap::Args;
+use product_config::ProductConfigManager;
+use snafu::{ResultExt, Snafu};
+
+use crate::{logging::TracingTarget, namespace::WatchNamespace};
+
 pub const AUTHOR: &str = "Stackable GmbH - [email protected]";
 
 type Result<T, E = Error> = std::result::Result<T, E>;

crates/stackable-operator/src/lib.rs

@@ -22,7 +22,11 @@ pub mod utils;
 pub mod validation;
 
 // Internal re-exports
-pub use stackable_shared::yaml::CustomResourceExt;
+pub use stackable_shared::{crd::CustomResourceExt, yaml::YamlSchema};
+
+pub mod shared {
+    pub use stackable_shared::*;
+}
 
 // External re-exports
 pub use ::k8s_openapi;

crates/stackable-shared/src/crd.rs

@@ -0,0 +1,56 @@
+use std::path::Path;
+
+use snafu::{ResultExt, Snafu};
+
+use crate::yaml::{SerializeOptions, YamlSchema};
+
+pub type Result<T, E = Error> = std::result::Result<T, E>;
+
+#[derive(Debug, Snafu)]
+pub enum Error {
+    #[snafu(display("failed to write CRD YAML schema to file"))]
+    WriteToFile { source: crate::yaml::Error },
+
+    #[snafu(display("failed to write CRD YAML schema to stdout"))]
+    WriteToStdout { source: crate::yaml::Error },
+
+    #[snafu(display("failed to generate CRD YAML schema"))]
+    GenerateSchema { source: crate::yaml::Error },
+}
+
+/// Provides YAML schema generation and output capabilities for Kubernetes custom resources.
+pub trait CustomResourceExt: kube::CustomResourceExt {
+    /// Generates the YAML schema of a `CustomResourceDefinition` and writes it to the specified
+    /// file at `path`.
+    ///
+    /// It additionally replaces the documentation URL placeholder with the correct value based on
+    /// the provided `operator_version`. The written YAML string is an explicit document with
+    /// leading dashes (`---`).
+    fn write_yaml_schema<P: AsRef<Path>>(path: P, operator_version: &str) -> Result<()> {
+        Self::crd()
+            .write_yaml_schema(path, operator_version, SerializeOptions::default())
+            .context(WriteToFileSnafu)
+    }
+
+    /// Generates the YAML schema of a `CustomResourceDefinition` and prints it to [stdout].
+    ///
+    /// It additionally replaces the documentation URL placeholder with the correct value based on
+    /// the provided `operator_version`. The written YAML string is an explicit document with
+    /// leading dashes (`---`).
+    ///
+    /// [stdout]: std::io::stdout
+    fn print_yaml_schema(operator_version: &str) -> Result<()> {
+        Self::crd()
+            .print_yaml_schema(operator_version, SerializeOptions::default())
+            .context(WriteToStdoutSnafu)
+    }
+
+    /// Generates the YAML schema of a `CustomResourceDefinition` and returns it as a [`String`].
+    fn yaml_schema(operator_version: &str) -> Result<String> {
+        Self::crd()
+            .generate_yaml_schema(operator_version, SerializeOptions::default())
+            .context(GenerateSchemaSnafu)
+    }
+}
+
+impl<T> CustomResourceExt for T where T: kube::CustomResourceExt {}

crates/stackable-shared/src/lib.rs

@@ -1,4 +1,5 @@
 //! This crate contains various shared helpers and utilities used across other crates in this
 //! workspace.
 
+pub mod crd;
 pub mod yaml;

crates/stackable-shared/src/yaml/mod.rs renamed to crates/stackable-shared/src/yaml.rs

@@ -128,37 +128,6 @@ pub trait YamlSchema: Sized + serde::Serialize {
 
 impl<T> YamlSchema for T where T: serde::ser::Serialize {}
 
-/// Provides YAML schema generation and output capabilities for Kubernetes custom resources.
-pub trait CustomResourceExt: kube::CustomResourceExt {
-    /// Generates the YAML schema of a `CustomResourceDefinition` and writes it to the specified
-    /// file at `path`.
-    ///
-    /// It additionally replaces the documentation URL placeholder with the correct value based on
-    /// the provided `operator_version`. The written YAML string is an explicit document with
-    /// leading dashes (`---`).
-    fn write_yaml_schema<P: AsRef<Path>>(path: P, operator_version: &str) -> Result<()> {
-        Self::crd().write_yaml_schema(path, operator_version, SerializeOptions::default())
-    }
-
-    /// Generates the YAML schema of a `CustomResourceDefinition` and prints it to [stdout].
-    ///
-    /// It additionally replaces the documentation URL placeholder with the correct value based on
-    /// the provided `operator_version`. The written YAML string is an explicit document with
-    /// leading dashes (`---`).
-    ///
-    /// [stdout]: std::io::stdout
-    fn print_yaml_schema(operator_version: &str) -> Result<()> {
-        Self::crd().print_yaml_schema(operator_version, SerializeOptions::default())
-    }
-
-    /// Generates the YAML schema of a `CustomResourceDefinition` and returns it as a [`String`].
-    fn yaml_schema(operator_version: &str) -> Result<String> {
-        Self::crd().generate_yaml_schema(operator_version, SerializeOptions::default())
-    }
-}
-
-impl<T> CustomResourceExt for T where T: kube::CustomResourceExt {}
-
 /// Serializes the given data structure and writes it to a [`Writer`](Write).
 pub fn serialize<T, W>(value: &T, mut writer: W, options: SerializeOptions) -> Result<()>
 where