sidereon-core 0.13.0

The complete Sidereon engine: numerical astrodynamics propagation core plus the GNSS domain layer (SP3, broadcast ephemeris, multi-GNSS positioning, RTK/PPP, ionosphere/troposphere, DOP) behind a default-on gnss feature
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
use super::*;
use crate::rtcm::{self, Message};

fn config(version: NtripVersion) -> NtripConfig {
    NtripConfig {
        host: "caster.example.test".into(),
        port: 2101,
        mountpoint: "MOUNT".into(),
        version,
        credentials: None,
        user_agent_product: "sidereon-test/0".into(),
        gga_interval_s: None,
    }
}

#[test]
fn rev1_request_bytes_are_deterministic() {
    let request = config(NtripVersion::Rev1).request_bytes().unwrap();
    assert_eq!(
        request,
        b"GET /MOUNT HTTP/1.0\r\nUser-Agent: NTRIP sidereon-test/0\r\n\r\n"
    );
}

#[test]
fn rev2_request_bytes_and_headers_use_same_values() {
    let mut cfg = config(NtripVersion::Rev2);
    cfg.credentials = Some(NtripCredentials {
        username: "user".into(),
        password: "pass".into(),
    });

    let request = String::from_utf8(cfg.request_bytes().unwrap()).unwrap();
    assert_eq!(
        request,
        "GET /MOUNT HTTP/1.1\r\nHost: caster.example.test:2101\r\nNtrip-Version: Ntrip/2.0\r\nUser-Agent: NTRIP sidereon-test/0\r\nAuthorization: Basic dXNlcjpwYXNz\r\nConnection: close\r\n\r\n"
    );

    let (path, headers) = cfg.request_headers().unwrap();
    assert_eq!(path, "/MOUNT");
    assert_eq!(
        headers,
        vec![
            ("Host".into(), "caster.example.test:2101".into()),
            ("Ntrip-Version".into(), "Ntrip/2.0".into()),
            ("User-Agent".into(), "NTRIP sidereon-test/0".into()),
            ("Authorization".into(), "Basic dXNlcjpwYXNz".into()),
            ("Connection".into(), "close".into()),
        ]
    );
}

#[test]
fn request_validation_rejects_malformed_values() {
    let mut cfg = config(NtripVersion::Rev2);
    cfg.mountpoint = "BAD/MOUNT".into();
    assert!(cfg.request_bytes().is_err());

    let mut cfg = config(NtripVersion::Rev2);
    cfg.user_agent_product = "bad product".into();
    assert!(cfg.request_bytes().is_err());

    let mut cfg = config(NtripVersion::Rev2);
    cfg.credentials = Some(NtripCredentials {
        username: "u:ser".into(),
        password: "pass".into(),
    });
    assert!(cfg.request_bytes().is_err());

    let mut cfg = config(NtripVersion::Rev2);
    cfg.host = "caster.example.test\r\nX: y".into();
    assert!(cfg.request_bytes().is_err());
}

#[test]
fn rev1_icy_stream_emits_payload_after_optional_blank_line() {
    let mut machine = NtripClientMachine::new(config(NtripVersion::Rev1));
    machine.connection_request().unwrap();
    let events = machine.push(b"ICY 200 OK\r\n\r\nabc");

    assert_eq!(
        events,
        vec![
            NtripEvent::Connected(NtripHandshake {
                version: NtripVersion::Rev1,
                chunked: false,
                headers: vec![],
            }),
            NtripEvent::Payload(b"abc".to_vec()),
        ]
    );
    assert_eq!(machine.state(), NtripState::Streaming);
}

#[test]
fn rev1_icy_optional_blank_line_can_be_split() {
    let mut machine = NtripClientMachine::new(config(NtripVersion::Rev1));
    machine.connection_request().unwrap();
    let connected = machine.push(b"ICY 200 OK\r\n");
    assert_eq!(
        connected,
        vec![NtripEvent::Connected(NtripHandshake {
            version: NtripVersion::Rev1,
            chunked: false,
            headers: vec![],
        })]
    );
    assert!(machine.push(b"\r").is_empty());
    assert_eq!(
        machine.push(b"\nDATA"),
        vec![NtripEvent::Payload(b"DATA".to_vec())]
    );

    let mut byte_machine = NtripClientMachine::new(config(NtripVersion::Rev1));
    byte_machine.connection_request().unwrap();
    let mut payload = Vec::new();
    for byte in b"ICY 200 OK\r\n\r\nDATA" {
        for event in byte_machine.push(&[*byte]) {
            if let NtripEvent::Payload(bytes) = event {
                payload.extend(bytes);
            }
        }
    }
    assert_eq!(payload, b"DATA");
}

