refactor: use ConfigFileName enum where possible

Author: maltesander

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

@@ -12,14 +12,11 @@ use crate::{
     controller::{
         ValidatedCluster,
         build::properties::{
-            core_site, hive_site, logging, resolved_overrides, security_properties,
+            ConfigFileName, core_site, hive_site, logging, resolved_overrides, security_properties,
         },
         build_recommended_labels,
     },
-    crd::{
-        CORE_SITE_XML, HIVE_METASTORE_LOG4J2_PROPERTIES, HIVE_SITE_XML, HiveRole,
-        JVM_SECURITY_PROPERTIES_FILE, v1alpha1,
-    },
+    crd::{HiveRole, v1alpha1},
     framework::writer::{to_hadoop_xml, to_java_properties_string},
 };
 
@@ -31,7 +28,7 @@ pub enum Error {
     #[snafu(display("failed to build hive-site.xml"))]
     BuildHiveSite { source: hive_site::Error },
 
-    #[snafu(display("failed to serialize {JVM_SECURITY_PROPERTIES_FILE}"))]
+    #[snafu(display("failed to serialize {}", ConfigFileName::Security))]
     WriteSecurityProperties {
         source: crate::framework::writer::PropertiesWriterError,
     },
@@ -101,20 +98,26 @@ pub fn build_metastore_rolegroup_config_map(
                 .context(MetadataBuildSnafu)?
                 .build(),
         )
-        .add_data(HIVE_SITE_XML, to_hadoop_xml(hive_site_data.iter()))
         .add_data(
-            JVM_SECURITY_PROPERTIES_FILE,
+            ConfigFileName::HiveSite.to_string(),
+            to_hadoop_xml(hive_site_data.iter()),
+        )
+        .add_data(
+            ConfigFileName::Security.to_string(),
             to_java_properties_string(security_data.iter())
                 .context(WriteSecurityPropertiesSnafu)?,
         );
 
     // core-site.xml is only required when Kerberos is enabled without an HDFS backend.
     if let Some(core_site_data) = core_site::build(&cluster.cluster_config) {
-        cm_builder.add_data(CORE_SITE_XML, to_hadoop_xml(core_site_data.iter()));
+        cm_builder.add_data(
+            ConfigFileName::CoreSite.to_string(),
+            to_hadoop_xml(core_site_data.iter()),
+        );
     }
 
     if let Some(log4j2_properties) = logging::build_log4j2(&rg.config.logging) {
-        cm_builder.add_data(HIVE_METASTORE_LOG4J2_PROPERTIES, log4j2_properties);
+        cm_builder.add_data(ConfigFileName::Log4j2.to_string(), log4j2_properties);
     }
     if let Some(vector_config) = logging::build_vector_config(rolegroup, &rg.config.logging) {
         cm_builder.add_data(VECTOR_CONFIG_FILE, vector_config);

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

@@ -19,6 +19,35 @@ pub(crate) fn resolved_overrides(overrides: KeyValueConfigOverrides) -> BTreeMap
         .collect()
 }
 
+/// The names of the Hive config files assembled into the rolegroup `ConfigMap`.
+#[derive(Clone, Copy, Debug, strum::Display)]
+pub enum ConfigFileName {
+    #[strum(serialize = "hive-site.xml")]
+    HiveSite,
+    #[strum(serialize = "core-site.xml")]
+    CoreSite,
+    #[strum(serialize = "security.properties")]
+    Security,
+    #[strum(serialize = "metastore-log4j2.properties")]
+    Log4j2,
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn file_names_match_the_hive_on_disk_names() {
+        assert_eq!(ConfigFileName::HiveSite.to_string(), "hive-site.xml");
+        assert_eq!(ConfigFileName::CoreSite.to_string(), "core-site.xml");
+        assert_eq!(ConfigFileName::Security.to_string(), "security.properties");
+        assert_eq!(
+            ConfigFileName::Log4j2.to_string(),
+            "metastore-log4j2.properties"
+        );
+    }
+}
+
 #[cfg(test)]
 pub(crate) mod test_support {
     use std::collections::BTreeMap;

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

@@ -55,7 +55,7 @@ pub const STACKABLE_LOG_CONFIG_MOUNT_DIR: &str = "/stackable/mount/log-config";
 pub const STACKABLE_LOG_CONFIG_MOUNT_DIR_NAME: &str = "log-config-mount";
 
 // Config file names
-pub const CORE_SITE_XML: &str = "core-site.xml";
+// TODO(@maltesander): remove once fully consolidated with ConfigFileName
 pub const HIVE_SITE_XML: &str = "hive-site.xml";
 pub const HIVE_METASTORE_LOG4J2_PROPERTIES: &str = "metastore-log4j2.properties";
 pub const JVM_SECURITY_PROPERTIES_FILE: &str = "security.properties";