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
mod assert;
mod command;
mod copy;
mod set_vars;
mod template;

use crate::error::{Error, ErrorKind, Result};
use crate::vars::Vars;

use std::collections::HashMap;

use serde::Serialize;
use serde_json::Value;
use yaml_rust::Yaml;

/// Return values of a [`Module`] execution.
///
/// [`Module`]: struct.Module.html
#[derive(Clone, Debug, PartialEq, Serialize)]
// ANCHOR: module_result
pub struct ModuleResult {
    /// True when the executed module changed something.
    changed: bool,
    /// The Output value will appear in logs when module is executed.
    output: Option<String>,
    /// Modules store the data they return in the Extra field.
    extra: Option<Value>,
}
// ANCHOR_END: module_result

impl ModuleResult {
    pub fn new(changed: bool, extra: Option<Value>, output: Option<String>) -> Self {
        Self {
            changed,
            extra,
            output,
        }
    }

    /// Return changed.
    pub fn get_changed(&self) -> bool {
        self.changed
    }

    /// Return extra.
    pub fn get_extra(&self) -> Option<Value> {
        self.extra.clone()
    }

    /// Return output which is printed in log.
    pub fn get_output(&self) -> Option<String> {
        self.output.clone()
    }
}

/// Basic execution structure. Build with module name and module exec function.
#[derive(Debug, Clone, PartialEq)]
pub struct Module {
    name: &'static str,
    exec_fn: fn(Yaml, Vars) -> Result<(ModuleResult, Vars)>,
}

impl Module {
    /// Return name.
    pub fn get_name(&self) -> &str {
        self.name
    }

    /// Execute `self.exec_fn`.
    pub fn exec(&self, params: Yaml, vars: Vars) -> Result<(ModuleResult, Vars)> {
        (self.exec_fn)(params, vars)
    }

    #[cfg(test)]
    pub fn test_example() -> Self {
        Module {
            name: "test",
            exec_fn: |_, _| {
                Ok((
                    ModuleResult {
                        changed: true,
                        extra: None,
                        output: None,
                    },
                    Vars::new(),
                ))
            },
        }
    }
}

lazy_static! {
    pub static ref MODULES: HashMap<&'static str, Module> = {
        vec![
            (
                "assert",
                Module {
                    name: "assert",
                    exec_fn: assert::exec,
                },
            ),
            (
                "command",
                Module {
                    name: "command",
                    exec_fn: command::exec,
                },
            ),
            (
                "copy",
                Module {
                    name: "copy",
                    exec_fn: copy::exec,
                },
            ),
            (
                "set_vars",
                Module {
                    name: "set_vars",
                    exec_fn: set_vars::exec,
                },
            ),
            (
                "template",
                Module {
                    name: "template",
                    exec_fn: template::exec,
                },
            ),
        ]
        .into_iter()
        .collect::<HashMap<&'static str, Module>>()
    };
}

#[inline(always)]
pub fn is_module(module: &str) -> bool {
    MODULES.get(module).is_some()
}

#[inline]
fn get_key(yaml: &Yaml, key: &str) -> Result<Yaml> {
    if yaml[key].is_badvalue() {
        Err(Error::new(
            ErrorKind::NotFound,
            format!("param {} not found in: {:?}", key, yaml),
        ))
    } else {
        Ok(yaml[key].clone())
    }
}

/// Get param from [`Yaml`] with `rash` [`Error`] wrappers.
///
/// # Example
/// ```ignore
/// let param = get_param(&yaml, "foo").unwrap();
/// assert_eq!(param, "boo");
/// ```
/// [`Yaml`]: ../../yaml_rust/struct.Yaml.
/// [`Error`]: ../error/struct.Error.html
#[inline]
pub fn get_param(yaml: &Yaml, key: &str) -> Result<String> {
    match get_key(yaml, key)?.as_str() {
        Some(s) => Ok(s.to_string()),
        None => Err(Error::new(
            ErrorKind::InvalidData,
            format!("param '{}' not valid string in: {:?}", key, yaml),
        )),
    }
}

/// Get param from [`Yaml`] with `rash` [`Error`] wrappers.
///
/// # Example
/// ```ignore
/// let param = get_param_bool(&yaml, "foo").unwrap();
/// assert_eq!(param, true);
/// ```
/// [`Yaml`]: ../../yaml_rust/struct.Yaml.
/// [`Error`]: ../error/struct.Error.html
#[inline]
pub fn get_param_bool(yaml: &Yaml, key: &str) -> Result<bool> {
    match get_key(yaml, key)?.as_bool() {
        Some(x) => Ok(x),
        None => Err(Error::new(
            ErrorKind::InvalidData,
            format!("param '{}' not valid boolean in: {:?}", key, yaml),
        )),
    }
}

/// Get param from [`Yaml`] with `rash` [`Error`] wrappers.
///
/// # Example
/// ```ignore
/// let param = get_param_list(&yaml, "foo").unwrap();
/// assert_eq!(param, vec!["1 == 1"]);
/// ```
/// [`Yaml`]: ../../yaml_rust/struct.Yaml.
/// [`Error`]: ../error/struct.Error.html
#[inline]
pub fn get_param_list(yaml: &Yaml, key: &str) -> Result<Vec<String>> {
    match get_key(yaml, key)?.as_vec() {
        Some(x) => Ok(x
            .iter()
            .map(|yaml| match yaml.as_str() {
                Some(s) => Ok(s.to_string()),
                None => Err(Error::new(
                    ErrorKind::InvalidData,
                    format!("{:?} is not a valid string", &yaml),
                )),
            })
            .collect::<Result<Vec<String>>>()?),
        None => Err(Error::new(
            ErrorKind::InvalidData,
            format!("param '{}' not valid boolean in: {:?}", key, yaml),
        )),
    }
}