readcon-db 0.1.6

Mmap-backed CON frame corpus (Heed/LMDB), xxHash exact match, multi-language FFI
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

//! CON text is the authority; RCSO is derived. Locked in docs and numeric extract.

use std::fs;
use std::path::PathBuf;

use readcon_db::{ConCorpus, FrameKey};

fn root() -> PathBuf {
    PathBuf::from(env!("CARGO_MANIFEST_DIR"))
}

fn read(rel: &str) -> String {
    let p = root().join(rel);
    fs::read_to_string(&p).unwrap_or_else(|e| panic!("missing {}: {e}", p.display()))
}

fn fixture(name: &str) -> PathBuf {
    root().join("resources/test").join(name)
}

fn assert_contains(hay: &str, needle: &str, file: &str) {
    assert!(
        hay.contains(needle),
        "{file} must state the CON authority contract ({needle:?})"
    );
}

/// User docs and rustdoc must keep CON-text authority unmissable.
#[test]
fn docs_state_con_text_is_authority() {
    let soa = read("docs/orgmode/cooked-soa.org");
    assert_contains(&soa, "non-authoritative", "docs/orgmode/cooked-soa.org");
    assert_contains(&soa, "sole authority", "docs/orgmode/cooked-soa.org");
    assert_contains(
        &soa,
        "never read =frames_soa=",
        "docs/orgmode/cooked-soa.org",
    );

    let design = read("docs/design.md");
    assert_contains(&design, "non-authoritative", "docs/design.md");
    assert_contains(&design, "UTF-8 CON text in `frames` only", "docs/design.md");

    let arch = read("docs/source/architecture.md");
    assert_contains(&arch, "non-authoritative", "docs/source/architecture.md");
    assert_contains(&arch, "sole authority", "docs/source/architecture.md");

    let readme = read("README.md");
    assert_contains(&readme, "non-authoritative", "README.md");
    assert_contains(&readme, "sole authority", "README.md");

    let rustdoc = read("src/cooked_soa.rs");
    assert_contains(&rustdoc, "non-authoritative", "src/cooked_soa.rs");
    assert_contains(&rustdoc, "sole authority", "src/cooked_soa.rs");
    assert_contains(&rustdoc, "fully equivalent", "src/cooked_soa.rs");

    let map = read("docs/orgmode/readme.org");
    assert_contains(&map, "authoritative", "docs/orgmode/readme.org");
}

/// Parse path and cooked path must agree for positions, forces, and velocities.
/// Cook / delete cooked must not change CON text or hash.
#[test]
fn numeric_extract_parse_and_cooked_match() {
    let dir = tempfile::tempdir().unwrap();
    let db = ConCorpus::open(dir.path()).unwrap();
    let key = FrameKey {
        traj_id: 1,
        frame_idx: 0,
    };
    db.append_trajectory_path(1, fixture("tiny_cuh2_vel_forces.con"))
        .unwrap();
    assert!(!db.has_valid_cooked_soa(key).unwrap());

    let pos_parse = db.get_positions(key).unwrap();
    let f_parse = db.get_forces(key).unwrap().expect("forces");
    let v_parse = db.get_velocities(key).unwrap().expect("velocities");
    assert_eq!(pos_parse.len(), 4);
    assert!((pos_parse[0][0] - 0.6394).abs() < 1e-9);
    assert!((v_parse[0][0] - 0.001234).abs() < 1e-12);
    assert!((f_parse[0][0] - 0.123456).abs() < 1e-12);

    let text = db.get_frame_text(key).unwrap();
    let h = db.frame_hash(key).unwrap();

    db.cook_frame(key).unwrap();
    assert!(db.has_valid_cooked_soa(key).unwrap());
    assert_eq!(db.get_positions(key).unwrap(), pos_parse);
    assert_eq!(db.get_forces(key).unwrap().unwrap(), f_parse);
    assert_eq!(db.get_velocities(key).unwrap().unwrap(), v_parse);
    assert_eq!(db.get_frame_text(key).unwrap(), text);
    assert_eq!(db.frame_hash(key).unwrap().to_bytes(), h.to_bytes());
    assert_eq!(db.find_by_hash(h).unwrap(), Some(key));

    db.delete_cooked_soa(key).unwrap();
    assert!(!db.has_valid_cooked_soa(key).unwrap());
    assert_eq!(db.get_positions(key).unwrap(), pos_parse);
    assert_eq!(db.get_forces(key).unwrap().unwrap(), f_parse);
    assert_eq!(db.get_velocities(key).unwrap().unwrap(), v_parse);
    assert_eq!(db.get_frame_text(key).unwrap(), text);
    assert_eq!(db.frame_hash(key).unwrap().to_bytes(), h.to_bytes());
}