oakum 0.3.2

A polyglot release tool that derives dependent version bumps from the dependency graph
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
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
//! Cargo adapter: `cargo metadata --format-version 1 --no-deps`.

use std::collections::{BTreeMap, BTreeSet};
use std::fs;
use std::path::{Path, PathBuf};
use std::process::Command;

use semver::Version;
use serde::Deserialize;

use super::paths::{canonicalize, ensure_contained, repo_relative};
use super::DiscoverError;
use crate::plan::{
    Bounds, BuildResolution, DeclaredRange, Dependency, DependencyKind, Ecosystem, Package,
    PackageId, ResolvesDependenciesAt, Workspace,
};

/// Discover the Cargo workspace visible from `manifest_dir`.
///
/// `repository_root` bounds cargo's `workspace_root` (containment, not
/// equality) so an ancestor workspace outside the repo cannot absorb packages.
/// Always passes `--no-deps` so a lock-free crate is not mutated. Relays cargo's
/// exit-101 stderr verbatim (stray nested manifests).
///
/// # Errors
///
/// Returns [`DiscoverError`] when cargo fails, the workspace root escapes the
/// repository, JSON/TOML is unusable, or [`Workspace::new`] refuses the graph.
pub fn discover_cargo(
    manifest_dir: impl AsRef<Path>,
    repository_root: impl AsRef<Path>,
) -> Result<Workspace, DiscoverError> {
    let json = run_cargo_metadata(manifest_dir.as_ref())?;
    workspace_from_cargo_metadata(&json, repository_root)
}

/// Build a [`Workspace`] from `cargo metadata` JSON (`--format-version 1
/// --no-deps` shape). May read package manifests for path-linked peeks.
///
/// # Errors
///
/// Same class of failures as [`discover_cargo`], except cargo is not invoked.
pub fn workspace_from_cargo_metadata(
    json: &str,
    repository_root: impl AsRef<Path>,
) -> Result<Workspace, DiscoverError> {
    let meta: Metadata = serde_json::from_str(json)?;
    let repository_root = canonicalize(repository_root.as_ref())?;
    let workspace_root = canonicalize(Path::new(&meta.workspace_root))?;
    ensure_contained(&workspace_root, &repository_root)?;

    let member_ids: BTreeSet<&str> = meta.workspace_members.iter().map(String::as_str).collect();
    let members: Vec<&MetaPackage> = meta
        .packages
        .iter()
        .filter(|package| member_ids.contains(package.id.as_str()))
        .collect();

    if members.is_empty() {
        return Err(DiscoverError::InvalidMetadata {
            message: String::from("cargo metadata reported no workspace members"),
        });
    }

    let mut by_dir = BTreeMap::new();
    for package in &members {
        let dir = package_dir(package)?;
        if by_dir.insert(dir.clone(), *package).is_some() {
            return Err(DiscoverError::InvalidMetadata {
                message: format!(
                    "duplicate workspace member directories for {}",
                    dir.display()
                ),
            });
        }
    }

    let mut packages = Vec::with_capacity(members.len());
    for package in &members {
        packages.push(map_package(
            package,
            &by_dir,
            &workspace_root,
            &repository_root,
        )?);
    }
    let root = repo_relative(&workspace_root, &repository_root)?;
    Ok(Workspace::new(packages)?.with_cargo_workspace_root(root))
}

fn run_cargo_metadata(manifest_dir: &Path) -> Result<String, DiscoverError> {
    let output = Command::new("cargo")
        .args(["metadata", "--format-version", "1", "--no-deps"])
        .current_dir(manifest_dir)
        .output()
        .map_err(|source| DiscoverError::CargoNotRunnable { source })?;

    if !output.status.success() {
        let stderr = String::from_utf8_lossy(&output.stderr).trim().to_owned();
        let stdout = String::from_utf8_lossy(&output.stdout).trim().to_owned();
        let message = if !stderr.is_empty() {
            stderr
        } else if !stdout.is_empty() {
            stdout
        } else {
            String::from("no stderr or stdout")
        };
        return Err(DiscoverError::CargoMetadata {
            status: output.status.code(),
            message,
        });
    }

    String::from_utf8(output.stdout).map_err(|err| DiscoverError::InvalidMetadata {
        message: format!("stdout was not utf-8: {err}"),
    })
}

