fcache 0.2.0

File caching library with lazy creation, automatic refresh, and callback-based initialization
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

mod common;

use common::*;

#[test]
fn test_get_file() -> anyhow::Result<()> {
    // Create a new cache instance
    let cache = fcache::new()?;

    // Create a file in the cache
    let cache_file = cache.get("file.txt", |mut file| {
        file.write_all(TEST_CONTENT)?;
        Ok(())
    })?;

    // Verify file name matches
    assert_eq!(cache_file.name(), "file.txt");

    // Verify file path ends with name
    assert!(cache_file.path().ends_with(cache_file.name()));

    // Verify file exists on disk
    assert!(cache_file.path().exists());

    // Verify content matches
    let mut content = Vec::new();
    cache_file.open()?.read_to_end(&mut content)?;
    assert_eq!(content, TEST_CONTENT, "File content does not match");

    Ok(())
}

#[test]
fn test_get_lazy_file() -> anyhow::Result<()> {
    // Create a new cache instance
    let cache = fcache::new()?;

    // Create a lazy file in the cache (not created until accessed)
    let cache_file = cache.get_lazy("file.txt", |mut file| {
        file.write_all(TEST_CONTENT)?;
        Ok(())
    })?;

    // Verify file name matches
    assert_eq!(cache_file.name(), "file.txt");

    // Verify file path ends with name
    assert!(cache_file.path().ends_with(cache_file.name()));

    // Verify file doesn't exist yet
    assert!(!cache_file.path().exists());

    // Access the file (triggers creation)
    let mut file = cache_file.open()?;

    // Now file should exist
    assert!(cache_file.path().exists());

    // Verify content matches
    let mut content = Vec::new();
    file.read_to_end(&mut content)?;
    assert_eq!(content, TEST_CONTENT, "File content does not match");

    Ok(())
}

#[test]
fn test_double_file_get() -> anyhow::Result<()> {
    // Create a new cache instance
    let cache = fcache::new()?;

    // Create a file in the cache
    let _ = cache.get("file.txt", |_| Ok(()))?;

    // Create a second reference to the same file
    assert!(
        matches!(
            cache.get("file.txt", |_| Ok(())),
            Err(fcache::Error::FileAlreadyExists { .. })
        ),
        "Should return an error when trying to create the same file twice"
    );

    Ok(())
}

#[test]
fn test_file_empty_name() -> anyhow::Result<()> {
    // Create a new cache instance
    let cache = fcache::new()?;

    // Create a file in the cache
    assert!(
        matches!(cache.get("", |_| Ok(())), Err(fcache::Error::InvalidPath { .. }),),
        "Should return an error when trying to create a file with empty name"
    );

    // Create a file in the cache
    assert!(
        matches!(cache.get(" ", |_| Ok(())), Err(fcache::Error::InvalidPath { .. }),),
        "Should return an error when trying to create a file with empty name"
    );

    // Create a file in the cache
    assert!(
        matches!(cache.get("\t", |_| Ok(())), Err(fcache::Error::InvalidPath { .. }),),
        "Should return an error when trying to create a file with empty name"
    );

    // Create a file in the cache
    assert!(
        matches!(cache.get("\n", |_| Ok(())), Err(fcache::Error::InvalidPath { .. }),),
        "Should return an error when trying to create a file with empty name"
    );

    Ok(())
}

#[test]
fn test_file_dir_name() -> anyhow::Result<()> {
    // Create a new cache instance
    let cache = fcache::new()?;

    // Create a file in a subdirectory
    assert!(
        matches!(cache.get("dir/", |_| Ok(())), Err(fcache::Error::InvalidPath { .. }),),
        "Should return an error when trying to create a file with a trailing slash"
    );

    Ok(())
}

#[test]
fn test_file_out_of_cache() -> anyhow::Result<()> {
    // Create a new cache instance
    let cache = fcache::new()?;

    // Create a file out of the cache
    assert!(
        matches!(
            cache.get("../file.txt", |_| Ok(())),
            Err(fcache::Error::PathTraversal { .. }),
        ),
        "Should return an error when trying to create a file outside the cache"
    );

    // Create a file out of the cache
    assert!(
        matches!(
            cache.get("a/../../file.txt", |_| Ok(())),
            Err(fcache::Error::PathTraversal { .. }),
        ),
        "Should return an error when trying to create a file outside the cache"
    );

    // Create a file out of the cache
    assert!(
        matches!(
            cache.get("a/b/../c/../../../d/file.txt", |_| Ok(())),
            Err(fcache::Error::PathTraversal { .. }),
        ),
        "Should return an error when trying to create a file outside the cache"
    );

    Ok(())
}

