rename resource names functions

Author: adwk67

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

@@ -27,7 +27,7 @@ stackable_operator::constant!(pub(crate) PLACEHOLDER_DISCOVERY_ROLE_GROUP: RoleG
 
 // Placeholder role-group name used for the recommended labels of the role-level `Listener`
 // (which is not tied to a single role group).
-stackable_operator::constant!(pub(crate) PLACEHOLDER_LISTENER_ROLE_GROUP: RoleGroupName = "none");
+stackable_operator::constant!(pub(crate) NONE_ROLE_GROUP_NAME: RoleGroupName = "none");
 
 pub mod authentication;
 pub mod graceful_shutdown;

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

@@ -151,7 +151,7 @@ pub fn build_rolegroup_config_map(
     role_group_name: &RoleGroupName,
     rg: &DruidRoleGroupConfig,
 ) -> Result<ConfigMap> {
-    let resource_names = cluster.resource_names(role, role_group_name);
+    let resource_names = cluster.role_group_resource_names(role, role_group_name);
     let cluster_config = &cluster.cluster_config;
     let druid_tls_security = &cluster_config.druid_tls_security;
     let druid_auth_config = &cluster_config.druid_auth_config;

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

@@ -15,7 +15,7 @@ use stackable_operator::{
 
 use crate::{
     controller::{
-        build::{PLACEHOLDER_LISTENER_ROLE_GROUP, security::listener_ports},
+        build::{NONE_ROLE_GROUP_NAME, security::listener_ports},
         validate::ValidatedCluster,
     },
     crd::{
@@ -52,7 +52,7 @@ pub fn build_group_listener(
             .object_meta(
                 listener_group_name.to_string(),
                 druid_role,
-                &PLACEHOLDER_LISTENER_ROLE_GROUP,
+                &NONE_ROLE_GROUP_NAME,
             )
             .build(),
         spec: listener::v1alpha1::ListenerSpec {

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

@@ -20,7 +20,7 @@ stackable_operator::constant!(NONE_ROLE_GROUP_NAME: RoleGroupName = "none");
 pub fn build_service_account(cluster: &ValidatedCluster) -> ServiceAccount {
     rbac::build_service_account(
         cluster,
-        &cluster.rbac_resource_names(),
+        &cluster.cluster_resource_names(),
         rbac_labels(cluster),
     )
 }
@@ -30,7 +30,7 @@ pub fn build_service_account(cluster: &ValidatedCluster) -> ServiceAccount {
 pub fn build_role_binding(cluster: &ValidatedCluster) -> RoleBinding {
     rbac::build_role_binding(
         cluster,
-        &cluster.rbac_resource_names(),
+        &cluster.cluster_resource_names(),
         rbac_labels(cluster),
     )
 }

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

@@ -22,7 +22,7 @@ pub fn build_rolegroup_headless_service(
         metadata: cluster
             .object_meta(
                 cluster
-                    .resource_names(druid_role, role_group_name)
+                    .role_group_resource_names(druid_role, role_group_name)
                     .headless_service_name()
                     .to_string(),
                 druid_role,
@@ -59,7 +59,7 @@ pub fn build_rolegroup_metrics_service(
         metadata: cluster
             .object_meta(
                 cluster
-                    .resource_names(druid_role, role_group_name)
+                    .role_group_resource_names(druid_role, role_group_name)
                     .metrics_service_name()
                     .to_string(),
                 druid_role,

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

@@ -115,7 +115,7 @@ pub fn build_rolegroup_statefulset(
     rg: &DruidRoleGroupConfig,
 ) -> Result<StatefulSet> {
     let merged_rolegroup_config = &rg.config;
-    let resource_names = cluster.resource_names(role, role_group_name);
+    let resource_names = cluster.role_group_resource_names(role, role_group_name);
     // Everything below used to be threaded in as separate parameters; it all lives on the
     // `ValidatedCluster` now.
     let resolved_product_image = &cluster.image;
@@ -319,7 +319,7 @@ pub fn build_rolegroup_statefulset(
         .metadata(metadata)
         .service_account_name(
             cluster
-                .rbac_resource_names()
+                .cluster_resource_names()
                 .service_account_name()
                 .to_string(),
         )

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

@@ -281,15 +281,15 @@ impl ValidatedCluster {
 
     /// Type-safe names for the per-cluster RBAC resources: the ServiceAccount shared by all
     /// Pods, its (namespaced) RoleBinding, and the operator-deployed ClusterRole it binds.
-    pub fn rbac_resource_names(&self) -> role_utils::ResourceNames {
+    pub fn cluster_resource_names(&self) -> role_utils::ResourceNames {
         role_utils::ResourceNames {
             cluster_name: self.name.clone(),
             product_name: product_name(),
         }
     }
 
     /// Type-safe names for the resources of the given role's role group.
-    pub(crate) fn resource_names(
+    pub(crate) fn role_group_resource_names(
         &self,
         role: &DruidRole,
         role_group_name: &RoleGroupName,
@@ -614,7 +614,7 @@ mod tests {
     use strum::IntoEnumIterator;
 
     use super::{
-        Error,
+        Error, ValidatedCluster,
         test_support::{MINIMAL_DRUID_YAML, druid_from_yaml},
         validate,
     };
@@ -718,4 +718,13 @@ mod tests {
             "expected a ClusterIdentity error when the cluster has no uid"
         );
     }
+
+    /// Locks the invariant behind the `expect` in [`ValidatedCluster::role_name`]: every
+    /// `DruidRole` variant (present and future) must serialise to a valid `RoleName`.
+    #[test]
+    fn every_druid_role_serialises_to_a_valid_role_name() {
+        for role in DruidRole::iter() {
+            ValidatedCluster::role_name(&role);
+        }
+    }
 }