jamjam 0.3.0

Handles JAM, PCBOARD message bases & QWK packets.
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

use bstr::BString;
use jamjam::jam::last_read_storage::JamLastReadStorage;
use jamjam::jam::verify::Problem;
use jamjam::jam::{JamMessage, JamMessageBase};
use jamjam::util::echomail::EchomailAddress;
use pretty_assertions::assert_eq;
use std::io::{Seek, SeekFrom, Write};
use std::path::Path;
use tempfile::TempDir;

fn message(text: &str) -> JamMessage {
    JamMessage::new(&EchomailAddress::default())
        .with_to(BString::from("all"))
        .with_subject(BString::from(text))
        .with_text(BString::from(text))
}

fn filled(path: &Path) -> JamMessageBase {
    let mut base = JamMessageBase::create(path).unwrap();
    for text in ["one", "two", "three"] {
        base.write_message(&message(text)).unwrap();
    }
    base
}

#[test]
fn test_verify_accepts_a_healthy_base() {
    let dir = TempDir::new().unwrap();
    let mut base = filled(&dir.path().join("ok"));

    let report = base.verify().unwrap();
    assert!(report.is_ok(), "{report}");
    assert_eq!(report.live_messages, 3);
    assert_eq!(report.index_records, 3);
}

#[test]
fn test_verify_reports_active_message_drift() {
    let dir = TempDir::new().unwrap();
    let path = dir.path().join("drift");
    let mut base = filled(&path);
    base.delete_message(2).unwrap();

    let header = path.with_extension("jhr");
    let mut file = std::fs::OpenOptions::new()
        .write(true)
        .open(header)
        .unwrap();
    file.seek(SeekFrom::Start(12)).unwrap();
    file.write_all(&99u32.to_le_bytes()).unwrap();
    drop(file);

    let mut base = JamMessageBase::open(&path).unwrap();
    let report = base.verify().unwrap();
    assert!(
        report.problems.iter().any(|problem| matches!(
            problem,
            Problem::ActiveMessageCountWrong {
                stored: 99,
                counted: 2
            }
        )),
        "{report:?}"
    );
}

#[test]
fn test_repair_rebuilds_a_lost_index_and_clamps_lastread() {
    let dir = TempDir::new().unwrap();
    let path = dir.path().join("repair");
    let mut base = filled(&path);
    base.write_last_read(&JamLastReadStorage {
        user_crc: 1,
        user_id: 2,
        last_read_msg: 3,
        high_read_msg: 99,
    })
    .unwrap();
    drop(base);

    std::fs::write(path.with_extension("jdx"), []).unwrap();

    let mut base = JamMessageBase::open(&path).unwrap();
    let report = base.repair().unwrap();
    assert!(report.reindexed);
    assert_eq!(report.last_read_records_clamped, 1);
    assert!(
        report.after.is_ok()
            || report
                .after
                .problems
                .iter()
                .all(|problem| matches!(problem, Problem::UnreferencedText { .. })),
        "{:?}",
        report.after
    );
    assert_eq!(base.active_messages(), 3);
    assert_eq!(base.highest_message_number(), 3);
    let last = base.find_last_read(1, 2).unwrap().unwrap();
    assert_eq!(last.last_read_msg, 3);
    assert_eq!(last.high_read_msg, 3);
}

#[test]
fn test_repair_drops_a_partial_lastread_record() {
    let dir = TempDir::new().unwrap();
    let path = dir.path().join("partial");
    let mut base = filled(&path);
    base.write_last_read(&JamLastReadStorage {
        user_crc: 1,
        user_id: 2,
        last_read_msg: 2,
        high_read_msg: 2,
    })
    .unwrap();

    let mut data = std::fs::read(path.with_extension("jlr")).unwrap();
    data.extend_from_slice(&[0u8; 4]);
    std::fs::write(path.with_extension("jlr"), data).unwrap();

    let report = base.repair().unwrap();
    assert_eq!(report.last_read_bytes_dropped, 4);
    assert!(
        report
            .before
            .problems
            .iter()
            .any(|problem| matches!(problem, Problem::LastReadFileTruncated { .. }))
    );
    assert!(
        !report
            .after
            .problems
            .iter()
            .any(|problem| matches!(problem, Problem::LastReadFileTruncated { .. })),
        "{:?}",
        report.after
    );
    assert_eq!(base.find_last_read(1, 2).unwrap().unwrap().last_read_msg, 2);
}

#[test]
fn test_verify_does_not_rewrite_the_base() {
    let dir = TempDir::new().unwrap();
    let path = dir.path().join("readonly");
    let mut base = filled(&path);
    let before = std::fs::read(path.with_extension("jdx")).unwrap();
    let _ = base.verify().unwrap();
    assert_eq!(std::fs::read(path.with_extension("jdx")).unwrap(), before);
}