1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
use std::collections::{HashMap, HashSet};
use std::error::Error;
use std::fmt::{Debug, Display, Error as FmtError, Formatter};
use std::fs::{self, File};
use std::io::{Error as IoError, ErrorKind};
use std::net::SocketAddr;
use std::path::{Path, PathBuf};
use serde::{Deserialize, Serialize};
type ConfigResult<T> = Result<T, ConfigError>;
#[derive(Debug)]
pub struct ConfigError {
reason: String,
}
impl ConfigError {
fn new(reason: &str) -> ConfigError {
ConfigError {
reason: String::from(reason),
}
}
}
impl Display for ConfigError {
fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), FmtError> {
write!(f, "ConfigError: {}", self.reason)
}
}
impl Error for ConfigError {}
#[derive(Clone, Debug, Eq, Deserialize, Hash, Serialize, PartialEq)]
pub enum PubSubKind {
Udp(SocketAddr),
Unix,
}
#[derive(Clone, Debug, Eq, Deserialize, Hash, Serialize, PartialEq)]
pub struct PubSubEndpoint {
name: String,
config: PubSubKind,
}
impl PubSubEndpoint {
pub fn new_udp_endpoint(name: &str, addr: SocketAddr) -> PubSubEndpoint {
PubSubEndpoint {
name: String::from(name),
config: PubSubKind::Udp(addr),
}
}
pub fn new_unix_endpoint(name: &str) -> PubSubEndpoint {
PubSubEndpoint {
name: String::from(name),
config: PubSubKind::Unix,
}
}
pub fn name(&self) -> String {
self.name.clone()
}
pub fn config(&self) -> PubSubKind {
self.config.clone()
}
pub fn udp(&self) -> Option<SocketAddr> {
match &self.config {
PubSubKind::Udp(addr) => Some(*addr),
_ => None,
}
}
pub fn unix(&self) -> Option<String> {
match &self.config {
PubSubKind::Unix => Some(self.name.clone()),
_ => None,
}
}
}
#[derive(Clone, Debug, Deserialize, Serialize, PartialEq)]
pub struct Config {
rpc: HashMap<String, SocketAddr>,
pubsub: HashMap<String, HashSet<PubSubEndpoint>>,
}
impl Config {
pub fn new() -> Config {
Config {
rpc: HashMap::new(),
pubsub: HashMap::new(),
}
}
fn err_rpc_exists(&self, name: &str) -> ConfigResult<()> {
if self.rpc.contains_key(name) {
return Err(ConfigError::new(&format!("RPC exists: {}", name)));
}
Ok(())
}
pub fn add_rpc(&mut self, name: &str, addr: SocketAddr) -> ConfigResult<()> {
self.err_rpc_exists(name)?;
assert!(self.rpc.insert(String::from(name), addr).is_none());
Ok(())
}
pub fn get_rpc(&self, name: &str) -> Option<SocketAddr> {
match self.rpc.get(name) {
Some(addr) => Some(*addr),
None => None,
}
}
pub fn add_pubsub(&mut self, topic: &str, endpoint: &PubSubEndpoint) -> ConfigResult<()> {
let topic_config = self
.pubsub
.entry(String::from(topic))
.or_insert(HashSet::new());
for config in topic_config.iter() {
if config.name() == endpoint.name() {
return Err(ConfigError::new(&format!(
"Endpoint for PubSub topic {} exists: {}",
topic,
endpoint.name()
)));
}
}
topic_config.insert(endpoint.clone());
Ok(())
}
pub fn get_pubsub_endpoint(&self, topic: &str, endpoint: &str) -> Option<PubSubEndpoint> {
let topic_config = match self.get_pubsub_topic(topic) {
Some(config) => config,
None => return None,
};
for config in topic_config.iter() {
if config.name() == String::from(endpoint) {
return Some(config.clone());
}
}
None
}
pub fn get_pubsub_topic(&self, topic: &str) -> Option<HashSet<PubSubEndpoint>> {
match self.pubsub.get(topic) {
Some(config) => Some(config.clone()),
None => None,
}
}
pub fn has_pubsub(&self, topic: &str) -> bool {
self.pubsub.contains_key(topic)
}
pub fn read_yaml(path: &Path) -> Result<Config, IoError> {
let file = File::open(path)?;
match serde_yaml::from_reader(file) {
Ok(config) => Ok(config),
Err(err) => Err(IoError::new(ErrorKind::InvalidData, err)),
}
}
pub fn write_yaml(&self, path: &Path) -> Result<(), IoError> {
let file = File::create(path)?;
serde_yaml::to_writer(file, self).unwrap();
Ok(())
}
}
pub fn unix_socket_dir(run_dir: &Path) -> PathBuf {
run_dir.join("sockets")
}
pub fn initialize_run_dir(run_dir: &Path) -> bool {
let mut success = true;
let socket_dir = unix_socket_dir(run_dir);
log::trace!("Unix socket directory: {:?}", socket_dir);
if let Err(err) = fs::create_dir_all(&socket_dir) {
log::error!("Failed to create unix socket directory: {}", err);
success = false;
}
success
}
#[cfg(test)]
mod tests {
use std::io::Write;
use std::net::{IpAddr, Ipv4Addr};
use log;
use portpicker;
use super::*;
fn setup_logging() {
let _ = env_logger::builder()
.format(|buf, record| {
writeln!(
buf,
"{}:{} [{}] - {}",
record.file().unwrap_or("unknown"),
record.line().unwrap_or(0),
record.level(),
record.args()
)
})
.is_test(true)
.try_init();
}
fn pick_unused_addr() -> SocketAddr {
SocketAddr::new(
IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)),
portpicker::pick_unused_port().unwrap(),
)
}
#[test]
fn add_items_to_config() {
setup_logging();
let mut config = Config::new();
assert!(config.add_rpc("tcp", pick_unused_addr()).is_ok());
let result = config.add_rpc("tcp", pick_unused_addr());
assert!(result.is_err());
log::debug!("{}", result.err().unwrap());
let config = config;
let yaml = serde_yaml::to_string(&config).unwrap();
log::debug!("yaml:\n{}", yaml);
assert!(config.get_rpc("tcp").is_some());
let addr = config.get_rpc("tcp").unwrap();
assert!(addr.port() > 0);
}
#[test]
fn load_save_config_file() {
setup_logging();
let mut config = Config::new();
assert!(config.add_rpc("cats", pick_unused_addr()).is_ok());
assert!(config.add_rpc("dogs", pick_unused_addr()).is_ok());
assert!(config
.add_pubsub("turtles", &PubSubEndpoint::new_unix_endpoint("rabbits"))
.is_ok());
assert!(config
.add_pubsub(
"turtles",
&PubSubEndpoint::new_udp_endpoint("shell", pick_unused_addr()),
)
.is_ok());
assert!(config
.add_pubsub("coffee", &PubSubEndpoint::new_unix_endpoint("donuts"))
.is_ok());
assert!(config
.add_pubsub("coffee", &PubSubEndpoint::new_unix_endpoint("donuts"))
.is_err());
assert!(config
.add_pubsub(
"coffee",
&PubSubEndpoint::new_udp_endpoint("latte", pick_unused_addr()),
)
.is_ok());
assert!(config
.add_pubsub(
"coffee",
&PubSubEndpoint::new_udp_endpoint("mocha", pick_unused_addr()),
)
.is_ok());
let config = config;
assert!(config.get_rpc("cats").is_some());
let tempdir = tempfile::tempdir().unwrap();
let yaml_path = tempdir.path().join("config.yaml");
assert!(config.write_yaml(&yaml_path).is_ok());
let yaml = serde_yaml::to_string(&config).unwrap();
log::trace!("config:\n{}", yaml);
let recovered_config = Config::read_yaml(&yaml_path);
assert!(recovered_config.is_ok());
let recovered_config = recovered_config.unwrap();
log::trace!("recovered config: {:?}", recovered_config);
assert_eq!(recovered_config, config);
assert!(recovered_config.get_rpc("dogs").is_some());
assert!(recovered_config.get_rpc("cats").is_some());
let addr = recovered_config.get_rpc("cats").unwrap();
assert!(addr.port() > 0);
assert!(recovered_config
.get_pubsub_endpoint("turtles", "rabbits")
.is_some());
assert!(recovered_config
.get_pubsub_endpoint("turtles", "shell")
.is_some());
assert!(recovered_config
.get_pubsub_endpoint("turtles", "shells")
.is_none());
assert!(recovered_config
.get_pubsub_endpoint("coffee", "donuts")
.is_some());
assert!(recovered_config
.get_pubsub_endpoint("coffee", "latte")
.is_some());
assert!(recovered_config
.get_pubsub_endpoint("coffee", "mocha")
.is_some());
assert!(recovered_config
.get_pubsub_endpoint("coffee", "ice-cap")
.is_none());
}
#[test]
fn try_load_bad_yaml() {
setup_logging();
let tempdir = tempfile::tempdir().unwrap();
let yaml_path = tempdir.path().join("config.yaml");
{
let mut file = File::create(&yaml_path).unwrap();
file.write_all(b"invalid yaml data").unwrap();
}
let no_config = Config::read_yaml(&yaml_path);
assert!(no_config.is_err());
log::trace!("yaml error: {:?}", no_config.err());
let path_404 = tempdir.path().join("404.yaml");
let no_path = Config::read_yaml(&path_404);
assert!(no_path.is_err());
log::trace!("path error: {:?}", no_path.err());
}
#[test]
fn test_initialize_run_dir() {
let tempdir = tempfile::tempdir().unwrap();
assert!(initialize_run_dir(tempdir.path()));
let socket_dir = unix_socket_dir(tempdir.path());
assert!(socket_dir.exists());
}
}