fetter 3.4.0

System-wide Python package discovery, validation, vulnerability scanning, and allow-listing.
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
use std::cmp::Ordering;
use std::fmt;
use std::hash::Hash;
use std::hash::Hasher;

use serde::{Deserialize, Deserializer, Serialize, Serializer};

use crate::util::WILDCARD;

//------------------------------------------------------------------------------
#[derive(Debug, Eq, Ord, PartialEq, PartialOrd, Clone, Hash, Serialize, Deserialize)]
enum VersionPart {
    Number(u32),
    Text(String),
}

//------------------------------------------------------------------------------
#[derive(Debug, Clone)]
pub struct VersionSpec(Vec<VersionPart>);

impl Serialize for VersionSpec {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        serializer.serialize_str(&self.to_string())
    }
}

impl<'de> Deserialize<'de> for VersionSpec {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        let version_str = String::deserialize(deserializer)?;
        Ok(VersionSpec::new(&version_str))
    }
}

impl VersionSpec {
    /// Main constructor.
    pub fn new(version_str: &str) -> Self {
        let parts = version_str
            .split('.')
            .map(|part| {
                if let Ok(number) = part.parse::<u32>() {
                    VersionPart::Number(number)
                } else {
                    VersionPart::Text(part.to_string())
                }
            })
            .collect();
        VersionSpec(parts)
    }
    // https://packaging.python.org/en/latest/specifications/version-specifiers/#compatible-release
    pub(crate) fn is_compatible(&self, other: &Self) -> bool {
        if other < self {
            return false;
        }
        let mut ub = self.0.clone(); // upper bound
        let ub_len = ub.len();
        let mut numeric_count = 0;
        let numeric_total = self
            .0
            .iter()
            .filter(|part| matches!(part, VersionPart::Number(_)))
            .count();
        if numeric_total == 1 {
            // spec says this MUST NOT be used with a single segment version number such as ~=1; we permit, however, direct equivalent versions
            return self == other;
        }
        // try to find the second to last numeric component and increment it
        for i in 0..ub_len {
            if let VersionPart::Number(n) = ub[i] {
                numeric_count += 1;
                if numeric_count == numeric_total - 1 {
                    ub[i] = VersionPart::Number(n + 1);
                    ub.truncate(i + 1); // remove everything after
                    break;
                }
            }
        }
        other < &VersionSpec(ub)
    }

    // https://packaging.python.org/en/latest/specifications/version-specifiers/#arbitrary-equality
    pub(crate) fn is_arbitrary_equal(&self, other: &Self) -> bool {
        self.to_string() == other.to_string()
    }

    // https://python-poetry.org/docs/dependency-specification/#caret-requirements
    // ^1.2.3 	>=1.2.3 <2.0.0
    // ^1.2 	>=1.2.0 <2.0.0
    pub(crate) fn is_caret(&self, other: &Self) -> bool {
        if other < self {
            return false;
        }
        let mut ub = self.0.clone(); // upper bound
        let ub_len = ub.len();
        let mut numeric_count = 0;

        // increment the first non-zero, or the last
        for i in 0..ub_len {
            if let VersionPart::Number(n) = ub[i] {
                numeric_count += 1;
                if n != 0 || (numeric_count == ub_len) {
                    ub[i] = VersionPart::Number(n + 1);
                    ub.truncate(i + 1); // remove everything after
                    break;
                }
            }
        }
        other < &VersionSpec(ub)
    }

    // https://python-poetry.org/docs/dependency-specification/#tilde-requirements
    // ~1.2.3 	>=1.2.3 <1.3.0
    // ~1.2 	>=1.2.0 <1.3.0
    // ~1 	    >=1.0.0 <2.0.0
    pub(crate) fn is_tilde(&self, other: &Self) -> bool {
        if other < self {
            return false;
        }
        let mut ub = self.0.clone(); // upper bound
        let ub_len = ub.len();
        let mut numeric_count = 0;

        // find the second numeric component and increment it, or if length 1 increment it
        for i in 0..ub_len {
            if let VersionPart::Number(n) = ub[i] {
                numeric_count += 1;
                if numeric_count == 2 || (numeric_count == 1 && ub_len == 1) {
                    ub[i] = VersionPart::Number(n + 1);
                    ub.truncate(i + 1); // remove everything after
                    break;
                }
            }
        }
        other < &VersionSpec(ub)
    }

