oakum 0.12.1

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
//! Pure migrate plan comparison (`okm-45t.3`).
//!
//! Classifies before/after fingerprints: equality, expected knope pre-1.0
//! feature fallout (patch vs minor), or unexpected drift. No I/O.

use alloc::collections::BTreeMap;
use alloc::collections::BTreeSet;
use alloc::string::String;
use alloc::vec::Vec;

use semver::Version;

use super::aggregate::{aggregate, BumpFile};
use super::bump::{apply_bump, BumpLevel, Versioning};
use super::compose::{ChangeSource, Plan, PlannedChange};
use super::workspace::{PackageId, Workspace};

/// `(from, to)` versions for each planned package.
pub type PlanFingerprint = BTreeMap<PackageId, (Version, Version)>;

#[must_use]
pub fn plan_fingerprint(plan: &Plan) -> PlanFingerprint {
    plan.changes()
        .iter()
        .map(|(id, change)| (id.clone(), (change.from().clone(), change.to().clone())))
        .collect()
}

#[derive(Clone, Debug, PartialEq, Eq)]
pub struct PackageDiff {
    id: PackageId,
    before: Option<(Version, Version)>,
    after: Option<(Version, Version)>,
}

impl PackageDiff {
    #[must_use]
    pub const fn id(&self) -> &PackageId {
        &self.id
    }

    #[must_use]
    pub const fn before(&self) -> Option<&(Version, Version)> {
        self.before.as_ref()
    }

    #[must_use]
    pub const fn after(&self) -> Option<&(Version, Version)> {
        self.after.as_ref()
    }
}

/// Opaque: construct only via [`compare_plans`]. Classification lives in the
/// private inner arm so dependents cannot forge empty or reclassified values.
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct PlanComparison {
    inner: PlanComparisonInner,
}

#[derive(Clone, Debug, PartialEq, Eq)]
enum PlanComparisonInner {
    Equal,
    ExpectedKnopeFeature(Vec<PackageDiff>),
    Unexpected {
        expected: Vec<PackageDiff>,
        unexpected: Vec<PackageDiff>,
    },
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct UnexpectedDiffs<'a> {
    pub expected: &'a [PackageDiff],
    pub unexpected: &'a [PackageDiff],
}

impl PlanComparison {
    /// Crate-local helper for tests; dependents use [`compare_plans`].
    #[must_use]
    pub(crate) const fn equal() -> Self {
        Self {
            inner: PlanComparisonInner::Equal,
        }
    }

    /// True when migrate should hard-fail on plan drift.
    #[cfg(test)]
    #[must_use]
    pub const fn is_unexpected(&self) -> bool {
        matches!(self.inner, PlanComparisonInner::Unexpected { .. })
    }

    /// Knope feature fallout rows when that is the only drift.
    #[must_use]
    pub fn expected_knope_feature(&self) -> Option<&[PackageDiff]> {
        match &self.inner {
            PlanComparisonInner::ExpectedKnopeFeature(diffs) => Some(diffs.as_slice()),
            _ => None,
        }
    }

    /// Unexpected drift, with any expected knope rows alongside.
    #[must_use]
    pub fn unexpected(&self) -> Option<UnexpectedDiffs<'_>> {
        match &self.inner {
            PlanComparisonInner::Unexpected {
                expected,
                unexpected,
            } => Some(UnexpectedDiffs {
                expected: expected.as_slice(),
                unexpected: unexpected.as_slice(),
            }),
            _ => None,
        }
    }
}

/// `before_plan` is required for cascade walks on the simulated-before path;
/// source-tool before fingerprints pass `None`.
#[must_use]
pub fn compare_plans(
    workspace: &Workspace,
    files: &[BumpFile],
    knope: bool,
    before: &PlanFingerprint,
    before_plan: Option<&Plan>,
    after: &Plan,
) -> PlanComparison {
    let after_fp = plan_fingerprint(after);
    if before == &after_fp {
        return PlanComparison::equal();
    }
    let features = knope_feature_ids(workspace, files);
    let mut ids: BTreeSet<PackageId> = before.keys().cloned().collect();
    ids.extend(after_fp.keys().cloned());
    let mut expected = Vec::new();
    let mut unexpected = Vec::new();
    for id in ids {
        let before_v = before.get(&id).cloned();
        let after_v = after_fp.get(&id).cloned();
        if before_v == after_v {
            continue;
        }
        let diff = PackageDiff {
            id: id.clone(),
            before: before_v,
            after: after_v,
        };
        if knope_feature_fallout(knope, &features, before_plan, after, before, &after_fp, &id) {
            expected.push(diff);
        } else {
            unexpected.push(diff);
        }
    }
    if unexpected.is_empty() {
        PlanComparison {
            inner: PlanComparisonInner::ExpectedKnopeFeature(expected),
        }
    } else {
        PlanComparison {
            inner: PlanComparisonInner::Unexpected {
                expected,
                unexpected,
            },
        }
    }
}

