snapbox 1.2.1

Snapshot testing toolbox
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

/// Collection of files
pub trait DirFixture: std::fmt::Debug {
    /// Initialize a test fixture directory `root`
    fn write_to_path(&self, root: &std::path::Path) -> Result<(), crate::assert::Error>;
}

#[cfg(feature = "dir")] // for documentation purposes only
impl DirFixture for std::path::Path {
    fn write_to_path(&self, root: &std::path::Path) -> Result<(), crate::assert::Error> {
        super::copy_template(self, root)
    }
}

#[cfg(feature = "dir")] // for documentation purposes only
impl DirFixture for &'_ std::path::Path {
    fn write_to_path(&self, root: &std::path::Path) -> Result<(), crate::assert::Error> {
        std::path::Path::new(self).write_to_path(root)
    }
}

#[cfg(feature = "dir")] // for documentation purposes only
impl DirFixture for &'_ std::path::PathBuf {
    fn write_to_path(&self, root: &std::path::Path) -> Result<(), crate::assert::Error> {
        std::path::Path::new(self).write_to_path(root)
    }
}

#[cfg(feature = "dir")] // for documentation purposes only
impl DirFixture for std::path::PathBuf {
    fn write_to_path(&self, root: &std::path::Path) -> Result<(), crate::assert::Error> {
        std::path::Path::new(self).write_to_path(root)
    }
}

#[cfg(feature = "dir")] // for documentation purposes only
impl DirFixture for str {
    fn write_to_path(&self, root: &std::path::Path) -> Result<(), crate::assert::Error> {
        std::path::Path::new(self).write_to_path(root)
    }
}

#[cfg(feature = "dir")] // for documentation purposes only
impl DirFixture for &'_ str {
    fn write_to_path(&self, root: &std::path::Path) -> Result<(), crate::assert::Error> {
        std::path::Path::new(self).write_to_path(root)
    }
}

#[cfg(feature = "dir")] // for documentation purposes only
impl DirFixture for &'_ String {
    fn write_to_path(&self, root: &std::path::Path) -> Result<(), crate::assert::Error> {
        std::path::Path::new(self).write_to_path(root)
    }
}

#[cfg(feature = "dir")] // for documentation purposes only
impl DirFixture for String {
    fn write_to_path(&self, root: &std::path::Path) -> Result<(), crate::assert::Error> {
        std::path::Path::new(self).write_to_path(root)
    }
}

impl<P, S> DirFixture for &[(P, S)]
where
    P: AsRef<std::path::Path>,
    P: std::fmt::Debug,
    S: AsRef<[u8]>,
    S: std::fmt::Debug,
{
    fn write_to_path(&self, root: &std::path::Path) -> Result<(), crate::assert::Error> {
        let root = super::ops::canonicalize(root)
            .map_err(|e| format!("Failed to canonicalize {}: {}", root.display(), e))?;

        for (path, content) in self.iter() {
            let rel_path = path.as_ref();
            let path = root.join(rel_path);
            let path = super::ops::normalize_path(&path);
            if !path.starts_with(&root) {
                return Err(crate::assert::Error::new(format!(
                    "Fixture {} is for outside of the target root",
                    rel_path.display(),
                )));
            }

            let content = content.as_ref();

            if let Some(dir) = path.parent() {
                std::fs::create_dir_all(dir).map_err(|e| {
                    format!(
                        "Failed to create fixture directory {}: {}",
                        dir.display(),
                        e
                    )
                })?;
            }
            std::fs::write(&path, content)
                .map_err(|e| format!("Failed to write fixture {}: {}", path.display(), e))?;
        }
        Ok(())
    }
}

impl<const N: usize, P, S> DirFixture for [(P, S); N]
where
    P: AsRef<std::path::Path>,
    P: std::fmt::Debug,
    S: AsRef<[u8]>,
    S: std::fmt::Debug,
{
    fn write_to_path(&self, root: &std::path::Path) -> Result<(), crate::assert::Error> {
        let s: &[(P, S)] = self;
        s.write_to_path(root)
    }
}