ados-lora 0.1.1

LoRa transmit governor with cited regional band plans: time-on-air, duty cycle, dwell time, listen-before-talk, power limits and a persisted airtime ledger.
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

use super::*;

const S: i64 = 1_000_000_000;

fn now(mono_s: i64, utc_s: i64, trusted: bool) -> Now {
    Now {
        mono_ns: mono_s * S,
        utc_ms: utc_s * 1000,
        utc_trusted: trusted,
    }
}

#[test]
fn a_charge_survives_a_service_restart_in_the_same_boot() {
    let dir = tempfile::tempdir().unwrap();
    let p = dir.path().join("lora/airtime.jsonl");
    let (mut l, _) = Ledger::open(&p, "boot-a", now(100, 1_000, false), 3600).unwrap();
    l.charge(
        now(110, 1_010, false),
        866.125,
        "865.0-867.0",
        30_000_000,
        "IN865",
    )
    .unwrap();
    drop(l);
    let (l, report) = Ledger::open(&p, "boot-a", now(120, 1_020, false), 3600).unwrap();
    assert_eq!(report.entries, 1);
    assert_eq!(l.spends()[0].at_ns, 110 * S);
    assert_eq!(l.spent_in(865.0, 867.0, 0), 30_000_000);
}

#[test]
fn an_untrusted_previous_boot_counts_as_spent_at_service_start() {
    let dir = tempfile::tempdir().unwrap();
    let p = dir.path().join("airtime.jsonl");
    let (mut l, _) = Ledger::open(&p, "boot-a", now(5_000, 9_000, false), 3600).unwrap();
    l.charge(
        now(5_000, 9_000, false),
        866.125,
        "865.0-867.0",
        30_000_000,
        "IN865",
    )
    .unwrap();
    drop(l);
    // Rebooted: monotonic restarts near zero, no trusted clock.
    let (l, _) = Ledger::open(&p, "boot-b", now(20, 9_100, false), 3600).unwrap();
    assert_eq!(l.spends()[0].at_ns, 20 * S);
    assert_eq!(l.spent_in(865.0, 867.0, 20 * S - 3600 * S), 30_000_000);
}

#[test]
fn trusted_clocks_age_a_previous_boot_by_utc() {
    let dir = tempfile::tempdir().unwrap();
    let p = dir.path().join("airtime.jsonl");
    let (mut l, _) = Ledger::open(&p, "boot-a", now(10, 50_000, true), 3600).unwrap();
    l.charge(
        now(10, 50_000, true),
        866.125,
        "865.0-867.0",
        1_000,
        "IN865",
    )
    .unwrap();
    drop(l);
    // 4000 s later on a new boot: older than the window.
    let (l, _) = Ledger::open(&p, "boot-b", now(30, 54_000, true), 3600).unwrap();
    assert_eq!(l.spends()[0].at_ns, 30 * S - 4000 * S);
    assert_eq!(l.spent_in(865.0, 867.0, 30 * S - 3600 * S), 0);
}

#[test]
fn a_trusted_heartbeat_bounds_the_downtime_credited() {
    let dir = tempfile::tempdir().unwrap();
    let p = dir.path().join("airtime.jsonl");
    let (mut l, _) = Ledger::open(&p, "boot-a", now(10, 0, false), 3600).unwrap();
    // Spent while the clock was untrusted, later the clock locked.
    l.charge(now(10, 0, false), 866.125, "865.0-867.0", 5_000, "IN865")
        .unwrap();
    l.heartbeat(now(70, 60_000, true)).unwrap();
    drop(l);
    let (l, _) = Ledger::open(&p, "boot-b", now(30, 61_000, true), 3600).unwrap();
    // Placed at the heartbeat: 1000 s before now.
    assert_eq!(l.spends()[0].at_ns, 30 * S - 1000 * S);
}

#[test]
fn a_torn_tail_is_dropped_and_the_file_rewritten() {
    let dir = tempfile::tempdir().unwrap();
    let p = dir.path().join("airtime.jsonl");
    let (mut l, _) = Ledger::open(&p, "boot-a", now(1, 1, false), 3600).unwrap();
    l.charge(now(2, 2, false), 866.125, "865.0-867.0", 7, "IN865")
        .unwrap();
    drop(l);
    let mut f = OpenOptions::new().append(true).open(&p).unwrap();
    f.write_all(b"{\"kind\":\"tx\",\"boot").unwrap();
    drop(f);
    let (l, report) = Ledger::open(&p, "boot-a", now(3, 3, false), 3600).unwrap();
    assert!(report.torn_tail && !report.reset);
    assert_eq!(l.spends().len(), 1);
    assert!(!std::fs::read_to_string(&p).unwrap().contains("\"boot\n"));
}

#[test]
fn a_corrupt_file_is_moved_aside_and_duty_starts_exhausted() {
    let dir = tempfile::tempdir().unwrap();
    let p = dir.path().join("airtime.jsonl");
    std::fs::write(&p, "garbage\n{\"kind\":\"seen\",\"boot_id\":\"a\",\"t_mono_ns\":1,\"t_utc_ms\":1,\"utc_trusted\":false}\n").unwrap();
    let (l, report) = Ledger::open(&p, "boot-a", now(100, 100, false), 3600).unwrap();
    assert!(report.reset);
    assert!(dir.path().join("airtime.jsonl.bad").exists());
    assert_eq!(l.exhausted_until_ns(), Some(100 * S + 3600 * S));
    assert!(l.spends().is_empty());
}