fn map_package(
    package: &MetaPackage,
    members_by_dir: &BTreeMap<PathBuf, &MetaPackage>,
    workspace_root: &Path,
    repository_root: &Path,
) -> Result<Package, DiscoverError> {
    let version = Version::parse(&package.version).map_err(|err| DiscoverError::Version {
        package: package.name.clone(),
        message: err.to_string(),
    })?;

    let resolves = if package
        .targets
        .iter()
        .any(|t| t.kind.iter().any(|k| k == "bin"))
    {
        ResolvesDependenciesAt::Build(BuildResolution::BinaryTarget)
    } else {
        ResolvesDependenciesAt::Install
    };

    let mut dependencies = Vec::new();
    for dep in &package.dependencies {
        // Registry (and other pathless) deps are never intra-workspace edges,
        // even when a workspace member reuses the same package name.
        let Some(dep_path) = dep.path.as_ref() else {
            continue;
        };

        let dep_dir = canonicalize(Path::new(dep_path))?;
        let Some(member) = members_by_dir.get(&dep_dir) else {
            continue;
        };
        if member.name != dep.name {
            return Err(DiscoverError::InvalidMetadata {
                message: format!(
                    "{} path dependency {} resolves to package {}, not {}",
                    package.name, dep_path, member.name, dep.name
                ),
            });
        }
        dependencies.push(map_dependency(package, dep, workspace_root)?);
    }

    let dir = package_dir(package)?;
    let manifest_dir = repo_relative(&dir, repository_root)?;
    Ok(Package::new(
        PackageId::new(Ecosystem::Cargo, package.name.clone()),
        version,
        resolves,
        cargo_is_publishable(package.publish.as_ref()),
        dependencies,
    )
    .with_manifest_dir(manifest_dir))
}

/// Cargo metadata: `null` = any registry; empty list = nowhere; non-empty
/// allow-list = publishable somewhere (not necessarily crates.io).
fn cargo_is_publishable(publish: Option<&Vec<String>>) -> bool {
    match publish {
        None => true,
        Some(registries) => !registries.is_empty(),
    }
}

fn map_dependency(
    dependent: &MetaPackage,
    dep: &MetaDependency,
    workspace_root: &Path,
) -> Result<Dependency, DiscoverError> {
    let kind = match dep.kind.as_deref() {
        None => DependencyKind::Normal,
        Some("dev") => DependencyKind::Development,
        Some("build") => DependencyKind::Build,
        Some(other) => {
            return Err(DiscoverError::UnknownDependencyKind {
                package: dependent.name.clone(),
                dependency: dep.name.clone(),
                kind: other.to_owned(),
            });
        }
    };

    let declared_as = dep.rename.clone().unwrap_or_else(|| dep.name.clone());
    let range = declared_range(dependent, dep, &declared_as, kind, workspace_root)?;

    Ok(Dependency {
        on: PackageId::new(Ecosystem::Cargo, dep.name.clone()),
        kind,
        declared_as,
        target: dep.target.clone(),
        range,
    })
}

fn declared_range(
    dependent: &MetaPackage,
    dep: &MetaDependency,
    declared_as: &str,
    kind: DependencyKind,
    workspace_root: &Path,
) -> Result<DeclaredRange, DiscoverError> {
    // Path + authored `version = "*"` and path-only both report req "*". Only a
    // TOML peek (ADR-0026 / research) distinguishes PathLinked from Plain(*).
    if dep.path.is_some() && dep.req == "*" {
        let manifest = PathBuf::from(&dependent.manifest_path);
        if !dependency_declares_version(
            &manifest,
            workspace_root,
            declared_as,
            kind,
            dep.target.as_deref(),
            &dependent.name,
            &dep.name,
        )? {
            return Ok(DeclaredRange::PathLinked);
        }
    }

    let bounds = Bounds::from_cargo_text(&dep.req).map_err(|err| DiscoverError::Range {
        package: dependent.name.clone(),
        dependency: dep.name.clone(),
        message: err.to_string(),
    })?;
    Ok(DeclaredRange::Plain(bounds))
}

