seerdb 0.0.10

Research-grade storage engine with learned data structures
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
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
//! Metamorphic testing: Test invariants that should always hold
//!
//! These tests verify properties that must be true regardless of input:
//! - Insert then delete all = empty database
//! - Different insertion orders = same final state
//! - Compaction doesn't change query results
//! - Flush doesn't change query results
//!
//! Run with: `cargo test metamorphic`

use rand::seq::SliceRandom;
use rand::SeedableRng;
use seerdb::{DBOptions, DB};
use std::collections::BTreeMap;
use tempfile::TempDir;

/// Helper to collect all key-value pairs from database
fn collect_all(db: &DB) -> BTreeMap<Vec<u8>, Vec<u8>> {
    let mut result = BTreeMap::new();
    if let Ok(iter) = db.iter() {
        for item in iter {
            if let Ok((k, v)) = item {
                result.insert(k.to_vec(), v.to_vec());
            }
        }
    }
    result
}

/// Helper to create a test database
fn create_db(temp_dir: &TempDir) -> DB {
    DBOptions::default()
        .background_compaction(false)
        .background_flush(false)
        .memtable_capacity(4096) // Small to trigger flushes
        .open(temp_dir.path())
        .expect("Failed to open database")
}

// =============================================================================
// METAMORPHIC PROPERTY 1: Insert then delete all = empty
// =============================================================================

/// Insert N keys, then delete all N keys. Database should be empty.
#[test]
fn test_metamorphic_insert_delete_all_is_empty() {
    let temp_dir = TempDir::new().unwrap();
    let db = create_db(&temp_dir);

    let keys: Vec<Vec<u8>> = (0..100)
        .map(|i| format!("key_{:04}", i).into_bytes())
        .collect();

    // Insert all keys
    for key in &keys {
        db.put(key, b"value").unwrap();
    }

    // Verify they exist
    for key in &keys {
        assert!(db.get(key).unwrap().is_some(), "Key should exist after put");
    }

    // Delete all keys
    for key in &keys {
        db.delete(key).unwrap();
    }

    // Verify database is empty
    for key in &keys {
        assert!(
            db.get(key).unwrap().is_none(),
            "Key should not exist after delete"
        );
    }

    // Verify iteration returns nothing
    let all = collect_all(&db);
    assert!(all.is_empty(), "Database should be empty after delete all");
}

/// Same test but with flush between insert and delete
#[test]
fn test_metamorphic_insert_flush_delete_all_is_empty() {
    let temp_dir = TempDir::new().unwrap();
    let db = create_db(&temp_dir);

    let keys: Vec<Vec<u8>> = (0..100)
        .map(|i| format!("key_{:04}", i).into_bytes())
        .collect();

    // Insert all keys
    for key in &keys {
        db.put(key, b"value").unwrap();
    }

    // Flush to SSTable
    db.flush().unwrap();

    // Delete all keys
    for key in &keys {
        db.delete(key).unwrap();
    }

    // Flush tombstones
    db.flush().unwrap();

    // Verify database is empty
    for key in &keys {
        assert!(
            db.get(key).unwrap().is_none(),
            "Key {} should not exist after delete",
            String::from_utf8_lossy(key)
        );
    }
}

/// Insert, flush, delete, flush, reopen - should still be empty
#[test]
fn test_metamorphic_insert_delete_reopen_is_empty() {
    let temp_dir = TempDir::new().unwrap();
    let db_path = temp_dir.path().to_path_buf();

    let keys: Vec<Vec<u8>> = (0..50)
        .map(|i| format!("key_{:04}", i).into_bytes())
        .collect();

    // Phase 1: Insert and delete
    {
        let db = create_db(&temp_dir);
        for key in &keys {
            db.put(key, b"value").unwrap();
        }
        db.flush().unwrap();
        for key in &keys {
            db.delete(key).unwrap();
        }
        db.flush().unwrap();
    }

    // Phase 2: Reopen and verify empty
    {
        let db = DBOptions::default()
            .background_compaction(false)
            .background_flush(false)
            .open(&db_path)
            .unwrap();

        for key in &keys {
            assert!(
                db.get(key).unwrap().is_none(),
                "Key should not exist after reopen"
            );
        }
    }
}

// =============================================================================
// METAMORPHIC PROPERTY 2: Different insertion orders = same final state
// =============================================================================

