auberge 0.14.18

CLI tool for managing self-hosted infrastructure with Ansible
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
use crate::ansible_assets::AnsibleAssets;
use eyre::{Result, WrapErr};
use std::collections::HashMap;
use std::path::PathBuf;

#[derive(Debug, Clone)]
pub struct PlaybookRun {
    pub path: PathBuf,
    pub tags: Vec<String>,
}

impl PlaybookRun {
    /// `true` when this run targets the apps playbook (`apps.yml`).
    pub fn is_apps(&self) -> bool {
        self.path
            .file_name()
            .and_then(|n| n.to_str())
            .is_some_and(|n| n == "apps.yml")
    }
}

fn parse_playbook_roles(playbook_path: &PathBuf) -> Result<Vec<(String, Vec<String>)>> {
    let content = std::fs::read_to_string(playbook_path)
        .wrap_err_with(|| format!("Failed to read playbook: {}", playbook_path.display()))?;

    let docs: Vec<serde_yaml::Value> = serde_yaml::from_str(&content)
        .wrap_err_with(|| format!("Failed to parse playbook: {}", playbook_path.display()))?;

    let mut roles = Vec::new();
    for doc in &docs {
        if let Some(play_roles) = doc.get("roles").and_then(|r| r.as_sequence()) {
            for role in play_roles {
                let role_name = role
                    .get("role")
                    .and_then(|r| r.as_str())
                    .unwrap_or_default()
                    .to_string();

                let tags: Vec<String> = role
                    .get("tags")
                    .and_then(|t| t.as_sequence())
                    .map(|seq| {
                        seq.iter()
                            .filter_map(|v| v.as_str().map(String::from))
                            .collect()
                    })
                    .unwrap_or_default();

                if !role_name.is_empty() {
                    roles.push((role_name, tags));
                }
            }
        }
    }

    Ok(roles)
}

fn build_tag_playbook_map() -> Result<HashMap<String, Vec<PathBuf>>> {
    let playbooks_dir = AnsibleAssets::prepare()?.playbooks_dir();
    let mut tag_map: HashMap<String, Vec<PathBuf>> = HashMap::new();

    for filename in PLAYBOOK_ORDER {
        let path = playbooks_dir.join(filename);
        if !path.exists() {
            continue;
        }

        let canonical = std::fs::canonicalize(&path)
            .wrap_err_with(|| format!("Failed to canonicalize: {}", path.display()))?;

        let roles = parse_playbook_roles(&canonical)?;
        for (role_name, tags) in roles {
            tag_map
                .entry(role_name)
                .or_default()
                .push(canonical.clone());
            for tag in tags {
                let entry = tag_map.entry(tag).or_default();
                if !entry.contains(&canonical) {
                    entry.push(canonical.clone());
                }
            }
        }
    }

    Ok(tag_map)
}

const PLAYBOOK_ORDER: &[&str] = &["hardening.yml", "infrastructure.yml", "apps.yml"];

/// Resolves `name` to a standalone playbook (one outside [`PLAYBOOK_ORDER`]),
/// excluding `.meta.yml` sidecars.
pub fn find_standalone_playbook(name: &str) -> Result<Option<PathBuf>> {
    if name.ends_with(".meta") || name.contains(['/', '\\']) {
        return Ok(None);
    }

    let playbooks_dir = AnsibleAssets::prepare()?.playbooks_dir();
    for ext in ["yml", "yaml"] {
        let filename = format!("{name}.{ext}");
        if PLAYBOOK_ORDER.contains(&filename.as_str()) {
            return Ok(None);
        }
        let path = playbooks_dir.join(&filename);
        if path.is_file() {
            let canonical = std::fs::canonicalize(&path)
                .wrap_err_with(|| format!("Failed to canonicalize: {}", path.display()))?;
            return Ok(Some(canonical));
        }
    }

    Ok(None)
}