/// True when the authored dep has a `version` key, including via
/// `[workspace.dependencies]` when `workspace = true`.
fn dependency_declares_version(
    manifest_path: &Path,
    workspace_root: &Path,
    declared_as: &str,
    kind: DependencyKind,
    target: Option<&str>,
    package_name: &str,
    dependency_name: &str,
) -> Result<bool, DiscoverError> {
    let entry = dependency_entry(
        manifest_path,
        declared_as,
        kind,
        target,
        package_name,
        dependency_name,
    )?;
    match entry {
        toml::Value::String(_) => Ok(true),
        toml::Value::Table(table) => {
            if table.contains_key("version") {
                return Ok(true);
            }
            if table.get("workspace").and_then(toml::Value::as_bool) == Some(true) {
                return workspace_dependency_declares_version(
                    workspace_root,
                    declared_as,
                    package_name,
                    dependency_name,
                );
            }
            Ok(false)
        }
        other => Err(DiscoverError::Toml {
            path: manifest_path.to_path_buf(),
            message: format!(
                "{package_name} dependency {declared_as}: unexpected TOML value {other:?}"
            ),
        }),
    }
}

fn workspace_dependency_declares_version(
    workspace_root: &Path,
    declared_as: &str,
    package_name: &str,
    dependency_name: &str,
) -> Result<bool, DiscoverError> {
    let root_manifest = workspace_root.join("Cargo.toml");
    let text = fs::read_to_string(&root_manifest).map_err(|source| DiscoverError::Io {
        path: root_manifest.clone(),
        source,
    })?;
    let table: toml::Table = toml::from_str(&text).map_err(|err| DiscoverError::Toml {
        path: root_manifest.clone(),
        message: err.to_string(),
    })?;
    let Some(workspace) = table.get("workspace").and_then(|v| v.as_table()) else {
        return Err(DiscoverError::Toml {
            path: root_manifest,
            message: format!(
                "{package_name} inherits {dependency_name} via workspace = true, but root has no [workspace]"
            ),
        });
    };
    let Some(deps) = workspace.get("dependencies").and_then(|v| v.as_table()) else {
        return Err(DiscoverError::Toml {
            path: root_manifest,
            message: format!(
                "{package_name} inherits {dependency_name} via workspace = true, but root has no [workspace.dependencies]"
            ),
        });
    };
    let Some(entry) = deps.get(declared_as) else {
        return Err(DiscoverError::Toml {
            path: root_manifest,
            message: format!(
                "{package_name} inherits {declared_as}, but [workspace.dependencies] has no such key"
            ),
        });
    };
    match entry {
        toml::Value::String(_) => Ok(true),
        toml::Value::Table(t) => Ok(t.contains_key("version")),
        other => Err(DiscoverError::Toml {
            path: root_manifest,
            message: format!("[workspace.dependencies].{declared_as}: unexpected {other:?}"),
        }),
    }
}

fn dependency_entry(
    manifest_path: &Path,
    declared_as: &str,
    kind: DependencyKind,
    target: Option<&str>,
    package_name: &str,
    dependency_name: &str,
) -> Result<toml::Value, DiscoverError> {
    let text = fs::read_to_string(manifest_path).map_err(|source| DiscoverError::Io {
        path: manifest_path.to_path_buf(),
        source,
    })?;
    let table: toml::Table = toml::from_str(&text).map_err(|err| DiscoverError::Toml {
        path: manifest_path.to_path_buf(),
        message: err.to_string(),
    })?;

    let section = match kind {
        DependencyKind::Normal => "dependencies",
        DependencyKind::Development => "dev-dependencies",
        DependencyKind::Build => "build-dependencies",
        DependencyKind::Peer | DependencyKind::Optional => {
            return Err(DiscoverError::UnknownDependencyKind {
                package: package_name.to_owned(),
                dependency: dependency_name.to_owned(),
                kind: format!("{kind}"),
            });
        }
    };

    let deps_table = if let Some(predicate) = target {
        let Some(targets) = table.get("target").and_then(|v| v.as_table()) else {
            return Err(DiscoverError::Toml {
                path: manifest_path.to_path_buf(),
                message: format!(
                    "{package_name}: metadata listed target {predicate:?} for {declared_as}, but manifest has no [target]"
                ),
            });
        };
        let Some(target_table) = targets.get(predicate).and_then(|v| v.as_table()) else {
            return Err(DiscoverError::Toml {
                path: manifest_path.to_path_buf(),
                message: format!(
                    "{package_name}: metadata listed target {predicate:?} for {declared_as}, missing from manifest"
                ),
            });
        };
        target_table.get(section).and_then(|v| v.as_table())
    } else {
        table.get(section).and_then(|v| v.as_table())
    };

    let Some(deps) = deps_table else {
        return Err(DiscoverError::Toml {
            path: manifest_path.to_path_buf(),
            message: format!(
                "{package_name}: metadata listed {declared_as} under {section}, missing from manifest"
            ),
        });
    };
    let Some(entry) = deps.get(declared_as) else {
        return Err(DiscoverError::Toml {
            path: manifest_path.to_path_buf(),
            message: format!(
                "{package_name}: metadata listed dependency key {declared_as}, missing from manifest"
            ),
        });
    };
    Ok(entry.clone())
}

