tegdb 0.5.0

The name TegridyDB (short for TegDB) is inspired by the Tegridy Farm in South Park and tries to correct some of the wrong database implementations, such as null support, implicit conversion support, etc.
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
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
//! - Storage engine operations

use std::env;
use std::fs;
use std::path::PathBuf;
use tegdb::storage_engine::{EngineConfig, StorageEngine};
use tegdb::Result;

/// Creates a unique temporary file path for tests
fn temp_db_path(prefix: &str) -> PathBuf {
    let mut path = env::temp_dir();
    path.push(format!("tegdb_test_{}_{}", prefix, std::process::id()));
    path.with_extension("teg")
}

#[test]
fn test_engine() -> Result<()> {
    let path = temp_db_path("basic");
    if path.exists() {
        fs::remove_file(&path)?;
    }

    let mut engine = StorageEngine::new(path.clone())?;

    // Test set and get
    let key = b"key";
    let value = b"value";
    engine.set(key, value.to_vec())?;
    let get_value = engine.get(key).unwrap();
    assert_eq!(
        &*get_value,
        value,
        "Expected: {}, Got: {}",
        String::from_utf8_lossy(value),
        String::from_utf8_lossy(&get_value)
    );

    // Test del
    engine.del(key)?;
    let get_value = engine.get(key);
    assert_eq!(
        get_value,
        None,
        "Expected: None, Got: {}",
        String::from_utf8_lossy(get_value.as_deref().unwrap_or_default())
    );

    // Test scan
    let start_key = b"a";
    let end_key = b"z";
    engine.set(start_key, b"start_value".to_vec())?;
    engine.set(end_key, b"end_value".to_vec())?;

    let mut end_key_extended = Vec::new();
    end_key_extended.extend_from_slice(end_key);
    end_key_extended.push(0);

    let result = engine
        .scan(start_key.to_vec()..end_key_extended)?
        .collect::<Vec<_>>();
    assert_eq!(result.len(), 2);

    // Cleanup
    fs::remove_file(path)?;

    Ok(())
}

#[test]
fn test_persistence() -> Result<()> {
    let path = temp_db_path("persistence");
    if path.exists() {
        fs::remove_file(&path)?;
    }

    // Create engine and set values
    {
        let mut engine = StorageEngine::new(path.clone())?;

        engine.set(b"key1", b"value1".to_vec())?;
        engine.set(b"key2", b"value2".to_vec())?;
        engine.set(b"key3", b"value3".to_vec())?;

        // Explicitly drop the engine to ensure file is closed properly
        drop(engine);
    }

    // Reopen and verify values
    {
        let engine = StorageEngine::new(path.clone())?;

        let value1 = engine.get(b"key1").unwrap();
        let value2 = engine.get(b"key2").unwrap();
        let value3 = engine.get(b"key3").unwrap();

        assert_eq!(
            &*value1, b"value1",
            "Value for key1 not persisted correctly"
        );
        assert_eq!(
            &*value2, b"value2",
            "Value for key2 not persisted correctly"
        );
        assert_eq!(
            &*value3, b"value3",
            "Value for key3 not persisted correctly"
        );

        // Drop engine again to ensure changes are persisted
        drop(engine);
    }

    // Reopen, update some values, and verify again
    {
        let mut engine = StorageEngine::new(path.clone())?;

        engine.set(b"key2", b"updated_value".to_vec())?;
        engine.set(b"key4", b"value4".to_vec())?;

        // Explicitly drop the engine to ensure file is closed properly
        drop(engine);
    }

    // Reopen and verify updated values
    {
        let engine = StorageEngine::new(path.clone())?;

        let value1 = engine.get(b"key1").unwrap();
        let value2 = engine.get(b"key2").unwrap();
        let value3 = engine.get(b"key3").unwrap();
        let value4 = engine.get(b"key4").unwrap();

        assert_eq!(&*value1, b"value1", "Original value for key1 was lost");
        assert_eq!(
            &*value2, b"updated_value",
            "Value for key2 not updated correctly"
        );
        assert_eq!(&*value3, b"value3", "Original value for key3 was lost");
        assert_eq!(
            &*value4, b"value4",
            "New value for key4 not persisted correctly"
        );

        // Drop engine again
        drop(engine);
    }

    // Reopen, delete a key, and verify again
    {
        let mut engine = StorageEngine::new(path.clone())?;

        engine.del(b"key3")?;

        // Explicitly drop the engine to ensure file is closed properly
        drop(engine);
    }

    // Reopen and verify deletion
    {
        let engine = StorageEngine::new(path.clone())?;

        let value3 = engine.get(b"key3");

        assert_eq!(value3, None, "Key3 was not deleted properly");

        // Drop engine for the last time
        drop(engine);
    }

    // Cleanup
    fs::remove_file(path)?;

    Ok(())
}

