quadlet-lens 0.2.3

Source-aware Rust library for Podman Quadlet parsing, validation, generation, and rendering
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

//! Lexical path forms retained before key-specific Quadlet resolution.

/// Lexical form of an authored Quadlet path value.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
#[non_exhaustive]
pub enum PathForm {
    /// Literal path beginning at the filesystem root.
    AbsoluteLiteral,
    /// Literal path beginning with `./` or `../`; supported keys resolve it from the unit file.
    UnitRelativeLiteral,
    /// Other literal relative text, including `~`, which systemd does not treat as shell expansion.
    RelativeLiteral,
    /// Text containing at least one non-escaped systemd `%` specifier.
    SystemdSpecifier,
}

/// Classifies path spelling without expanding specifiers or applying key-specific rules.
///
/// A doubled `%%` is a literal percent and does not by itself make a value a
/// specifier expression. The function deliberately does not claim that every
/// Quadlet key accepts every returned form.
#[must_use]
pub fn classify_path(value: &str) -> PathForm {
    if contains_systemd_specifier(value) {
        return PathForm::SystemdSpecifier;
    }
    if value.starts_with('/') {
        PathForm::AbsoluteLiteral
    } else if value == "." || value == ".." || value.starts_with("./") || value.starts_with("../") {
        PathForm::UnitRelativeLiteral
    } else {
        PathForm::RelativeLiteral
    }
}

fn contains_systemd_specifier(value: &str) -> bool {
    let mut bytes = value.bytes();
    while let Some(byte) = bytes.next() {
        if byte == b'%' {
            match bytes.next() {
                Some(b'%') => {}
                Some(_) | None => return true,
            }
        }
    }
    false
}

#[cfg(test)]
mod tests {
    use super::{PathForm, classify_path};

    #[test]
    fn distinguishes_literals_unit_relative_paths_and_specifiers() {
        assert_eq!(classify_path("/srv/data"), PathForm::AbsoluteLiteral);
        assert_eq!(classify_path("./data"), PathForm::UnitRelativeLiteral);
        assert_eq!(classify_path("../data"), PathForm::UnitRelativeLiteral);
        assert_eq!(classify_path("data"), PathForm::RelativeLiteral);
        assert_eq!(classify_path("~/data"), PathForm::RelativeLiteral);
        assert_eq!(classify_path("%h/data"), PathForm::SystemdSpecifier);
        assert_eq!(classify_path("/srv/%n/data"), PathForm::SystemdSpecifier);
        assert_eq!(classify_path("%%h/data"), PathForm::RelativeLiteral);
    }
}