lb-sparkplugb-rs 0.1.1

Eclipse Sparkplug B 3.0.0 protocol library — payload codec, topic namespace, sequence/bdSeq, and (phased) edge & host roles, in Rust.
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

//! Topic parsing / formatting table tests (spec §4).

use sparkplug_b::{MessageType, SparkplugTopic};

#[test]
fn parses_and_formats_node_topic() {
    let t = SparkplugTopic::parse("spBv1.0/Group1/NBIRTH/Edge1").expect("valid node topic");
    assert_eq!(t.message_type(), MessageType::NBirth);
    assert_eq!(t.to_string(), "spBv1.0/Group1/NBIRTH/Edge1");
}

#[test]
fn parses_and_formats_device_topic() {
    let t = SparkplugTopic::parse("spBv1.0/G/DDATA/E/Dev").expect("valid device topic");
    assert_eq!(t.message_type(), MessageType::DData);
    assert_eq!(t.to_string(), "spBv1.0/G/DDATA/E/Dev");
}

#[test]
fn parses_and_formats_state_topic() {
    let t = SparkplugTopic::parse("spBv1.0/STATE/primary-host").expect("valid state topic");
    assert_eq!(t.message_type(), MessageType::State);
    assert_eq!(t.to_string(), "spBv1.0/STATE/primary-host");
}

#[test]
fn rejects_wrong_namespace() {
    assert!(SparkplugTopic::parse("spAv1.0/G/NDATA/E").is_err());
}

#[test]
fn rejects_node_topic_with_device_message_type() {
    // DBIRTH on a 4-token (node) topic is invalid.
    assert!(SparkplugTopic::parse("spBv1.0/G/DBIRTH/E").is_err());
}

#[test]
fn rejects_device_topic_with_node_message_type() {
    // NDATA on a 5-token (device) topic is invalid.
    assert!(SparkplugTopic::parse("spBv1.0/G/NDATA/E/Dev").is_err());
}

#[test]
fn rejects_reserved_characters_in_ids() {
    assert!(SparkplugTopic::parse("spBv1.0/Grp+/NDATA/E").is_err());
    assert!(SparkplugTopic::parse("spBv1.0/Grp/NDATA/E#").is_err());
}

#[test]
fn rejects_wrong_token_count() {
    assert!(SparkplugTopic::parse("spBv1.0/G").is_err());
    assert!(SparkplugTopic::parse("spBv1.0/G/NDATA/E/Dev/extra").is_err());
}

#[test]
fn device_message_types_carry_device_and_seq_rules() {
    assert!(MessageType::DData.has_device());
    assert!(!MessageType::NData.has_device());
    // NDEATH / NCMD / DCMD carry no sequence number.
    assert!(!MessageType::NDeath.carries_seq());
    assert!(!MessageType::NCmd.carries_seq());
    assert!(!MessageType::DCmd.carries_seq());
    // DDEATH does carry a sequence number.
    assert!(MessageType::DDeath.carries_seq());
    assert!(MessageType::NBirth.carries_seq());
}

#[test]
fn rejects_state_topic_with_extra_token() {
    assert!(SparkplugTopic::parse("spBv1.0/STATE/host/extra").is_err());
}

#[test]
fn parse_format_round_trips_for_all_topic_shapes() {
    for topic in [
        "spBv1.0/G/NBIRTH/E",
        "spBv1.0/G/NDEATH/E",
        "spBv1.0/G/NDATA/E",
        "spBv1.0/G/NCMD/E",
        "spBv1.0/G/DBIRTH/E/D",
        "spBv1.0/G/DDEATH/E/D",
        "spBv1.0/G/DDATA/E/D",
        "spBv1.0/G/DCMD/E/D",
        "spBv1.0/STATE/host",
    ] {
        let parsed = SparkplugTopic::parse(topic).expect("valid topic");
        assert_eq!(parsed.to_string(), topic, "round-trip for {topic}");
    }
}