refactor: tighten constant visibility

Author: maltesander

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

@@ -14,7 +14,12 @@ use super::{
 use crate::{
     controller::{
         NifiRoleGroupConfig, ValidatedCluster,
-        build::{HTTPS_PORT, NIFI_CONFIG_DIRECTORY, NIFI_PYTHON_WORKING_DIRECTORY, PROTOCOL_PORT},
+        build::{
+            HTTPS_PORT, NIFI_CONFIG_DIRECTORY, NIFI_PYTHON_WORKING_DIRECTORY, PROTOCOL_PORT,
+            resource::statefulset::{
+                NODE_ADDRESS_ENV, STACKLET_NAME_ENV, ZOOKEEPER_CHROOT_ENV, ZOOKEEPER_HOSTS_ENV,
+            },
+        },
     },
     crd::{storage::NifiRepository, v1alpha1},
     security::{
@@ -405,7 +410,7 @@ pub fn build(
     //#############################################
     properties.insert(
         "nifi.web.https.host".to_string(),
-        env_reference("NODE_ADDRESS"),
+        env_reference(NODE_ADDRESS_ENV),
     );
     properties.insert("nifi.web.https.port".to_string(), HTTPS_PORT.to_string());
     properties.insert(
@@ -515,7 +520,7 @@ pub fn build(
     properties.insert("nifi.cluster.is.node".to_string(), "true".to_string());
     properties.insert(
         "nifi.cluster.node.address".to_string(),
-        env_reference("NODE_ADDRESS"),
+        env_reference(NODE_ADDRESS_ENV),
     );
     properties.insert(
         "nifi.cluster.node.protocol.port".to_string(),
@@ -536,13 +541,13 @@ pub fn build(
             // this will be replaced via a container command script
             properties.insert(
                 "nifi.zookeeper.connect.string".to_string(),
-                env_reference("ZOOKEEPER_HOSTS"),
+                env_reference(ZOOKEEPER_HOSTS_ENV),
             );
 
             // this will be replaced via a container command script
             properties.insert(
                 "nifi.zookeeper.root.node".to_string(),
-                env_reference("ZOOKEEPER_CHROOT"),
+                env_reference(ZOOKEEPER_CHROOT_ENV),
             );
         }
 
@@ -557,7 +562,7 @@ pub fn build(
             // this will be replaced via a container command script
             properties.insert(
                 "nifi.cluster.leader.election.kubernetes.lease.prefix".to_string(),
-                env_reference("STACKLET_NAME"),
+                env_reference(STACKLET_NAME_ENV),
             );
         }
     }

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

@@ -52,14 +52,17 @@ mod tests {
 
     use stackable_operator::v2::types::kubernetes::ConfigMapName;
 
-    use super::*;
+    use super::{super::env_reference, *};
+    use crate::controller::build::resource::statefulset::{
+        STACKLET_NAME_ENV, ZOOKEEPER_CHROOT_ENV, ZOOKEEPER_HOSTS_ENV,
+    };
 
     #[test]
     fn test_build_state_management_xml_kubernetes() {
         let xml = build(&NifiClusteringBackend::Kubernetes {});
         assert!(xml.contains(KUBERNETES_STATE_PROVIDER_ID));
         assert!(xml.contains("KubernetesConfigMapStateProvider"));
-        assert!(xml.contains("${env:STACKLET_NAME}"));
+        assert!(xml.contains(&env_reference(STACKLET_NAME_ENV)));
         assert!(!xml.contains(ZOOKEEPER_STATE_PROVIDER_ID));
     }
 
@@ -71,8 +74,8 @@ mod tests {
         });
         assert!(xml.contains(ZOOKEEPER_STATE_PROVIDER_ID));
         assert!(xml.contains("ZooKeeperStateProvider"));
-        assert!(xml.contains("${env:ZOOKEEPER_HOSTS}"));
-        assert!(xml.contains("${env:ZOOKEEPER_CHROOT}"));
+        assert!(xml.contains(&env_reference(ZOOKEEPER_HOSTS_ENV)));
+        assert!(xml.contains(&env_reference(ZOOKEEPER_CHROOT_ENV)));
         assert!(!xml.contains(KUBERNETES_STATE_PROVIDER_ID));
     }
 }

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

@@ -6,7 +6,14 @@ use stackable_operator::utils::cluster_info::KubernetesClusterInfo;
 
 use crate::controller::{
     ValidatedCluster,
-    build::{HTTPS_PORT, properties::env_reference, resource::reporting_task},
+    build::{
+        HTTPS_PORT,
+        properties::env_reference,
+        resource::{
+            reporting_task,
+            statefulset::{LISTENER_DEFAULT_ADDRESS_ENV, LISTENER_DEFAULT_PORT_HTTPS_ENV},
+        },
+    },
 };
 
 /// Computes the comma-separated NiFi proxy hosts, or `"*"` if `hostHeaderCheck.allowAll` is set.
@@ -35,8 +42,8 @@ pub fn compute_proxy_hosts(
     // Address and port are injected from the listener volume during the prepare container
     let mut proxy_hosts = HashSet::from([format!(
         "{address}:{port}",
-        address = env_reference("LISTENER_DEFAULT_ADDRESS"),
-        port = env_reference("LISTENER_DEFAULT_PORT_HTTPS")
+        address = env_reference(LISTENER_DEFAULT_ADDRESS_ENV),
+        port = env_reference(LISTENER_DEFAULT_PORT_HTTPS_ENV)
     )]);
     proxy_hosts.extend(host_header_check.additional_allowed_hosts.iter().cloned());
 

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

@@ -154,6 +154,16 @@ stackable_operator::constant!(VECTOR_CONTAINER_NAME: ContainerName = "vector");
 stackable_operator::constant!(VECTOR_LOG_CONFIG_VOLUME_NAME: VolumeName = "config");
 stackable_operator::constant!(VECTOR_LOG_VOLUME_NAME: VolumeName = "log");
 
+// Names of the environment variables injected into the NiFi container here (or exported by the
+// prepare init-container) and referenced as `${env:...}` placeholders by the config-file builders
+// (`nifi.properties`, `state-management.xml`, proxy hosts). The two sides must agree.
+pub(crate) const STACKLET_NAME_ENV: &str = "STACKLET_NAME";
+pub(crate) const NODE_ADDRESS_ENV: &str = "NODE_ADDRESS";
+pub(crate) const ZOOKEEPER_HOSTS_ENV: &str = "ZOOKEEPER_HOSTS";
+pub(crate) const ZOOKEEPER_CHROOT_ENV: &str = "ZOOKEEPER_CHROOT";
+pub(crate) const LISTENER_DEFAULT_ADDRESS_ENV: &str = "LISTENER_DEFAULT_ADDRESS";
+pub(crate) const LISTENER_DEFAULT_PORT_HTTPS_ENV: &str = "LISTENER_DEFAULT_PORT_HTTPS";
+
 /// The rolegroup [`StatefulSet`] runs the rolegroup, as configured by the administrator.
 ///
 /// The [`Pod`](`stackable_operator::k8s_openapi::api::core::v1::Pod`)s are accessible through the
@@ -207,7 +217,7 @@ pub(crate) async fn build_node_rolegroup_statefulset(
     });
 
     env_vars.push(EnvVar {
-        name: "STACKLET_NAME".to_string(),
+        name: STACKLET_NAME_ENV.to_string(),
         value: Some(cluster.name.to_string()),
         ..Default::default()
     });
@@ -228,8 +238,8 @@ pub(crate) async fn build_node_rolegroup_statefulset(
                 }),
                 ..EnvVar::default()
             };
-            env_vars.push(zookeeper_env_var("ZOOKEEPER_HOSTS"));
-            env_vars.push(zookeeper_env_var("ZOOKEEPER_CHROOT"));
+            env_vars.push(zookeeper_env_var(ZOOKEEPER_HOSTS_ENV));
+            env_vars.push(zookeeper_env_var(ZOOKEEPER_CHROOT_ENV));
         }
         v1alpha1::NifiClusteringBackend::Kubernetes {} => {}
     }
