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 436 437 438 439 440 441
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::setting_defaults::*;
/// All settings which are used by both, the client and the daemon
#[derive(PartialEq, Eq, Clone, Debug, Default, Deserialize, Serialize)]
pub struct Shared {
/// Don't access this property directly, but rather use the getter with the same name.
/// It's only public to allow proper integration testing.
///
/// The directory that is used for all of pueue's state. \
/// I.e. task logs, state dumps, etc.
pub pueue_directory: Option<PathBuf>,
/// Don't access this property directly, but rather use the getter with the same name.
/// It's only public to allow proper integration testing.
///
/// The location where runtime related files will be placed.
/// Defaults to `pueue_directory` unless `$XDG_RUNTIME_DIR` is set.
pub runtime_directory: Option<PathBuf>,
/// Don't access this property directly, but rather use the getter with the same name.
/// It's only public to allow proper integration testing.
///
/// The location of the alias file used by the daemon/client when working with
/// aliases.
pub alias_file: Option<PathBuf>,
/// If this is set to true, unix sockets will be used.
/// Otherwise we default to TCP+TLS
#[cfg(not(target_os = "windows"))]
#[serde(default = "default_true")]
pub use_unix_socket: bool,
/// Don't access this property directly, but rather use the getter with the same name.
/// It's only public to allow proper integration testing.
///
/// The path to the unix socket.
#[cfg(not(target_os = "windows"))]
pub unix_socket_path: Option<PathBuf>,
/// The TCP hostname/ip address.
#[serde(default = "default_host")]
pub host: String,
/// The TCP port.
#[serde(default = "default_port")]
pub port: String,
/// The path where the daemon's PID is located.
/// This is by default in `runtime_directory/pueue.pid`.
pub pid_path: Option<PathBuf>,
/// Don't access this property directly, but rather use the getter with the same name.
/// It's only public to allow proper integration testing.
///
/// The path to the TLS certificate used by the daemon. \
/// This is also used by the client to verify the daemon's identity.
pub daemon_cert: Option<PathBuf>,
/// Don't access this property directly, but rather use the getter with the same name.
/// It's only public to allow proper integration testing.
///
/// The path to the TLS key used by the daemon.
pub daemon_key: Option<PathBuf>,
/// Don't access this property directly, but rather use the getter with the same name.
/// It's only public to allow proper integration testing.
///
/// The path to the file containing the shared secret used to authenticate the client.
pub shared_secret_path: Option<PathBuf>,
}
/// All settings which are used by the client
#[derive(PartialEq, Eq, Clone, Debug, Default, Deserialize, Serialize)]
pub struct Client {
/// If set to true, all tasks will be restart in place, instead of creating a new task.
/// False is the default, as you'll lose the logs of the previously failed tasks when
/// restarting tasks in place.
#[serde(default = "Default::default")]
pub restart_in_place: bool,
/// Whether the client should read the logs directly from disk or whether it should
/// request the data from the daemon via socket.
#[serde(default = "default_true")]
pub read_local_logs: bool,
/// Whether the client should show a confirmation question on potential dangerous actions.
#[serde(default = "Default::default")]
pub show_confirmation_questions: bool,
/// Whether aliases specified in `pueue_aliases.yml` should be expanded in the `pueue status`
/// or shown in their short form.
#[serde(default = "Default::default")]
pub show_expanded_aliases: bool,
/// Whether the client should use dark shades instead of regular colors.
#[serde(default = "Default::default")]
pub dark_mode: bool,
/// The max amount of lines each task get's in the `pueue status` view.
pub max_status_lines: Option<usize>,
/// The format that will be used to display time formats in `pueue status`.
#[serde(default = "default_status_time_format")]
pub status_time_format: String,
/// The format that will be used to display datetime formats in `pueue status`.
#[serde(default = "default_status_datetime_format")]
pub status_datetime_format: String,
}
/// All settings which are used by the daemon
#[derive(PartialEq, Eq, Clone, Debug, Default, Deserialize, Serialize)]
pub struct Daemon {
/// Whether a group should be paused as soon as a single task fails
#[serde(default = "Default::default")]
pub pause_group_on_failure: bool,
/// Whether the daemon (and all groups) should be paused as soon as a single task fails
#[serde(default = "Default::default")]
pub pause_all_on_failure: bool,
/// The callback that's called whenever a task finishes.
pub callback: Option<String>,
/// The amount of log lines from stdout/stderr that are passed to the callback command.
#[serde(default = "default_callback_log_lines")]
pub callback_log_lines: usize,
/// The legacy configuration for groups
#[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(),
}
}
}
/// The parent settings struct. \
/// This contains all other setting structs.
#[derive(PartialEq, Eq, Clone, Debug, Deserialize, Serialize)]
pub struct Settings {
#[serde(default = "Default::default")]
pub client: Client,
#[serde(default = "Default::default")]
pub daemon: Daemon,
pub shared: Shared,
#[serde(default = "HashMap::new")]
pub profiles: HashMap<String, NestedSettings>,
}
/// The nested settings struct for profiles. \
/// In contrast to the normal `Settings` struct, this struct doesn't allow profiles.
/// That way we prevent nested profiles and problems with self-referencing structs.
#[derive(PartialEq, Eq, Clone, Debug, Deserialize, Serialize)]
pub struct NestedSettings {
#[serde(default = "Default::default")]
pub client: Client,
#[serde(default = "Default::default")]
pub daemon: Daemon,
#[serde(default = "Default::default")]
pub shared: Shared,
}
/// Get the default config directory.
/// If no config can be found, fallback to the current directory.
pub fn configuration_directories() -> Vec<PathBuf> {
if let Some(config_dir) = dirs::config_dir() {
vec![config_dir.join("pueue"), PathBuf::from(".")]
} else {
vec![PathBuf::from(".")]
}
}
/// Little helper which expands a given path's `~` characters to a fully qualified path.
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 if let Some(path) = dirs::data_local_dir() {
path.join("pueue")
} else {
PathBuf::from("./pueue")
}
}
/// Get the current runtime directory in the following precedence.
/// 1. Config value
/// 2. Environment configuration
/// 3. Pueue directory
pub fn runtime_directory(&self) -> PathBuf {
if let Some(path) = &self.runtime_directory {
expand_home(path)
} else if let Some(path) = dirs::runtime_dir() {
path
} else {
self.pueue_directory()
}
}
/// The unix socket path can either be explicitly specified or it's simply placed in the
/// current runtime directory.
#[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()))
}
}
/// The location of the alias file used by the daemon/client when working with
/// task aliases.
pub fn alias_file(&self) -> PathBuf {
if let Some(path) = &self.alias_file {
expand_home(path)
} else if let Some(config_dir) = dirs::config_dir() {
config_dir.join("pueue_aliases.yml")
} else {
PathBuf::from("pueue_aliases.yml")
}
}
/// The daemon's pid path can either be explicitly specified or it's simply placed in the
/// current runtime directory.
pub fn pid_path(&self) -> PathBuf {
if let Some(path) = &self.pid_path {
expand_home(path)
} else {
self.runtime_directory().join("pueue.pid")
}
}
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 {
/// Try to read existing config files, while using default values for non-existing fields.
/// If successful, this will return a full config as well as a boolean on whether we found an
/// existing configuration file or not.
///
/// The default local config locations depends on the current target.
pub fn read(from_file: &Option<PathBuf>) -> Result<(Settings, bool), Error> {
// Load the config from a very specific file path
if let Some(path) = from_file {
// Open the file in read-only mode with buffer.
let file = File::open(path)
.map_err(|err| Error::IoPathError(path.clone(), "opening config file", err))?;
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");
let config_dirs = configuration_directories();
for directory in config_dirs.into_iter() {
let path = directory.join("pueue.yml");
info!("Checking path: {path:?}");
// Check if the file exists and parse it.
if path.exists() && path.is_file() {
info!("Found config file at: {path:?}");
// Open the file in read-only mode with buffer.
let file = File::open(&path)
.map_err(|err| Error::IoPathError(path, "opening config file.", err))?;
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.");
// Return a default configuration if we couldn't find a file.
Ok((Settings::default(), false))
}
/// Save the current configuration as a file to the given path. \
/// If no path is given, the default configuration path will be used. \
/// The file is then written to the main configuration directory of the respective OS.
pub fn save(&self, path: &Option<PathBuf>) -> Result<(), Error> {
let config_path = if let Some(path) = path {
path.clone()
} else if let Some(path) = dirs::config_dir() {
let path = path.join("pueue");
path.join("pueue.yml")
} else {
return Err(Error::Generic(
"Failed to resolve default config directory. User home cannot be determined."
.into(),
));
};
let config_dir = config_path
.parent()
.ok_or_else(|| Error::InvalidPath("Couldn't resolve config directory".into()))?;
// Create the config dir, if it doesn't exist yet
if !config_dir.exists() {
create_dir_all(config_dir).map_err(|err| {
Error::IoPathError(config_dir.to_path_buf(), "creating config dir", err)
})?;
}
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).map_err(|err| {
Error::IoPathError(config_dir.to_path_buf(), "creating settings file", err)
})?;
file.write_all(content.as_bytes()).map_err(|err| {
Error::IoPathError(config_dir.to_path_buf(), "writing settings file", err)
})?;
Ok(())
}
/// Try to load a profile. Error if it doesn't exist.
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::*;
/// Check if profiles get loaded correctly.
#[test]
fn test_load_profile() {
// Create some default settings and ensure that default values are loaded.
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());
// Crate a new profile with slightly different values.
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);
// Load the profile and ensure the new values are now loaded.
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");
}
/// A proper pueue [Error] should be thrown if the profile cannot be found.
#[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:?}");
}
}