armdb 0.1.13

sharded bitcask key-value storage optimized for NVMe
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

use armdb::{Config, ConstTree, DbError};
use tempfile::tempdir;

#[cfg(feature = "var-collections")]
use armdb::VarTree;

// ---------------------------------------------------------------------------
// db.meta format mismatch tests
// ---------------------------------------------------------------------------

#[test]
fn test_shard_count_mismatch() {
    let dir = tempdir().unwrap();

    // Create database with 3 shards
    {
        let tree = ConstTree::<[u8; 8], 8>::open(dir.path(), Config::test()).unwrap();
        tree.put(&1u64.to_be_bytes(), &100u64.to_be_bytes())
            .unwrap();
        tree.close().unwrap();
    }

    // Reopen with different shard_count → FormatMismatch
    {
        let mut config = Config::test();
        config.shard_count = 5; // was 3
        let err = unwrap_err(ConstTree::<[u8; 8], 8>::open(dir.path(), config));
        assert!(
            matches!(err, DbError::FormatMismatch(_)),
            "expected FormatMismatch, got: {err}"
        );
        let msg = err.to_string();
        assert!(
            msg.contains("shard_count"),
            "error should mention shard_count: {msg}"
        );
    }
}

#[test]
fn test_shard_prefix_bits_mismatch() {
    let dir = tempdir().unwrap();

    // Create database with shard_prefix_bits = 0
    {
        let tree = ConstTree::<[u8; 8], 8>::open(dir.path(), Config::test()).unwrap();
        tree.put(&1u64.to_be_bytes(), &100u64.to_be_bytes())
            .unwrap();
        tree.close().unwrap();
    }

    // Reopen with different shard_prefix_bits → FormatMismatch
    {
        let mut config = Config::test();
        config.shard_prefix_bits = 32; // was 0
        let err = unwrap_err(ConstTree::<[u8; 8], 8>::open(dir.path(), config));
        assert!(
            matches!(err, DbError::FormatMismatch(_)),
            "expected FormatMismatch, got: {err}"
        );
        let msg = err.to_string();
        assert!(
            msg.contains("shard_prefix_bits"),
            "error should mention shard_prefix_bits: {msg}"
        );
    }
}

#[test]
fn test_db_meta_invalid_size() {
    let dir = tempdir().unwrap();

    // Create db directory with a malformed db.meta
    std::fs::create_dir_all(dir.path()).unwrap();
    std::fs::write(dir.path().join("db.meta"), [0u8; 2]).unwrap(); // wrong size

    let err = unwrap_err(ConstTree::<[u8; 8], 8>::open(dir.path(), Config::test()));
    assert!(
        matches!(err, DbError::FormatMismatch(_)),
        "expected FormatMismatch, got: {err}"
    );
}

#[test]
fn test_same_config_reopens_fine() {
    let dir = tempdir().unwrap();
    let config = Config::test();

    {
        let tree = ConstTree::<[u8; 8], 8>::open(dir.path(), config.clone()).unwrap();
        tree.put(&1u64.to_be_bytes(), &42u64.to_be_bytes()).unwrap();
        tree.close().unwrap();
    }

    // Same config → should succeed
    {
        let tree = ConstTree::<[u8; 8], 8>::open(dir.path(), config).unwrap();
        assert_eq!(tree.get(&1u64.to_be_bytes()), Some(42u64.to_be_bytes()));
    }
}

// ---------------------------------------------------------------------------
// hints=false recovery tests
// ---------------------------------------------------------------------------

#[test]
fn test_const_recovery_no_hints() {
    let dir = tempdir().unwrap();
    let mut config = Config::test();
    config.hints = false;

    // Write entries with hints disabled
    {
        let tree = ConstTree::<[u8; 8], 8>::open(dir.path(), config.clone()).unwrap();

        for i in 0u64..100 {
            tree.put(&i.to_be_bytes(), &(i * 10).to_be_bytes()).unwrap();
        }

        tree.close().unwrap();
    }

    // Verify no hint files were created
    let has_hints = walkdir(dir.path(), ".hint");
    assert!(!has_hints, "no .hint files should exist when hints=false");

    // Reopen and verify all entries recovered via full scan
    {
        let tree = ConstTree::<[u8; 8], 8>::open(dir.path(), config).unwrap();
        assert_eq!(tree.len(), 100);

        for i in 0u64..100 {
            let actual = tree
                .get(&i.to_be_bytes())
                .unwrap_or_else(|| panic!("key {i} not found"));
            assert_eq!(actual, (i * 10).to_be_bytes());
        }
    }
}

