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
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
//! the [Templates + Parameterization proposal](https://github.com/kubernetes/kubernetes/blob/master/docs/proposals/templates.md).
//!
//! The crate ships with a command line utility and a library for programmatically processing
//! manifest templates. See the [README](https://github.com/jimmycuadra/ktmpl) for documentation for
//! the command line utility, and a general overview of the Kubernetes template system.
//!
//! Here is a simple example of using the library:
//!
//! ```
//! extern crate ktmpl;
//!
//! use ktmpl::{ParameterValue, ParameterValues, Template};
//!
//! fn main() {
//!     let template_contents = r#"
//! ---
//! kind: "Template"
//! apiVersion: "v1"
//! metadata:
//!   name: "example"
//! objects:
//!   - kind: "Service"
//!     apiVersion: "v1"
//!     metadata:
//!       name: "$(DATABASE_SERVICE_NAME)"
//!     spec:
//!       ports:
//!         - name: "db"
//!           protocol: "TCP"
//!           targetPort: 3000
//!       selector:
//!         name: "$(DATABASE_SERVICE_NAME)"
//! parameters:
//!   - name: "DATABASE_SERVICE_NAME"
//!     description: "Database service name"
//!     required: true
//!     parameterType: "string"
//! "#;
//!
//!     let mut parameter_values = ParameterValues::new();
//!
//!     parameter_values.insert(
//!         "DATABASE_SERVICE_NAME".to_string(),
//!         ParameterValue::Plain("mongo".to_string()),
//!     );
//!
//!     let template = Template::new(
//!         template_contents.to_string(),
//!         parameter_values,
//!         None,
//!     ).unwrap();
//!     let processed_template = template.process().unwrap();
//!
//!     assert_eq!(
//!         processed_template.lines().map(|l| l.trim_right()).collect::<Vec<&str>>().join("\n"),
//!         r#"---
//! kind: Service
//! apiVersion: v1
//! metadata:
//!   name: mongo
//! spec:
//!   ports:
//!     - name: db
//!       protocol: TCP
//!       targetPort: 3000
//!   selector:
//!     name: mongo"#
//!     );
//! }
//! ```

#![deny(missing_debug_implementations)]
#![deny(missing_docs)]

pub use crate::{
    parameter::{
        parameter_values_from_file,
        parameter_values_from_str,
        parameter_values_from_yaml,
        ParameterValue,
        ParameterValues,
    },
    secret::{Secret, Secrets},
    template::Template,
};

mod parameter;
mod processor;
mod secret;
mod template;

#[cfg(test)]
mod tests {
    use std::fs::File;
    use std::io::Read;

    use super::{
        parameter_values_from_file,
        ParameterValue,
        ParameterValues,
        Secret,
        Secrets,
        Template,
    };

    #[test]
    fn process_keys() {
        let template_contents = r#"
---
objects:
    - $(FOO): bar
parameters:
  - name: FOO
    value: baz
"#;
        let template = Template::new(
            template_contents.to_string(),
            ParameterValues::new(),
            None,
        )
        .unwrap();

        let processed_template = template.process().unwrap();

        assert_eq!(
            processed_template
                .lines()
                .map(|l| l.trim_end())
                .collect::<Vec<&str>>()
                .join("\n"),
            r#"---
baz: bar"#
        );
    }

    #[test]
    fn encode_secrets() {
        let template_contents = r#"
---
kind: "Template"
apiVersion: "v1"
metadata:
  name: "example"
objects:
  - kind: "Secret"
    apiVersion: "v1"
    metadata:
      name: "webapp"
    data:
      config.yml: |
        username: "carl"
        password: "$(PASSWORD)"
    type: "Opaque"
parameters:
  - name: "PASSWORD"
    description: "The password for the web app"
    required: true
    parameterType: "string"
"#;

        let mut parameter_values = ParameterValues::new();

        parameter_values.insert(
            "PASSWORD".to_string(),
            ParameterValue::Plain("narble".to_string()),
        );

        let mut secrets = Secrets::new();

        secrets.insert(Secret {
            name: "webapp".to_string(),
            namespace: "default".to_string(),
        });

        let template = Template::new(
            template_contents.to_string(),
            parameter_values,
            Some(secrets),
        )
        .unwrap();

        let processed_template = template.process().unwrap();

        assert_eq!(
            processed_template
                .lines()
                .map(|l| l.trim_end())
                .collect::<Vec<&str>>()
                .join("\n"),
            r#"---
kind: Secret
apiVersion: v1
metadata:
  name: webapp
data:
  config.yml: dXNlcm5hbWU6ICJjYXJsIgpwYXNzd29yZDogIm5hcmJsZSIK
type: Opaque"#
        );
    }

    #[test]
    fn missing_secret() {
        let template_contents = r#"
---
kind: "Template"
apiVersion: "v1"
metadata:
  name: "example"
objects:
  - kind: "Namespace"
    apiVersion: "v1"
    metadata:
      name: "$(NAMESPACE)"
parameters:
  - name: "NAMESPACE"
    description: "The namespace to create"
    required: true
    parameterType: "string"
"#;

        let mut parameter_values = ParameterValues::new();

        parameter_values.insert(
            "NAMESPACE".to_string(),
            ParameterValue::Plain("foo".to_string()),
        );

        let mut secrets = Secrets::new();

        secrets.insert(Secret {
            name: "ghost".to_string(),
            namespace: "default".to_string(),
        });

        let template = Template::new(
            template_contents.to_string(),
            parameter_values,
            Some(secrets),
        )
        .unwrap();

        assert!(template.process().is_err());
    }

    #[test]
    fn parameter_file() {
        let mut template_file = File::open("example.yml").unwrap();
        let mut template_contents = String::new();

        template_file
            .read_to_string(&mut template_contents)
            .unwrap();

        let parameter_values = parameter_values_from_file("params.yml").unwrap();

        let template =
            Template::new(template_contents.to_string(), parameter_values, None).unwrap();

        let processed_template = template.process().unwrap();

        assert_eq!(
            processed_template
                .lines()
                .map(|l| l.trim_end())
                .collect::<Vec<&str>>()
                .join("\n"),
            r#"---
kind: Service
apiVersion: v1
metadata:
  name: mongodb
spec:
  ports:
    - name: mongo
      protocol: TCP
      targetPort: 27017
  selector:
    name: mongodb
---
kind: ReplicationController
apiVersion: v1
metadata:
  name: mongodb
spec:
  replicas: 2
  selector:
    name: mongodb
  template:
    metadata:
      creationTimestamp: ~
      labels:
        name: mongodb
    spec:
      containers:
        - name: mongodb
          image: docker.io/centos/mongodb-26-centos7
          ports:
            - containerPort: 27017
              protocol: TCP
          env:
            - name: MONGODB_USER
              value: carl
            - name: MONGODB_PASSWORD
              value: c2VjcmV0
            - name: MONGODB_DATABASE
              value: sampledb"#
        );
    }
}