    // Return True if this VersionSpec has a woldcard
    pub(crate) fn has_wildcard(&self) -> bool {
        self.0.iter().rev().any(|part| match part {
            VersionPart::Number(_) => false,
            VersionPart::Text(text) => text == WILDCARD,
        })
    }
}
impl fmt::Display for VersionSpec {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let version_string = self
            .0
            .iter()
            .map(|part| match part {
                VersionPart::Number(num) => num.to_string(),
                VersionPart::Text(text) => text.clone(),
            })
            .collect::<Vec<_>>()
            .join(".");
        write!(f, "{version_string}")
    }
}

// This hash implementation does not treat wildcards "*" special, which may be an issue as PartialEq does
impl Hash for VersionSpec {
    fn hash<H: Hasher>(&self, state: &mut H) {
        for part in &self.0 {
            part.hash(state);
        }
    }
}

// This ordering implementation is handling wild cards and zero-padding, but may not yet be handling "post" release correctly
// https://packaging.python.org/en/latest/specifications/version-specifiers/#post-releases
impl Ord for VersionSpec {
    fn cmp(&self, other: &Self) -> Ordering {
        let max_len = self.0.len().max(other.0.len());
        for i in 0..max_len {
            // extend to max with zero padding
            let self_part = self.0.get(i).unwrap_or(&VersionPart::Number(0));
            let other_part = other.0.get(i).unwrap_or(&VersionPart::Number(0));

            let ordering = match (self_part, other_part) {
                (VersionPart::Number(a), VersionPart::Number(b)) => a.cmp(b),
                (VersionPart::Text(a), VersionPart::Text(b)) => {
                    if a == WILDCARD || b == WILDCARD {
                        Ordering::Equal
                    } else {
                        a.cmp(b)
                    }
                }
                (VersionPart::Number(_), VersionPart::Text(b)) => {
                    if b == WILDCARD {
                        Ordering::Equal
                    } else {
                        Ordering::Greater // numbers are always greater than text
                    }
                }
                (VersionPart::Text(a), VersionPart::Number(_)) => {
                    if a == WILDCARD {
                        Ordering::Equal
                    } else {
                        Ordering::Less
                    }
                }
            };
            if ordering != Ordering::Equal {
                return ordering; // else, continue iteration
            }
        }
        // self.0.len().cmp(&other.0.len())
        Ordering::Equal
    }
}
impl PartialOrd for VersionSpec {
    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
        Some(self.cmp(other))
    }
}
impl PartialEq for VersionSpec {
    fn eq(&self, other: &Self) -> bool {
        let max_len = self.0.len().max(other.0.len());
        for i in 0..max_len {
            // extend to max with zero padding
            let self_part = self.0.get(i).unwrap_or(&VersionPart::Number(0));
            let other_part = other.0.get(i).unwrap_or(&VersionPart::Number(0));

            match (self_part, other_part) {
                // if wildcard "*" both equal
                (VersionPart::Text(a), VersionPart::Text(b))
                    if a == WILDCARD || b == WILDCARD =>
                {
                    continue
                }
                (VersionPart::Text(a), VersionPart::Number(_)) if a == WILDCARD => {
                    continue
                }
                (VersionPart::Number(_), VersionPart::Text(b)) if b == WILDCARD => {
                    continue
                }
                // parts must match exactly
                (VersionPart::Number(a), VersionPart::Number(b)) if a != b => {
                    return false
                }
                (VersionPart::Text(a), VersionPart::Text(b)) if a != b => return false,
                // not equal
                (VersionPart::Number(_), VersionPart::Text(_)) => return false,
                (VersionPart::Text(_), VersionPart::Number(_)) => return false,
                _ => {} // continue
            }
        }
        true
    }
}

impl Eq for VersionSpec {}

//------------------------------------------------------------------------------
#[cfg(test)]
mod tests {

    use super::*;

