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
|
use std::fmt::Display;
use std::str::FromStr;
use std::sync::LazyLock;
use crate::PreStableType::{Alpha, Beta};
use regex::Regex;
/// The Mullvad VPN app product version
pub const VERSION: &str = include_str!(concat!(env!("OUT_DIR"), "/product-version.txt"));
#[derive(Debug, Clone, PartialEq)]
pub struct Version {
pub year: String,
pub incremental: String,
/// A version can have an optional pre-stable type, e.g. alpha or beta. If `pre_stable`
/// and `dev` both are None the version is stable.
pub pre_stable: Option<PreStableType>,
/// All versions may have an optional -dev-[commit hash] suffix.
pub dev: Option<String>,
}
#[derive(Debug, Clone, PartialEq)]
pub enum PreStableType {
Alpha(String),
Beta(String),
}
impl Version {
pub fn parse(version: &str) -> Version {
Version::from_str(version).unwrap()
}
pub fn is_stable(&self) -> bool {
self.pre_stable.is_none() && self.dev.is_none()
}
pub fn alpha(&self) -> Option<&str> {
match &self.pre_stable {
Some(PreStableType::Alpha(v)) => Some(v),
_ => None,
}
}
pub fn beta(&self) -> Option<&str> {
match &self.pre_stable {
Some(PreStableType::Beta(beta)) => Some(beta),
_ => None,
}
}
}
impl Display for Version {
/// Format Version as a string: year.incremental-{alpha|beta}-{dev}
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let Version {
year,
incremental,
pre_stable,
dev,
} = &self;
write!(f, "{year}.{incremental}")?;
match pre_stable {
Some(PreStableType::Alpha(version)) => write!(f, "-alpha{version}")?,
Some(PreStableType::Beta(version)) => write!(f, "-beta{version}")?,
None => (),
};
if let Some(commit_hash) = dev {
write!(f, "-dev-{commit_hash}")?;
}
Ok(())
}
}
impl FromStr for Version {
type Err = String;
fn from_str(version: &str) -> Result<Self, Self::Err> {
static VERSION_REGEX: LazyLock<Regex> = LazyLock::new(|| {
Regex::new(
r"(?x) # enable insignificant whitespace mode
20(?<year>\d{2})\. # the last two digits of the year
(?<incremental>[1-9]\d?) # the incrementing version number
(?: # (optional) alpha or beta or dev
-alpha(?<alpha>[1-9]\d?\d?)|
-beta(?<beta>[1-9]\d?\d?)
)?
(?:
-dev-(?<dev>[0-9a-f]+)
)?$
",
)
.unwrap()
});
let captures = VERSION_REGEX
.captures(version)
.ok_or_else(|| format!("Version does not match expected format: {version}"))?;
let year = captures
.name("year")
.expect("Missing year")
.as_str()
.to_owned();
let incremental = captures
.name("incremental")
.ok_or("Missing incremental")?
.as_str()
.to_owned();
let alpha = captures.name("alpha").map(|m| m.as_str().to_owned());
let beta = captures.name("beta").map(|m| m.as_str().to_owned());
let dev = captures.name("dev").map(|m| m.as_str().to_owned());
let pre_stable = match (alpha, beta) {
(None, None) => None,
(Some(v), None) => Some(Alpha(v)),
(None, Some(v)) => Some(Beta(v)),
_ => return Err(format!("Invalid version: {version}")),
};
Ok(Version {
year,
incremental,
pre_stable,
dev,
})
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_parse() {
let version = "2021.34";
let parsed = Version::parse(version);
assert_eq!(parsed.year, "21");
assert_eq!(parsed.incremental, "34");
assert_eq!(parsed.alpha(), None);
assert_eq!(parsed.beta(), None);
assert_eq!(parsed.dev, None);
assert!(parsed.is_stable());
}
#[test]
fn test_parse_with_alpha() {
let version = "2023.1-alpha77";
let parsed = Version::parse(version);
assert_eq!(parsed.year, "23");
assert_eq!(parsed.incremental, "1");
assert_eq!(parsed.alpha(), Some("77"));
assert_eq!(parsed.beta(), None);
assert_eq!(parsed.dev, None);
assert!(!parsed.is_stable());
let version = "2021.34-alpha777";
let parsed = Version::parse(version);
assert_eq!(parsed.alpha(), Some("777"));
}
#[test]
fn test_parse_with_beta() {
let version = "2021.34-beta5";
let parsed = Version::parse(version);
assert_eq!(parsed.year, "21");
assert_eq!(parsed.incremental, "34");
assert_eq!(parsed.alpha(), None);
assert_eq!(parsed.beta(), Some("5"));
assert_eq!(parsed.dev, None);
assert!(!parsed.is_stable());
let version = "2021.34-beta453";
let parsed = Version::parse(version);
assert_eq!(parsed.beta(), Some("453"));
}
#[test]
fn test_parse_with_dev() {
let version = "2021.34-dev-0b60e4d87";
let parsed = Version::parse(version);
assert_eq!(parsed.year, "21");
assert_eq!(parsed.incremental, "34");
assert!(!parsed.is_stable());
assert_eq!(parsed.dev, Some("0b60e4d87".to_string()));
assert_eq!(parsed.alpha(), None);
assert_eq!(parsed.beta(), None);
}
#[test]
fn test_parse_both_beta_and_dev() {
let version = "2024.8-beta1-dev-e5483d";
let parsed = Version::parse(version);
assert_eq!(parsed.year, "24");
assert_eq!(parsed.incremental, "8");
assert_eq!(parsed.alpha(), None);
assert_eq!(parsed.beta(), Some("1"));
assert_eq!(parsed.dev, Some("e5483d".to_string()));
assert!(!parsed.is_stable());
}
#[test]
#[should_panic]
fn test_panics_on_invalid_version() {
Version::parse("2021");
}
#[test]
#[should_panic]
fn test_panics_on_invalid_version_type_number() {
Version::parse("2021.1-beta001");
}
#[test]
#[should_panic]
fn test_panics_on_alpha_and_beta_in_same_version() {
Version::parse("2021.1-beta5-alpha2");
}
#[test]
#[should_panic]
fn test_panics_on_dev_without_commit_hash() {
Version::parse("2021.1-dev");
}
}
|