feat(stackable-versioned)!: Integrate with ConversionReviews (#1050)

* feat(stackable-versioned): Add flux-converter

* test: Add roundtrip generation via macro

* fix some tests

* Fix remaining tests

* fix rest of tests

* refactor(k8s-version): Move darling code into module

* refactor(stackable-versioned): Split utils into separate files

* chore(stackable-versioned): Cleanup, move and improve conversion code

* chore(stackable-versioned): Move K8s related error enums

* chore(stackable-versioned): Move code, add error handling

* chore(stackable-versioned): Remove roundtrip tests

These tests are removed for now, because we are not able
to roundtrip CRD conversions without data loss yet. This
feature will be re-added in a follow-up PR in an improved
form once loss-less roundtripping is supported.

* chore(crd-preview): Fix macro, add re-exports

* chore!(stackable-versioned): Remove unused merged_crd skip flag

* fix(stackable-versioned): Emit status field during conversion

* chore: Fix clippy lints

* test(stackable-versioned): Adjust snapshots

* chore: Add rust-analyzer setting

* chore: Allow RUSTSEC-2024-0436 advisory

* chore(stackable-versioned): Remove unused fixtures

* chore(stackable-versioned): Remove unused feature

* chore(stackable-versioned): Fix rustdoc

* chore: Remove unused dependencies

* chore(stackable-versioned): Move Otel attributes into constants

* docs(stackable-versioned): Adjust K8s doc comments

* test(stackable-versioned): Improve conversion_paths unit test

* chore(stackable-versioned): Update changelog

* chore: Apply suggestions

Co-authored-by: Nick <[email protected]>

* docs(stackable-versioned): Add doc comments

* chore: Apply suggestion

Co-authored-by: Nick <[email protected]>

---------

Co-authored-by: Techassi <[email protected]>
Co-authored-by: Nick <[email protected]>

Author: 3 people

.vscode/settings.json

@@ -1,5 +1,6 @@
 {
   "rust-analyzer.cargo.features": "all",
+  "rust-analyzer.imports.granularity.group": "crate",
   "rust-analyzer.rustfmt.overrideCommand": [
     "rustfmt",
     "+nightly-2025-05-26",

Cargo.lock

@@ -25,7 +25,8 @@ educe =  { version = "0.6.0", default-features = false, features = ["Clone", "De
 either = "1.13.0"
 futures = "0.3.30"
 futures-util = "0.3.30"
-indexmap = "2.5"
+indexmap = "2.5.0"
+indoc = "2.0.6"
 insta = { version= "1.40", features = ["glob"] }
 hyper = { version = "1.4.1", features = ["full"] }
 hyper-util = "0.1.8"
@@ -41,6 +42,7 @@ opentelemetry-appender-tracing = "0.29.1"
 opentelemetry-otlp = "0.29.0"
 # opentelemetry-semantic-conventions = "0.28.0"
 p256 = { version = "0.13.2", features = ["ecdsa"] }
+paste = "1.0.15"
 pin-project = "1.1.5"
 prettyplease = "0.2.22"
 proc-macro2 = "1.0.86"

Cargo.toml

@@ -0,0 +1,35 @@
+use std::str::FromStr;
+
+use darling::FromMeta;
+
+use crate::ApiVersion;
+
+impl FromMeta for ApiVersion {
+    fn from_string(value: &str) -> darling::Result<Self> {
+        Self::from_str(value).map_err(darling::Error::custom)
+    }
+}
+
+#[cfg(test)]
+mod test {
+    use quote::quote;
+    use rstest::rstest;
+
+    use super::*;
+    use crate::{Level, Version};
+
+    fn parse_meta(tokens: proc_macro2::TokenStream) -> ::std::result::Result<syn::Meta, String> {
+        let attribute: syn::Attribute = syn::parse_quote!(#[#tokens]);
+        Ok(attribute.meta)
+    }
+
+    #[rstest]
+    #[case(quote!(ignore = "extensions/v1beta1"), ApiVersion { group: Some("extensions".parse().unwrap()), version: Version { major: 1, level: Some(Level::Beta(1)) } })]
+    #[case(quote!(ignore = "v1beta1"), ApiVersion { group: None, version: Version { major: 1, level: Some(Level::Beta(1)) } })]
+    #[case(quote!(ignore = "v1"), ApiVersion { group: None, version: Version { major: 1, level: None } })]
+    fn from_meta(#[case] input: proc_macro2::TokenStream, #[case] expected: ApiVersion) {
+        let meta = parse_meta(input).expect("valid attribute tokens");
+        let api_version = ApiVersion::from_meta(&meta).expect("version must parse from attribute");
+        assert_eq!(api_version, expected);
+    }
+}

crates/k8s-version/src/api_version/darling.rs

@@ -1,14 +1,15 @@
 use std::{cmp::Ordering, fmt::Display, str::FromStr};
 
-#[cfg(feature = "darling")]
-use darling::FromMeta;
 use snafu::{ResultExt, Snafu};
 
 use crate::{Group, ParseGroupError, ParseVersionError, Version};
 
 #[cfg(feature = "serde")]
 mod serde;
 
+#[cfg(feature = "darling")]
+mod darling;
+
 /// Error variants which can be encountered when creating a new [`ApiVersion`]
 /// from unparsed input.
 #[derive(Debug, PartialEq, Snafu)]
@@ -45,13 +46,13 @@ impl FromStr for ApiVersion {
     fn from_str(input: &str) -> Result<Self, Self::Err> {
         let (group, version) = if let Some((group, version)) = input.split_once('/') {
             let group = Group::from_str(group).context(ParseGroupSnafu)?;
+            let version = Version::from_str(version).context(ParseVersionSnafu)?;
 
-            (
-                Some(group),
-                Version::from_str(version).context(ParseVersionSnafu)?,
-            )
+            (Some(group), version)
         } else {
-            (None, Version::from_str(input).context(ParseVersionSnafu)?)
+            let version = Version::from_str(input).context(ParseVersionSnafu)?;
+
+            (None, version)
         };
 
         Ok(Self { group, version })
@@ -77,13 +78,6 @@ impl Display for ApiVersion {
     }
 }
 
-#[cfg(feature = "darling")]
-impl FromMeta for ApiVersion {
-    fn from_string(value: &str) -> darling::Result<Self> {
-        Self::from_str(value).map_err(darling::Error::custom)
-    }
-}
-
 impl ApiVersion {
     /// Create a new Kubernetes API version.
     pub fn new(group: Option<Group>, version: Version) -> Self {
@@ -104,19 +98,11 @@ impl ApiVersion {
 
 #[cfg(test)]
 mod test {
-    #[cfg(feature = "darling")]
-    use quote::quote;
     use rstest::rstest;
 
     use super::*;
     use crate::Level;
 
-    #[cfg(feature = "darling")]
-    fn parse_meta(tokens: proc_macro2::TokenStream) -> ::std::result::Result<syn::Meta, String> {
-        let attribute: syn::Attribute = syn::parse_quote!(#[#tokens]);
-        Ok(attribute.meta)
-    }
-
     #[rstest]
     #[case("extensions/v1beta1", ApiVersion { group: Some("extensions".parse().unwrap()), version: Version { major: 1, level: Some(Level::Beta(1)) } })]
     #[case("v1beta1", ApiVersion { group: None, version: Version { major: 1, level: Some(Level::Beta(1)) } })]
@@ -145,15 +131,4 @@ mod test {
     fn partial_ord(#[case] input: Version, #[case] other: Version, #[case] expected: Ordering) {
         assert_eq!(input.partial_cmp(&other), Some(expected));
     }
-
-    #[cfg(feature = "darling")]
-    #[rstest]
-    #[case(quote!(ignore = "extensions/v1beta1"), ApiVersion { group: Some("extensions".parse().unwrap()), version: Version { major: 1, level: Some(Level::Beta(1)) } })]
-    #[case(quote!(ignore = "v1beta1"), ApiVersion { group: None, version: Version { major: 1, level: Some(Level::Beta(1)) } })]
-    #[case(quote!(ignore = "v1"), ApiVersion { group: None, version: Version { major: 1, level: None } })]
-    fn from_meta(#[case] input: proc_macro2::TokenStream, #[case] expected: ApiVersion) {
-        let meta = parse_meta(input).expect("valid attribute tokens");
-        let api_version = ApiVersion::from_meta(&meta).expect("version must parse from attribute");
-        assert_eq!(api_version, expected);
-    }
 }

crates/k8s-version/src/api_version/mod.rs

@@ -47,13 +47,13 @@ impl FromStr for Group {
         ensure!(group.len() <= MAX_GROUP_LENGTH, TooLongSnafu);
         ensure!(API_GROUP_REGEX.is_match(group), InvalidFormatSnafu);
 
-        Ok(Self(group.to_string()))
+        Ok(Self(group.to_owned()))
     }
 }
 
 impl fmt::Display for Group {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        write!(f, "{}", self.0)
+        f.write_str(self)
     }
 }
 

crates/k8s-version/src/group.rs

@@ -38,7 +38,7 @@
 //!     crates(
 //!         kube_core = "stackable_operator::kube::core",
 //!         k8s_openapi = "stackable_operator::k8s_openapi",
-//!         schemars = "stackable_operator::schemars"
+//!         schemars = "stackable_operator::schemars",
 //!     )
 //! )]
 //! #[serde(rename_all = "camelCase")]

crates/stackable-operator/src/commons/resources.rs

@@ -32,7 +32,7 @@ pub mod versioned {
         crates(
             kube_core = "kube::core",
             k8s_openapi = "k8s_openapi",
-            schemars = "schemars"
+            schemars = "schemars",
         )
     ))]
     #[derive(

crates/stackable-operator/src/crd/authentication/core/mod.rs

@@ -169,7 +169,7 @@ impl Default for FieldNames {
 #[cfg(test)]
 mod tests {
     use super::*;
-    use crate::commons::secret_class::SecretClassVolume;
+    use crate::{commons::secret_class::SecretClassVolume, utils::yaml_from_str_singleton_map};
 
     #[test]
     fn minimal() {
@@ -213,9 +213,7 @@ mod tests {
                   caCert:
                     secretClass: ldap-ca-cert
         "#;
-        let deserializer = serde_yaml::Deserializer::from_str(input);
-        let ldap: AuthenticationProvider =
-            serde_yaml::with::singleton_map_recursive::deserialize(deserializer).unwrap();
+        let ldap: AuthenticationProvider = yaml_from_str_singleton_map(input).unwrap();
 
         assert_eq!(ldap.port(), 42);
         assert!(ldap.tls.uses_tls());

crates/stackable-operator/src/crd/authentication/ldap/v1alpha1_impl.rs

@@ -365,7 +365,7 @@ mod tests {
     use super::*;
     use crate::{
         config::fragment::validate, product_config_utils::env_vars_from,
-        product_logging::spec::default_container_log_config,
+        product_logging::spec::default_container_log_config, utils::yaml_from_str_singleton_map,
     };
 
     #[test]
@@ -435,9 +435,7 @@ mod tests {
               --git-config: key:value,safe.directory:/safe-dir
           "#;
 
-        let deserializer = serde_yaml::Deserializer::from_str(git_sync_spec);
-        let git_syncs: Vec<GitSync> =
-            serde_yaml::with::singleton_map_recursive::deserialize(deserializer).unwrap();
+        let git_syncs: Vec<GitSync> = yaml_from_str_singleton_map(git_sync_spec).unwrap();
 
         let resolved_product_image = ResolvedProductImage {
             image: "oci.stackable.tech/sdp/product:latest".to_string(),

crates/stackable-operator/src/crd/git_sync/v1alpha1_impl.rs

@@ -13,8 +13,8 @@ mod class;
 mod core;
 mod listeners;
 
-pub use class::ListenerClass;
-pub use listeners::{Listener, PodListeners};
+pub use class::{ListenerClass, ListenerClassVersion};
+pub use listeners::{Listener, ListenerVersion, PodListeners, PodListenersVersion};
 
 // Group all v1alpha1 items in one module.
 pub mod v1alpha1 {

crates/stackable-operator/src/crd/listener/mod.rs

@@ -21,7 +21,7 @@ pub mod versioned {
         crates(
             kube_core = "kube::core",
             k8s_openapi = "k8s_openapi",
-            schemars = "schemars"
+            schemars = "schemars",
         ),
         namespaced
     ))]

crates/stackable-operator/src/crd/s3/bucket/mod.rs

@@ -31,7 +31,7 @@ pub mod versioned {
         crates(
             kube_core = "kube::core",
             k8s_openapi = "k8s_openapi",
-            schemars = "schemars"
+            schemars = "schemars",
         ),
         namespaced
     ))]

crates/stackable-operator/src/crd/s3/connection/mod.rs

@@ -1,8 +1,8 @@
 mod bucket;
 mod connection;
 
-pub use bucket::S3Bucket;
-pub use connection::S3Connection;
+pub use bucket::{S3Bucket, S3BucketVersion};
+pub use connection::{S3Connection, S3ConnectionVersion};
 
 // Group all v1alpha1 items in one module.
 pub mod v1alpha1 {

crates/stackable-operator/src/crd/s3/mod.rs

@@ -25,3 +25,11 @@ pub use self::{option::OptionExt, url::UrlExt};
 pub(crate) fn format_full_controller_name(operator: &str, controller: &str) -> String {
     format!("{operator}_{controller}")
 }
+
+pub fn yaml_from_str_singleton_map<'a, D>(input: &'a str) -> Result<D, serde_yaml::Error>
+where
+    D: serde::Deserialize<'a>,
+{
+    let deserializer = serde_yaml::Deserializer::from_str(input);
+    serde_yaml::with::singleton_map_recursive::deserialize(deserializer)
+}

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

@@ -33,6 +33,7 @@ k8s-version = { path = "../k8s-version", features = ["darling"] }
 
 convert_case.workspace = true
 darling.workspace = true
+indoc.workspace = true
 itertools.workspace = true
 k8s-openapi = { workspace = true, optional = true }
 kube = { workspace = true, optional = true }
@@ -53,4 +54,5 @@ serde.workspace = true
 serde_json.workspace = true
 serde_yaml.workspace = true
 snafu.workspace = true
+tracing.workspace = true
 trybuild.workspace = true

crates/stackable-versioned-macros/Cargo.toml

@@ -47,25 +47,10 @@ pub struct KubernetesArguments {
     // doc
     // annotation
     // label
-    pub skip: Option<KubernetesSkipArguments>,
-
     #[darling(default)]
     pub options: KubernetesConfigOptions,
 }
 
-/// This struct contains supported kubernetes skip arguments.
-///
-/// Supported arguments are:
-///
-/// - `merged_crd` flag, which skips generating the `crd()` and `merged_crd()` functions are
-///    generated.
-#[derive(Clone, Debug, FromMeta)]
-pub struct KubernetesSkipArguments {
-    /// Whether the `crd()` and `merged_crd()` generation should be skipped for
-    /// this container.
-    pub merged_crd: Flag,
-}
-
 /// This struct contains crate overrides to be passed to `#[kube]`.
 #[derive(Clone, Debug, FromMeta)]
 pub struct KubernetesCrateArguments {
@@ -176,4 +161,5 @@ impl ToTokens for KubernetesCrateArguments {
 #[derive(Clone, Default, Debug, FromMeta)]
 pub struct KubernetesConfigOptions {
     pub experimental_conversion_tracking: Flag,
+    pub enable_tracing: Flag,
 }