/// Insert keys in different orders, final state should be identical
#[test]
fn test_metamorphic_insertion_order_independent() {
    let keys: Vec<(Vec<u8>, Vec<u8>)> = (0..100)
        .map(|i| {
            (
                format!("key_{:04}", i).into_bytes(),
                format!("value_{:04}", i).into_bytes(),
            )
        })
        .collect();

    // Order 1: Sequential
    let temp_dir1 = TempDir::new().unwrap();
    let db1 = create_db(&temp_dir1);
    for (k, v) in &keys {
        db1.put(k, v).unwrap();
    }
    db1.flush().unwrap();

    // Order 2: Reversed
    let temp_dir2 = TempDir::new().unwrap();
    let db2 = create_db(&temp_dir2);
    for (k, v) in keys.iter().rev() {
        db2.put(k, v).unwrap();
    }
    db2.flush().unwrap();

    // Order 3: Shuffled
    let temp_dir3 = TempDir::new().unwrap();
    let db3 = create_db(&temp_dir3);
    let mut shuffled = keys.clone();
    let mut rng = rand::rngs::StdRng::seed_from_u64(12345);
    shuffled.shuffle(&mut rng);
    for (k, v) in &shuffled {
        db3.put(k, v).unwrap();
    }
    db3.flush().unwrap();

    // Collect final states
    let state1 = collect_all(&db1);
    let state2 = collect_all(&db2);
    let state3 = collect_all(&db3);

    // All should be identical
    assert_eq!(state1, state2, "Sequential vs Reversed differ");
    assert_eq!(state1, state3, "Sequential vs Shuffled differ");
}

/// Interleaved puts to same keys - last write wins
#[test]
fn test_metamorphic_last_write_wins() {
    let temp_dir = TempDir::new().unwrap();
    let db = create_db(&temp_dir);

    // Write multiple values to same key
    db.put(b"key", b"value1").unwrap();
    db.put(b"key", b"value2").unwrap();
    db.put(b"key", b"value3").unwrap();

    // Last write should win
    let result = db.get(b"key").unwrap().unwrap();
    assert_eq!(result.as_ref(), b"value3");

    // Even after flush
    db.flush().unwrap();
    let result = db.get(b"key").unwrap().unwrap();
    assert_eq!(result.as_ref(), b"value3");
}

// =============================================================================
// METAMORPHIC PROPERTY 3: Flush doesn't change query results
// =============================================================================

/// Query results should be identical before and after flush
#[test]
fn test_metamorphic_flush_preserves_results() {
    let temp_dir = TempDir::new().unwrap();
    let db = create_db(&temp_dir);

    // Insert data
    for i in 0..100 {
        let key = format!("key_{:04}", i);
        let value = format!("value_{:04}", i);
        db.put(key.as_bytes(), value.as_bytes()).unwrap();
    }

    // Collect state before flush
    let before_flush = collect_all(&db);

    // Flush
    db.flush().unwrap();

    // Collect state after flush
    let after_flush = collect_all(&db);

    assert_eq!(before_flush, after_flush, "Flush changed query results");
}

/// Multiple flushes should not change results
#[test]
fn test_metamorphic_multiple_flushes_idempotent() {
    let temp_dir = TempDir::new().unwrap();
    let db = create_db(&temp_dir);

    // Insert data
    for i in 0..50 {
        db.put(
            format!("key_{:04}", i).as_bytes(),
            format!("value_{:04}", i).as_bytes(),
        )
        .unwrap();
    }

    db.flush().unwrap();
    let after_first = collect_all(&db);

    db.flush().unwrap();
    let after_second = collect_all(&db);

    db.flush().unwrap();
    let after_third = collect_all(&db);

    assert_eq!(after_first, after_second);
    assert_eq!(after_second, after_third);
}

// =============================================================================
// METAMORPHIC PROPERTY 4: Compaction doesn't change query results
// =============================================================================

