shikane 1.0.1

dynamic output configuration tool focusing on accuracy and determinism
Documentation 
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

use std::collections::VecDeque;
use std::path::PathBuf;
use std::time::Duration;

#[allow(unused_imports)]
use log::{debug, error, info, trace, warn};
use serde::{Deserialize, Serialize};
use snafu::{prelude::*, Location};
use xdg::BaseDirectories;

use crate::daemon::ShikaneArgs;
use crate::error;
use crate::profile::Profile;

#[derive(Clone, Debug)]
pub struct Settings {
    pub profiles: VecDeque<Profile>,
    pub skip_tests: bool,
    pub oneshot: bool,
    pub timeout: Duration,
    pub config_path: PathBuf,
}

#[derive(Default, Debug, Serialize, Deserialize)]
pub struct SettingsToml {
    pub timeout: Option<u64>,
    #[serde(default, rename = "profile")]
    pub profiles: VecDeque<Profile>,
}

impl Settings {
    pub fn from_args(args: ShikaneArgs) -> Self {
        let (config, path) = match parse_settings_toml(args.config) {
            Ok(config) => config,
            Err(err) => {
                error!("{}", error::report(err.as_ref()));
                std::process::exit(1);
            }
        };

        let timeout = config.timeout.unwrap_or(args.timeout);

        Self {
            profiles: config.profiles,
            skip_tests: args.skip_tests,
            oneshot: args.oneshot,
            timeout: Duration::from_millis(timeout),
            config_path: path,
        }
    }

    pub fn reload_config(&mut self, config: Option<PathBuf>) -> Result<(), Box<dyn snafu::Error>> {
        let config = config.unwrap_or(self.config_path.clone());
        debug!("reloading config from {:?}", std::fs::canonicalize(&config));
        let (config, path) = parse_settings_toml(Some(config))?;
        self.profiles = config.profiles;
        self.config_path = path;
        Ok(())
    }
}

fn parse_settings_toml(
    config_path: Option<PathBuf>,
) -> Result<(SettingsToml, PathBuf), Box<dyn snafu::Error>> {
    let config_path = match config_path {
        None => {
            let xdg_dirs = BaseDirectories::with_prefix("shikane").context(BaseDirectoriesCtx)?;
            xdg_dirs
                .place_config_file("config.toml")
                .context(ConfigPathCtx)?
        }
        Some(path) => path,
    };
    let s = std::fs::read_to_string(config_path.clone()).context(ReadConfigFileCtx)?;
    let mut config: SettingsToml = toml::from_str(&s).context(TomlDeserializeCtx)?;
    config
        .profiles
        .iter_mut()
        .enumerate()
        .for_each(|(idx, p)| p.index = idx);
    Ok((config, config_path))
}

#[derive(Debug, Snafu)]
#[snafu(context(suffix(Ctx)))]
pub enum SettingsError {
    #[snafu(display("[{location}] Problem with XDG directories"))]
    BaseDirectories {
        source: xdg::BaseDirectoriesError,
        location: Location,
    },
    #[snafu(display("[{location}] Cannot read config file"))]
    ReadConfigFile {
        source: std::io::Error,
        location: Location,
    },
    #[snafu(display("[{location}] Cannot place config file in XDG config directory"))]
    ConfigPath {
        source: std::io::Error,
        location: Location,
    },
    #[snafu(display("[{location}] Cannot deserialize settings from TOML"))]
    TomlDeserialize {
        source: toml::de::Error,
        location: Location,
    },
}