fn package_dir(package: &MetaPackage) -> Result<PathBuf, DiscoverError> {
    let manifest = Path::new(&package.manifest_path);
    let Some(dir) = manifest.parent() else {
        return Err(DiscoverError::InvalidMetadata {
            message: format!("package {} has no manifest directory", package.name),
        });
    };
    canonicalize(dir)
}

#[derive(Debug, Deserialize)]
struct Metadata {
    packages: Vec<MetaPackage>,
    workspace_members: Vec<String>,
    workspace_root: String,
}

#[derive(Debug, Deserialize)]
struct MetaPackage {
    name: String,
    version: String,
    id: String,
    manifest_path: String,
    /// Always present in `cargo metadata` JSON: `null` = unrestricted, `[]` =
    /// nowhere. No `#[serde(default)]` — a missing key must not look like null.
    publish: Option<Vec<String>>,
    dependencies: Vec<MetaDependency>,
    targets: Vec<MetaTarget>,
}

#[derive(Debug, Deserialize)]
struct MetaDependency {
    name: String,
    req: String,
    kind: Option<String>,
    rename: Option<String>,
    target: Option<String>,
    path: Option<String>,
}

#[derive(Debug, Deserialize)]
struct MetaTarget {
    kind: Vec<String>,
}

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

    fn fixture_dir(name: &str) -> PathBuf {
        PathBuf::from(env!("CARGO_MANIFEST_DIR"))
            .join("tests/fixtures/cargo-discover")
            .join(name)
    }

    fn discover(name: &str) -> Workspace {
        let root = fixture_dir(name);
        discover_cargo(&root, &root).expect("discover")
    }

    #[test]
    fn lone_lib_is_one_member_workspace() {
        let root = fixture_dir("lone-lib");
        let workspace = discover_cargo(&root, &root).expect("discover");
        assert_eq!(workspace.packages().count(), 1);
        let pkg = workspace
            .get(&PackageId::new(Ecosystem::Cargo, "lone-lib"))
            .expect("lone-lib");
        assert_eq!(
            pkg.resolves_dependencies_at(),
            ResolvesDependenciesAt::Install
        );
        assert_eq!(pkg.manifest_dir(), "");
        assert_eq!(workspace.cargo_workspace_root(), Some(""));
        assert!(
            !root.join("Cargo.lock").exists(),
            "--no-deps must not write a lockfile"
        );
    }

    #[test]
    fn binary_target_marks_build_resolution() {
        let pkg = discover("with-bin")
            .get(&PackageId::new(Ecosystem::Cargo, "with-bin"))
            .expect("with-bin")
            .clone();
        assert_eq!(
            pkg.resolves_dependencies_at(),
            ResolvesDependenciesAt::Build(BuildResolution::BinaryTarget)
        );
    }

    #[test]
    fn path_only_edge_is_path_linked() {
        let edge = discover("path-linked")
            .get(&PackageId::new(Ecosystem::Cargo, "app"))
            .expect("app")
            .dependencies()
            .iter()
            .find(|d| d.on.name == "core")
            .expect("edge")
            .clone();
        assert_eq!(edge.range, DeclaredRange::PathLinked);
    }

    #[test]
    fn nested_members_have_repo_relative_dirs() {
        let workspace = discover("path-linked");
        assert_eq!(
            workspace
                .get(&PackageId::new(Ecosystem::Cargo, "app"))
                .expect("app")
                .manifest_dir(),
            "app"
        );
        assert_eq!(
            workspace
                .get(&PackageId::new(Ecosystem::Cargo, "core"))
                .expect("core")
                .manifest_dir(),
            "core"
        );
        assert_eq!(workspace.cargo_workspace_root(), Some(""));
    }

    #[test]
    fn path_with_star_version_is_plain_star() {
        let edge = discover("path-star-version")
            .get(&PackageId::new(Ecosystem::Cargo, "app"))
            .expect("app")
            .dependencies()
            .iter()
            .find(|d| d.on.name == "core")
            .expect("edge")
            .clone();
        let expected = DeclaredRange::Plain(Bounds::from_cargo_text("*").expect("*"));
        assert_eq!(edge.range, expected);
    }

    #[test]
    fn workspace_inherited_star_is_plain_star() {
        let edge = discover("workspace-inherit-star")
            .get(&PackageId::new(Ecosystem::Cargo, "app"))
            .expect("app")
            .dependencies()
            .iter()
            .find(|d| d.on.name == "core")
            .expect("edge")
            .clone();
        let expected = DeclaredRange::Plain(Bounds::from_cargo_text("*").expect("*"));
        assert_eq!(edge.range, expected);
    }

    #[test]
    fn cargo_publish_null_is_publishable_empty_list_is_not() {
        assert!(cargo_is_publishable(None));
        assert!(!cargo_is_publishable(Some(&Vec::new())));
        assert!(cargo_is_publishable(Some(&vec![String::from("crates-io")])));
    }

    #[test]
    fn publish_gate_maps_null_empty_and_allow_list() {
        let workspace = discover("publish-gate");
        let open = workspace
            .get(&PackageId::new(Ecosystem::Cargo, "open"))
            .expect("open");
        let closed = workspace
            .get(&PackageId::new(Ecosystem::Cargo, "closed"))
            .expect("closed");
        let restricted = workspace
            .get(&PackageId::new(Ecosystem::Cargo, "restricted"))
            .expect("restricted");
        assert!(open.publishable());
        assert!(!closed.publishable());
        assert!(restricted.publishable());
    }

    #[test]
    fn workspace_maps_runtime_and_dev_edges() {
        let workspace = discover("workspace");
        assert_eq!(workspace.packages().count(), 3);
        let cli = workspace
            .get(&PackageId::new(Ecosystem::Cargo, "cli"))
            .expect("cli");
        assert_eq!(
            cli.resolves_dependencies_at(),
            ResolvesDependenciesAt::Build(BuildResolution::BinaryTarget)
        );
        let normal = cli
            .dependencies()
            .iter()
            .find(|d| d.on.name == "core" && d.kind == DependencyKind::Normal)
            .expect("normal");
        assert!(matches!(normal.range, DeclaredRange::Plain(_)));
        let tool = workspace
            .get(&PackageId::new(Ecosystem::Cargo, "tool"))
            .expect("tool");
        let dev = tool
            .dependencies()
            .iter()
            .find(|d| d.kind == DependencyKind::Development)
            .expect("dev");
        assert_eq!(dev.on.name, "core");
    }

    #[test]
    fn exit_101_relays_cargo_stderr() {
        let root = fixture_dir("stray-nested");
        let err = discover_cargo(root.join("stray"), &root).expect_err("must fail");
        match err {
            DiscoverError::CargoMetadata {
                status: Some(101),
                message,
            } => {
                assert!(
                    message.contains("workspace") || message.contains("members"),
                    "expected cargo's stray-manifest wording, got: {message}"
                );
            }
            other => panic!("expected CargoMetadata exit 101, got {other}"),
        }
    }

    #[test]
    fn workspace_root_outside_repository_is_rejected() {
        // `/tmp` is not an existing path on Windows (canonicalize fails with Io).
        let outside = std::env::temp_dir();
        let json = serde_json::json!({
            "packages": [],
            "workspace_members": [],
            "workspace_root": outside,
        });
        let err = workspace_from_cargo_metadata(&json.to_string(), fixture_dir("lone-lib"))
            .expect_err("outside root");
        assert!(
            matches!(err, DiscoverError::WorkspaceRootOutsideRepository { .. }),
            "{err}"
        );
    }

    #[test]
    fn workspace_root_missing_is_io() {
        let json = serde_json::json!({
            "packages": [],
            "workspace_members": [],
            "workspace_root": "/this-path-does-not-exist-oakum-probe",
        });
        let err = workspace_from_cargo_metadata(&json.to_string(), fixture_dir("lone-lib"))
            .expect_err("missing root");
        assert!(matches!(err, DiscoverError::Io { .. }), "{err}");
    }

    #[cfg(windows)]
    #[test]
    fn workspace_root_unix_tmp_is_io_on_windows() {
        let json = r#"{"packages":[],"workspace_members":[],"workspace_root":"/tmp"}"#;
        let err =
            workspace_from_cargo_metadata(json, fixture_dir("lone-lib")).expect_err("unix tmp");
        assert!(matches!(err, DiscoverError::Io { .. }), "{err}");
    }
}