ansible_module 0.2.0

Framework to write Ansible modules with Rust
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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126

/// Macros for convenient way to `exit_json` from module
///
/// # Examples
///
/// ```
/// use ansible_module::{AnsibleModule, AnsibleModuleBuilder, fail_json, exit_json};
/// use serde_json::{json, Value};
///
/// let arg_spec: Value = json!({
///     "msg": {
///         "type": "str"
///     } ,
///     "additional": {
///         "type": "int",
///         "no_log": true
///     },
/// });
///
/// let module = AnsibleModuleBuilder::new(arg_spec, None)
///     .build()
///     .unwrap_or_else(|e| fail_json!(e));
///
///
/// exit_json!(module);
/// exit_json!(module, true);
/// exit_json!(module, "msg" => json!("hello world!"));
/// exit_json!(
///     module,
///     false,
///     "msg" => json!("Already done!"),
///     "additional" => json!(52)
/// );
/// exit_json!(module, false, "msg" => json!("Already done!"));
/// ```
///
#[macro_export]
macro_rules! exit_json {
    ($self:expr, $changed:expr, $($k:literal => $v:expr),+) => {
        let mut m = ::std::collections::BTreeMap::new();
        $(
            m.insert($k.to_string(), $v);
        )+
        $self.exit_json(&m, $changed)
    };
    ($self:expr, $changed:expr) => {
        let m = ::std::collections::BTreeMap::new();
        $self.exit_json(&m, $changed)
    };
    ($self:expr, $($k:literal => $v:expr),+) => {
        let mut m = ::std::collections::BTreeMap::new();
        $(
            m.insert($k.to_string(), $v);
        )+
        $self.exit_json(&m, false)
    };
    ($self:expr) => {
        let m = ::std::collections::BTreeMap::new();
        $self.exit_json(&m, false)
    };
}

/// Macros for convenient way to `fail_json` from module
///
/// # Examples
///
/// ```
/// use ansible_module::{AnsibleModule, fail_json};
///
/// fail_json!();
/// fail_json!("Something went horribly (or not) wrong!".to_string());
/// ```
///
#[macro_export]
macro_rules! fail_json {
    ($msg: expr) => {
        AnsibleModule::fail_json($msg)
    };
    () => {
        AnsibleModule::fail_json("".to_string())
    };
}

#[cfg(test)]
mod tests {
    use crate::{AnsibleModule, AnsibleModuleBuilder, exit_json};
    use serde_json::{Value, json};
    use std::io::Write;
    use std::vec;
    use tempfile::NamedTempFile;

    #[test]
    #[should_panic(expected = r#"{"changed":false,"failed":false,"also":52,"msg":"Bye bye!"}"#)]
    fn check_exit_json_macro() {
        let input_string: String = r#"{}"#.to_string();
        let arg_spec: Value = json!({
            "api_url": {
                "type": "str"
            },
        });

        let mut file: NamedTempFile = NamedTempFile::new().unwrap();
        writeln!(file, "{input_string}").unwrap();
        let input_args: Vec<String> = vec![
            "module_name".to_string(),
            file.path().to_str().unwrap().to_string(),
        ];

        let module: AnsibleModule = AnsibleModuleBuilder::new(arg_spec, Some(input_args))
            .build()
            .unwrap();

        exit_json!(
            module,
            "msg" => json!("Bye bye!"),
            "also" => json!(52)
        );
    }

    #[test]
    #[should_panic(
        expected = r#"{"msg":"Something went horribly wrong!","changed":false,"failed":true}"#
    )]
    fn check_fail_json_macro() {
        fail_json!("Something went horribly wrong!".to_string());
    }
}