Use constants for environment variable names

Author: siegfriedweber

Cargo.lock

@@ -1,9 +1,12 @@
 //! Configuration of an OpenSearch node
 
+use std::str::FromStr;
+
 use serde_json::json;
 use stackable_operator::{
     builder::pod::container::FieldPathEnvVar,
     commons::networking::DomainName,
+    constant,
     k8s_openapi::DeepMerge,
     v2::{
         builder::pod::container::{EnvVarName, EnvVarSet},
@@ -140,6 +143,17 @@ const CONFIG_OPTION_TRANSPORT_PUBLISH_HOST: &str = "transport.publish_host";
 
 const DEFAULT_OPENSEARCH_HOME: &str = "/stackable/opensearch";
 
+constant!(ENV_VAR_NAME_DISCOVERY_SEED_HOSTS: EnvVarName = CONFIG_OPTION_DISCOVERY_SEED_HOSTS);
+constant!(ENV_VAR_NAME_HTTP_PUBLISH_HOST: EnvVarName = CONFIG_OPTION_HTTP_PUBLISH_HOST);
+constant!(ENV_VAR_NAME_INITIAL_CLUSTER_MANAGER_NODES: EnvVarName = CONFIG_OPTION_INITIAL_CLUSTER_MANAGER_NODES);
+constant!(ENV_VAR_NAME_NETWORK_PUBLISH_HOST: EnvVarName = CONFIG_OPTION_NETWORK_PUBLISH_HOST);
+constant!(ENV_VAR_NAME_NODE_NAME: EnvVarName = CONFIG_OPTION_NODE_NAME);
+constant!(ENV_VAR_NAME_NODE_ROLES: EnvVarName = CONFIG_OPTION_NODE_ROLES);
+constant!(ENV_VAR_NAME_OPENSEARCH_HOME: EnvVarName = "OPENSEARCH_HOME");
+constant!(ENV_VAR_NAME_OPENSEARCH_PATH_CONF: EnvVarName = "OPENSEARCH_PATH_CONF");
+constant!(ENV_VAR_NAME_POD_NAME: EnvVarName = "_POD_NAME");
+constant!(ENV_VAR_NAME_TRANSPORT_PUBLISH_HOST: EnvVarName = CONFIG_OPTION_TRANSPORT_PUBLISH_HOST);
+
 /// Configuration of an OpenSearch node based on the cluster and role-group configuration
 pub struct NodeConfig {
     cluster: ValidatedCluster,
@@ -295,36 +309,36 @@ impl NodeConfig {
             .with_field_path(
                 // Prefix with an underscore, so that it occurs before the other environment
                 // variables which depend on it.
-                &EnvVarName::from_str_unsafe("_POD_NAME"),
+                &ENV_VAR_NAME_POD_NAME,
                 &FieldPathEnvVar::Name,
             )
             // Set the OpenSearch node name to the Pod name.
             // The node name is used e.g. for INITIAL_CLUSTER_MANAGER_NODES.
             .with_field_path(
-                &EnvVarName::from_str_unsafe(CONFIG_OPTION_NODE_NAME),
+                &ENV_VAR_NAME_NODE_NAME,
                 &FieldPathEnvVar::Name,
             )
             .with_value(
-                &EnvVarName::from_str_unsafe(CONFIG_OPTION_NETWORK_PUBLISH_HOST),
+                &ENV_VAR_NAME_NETWORK_PUBLISH_HOST,
                 &fqdn,
             )
             .with_value(
-                &EnvVarName::from_str_unsafe(CONFIG_OPTION_TRANSPORT_PUBLISH_HOST),
+                &ENV_VAR_NAME_TRANSPORT_PUBLISH_HOST,
                 &fqdn,
             )
             .with_value(
-                &EnvVarName::from_str_unsafe(CONFIG_OPTION_HTTP_PUBLISH_HOST),
+                &ENV_VAR_NAME_HTTP_PUBLISH_HOST,
                 &fqdn,
             )
             .with_value(
-                &EnvVarName::from_str_unsafe(CONFIG_OPTION_DISCOVERY_SEED_HOSTS),
+                &ENV_VAR_NAME_DISCOVERY_SEED_HOSTS,
                 format!(
                     "{}.{}.svc.{}",
                     self.seed_nodes_service_name, self.cluster.namespace, self.cluster_domain_name
                 ),
             )
             .with_value(
-                &EnvVarName::from_str_unsafe(CONFIG_OPTION_NODE_ROLES),
+                &ENV_VAR_NAME_NODE_ROLES,
                 Self::to_comma_separated_list(
                     &self
                         .role_group_config
@@ -339,7 +353,7 @@ impl NodeConfig {
 
         if let Some(initial_cluster_manager_nodes) = self.initial_cluster_manager_nodes() {
             env_vars = env_vars.with_value(
-                &EnvVarName::from_str_unsafe(CONFIG_OPTION_INITIAL_CLUSTER_MANAGER_NODES),
+                &ENV_VAR_NAME_INITIAL_CLUSTER_MANAGER_NODES,
                 initial_cluster_manager_nodes,
             );
         }
@@ -456,7 +470,7 @@ impl NodeConfig {
     /// Return content of the `OPENSEARCH_HOME` environment variable from envOverrides or default to `DEFAULT_OPENSEARCH_HOME`
     pub fn opensearch_home(&self) -> String {
         self.environment_variables()
-            .get(&EnvVarName::from_str_unsafe("OPENSEARCH_HOME"))
+            .get(&ENV_VAR_NAME_OPENSEARCH_HOME)
             .and_then(|env_var| env_var.value.clone())
             .unwrap_or(DEFAULT_OPENSEARCH_HOME.to_owned())
     }
@@ -465,7 +479,7 @@ impl NodeConfig {
     pub fn opensearch_path_conf(&self) -> String {
         let opensearch_home = self.opensearch_home();
         self.environment_variables()
-            .get(&EnvVarName::from_str_unsafe("OPENSEARCH_PATH_CONF"))
+            .get(&ENV_VAR_NAME_OPENSEARCH_PATH_CONF)
             .and_then(|env_var| env_var.value.clone())
             .unwrap_or(format!("{opensearch_home}/config"))
     }
@@ -675,6 +689,21 @@ mod tests {
         );
     }
 
+    #[test]
+    fn test_constants() {
+        // Test that dereferencing the constants does not panic.
+        let _ = *ENV_VAR_NAME_DISCOVERY_SEED_HOSTS;
+        let _ = *ENV_VAR_NAME_HTTP_PUBLISH_HOST;
+        let _ = *ENV_VAR_NAME_INITIAL_CLUSTER_MANAGER_NODES;
+        let _ = *ENV_VAR_NAME_NETWORK_PUBLISH_HOST;
+        let _ = *ENV_VAR_NAME_NODE_NAME;
+        let _ = *ENV_VAR_NAME_NODE_ROLES;
+        let _ = *ENV_VAR_NAME_OPENSEARCH_HOME;
+        let _ = *ENV_VAR_NAME_OPENSEARCH_PATH_CONF;
+        let _ = *ENV_VAR_NAME_POD_NAME;
+        let _ = *ENV_VAR_NAME_TRANSPORT_PUBLISH_HOST;
+    }
+
     #[test]
     pub fn test_super_admin_dn() {
         let node_config = node_config(TestConfig::default());

Cargo.nix

@@ -1,8 +1,9 @@
 //! OpenSearch specific log configuration
 
-use std::{cmp, collections::BTreeMap};
+use std::{cmp, collections::BTreeMap, str::FromStr};
 
 use stackable_operator::{
+    constant,
     memory::{BinaryMultiple, MemoryQuantity},
     product_logging::spec::{AppenderConfig, AutomaticContainerLogConfig, LogLevel, LoggerConfig},
     v2::{
@@ -23,6 +24,8 @@ pub const MAX_OPENSEARCH_SERVER_LOG_FILES_SIZE: MemoryQuantity = MemoryQuantity
     unit: BinaryMultiple::Mebi,
 };
 
+constant!(ENV_VAR_NAME_OPENSEARCH_SERVER_LOG_FILE: EnvVarName = "OPENSEARCH_SERVER_LOG_FILE");
+
 /// Create a log4j2 configuration from the given automatic log configuration
 pub fn create_log4j2_config(config: &AutomaticContainerLogConfig) -> String {
     [
@@ -189,7 +192,7 @@ pub fn vector_config_file_content() -> String {
 /// [`crate::framework::product_logging::framework::vector_container`].
 pub fn vector_config_file_extra_env_vars() -> EnvVarSet {
     EnvVarSet::new().with_value(
-        &EnvVarName::from_str_unsafe("OPENSEARCH_SERVER_LOG_FILE"),
+        &ENV_VAR_NAME_OPENSEARCH_SERVER_LOG_FILE,
         "opensearch_server.json",
     )
 }
@@ -200,7 +203,16 @@ mod tests {
         AppenderConfig, AutomaticContainerLogConfig, LogLevel, LoggerConfig,
     };
 
-    use super::{create_log4j2_config, vector_config_file_extra_env_vars};
+    use super::{
+        ENV_VAR_NAME_OPENSEARCH_SERVER_LOG_FILE, create_log4j2_config,
+        vector_config_file_extra_env_vars,
+    };
+
+    #[test]
+    fn test_constants() {
+        // Test that dereferencing the constants does not panic.
+        let _ = *ENV_VAR_NAME_OPENSEARCH_SERVER_LOG_FILE;
+    }
 
     #[test]
     pub fn test_create_log4j2_config() {