cumulus 0.0.6

AWS CloudFormation Template Generator
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
127
128
129
130
131
132

use std::collections::HashMap;

use serde::Serialize;

use crate::error;

use crate::condition::Condition;
use crate::mapping::Mapping;
use crate::metadata::Metadata;
use crate::output::Output;
use crate::parameter::Parameter;
use crate::resource::{Resource, ToResource};
use crate::transform::Transform;

const AWS_TEMPLATE_FORMAT_VERSION: &str = "2010-09-09";

#[derive(Debug, Serialize)]
#[serde(rename_all = "PascalCase")]
pub struct Template {
    #[serde(rename = "AWSTemplateFormatVersion")]
    aws_template_format_version: String,
    #[serde(skip_serializing_if = "String::is_empty")]
    description: String,
    #[serde(skip_serializing_if = "HashMap::is_empty")]
    metadata: HashMap<String, Metadata>,
    #[serde(skip_serializing_if = "HashMap::is_empty")]
    parameters: HashMap<String, Parameter>,
    #[serde(skip_serializing_if = "HashMap::is_empty")]
    mappings: HashMap<String, Mapping>,
    #[serde(skip_serializing_if = "HashMap::is_empty")]
    conditions: HashMap<String, Condition>,
    #[serde(skip_serializing_if = "HashMap::is_empty")]
    transform: HashMap<String, Transform>,
    resources: HashMap<String, Resource>,
    #[serde(skip_serializing_if = "HashMap::is_empty")]
    outputs: HashMap<String, Output>,
}

impl Default for Template {
    fn default() -> Self {
        let aws_template_format_version = String::from(AWS_TEMPLATE_FORMAT_VERSION);

        Self {
            aws_template_format_version,
            description: String::new(),
            metadata: HashMap::default(),
            parameters: HashMap::default(),
            mappings: HashMap::default(),
            conditions: HashMap::default(),
            transform: HashMap::default(),
            resources: HashMap::default(),
            outputs: HashMap::default(),
        }
    }
}

impl Template {
    pub fn new() -> Self {
        Self::default()
    }

    pub fn description(&mut self, description: impl Into<String>) -> &mut Self {
        self.description = description.into();
        // See https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-description-structure.html
        self.description.truncate(1024);
        self
    }

    pub fn resource(&mut self, resource: impl ToResource) -> &mut Self {
        let name = resource.name();
        let resource = resource.into();
        self.resources.insert(name, resource);
        self
    }

    pub fn parameter(&mut self, parameter: Parameter) -> &mut Self {
        let name = parameter.name();
        self.parameters.insert(name, parameter);
        self
    }

    pub fn mapping(&mut self, name: impl Into<String>, mapping: Mapping) -> &mut Self {
        let name = name.into();
        self.mappings.insert(name, mapping);
        self
    }

    pub fn output(&mut self, name: impl Into<String>, output: Output) -> &mut Self {
        let name = name.into();
        self.outputs.insert(name, output);
        self
    }

    pub fn validate(&self) -> Result<&Self, error::Error> {
        Ok(self)
    }

    pub fn json(&self) -> String {
        serde_json::to_string(self).expect("Template must be serializable")
    }

    pub fn json_pretty(&self) -> String {
        serde_json::to_string_pretty(self).expect("Template must be serializable")
    }

    #[cfg(feature = "yaml")]
    pub fn yaml(&self) -> String {
        serde_yaml::to_string(self).expect("Template must be serializable")
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn short_description() {
        let mut template = Template::new();
        template.description("Example");
        assert_eq!(template.description, "Example");
    }

    #[test]
    fn long_description() {
        let mut template = Template::new();
        let long = "0123456789abcdef".repeat(128);
        let short = "0123456789abcdef".repeat(64);
        template.description(&long);
        assert_ne!(template.description, long);
        assert_eq!(template.description, short);
    }
}