uselesskey-core 0.10.0

Core factory, deterministic derivation, and cache engine for uselesskey test fixtures.
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

use std::fmt;
use std::path::Path;

use crate::Error;
use crate::srp::sink::TempArtifact as RawTempArtifact;

pub struct TempArtifact {
    inner: RawTempArtifact,
}

impl fmt::Debug for TempArtifact {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("TempArtifact")
            .field("path", &self.inner.path())
            .finish_non_exhaustive()
    }
}

impl TempArtifact {
    pub fn new_bytes(prefix: &str, suffix: &str, bytes: &[u8]) -> Result<Self, Error> {
        let inner = RawTempArtifact::new_bytes(prefix, suffix, bytes)?;
        Ok(Self { inner })
    }

    pub fn new_string(prefix: &str, suffix: &str, s: &str) -> Result<Self, Error> {
        let inner = RawTempArtifact::new_string(prefix, suffix, s)?;
        Ok(Self { inner })
    }

    pub fn path(&self) -> &Path {
        self.inner.path()
    }

    pub fn read_to_bytes(&self) -> Result<Vec<u8>, Error> {
        self.inner.read_to_bytes().map_err(Error::from)
    }

    pub fn read_to_string(&self) -> Result<String, Error> {
        self.inner.read_to_string().map_err(Error::from)
    }
}

#[cfg(test)]
mod tests {
    use super::TempArtifact;
    use std::thread;
    use std::time::Duration;

    #[test]
    fn temp_artifact_string_round_trips_and_debug_mentions_path() -> Result<(), crate::Error> {
        let artifact = TempArtifact::new_string("uselesskey-", ".unit.txt", "hello-world")?;

        let dbg = format!("{artifact:?}");
        assert!(dbg.contains("TempArtifact"));
        assert!(dbg.contains(".unit.txt"));

        let text = artifact.read_to_string()?;
        assert_eq!(text, "hello-world");
        Ok(())
    }

    #[test]
    fn temp_artifact_bytes_round_trip() -> Result<(), crate::Error> {
        let bytes = vec![0x01, 0x02, 0x03, 0xFF];
        let artifact = TempArtifact::new_bytes("uselesskey-", ".unit.bin", &bytes)?;

        let read = artifact.read_to_bytes()?;
        assert_eq!(read, bytes);
        Ok(())
    }

    #[test]
    fn temp_artifact_exposes_live_path_and_deletes_on_drop() -> Result<(), crate::Error> {
        let path = {
            let artifact = TempArtifact::new_string("uselesskey-", ".unit.cleanup", "cleanup")?;
            let path = artifact.path().to_path_buf();
            assert!(
                path.exists(),
                "temp file should exist while artifact is alive"
            );
            path
        };

        let mut attempts = 0;
        loop {
            thread::sleep(Duration::from_millis(10));
            attempts += 1;
            if !path.exists() || attempts >= 5 {
                break;
            }
        }

        assert!(!path.exists(), "temp file should be deleted after drop");
        Ok(())
    }

    #[test]
    fn temp_artifact_read_to_string_replaces_invalid_utf8() -> Result<(), crate::Error> {
        let artifact = TempArtifact::new_bytes("uselesskey-", ".unit.utf8", &[0xFF, 0xFE, 0xFD])?;
        let text = artifact.read_to_string()?;
        assert!(text.contains('\u{FFFD}'));
        Ok(())
    }
}