#[test]
fn test_basic_operations() -> Result<()> {
    let path = temp_db_path("basic_ops");
    if path.exists() {
        fs::remove_file(&path)?;
    }

    let mut engine = StorageEngine::new(path.clone())?;

    engine.set(b"key", b"value".to_vec())?;
    let value = engine.get(b"key").unwrap();
    assert_eq!(&*value, b"value");

    fs::remove_file(path)?;

    Ok(())
}

#[test]
fn test_concurrent_access() -> Result<()> {
    let path = temp_db_path("concurrent");
    if path.exists() {
        fs::remove_file(&path)?;
    }

    // First engine instance
    let engine1 = StorageEngine::new(path.clone())?;

    // This should fail - file should be locked
    let engine2_result = StorageEngine::new(path.clone());
    assert!(
        engine2_result.is_err(),
        "Second engine should not be able to open locked database"
    );

    // Clean up
    drop(engine1);

    // After dropping the first instance, we should be able to open it again
    let _engine3 = StorageEngine::new(path.clone())?;

    fs::remove_file(path)?;

    Ok(())
}

#[test]
fn test_empty_string_values() -> Result<()> {
    let path = temp_db_path("empty");
    if path.exists() {
        fs::remove_file(&path)?;
    }

    let mut engine = StorageEngine::new(path.clone())?;

    // Empty value should be treated as delete
    engine.set(b"key1", vec![])?;
    assert_eq!(engine.get(b"key1"), None);

    // Set a value first
    engine.set(b"key2", b"value".to_vec())?;
    assert_eq!(
        engine.get(b"key2").map(|a| a.as_ref().to_vec()),
        Some(b"value".to_vec())
    );

    // Then set it to empty (should delete)
    engine.set(b"key2", vec![])?;
    assert_eq!(engine.get(b"key2"), None);

    // Clean up
    fs::remove_file(path)?;

    Ok(())
}

#[test]
fn test_len_and_empty() -> Result<()> {
    let path = temp_db_path("len");
    if path.exists() {
        fs::remove_file(&path)?;
    }

    let mut engine = StorageEngine::new(path.clone())?;

    // Should start empty
    assert_eq!(engine.len(), 0);
    assert!(engine.is_empty());

    // Add some entries
    engine.set(b"key1", b"value1".to_vec())?;
    engine.set(b"key2", b"value2".to_vec())?;

    // Should have 2 entries
    assert_eq!(engine.len(), 2);
    assert!(!engine.is_empty());

    // Delete an entry
    engine.del(b"key1")?;

    // Should have 1 entry
    assert_eq!(engine.len(), 1);
    assert!(!engine.is_empty());

    // Delete the last entry
    engine.del(b"key2")?;

    // Should be empty again
    assert_eq!(engine.len(), 0);
    assert!(engine.is_empty());

    // Clean up
    fs::remove_file(path)?;

    Ok(())
}

#[test]
fn test_engine_basic_operations_moved() -> Result<()> {
    let path = temp_db_path("basic_ops_moved");
    if path.exists() {
        fs::remove_file(&path)?;
    }

    let mut engine = StorageEngine::new(path.clone())?;

    // Set and get
    engine.set(b"key1", b"value1".to_vec())?;
    assert_eq!(
        engine.get(b"key1").map(|a| a.as_ref().to_vec()),
        Some(b"value1".to_vec())
    );

    // Delete
    engine.del(b"key1")?;
    assert_eq!(engine.get(b"key1"), None);

    // Cleanup
    fs::remove_file(path)?;

    Ok(())
}

#[test]
fn test_overwrite_key() -> Result<()> {
    let path = temp_db_path("overwrite");
    if path.exists() {
        fs::remove_file(&path)?;
    }
    let mut engine = StorageEngine::new(path.clone())?;

    engine.set(b"key1", b"value1".to_vec())?;
    assert_eq!(
        engine.get(b"key1").map(|a| a.as_ref().to_vec()),
        Some(b"value1".to_vec())
    );

    // Overwrite key1
    engine.set(b"key1", b"value_new".to_vec())?;
    assert_eq!(
        engine.get(b"key1").map(|a| a.as_ref().to_vec()),
        Some(b"value_new".to_vec())
    );

    fs::remove_file(path)?;
    Ok(())
}

