Skip to main content

spudkit_core/
spud.rs

1/// A spud — a named app that maps to a `spud-{name}` Docker image.
2#[derive(Clone, Debug)]
3pub struct Spud {
4    name: String,
5}
6
7impl Spud {
8    pub fn new(name: &str) -> anyhow::Result<Self> {
9        if name.is_empty() || name.contains('/') || name.contains("..") {
10            anyhow::bail!("invalid spud name: {name:?}");
11        }
12        Ok(Self {
13            name: name.to_string(),
14        })
15    }
16
17    pub fn name(&self) -> &str {
18        &self.name
19    }
20
21    pub fn socket_path(&self) -> String {
22        format!("/tmp/spudkit-{}.sock", self.name)
23    }
24}
25
26#[cfg(test)]
27mod tests {
28    use super::*;
29    use rstest::rstest;
30
31    #[test]
32    fn socket_path_uses_name() {
33        let spud = Spud::new("hello-world").unwrap();
34        assert_eq!(spud.socket_path(), "/tmp/spudkit-hello-world.sock");
35    }
36
37    #[test]
38    fn name_returns_short_name() {
39        let spud = Spud::new("hello-world").unwrap();
40        assert_eq!(spud.name(), "hello-world");
41    }
42
43    #[rstest]
44    #[case::empty("")]
45    #[case::slash("foo/bar")]
46    #[case::dotdot("..")]
47    #[case::traversal("../../etc")]
48    fn rejects_invalid_names(#[case] name: &str) {
49        assert!(Spud::new(name).is_err(), "should reject: {name:?}");
50    }
51}