#[test]
fn test_file_callback_error() -> anyhow::Result<()> {
    // Create a new cache instance
    let cache = fcache::new()?;

    // Create a file in the cache
    assert!(
        matches!(
            cache.get("file.txt", |_| {
                let _ = "fail".parse::<i32>()?;
                Ok(())
            }),
            Err(fcache::Error::Callback { .. })
        ),
        "Should return an error when callback fails"
    );

    Ok(())
}

#[test]
fn test_file_removal() -> anyhow::Result<()> {
    // Create a new cache instance
    let cache = fcache::new()?;

    // Create a file in the cache
    let cache_file = cache.get("file.txt", |_| Ok(()))?;

    // Verify file exists
    assert!(cache_file.path().exists());

    // Remove the file
    cache_file.remove()?;

    // Verify file is gone
    assert!(!cache_file.path().exists());

    Ok(())
}

#[test]
fn test_nested_file_removal() -> anyhow::Result<()> {
    // Create a new cache instance
    let cache = fcache::new()?;

    // Create a file in the cache
    let cache_file = cache.get("a/b/c/d/file.txt", |_| Ok(()))?;

    // Verify file name matches
    assert_eq!(cache_file.name(), "file.txt");

    // Verify file path ends with name
    assert!(cache_file.path().ends_with(cache_file.name()));

    // Create a file
    let _ = cache.get("a/b/c/file.txt", |_| Ok(()))?;

    // Verify file exists
    assert!(cache_file.path().exists());

    // Remove the file
    cache_file.remove()?;

    // Verify file is gone
    assert!(!cache_file.path().exists());
    assert_eq!(
        cache_file.path().parent().map(|parent| parent.exists()),
        Some(false),
        "Parent directory should not exist"
    );
    assert_eq!(
        cache_file
            .path()
            .parent()
            .and_then(|parent| parent.parent())
            .map(|parent| parent.exists()),
        Some(true),
        "Grandparent directory should exist"
    );

    Ok(())
}

#[test]
fn test_large_file_content() -> anyhow::Result<()> {
    // Create a new cache instance
    let cache = fcache::new()?;

    // Create a file in the cache
    let cache_file = cache.get("file.txt", |mut file| {
        file.write_all(TEST_LARGE_CONTENT)?;
        Ok(())
    })?;

    // Verify file exists on disk
    assert!(cache_file.path().exists());

    // Verify content matches
    let mut content = Vec::new();
    cache_file.open()?.read_to_end(&mut content)?;
    assert_eq!(content, TEST_LARGE_CONTENT, "File content does not match");

    Ok(())
}

#[test]
fn test_file_with_refresh_interval() -> anyhow::Result<()> {
    let refresh_interval = Duration::from_secs(10);

    // Create a new cache instance
    let cache = fcache::new()?;

    // Create a file in the cache
    let cache_file = cache
        .get("file.txt", |_| Ok(()))?
        .with_refresh_interval(refresh_interval);

    // Verify refresh interval
    assert_eq!(
        cache_file.refresh_interval(),
        refresh_interval,
        "Refresh interval was not updated"
    );

    Ok(())
}

#[test]
fn test_file_with_default_refresh_interval() -> anyhow::Result<()> {
    let refresh_interval = Duration::from_secs(10);

    // Create a new cache instance
    let cache = fcache::new()?;

    // Create a file in the cache
    let cache_file = cache
        .get("file.txt", |_| Ok(()))?
        .with_refresh_interval(refresh_interval);

    // Update the cache file to use the default refresh interval
    let cache_file = cache_file.with_default_refresh_interval();

    // Verify the refresh interval is set to the default
    assert_eq!(
        cache_file.refresh_interval(),
        cache.refresh_interval(),
        "Refresh interval was not set to default"
    );

    Ok(())
}