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
use super::transform_values::TransformsValues;
use crate::error::*;
use schemars::JsonSchema;
use std::fs;
use std::path::Path;
use super::ignore_cfg::IgnoreCfg;
use super::import_cfg::ImportCfg;
use super::script_cfg::ScriptCfg;
use super::variable_cfg::VariableCfg;
#[derive(Serialize, Deserialize, Debug, Default, Clone, PartialEq, JsonSchema)]
#[serde(deny_unknown_fields, default)]
pub struct TemplateCfg {
/// list of variables/parameters of the template
pub(crate) variables: Vec<VariableCfg>,
/// list of path from the current template to ignore
pub(crate) ignores: Vec<IgnoreCfg>,
/// list of template to import and to apply as part of this template
pub(crate) imports: Vec<ImportCfg>,
/// list of the scripts to apply at end of generation
pub(crate) scripts: Vec<ScriptCfg>,
/// set to true if the template content is under a `template` folder (not mixed with metadata)
pub(crate) use_template_dir: bool,
}
impl TemplateCfg {
pub fn from_str<S>(str: S) -> Result<TemplateCfg>
where
S: AsRef<str>,
{
//let cfg = serde_json::from_str::<TemplateCfg>(str.as_ref())?;
serde_yaml::from_str::<TemplateCfg>(str.as_ref()).map_err(Error::from)
}
pub fn from_template_folder(template_base: &Path) -> Result<TemplateCfg> {
let cfg_path = template_base.join(super::TEMPLATE_CFG_FILENAME);
if cfg_path.exists() {
tracing::event!(tracing::Level::TRACE, cfg_path = ?cfg_path);
let cfg_str = fs::read_to_string(cfg_path)?;
Self::from_str(cfg_str)
} else {
Ok(TemplateCfg::default())
}
}
}
impl TransformsValues for TemplateCfg {
/// transforms ignore, imports
fn transforms_values<F>(&self, render: &F) -> Result<Self>
where
F: Fn(&str) -> String,
{
let variables = self.variables.clone();
let ignores = self.ignores.transforms_values(render)?;
let imports = self.imports.transforms_values(render)?;
let scripts = self.scripts.transforms_values(render)?;
Ok(TemplateCfg {
variables,
ignores,
imports,
scripts,
use_template_dir: self.use_template_dir,
})
}
}
#[cfg(test)]
mod tests {
use super::super::variable_cfg::VariableValueCfg;
use super::*;
use pretty_assertions::assert_eq;
// TODO provide a PR for https://github.com/dtolnay/serde-yaml/issues/86
// #[test]
// fn test_from_str_empty() {
// let cfg_str = r#"
// "#;
// let expected = TemplateCfg::default();
// let actual = TemplateCfg::from_str(cfg_str).unwrap();
// assert_eq!(&expected, &actual);
// }
#[test]
fn various_assert_equals() {
let v1_0 = Some(serde_yaml::to_value("v1").expect("yaml parsed"));
let v1_1 = Some(serde_yaml::to_value("v1").expect("yaml parsed"));
let v2_0 = Some(serde_yaml::to_value("v2").expect("yaml parsed"));
assert_eq!(&v1_0, &v1_0);
assert_eq!(&v1_0, &v1_1);
assert_ne!(&v1_0, &v2_0);
}
#[test]
fn test_deserialize_cfg_yaml() {
let cfg_str = r#"
variables:
- name: k2
default_value: v2
- name: k1
default_value: V1
- name: k3
"#;
let mut expected = TemplateCfg::default();
expected.variables.push(VariableCfg {
name: "k2".to_owned(),
default_value: Some(VariableValueCfg(
serde_yaml::to_value("v2").expect("yaml parsed"),
)),
..Default::default()
});
expected.variables.push(VariableCfg {
name: "k1".to_owned(),
default_value: Some(VariableValueCfg(
serde_yaml::to_value("V1").expect("yaml parsed"),
)),
..Default::default()
});
expected.variables.push(VariableCfg {
name: "k3".to_owned(),
..Default::default()
});
let actual = serde_yaml::from_str::<TemplateCfg>(cfg_str).unwrap();
assert_eq!(&expected.variables, &actual.variables);
assert_eq!(false, actual.use_template_dir);
}
//TODO
// #[test]
// fn test_deserialize_cfg_yaml_select() {
// let cfg_str = r#"
// variables:
// - name: k2
// select_in_values:
// - vk21
// - vk22
// - name: k1
// select_in_values: [ "vk11", "vk12" ]
// - name: k3
// select_in_values: '[ "vk31", "vk32" ]'
// - name: k4
// select_in_values: '{{ do_stuff }}'
// "#;
// let mut variables = vec![];
// variables.push(VariableCfg {
// name: "k2".to_owned(),
// select_in_values: vec![
// serde_yaml::Value::String("vk21".to_owned()),
// serde_yaml::Value::String("vk22".to_owned()),
// ],
// ..Default::default()
// });
// variables.push(VariableDef {
// name: "k1".to_owned(),
// select_in_values: vec![
// serde_yaml::Value::String("vk11".to_owned()),
// serde_yaml::Value::String("vk12".to_owned()),
// ],
// ..Default::default()
// });
// variables.push(VariableDef {
// name: "k3".to_owned(),
// select_in_values: ValuesForSelection::String("[ \"vk31\", \"vk32\" ]".to_owned()),
// ..Default::default()
// });
// expected.variables.push(VariableDef {
// name: "k4".to_owned(),
// select_in_values: ValuesForSelection::String("{{ do_stuff }}".to_owned()),
// ..Default::default()
// });
// let actual = serde_yaml::from_str::<TemplateCfg>(&cfg_str).unwrap();
// assert_eq!(&variables, &actual.variables);
// assert_eq!(false, &actual.use_template_dir);
// }
#[test]
fn test_transforms_values() {
let cfg_in_str = r#"
ignores:
- keep
- to_transform
variables:
- name: k2
default_value: v2
- name: k1
default_value: to_transform
- name: k3
scripts:
- cmd: hello to_transform
"#;
let cfg_expected_str = r#"
ignores:
- keep
- transformed
variables:
- name: k2
default_value: v2
- name: k1
default_value: to_transform
- name: k3
scripts:
- cmd: hello transformed
"#;
let cfg_in = TemplateCfg::from_str(cfg_in_str).unwrap();
let expected = TemplateCfg::from_str(cfg_expected_str).unwrap();
let render = |v: &str| v.replace("to_transform", "transformed");
let actual = cfg_in.transforms_values(&render).unwrap();
assert_eq!(&actual, &expected);
}
#[test]
fn test_deserialize_cfg_yaml_use_template_dir_false() {
let cfg_str = r#"
use_template_dir: false
"#;
let actual = serde_yaml::from_str::<TemplateCfg>(cfg_str).unwrap();
assert_eq!(false, actual.use_template_dir);
}
#[test]
fn test_deserialize_cfg_yaml_use_template_dir_true() {
let cfg_str = r#"
use_template_dir: true
"#;
let actual = serde_yaml::from_str::<TemplateCfg>(cfg_str).unwrap();
assert_eq!(true, actual.use_template_dir);
}
#[test]
fn test_accept_ignores_with_values() {
let cfg_in_str = r#"
ignores:
- "{{foo}}"
- '{{#if (eq k1 "foo")}}foo{{/if}}'
variables:
- name: k1
"#;
TemplateCfg::from_str(cfg_in_str).unwrap();
}
}