svccat 1.4.0

Detect drift between your declared service catalog and what actually lives in the repo.
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
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
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
use crate::manifest::{DiscoveryConfig, Manifest, ServiceEntry, DEFAULT_DISCOVERY_PATHS};
use anyhow::{Context, Result};
use serde::Deserialize;
use std::path::{Path, PathBuf};

// ── Backstage types (subset we care about) ────────────────────────────────────

#[derive(Debug, Deserialize)]
struct CatalogInfo {
    kind: String,
    metadata: CatalogMetadata,
    spec: Option<CatalogSpec>,
}

#[derive(Debug, Deserialize)]
struct CatalogMetadata {
    name: String,
    #[allow(dead_code)]
    description: Option<String>,
    #[serde(default)]
    #[allow(dead_code)]
    annotations: std::collections::HashMap<String, String>,
}

#[derive(Debug, Deserialize)]
struct CatalogSpec {
    #[serde(rename = "type")]
    kind_type: Option<String>,
    owner: Option<String>,
    system: Option<String>,
    #[allow(dead_code)]
    lifecycle: Option<String>,
    #[serde(rename = "dependsOn", default)]
    depends_on: Vec<String>,
}

// ── Public API ────────────────────────────────────────────────────────────────

/// Walk `root` for all `catalog-info.yaml` files, parse Backstage Component
/// entities from each, and return them as `ServiceEntry` values ready to merge
/// into a svccat manifest.
pub fn import_backstage(root: &Path) -> Result<Vec<(ServiceEntry, String)>> {
    let mut entries: Vec<(ServiceEntry, String)> = Vec::new();

    for path in find_catalog_files(root) {
        let text = std::fs::read_to_string(&path)
            .with_context(|| format!("cannot read {}", path.display()))?;

        // A single file may contain multiple YAML documents separated by "---".
        for doc in text.split("\n---") {
            let doc = doc.trim();
            if doc.is_empty() {
                continue;
            }
            let info: CatalogInfo = match serde_yaml::from_str(doc) {
                Ok(v) => v,
                Err(_) => continue, // skip non-Backstage docs silently
            };

            if !info.kind.eq_ignore_ascii_case("Component") {
                continue;
            }

            let rel_dir = path
                .parent()
                .and_then(|p| p.strip_prefix(root).ok())
                .map(|p| p.to_string_lossy().replace('\\', "/"))
                .unwrap_or_default();

            let spec = info.spec.as_ref();

            // Strip "component:<default/>:" or "group:<default/>:" prefixes from
            // depends_on entries that Backstage generates.
            let deps: Vec<String> = spec
                .map(|s| {
                    s.depends_on
                        .iter()
                        .filter_map(|d| {
                            // "component:default/auth-service" -> "auth-service"
                            d.split('/').next_back().map(str::to_owned)
                        })
                        .collect()
                })
                .unwrap_or_default();

            let svc = ServiceEntry {
                name: info.metadata.name.clone(),
                language: None,
                platform: spec.and_then(|s| s.system.clone()),
                url: None,
                role: spec.and_then(|s| s.kind_type.clone()),
                team: spec.and_then(|s| s.owner.clone()),
                oncall: None,
                submodule: None,
                path: if rel_dir.is_empty() {
                    None
                } else {
                    Some(rel_dir)
                },
                docs: None,
                ci: None,
                tags: Vec::new(),
                depends_on: deps,
            };

            let source = path.display().to_string();
            entries.push((svc, source));
        }
    }

    Ok(entries)
}