    #[test]
    fn test_version_spec_a() {
        assert_eq!(VersionSpec::new("2.2"), VersionSpec::new("2.2"));
        assert_eq!(VersionSpec::new("2.*"), VersionSpec::new("2.2"));
        assert_eq!(VersionSpec::new("2.2"), VersionSpec::new("2.*"));
    }
    #[test]
    fn test_version_spec_b() {
        assert_eq!(VersionSpec::new("2.*.1"), VersionSpec::new("2.2.1"));
        assert_ne!(VersionSpec::new("2.*.1"), VersionSpec::new("2.2.2"));
    }
    #[test]
    fn test_version_spec_c() {
        // NOTE: not sure these falses are what we want
        assert!(VersionSpec::new("2.*") <= VersionSpec::new("2.2.1"));
        assert!(VersionSpec::new("2.2") <= VersionSpec::new("2.*"));
    }
    #[test]
    fn test_version_spec_d() {
        assert!(VersionSpec::new("2.1") != VersionSpec::new("2.2"));
        assert!(VersionSpec::new("2.2") == VersionSpec::new("2.2"));
        assert!(VersionSpec::new("2.2.0") == VersionSpec::new("2.2"));
    }
    #[test]
    fn test_version_spec_e() {
        assert!(VersionSpec::new("1.7.1") > VersionSpec::new("1.7"));
        assert!(VersionSpec::new("1.7.1") < VersionSpec::new("1.8"));
        assert!(VersionSpec::new("1.7.0.post1") <= VersionSpec::new("1.7"));
        assert!(VersionSpec::new("1.7.1") > VersionSpec::new("1.7.post1"));
        // this is supposed to be true: >1.7.post2 will allow 1.7.1 and 1.7.0.post3 but not 1.7.0.
        // assert_eq!(VersionSpec::new("1.7.0") > VersionSpec::new("1.7.post1"), false);
    }
    //--------------------------------------------------------------------------
    #[test]
    fn test_version_is_compatible_a() {
        assert!(VersionSpec::new("2.2").is_compatible(&VersionSpec::new("2.2")),);
        assert!(!VersionSpec::new("2.2").is_compatible(&VersionSpec::new("3.2")),);
        assert!(VersionSpec::new("2.2").is_compatible(&VersionSpec::new("2.2.3.9")),);
    }
    #[test]
    fn test_version_is_compatible_b() {
        assert!(VersionSpec::new("2.2-2").is_arbitrary_equal(&VersionSpec::new("2.2-2")),);
        assert!(
            VersionSpec::new("foobar").is_arbitrary_equal(&VersionSpec::new("foobar")),
        );
        assert!(
            !VersionSpec::new("foobar").is_arbitrary_equal(&VersionSpec::new("foobars")),
        );
        assert!(!VersionSpec::new("1.0")
            .is_arbitrary_equal(&VersionSpec::new("1.0+downstream1")),);
    }
    #[test]
    fn test_version_is_compatible_c() {
        assert!(!VersionSpec::new("2.2.1").is_compatible(&VersionSpec::new("2.2.0")),);
        assert!(VersionSpec::new("2.2.1").is_compatible(&VersionSpec::new("2.2.9")),);
        assert!(!VersionSpec::new("2.2.1").is_compatible(&VersionSpec::new("2.3")),);
    }
    #[test]
    fn test_version_is_compatible_d() {
        assert!(!VersionSpec::new("1.4.5.0").is_compatible(&VersionSpec::new("2.2.0")),);
        assert!(VersionSpec::new("1.4.5.0").is_compatible(&VersionSpec::new("1.4.5.9")),);
        assert!(!VersionSpec::new("1.4.5.0").is_compatible(&VersionSpec::new("1.4.6.0")),);
    }
    #[test]
    fn test_version_is_compatible_e() {
        assert!(VersionSpec::new("2").is_compatible(&VersionSpec::new("2.0.0.0")),);
        assert!(!VersionSpec::new("2").is_compatible(&VersionSpec::new("2.1")),);
        assert!(!VersionSpec::new("2").is_compatible(&VersionSpec::new("3")),);
    }
    //--------------------------------------------------------------------------
    #[test]
    fn test_version_spec_json_a() {
        let vs1 = VersionSpec::new("2.2.3rc2");
        let json = serde_json::to_string(&vs1).unwrap();
        assert_eq!(json, "\"2.2.3rc2\"");
        let vs2: VersionSpec = serde_json::from_str(&json).unwrap();
        assert_eq!(vs2, VersionSpec::new("2.2.3rc2"));
    }