fn playbook_role_names(filename: &str) -> Result<Vec<String>> {
    let playbooks_dir = AnsibleAssets::prepare()?.playbooks_dir();
    let path = playbooks_dir.join(filename);
    if !path.exists() {
        return Ok(Vec::new());
    }
    let canonical = std::fs::canonicalize(&path)
        .wrap_err_with(|| format!("Failed to canonicalize: {}", path.display()))?;
    let roles = parse_playbook_roles(&canonical)?;
    Ok(roles.into_iter().map(|(name, _)| name).collect())
}

pub fn get_app_names() -> Result<Vec<String>> {
    playbook_role_names("apps.yml")
}

pub fn get_infrastructure_role_names() -> Result<Vec<String>> {
    playbook_role_names("infrastructure.yml")
}

pub fn resolve_tags_to_playbook_runs(tags: &[String]) -> Result<(Vec<PlaybookRun>, Vec<String>)> {
    let tag_map = build_tag_playbook_map()?;

    let mut playbook_tags: HashMap<PathBuf, Vec<String>> = HashMap::new();
    let mut has_apps = false;
    let mut unknown_tags: Vec<String> = Vec::new();

    for tag in tags {
        if let Some(playbook_paths) = tag_map.get(tag) {
            for playbook_path in playbook_paths {
                let filename = playbook_path
                    .file_name()
                    .and_then(|n| n.to_str())
                    .unwrap_or("");

                if filename == "apps.yml" {
                    has_apps = true;
                }

                playbook_tags
                    .entry(playbook_path.clone())
                    .or_default()
                    .push(tag.clone());
            }
        } else {
            unknown_tags.push(tag.clone());
        }
    }

    if has_apps {
        let playbooks_dir = AnsibleAssets::prepare()?.playbooks_dir();
        let infra = playbooks_dir.join("infrastructure.yml");
        if infra.exists() {
            let canonical = std::fs::canonicalize(&infra)?;
            playbook_tags.entry(canonical).or_default().clear();
        }
    }

    let mut runs: Vec<PlaybookRun> = Vec::new();
    for playbook_name in PLAYBOOK_ORDER {
        for (path, tags) in &playbook_tags {
            let filename = path.file_name().and_then(|n| n.to_str()).unwrap_or("");
            if filename == *playbook_name {
                runs.push(PlaybookRun {
                    path: path.clone(),
                    tags: tags.clone(),
                });
            }
        }
    }

    Ok((runs, unknown_tags))
}

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

    #[test]
    fn test_parse_playbook_roles_apps() {
        let playbooks_dir = AnsibleAssets::prepare().unwrap().playbooks_dir();
        let apps_path = std::fs::canonicalize(playbooks_dir.join("apps.yml")).unwrap();
        let roles = parse_playbook_roles(&apps_path).unwrap();

        let role_names: Vec<&str> = roles.iter().map(|(name, _)| name.as_str()).collect();
        assert!(role_names.contains(&"paperless"));
        assert!(role_names.contains(&"baikal"));
        assert!(role_names.contains(&"freshrss"));
        assert!(role_names.contains(&"gokapi"));
    }

    #[test]
    fn test_parse_playbook_roles_infrastructure() {
        let playbooks_dir = AnsibleAssets::prepare().unwrap().playbooks_dir();
        let infra_path = std::fs::canonicalize(playbooks_dir.join("infrastructure.yml")).unwrap();
        let roles = parse_playbook_roles(&infra_path).unwrap();

        let role_names: Vec<&str> = roles.iter().map(|(name, _)| name.as_str()).collect();
        assert!(role_names.contains(&"caddy"));
        assert!(role_names.contains(&"tailscale"));
    }

    #[test]
    fn test_get_infrastructure_role_names() {
        let roles = get_infrastructure_role_names().unwrap();
        assert!(roles.contains(&"caddy".to_string()));
        assert!(roles.contains(&"blocky".to_string()));
        assert!(roles.contains(&"headscale".to_string()));
        assert!(roles.contains(&"tailscale".to_string()));
        assert!(!roles.contains(&"paperless".to_string()));
    }

    #[test]
    fn test_build_tag_playbook_map() {
        let map = build_tag_playbook_map().unwrap();

        let paperless_playbooks = map.get("paperless").unwrap();
        assert_eq!(paperless_playbooks.len(), 1);
        assert_eq!(
            paperless_playbooks[0]
                .file_name()
                .unwrap()
                .to_str()
                .unwrap(),
            "apps.yml"
        );

        let caddy_playbooks = map.get("caddy").unwrap();
        assert_eq!(caddy_playbooks.len(), 1);
        assert_eq!(
            caddy_playbooks[0].file_name().unwrap().to_str().unwrap(),
            "infrastructure.yml"
        );
    }

    #[test]
    fn test_build_tag_playbook_map_overlapping_tags() {
        let map = build_tag_playbook_map().unwrap();

        let network_playbooks = map.get("network").unwrap();
        assert_eq!(network_playbooks.len(), 2);
        let filenames: Vec<&str> = network_playbooks
            .iter()
            .map(|p| p.file_name().unwrap().to_str().unwrap())
            .collect();
        assert!(filenames.contains(&"infrastructure.yml"));
        assert!(filenames.contains(&"apps.yml"));

        let web_playbooks = map.get("web").unwrap();
        assert_eq!(web_playbooks.len(), 2);
        let filenames: Vec<&str> = web_playbooks
            .iter()
            .map(|p| p.file_name().unwrap().to_str().unwrap())
            .collect();
        assert!(filenames.contains(&"infrastructure.yml"));
        assert!(filenames.contains(&"apps.yml"));
    }

    #[test]
    fn test_resolve_app_tag_includes_infrastructure() {
        let (runs, unknown) = resolve_tags_to_playbook_runs(&["paperless".to_string()]).unwrap();

        assert!(unknown.is_empty());
        assert_eq!(runs.len(), 2);
        assert_eq!(
            runs[0].path.file_name().unwrap().to_str().unwrap(),
            "infrastructure.yml"
        );
        assert!(runs[0].tags.is_empty());
        assert_eq!(
            runs[1].path.file_name().unwrap().to_str().unwrap(),
            "apps.yml"
        );
        assert_eq!(runs[1].tags, vec!["paperless"]);
    }

    #[test]
    fn test_resolve_infra_tag_no_apps() {
        let (runs, unknown) = resolve_tags_to_playbook_runs(&["tailscale".to_string()]).unwrap();

        assert!(unknown.is_empty());
        assert_eq!(runs.len(), 1);
        assert_eq!(
            runs[0].path.file_name().unwrap().to_str().unwrap(),
            "infrastructure.yml"
        );
        assert_eq!(runs[0].tags, vec!["tailscale"]);
    }

    #[test]
    fn test_resolve_mixed_tags_ordered() {
        let (runs, _) =
            resolve_tags_to_playbook_runs(&["tailscale".to_string(), "paperless".to_string()])
                .unwrap();

        assert_eq!(runs.len(), 2);
        assert_eq!(
            runs[0].path.file_name().unwrap().to_str().unwrap(),
            "infrastructure.yml"
        );
        assert_eq!(
            runs[1].path.file_name().unwrap().to_str().unwrap(),
            "apps.yml"
        );
    }

    #[test]
    fn test_resolve_mixed_app_and_substrate_tags_forces_untagged_infra() {
        let (runs, unknown) =
            resolve_tags_to_playbook_runs(&["paperless".to_string(), "blocky".to_string()])
                .unwrap();

        assert!(unknown.is_empty());
        assert_eq!(runs.len(), 2);
        assert_eq!(
            runs[0].path.file_name().unwrap().to_str().unwrap(),
            "infrastructure.yml"
        );
        assert!(runs[0].tags.is_empty());
        assert_eq!(
            runs[1].path.file_name().unwrap().to_str().unwrap(),
            "apps.yml"
        );
        assert_eq!(runs[1].tags, vec!["paperless"]);
    }

    #[test]
    fn test_resolve_substrate_only_tag_stays_targeted() {
        let (runs, unknown) = resolve_tags_to_playbook_runs(&["blocky".to_string()]).unwrap();

        assert!(unknown.is_empty());
        assert_eq!(runs.len(), 1);
        assert_eq!(
            runs[0].path.file_name().unwrap().to_str().unwrap(),
            "infrastructure.yml"
        );
        assert_eq!(runs[0].tags, vec!["blocky"]);
    }

    #[test]
    fn test_resolve_overlapping_tag_hits_both_playbooks() {
        let (runs, unknown) = resolve_tags_to_playbook_runs(&["network".to_string()]).unwrap();

        assert!(unknown.is_empty());
        assert_eq!(runs.len(), 2);
        assert_eq!(
            runs[0].path.file_name().unwrap().to_str().unwrap(),
            "infrastructure.yml"
        );
        assert!(runs[0].tags.is_empty());
        assert_eq!(
            runs[1].path.file_name().unwrap().to_str().unwrap(),
            "apps.yml"
        );
        assert!(runs[1].tags.contains(&"network".to_string()));
    }

    #[test]
    fn test_parse_playbook_roles_hardening() {
        let playbooks_dir = AnsibleAssets::prepare().unwrap().playbooks_dir();
        let hardening_path = std::fs::canonicalize(playbooks_dir.join("hardening.yml")).unwrap();
        let roles = parse_playbook_roles(&hardening_path).unwrap();

        let role_names: Vec<&str> = roles.iter().map(|(name, _)| name.as_str()).collect();
        assert!(role_names.contains(&"fail2ban"));
        assert!(role_names.contains(&"kernel_hardening"));
    }

    #[test]
    fn test_build_tag_playbook_map_includes_hardening() {
        let map = build_tag_playbook_map().unwrap();

        let fail2ban_playbooks = map.get("fail2ban").unwrap();
        assert_eq!(fail2ban_playbooks.len(), 1);
        assert_eq!(
            fail2ban_playbooks[0].file_name().unwrap().to_str().unwrap(),
            "hardening.yml"
        );
    }

    #[test]
    fn test_resolve_fail2ban_tag_targets_hardening() {
        let (runs, unknown) = resolve_tags_to_playbook_runs(&["fail2ban".to_string()]).unwrap();

        assert!(unknown.is_empty());
        assert_eq!(runs.len(), 1);
        assert_eq!(
            runs[0].path.file_name().unwrap().to_str().unwrap(),
            "hardening.yml"
        );
        assert_eq!(runs[0].tags, vec!["fail2ban"]);
    }

    #[test]
    fn test_resolve_unknown_tags_reported() {
        let (runs, unknown) = resolve_tags_to_playbook_runs(&["paperles".to_string()]).unwrap();

        assert!(runs.is_empty());
        assert_eq!(unknown, vec!["paperles"]);
    }

    #[test]
    fn test_find_standalone_playbook_resolves_all_standalones() {
        for name in [
            "bootstrap",
            "calibre",
            "gokapi",
            "hermes",
            "remove-radicale",
            "vibecoder",
        ] {
            let path = find_standalone_playbook(name).unwrap().unwrap();
            assert_eq!(
                path.file_name().unwrap().to_str().unwrap(),
                format!("{name}.yml")
            );
        }
    }

    #[test]
    fn test_find_standalone_playbook_excludes_aggregators() {
        for name in ["hardening", "infrastructure", "apps"] {
            assert!(find_standalone_playbook(name).unwrap().is_none());
        }
    }

    #[test]
    fn test_find_standalone_playbook_excludes_meta_sidecars() {
        assert!(find_standalone_playbook("hermes.meta").unwrap().is_none());
    }

    #[test]
    fn test_find_standalone_playbook_unknown_name() {
        assert!(find_standalone_playbook("nope").unwrap().is_none());
    }
}