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
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
#![allow(non_snake_case)]
use kube_derive::CustomResource;
use semver::Version;
use std::collections::{BTreeMap, BTreeSet};
use crate::teams;
#[allow(unused_imports)] use std::path::{Path, PathBuf};
#[allow(unused_imports)] use super::{Error, Result};
use crate::{
region::{Environment, Region},
states::ConfigState,
};
#[derive(Serialize, Deserialize, Debug, Clone)]
#[cfg_attr(feature = "filesystem", serde(deny_unknown_fields))]
pub struct Cluster {
pub name: String,
pub api: String,
#[serde(default)]
pub teleport: Option<String>,
#[serde(default)]
pub clustername: Option<String>,
pub regions: Vec<String>,
}
#[derive(Serialize, Deserialize, Debug, Clone)]
#[cfg_attr(feature = "filesystem", serde(deny_unknown_fields))]
pub struct Location {
pub name: String,
pub global_region: String,
pub local_region: String,
}
#[derive(Serialize, Deserialize, Debug, Clone)]
#[cfg_attr(feature = "filesystem", serde(deny_unknown_fields))]
pub struct GithubParameters {
pub organisation: String,
}
#[derive(Serialize, Deserialize, Debug, Clone)]
#[cfg_attr(feature = "filesystem", serde(deny_unknown_fields))]
pub struct SlackParameters {
pub team: String,
}
#[derive(CustomResource, Serialize, Deserialize, Debug, Clone)]
#[kube(
group = "babylontech.co.uk",
kind = "ShipcatConfig",
version = "v1",
namespaced
)]
#[kube(apiextensions = "v1beta1")]
#[cfg_attr(feature = "filesystem", serde(deny_unknown_fields))]
pub struct Config {
#[serde(default)]
#[cfg(feature = "filesystem")]
pub defaults: serde_yaml::Value,
pub clusters: BTreeMap<String, Cluster>,
#[serde(default)]
pub contextAliases: BTreeMap<String, String>,
regions: Vec<Region>,
#[serde(default)]
pub locations: BTreeMap<String, Location>,
pub slack: SlackParameters,
pub github: GithubParameters,
#[serde(default)]
pub allowedLabels: Vec<String>,
#[serde(default)]
pub allowedCustomMetadata: BTreeSet<String>,
pub versions: BTreeMap<Environment, Version>,
#[serde(default)]
pub owners: teams::Owners,
#[serde(default, skip_serializing, skip_deserializing)]
state: ConfigState,
}
impl Config {
pub fn verify(&self) -> Result<()> {
for (cname, clst) in &self.clusters {
if cname != &clst.name {
bail!(
"clust '{}' must have a '.name' equal to its key in clusters",
cname
);
}
#[cfg(feature = "filesystem")]
for r in &clst.regions {
if !self.has_region(r) && self.state == ConfigState::File {
bail!("cluster {} defines undefined region {}", cname, r);
}
}
}
for (k, v) in &self.contextAliases {
if !self.has_region(v) {
bail!("context alias {} points to undefined region {}", k, v);
}
if self.has_region(k) {
bail!("cannot self-alias region {}", k);
}
}
let mut used_kong_urls = vec![];
for r in &self.regions {
if r.namespace == "" {
bail!("Need to set `namespace` in {}", r.name);
}
if r.cluster == "" {
bail!("Need to set the serving `cluster` of {}", r.name);
}
if !self.clusters.keys().any(|c| c == &r.cluster) {
bail!("Region {} served by missing cluster '{}'", r.name, r.cluster);
}
r.vault.verify(&r.name)?;
for v in r.base_urls.values() {
if v.ends_with('/') {
bail!("A base_url must not end with a slash");
}
}
if let Some(kong) = &r.kong {
kong.verify()?;
if used_kong_urls.contains(&kong.config_url) {
bail!("Cannot reuse kong config urls for {} across regions", r.name);
}
used_kong_urls.push(kong.config_url.clone());
}
}
Ok(())
}
#[cfg(feature = "filesystem")]
pub fn verify_version_pin(&self, env: &Environment) -> Result<()> {
let pin = self.get_appropriate_version_pin(env)?;
debug!("Verifying version pin: {} for {}", pin, env.to_string());
Config::bail_on_version_older_than(&pin)
}
#[cfg(feature = "filesystem")]
pub fn get_appropriate_version_pin(&self, env: &Environment) -> Result<Version> {
let pin = self.versions.get(&env).unwrap_or_else(|| {
debug!("No version pin for environment {:?} - assuming maximum", env);
self.versions
.values()
.max()
.expect("a version pin exists in shipcat.conf")
});
Ok(pin.clone())
}
#[cfg(feature = "filesystem")]
pub fn bail_on_version_older_than(pin: &Version) -> Result<()> {
let current = Version::parse(env!("CARGO_PKG_VERSION")).unwrap();
if *pin > current {
let releasesurl = "https://github.com/babylonhealth/shipcat/releases";
let brewurl = "https://github.com/babylonhealth/homebrew-babylon";
let install = format!(
"Precompiled releases for mac/linux from {} installeable via:
\tshipcat self-upgrade
",
releasesurl
);
let brewinstall = format!(
"Homebrew managed mac releases from {} installeable via:
\tbrew update && brew upgrade shipcat
",
brewurl
);
bail!(
"Your shipcat is out of date ({} < {})\n{}\n{}",
current,
pin,
install,
brewinstall
)
}
Ok(())
}
pub fn print(&self) -> Result<()> {
println!("{}", serde_yaml::to_string(self)?);
Ok(())
}
pub fn list_regions(&self) -> Vec<String> {
self.regions.iter().map(|r| r.name.clone()).collect()
}
#[cfg(feature = "filesystem")]
async fn secrets(&mut self, region: &str) -> Result<()> {
assert_eq!(self.state, ConfigState::Base);
assert_eq!(self.regions.len(), 1);
self.state = ConfigState::Filtered;
if let Some(idx) = self.regions.iter().position(|r| r.name == region) {
self.regions[idx].secrets().await?;
} else {
bail!("Region {} does not exist in the config", region)
}
Ok(())
}
pub fn resolve_cluster(&self, ctx: &str, cluster: Option<String>) -> Result<(Cluster, Region)> {
let reg = self.get_region(ctx)?;
if let Some(c) = cluster {
if let Some(c) = self.clusters.get(&c) {
return Ok((c.clone(), reg));
} else {
bail!("Specified cluster '{}' does not exist in shipcat.conf", c);
}
}
let candidates = self
.clusters
.values()
.cloned()
.filter(|v| v.regions.contains(®.name))
.collect::<Vec<_>>();
if candidates.len() != 1 {
bail!(
"Ambiguous context {} served by more than one cluster - please specify -c cluster",
ctx
);
}
Ok((candidates[0].clone(), reg))
}
pub fn has_secrets(&self) -> bool {
self.state == ConfigState::Filtered
}
fn resolve_context(&self, ctx: String) -> Option<String> {
if self.has_region(&ctx) {
Some(ctx)
}
else {
self.contextAliases.get(&ctx).map(|a| a.to_string())
}
}
fn has_region(&self, region: &str) -> bool {
self.regions.iter().any(|r| r.name == region)
}
pub fn get_region(&self, ctx: &str) -> Result<Region> {
if let Some(region) = self.resolve_context(ctx.to_string()) {
return Ok(self.regions.iter().find(|r| r.name == region).unwrap().clone());
}
bail!(
"You need to define your kube context '{}' in shipcat.conf regions first",
ctx
)
}
pub fn get_regions(&self) -> Vec<Region> {
self.regions.clone()
}
pub fn find_owning_cluster(&self, region: &Region) -> Option<Cluster> {
for c in self.clusters.values() {
if c.regions.iter().any(|r| r == ®ion.name) {
if c.name != region.cluster {
warn!("Inactive cluster: {} for {}", c.name, region.name);
} else {
return Some(c.clone());
}
}
}
None
}
}
#[derive(Deserialize)]
pub struct ConfigFallback {
pub versions: BTreeMap<Environment, Version>,
}
impl ConfigFallback {
fn read() -> Result<ConfigFallback> {
use std::fs;
let pwd = Path::new(".");
let mpath = pwd.join("shipcat.conf");
let data = fs::read_to_string(&mpath)?;
let vc: ConfigFallback = serde_yaml::from_str(&data)?;
Ok(vc)
}
pub fn find_upgradeable_version() -> Result<Option<Version>> {
let fb = match Self::read() {
Ok(cfg) => cfg,
Err(e) => {
error!("shipcat.conf versions unreadable - manifests out of date?");
bail!("shipcat.conf could not be read even in fallback mode: {}", e);
}
};
match fb.versions.values().min() {
None => bail!("Failed to understand version pin in shipcat.conf - needs at least one pin"),
Some(lowest) => {
let current = Version::parse(env!("CARGO_PKG_VERSION")).unwrap();
if *lowest > current {
return Ok(Some(lowest.to_owned()));
}
}
}
Ok(None)
}
}
#[cfg(feature = "filesystem")]
impl Config {
pub async fn new(state: ConfigState, context: &str) -> Result<(Config, Region)> {
let mut conf = Self::read().await?;
let region = if let Some(r) = conf.resolve_context(context.to_string()) {
r
} else {
error!("Please use an existing kube context or add your current context to shipcat.conf");
bail!(
"The current kube context ('{}') is not defined in shipcat.conf",
context
);
};
if state == ConfigState::Filtered || state == ConfigState::Base {
conf.remove_redundant_regions(®ion)?;
} else if state != ConfigState::UnionisedBase {
bail!("Config::new only supports Filtered, Base and UnionisedBase types");
}
if state == ConfigState::Filtered {
conf.secrets(®ion).await?;
}
let reg = conf.get_region(®ion)?;
Ok((conf, reg))
}
async fn read_from(pwd: &PathBuf) -> Result<Config> {
use tokio::fs;
let mpath = pwd.join("shipcat.conf");
trace!("Using config in {}", mpath.display());
if !mpath.exists() {
bail!("Config file {} does not exist", mpath.display())
}
let data = fs::read_to_string(&mpath).await?;
let res = serde_yaml::from_str(&data)?;
Ok(res)
}
pub async fn read() -> Result<Config> {
let pwd = Path::new(".");
let mut conf = Config::read_from(&pwd.to_path_buf()).await?;
conf.owners = teams::Owners::read()?;
Ok(conf)
}
pub fn has_all_regions(&self) -> bool {
self.state == ConfigState::File
}
pub fn get_region_unchecked(&self, region: &str) -> Option<&Region> {
assert!(self.has_all_regions());
self.regions.iter().find(|r| r.name == region)
}
fn remove_redundant_regions(&mut self, region: &str) -> Result<()> {
assert_eq!(self.state, ConfigState::File);
assert!(self.has_region(region));
let r = region.to_string();
self.clusters = self
.clusters
.clone()
.into_iter()
.filter(|(_, c)| c.regions.contains(&r))
.collect();
self.contextAliases = self
.contextAliases
.clone()
.into_iter()
.filter(|(_, v)| v == region)
.collect();
self.regions = self
.regions
.clone()
.into_iter()
.filter(|r| r.name == region)
.collect();
self.state = ConfigState::Base;
Ok(())
}
}
#[cfg(test)]
mod tests {
use crate::region::VersionScheme;
#[test]
fn version_validate_test() {
let scheme = VersionScheme::GitShaOrSemver;
assert!(scheme.verify("2.3.4").is_ok());
assert!(scheme.verify("2.3.4-alpine").is_ok());
assert!(scheme.verify("e7c1e5dd5de74b2b5da5eef76eb5bf12bdc2ac19").is_ok());
assert!(scheme.verify("e7c1e5dd5de74b2b5da").is_err());
assert!(scheme.verify("1.0").is_err());
assert!(scheme.verify("v1.0.0").is_err());
let svscheme = VersionScheme::Semver;
assert!(svscheme.verify("2.3.4").is_ok());
assert!(svscheme
.verify("e7c1e5dd5de74b2b5da5eef76eb5bf12bdc2ac19")
.is_err());
}
}