#[test]
fn reset_then_reuse_matches_fresh_machine() {
    let wire = b"HTTP/1.1 200 OK\r\nContent-Type: gnss/data\r\n\r\nabc";

    let mut reused = NtripClientMachine::new(config(NtripVersion::Rev2));
    reused.connection_request().unwrap();
    reused.push(b"HTTP/1.1 200");
    reused.reset();
    let reused_request = reused.connection_request().unwrap();
    let reused_events = reused.push(wire);

    let mut fresh = NtripClientMachine::new(config(NtripVersion::Rev2));
    let fresh_request = fresh.connection_request().unwrap();
    let fresh_events = fresh.push(wire);

    assert_eq!(reused_request, fresh_request);
    assert_eq!(reused_events, fresh_events);
    assert_eq!(reused.state(), fresh.state());
}

#[test]
fn rev2_http_stream_emits_dechunked_payload_split_across_pushes() {
    let frame = rtcm::encode_frame(&[0xff, 0xf0]).unwrap();
    let mut wire =
        b"HTTP/1.1 200 OK\r\nContent-Type: gnss/data\r\nTransfer-Encoding: chunked\r\n\r\n"
            .to_vec();
    wire.extend_from_slice(format!("{:X}\r\n", frame.len()).as_bytes());
    wire.extend_from_slice(&frame[..3]);

    let mut machine = NtripClientMachine::new(config(NtripVersion::Rev2));
    machine.connection_request().unwrap();
    let first = machine.push(&wire);
    assert_eq!(
        first[0],
        NtripEvent::Connected(NtripHandshake {
            version: NtripVersion::Rev2,
            chunked: true,
            headers: vec![
                ("Content-Type".into(), "gnss/data".into()),
                ("Transfer-Encoding".into(), "chunked".into()),
            ],
        })
    );
    assert_eq!(first[1], NtripEvent::Payload(frame[..3].to_vec()));

    let mut tail = frame[3..].to_vec();
    tail.extend_from_slice(b"\r\n0\r\n\r\n");
    let second = machine.push(&tail);
    assert_eq!(
        second,
        vec![
            NtripEvent::Payload(frame[3..].to_vec()),
            NtripEvent::StreamEnded,
        ]
    );

    let mut assembler = rtcm::SsrStreamAssembler::new();
    let decoded: Vec<_> = first
        .into_iter()
        .chain(second)
        .filter_map(|event| match event {
            NtripEvent::Payload(bytes) => Some(bytes),
            _ => None,
        })
        .flat_map(|bytes| assembler.push(&bytes))
        .collect();
    assert!(matches!(&decoded[0], Ok(Message::Unsupported(msg)) if msg.message_number == 4095));
}

#[test]
fn chunk_decoder_handles_extensions_trailers_and_poisoning() {
    let mut decoder = ChunkedDecoder::new();
    assert_eq!(decoder.push(b"4;ignored=yes\r\nWi").unwrap(), b"Wi");
    assert_eq!(
        decoder
            .push(b"ki\r\n5\r\npedia\r\n0\r\nX: y\r\n\r\n")
            .unwrap(),
        b"kipedia"
    );
    assert!(decoder.finished());

    let mut decoder = ChunkedDecoder::new();
    assert!(decoder.push(b"Z\r\n").is_err());
    assert!(decoder.push(b"1\r\na\r\n").is_err());
}

#[test]
fn chunk_decoder_accepts_zero_size_first() {
    let mut decoder = ChunkedDecoder::new();
    assert_eq!(decoder.push(b"0\r\n\r\n").unwrap(), b"");
    assert!(decoder.finished());
    assert_eq!(decoder.push(b"ignored").unwrap(), b"");
}

#[test]
fn handshake_header_values_drop_exactly_one_leading_space() {
    let mut machine = NtripClientMachine::new(config(NtripVersion::Rev2));
    machine.connection_request().unwrap();
    let events = machine.push(
        b"HTTP/1.1 200 OK\r\nContent-Type: gnss/data\r\nX-One: value\r\nX-Two:  value\r\nX-Tab:\tvalue\r\n\r\n",
    );
    let NtripEvent::Connected(handshake) = &events[0] else {
        panic!("expected connected event");
    };
    assert_eq!(
        handshake.headers,
        vec![
            ("Content-Type".into(), "gnss/data".into()),
            ("X-One".into(), "value".into()),
            ("X-Two".into(), " value".into()),
            ("X-Tab".into(), "\tvalue".into()),
        ]
    );
}

