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
use std::collections::HashMap;
use std::fs::{create_dir_all, File};
use std::io::{prelude::*, BufReader};
use std::path::{Path, PathBuf};
use log::info;
use serde_derive::{Deserialize, Serialize};
use shellexpand::tilde;
use crate::error::Error;
use crate::platform::directories::*;
use crate::setting_defaults::*;
#[derive(PartialEq, Clone, Debug, Default, Deserialize, Serialize)]
pub struct Shared {
pub pueue_directory: Option<PathBuf>,
pub runtime_directory: Option<PathBuf>,
#[cfg(not(target_os = "windows"))]
#[serde(default = "default_true")]
pub use_unix_socket: bool,
#[cfg(not(target_os = "windows"))]
pub unix_socket_path: Option<PathBuf>,
#[serde(default = "default_host")]
pub host: String,
#[serde(default = "default_port")]
pub port: String,
pub daemon_cert: Option<PathBuf>,
pub daemon_key: Option<PathBuf>,
pub shared_secret_path: Option<PathBuf>,
}
#[derive(PartialEq, Clone, Debug, Default, Deserialize, Serialize)]
pub struct Client {
#[serde(default = "Default::default")]
pub restart_in_place: bool,
#[serde(default = "default_true")]
pub read_local_logs: bool,
#[serde(default = "Default::default")]
pub show_confirmation_questions: bool,
#[serde(default = "Default::default")]
pub show_expanded_aliases: bool,
#[serde(default = "Default::default")]
pub dark_mode: bool,
pub max_status_lines: Option<usize>,
#[serde(default = "default_status_time_format")]
pub status_time_format: String,
#[serde(default = "default_status_datetime_format")]
pub status_datetime_format: String,
}
#[derive(PartialEq, Clone, Debug, Default, Deserialize, Serialize)]
pub struct Daemon {
#[serde(default = "Default::default")]
pub pause_group_on_failure: bool,
#[serde(default = "Default::default")]
pub pause_all_on_failure: bool,
pub callback: Option<String>,
#[serde(default = "default_callback_log_lines")]
pub callback_log_lines: usize,
#[serde(skip_serializing)]
#[deprecated(
since = "1.1.0",
note = "The configuration for groups is now stored in the state."
)]
pub groups: Option<HashMap<String, i64>>,
}
impl Default for Settings {
fn default() -> Self {
Settings {
client: Client {
read_local_logs: true,
status_time_format: default_status_time_format(),
status_datetime_format: default_status_datetime_format(),
..Default::default()
},
daemon: Daemon {
callback_log_lines: default_callback_log_lines(),
..Default::default()
},
shared: Shared {
#[cfg(not(target_os = "windows"))]
use_unix_socket: true,
host: default_host(),
port: default_port(),
..Default::default()
},
profiles: HashMap::new(),
}
}
}
#[derive(PartialEq, Clone, Debug, Deserialize, Serialize)]
pub struct Settings {
pub client: Client,
pub daemon: Daemon,
pub shared: Shared,
#[serde(default = "HashMap::new")]
pub profiles: HashMap<String, NestedSettings>,
}
#[derive(PartialEq, Clone, Debug, Deserialize, Serialize)]
pub struct NestedSettings {
pub client: Client,
pub daemon: Daemon,
pub shared: Shared,
}
pub fn expand_home(old_path: &Path) -> PathBuf {
PathBuf::from(tilde(&old_path.to_string_lossy()).into_owned())
}
impl Shared {
pub fn pueue_directory(&self) -> PathBuf {
if let Some(path) = &self.pueue_directory {
expand_home(path)
} else {
default_pueue_path()
}
}
pub fn runtime_directory(&self) -> PathBuf {
if let Some(path) = &self.runtime_directory {
expand_home(path)
} else if let Some(path) = default_runtime_directory() {
path
} else {
default_pueue_path()
}
}
#[cfg(not(target_os = "windows"))]
pub fn unix_socket_path(&self) -> PathBuf {
if let Some(path) = &self.unix_socket_path {
expand_home(path)
} else {
self.runtime_directory()
.join(format!("pueue_{}.socket", whoami::username()))
}
}
pub fn daemon_cert(&self) -> PathBuf {
if let Some(path) = &self.daemon_cert {
expand_home(path)
} else {
self.pueue_directory().join("certs").join("daemon.cert")
}
}
pub fn daemon_key(&self) -> PathBuf {
if let Some(path) = &self.daemon_key {
expand_home(path)
} else {
self.pueue_directory().join("certs").join("daemon.key")
}
}
pub fn shared_secret_path(&self) -> PathBuf {
if let Some(path) = &self.shared_secret_path {
expand_home(path)
} else {
self.pueue_directory().join("shared_secret")
}
}
}
impl Settings {
pub fn read(from_file: &Option<PathBuf>) -> Result<(Settings, bool), Error> {
if let Some(path) = from_file {
if !path.exists() || !path.is_file() {
return Err(Error::FileNotFound(format!(
"Couldn't find config at path {path:?}"
)));
}
let file = File::open(path)?;
let reader = BufReader::new(file);
let settings = serde_yaml::from_reader(reader)
.map_err(|err| Error::ConfigDeserialization(err.to_string()))?;
return Ok((settings, true));
};
info!("Parsing config files");
for directory in get_config_directories().into_iter() {
let path = directory.join("pueue.yml");
info!("Checking path: {path:?}");
if path.exists() && path.is_file() {
info!("Found config file at: {path:?}");
let file = File::open(path)?;
let reader = BufReader::new(file);
let settings = serde_yaml::from_reader(reader)
.map_err(|err| Error::ConfigDeserialization(err.to_string()))?;
return Ok((settings, true));
}
}
info!("No config file found. Use default config.");
Ok((Settings::default(), false))
}
pub fn save(&self, path: &Option<PathBuf>) -> Result<(), Error> {
let config_path = if let Some(path) = path {
path.clone()
} else {
default_config_directory().join("pueue.yml")
};
let config_dir = config_path
.parent()
.ok_or_else(|| Error::InvalidPath("Couldn't resolve config directory".into()))?;
if !config_dir.exists() {
create_dir_all(config_dir)?;
}
let content = match serde_yaml::to_string(self) {
Ok(content) => content,
Err(error) => {
return Err(Error::Generic(format!(
"Configuration file serialization failed:\n{error}"
)))
}
};
let mut file = File::create(config_path)?;
file.write_all(content.as_bytes())?;
Ok(())
}
pub fn load_profile(&mut self, profile: &str) -> Result<(), Error> {
let profile = self.profiles.remove(profile).ok_or_else(|| {
Error::ConfigDeserialization(format!("Couldn't find profile with name \"{profile}\""))
})?;
self.client = profile.client;
self.daemon = profile.daemon;
self.shared = profile.shared;
Ok(())
}
}
#[cfg(test)]
mod test {
use super::*;
#[test]
fn test_load_profile() {
let mut settings = Settings::default();
assert_eq!(
settings.client.status_time_format,
default_status_time_format()
);
assert_eq!(
settings.daemon.callback_log_lines,
default_callback_log_lines()
);
assert_eq!(settings.shared.host, default_host());
let mut profile = Settings::default();
profile.client.status_time_format = "test".to_string();
profile.daemon.callback_log_lines = 100_000;
profile.shared.host = "quatschhost".to_string();
let profile = NestedSettings {
client: profile.client,
daemon: profile.daemon,
shared: profile.shared,
};
settings.profiles.insert("testprofile".to_string(), profile);
settings
.load_profile("testprofile")
.expect("We just added the profile");
assert_eq!(settings.client.status_time_format, "test");
assert_eq!(settings.daemon.callback_log_lines, 100_000);
assert_eq!(settings.shared.host, "quatschhost");
}
#[test]
fn test_error_on_missing_profile() {
let mut settings = Settings::default();
let result = settings.load_profile("doesn't exist");
let expected_error_message = "Couldn't find profile with name \"doesn't exist\"";
if let Err(Error::ConfigDeserialization(error_message)) = result {
assert_eq!(error_message, expected_error_message);
return;
}
panic!("Got unexpected result when expecting missing profile error: {result:?}");
}
}