@@ -289,7 +299,7 @@ pub(crate) async fn build_node_rolegroup_statefulset(
             "test -L {NIFI_CONFIG_DIRECTORY}/{logback} || ln -sf {STACKABLE_LOG_CONFIG_DIR}/{logback} {NIFI_CONFIG_DIRECTORY}/{logback}",
             logback = ConfigFileName::Logback
         ),
-        format!(r#"export NODE_ADDRESS="{node_address}""#),
+        format!(r#"export {NODE_ADDRESS_ENV}="{node_address}""#),
     ]);
 
     // This commands needs to go first, as they might set env variables needed by the templating
@@ -308,10 +318,10 @@ pub(crate) async fn build_node_rolegroup_statefulset(
     }
 
     prepare_args.push(format!(
-        "export LISTENER_DEFAULT_ADDRESS=$(cat {LISTENER_VOLUME_DIR}/default-address/address)"
+        "export {LISTENER_DEFAULT_ADDRESS_ENV}=$(cat {LISTENER_VOLUME_DIR}/default-address/address)"
     ));
     prepare_args.push(format!(
-        "export LISTENER_DEFAULT_PORT_HTTPS=$(cat {LISTENER_VOLUME_DIR}/default-address/ports/https)"
+        "export {LISTENER_DEFAULT_PORT_HTTPS_ENV}=$(cat {LISTENER_VOLUME_DIR}/default-address/ports/https)"
     ));
 
     // Template the config files that contain `${env:...}`/`${file:...}` placeholders, in a fixed