#[test]
fn test_delete_non_existent_key() -> Result<()> {
    let path = temp_db_path("del_non_existent");
    if path.exists() {
        fs::remove_file(&path)?;
    }
    let mut engine = StorageEngine::new(path.clone())?;

    // Delete a key that doesn't exist
    engine.del(b"non_existent_key")?;
    assert_eq!(engine.get(b"non_existent_key"), None);

    fs::remove_file(path)?;
    Ok(())
}

#[test]
fn test_scan_empty_db() -> Result<()> {
    let path = temp_db_path("scan_empty");
    if path.exists() {
        fs::remove_file(&path)?;
    }
    let engine = StorageEngine::new(path.clone())?;

    let scan_result = engine
        .scan(b"a".to_vec()..b"z".to_vec())?
        .collect::<Vec<_>>();
    assert!(scan_result.is_empty());

    fs::remove_file(path)?;
    Ok(())
}

#[test]
fn test_scan_no_match() -> Result<()> {
    let path = temp_db_path("scan_no_match");
    if path.exists() {
        fs::remove_file(&path)?;
    }
    let mut engine = StorageEngine::new(path.clone())?;

    engine.set(b"key1", b"value1".to_vec())?;
    engine.set(b"key2", b"value2".to_vec())?;

    // Scan a range that won't match any existing keys
    let scan_result = engine
        .scan(b"x".to_vec()..b"z".to_vec())?
        .collect::<Vec<_>>();
    assert!(scan_result.is_empty());

    fs::remove_file(path)?;
    Ok(())
}

#[test]
fn test_special_characters_keys_values() -> Result<()> {
    let path = temp_db_path("special_chars");
    if path.exists() {
        fs::remove_file(&path)?;
    }
    let mut engine = StorageEngine::new(path.clone())?;

    let keys = [
        b"key with spaces".to_vec(),
        b"key/with/slashes".to_vec(),
        b"key\\with\\backslashes".to_vec(),
        b"key\"with\'quotes".to_vec(),
        b"key\twith\nnewlines".to_vec(),
        vec![0, 1, 2, 3, 4, 5], // Non-UTF8 key
    ];
    let values = [
        b"value with spaces".to_vec(),
        b"value/with/slashes".to_vec(),
        b"value\\with\\backslashes".to_vec(),
        b"value\"with\'quotes".to_vec(),
        b"value\twith\nnewlines".to_vec(),
        vec![10, 20, 30, 40, 50], // Non-UTF8 value
    ];

    for i in 0..keys.len() {
        engine.set(&keys[i], values[i].clone())?;
        assert_eq!(
            engine.get(&keys[i]).map(|a| a.as_ref().to_vec()),
            Some(values[i].clone())
        );
    }

    fs::remove_file(path)?;
    Ok(())
}

#[test]
#[should_panic(expected = "range start is greater than range end in BTreeMap")]
fn test_scan_reverse_range() {
    let path = temp_db_path("scan_reverse");
    if path.exists() {
        fs::remove_file(&path).unwrap();
    }
    let mut engine = StorageEngine::new(path.clone()).unwrap();

    engine.set(b"a", b"val_a".to_vec()).unwrap();
    engine.set(b"b", b"val_b".to_vec()).unwrap();
    engine.set(b"c", b"val_c".to_vec()).unwrap();

    // Start key is greater than end key
    // This should panic based on BTreeMap behavior
    let _scan_result = engine
        .scan(b"c".to_vec()..b"a".to_vec())
        .unwrap()
        .collect::<Vec<_>>();

    // The following lines will not be reached if the panic occurs as expected.
    fs::remove_file(path).unwrap();
}