#[must_use]
pub fn format_versions(versions: Option<&(Version, Version)>) -> String {
    match versions {
        Some((from, to)) => alloc::format!("{from} → {to}"),
        None => String::from("absent"),
    }
}

fn bumped(from: &Version, level: BumpLevel) -> Option<Version> {
    apply_bump(from, level, Versioning::ZeroMajor)
        .ok()
        .map(|(next, _)| next)
}

fn is_knope_feature_versions(
    before: Option<&(Version, Version)>,
    after: Option<&(Version, Version)>,
) -> bool {
    let Some((before_from, before_to)) = before else {
        return false;
    };
    let Some((after_from, after_to)) = after else {
        return false;
    };
    if before_from != after_from {
        return false;
    }
    let Some(patch) = bumped(before_from, BumpLevel::Patch) else {
        return false;
    };
    let Some(minor) = bumped(before_from, BumpLevel::Minor) else {
        return false;
    };
    before_to == &patch && after_to == &minor
}

fn knope_feature_fallout(
    knope: bool,
    features: &BTreeSet<PackageId>,
    before: Option<&Plan>,
    after: &Plan,
    before_fp: &PlanFingerprint,
    after_fp: &PlanFingerprint,
    id: &PackageId,
) -> bool {
    if !knope {
        return false;
    }
    let canonical: BTreeSet<PackageId> = features
        .iter()
        .filter(|feature| {
            is_knope_feature_versions(before_fp.get(*feature), after_fp.get(*feature))
        })
        .cloned()
        .collect();
    if canonical.contains(id) {
        return true;
    }
    cascaded_from_feature(after, &canonical, id)
        || before.is_some_and(|before| cascaded_from_feature(before, &canonical, id))
}

fn cascaded_from_feature(plan: &Plan, features: &BTreeSet<PackageId>, id: &PackageId) -> bool {
    let mut current = id.clone();
    let mut seen = BTreeSet::new();
    while seen.insert(current.clone()) {
        match plan.get(&current).map(PlannedChange::source) {
            Some(ChangeSource::Cascade { trigger }) => {
                if features.contains(trigger) {
                    return true;
                }
                current = trigger.clone();
            }
            _ => return false,
        }
    }
    false
}

