chore: Use safe types already in the CRD

Author: siegfriedweber

Cargo.toml

@@ -16,7 +16,7 @@ built = { version = "0.8.0", features = ["chrono", "git2"] }
 clap = "4.5"
 futures = { version = "0.3", features = ["compat"] }
 pretty_assertions = "1.4"
-regex = "1.11.3"
+regex = "1.11"
 rstest = "0.26"
 schemars = { version = "1.0.0", features = ["url2"] } # same as in operator-rs
 serde = { version = "1.0", features = ["derive"] }

deploy/helm/opensearch-operator/crds/crds.yaml

@@ -38,6 +38,8 @@ spec:
                         It must contain the key `ADDRESS` with the address of the Vector aggregator.
                         Follow the [logging tutorial](https://docs.stackable.tech/home/nightly/tutorials/logging-vector-aggregator)
                         to learn how to configure log aggregation with Vector.
+                      maxLength: 253
+                      minLength: 1
                       nullable: true
                       type: string
                   type: object
@@ -183,6 +185,8 @@ spec:
                           type: string
                         listenerClass:
                           description: This field controls which [ListenerClass](https://docs.stackable.tech/home/nightly/listener-operator/listenerclass.html) is used to expose the HTTP communication.
+                          maxLength: 253
+                          minLength: 1
                           nullable: true
                           type: string
                         logging:
@@ -526,6 +530,8 @@ spec:
                                 type: string
                               listenerClass:
                                 description: This field controls which [ListenerClass](https://docs.stackable.tech/home/nightly/listener-operator/listenerclass.html) is used to expose the HTTP communication.
+                                maxLength: 253
+                                minLength: 1
                                 nullable: true
                                 type: string
                               logging:

rust/operator-binary/src/controller.rs

@@ -33,8 +33,8 @@ use crate::{
         v1alpha1::{self},
     },
     framework::{
-        ClusterName, ControllerName, HasName, HasUid, NameIsValidLabelValue, NamespaceName,
-        OperatorName, ProductName, ProductVersion, RoleGroupName, RoleName, Uid,
+        ClusterName, ControllerName, HasName, HasUid, ListenerClassName, NameIsValidLabelValue,
+        NamespaceName, OperatorName, ProductName, ProductVersion, RoleGroupName, RoleName, Uid,
         product_logging::framework::{ValidatedContainerLogConfigChoice, VectorContainerLogConfig},
         role_utils::{GenericProductSpecificCommonConfig, RoleGroupConfig},
     },
@@ -128,7 +128,7 @@ type OpenSearchNodeResources =
 #[derive(Clone, Debug, PartialEq)]
 pub struct ValidatedOpenSearchConfig {
     pub affinity: StackableAffinity,
-    pub listener_class: String,
+    pub listener_class: ListenerClassName,
     pub logging: ValidatedLogging,
     pub node_roles: NodeRoles,
     pub resources: OpenSearchNodeResources,
@@ -379,8 +379,8 @@ mod tests {
         controller::{OpenSearchNodeResources, ValidatedOpenSearchConfig},
         crd::{NodeRoles, v1alpha1},
         framework::{
-            ClusterName, NamespaceName, OperatorName, ProductVersion, RoleGroupName,
-            builder::pod::container::EnvVarSet,
+            ClusterName, ListenerClassName, NamespaceName, OperatorName, ProductVersion,
+            RoleGroupName, builder::pod::container::EnvVarSet,
             product_logging::framework::ValidatedContainerLogConfigChoice,
             role_utils::GenericProductSpecificCommonConfig,
         },
@@ -504,7 +504,7 @@ mod tests {
             replicas,
             config: ValidatedOpenSearchConfig {
                 affinity: StackableAffinity::default(),
-                listener_class: "external-stable".to_owned(),
+                listener_class: ListenerClassName::from_str_unsafe("external-stable"),
                 logging: ValidatedLogging {
                     opensearch_container: ValidatedContainerLogConfigChoice::Automatic(
                         AutomaticContainerLogConfig::default(),

rust/operator-binary/src/controller/build.rs

@@ -79,8 +79,8 @@ mod tests {
         },
         crd::{NodeRoles, v1alpha1},
         framework::{
-            ClusterName, ControllerName, NamespaceName, OperatorName, ProductName, ProductVersion,
-            RoleGroupName, builder::pod::container::EnvVarSet,
+            ClusterName, ControllerName, ListenerClassName, NamespaceName, OperatorName,
+            ProductName, ProductVersion, RoleGroupName, builder::pod::container::EnvVarSet,
             role_utils::GenericProductSpecificCommonConfig,
         },
     };
@@ -202,7 +202,7 @@ mod tests {
             replicas,
             config: ValidatedOpenSearchConfig {
                 affinity: StackableAffinity::default(),
-                listener_class: "external-stable".to_owned(),
+                listener_class: ListenerClassName::from_str_unsafe("external-stable"),
                 logging: ValidatedLogging {
                     opensearch_container: ValidatedContainerLogConfigChoice::Automatic(
                         AutomaticContainerLogConfig::default(),

rust/operator-binary/src/controller/build/node_config.rs

@@ -285,7 +285,7 @@ mod tests {
         controller::{ValidatedLogging, ValidatedOpenSearchConfig},
         crd::NodeRoles,
         framework::{
-            ClusterName, NamespaceName, ProductVersion, RoleGroupName,
+            ClusterName, ListenerClassName, NamespaceName, ProductVersion, RoleGroupName,
             product_logging::framework::ValidatedContainerLogConfigChoice,
             role_utils::GenericProductSpecificCommonConfig,
         },
@@ -315,7 +315,7 @@ mod tests {
             replicas: test_config.replicas,
             config: ValidatedOpenSearchConfig {
                 affinity: StackableAffinity::default(),
-                listener_class: "cluster-internal".to_string(),
+                listener_class: ListenerClassName::from_str_unsafe("cluster-internal"),
                 logging: ValidatedLogging {
                     opensearch_container: ValidatedContainerLogConfigChoice::Automatic(
                         AutomaticContainerLogConfig::default(),

rust/operator-binary/src/controller/build/role_builder.rs

@@ -241,8 +241,8 @@ mod tests {
         },
         crd::{NodeRoles, v1alpha1},
         framework::{
-            ClusterName, ControllerName, NamespaceName, OperatorName, ProductName, ProductVersion,
-            RoleGroupName, builder::pod::container::EnvVarSet,
+            ClusterName, ControllerName, ListenerClassName, NamespaceName, OperatorName,
+            ProductName, ProductVersion, RoleGroupName, builder::pod::container::EnvVarSet,
             role_utils::GenericProductSpecificCommonConfig,
         },
     };
@@ -263,7 +263,7 @@ mod tests {
             replicas: 1,
             config: ValidatedOpenSearchConfig {
                 affinity: StackableAffinity::default(),
-                listener_class: "cluster-internal".to_string(),
+                listener_class: ListenerClassName::from_str_unsafe("cluster-internal"),
                 logging: ValidatedLogging {
                     opensearch_container: ValidatedContainerLogConfigChoice::Automatic(
                         AutomaticContainerLogConfig::default(),

rust/operator-binary/src/controller/build/role_group_builder.rs

@@ -569,7 +569,7 @@ impl<'a> RoleGroupBuilder<'a> {
         listener::v1alpha1::Listener {
             metadata,
             spec: listener::v1alpha1::ListenerSpec {
-                class_name: Some(listener_class),
+                class_name: Some(listener_class.to_string()),
                 ports: Some(ports.to_vec()),
                 ..listener::v1alpha1::ListenerSpec::default()
             },
@@ -653,9 +653,9 @@ mod tests {
         },
         crd::{NodeRoles, v1alpha1},
         framework::{
-            ClusterName, ConfigMapName, ControllerName, NamespaceName, OperatorName, ProductName,
-            ProductVersion, RoleGroupName, ServiceAccountName, ServiceName,
-            builder::pod::container::EnvVarSet,
+            ClusterName, ConfigMapName, ControllerName, ListenerClassName, NamespaceName,
+            OperatorName, ProductName, ProductVersion, RoleGroupName, ServiceAccountName,
+            ServiceName, builder::pod::container::EnvVarSet,
             product_logging::framework::VectorContainerLogConfig,
             role_utils::GenericProductSpecificCommonConfig,
         },
@@ -693,7 +693,7 @@ mod tests {
             replicas: 1,
             config: ValidatedOpenSearchConfig {
                 affinity: StackableAffinity::default(),
-                listener_class: "cluster-internal".to_string(),
+                listener_class: ListenerClassName::from_str_unsafe("cluster-internal"),
                 logging: ValidatedLogging {
                     opensearch_container: ValidatedContainerLogConfigChoice::Automatic(
                         AutomaticContainerLogConfig::default(),

rust/operator-binary/src/controller/validate.rs

@@ -64,9 +64,6 @@ pub enum Error {
     #[snafu(display("failed to set role-group name"))]
     ParseRoleGroupName { source: crate::framework::Error },
 
-    #[snafu(display("failed to set vectorAggregatorConfigMapName"))]
-    ParseVectorAggregatorConfigMapName { source: crate::framework::Error },
-
     #[snafu(display("failed to resolve product image"))]
     ResolveProductImage {
         source: stackable_operator::commons::product_image_selection::Error,
@@ -166,22 +163,12 @@ fn validate_role_group_config(
     )
     .context(ValidateOpenSearchConfigSnafu)?;
 
-    let vector_aggregator_config_map_name = if let Some(config_map_name) = &cluster
-        .spec
-        .cluster_config
-        .vector_aggregator_config_map_name
-    {
-        Some(
-            ConfigMapName::from_str(config_map_name)
-                .context(ParseVectorAggregatorConfigMapNameSnafu)?,
-        )
-    } else {
-        None
-    };
-
     let logging = validate_logging_configuration(
         &merged_role_group.config.config.logging,
-        vector_aggregator_config_map_name,
+        &cluster
+            .spec
+            .cluster_config
+            .vector_aggregator_config_map_name,
     )?;
 
     let graceful_shutdown_timeout = merged_role_group.config.config.graceful_shutdown_timeout;
@@ -223,15 +210,16 @@ fn validate_role_group_config(
 
 fn validate_logging_configuration(
     logging: &Logging<v1alpha1::Container>,
-    vector_aggregator_config_map_name: Option<ConfigMapName>,
+    vector_aggregator_config_map_name: &Option<ConfigMapName>,
 ) -> Result<ValidatedLogging> {
     let opensearch_container =
         validate_logging_configuration_for_container(logging, v1alpha1::Container::OpenSearch)
             .context(ValidateLoggingConfigSnafu)?;
 
     let vector_container = if logging.enable_vector_agent {
-        let vector_aggregator_config_map_name =
-            vector_aggregator_config_map_name.context(GetVectorAggregatorConfigMapNameSnafu)?;
+        let vector_aggregator_config_map_name = vector_aggregator_config_map_name
+            .clone()
+            .context(GetVectorAggregatorConfigMapNameSnafu)?;
         Some(VectorContainerLogConfig {
             log_config: validate_logging_configuration_for_container(
                 logging,
@@ -288,8 +276,8 @@ mod tests {
             v1alpha1::{self},
         },
         framework::{
-            ClusterName, ConfigMapName, ControllerName, NamespaceName, OperatorName, ProductName,
-            ProductVersion, RoleGroupName,
+            ClusterName, ConfigMapName, ControllerName, ListenerClassName, NamespaceName,
+            OperatorName, ProductName, ProductVersion, RoleGroupName,
             builder::pod::container::{EnvVarName, EnvVarSet},
             product_logging::framework::{
                 ValidatedContainerLogConfigChoice, VectorContainerLogConfig,
@@ -360,7 +348,9 @@ mod tests {
                                 }),
                                 ..StackableAffinity::default()
                             },
-                            listener_class: "listener-class-from-role-group-level".to_owned(),
+                            listener_class: ListenerClassName::from_str_unsafe(
+                                "listener-class-from-role-group-level"
+                            ),
                             logging: ValidatedLogging {
                                 opensearch_container: ValidatedContainerLogConfigChoice::Automatic(
                                     AutomaticContainerLogConfig {
@@ -580,19 +570,6 @@ mod tests {
         );
     }
 
-    #[test]
-    fn test_validate_err_parse_vector_aggregator_config_map_name() {
-        test_validate_err(
-            |cluster| {
-                cluster
-                    .spec
-                    .cluster_config
-                    .vector_aggregator_config_map_name = Some("invalid ConfigMap name".to_owned())
-            },
-            ErrorDiscriminants::ParseVectorAggregatorConfigMapName,
-        );
-    }
-
     #[test]
     fn test_validate_err_validate_logging_config() {
         test_validate_err(
@@ -685,14 +662,18 @@ mod tests {
                 image: serde_json::from_str(r#"{"productVersion": "3.1.0"}"#)
                     .expect("should be a valid ProductImage structure"),
                 cluster_config: v1alpha1::OpenSearchClusterConfig {
-                    vector_aggregator_config_map_name: Some("vector-aggregator".to_owned()),
+                    vector_aggregator_config_map_name: Some(ConfigMapName::from_str_unsafe(
+                        "vector-aggregator",
+                    )),
                 },
                 cluster_operation: ClusterOperation::default(),
                 nodes: Role {
                     config: CommonConfiguration {
                         config: v1alpha1::OpenSearchConfigFragment {
                             graceful_shutdown_timeout: Some(Duration::from_minutes_unchecked(5)),
-                            listener_class: Some("listener-class-from-role-level".to_owned()),
+                            listener_class: Some(ListenerClassName::from_str_unsafe(
+                                "listener-class-from-role-level",
+                            )),
                             logging: LoggingFragment {
                                 enable_vector_agent: Some(true),
                                 containers: BTreeMap::default(),
@@ -740,9 +721,9 @@ mod tests {
                         RoleGroup {
                             config: CommonConfiguration {
                                 config: v1alpha1::OpenSearchConfigFragment {
-                                    listener_class: Some(
-                                        "listener-class-from-role-group-level".to_owned(),
-                                    ),
+                                    listener_class: Some(ListenerClassName::from_str_unsafe(
+                                        "listener-class-from-role-group-level",
+                                    )),
                                     ..v1alpha1::OpenSearchConfigFragment::default()
                                 },
                                 config_overrides: [(

rust/operator-binary/src/crd/mod.rs

@@ -26,12 +26,15 @@ use stackable_operator::{
 };
 use strum::{Display, EnumIter};
 
-use crate::framework::{
-    ClusterName, ContainerName, NameIsValidLabelValue, ProductName, RoleName,
-    role_utils::GenericProductSpecificCommonConfig,
+use crate::{
+    constant,
+    framework::{
+        ClusterName, ConfigMapName, ContainerName, ListenerClassName, NameIsValidLabelValue,
+        ProductName, RoleName, role_utils::GenericProductSpecificCommonConfig,
+    },
 };
 
-const DEFAULT_LISTENER_CLASS: &str = "cluster-internal";
+constant!(DEFAULT_LISTENER_CLASS: ListenerClassName = "cluster-internal");
 
 #[versioned(
     version(name = "v1alpha1"),
@@ -82,7 +85,7 @@ pub mod versioned {
         /// Follow the [logging tutorial](DOCS_BASE_URL_PLACEHOLDER/tutorials/logging-vector-aggregator)
         /// to learn how to configure log aggregation with Vector.
         #[serde(skip_serializing_if = "Option::is_none")]
-        pub vector_aggregator_config_map_name: Option<String>,
+        pub vector_aggregator_config_map_name: Option<ConfigMapName>,
     }
 
     // The possible node roles are by default the built-in roles and the search role, see
@@ -151,7 +154,7 @@ pub mod versioned {
 
         /// This field controls which [ListenerClass](https://docs.stackable.tech/home/nightly/listener-operator/listenerclass.html) is used to expose the HTTP communication.
         #[fragment_attrs(serde(default))]
-        pub listener_class: String,
+        pub listener_class: ListenerClassName,
 
         #[fragment_attrs(serde(default))]
         pub logging: Logging<Container>,
@@ -257,7 +260,7 @@ impl v1alpha1::OpenSearchConfig {
             ),
             // Defaults taken from the Helm chart, see
             // https://github.com/opensearch-project/helm-charts/blob/opensearch-3.0.0/charts/opensearch/values.yaml#L16-L20
-            listener_class: Some(DEFAULT_LISTENER_CLASS.to_string()),
+            listener_class: Some(DEFAULT_LISTENER_CLASS.to_owned()),
             logging: product_logging::spec::default_logging(),
             node_roles: Some(NodeRoles(vec![
                 v1alpha1::NodeRole::ClusterManager,