#[test]
fn rev1_sourcetable_response_parses_records_after_headers() {
    let wire = b"SOURCETABLE 200 OK\r\nServer: caster\r\nContent-Type: gnss/sourcetable\r\n\r\nSTR;MOUNT;ID;RTCM 3;1004(1);2;GPS;NET;USA;40.1;-105.2;1;0;gen;none;B;N;9600;misc;with;semis\r\nCAS;caster.example.test;2101;Caster;Op;0;USA;40.0;-105.0;backup.example.test;2102;cas misc\r\nNET;NET;Op;D;Y;https://net;https://str;https://reg;net misc\r\nENDSOURCETABLE\r\n";
    let mut machine = NtripClientMachine::new(config(NtripVersion::Rev1));
    machine.connection_request().unwrap();
    let events = machine.push(wire);

    let NtripEvent::Sourcetable(table) = &events[0] else {
        panic!("expected sourcetable event");
    };
    assert_eq!(table.records.len(), 3);
    let stream = table.streams().next().unwrap();
    assert_eq!(stream.mountpoint, "MOUNT");
    assert_eq!(stream.nmea_required.value(), Some(&true));
    assert_eq!(stream.authentication, StrAuth::Basic);
    assert_eq!(stream.misc, "misc;with;semis");
}

#[test]
fn rev2_chunked_sourcetable_is_decoded_before_parsing() {
    let body = b"STR;MOUNT;ID;RTCM;1004;2;GPS;NET;USA;40.1;-105.2;1;0;gen;none;B;N;9600;misc\r\nENDSOURCETABLE\r\n";
    let mut wire =
        b"HTTP/1.1 200 OK\r\nContent-Type: gnss/sourcetable\r\nTransfer-Encoding: chunked\r\n\r\n"
            .to_vec();
    wire.extend_from_slice(format!("{:X}\r\n", body.len()).as_bytes());
    wire.extend_from_slice(&body[..10]);

    let mut machine = NtripClientMachine::new(config(NtripVersion::Rev2));
    machine.connection_request().unwrap();
    assert!(machine.push(&wire).is_empty());

    let mut tail = body[10..].to_vec();
    tail.extend_from_slice(b"\r\n0\r\n\r\n");
    let events = machine.push(&tail);
    let NtripEvent::Sourcetable(table) = &events[0] else {
        panic!("expected sourcetable");
    };
    assert_eq!(table.records.len(), 1);
    assert_eq!(table.streams().next().unwrap().mountpoint, "MOUNT");
}

#[test]
fn sourcetable_finish_accepts_eof_and_case_insensitive_terminator() {
    let mut machine = NtripClientMachine::new(config(NtripVersion::Rev1));
    machine.connection_request().unwrap();
    machine.push(b"SOURCETABLE 200 OK\r\nSTR;MP;ID;RTCM;;;;;;1.0;2.0;0;0;;;;N;9600;tail\r\n");
    let events = machine.finish();
    let NtripEvent::Sourcetable(table) = &events[0] else {
        panic!("expected sourcetable");
    };
    assert_eq!(table.records.len(), 1);

    let mut machine = NtripClientMachine::new(config(NtripVersion::Rev1));
    machine.connection_request().unwrap();
    let events = machine
        .push(b"SOURCETABLE 200 OK\r\nSTR;MP;ID;RTCM;;;;;;;;;;;;;;;N;;tail\r\nendsourcetable\r\n");
    assert!(matches!(events[0], NtripEvent::Sourcetable(_)));
}

#[test]
fn bad_auth_status_digest_and_content_type_are_rejections() {
    let mut machine = NtripClientMachine::new(config(NtripVersion::Rev1));
    machine.connection_request().unwrap();
    assert_eq!(
        machine.push(b"ERROR - Bad Password\r\n"),
        vec![NtripEvent::Rejected(NtripRejection::Unauthorized)]
    );

    let mut machine = NtripClientMachine::new(config(NtripVersion::Rev2));
    machine.connection_request().unwrap();
    assert_eq!(
        machine.push(b"HTTP/1.1 404 Not Found\r\n\r\n"),
        vec![NtripEvent::Rejected(NtripRejection::MountpointNotFound)]
    );

    let mut machine = NtripClientMachine::new(config(NtripVersion::Rev2));
    machine.connection_request().unwrap();
    assert_eq!(
        machine.push(
            b"HTTP/1.1 401 Unauthorized\r\nWWW-Authenticate: Digest realm=\"caster\"\r\n\r\n"
        ),
        vec![NtripEvent::Rejected(NtripRejection::DigestRequired)]
    );

    let mut machine = NtripClientMachine::new(config(NtripVersion::Rev2));
    machine.connection_request().unwrap();
    assert_eq!(
        machine.push(
            b"HTTP/1.1 401 Unauthorized\r\nWWW-Authenticate: Digest realm=\"caster\", Basic realm=\"caster\"\r\n\r\n"
        ),
        vec![NtripEvent::Rejected(NtripRejection::Unauthorized)]
    );

    let mut machine = NtripClientMachine::new(config(NtripVersion::Rev2));
    machine.connection_request().unwrap();
    assert_eq!(
        machine.push(b"HTTP/1.1 200 OK\r\nContent-Type: text/html; charset=utf-8\r\n\r\n<html>"),
        vec![NtripEvent::Rejected(
            NtripRejection::UnexpectedContentType {
                content_type: "text/html".into(),
            }
        )]
    );
}