    //--------------------------------------------------------------------------
    #[test]
    fn test_version_spec_tilde_a() {
        assert!(VersionSpec::new("1.7.1").is_tilde(&VersionSpec::new("1.7.2")),);
        assert!(!VersionSpec::new("1.7.1").is_tilde(&VersionSpec::new("1.7")),);
        assert!(!VersionSpec::new("1.7.1").is_tilde(&VersionSpec::new("1.8")),);
        assert!(!VersionSpec::new("1.7.1").is_tilde(&VersionSpec::new("2")),);
        assert!(!VersionSpec::new("1.7.1").is_tilde(&VersionSpec::new("0.8")),);
    }
    #[test]
    fn test_version_spec_tilde_b() {
        assert!(VersionSpec::new("1.2").is_tilde(&VersionSpec::new("1.2.1")),);
        assert!(VersionSpec::new("1.2").is_tilde(&VersionSpec::new("1.2.9.1")),);
        assert!(!VersionSpec::new("1.2").is_tilde(&VersionSpec::new("1.8")),);
        assert!(!VersionSpec::new("1.2").is_tilde(&VersionSpec::new("2")),);
        assert!(!VersionSpec::new("1.2").is_tilde(&VersionSpec::new("1.3")),);
    }
    #[test]
    fn test_version_spec_tilde_c() {
        assert!(VersionSpec::new("2").is_tilde(&VersionSpec::new("2.1")),);
        assert!(VersionSpec::new("2").is_tilde(&VersionSpec::new("2.9.1")),);
        assert!(!VersionSpec::new("2").is_tilde(&VersionSpec::new("1.8")),);
        assert!(!VersionSpec::new("2").is_tilde(&VersionSpec::new("3")),);
        assert!(!VersionSpec::new("2").is_tilde(&VersionSpec::new("4")),);
    }

    //--------------------------------------------------------------------------
    #[test]
    fn test_version_spec_caret_a() {
        assert!(VersionSpec::new("1.7.1").is_caret(&VersionSpec::new("1.7.2")),);
        assert!(VersionSpec::new("1.7.1").is_caret(&VersionSpec::new("1.20")),);
        assert!(!VersionSpec::new("1.7.1").is_caret(&VersionSpec::new("1.6")),);
        assert!(!VersionSpec::new("1.7.1").is_caret(&VersionSpec::new("2")),);
        assert!(!VersionSpec::new("1.7.1").is_caret(&VersionSpec::new("0.8")),);
    }
    #[test]
    fn test_version_spec_caret_b() {
        assert!(VersionSpec::new("1").is_caret(&VersionSpec::new("1.7.2")),);
        assert!(VersionSpec::new("1").is_caret(&VersionSpec::new("1.0.1")),);
        assert!(VersionSpec::new("1").is_caret(&VersionSpec::new("1.6")),);
        assert!(!VersionSpec::new("1").is_caret(&VersionSpec::new("2")),);
        assert!(!VersionSpec::new("1").is_caret(&VersionSpec::new("0.8")),);
    }
    #[test]
    fn test_version_spec_caret_c() {
        assert!(!VersionSpec::new("0").is_caret(&VersionSpec::new("1.7.2")),);
        assert!(!VersionSpec::new("0").is_caret(&VersionSpec::new("1.0.1")),);
        assert!(VersionSpec::new("0").is_caret(&VersionSpec::new("0.6")),);
        assert!(VersionSpec::new("0").is_caret(&VersionSpec::new("0.1.2")),);
        assert!(VersionSpec::new("0").is_caret(&VersionSpec::new("0.8")),);
    }
    #[test]
    fn test_version_spec_caret_d() {
        assert!(!VersionSpec::new("0.0.3").is_caret(&VersionSpec::new("1.7.2")),);
        assert!(!VersionSpec::new("0.0.3").is_caret(&VersionSpec::new("0.0.2")),);
        assert!(!VersionSpec::new("0.0.3").is_caret(&VersionSpec::new("0.0.4")),);
        assert!(VersionSpec::new("0.0.3").is_caret(&VersionSpec::new("0.0.3.1")),);
        assert!(VersionSpec::new("0.0.3").is_caret(&VersionSpec::new("0.0.3.9")),);
    }
    #[test]
    fn test_version_spec_caret_e() {
        assert!(VersionSpec::new("0.0").is_caret(&VersionSpec::new("0.0.2")),);
        assert!(VersionSpec::new("0.0").is_caret(&VersionSpec::new("0.0.2.5")),);
        assert!(!VersionSpec::new("0.0").is_caret(&VersionSpec::new("0.1.0")),);
        assert!(!VersionSpec::new("0.0").is_caret(&VersionSpec::new("1")),);
    }

    //--------------------------------------------------------------------------
    #[test]
    fn test_version_spec_has_wildcard_a() {
        assert!(VersionSpec::new("1.7.*").has_wildcard());
        assert!(!VersionSpec::new("1.7.3").has_wildcard());
    }
}