Skip to main content

release_version/
upgrade_decision.rs

1//! Upgrade decision logic for comparing build versions.
2
3/// The outcome of comparing the current build version against a
4/// release manifest.
5#[derive(Debug, PartialEq, Eq)]
6pub enum UpgradeDecision {
7    /// The manifest version is newer. Upgrade should proceed.
8    Upgrade,
9    /// The versions are identical. Already up to date.
10    UpToDate,
11    /// The available version is older. Downgrade refused unless the
12    /// caller explicitly allows an override.
13    Downgrade,
14    /// At least one value is a development build; build numbers are not
15    /// comparable with release builds. Upgrade refused unless the
16    /// caller explicitly allows an override.
17    DevBuild,
18}
19
20#[cfg(test)]
21mod tests {
22    use semver::Version;
23
24    use super::*;
25    use crate::BuildVersion;
26
27    fn ci(major: u64, minor: u64, patch: u64, build: u64) -> BuildVersion {
28        BuildVersion::new(Version::new(major, minor, patch), build, false)
29    }
30
31    fn dev(major: u64, minor: u64, patch: u64, build: u64) -> BuildVersion {
32        BuildVersion::new(Version::new(major, minor, patch), build, true)
33    }
34
35    #[test]
36    fn semver_upgrade() {
37        let current = ci(0, 10, 0, 100);
38        let manifest = ci(0, 11, 0, 50);
39        assert_eq!(
40            current.compare_for_upgrade(&manifest, false),
41            UpgradeDecision::Upgrade
42        );
43    }
44
45    #[test]
46    fn semver_downgrade_refused() {
47        let current = ci(0, 11, 0, 100);
48        let manifest = ci(0, 10, 0, 200);
49        assert_eq!(
50            current.compare_for_upgrade(&manifest, false),
51            UpgradeDecision::Downgrade
52        );
53    }
54
55    #[test]
56    fn semver_downgrade_explicit() {
57        let current = ci(0, 11, 0, 100);
58        let manifest = ci(0, 10, 0, 200);
59        assert_eq!(
60            current.compare_for_upgrade(&manifest, true),
61            UpgradeDecision::Upgrade
62        );
63    }
64
65    #[test]
66    fn same_semver_higher_build() {
67        let current = ci(0, 11, 0, 100);
68        let manifest = ci(0, 11, 0, 200);
69        assert_eq!(
70            current.compare_for_upgrade(&manifest, false),
71            UpgradeDecision::Upgrade
72        );
73    }
74
75    #[test]
76    fn same_semver_same_build() {
77        let current = ci(0, 11, 0, 200);
78        let manifest = ci(0, 11, 0, 200);
79        assert_eq!(
80            current.compare_for_upgrade(&manifest, false),
81            UpgradeDecision::UpToDate
82        );
83    }
84
85    #[test]
86    fn same_semver_lower_build_refused() {
87        let current = ci(0, 11, 0, 200);
88        let manifest = ci(0, 11, 0, 100);
89        assert_eq!(
90            current.compare_for_upgrade(&manifest, false),
91            UpgradeDecision::Downgrade
92        );
93    }
94
95    #[test]
96    fn same_semver_lower_build_explicit() {
97        let current = ci(0, 11, 0, 200);
98        let manifest = ci(0, 11, 0, 100);
99        assert_eq!(
100            current.compare_for_upgrade(&manifest, true),
101            UpgradeDecision::Upgrade
102        );
103    }
104
105    #[test]
106    fn dev_build_same_semver_refused() {
107        let current = dev(0, 11, 0, 1221);
108        let manifest = ci(0, 11, 0, 207);
109        assert_eq!(
110            current.compare_for_upgrade(&manifest, false),
111            UpgradeDecision::DevBuild
112        );
113    }
114
115    #[test]
116    fn dev_build_same_semver_explicit() {
117        let current = dev(0, 11, 0, 1221);
118        let manifest = ci(0, 11, 0, 207);
119        assert_eq!(
120            current.compare_for_upgrade(&manifest, true),
121            UpgradeDecision::Upgrade
122        );
123    }
124
125    #[test]
126    fn dev_build_older_semver_upgrades() {
127        let current = dev(0, 10, 0, 1221);
128        let manifest = ci(0, 11, 0, 207);
129        assert_eq!(
130            current.compare_for_upgrade(&manifest, false),
131            UpgradeDecision::Upgrade
132        );
133    }
134
135    #[test]
136    fn dev_build_newer_semver_refuses() {
137        let current = dev(0, 12, 0, 1221);
138        let manifest = ci(0, 11, 0, 207);
139        assert_eq!(
140            current.compare_for_upgrade(&manifest, false),
141            UpgradeDecision::Downgrade
142        );
143    }
144
145    #[test]
146    fn semver_ordering_0_9_lt_0_10() {
147        let current = ci(0, 9, 0, 1);
148        let manifest = ci(0, 10, 0, 1);
149        assert_eq!(
150            current.compare_for_upgrade(&manifest, false),
151            UpgradeDecision::Upgrade
152        );
153    }
154}