chkpt-core 0.3.1

Core library for chkpt – a fast, content-addressable checkpoint system
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

use chkpt_core::index::{FileEntry, FileIndex};
use tempfile::TempDir;

fn make_entry(path: &str, hash_byte: u8, size: u64) -> FileEntry {
    FileEntry {
        path: path.to_string(),
        blob_hash: [hash_byte; 16],
        size,
        mtime_secs: 1000 + size as i64,
        mtime_nanos: 0,
        inode: Some(size + 100),
        mode: 0o644,
    }
}

#[test]
fn test_index_open_empty() {
    let dir = TempDir::new().unwrap();
    let idx = FileIndex::open(dir.path().join("index.bin")).unwrap();
    assert_eq!(idx.entries_by_path().unwrap().len(), 0);
}

#[test]
fn test_index_insert_and_get() {
    let dir = TempDir::new().unwrap();
    let mut idx = FileIndex::open(dir.path().join("index.bin")).unwrap();
    let entry = make_entry("src/main.rs", 1, 100);
    idx.upsert(&entry).unwrap();
    let loaded = idx.get("src/main.rs").unwrap().unwrap();
    assert_eq!(loaded.size, 100);
    assert_eq!(loaded.blob_hash, [1u8; 16]);
}

#[test]
fn test_index_get_nonexistent() {
    let dir = TempDir::new().unwrap();
    let idx = FileIndex::open(dir.path().join("index.bin")).unwrap();
    assert!(idx.get("nope").unwrap().is_none());
}

#[test]
fn test_index_upsert_updates() {
    let dir = TempDir::new().unwrap();
    let mut idx = FileIndex::open(dir.path().join("index.bin")).unwrap();
    idx.upsert(&make_entry("a.txt", 0, 10)).unwrap();
    idx.upsert(&make_entry("a.txt", 1, 20)).unwrap();
    let loaded = idx.get("a.txt").unwrap().unwrap();
    assert_eq!(loaded.size, 20);
    assert_eq!(loaded.blob_hash, [1u8; 16]);
}

#[test]
fn test_index_remove() {
    let dir = TempDir::new().unwrap();
    let mut idx = FileIndex::open(dir.path().join("index.bin")).unwrap();
    idx.upsert(&make_entry("del.txt", 0, 5)).unwrap();
    idx.remove("del.txt").unwrap();
    assert!(idx.get("del.txt").unwrap().is_none());
}

#[test]
fn test_index_all_paths() {
    let dir = TempDir::new().unwrap();
    let mut idx = FileIndex::open(dir.path().join("index.bin")).unwrap();
    for (i, name) in ["a.txt", "b.txt", "c.txt"].iter().enumerate() {
        idx.upsert(&make_entry(name, i as u8, 1)).unwrap();
    }
    let paths = idx.all_paths().unwrap();
    assert_eq!(paths.len(), 3);
}

#[test]
fn test_index_bulk_upsert() {
    let dir = TempDir::new().unwrap();
    let mut idx = FileIndex::open(dir.path().join("index.bin")).unwrap();
    let entries: Vec<FileEntry> = (0..100)
        .map(|i| make_entry(&format!("file_{}.txt", i), i as u8, i as u64))
        .collect();
    idx.bulk_upsert(&entries).unwrap();
    assert_eq!(idx.all_paths().unwrap().len(), 100);
}

#[test]
fn test_index_clear() {
    let dir = TempDir::new().unwrap();
    let mut idx = FileIndex::open(dir.path().join("index.bin")).unwrap();
    idx.upsert(&make_entry("x.txt", 0, 1)).unwrap();
    idx.clear().unwrap();
    assert_eq!(idx.all_paths().unwrap().len(), 0);
}

#[test]
fn test_index_entries_by_path() {
    let dir = TempDir::new().unwrap();
    let mut idx = FileIndex::open(dir.path().join("index.bin")).unwrap();
    idx.bulk_upsert(&[make_entry("a.txt", 1, 1), make_entry("b.txt", 2, 2)])
        .unwrap();
    let entries = idx.entries_by_path().unwrap();
    assert_eq!(entries.len(), 2);
    assert_eq!(entries["a.txt"].blob_hash, [1u8; 16]);
    assert_eq!(entries["b.txt"].size, 2);
}

#[test]
fn test_index_apply_changes_updates_and_removes_in_one_call() {
    let dir = TempDir::new().unwrap();
    let mut idx = FileIndex::open(dir.path().join("index.bin")).unwrap();
    idx.bulk_upsert(&[make_entry("keep.txt", 1, 1), make_entry("remove.txt", 2, 2)])
        .unwrap();

    idx.apply_changes(
        &[String::from("remove.txt")],
        &[FileEntry {
            path: "keep.txt".into(),
            blob_hash: [3u8; 16],
            size: 3,
            mtime_secs: 3,
            mtime_nanos: 0,
            inode: Some(10),
            mode: 0o755,
        }],
    )
    .unwrap();

    let entries = idx.entries_by_path().unwrap();
    assert_eq!(entries.len(), 1);
    assert_eq!(entries["keep.txt"].blob_hash, [3u8; 16]);
    assert_eq!(entries["keep.txt"].mode, 0o755);
    assert!(!entries.contains_key("remove.txt"));
}

#[test]
fn test_index_persistence_across_opens() {
    let dir = TempDir::new().unwrap();
    let index_path = dir.path().join("index.bin");

    {
        let mut idx = FileIndex::open(&index_path).unwrap();
        idx.upsert(&make_entry("persist.txt", 42, 999)).unwrap();
    }

    let idx2 = FileIndex::open(&index_path).unwrap();
    let loaded = idx2.get("persist.txt").unwrap().unwrap();
    assert_eq!(loaded.blob_hash, [42u8; 16]);
    assert_eq!(loaded.size, 999);
}

#[test]
fn test_index_gracefully_handles_corrupt_or_legacy_format() {
    // Simulate an index.bin written by an older version with an incompatible
    // binary layout (e.g. 32-byte blob_hash instead of 16-byte).  The index
    // is a pure performance cache so a decode failure must not propagate as
    // an error — it should silently start with an empty index instead.
    let dir = TempDir::new().unwrap();
    let index_path = dir.path().join("index.bin");

    // Write garbage / incompatible bytes that bitcode cannot decode into
    // Vec<FileEntry>.
    std::fs::write(&index_path, b"this is not valid bitcode data").unwrap();

    let idx = FileIndex::open(&index_path).unwrap(); // must not panic/error
    assert_eq!(idx.all_paths().unwrap().len(), 0);
}