#[test]
fn compaction_drops_spends_older_than_the_window() {
    let dir = tempfile::tempdir().unwrap();
    let p = dir.path().join("airtime.jsonl");
    let (mut l, _) = Ledger::open(&p, "boot-a", now(1, 1, false), 3600).unwrap();
    l.charge(now(10, 10, false), 866.125, "865.0-867.0", 1, "IN865")
        .unwrap();
    l.charge(now(4000, 4000, false), 866.125, "865.0-867.0", 2, "IN865")
        .unwrap();
    l.compact(now(4000, 4000, false), 3600).unwrap();
    assert_eq!(l.spends().len(), 1);
    l.charge(now(4001, 4001, false), 866.125, "865.0-867.0", 3, "IN865")
        .unwrap();
    drop(l);
    let (l, _) = Ledger::open(&p, "boot-a", now(4002, 4002, false), 3600).unwrap();
    assert_eq!(l.spent_in(0.0, 1000.0, 0), 5);
}

#[test]
fn the_corrupt_ledger_lockout_survives_a_reload_and_a_reboot() {
    let dir = tempfile::tempdir().unwrap();
    let p = dir.path().join("airtime.jsonl");
    std::fs::write(&p, "garbage\n{\"kind\":\"seen\",\"boot_id\":\"a\",\"t_mono_ns\":1,\"t_utc_ms\":1,\"utc_trusted\":false}\n").unwrap();
    let (l, report) = Ledger::open(&p, "boot-a", now(100, 100, false), 3600).unwrap();
    assert!(report.reset);
    drop(l);
    // A SIGHUP reload in the same boot keeps the lockout end.
    let (l, report) = Ledger::open(&p, "boot-a", now(200, 200, false), 3600).unwrap();
    assert!(!report.reset);
    assert_eq!(l.exhausted_until_ns(), Some(3700 * S));
    drop(l);
    // Compaction inside the window keeps the reset entry.
    let (mut l, _) = Ledger::open(&p, "boot-a", now(300, 300, false), 3600).unwrap();
    l.compact(now(300, 300, false), 3600).unwrap();
    drop(l);
    // A reboot with no trusted clock counts the reset from service start.
    let (l, _) = Ledger::open(&p, "boot-b", now(10, 400, false), 3600).unwrap();
    assert_eq!(l.exhausted_until_ns(), Some(3610 * S));
    drop(l);
    // Once the window has passed, compaction drops it.
    let (mut l, _) = Ledger::open(&p, "boot-b", now(4000, 4400, false), 3600).unwrap();
    l.compact(now(4000, 4400, false), 3600).unwrap();
    drop(l);
    let (l, _) = Ledger::open(&p, "boot-b", now(4001, 4401, false), 3600).unwrap();
    assert_eq!(l.exhausted_until_ns(), None);
}

#[test]
fn a_previous_boot_spend_ages_out_across_service_restarts() {
    let dir = tempfile::tempdir().unwrap();
    let p = dir.path().join("airtime.jsonl");
    let (mut l, _) = Ledger::open(&p, "boot-a", now(5_000, 9_000, false), 3600).unwrap();
    l.charge(
        now(5_000, 9_000, false),
        866.125,
        "865.0-867.0",
        30_000_000,
        "IN865",
    )
    .unwrap();
    drop(l);
    // Placed at the first start of the next boot ...
    let (l, _) = Ledger::open(&p, "boot-b", now(20, 9_100, false), 3600).unwrap();
    assert_eq!(l.spends()[0].at_ns, 20 * S);
    drop(l);
    // ... and kept there by a later restart in that boot, so it leaves the
    // window one hour later instead of being re-placed at every start.
    let (l, _) = Ledger::open(&p, "boot-b", now(3_700, 12_800, false), 3600).unwrap();
    assert_eq!(l.spends()[0].at_ns, 20 * S);
    assert_eq!(l.spent_in(865.0, 867.0, 3_700 * S - 3_600 * S), 0);
}

#[test]
fn an_untrusted_boot_spend_is_not_aged_by_an_adopted_trusted_time() {
    let dir = tempfile::tempdir().unwrap();
    let p = dir.path().join("airtime.jsonl");
    // B1, trusted clock: a small spend and a heartbeat at UTC 50 000 s.
    let (mut l, _) = Ledger::open(&p, "boot-1", now(10, 50_000, true), 3600).unwrap();
    l.charge(
        now(10, 50_000, true),
        866.125,
        "865.0-867.0",
        1_000,
        "IN865",
    )
    .unwrap();
    l.heartbeat(now(70, 50_060, true)).unwrap();
    drop(l);
    // B2, no trusted clock: adopts B1's entries, then spends the whole budget
    // at an unknown wall time.
    let (mut l, _) = Ledger::open(&p, "boot-2", now(20, 0, false), 3600).unwrap();
    l.charge(
        now(30, 0, false),
        866.125,
        "865.0-867.0",
        36_000_000,
        "IN865",
    )
    .unwrap();
    drop(l);
    // B3, trusted clock, 3700 s after B1's last trusted moment. B2's spend
    // could have happened just before this boot, so it must still count.
    let b3 = now(5, 53_760, true);
    let (l, _) = Ledger::open(&p, "boot-3", b3, 3600).unwrap();
    let since = b3.mono_ns - 3600 * S;
    assert!(l.spent_in(865.0, 867.0, since) >= 36_000_000);
    // And it stays counted until a full window after this boot placed it.
    drop(l);
    let (l, _) = Ledger::open(&p, "boot-3", now(3_000, 56_755, true), 3600).unwrap();
    assert!(l.spent_in(865.0, 867.0, 3_000 * S - 3600 * S) >= 36_000_000);
}