#[test]
fn sourcetable_round_trip_preserves_unknown_and_raw_fields() {
    let text = "STR;MP\\nRAW;ID;RTCM;details;bad;GPS;NET;USA;badlat;1.0;2;0;gen;none;Z;maybe;badrate;tail\\nraw;more\r\nXYZ;a;b\\nraw\r\nENDSOURCETABLE\r\n";
    let table = parse_sourcetable(text).unwrap();
    let rendered = table.to_text().unwrap();
    let reparsed = parse_sourcetable(&rendered).unwrap();
    assert_eq!(reparsed, table);

    let stream = table.streams().next().unwrap();
    assert_eq!(stream.mountpoint, "MP\\nRAW");
    assert_eq!(stream.carrier, Field::Raw("bad".into()));
    assert_eq!(stream.lat_deg, Field::Raw("badlat".into()));
    assert_eq!(stream.misc, "tail\\nraw;more");
    assert!(rendered.contains("MP\\nRAW"));
    assert!(!rendered.contains("MP\nRAW"));

    let table = Sourcetable {
        records: vec![SourcetableRecord::Other(OtherRecord {
            type_tag: " weird tag ".into(),
            fields: vec!["a".into(), "c\\d".into()],
        })],
    };
    assert_eq!(parse_sourcetable(&table.to_text().unwrap()).unwrap(), table);

    let nan =
        parse_sourcetable("STR;MP;ID;RTCM;;2;GPS;NET;USA;NaN;inf;0;0;gen;none;N;N;9600;tail\r\n")
            .unwrap();
    let stream = nan.streams().next().unwrap();
    assert_eq!(stream.lat_deg, Field::Raw("NaN".into()));
    assert_eq!(stream.lon_deg, Field::Raw("inf".into()));
}

#[test]
fn sourcetable_to_text_rejects_unrepresentable_synthetic_fields() {
    let mut table = parse_sourcetable(
        "STR;MP;ID;RTCM;;2;GPS;NET;USA;1.0;2.0;0;0;gen;none;N;N;9600;tail;ok\r\n",
    )
    .unwrap();
    assert_eq!(table.to_text().unwrap().matches("tail;ok").count(), 1);

    let SourcetableRecord::Str(stream) = &mut table.records[0] else {
        panic!("expected STR record");
    };
    stream.mountpoint = "bad\nmount".into();
    assert!(matches!(
        table.to_text(),
        Err(crate::Error::InvalidInput(message)) if message.contains("line break")
    ));

    let SourcetableRecord::Str(stream) = &mut table.records[0] else {
        panic!("expected STR record");
    };
    stream.mountpoint = "bad;mount".into();
    assert!(matches!(
        table.to_text(),
        Err(crate::Error::InvalidInput(message)) if message.contains("semicolon")
    ));
}

#[test]
fn gga_formatter_and_machine_pacing_are_deterministic() {
    let position = GgaPosition {
        lat_deg: 40.0,
        lon_deg: -105.0,
        height_m: 1600.0,
        ..GgaPosition::default()
    };
    let sentence = format_gga(&position, 3661.239).unwrap();
    assert_eq!(
        String::from_utf8(sentence).unwrap(),
        "$GPGGA,010101.23,4000.0000000,N,10500.0000000,W,1,10,1.00,1600.0,M,,,,*2A\r\n"
    );

    let mut cfg = config(NtripVersion::Rev1);
    cfg.gga_interval_s = Some(10.0);
    let mut machine = NtripClientMachine::new(cfg);
    machine.connection_request().unwrap();
    machine.push(b"ICY 200 OK\r\n");
    assert!(machine.gga_message(5.0, &position, 1.0).is_some());
    assert!(machine.gga_message(14.0, &position, 2.0).is_none());
    assert!(machine.gga_message(15.0, &position, 3.0).is_some());
    assert!(machine.gga_message(14.0, &position, 4.0).is_none());

    let bad_position = GgaPosition {
        lat_deg: 91.0,
        ..position
    };
    assert!(machine.try_gga_message(25.0, &bad_position, 5.0).is_err());
}