/// Merge imported service entries into an existing or new manifest and write it
/// to `output_path`.
///
/// - If `output_path` exists and `force` is false, only new services (by name)
///   are appended; existing entries are left untouched.
/// - If `force` is true the file is overwritten with the merged result.
pub fn run_backstage(root: &Path, output_path: PathBuf, force: bool) -> Result<()> {
    let imported = import_backstage(root)?;

    if imported.is_empty() {
        println!(
            "No Backstage Component entities found in {}.",
            root.display()
        );
        println!("Make sure your catalog-info.yaml files use `kind: Component`.");
        return Ok(());
    }

    // Load or bootstrap a manifest to merge into.
    let mut manifest = if output_path.exists() && !force {
        Manifest::load(&output_path)?
    } else {
        Manifest {
            version: "1".to_string(),
            discovery: DiscoveryConfig {
                paths: DEFAULT_DISCOVERY_PATHS
                    .iter()
                    .map(|s| s.to_string())
                    .collect(),
                markers: crate::manifest::default_markers_pub(),
                ignore: vec![],
            },
            policy: Default::default(),
            services: vec![],
        }
    };

    let existing_names: std::collections::HashSet<String> =
        manifest.services.iter().map(|s| s.name.clone()).collect();

    let mut added = 0usize;
    let mut skipped = 0usize;

    for (svc, source) in &imported {
        if existing_names.contains(&svc.name) {
            eprintln!(
                "  skip  '{}' already in manifest  (from {})",
                svc.name, source
            );
            skipped += 1;
        } else {
            eprintln!("  add   '{}'  (from {})", svc.name, source);
            manifest.services.push(svc.clone());
            added += 1;
        }
    }

    // Serialise back to YAML. serde_yaml produces clean output.
    let yaml = serde_yaml::to_string(&manifest).context("failed to serialise manifest to YAML")?;

    std::fs::write(&output_path, &yaml)
        .with_context(|| format!("cannot write {}", output_path.display()))?;

    println!();
    println!(
        "Wrote {} — added {}, skipped {} (already declared).",
        output_path.display(),
        added,
        skipped
    );
    println!("Run `svccat check` to verify there is no drift.");
    Ok(())
}

// ── Docker Compose types ──────────────────────────────────────────────────────

#[derive(Debug, Deserialize)]
struct DockerComposeFile {
    services: std::collections::HashMap<String, DockerComposeService>,
}

#[derive(Debug, Deserialize, Default)]
struct DockerComposeService {
    build: Option<DockerBuild>,
    #[allow(dead_code)]
    image: Option<String>,
    #[serde(default)]
    depends_on: serde_yaml::Value,
}

#[derive(Debug, Deserialize)]
#[serde(untagged)]
enum DockerBuild {
    Simple(String),
    Extended { context: String },
}

impl DockerBuild {
    fn context_path(&self) -> &str {
        match self {
            Self::Simple(s) => s.as_str(),
            Self::Extended { context } => context.as_str(),
        }
    }
}

fn parse_compose_depends_on(val: &serde_yaml::Value) -> Vec<String> {
    match val {
        serde_yaml::Value::Sequence(seq) => seq
            .iter()
            .filter_map(|v| v.as_str().map(str::to_owned))
            .collect(),
        serde_yaml::Value::Mapping(map) => map
            .iter()
            .filter_map(|(k, _)| k.as_str().map(str::to_owned))
            .collect(),
        _ => vec![],
    }
}

// ── Docker Compose public API ─────────────────────────────────────────────────

/// Parse all services from a `docker-compose.yml` / `compose.yaml` file found
/// in `root` and return them as `ServiceEntry` values.
pub fn import_docker_compose(root: &Path) -> Result<Vec<(ServiceEntry, String)>> {
    let compose_path = find_compose_file(root).ok_or_else(|| {
        anyhow::anyhow!(
            "no docker-compose.yml / compose.yaml found in {}",
            root.display()
        )
    })?;

    let text = std::fs::read_to_string(&compose_path)
        .with_context(|| format!("cannot read {}", compose_path.display()))?;

    let compose: DockerComposeFile = serde_yaml::from_str(&text)
        .with_context(|| format!("cannot parse {}", compose_path.display()))?;

    let source = compose_path.display().to_string();
    let mut entries: Vec<(ServiceEntry, String)> = Vec::new();

    let mut names: Vec<&String> = compose.services.keys().collect();
    names.sort();

    for name in names {
        let svc = &compose.services[name];

        let path = svc.build.as_ref().map(|b| {
            // Normalise "./" prefix and backslashes.
            b.context_path().trim_start_matches("./").replace('\\', "/")
        });

        let depends_on = parse_compose_depends_on(&svc.depends_on);

        entries.push((
            ServiceEntry {
                name: name.clone(),
                path,
                language: None,
                platform: None,
                url: None,
                role: None,
                team: None,
                oncall: None,
                submodule: None,
                docs: None,
                ci: None,
                tags: Vec::new(),
                depends_on,
            },
            source.clone(),
        ));
    }

    Ok(entries)
}

