refactor: move ConfigFileName enum

Author: maltesander

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

@@ -6,10 +6,10 @@ use stackable_operator::{
     utils::COMMON_BASH_TRAP_FUNCTIONS,
 };
 
+use super::properties::ConfigFileName;
 use crate::crd::{
-    BROKER_ID_POD_MAP_DIR, ConfigFileName, KafkaPodDescriptor, STACKABLE_CONFIG_DIR,
-    STACKABLE_KERBEROS_KRB5_PATH, STACKABLE_LOG_CONFIG_DIR, STACKABLE_LOG_DIR,
-    security::KafkaTlsSecurity,
+    BROKER_ID_POD_MAP_DIR, KafkaPodDescriptor, STACKABLE_CONFIG_DIR, STACKABLE_KERBEROS_KRB5_PATH,
+    STACKABLE_LOG_CONFIG_DIR, STACKABLE_LOG_DIR, security::KafkaTlsSecurity,
 };
 
 /// The JVM options selecting the Kafka log4j/log4j2 config file. Kafka 3.x uses log4j,

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

@@ -4,7 +4,8 @@ use stackable_operator::{
     v2::jvm_argument_overrides::JvmArgumentOverrides,
 };
 
-use crate::crd::{ConfigFileName, METRICS_PORT, STACKABLE_CONFIG_DIR, role::AnyConfig};
+use super::properties::ConfigFileName;
+use crate::crd::{METRICS_PORT, STACKABLE_CONFIG_DIR, role::AnyConfig};
 
 const JAVA_HEAP_FACTOR: f32 = 0.8;
 

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

@@ -12,8 +12,9 @@ use stackable_operator::{
     role_utils::RoleGroupRef,
 };
 
+use super::ConfigFileName;
 use crate::crd::{
-    ConfigFileName, STACKABLE_LOG_DIR,
+    STACKABLE_LOG_DIR,
     role::{AnyConfig, broker::BrokerContainer, controller::ControllerContainer},
     v1alpha1,
 };

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

@@ -6,7 +6,45 @@ pub mod listener;
 pub mod logging;
 pub mod security_properties;
 
-use crate::crd::{KafkaPodDescriptor, role::KafkaRole};
+use crate::crd::{
+    KafkaPodDescriptor,
+    role::{AnyConfig, KafkaRole},
+};
+
+/// The names of the config files assembled into the rolegroup `ConfigMap`.
+///
+/// A single source of truth for the on-disk file names, used by the config-map
+/// builder, the per-file property builders and the JVM/command builders.
+#[derive(Clone, Copy, Debug, PartialEq, Eq, strum::Display)]
+pub enum ConfigFileName {
+    #[strum(serialize = "broker.properties")]
+    BrokerProperties,
+    #[strum(serialize = "controller.properties")]
+    ControllerProperties,
+    #[strum(serialize = "security.properties")]
+    Security,
+    #[strum(serialize = "client.properties")]
+    Client,
+    /// JAAS configuration for Kerberos authentication. It has the `.properties`
+    /// extension but is not a Java properties file.
+    #[strum(serialize = "jaas.properties")]
+    Jaas,
+    /// Used by Kafka 3.x.
+    #[strum(serialize = "log4j.properties")]
+    Log4j,
+    /// Used by Kafka 4.0 and later.
+    #[strum(serialize = "log4j2.properties")]
+    Log4j2,
+}
+
+/// The product config-file name for a role group, derived from its role
+/// (`broker.properties` for brokers, `controller.properties` for controllers).
+pub fn config_file_name(config: &AnyConfig) -> ConfigFileName {
+    match config {
+        AnyConfig::Broker(_) => ConfigFileName::BrokerProperties,
+        AnyConfig::Controller(_) => ConfigFileName::ControllerProperties,
+    }
+}
 
 pub(crate) fn kraft_controllers(pod_descriptors: &[KafkaPodDescriptor]) -> Vec<String> {
     pod_descriptors
@@ -21,3 +59,25 @@ pub(crate) fn kraft_controllers(pod_descriptors: &[KafkaPodDescriptor]) -> Vec<S
         })
         .collect::<Vec<String>>()
 }
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn file_names_match_the_kafka_on_disk_names() {
+        assert_eq!(
+            ConfigFileName::BrokerProperties.to_string(),
+            "broker.properties"
+        );
+        assert_eq!(
+            ConfigFileName::ControllerProperties.to_string(),
+            "controller.properties"
+        );
+        assert_eq!(ConfigFileName::Security.to_string(), "security.properties");
+        assert_eq!(ConfigFileName::Client.to_string(), "client.properties");
+        assert_eq!(ConfigFileName::Jaas.to_string(), "jaas.properties");
+        assert_eq!(ConfigFileName::Log4j.to_string(), "log4j.properties");
+        assert_eq!(ConfigFileName::Log4j2.to_string(), "log4j2.properties");
+    }
+}

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

@@ -13,10 +13,12 @@ use stackable_operator::{
 use crate::{
     controller::{
         RoleGroupName, ValidatedCluster, ValidatedRoleGroupConfig,
-        build::properties::logging::role_group_config_map_data,
+        build::properties::{
+            ConfigFileName, config_file_name, logging::role_group_config_map_data,
+        },
     },
     crd::{
-        ConfigFileName, STACKABLE_LISTENER_BOOTSTRAP_DIR, STACKABLE_LISTENER_BROKER_DIR,
+        STACKABLE_LISTENER_BOOTSTRAP_DIR, STACKABLE_LISTENER_BROKER_DIR,
         listener::{KafkaListenerConfig, node_address_cmd},
         role::AnyConfig,
     },
@@ -70,7 +72,7 @@ pub fn build_rolegroup_config_map(
     let cluster_config = &validated_cluster.cluster_config;
     let kafka_security = &cluster_config.kafka_security;
     let resolved_product_image = &validated_cluster.image;
-    let kafka_config_file_name = validated_rg.config.config_file_name().to_string();
+    let kafka_config_file_name = config_file_name(&validated_rg.config).to_string();
     let config_overrides = validated_rg
         .config_overrides
         .config_file_overrides()

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

@@ -1,14 +1,12 @@
 pub mod affinity;
 pub mod authentication;
 pub mod authorization;
-pub mod config_file;
 pub mod listener;
 pub mod role;
 pub mod security;
 pub mod tls;
 
 use authentication::KafkaAuthentication;
-pub use config_file::ConfigFileName;
 use serde::{Deserialize, Serialize};
 use snafu::{OptionExt, Snafu};
 use stackable_operator::{

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

@@ -15,13 +15,10 @@ use stackable_operator::{
 use strum::{Display, EnumIter, EnumString, IntoEnumIterator};
 
 use crate::{
-    crd::{
-        ConfigFileName,
-        role::{
-            broker::BrokerConfig,
-            commons::{CommonConfig, Storage},
-            controller::ControllerConfig,
-        },
+    crd::role::{
+        broker::BrokerConfig,
+        commons::{CommonConfig, Storage},
+        controller::ControllerConfig,
     },
     v1alpha1,
 };
@@ -228,13 +225,6 @@ impl AnyConfig {
             AnyConfig::Controller(_) => None,
         }
     }
-
-    pub fn config_file_name(&self) -> ConfigFileName {
-        match self {
-            AnyConfig::Broker(_) => ConfigFileName::BrokerProperties,
-            AnyConfig::Controller(_) => ConfigFileName::ControllerProperties,
-        }
-    }
 }
 
 /// Merged role/role-group `configOverrides` for a role group of an unknown type.