fn knope_feature_ids(workspace: &Workspace, files: &[BumpFile]) -> BTreeSet<PackageId> {
    aggregate(files.to_vec())
        .into_iter()
        .filter(|(id, bump)| {
            bump.level() == BumpLevel::Minor
                && workspace
                    .get(id)
                    .is_some_and(|pkg| pkg.version().major == 0)
        })
        .map(|(id, _)| id)
        .collect()
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::plan::{
        compose, DeclaredRange, Dependency, DependencyKind, Ecosystem, Package, PackageId,
        ResolvesDependenciesAt, Workspace,
    };
    use alloc::vec;
    use semver::Version;

    fn cargo_pkg(name: &str, version: Version) -> Package {
        Package::new(
            PackageId::new(Ecosystem::Cargo, name),
            version,
            ResolvesDependenciesAt::Install,
            true,
            vec![],
        )
    }

    fn edge(on: PackageId) -> Dependency {
        let declared_as = on.name.clone();
        Dependency {
            on,
            kind: DependencyKind::Normal,
            declared_as,
            target: None,
            range: DeclaredRange::PathLinked,
        }
    }

    fn workspace(packages: Vec<Package>) -> Workspace {
        Workspace::new(packages).expect("workspace")
    }

    fn bump(id: &str, level: BumpLevel) -> BumpFile {
        BumpFile {
            id: alloc::format!("{id}.md"),
            entries: vec![(PackageId::new(Ecosystem::Cargo, id), level)],
            note: String::new(),
        }
    }

    fn oakum_plan(ws: &Workspace, files: Vec<BumpFile>) -> Plan {
        let intent = aggregate(files);
        compose(
            ws,
            &intent,
            |_| Versioning::ZeroMajor,
            super::super::cascade::CascadeAs::Patch,
        )
        .expect("compose")
    }

    #[test]
    fn format_versions_renders_pair_or_absent() {
        let pair = (Version::new(0, 1, 0), Version::new(0, 1, 1));
        assert_eq!(format_versions(Some(&pair)), "0.1.0 → 0.1.1");
        assert_eq!(format_versions(None), "absent");
    }

    #[test]
    fn equal_fingerprints() {
        let ws = workspace(vec![cargo_pkg("core", Version::new(0, 1, 0))]);
        let files = vec![bump("core", BumpLevel::Patch)];
        let plan = oakum_plan(&ws, files.clone());
        let fp = plan_fingerprint(&plan);
        assert_eq!(
            compare_plans(&ws, &files, false, &fp, Some(&plan), &plan),
            PlanComparison::equal()
        );
    }

    #[test]
    fn knope_feature_patch_vs_minor_is_expected() {
        let ws = workspace(vec![cargo_pkg("core", Version::new(0, 1, 0))]);
        let files = vec![bump("core", BumpLevel::Minor)];
        let after = oakum_plan(&ws, files.clone());
        let mut before = plan_fingerprint(&after);
        let core = PackageId::new(Ecosystem::Cargo, "core");
        before.insert(core.clone(), (Version::new(0, 1, 0), Version::new(0, 1, 1)));
        let cmp = compare_plans(&ws, &files, true, &before, None, &after);
        let diffs = cmp
            .expected_knope_feature()
            .expect("expected knope fallout");
        assert_eq!(diffs.len(), 1);
        assert_eq!(diffs[0].id(), &core);
    }

    #[test]
    fn unexpected_diff_without_knope_flag() {
        let ws = workspace(vec![cargo_pkg("core", Version::new(0, 1, 0))]);
        let files = vec![bump("core", BumpLevel::Minor)];
        let after = oakum_plan(&ws, files.clone());
        let mut before = plan_fingerprint(&after);
        let core = PackageId::new(Ecosystem::Cargo, "core");
        before.insert(core, (Version::new(0, 1, 0), Version::new(0, 1, 1)));
        assert!(compare_plans(&ws, &files, false, &before, None, &after).is_unexpected());
    }

    #[test]
    fn knope_true_non_fallout_shape_is_unexpected() {
        let ws = workspace(vec![cargo_pkg("core", Version::new(0, 1, 0))]);
        let files = vec![bump("core", BumpLevel::Minor)];
        let after = oakum_plan(&ws, files.clone());
        let mut before = plan_fingerprint(&after);
        let core = PackageId::new(Ecosystem::Cargo, "core");
        // Not patch→minor: oakum would go 0.1.0→0.2.0; before claims 0.1.0→0.3.0.
        before.insert(core, (Version::new(0, 1, 0), Version::new(0, 3, 0)));
        assert!(compare_plans(&ws, &files, true, &before, None, &after).is_unexpected());
    }

    #[test]
    fn knope_feature_cascade_dependent_is_expected() {
        let core_id = PackageId::new(Ecosystem::Cargo, "core");
        let cli_id = PackageId::new(Ecosystem::Cargo, "cli");
        let ws = workspace(vec![
            cargo_pkg("core", Version::new(0, 1, 0)),
            Package::new(
                cli_id.clone(),
                Version::new(0, 1, 0),
                ResolvesDependenciesAt::Install,
                true,
                vec![edge(core_id.clone())],
            ),
        ]);
        let files = vec![bump("core", BumpLevel::Minor)];
        let after = oakum_plan(&ws, files.clone());
        assert!(
            after.get(&cli_id).is_some(),
            "cli must cascade from core for this unit"
        );
        // Source-tool before often lists only the feature package; oakum after
        // adds the cascade dependent — that gap is what cascaded_from_feature covers.
        let mut before = PlanFingerprint::new();
        before.insert(
            core_id.clone(),
            (Version::new(0, 1, 0), Version::new(0, 1, 1)),
        );
        let cmp = compare_plans(&ws, &files, true, &before, None, &after);
        let diffs = cmp
            .expected_knope_feature()
            .unwrap_or_else(|| panic!("expected cascade fallout, got {cmp:?}"));
        let ids: BTreeSet<_> = diffs.iter().map(PackageDiff::id).cloned().collect();
        assert!(ids.contains(&core_id) && ids.contains(&cli_id), "{ids:?}");
        assert!(compare_plans(&ws, &files, false, &before, None, &after).is_unexpected());
    }

    #[test]
    fn knope_feature_version_shape() {
        let from = Version::new(0, 1, 0);
        assert!(is_knope_feature_versions(
            Some(&(from.clone(), Version::new(0, 1, 1))),
            Some(&(from.clone(), Version::new(0, 2, 0))),
        ));
        assert!(!is_knope_feature_versions(
            Some(&(from.clone(), Version::new(0, 1, 1))),
            Some(&(from.clone(), Version::new(0, 3, 0))),
        ));
        assert!(!is_knope_feature_versions(None, None));
        assert!(!is_knope_feature_versions(
            Some(&(from.clone(), Version::new(0, 1, 1))),
            Some(&(Version::new(0, 2, 0), Version::new(0, 3, 0))),
        ));
    }
}