/// Merge docker-compose services into an existing or new manifest.
pub fn run_docker_compose(root: &Path, output_path: PathBuf, force: bool) -> Result<()> {
    let imported = import_docker_compose(root)?;

    if imported.is_empty() {
        println!("No services found in the compose file.");
        return Ok(());
    }

    let mut manifest = if output_path.exists() && !force {
        Manifest::load(&output_path)?
    } else {
        Manifest {
            version: "1".to_string(),
            discovery: DiscoveryConfig {
                paths: DEFAULT_DISCOVERY_PATHS
                    .iter()
                    .map(|s| s.to_string())
                    .collect(),
                markers: crate::manifest::default_markers_pub(),
                ignore: vec![],
            },
            policy: Default::default(),
            services: vec![],
        }
    };

    let existing_names: std::collections::HashSet<String> =
        manifest.services.iter().map(|s| s.name.clone()).collect();

    let mut added = 0usize;
    let mut skipped = 0usize;

    for (svc, source) in &imported {
        if existing_names.contains(&svc.name) {
            eprintln!(
                "  skip  '{}' already in manifest  (from {})",
                svc.name, source
            );
            skipped += 1;
        } else {
            eprintln!("  add   '{}'  (from {})", svc.name, source);
            manifest.services.push(svc.clone());
            added += 1;
        }
    }

    let yaml = serde_yaml::to_string(&manifest).context("failed to serialise manifest to YAML")?;
    std::fs::write(&output_path, &yaml)
        .with_context(|| format!("cannot write {}", output_path.display()))?;

    println!();
    println!(
        "Wrote {} — added {}, skipped {} (already declared).",
        output_path.display(),
        added,
        skipped
    );
    println!("Run `svccat check` to verify there is no drift.");
    Ok(())
}

// ── Helpers ───────────────────────────────────────────────────────────────────

fn find_catalog_files(root: &Path) -> Vec<PathBuf> {
    let pattern = root.join("**/catalog-info.yaml");
    glob::glob(&pattern.to_string_lossy())
        .into_iter()
        .flatten()
        .flatten()
        .collect()
}

fn find_compose_file(root: &Path) -> Option<PathBuf> {
    for name in &[
        "docker-compose.yml",
        "docker-compose.yaml",
        "compose.yml",
        "compose.yaml",
    ] {
        let p = root.join(name);
        if p.exists() {
            return Some(p);
        }
    }
    None
}

// ── OpenAPI / Swagger types ───────────────────────────────────────────────────

#[derive(Debug, Deserialize)]
struct OpenApiFile {
    info: OpenApiInfo,
    /// OpenAPI 3.x server list.
    servers: Option<Vec<OpenApiServer>>,
    /// Swagger 2.x host field.
    host: Option<String>,
    /// Swagger 2.x basePath field.
    #[serde(rename = "basePath")]
    base_path: Option<String>,
}

#[derive(Debug, Deserialize)]
struct OpenApiInfo {
    title: String,
    #[serde(rename = "x-team")]
    x_team: Option<String>,
    #[serde(rename = "x-oncall")]
    x_oncall: Option<String>,
    #[serde(rename = "x-language")]
    x_language: Option<String>,
}

#[derive(Debug, Deserialize)]
struct OpenApiServer {
    url: String,
}

// ── OpenAPI public API ────────────────────────────────────────────────────────

