render_cdk 0.0.21

This crate provides a streamlined interface for interacting with Render, a platform that allows you to build, deploy, and scale your apps with ease.
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
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

#![allow(missing_docs)]
#![allow(unused)]
// [JSON] parsing.
use serde::{Deserialize, Serialize};

#[derive(Debug, Default, Clone, Deserialize, Serialize)]
pub struct Base {
    #[serde(rename = "type")]
    pub type_: String,
    pub name: String,
    pub repo: String,

    #[serde(rename = "ownerId")]
    pub owner_id: String,

    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(rename = "autoDeploy")]
    pub auto_deploy: Option<String>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub branch: Option<String>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub image: Option<Image>,

    #[serde(rename = "buildFilter")]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub build_filter: Option<BuildFilter>,

    #[serde(rename = "rootDir")]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub root_dir: Option<String>,

    #[serde(skip_serializing_if = "Vec::is_empty")]
    #[serde(rename = "envVars")]
    pub env_vars: Vec<EnvVar>,

    #[serde(skip_serializing_if = "Vec::is_empty")]
    #[serde(rename = "secretFiles")]
    pub secret_files: Vec<SecretFile>,

    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(rename = "serviceDetails")]
    pub service_details: Option<ServiceDetails>,

    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(rename = "healthCheckPath")]
    pub health_check_path: Option<String>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub autoscaling: Option<AutoScaling>,
}

#[derive(Debug, Default, Clone, Deserialize, Serialize)]
pub struct Template {
    #[serde(rename = "type")]
    pub type_: String,
    pub name: String,
    pub repo: String,

    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(rename = "autoDeploy")]
    pub auto_deploy: Option<String>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub branch: Option<String>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub image: Option<Image>,

    #[serde(rename = "buildFilter")]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub build_filter: Option<BuildFilter>,

    #[serde(rename = "rootDir")]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub root_dir: Option<String>,

    #[serde(skip_serializing_if = "Vec::is_empty")]
    #[serde(rename = "envVars")]
    pub env_vars: Vec<EnvVar>,

    #[serde(skip_serializing_if = "Vec::is_empty")]
    #[serde(rename = "secretFiles")]
    pub secret_files: Vec<SecretFile>,

    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(rename = "serviceDetails")]
    pub service_details: Option<ServiceDetails>,

    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(rename = "healthCheckPath")]
    pub health_check_path: Option<String>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub autoscaling: Option<AutoScaling>,
}

#[derive(Debug, Default, Clone, Deserialize, Serialize)]
pub struct Image {
    #[serde(rename = "ownerId")]
    pub owner_id: String,

    #[serde(rename = "registryCredentialId")]
    pub registry_credential_id: String,

    #[serde(rename = "imagePath")]
    pub image_path: String,
}

#[derive(Debug, Default, Clone, Deserialize, Serialize)]
pub struct BuildFilter {
    pub paths: Vec<String>,

    #[serde(rename = "ignoredPaths")]
    pub ignored_paths: Vec<String>,
}

#[derive(Debug, Default, Clone, Deserialize, Serialize)]
pub struct EnvVar {
    pub key: String,
    pub value: Option<String>,

    #[serde(rename = "generateValue")]
    pub generate_value: bool,
}

#[derive(Debug, Default, Clone, Deserialize, Serialize)]
pub struct SecretFile {
    pub name: String,
    pub content: String,
}

#[derive(Debug, Default, Clone, Deserialize, Serialize)]
pub struct ServiceDetails {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub region: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub plan: Option<String>,

    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(rename = "buildCommand")]
    pub build_command: Option<String>,

    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(rename = "preDeployCommand")]
    pub pre_deploy_command: Option<String>,

    #[serde(skip_serializing_if = "Vec::is_empty")]
    pub headers: Vec<Header>,

    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(rename = "publishPath")]
    pub publish_path: Option<String>,

    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(rename = "pullRequestPreviewsEnabled")]
    pub pull_request_previews_enabled: Option<String>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub runtime: Option<String>,

    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(rename = "numInstances")]
    pub num_instances: Option<i32>,

    #[serde(skip_serializing_if = "Vec::is_empty")]
    pub routes: Vec<Route>,

    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(rename = "envSpecificDetails")]
    pub env_specific_details: Option<EnvSpecificDetails>,
}

#[derive(Debug, Default, Clone, Deserialize, Serialize)]
pub struct EnvSpecificDetails {
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(rename = "buildCommand")]
    pub build_command: Option<String>,

    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(rename = "startCommand")]
    pub start_command: Option<String>,
}

// Autoscaling properties.
#[derive(Debug, Default, Clone, Deserialize, Serialize)]
pub struct AutoScaling {
    min: u32,
    max: u32,
    criteria: Option<Criteria>,
}

// Autoscaling criteria.
#[derive(Debug, Default, Clone, Deserialize, Serialize)]
pub struct Criteria {
    pub cpu: Option<Cpu>,
    pub memory: Option<Memory>,
}

#[derive(Debug, Default, Clone, Deserialize, Serialize)]
pub struct Cpu {
    pub percentage: u32,
}

#[derive(Debug, Default, Clone, Deserialize, Serialize)]
pub struct Memory {
    pub percentage: u32,
}

// Additional configuration i.e header, route etc.
#[derive(Debug, Default, Clone, Deserialize, Serialize)]
pub struct Header {
    pub path: String,
    pub name: String,
    pub value: String,
}

#[derive(Debug, Default, Clone, Deserialize, Serialize)]
pub struct Route {
    #[serde(rename = "type")]
    pub type_: String,
    pub source: String,
    pub destination: String,
    pub priority: u32,
}

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

    #[test]
    fn test_template_model() {
        let service_details = ServiceDetails {
            region: Some("oregon".to_owned()),
            plan: Some("starter".to_owned()),
            build_command: Some("yarn".to_owned()),
            pre_deploy_command: None,
            headers: vec![],
            publish_path: Some("./".to_owned()),
            pull_request_previews_enabled: Some("yes".to_owned()),
            runtime: Some("node".to_owned()),
            num_instances: Some(1),
            routes: vec![],
            env_specific_details: Some(EnvSpecificDetails {
                build_command: Some("yarn".to_owned()),
                start_command: Some("npm start".to_owned()),
            }),
        };

        let image = Image {
            owner_id: "usr-a1b2c3d4".to_owned(),
            registry_credential_id: "33ef574274c011e4bea40242ac11001b".to_owned(),
            image_path: "/var/lib/docker".to_owned(),
        };

        let autoscaling = AutoScaling {
            min: 1,
            max: 2,
            criteria: Some(Criteria {
                cpu: Some(Cpu { percentage: 60 }),
                memory: Some(Memory { percentage: 60 }),
            }),
        };

        let template = Template {
            type_: "web_service".to_owned(),
            name: "test_web_service".to_owned(),
            repo: "https://github.com/<username>/<repo>".to_owned(),
            auto_deploy: Some("yes".to_owned()),
            branch: Some("master".to_owned()),
            image: Some(image),
            build_filter: None,
            root_dir: Some("./".to_owned()),
            env_vars: vec![],
            secret_files: vec![],
            service_details: Some(service_details),
            health_check_path: Some("".to_owned()),
            autoscaling: Some(autoscaling),
        };

        assert_eq!(template.type_, "web_service".to_owned());
        assert_eq!(template.name, "test_web_service".to_owned());
        assert_eq!(template.auto_deploy, Some("yes".to_owned()));
        assert_eq!(
            template.repo,
            "https://github.com/<username>/<repo>".to_owned()
        );
    }
}