path-rs 0.1.0

Cross-platform path expansion, normalization, traversal, searching, and caching
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

//! Memory cache edge cases and optional persistent cache.

use path_rs::{CacheKey, CacheMode, CacheOptions, CacheValue, DiscoveryCache, MemoryCache};
use std::path::PathBuf;
use std::time::{Duration, SystemTime};

fn key(pattern: &str) -> CacheKey {
    CacheKey {
        root: PathBuf::from("/repo"),
        patterns: vec![pattern.into()],
        exclude_patterns: vec![],
        recursive: true,
        follow_symlinks: false,
        include_hidden: false,
        include_files: true,
        include_directories: true,
        include_symlinks: true,
        max_depth: None,
        sort: path_rs::SortMode::Path,
    }
}

fn empty_value() -> CacheValue {
    CacheValue {
        entries: vec![],
        stored_at: SystemTime::now(),
        ttl: None,
    }
}

#[test]
fn different_keys_for_different_options() {
    let mut a = key("*.rs");
    let mut b = key("*.rs");
    b.include_hidden = true;
    assert_ne!(a, b);
    a.patterns = vec!["**/*.rs".into()];
    assert_ne!(a, b);
}

#[test]
fn ttl_and_eviction() {
    let cache = MemoryCache::new(CacheOptions {
        mode: CacheMode::Memory,
        ttl: Some(Duration::from_millis(1)),
        max_entries: 2,
        validate_metadata: false,
    });

    let k = key("a");
    cache
        .put(
            k.clone(),
            CacheValue {
                entries: vec![],
                stored_at: SystemTime::now() - Duration::from_secs(10),
                ttl: Some(Duration::from_millis(1)),
            },
        )
        .unwrap();
    assert!(cache.get(&k).unwrap().is_none());

    cache.put(key("1"), empty_value()).unwrap();
    cache.put(key("2"), empty_value()).unwrap();
    cache.put(key("3"), empty_value()).unwrap();
    assert!(cache.len().unwrap() <= 2);
}

#[test]
fn invalidate_root_prefix() {
    let cache = MemoryCache::new(CacheOptions {
        mode: CacheMode::Memory,
        ttl: None,
        max_entries: 16,
        validate_metadata: false,
    });
    let mut k1 = key("*.rs");
    k1.root = PathBuf::from("/repo/a");
    let mut k2 = key("*.rs");
    k2.root = PathBuf::from("/other");
    cache.put(k1.clone(), empty_value()).unwrap();
    cache.put(k2.clone(), empty_value()).unwrap();
    cache.invalidate(std::path::Path::new("/repo")).unwrap();
    assert!(cache.get(&k1).unwrap().is_none());
    assert!(cache.get(&k2).unwrap().is_some());
}

#[cfg(feature = "persistent-cache")]
#[test]
fn persistent_cache_roundtrip() {
    use path_rs::PersistentCache;
    use std::time::Duration;

    let name = format!(
        "path-rs-test-{}",
        std::time::SystemTime::now()
            .duration_since(std::time::UNIX_EPOCH)
            .unwrap()
            .as_nanos()
    );
    let file = format!("{name}.json");
    let cache = PersistentCache::open(
        &name,
        &file,
        CacheOptions {
            mode: CacheMode::Persistent,
            ttl: Some(Duration::from_secs(3600)),
            max_entries: 32,
            validate_metadata: false,
        },
    )
    .unwrap();

    let k = key("**/*.rs");
    cache.put(k.clone(), empty_value()).unwrap();
    assert!(cache.get(&k).unwrap().is_some());
    cache.clear().unwrap();
    assert!(cache.get(&k).unwrap().is_none());
}

#[cfg(feature = "persistent-cache")]
#[test]
fn corrupt_persistent_cache_is_miss() {
    use path_rs::PersistentCache;

    let name = format!(
        "path-rs-corrupt-{}",
        std::time::SystemTime::now()
            .duration_since(std::time::UNIX_EPOCH)
            .unwrap()
            .as_nanos()
    );
    let cache = PersistentCache::open(
        &name,
        "corrupt.json",
        CacheOptions {
            mode: CacheMode::Persistent,
            ttl: None,
            max_entries: 8,
            validate_metadata: false,
        },
    )
    .unwrap();
    // Write garbage into the cache file path
    let path = cache.path().to_path_buf();
    std::fs::write(&path, b"not-json{{{").unwrap();

    let cache2 = PersistentCache::open(
        &name,
        "corrupt.json",
        CacheOptions {
            mode: CacheMode::Persistent,
            ttl: None,
            max_entries: 8,
            validate_metadata: false,
        },
    )
    .unwrap();
    assert!(cache2.get(&key("x")).unwrap().is_none());
}