/// Walk `root` for OpenAPI / Swagger spec files and return `ServiceEntry` values.
///
/// Recognised file names: `openapi.yaml`, `openapi.yml`, `swagger.yaml`, `swagger.yml`.
/// The service name is derived from `info.title` (slugified to lowercase kebab-case).
pub fn import_openapi(root: &Path) -> Result<Vec<(ServiceEntry, String)>> {
    let mut entries: Vec<(ServiceEntry, String)> = Vec::new();

    let patterns = [
        "**/openapi.yaml",
        "**/openapi.yml",
        "**/swagger.yaml",
        "**/swagger.yml",
    ];

    let mut paths: Vec<PathBuf> = Vec::new();
    for pattern in &patterns {
        let full_pattern = root.join(pattern);
        let matches = glob::glob(&full_pattern.to_string_lossy())
            .into_iter()
            .flatten()
            .flatten();
        paths.extend(matches);
    }
    paths.sort();
    paths.dedup();

    for path in &paths {
        let text = match std::fs::read_to_string(path) {
            Ok(t) => t,
            Err(_) => continue,
        };
        let spec: OpenApiFile = match serde_yaml::from_str(&text) {
            Ok(v) => v,
            Err(_) => continue,
        };

        let name = slugify(&spec.info.title);
        if name.is_empty() {
            continue;
        }

        let url = spec
            .servers
            .as_ref()
            .and_then(|s| s.first())
            .map(|s| s.url.clone())
            .or_else(|| {
                // Swagger 2.x: build URL from host + basePath.
                spec.host.as_ref().map(|h| {
                    let base = spec.base_path.as_deref().unwrap_or("");
                    format!("https://{h}{base}")
                })
            });

        let rel_dir = path
            .parent()
            .and_then(|p| p.strip_prefix(root).ok())
            .map(|p| p.to_string_lossy().replace('\\', "/"))
            .unwrap_or_default();

        let svc = ServiceEntry {
            name,
            language: spec.info.x_language,
            platform: None,
            url,
            role: Some("api".to_string()),
            team: spec.info.x_team,
            oncall: spec.info.x_oncall,
            submodule: None,
            path: if rel_dir.is_empty() {
                None
            } else {
                Some(rel_dir)
            },
            docs: None,
            ci: None,
            tags: Vec::new(),
            depends_on: vec![],
        };

        entries.push((svc, path.display().to_string()));
    }

    Ok(entries)
}

/// Merge OpenAPI-imported services into an existing or new manifest.
pub fn run_openapi(root: &Path, output_path: PathBuf, force: bool) -> Result<()> {
    let imported = import_openapi(root)?;

    if imported.is_empty() {
        println!("No OpenAPI / Swagger specs found in {}.", root.display());
        println!("Searched for: openapi.yaml, openapi.yml, swagger.yaml, swagger.yml");
        return Ok(());
    }

    let mut manifest = if output_path.exists() && !force {
        Manifest::load(&output_path)?
    } else {
        Manifest {
            version: "1".to_string(),
            discovery: DiscoveryConfig {
                paths: DEFAULT_DISCOVERY_PATHS
                    .iter()
                    .map(|s| s.to_string())
                    .collect(),
                markers: crate::manifest::default_markers_pub(),
                ignore: vec![],
            },
            policy: Default::default(),
            services: vec![],
        }
    };

    let existing_names: std::collections::HashSet<String> =
        manifest.services.iter().map(|s| s.name.clone()).collect();

    let mut added = 0usize;
    let mut skipped = 0usize;

    for (svc, source) in &imported {
        if existing_names.contains(&svc.name) {
            eprintln!(
                "  skip  '{}' already in manifest  (from {})",
                svc.name, source
            );
            skipped += 1;
        } else {
            eprintln!("  add   '{}'  (from {})", svc.name, source);
            manifest.services.push(svc.clone());
            added += 1;
        }
    }

    let yaml = serde_yaml::to_string(&manifest).context("failed to serialise manifest to YAML")?;
    std::fs::write(&output_path, &yaml)
        .with_context(|| format!("cannot write {}", output_path.display()))?;

    println!();
    println!(
        "Wrote {} — added {}, skipped {} (already declared).",
        output_path.display(),
        added,
        skipped
    );
    println!("Run `svccat check` to verify there is no drift.");
    Ok(())
}

// ── OpenAPI helper ────────────────────────────────────────────────────────────

/// Convert an API title to a lowercase kebab-case slug suitable for service names.
///
/// Example: "User Service API" -> "user-service-api"
fn slugify(s: &str) -> String {
    s.to_lowercase()
        .chars()
        .map(|c| if c.is_alphanumeric() { c } else { '-' })
        .collect::<String>()
        .split('-')
        .filter(|p| !p.is_empty())
        .collect::<Vec<_>>()
        .join("-")
}