#[test]
fn test_scan_boundary_conditions() -> Result<()> {
    let path = temp_db_path("scan_boundaries");
    if path.exists() {
        fs::remove_file(&path)?;
    }
    let mut engine = StorageEngine::new(path.clone())?;

    engine.set(b"key1", b"value1".to_vec())?;
    engine.set(b"key2", b"value2".to_vec())?;
    engine.set(b"key3", b"value3".to_vec())?;

    // Scan for "key1" (exclusive end for "key2")
    let result1 = engine
        .scan(b"key1".to_vec()..b"key2".to_vec())?
        .collect::<Vec<_>>();
    assert_eq!(result1.len(), 1);
    assert_eq!(result1[0].0, b"key1".to_vec());
    assert_eq!(result1[0].1.as_ref(), b"value1");

    // Scan for "key2" and "key3"
    // To include "key3", the end of the range must be > "key3"
    let mut end_key3_inclusive = b"key3".to_vec();
    end_key3_inclusive.push(0); // Makes it "key3\x00"
    let result2 = engine
        .scan(b"key2".to_vec()..end_key3_inclusive)?
        .collect::<Vec<_>>();
    assert_eq!(result2.len(), 2);
    assert_eq!(result2[0].0, b"key2".to_vec());
    assert_eq!(result2[0].1.as_ref(), b"value2");
    assert_eq!(result2[1].0, b"key3".to_vec());
    assert_eq!(result2[1].1.as_ref(), b"value3");

    // Scan a range that includes nothing (e.g., between "key1" and "key2" but not including them)
    let mut start_after_key1 = b"key1".to_vec();
    start_after_key1.push(255); // e.g., "key1\xff"
    let result3 = engine
        .scan(start_after_key1..b"key2".to_vec())?
        .collect::<Vec<_>>();
    assert!(result3.is_empty());

    // Scan all keys (range from before "key1" to after "key3")
    let mut end_beyond_key3 = b"key3".to_vec();
    end_beyond_key3.push(0);
    let result_all = engine
        .scan(b"key0".to_vec()..end_beyond_key3)?
        .collect::<Vec<_>>();
    assert_eq!(result_all.len(), 3);
    assert_eq!(result_all[0].0, b"key1".to_vec());
    assert_eq!(result_all[1].0, b"key2".to_vec());
    assert_eq!(result_all[2].0, b"key3".to_vec());

    // Scan with a start key that doesn't exist but is before the first key
    let result_before_all = engine
        .scan(b"a".to_vec()..b"key2".to_vec())?
        .collect::<Vec<_>>();
    assert_eq!(result_before_all.len(), 1);
    assert_eq!(result_before_all[0].0, b"key1".to_vec());

    // Scan with an end key that includes the last key
    let result_includes_last = engine
        .scan(b"key3".to_vec()..b"z".to_vec())?
        .collect::<Vec<_>>();
    assert_eq!(result_includes_last.len(), 1);
    assert_eq!(result_includes_last[0].0, b"key3".to_vec());

    fs::remove_file(path)?;
    Ok(())
}

#[test]
fn test_isolation_sequential_sessions_data_visibility() -> Result<()> {
    let path = temp_db_path("isolation_sequential");
    if path.exists() {
        fs::remove_file(&path)?;
    }

    // Session 1: Write some data
    {
        let mut engine = StorageEngine::new(path.clone())?;
        engine.set(b"iso_key1", b"val1_session1".to_vec())?;
        engine.set(b"iso_key2", b"val2_session1".to_vec())?;
        drop(engine);
    }

    // Session 2: Read data from session 1, modify some, add new
    {
        let mut engine = StorageEngine::new(path.clone())?;
        assert_eq!(
            engine.get(b"iso_key1").map(|a| a.as_ref().to_vec()),
            Some(b"val1_session1".to_vec())
        );
        assert_eq!(
            engine.get(b"iso_key2").map(|a| a.as_ref().to_vec()),
            Some(b"val2_session1".to_vec())
        );

        engine.set(b"iso_key2", b"val2_session2_updated".to_vec())?;
        engine.set(b"iso_key3", b"val3_session2_new".to_vec())?;
        drop(engine);
    }

    // Session 3: Verify changes from session 2 and original from session 1
    {
        let engine = StorageEngine::new(path.clone())?;
        assert_eq!(
            engine.get(b"iso_key1").map(|a| a.as_ref().to_vec()),
            Some(b"val1_session1".to_vec())
        ); // Unchanged from session 1
        assert_eq!(
            engine.get(b"iso_key2").map(|a| a.as_ref().to_vec()),
            Some(b"val2_session2_updated".to_vec())
        ); // Updated in session 2
        assert_eq!(
            engine.get(b"iso_key3").map(|a| a.as_ref().to_vec()),
            Some(b"val3_session2_new".to_vec())
        ); // Added in session 2
        assert_eq!(engine.len(), 3);
        drop(engine);
    }

    fs::remove_file(path)?;
    Ok(())
}

#[test]
fn test_engine_value_size_limit() {
    let path = temp_db_path("value_limit");
    if path.exists() {
        fs::remove_file(&path).unwrap();
    }
    // configure engine to allow only 1-byte values
    let config = EngineConfig {
        max_value_size: 1,
        ..Default::default()
    };
    let mut engine = StorageEngine::with_config(path.clone(), config).unwrap();
    // setting oversized value should error
    let err = engine.set(b"k", vec![0, 1]);
    assert!(
        err.is_err(),
        "Expected engine.set error for oversized value"
    );
    // valid value
    engine.set(b"k", vec![0]).unwrap();
    assert_eq!(engine.get(b"k").map(|a| a.as_ref().to_vec()), Some(vec![0]));
    fs::remove_file(path).unwrap();
}