#[test]
fn test_const_recovery_no_hints_with_deletes() {
    let dir = tempdir().unwrap();
    let mut config = Config::test();
    config.hints = false;

    {
        let tree = ConstTree::<[u8; 8], 8>::open(dir.path(), config.clone()).unwrap();

        for i in 0u64..100 {
            tree.put(&i.to_be_bytes(), &(i * 10).to_be_bytes()).unwrap();
        }
        for i in 0u64..50 {
            tree.delete(&i.to_be_bytes()).unwrap();
        }

        tree.close().unwrap();
    }

    {
        let tree = ConstTree::<[u8; 8], 8>::open(dir.path(), config).unwrap();
        assert_eq!(tree.len(), 50);

        for i in 0u64..50 {
            assert!(tree.get(&i.to_be_bytes()).is_none());
        }
        for i in 50u64..100 {
            let actual = tree
                .get(&i.to_be_bytes())
                .unwrap_or_else(|| panic!("key {i} not found"));
            assert_eq!(actual, (i * 10).to_be_bytes());
        }
    }
}

#[cfg(feature = "var-collections")]
#[test]
fn test_var_recovery_no_hints() {
    let dir = tempdir().unwrap();
    let mut config = Config::test();
    config.hints = false;

    {
        let tree = VarTree::<[u8; 8]>::open(dir.path(), config.clone()).unwrap();

        for i in 0u64..100 {
            let value = format!("val_{i}").into_bytes();
            tree.put(&i.to_be_bytes(), &value).unwrap();
        }

        tree.close().unwrap();
    }

    let has_hints = walkdir(dir.path(), ".hint");
    assert!(!has_hints, "no .hint files should exist when hints=false");

    {
        let tree = VarTree::<[u8; 8]>::open(dir.path(), config).unwrap();
        assert_eq!(tree.len(), 100);

        for i in 0u64..100 {
            let expected = format!("val_{i}").into_bytes();
            let actual = tree
                .get(&i.to_be_bytes())
                .unwrap_or_else(|| panic!("key {i} not found"));
            assert_eq!(actual.as_bytes(), expected.as_slice());
        }
    }
}

/// Switch from hints=true to hints=false between restarts.
/// Old hint files should be ignored, recovery via full scan.
#[test]
fn test_switch_hints_true_to_false() {
    let dir = tempdir().unwrap();

    // Open with hints=true, write, close (generates hint files)
    {
        let mut config = Config::test();
        config.hints = true;
        let tree = ConstTree::<[u8; 8], 8>::open(dir.path(), config).unwrap();

        for i in 0u64..50 {
            tree.put(&i.to_be_bytes(), &(i * 10).to_be_bytes()).unwrap();
        }

        tree.close().unwrap();
    }

    let had_hints = walkdir(dir.path(), ".hint");
    assert!(had_hints, "hint files should exist after hints=true close");

    // Reopen with hints=false — should recover fine via full scan
    {
        let mut config = Config::test();
        config.hints = false;
        let tree = ConstTree::<[u8; 8], 8>::open(dir.path(), config).unwrap();
        assert_eq!(tree.len(), 50);

        for i in 0u64..50 {
            let actual = tree
                .get(&i.to_be_bytes())
                .unwrap_or_else(|| panic!("key {i} not found"));
            assert_eq!(actual, (i * 10).to_be_bytes());
        }
    }
}

// ---------------------------------------------------------------------------
// Helpers
// ---------------------------------------------------------------------------

/// Extract error from Result, panicking if Ok.
fn unwrap_err<T>(result: Result<T, DbError>) -> DbError {
    match result {
        Err(e) => e,
        Ok(_) => panic!("expected error, got Ok"),
    }
}

/// Check if any file with the given extension exists recursively under `dir`.
fn walkdir(dir: &std::path::Path, ext: &str) -> bool {
    fn walk(dir: &std::path::Path, ext: &str) -> bool {
        let Ok(entries) = std::fs::read_dir(dir) else {
            return false;
        };
        for entry in entries.flatten() {
            let path = entry.path();
            if path.is_dir() {
                if walk(&path, ext) {
                    return true;
                }
            } else if path.to_string_lossy().ends_with(ext) {
                return true;
            }
        }
        false
    }
    walk(dir, ext)
}