confluent_kafka/admin/
config.rs1use std::collections::HashMap;
18
19use crate::admin::ConfigEntry;
20
21#[derive(Clone, Debug, PartialEq, Eq)]
27#[doc(alias = "org.apache.kafka.clients.admin.Config")]
28pub struct Config {
29 entries: HashMap<String, ConfigEntry>,
30}
31
32impl Config {
33 #[doc(alias = "org.apache.kafka.clients.admin.Config#Config")]
39 pub fn new(entries: impl IntoIterator<Item = ConfigEntry>) -> Self {
40 let mut map = HashMap::new();
41 for entry in entries {
42 map.insert(entry.name().to_string(), entry);
43 }
44 Self { entries: map }
45 }
46
47 #[doc(alias = "org.apache.kafka.clients.admin.Config#entries")]
49 pub fn entries(&self) -> impl Iterator<Item = &ConfigEntry> {
50 self.entries.values()
51 }
52
53 #[doc(alias = "org.apache.kafka.clients.admin.Config#get")]
60 pub fn get(&self, name: &str) -> Option<&ConfigEntry> {
61 self.entries.get(name)
62 }
63}
64
65impl std::hash::Hash for Config {
66 fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
69 crate::common::utils::Utils::hash_unordered(&self.entries, state);
70 }
71}
72
73impl std::fmt::Display for Config {
74 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
77 let entries: Vec<String> = self.entries.values().map(|e| e.to_string()).collect();
78 write!(f, "Config(entries=[{}])", entries.join(", "))
79 }
80}
81
82#[cfg(test)]
83mod tests {
84 use super::*;
85 use crate::admin::ConfigEntryOptionsBuilder;
86 use crate::admin::config_entry::ConfigType;
87
88 #[test]
89 fn new_indexes_entries_by_name() {
90 let config = Config::new([
91 ConfigEntry::new("a".to_string(), Some("1".to_string())),
92 ConfigEntry::new("b".to_string(), Some("2".to_string())),
93 ]);
94 assert_eq!(config.get("a").unwrap().value(), Some("1"));
95 assert_eq!(config.get("b").unwrap().value(), Some("2"));
96 assert!(config.get("missing").is_none());
97 assert_eq!(config.entries().count(), 2);
98 }
99
100 #[test]
101 fn equality_is_order_independent() {
102 let a = Config::new([
103 ConfigEntry::new("a".to_string(), Some("1".to_string())),
104 ConfigEntry::new("b".to_string(), Some("2".to_string())),
105 ]);
106 let b = Config::new([
107 ConfigEntry::new("b".to_string(), Some("2".to_string())),
108 ConfigEntry::new("a".to_string(), Some("1".to_string())),
109 ]);
110 assert_eq!(a, b);
111 }
112
113 const SECRET: &str = "ssl-truststore-S3cr3t-91c4";
115
116 fn config_with_secret() -> Config {
118 Config::new([
119 ConfigEntry::with_options(
120 ConfigEntryOptionsBuilder::new()
121 .set_name("ssl.truststore.password".to_string())
122 .set_value(Some(SECRET.to_string()))
123 .set_is_sensitive(true)
124 .set_config_type(Some(ConfigType::Password))
125 .build()
126 .unwrap(),
127 ),
128 ConfigEntry::new("retention.ms".to_string(), Some("604800000".to_string())),
129 ])
130 }
131
132 #[test]
139 fn display_redacts_sensitive_values() {
140 let config = config_with_secret();
141 let sensitive = config.get("ssl.truststore.password").unwrap();
142 assert_eq!(sensitive.value(), Some(SECRET));
143 let rendered = config.to_string();
144 assert!(rendered.contains(&sensitive.to_string()), "{rendered}");
146 assert!(
147 rendered.contains(&config.get("retention.ms").unwrap().to_string()),
148 "{rendered}"
149 );
150 assert!(rendered.starts_with("Config(entries=["), "{rendered}");
151 assert!(rendered.contains("name=ssl.truststore.password, value=Redacted"), "{rendered}");
152 assert!(rendered.contains("name=retention.ms, value=604800000"), "{rendered}");
153 assert!(!rendered.contains(SECRET), "secret leaked: {rendered}");
154 }
155
156 #[test]
161 fn debug_redacts_sensitive_values() {
162 let config = config_with_secret();
163 for rendered in [format!("{config:?}"), format!("{config:#?}")] {
164 for entry in config.entries() {
165 assert!(rendered.contains(&entry.to_string()), "{rendered}");
166 }
167 assert!(rendered.starts_with("Config"), "{rendered}");
168 assert!(rendered.contains("name=ssl.truststore.password, value=Redacted"), "{rendered}");
169 assert!(rendered.contains("name=retention.ms, value=604800000"), "{rendered}");
170 assert!(!rendered.contains(SECRET), "secret leaked: {rendered}");
171 }
172 }
173}