ese-core 0.1.0

ESE (Extensible Storage Engine) database binary format reader
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

//! Integration tests for ese-btree-walk story.
//!
//! Tests [`EseDatabase::walk_leaf_pages`].

mod fixtures;
use ese_core::EseDatabase;

#[test]
fn walk_leaf_root_returns_root_page() {
    // A root page that is itself a leaf: walk_leaf_pages returns just that page number.
    let leaf = fixtures::make_leaf_page_with_records(0, &[]);
    let header = fixtures::make_ese_header_page();
    // page 0 = header, page 1 = leaf-root
    let tmp = fixtures::write_ese_file(&[header, leaf]);
    let db = EseDatabase::open(tmp.path()).expect("open");
    let leaves = db.walk_leaf_pages(1).expect("walk");
    assert_eq!(leaves, vec![1u32]);
}

#[test]
fn walk_two_level_btree_returns_leaf_pages_not_root() {
    // page 0 = header
    // page 1 = parent (root), ESE child refs [1, 2] → physical pages 2 and 3
    // page 2 = leaf A  (ESE page 1, physical 2)
    // page 3 = leaf B  (ESE page 2, physical 3)
    let header = fixtures::make_ese_header_page();
    let parent = fixtures::make_parent_page_with_children(&[1, 2]); // ESE page numbers
    let leaf_a = fixtures::make_leaf_page_with_records(0, &[]);
    let leaf_b = fixtures::make_leaf_page_with_records(0, &[]);
    let tmp = fixtures::write_ese_file(&[header, parent, leaf_a, leaf_b]);
    let db = EseDatabase::open(tmp.path()).expect("open");
    let mut leaves = db.walk_leaf_pages(1).expect("walk");
    leaves.sort_unstable();
    assert_eq!(leaves, vec![2u32, 3u32], "both leaf pages returned");
    assert!(!leaves.contains(&1), "root page must not be in result");
}

#[test]
fn walk_branch_child_ref_is_trailing_u32_after_key_prefix() {
    // Real ESE branch pages store each child reference as
    // `[btree_key_prefix..][child_page_u32]`. The traversal must read the
    // child page number from the LAST 4 bytes, ignoring the key prefix.
    //
    // page 0 = header
    // page 1 = parent (root) with an 11-byte key prefix + ESE child refs [1, 2]
    //          → physical pages 2 and 3
    // page 2 = leaf A, page 3 = leaf B
    let header = fixtures::make_ese_header_page();
    let key_prefix = b"\x00\x07KEYPRE\x00\x00"; // 11 bytes of non-trivial prefix
    let parent = fixtures::make_parent_page_with_prefixed_children(key_prefix, &[1, 2]);
    let leaf_a = fixtures::make_leaf_page_with_records(0, &[]);
    let leaf_b = fixtures::make_leaf_page_with_records(0, &[]);
    let tmp = fixtures::write_ese_file(&[header, parent, leaf_a, leaf_b]);
    let db = EseDatabase::open(tmp.path()).expect("open");
    let mut leaves = db.walk_leaf_pages(1).expect("walk");
    leaves.sort_unstable();
    assert_eq!(
        leaves,
        vec![2u32, 3u32],
        "child page number must come from the trailing 4 bytes, not the key prefix"
    );
}

#[test]
fn walk_branch_child_ref_exactly_four_bytes_no_panic() {
    // Boundary: a child-reference record that is EXACTLY 4 bytes (empty key
    // prefix). The `data[n-4..n]` read sits at the n==4 lower bound; the
    // traversal must read it without panicking.
    let header = fixtures::make_ese_header_page();
    let parent = fixtures::make_parent_page_with_prefixed_children(&[], &[1]); // physical page 2
    let leaf_a = fixtures::make_leaf_page_with_records(0, &[]);
    let tmp = fixtures::write_ese_file(&[header, parent, leaf_a]);
    let db = EseDatabase::open(tmp.path()).expect("open");
    let leaves = db.walk_leaf_pages(1).expect("walk");
    assert_eq!(leaves, vec![2u32]);
}

#[test]
fn walk_nonexistent_page_returns_err() {
    // Only page 0 (header) exists; asking for page 5 must fail.
    let header = fixtures::make_ese_header_page();
    let tmp = fixtures::write_ese_file(&[header]);
    let db = EseDatabase::open(tmp.path()).expect("open");
    assert!(db.walk_leaf_pages(5).is_err());
}