refactor: add objectmeta helper & PLACEHOLDER_LISTENER_ROLE_GROUP

Author: maltesander

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

@@ -2,7 +2,10 @@
 //!
 //! [`ValidatedCluster`]: crate::controller::ValidatedCluster
 
+use std::str::FromStr;
+
 use snafu::Snafu;
+use stackable_operator::v2::types::operator::RoleGroupName;
 
 use crate::{crd::storage::NifiRepository, security::oidc};
 
@@ -14,6 +17,10 @@ pub mod properties;
 pub mod proxy_hosts;
 pub mod resource;
 
+// Placeholder role-group name for role-level resources (e.g. the per-role `Listener`), which have
+// no associated role group. Preserves the historical `app.kubernetes.io/role-group: none` label.
+stackable_operator::constant!(pub(crate) PLACEHOLDER_LISTENER_ROLE_GROUP: RoleGroupName = "none");
+
 /// Errors that can occur while building the NiFi product configuration files.
 #[derive(Snafu, Debug)]
 #[snafu(visibility(pub(crate)))]

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

@@ -2,11 +2,9 @@
 
 use snafu::{ResultExt, Snafu};
 use stackable_operator::{
-    builder::{configmap::ConfigMapBuilder, meta::ObjectMetaBuilder},
-    k8s_openapi::api::core::v1::ConfigMap,
-    product_logging::framework::VECTOR_CONFIG_FILE,
-    utils::cluster_info::KubernetesClusterInfo,
-    v2::{builder::meta::ownerreference_from_resource, types::operator::RoleGroupName},
+    builder::configmap::ConfigMapBuilder, k8s_openapi::api::core::v1::ConfigMap,
+    product_logging::framework::VECTOR_CONFIG_FILE, utils::cluster_info::KubernetesClusterInfo,
+    v2::types::operator::RoleGroupName,
 };
 
 use crate::controller::{
@@ -72,16 +70,14 @@ pub fn build_rolegroup_config_map(
 
     cm_builder
         .metadata(
-            ObjectMetaBuilder::new()
-                .name_and_namespace(cluster)
-                .name(
+            cluster
+                .object_meta(
                     cluster
                         .resource_names(&rg.name)
                         .role_group_config_map()
                         .to_string(),
+                    &rg.name,
                 )
-                .ownerreference(ownerreference_from_resource(cluster, None, Some(true)))
-                .with_labels(cluster.recommended_labels(&rg.name))
                 .build(),
         )
         .add_data(

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

@@ -1,21 +1,19 @@
 use std::str::FromStr;
 
 use stackable_operator::{
-    builder::meta::ObjectMetaBuilder,
     crd::listener::v1alpha1::{Listener, ListenerPort, ListenerSpec},
     k8s_openapi::api::core::v1::PersistentVolumeClaim,
     kvp::Labels,
     v2::{
-        builder::{
-            meta::ownerreference_from_resource,
-            pod::volume::{ListenerReference, listener_operator_volume_source_builder_build_pvc},
+        builder::pod::volume::{
+            ListenerReference, listener_operator_volume_source_builder_build_pvc,
         },
         types::kubernetes::{ListenerClassName, ListenerName, PersistentVolumeClaimName},
     },
 };
 
 use crate::{
-    controller::ValidatedCluster,
+    controller::{ValidatedCluster, build::PLACEHOLDER_LISTENER_ROLE_GROUP},
     crd::{HTTPS_PORT, HTTPS_PORT_NAME},
 };
 
@@ -28,11 +26,11 @@ pub fn build_group_listener(
     listener_group_name: ListenerName,
 ) -> Listener {
     Listener {
-        metadata: ObjectMetaBuilder::new()
-            .name_and_namespace(cluster)
-            .name(listener_group_name.to_string())
-            .ownerreference(ownerreference_from_resource(cluster, None, Some(true)))
-            .with_labels(cluster.recommended_labels_role_level())
+        metadata: cluster
+            .object_meta(
+                listener_group_name.to_string(),
+                &PLACEHOLDER_LISTENER_ROLE_GROUP,
+            )
             .build(),
         spec: ListenerSpec {
             class_name: Some(listener_class.to_string()),

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

@@ -192,11 +192,11 @@ fn build_reporting_task_service(cluster: &ValidatedCluster) -> Result<Service> {
     );
 
     Ok(Service {
-        metadata: ObjectMetaBuilder::new()
-            .name_and_namespace(cluster)
-            .name(build_reporting_task_service_name(&nifi_cluster_name))
-            .ownerreference(ownerreference_from_resource(cluster, None, Some(true)))
-            .with_labels(cluster.recommended_labels(&reporting_task_role_group()))
+        metadata: cluster
+            .object_meta(
+                build_reporting_task_service_name(&nifi_cluster_name),
+                &reporting_task_role_group(),
+            )
             .build(),
         spec: Some(ServiceSpec {
             ports: Some(vec![ServicePort {
@@ -327,11 +327,8 @@ fn build_reporting_task_job(
     pod_template.merge_from(cluster.cluster_config.reporting_task_pod_overrides.clone());
 
     let job = Job {
-        metadata: ObjectMetaBuilder::new()
-            .name_and_namespace(cluster)
-            .name(job_name)
-            .ownerreference(ownerreference_from_resource(cluster, None, Some(true)))
-            .with_labels(cluster.recommended_labels(&reporting_task_role_group()))
+        metadata: cluster
+            .object_meta(job_name, &reporting_task_role_group())
             .build(),
         spec: Some(JobSpec {
             backoff_limit: Some(100),

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

@@ -1,8 +1,7 @@
 use stackable_operator::{
-    builder::meta::ObjectMetaBuilder,
     k8s_openapi::api::core::v1::{Service, ServicePort, ServiceSpec},
     kvp::{Annotations, Labels},
-    v2::{builder::meta::ownerreference_from_resource, types::operator::RoleGroupName},
+    v2::types::operator::RoleGroupName,
 };
 
 use crate::{
@@ -17,16 +16,14 @@ pub fn build_rolegroup_headless_service(
     role_group_name: &RoleGroupName,
 ) -> Service {
     Service {
-        metadata: ObjectMetaBuilder::new()
-            .name_and_namespace(cluster)
-            .name(
+        metadata: cluster
+            .object_meta(
                 cluster
                     .resource_names(role_group_name)
                     .headless_service_name()
                     .to_string(),
+                role_group_name,
             )
-            .ownerreference(ownerreference_from_resource(cluster, None, Some(true)))
-            .with_labels(cluster.recommended_labels(role_group_name))
             .build(),
         spec: Some(ServiceSpec {
             // Internal communication does not need to be exposed
@@ -48,16 +45,14 @@ pub fn build_rolegroup_metrics_service(
 ) -> Service {
     let product_version = &cluster.image.product_version;
     Service {
-        metadata: ObjectMetaBuilder::new()
-            .name_and_namespace(cluster)
-            .name(
+        metadata: cluster
+            .object_meta(
                 cluster
                     .resource_names(role_group_name)
                     .metrics_service_name()
                     .to_string(),
+                role_group_name,
             )
-            .ownerreference(ownerreference_from_resource(cluster, None, Some(true)))
-            .with_labels(cluster.recommended_labels(role_group_name))
             .with_labels(prometheus_labels())
             .with_annotations(prometheus_annotations(product_version))
             .build(),

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

@@ -38,10 +38,7 @@ use stackable_operator::{
     },
     utils::{COMMON_BASH_TRAP_FUNCTIONS, cluster_info::KubernetesClusterInfo},
     v2::{
-        builder::{
-            meta::ownerreference_from_resource,
-            pod::container::{EnvVarSet, new_container_builder},
-        },
+        builder::pod::container::{EnvVarSet, new_container_builder},
         product_logging::framework::{STACKABLE_LOG_DIR, vector_container},
         types::kubernetes::{ContainerName, VolumeName},
     },
@@ -556,7 +553,7 @@ pub(crate) async fn build_node_rolegroup_statefulset(
         .context(AddAuthVolumesSnafu)?;
 
     let metadata = ObjectMetaBuilder::new()
-        .with_labels(recommended_object_labels.clone())
+        .with_labels(recommended_object_labels)
         .build();
 
     let requested_secret_lifetime = merged_config
@@ -655,11 +652,8 @@ pub(crate) async fn build_node_rolegroup_statefulset(
     pod_template.merge_from(rg.pod_overrides.clone());
 
     Ok(StatefulSet {
-        metadata: ObjectMetaBuilder::new()
-            .name_and_namespace(cluster)
-            .name(resource_names.stateful_set_name().to_string())
-            .ownerreference(ownerreference_from_resource(cluster, None, Some(true)))
-            .with_labels(recommended_object_labels)
+        metadata: cluster
+            .object_meta(resource_names.stateful_set_name().to_string(), &rg.name)
             .with_label(RESTART_CONTROLLER_ENABLED_LABEL.to_owned())
             .build(),
         spec: Some(StatefulSetSpec {

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

@@ -231,13 +231,33 @@ impl ValidatedCluster {
         role_selector(self, &product_name(), &Self::role_name())
     }
 
-    /// Recommended labels for a role-level resource (the per-role [`Listener`]), which has no
-    /// associated role group. Uses the placeholder role-group `none`, preserving the historical
+    /// Returns an [`ObjectMetaBuilder`](stackable_operator::builder::meta::ObjectMetaBuilder)
+    /// pre-filled with the namespace, an owner reference back to this cluster, and the recommended
+    /// labels for a resource named `name` in `role_group_name`.
+    ///
+    /// Consolidates the metadata chain repeated by the child-resource builders. Call sites that
+    /// need extra labels/annotations chain them onto the returned builder. Role-level resources
+    /// (e.g. the per-role [`Listener`](stackable_operator::crd::listener::v1alpha1::Listener)) pass
+    /// the placeholder role-group `none`, preserving the historical
     /// `app.kubernetes.io/role-group: none` label.
-    pub fn recommended_labels_role_level(&self) -> Labels {
-        let role_group =
-            RoleGroupName::from_str("none").expect("'none' is a valid role-group name");
-        self.recommended_labels(&role_group)
+    pub(crate) fn object_meta(
+        &self,
+        name: impl Into<String>,
+        role_group_name: &RoleGroupName,
+    ) -> stackable_operator::builder::meta::ObjectMetaBuilder {
+        let mut builder = stackable_operator::builder::meta::ObjectMetaBuilder::new();
+        builder
+            .name_and_namespace(self)
+            .name(name)
+            .ownerreference(
+                stackable_operator::v2::builder::meta::ownerreference_from_resource(
+                    self,
+                    None,
+                    Some(true),
+                ),
+            )
+            .with_labels(self.recommended_labels(role_group_name));
+        builder
     }
 }