/// Trigger compaction, verify results unchanged
#[test]
fn test_metamorphic_compaction_preserves_results() {
    let temp_dir = TempDir::new().unwrap();
    let db = DBOptions::default()
        .background_compaction(false)
        .background_flush(false)
        .memtable_capacity(1024) // Very small to trigger many flushes
        .open(temp_dir.path())
        .unwrap();

    // Create multiple SSTables by flushing repeatedly
    for batch in 0..5 {
        for i in 0..20 {
            let key = format!("key_{:02}_{:04}", batch, i);
            let value = format!("value_{:02}_{:04}", batch, i);
            db.put(key.as_bytes(), value.as_bytes()).unwrap();
        }
        db.flush().unwrap();
    }

    // Collect state before adding more data
    let before_more_data = collect_all(&db);

    // Force more flushes to potentially trigger compaction
    for batch in 5..10 {
        for i in 0..20 {
            let key = format!("key_{:02}_{:04}", batch, i);
            let value = format!("value_{:02}_{:04}", batch, i);
            db.put(key.as_bytes(), value.as_bytes()).unwrap();
        }
        db.flush().unwrap();
    }

    // Verify original keys still correct (data from before_more_data preserved)
    let after_more_data = collect_all(&db);
    for (key, value) in &before_more_data {
        assert_eq!(
            after_more_data.get(key),
            Some(value),
            "Original key {:?} was lost or corrupted after adding more data",
            String::from_utf8_lossy(key)
        );
    }

    // Also verify via point lookups
    for batch in 0..5 {
        for i in 0..20 {
            let key = format!("key_{:02}_{:04}", batch, i);
            let expected = format!("value_{:02}_{:04}", batch, i);
            let result = db.get(key.as_bytes()).unwrap();
            assert_eq!(
                result.as_ref().map(|b| b.as_ref()),
                Some(expected.as_bytes()),
                "Key {} has wrong value after compaction",
                key
            );
        }
    }
}

// =============================================================================
// METAMORPHIC PROPERTY 5: Reopen doesn't change query results
// =============================================================================

/// Close and reopen database, verify results unchanged
#[test]
fn test_metamorphic_reopen_preserves_results() {
    let temp_dir = TempDir::new().unwrap();
    let db_path = temp_dir.path().to_path_buf();

    let expected: BTreeMap<Vec<u8>, Vec<u8>>;

    // Phase 1: Write data
    {
        let db = create_db(&temp_dir);
        for i in 0..100 {
            db.put(
                format!("key_{:04}", i).as_bytes(),
                format!("value_{:04}", i).as_bytes(),
            )
            .unwrap();
        }
        db.flush().unwrap();
        expected = collect_all(&db);
    }

    // Phase 2: Reopen and compare
    {
        let db = DBOptions::default()
            .background_compaction(false)
            .background_flush(false)
            .open(&db_path)
            .unwrap();
        let actual = collect_all(&db);
        assert_eq!(expected, actual, "Data changed after reopen");
    }
}

// =============================================================================
// METAMORPHIC PROPERTY 6: Get non-existent key always returns None
// =============================================================================

#[test]
fn test_metamorphic_get_nonexistent_always_none() {
    let temp_dir = TempDir::new().unwrap();
    let db = create_db(&temp_dir);

    // Empty database
    assert!(db.get(b"nonexistent").unwrap().is_none());

    // After some puts
    db.put(b"key1", b"value1").unwrap();
    db.put(b"key2", b"value2").unwrap();
    assert!(db.get(b"nonexistent").unwrap().is_none());

    // After flush
    db.flush().unwrap();
    assert!(db.get(b"nonexistent").unwrap().is_none());

    // After delete
    db.delete(b"key1").unwrap();
    assert!(db.get(b"nonexistent").unwrap().is_none());
    assert!(db.get(b"key1").unwrap().is_none()); // Deleted key also None
}

// =============================================================================
// METAMORPHIC PROPERTY 7: Empty value is distinguishable from None
// =============================================================================

#[test]
fn test_metamorphic_empty_value_vs_none() {
    let temp_dir = TempDir::new().unwrap();
    let db = create_db(&temp_dir);

    // Put empty value
    db.put(b"empty_key", b"").unwrap();

    // Should return Some(empty), not None
    let result = db.get(b"empty_key").unwrap();
    assert!(result.is_some(), "Empty value should be Some, not None");
    assert_eq!(result.unwrap().as_ref(), b"");

    // Non-existent should be None
    assert!(db.get(b"nonexistent").unwrap().is_none());

    // After flush
    db.flush().unwrap();
    let result = db.get(b"empty_key").unwrap();
    assert!(result.is_some());
    assert_eq!(result.unwrap().as_ref(), b"");
}