refactor: add ValidatedCluster::object_meta helper for child resource metadata

Author: maltesander

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

@@ -4,14 +4,9 @@ use std::collections::BTreeMap;
 
 use snafu::{OptionExt, ResultExt, Snafu};
 use stackable_operator::{
-    builder::{configmap::ConfigMapBuilder, meta::ObjectMetaBuilder},
-    k8s_openapi::api::core::v1::ConfigMap,
-    kvp::Labels,
-    product_logging::framework::VECTOR_CONFIG_FILE,
-    utils::cluster_info::KubernetesClusterInfo,
-    v2::{
-        builder::meta::ownerreference_from_resource, config_file_writer::to_java_properties_string,
-    },
+    builder::configmap::ConfigMapBuilder, k8s_openapi::api::core::v1::ConfigMap, kvp::Labels,
+    product_logging::framework::VECTOR_CONFIG_FILE, utils::cluster_info::KubernetesClusterInfo,
+    v2::config_file_writer::to_java_properties_string,
 };
 
 use crate::{
@@ -188,11 +183,8 @@ pub fn build_rolegroup_config_map(
 
     ConfigMapBuilder::new()
         .metadata(
-            ObjectMetaBuilder::new()
-                .name(&config_map_name)
-                .namespace(cluster.namespace.to_string())
-                .ownerreference(ownerreference_from_resource(cluster, None, Some(true)))
-                .with_labels(recommended_labels.clone())
+            cluster
+                .object_meta(&config_map_name, recommended_labels.clone())
                 .build(),
         )
         .data(data)
@@ -218,11 +210,8 @@ pub fn build_rolegroup_catalog_config_map(
     );
     ConfigMapBuilder::new()
         .metadata(
-            ObjectMetaBuilder::new()
-                .name(&catalog_config_map_name)
-                .namespace(cluster.namespace.to_string())
-                .ownerreference(ownerreference_from_resource(cluster, None, Some(true)))
-                .with_labels(recommended_labels.clone())
+            cluster
+                .object_meta(&catalog_config_map_name, recommended_labels.clone())
                 .build(),
         )
         .data(

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

@@ -1,13 +1,9 @@
 use snafu::{ResultExt, Snafu};
 use stackable_operator::{
-    builder::{
-        meta::ObjectMetaBuilder,
-        pod::volume::{ListenerOperatorVolumeSourceBuilder, ListenerReference},
-    },
+    builder::pod::volume::{ListenerOperatorVolumeSourceBuilder, ListenerReference},
     crd::listener::v1alpha1::{Listener, ListenerPort, ListenerSpec},
     k8s_openapi::api::core::v1::PersistentVolumeClaim,
     kvp::Labels,
-    v2::builder::meta::ownerreference_from_resource,
 };
 
 use crate::{controller::ValidatedCluster, crd::TrinoRole};
@@ -30,11 +26,8 @@ pub fn build_group_listener(
     listener_group_name: String,
 ) -> Listener {
     Listener {
-        metadata: ObjectMetaBuilder::new()
-            .name_and_namespace(cluster)
-            .name(listener_group_name)
-            .ownerreference(ownerreference_from_resource(cluster, None, Some(true)))
-            .with_labels(recommended_labels)
+        metadata: cluster
+            .object_meta(listener_group_name, recommended_labels)
             .build(),
         spec: ListenerSpec {
             class_name: Some(listener_class),

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

@@ -1,10 +1,8 @@
 use std::collections::BTreeMap;
 
 use stackable_operator::{
-    builder::meta::ObjectMetaBuilder,
     k8s_openapi::api::core::v1::{Service, ServicePort, ServiceSpec},
     kvp::{Annotations, Labels},
-    v2::builder::meta::ownerreference_from_resource,
 };
 
 use crate::{
@@ -23,16 +21,14 @@ pub fn build_rolegroup_headless_service(
     ports: Vec<ServicePort>,
 ) -> Service {
     Service {
-        metadata: ObjectMetaBuilder::new()
-            .name_and_namespace(cluster)
-            .name(
+        metadata: cluster
+            .object_meta(
                 cluster
                     .resource_names(role, role_group_name)
                     .headless_service_name()
                     .to_string(),
+                recommended_labels.clone(),
             )
-            .ownerreference(ownerreference_from_resource(cluster, None, Some(true)))
-            .with_labels(recommended_labels.clone())
             .build(),
         spec: Some(ServiceSpec {
             // Internal communication does not need to be exposed
@@ -56,16 +52,14 @@ pub fn build_rolegroup_metrics_service(
     selector: BTreeMap<String, String>,
 ) -> Service {
     Service {
-        metadata: ObjectMetaBuilder::new()
-            .name_and_namespace(cluster)
-            .name(
+        metadata: cluster
+            .object_meta(
                 cluster
                     .resource_names(role, role_group_name)
                     .metrics_service_name()
                     .to_string(),
+                recommended_labels.clone(),
             )
-            .ownerreference(ownerreference_from_resource(cluster, None, Some(true)))
-            .with_labels(recommended_labels.clone())
             .with_labels(prometheus_labels())
             .with_annotations(prometheus_annotations())
             .build(),

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

@@ -31,10 +31,7 @@ use stackable_operator::{
     product_logging,
     shared::time::Duration,
     v2::{
-        builder::{
-            meta::ownerreference_from_resource, pod::container::EnvVarSet,
-            statefulset::restarter_ignore_secret_annotations,
-        },
+        builder::{pod::container::EnvVarSet, statefulset::restarter_ignore_secret_annotations},
         product_logging::framework::{ValidatedContainerLogConfigChoice, vector_container},
         types::kubernetes::{ContainerName, VolumeName},
     },
@@ -438,11 +435,11 @@ pub fn build_rolegroup_statefulset(
     );
 
     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(cluster.recommended_labels(trino_role, role_group_name))
+        metadata: cluster
+            .object_meta(
+                resource_names.stateful_set_name().to_string(),
+                cluster.recommended_labels(trino_role, role_group_name),
+            )
             .with_label(RESTART_CONTROLLER_ENABLED_LABEL.to_owned())
             .with_annotations(annotations)
             .build(),

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

@@ -4,6 +4,7 @@
 use std::{collections::BTreeMap, str::FromStr};
 
 use stackable_operator::{
+    builder::meta::ObjectMetaBuilder,
     commons::{
         affinity::StackableAffinity,
         product_image_selection::ResolvedProductImage,
@@ -14,6 +15,7 @@ use stackable_operator::{
     shared::time::Duration,
     v2::{
         HasName, HasUid, NameIsValidLabelValue,
+        builder::meta::ownerreference_from_resource,
         kvp::label::{recommended_labels, role_group_selector},
         role_group_utils::ResourceNames,
         types::{
@@ -216,6 +218,25 @@ impl ValidatedCluster {
         }
     }
 
+    /// Returns an [`ObjectMetaBuilder`] pre-filled with this cluster's namespace, an owner
+    /// reference back to the cluster, the resource `name` and the given `recommended_labels`.
+    ///
+    /// Consolidates the metadata chain repeated by the child-resource builders. Call sites that
+    /// need extra labels/annotations chain them onto the returned builder.
+    pub(crate) fn object_meta(
+        &self,
+        name: impl Into<String>,
+        recommended_labels: Labels,
+    ) -> ObjectMetaBuilder {
+        let mut builder = ObjectMetaBuilder::new();
+        builder
+            .name_and_namespace(self)
+            .name(name)
+            .ownerreference(ownerreference_from_resource(self, None, Some(true)))
+            .with_labels(recommended_labels);
+        builder
+    }
+
     /// A [`TrinoRole`] as a type-safe [`RoleName`].
     fn role_name(role: &TrinoRole) -> RoleName {
         RoleName::from_str(&role.to_string()).expect("a TrinoRole is a valid RFC 1123 role name")