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
|
use std::convert::{TryFrom, TryInto};
use clock::Timestamp;
use serde::Deserialize;
/// In-memory representation of ThinEdge JSON alarm.
#[derive(Debug, Deserialize, PartialEq)]
pub struct ThinEdgeAlarm {
pub name: String,
pub severity: AlarmSeverity,
pub data: Option<ThinEdgeAlarmData>,
}
#[derive(Debug, Deserialize, PartialEq)]
pub enum AlarmSeverity {
Critical,
Major,
Minor,
Warning,
}
/// In-memory representation of ThinEdge JSON alarm payload
#[derive(Debug, Deserialize, PartialEq)]
pub struct ThinEdgeAlarmData {
pub text: Option<String>,
#[serde(default)]
#[serde(with = "clock::serde::rfc3339::option")]
pub time: Option<Timestamp>,
}
#[derive(thiserror::Error, Debug)]
pub enum ThinEdgeJsonDeserializerError {
#[error("Unsupported topic: {0}")]
UnsupportedTopic(String),
#[error("Unsupported alarm severity in topic: {0}")]
UnsupportedAlarmSeverity(String),
#[error(transparent)]
SerdeJsonError(#[from] serde_json::error::Error),
}
impl TryFrom<&str> for AlarmSeverity {
type Error = ThinEdgeJsonDeserializerError;
fn try_from(value: &str) -> Result<Self, Self::Error> {
match value {
"critical" => Ok(AlarmSeverity::Critical),
"major" => Ok(AlarmSeverity::Major),
"minor" => Ok(AlarmSeverity::Minor),
"warning" => Ok(AlarmSeverity::Warning),
invalid => Err(ThinEdgeJsonDeserializerError::UnsupportedAlarmSeverity(
invalid.into(),
)),
}
}
}
impl ThinEdgeAlarm {
pub fn try_from(
mqtt_topic: &str,
mqtt_payload: &str,
) -> Result<Self, ThinEdgeJsonDeserializerError> {
let topic_split: Vec<&str> = mqtt_topic.split('/').collect();
if topic_split.len() == 4 {
let alarm_name = topic_split[3];
if alarm_name.is_empty() {
return Err(ThinEdgeJsonDeserializerError::UnsupportedTopic(
mqtt_topic.into(),
));
}
let alarm_severity = topic_split[2];
let alarm_data = if mqtt_payload.is_empty() {
None
} else {
Some(serde_json::from_str(mqtt_payload)?)
};
Ok(Self {
name: alarm_name.into(),
severity: alarm_severity.try_into()?,
data: alarm_data,
})
} else {
Err(ThinEdgeJsonDeserializerError::UnsupportedTopic(
mqtt_topic.into(),
))
}
}
}
#[cfg(test)]
mod tests {
use super::*;
use assert_matches::assert_matches;
use serde_json::{json, Value};
use test_case::test_case;
use time::macros::datetime;
#[test_case(
"tedge/alarms/critical/temperature_alarm",
json!({
"text": "I raised it",
"time": "2021-04-23T19:00:00+05:00",
}),
ThinEdgeAlarm {
name: "temperature_alarm".into(),
severity: AlarmSeverity::Critical,
data: Some(ThinEdgeAlarmData {
text: Some("I raised it".into()),
time: Some(datetime!(2021-04-23 19:00:00 +05:00)),
}),
};
"critical alarm parsing"
)]
#[test_case(
"tedge/alarms/major/temperature_alarm",
json!({
"text": "I raised it",
}),
ThinEdgeAlarm {
name: "temperature_alarm".into(),
severity: AlarmSeverity::Major,
data: Some(ThinEdgeAlarmData {
text: Some("I raised it".into()),
time: None,
}),
};
"major alarm parsing without timestamp"
)]
#[test_case(
"tedge/alarms/minor/temperature_alarm",
json!({
"time": "2021-04-23T19:00:00+05:00",
}),
ThinEdgeAlarm {
name: "temperature_alarm".into(),
severity: AlarmSeverity::Minor,
data: Some(ThinEdgeAlarmData {
text: None,
time: Some(datetime!(2021-04-23 19:00:00 +05:00)),
}),
};
"minor alarm parsing without text"
)]
#[test_case(
"tedge/alarms/warning/temperature_alarm",
json!({}),
ThinEdgeAlarm {
name: "temperature_alarm".into(),
severity: AlarmSeverity::Warning,
data: Some(ThinEdgeAlarmData {
text: None,
time: None,
}),
};
"warning alarm parsing without text or timestamp"
)]
fn parse_thin_edge_alarm_json(
alarm_topic: &str,
alarm_payload: Value,
expected_alarm: ThinEdgeAlarm,
) {
let alarm =
ThinEdgeAlarm::try_from(alarm_topic, alarm_payload.to_string().as_str()).unwrap();
assert_eq!(alarm, expected_alarm);
}
#[test]
fn alarm_translation_empty_alarm_name() {
let result = ThinEdgeAlarm::try_from("tedge/alarms/critical/", "{}");
assert_matches!(
result,
Err(ThinEdgeJsonDeserializerError::UnsupportedTopic(_))
);
}
#[test]
fn alarm_translation_empty_severity() {
let result = ThinEdgeAlarm::try_from("tedge/alarms//some_alarm", "{}");
assert_matches!(
result,
Err(ThinEdgeJsonDeserializerError::UnsupportedAlarmSeverity(_))
);
}
#[test]
fn alarm_translation_empty_severity_and_name() {
let result = ThinEdgeAlarm::try_from("tedge/alarms//", "{}");
assert_matches!(
result,
Err(ThinEdgeJsonDeserializerError::UnsupportedTopic(_))
);
}
#[test]
fn alarm_translation_invalid_severity() {
let result = ThinEdgeAlarm::try_from("tedge/alarms/invalid_severity/foo", "{}");
assert_matches!(
result,
Err(ThinEdgeJsonDeserializerError::UnsupportedAlarmSeverity(_))
);
}
#[test]
fn alarm_translation_clear_alarm_with_empty_payload() {
let result = ThinEdgeAlarm::try_from("tedge/alarms/critical/temperature_high_alarm", "");
assert_matches!(result.unwrap().data, None);
}
}
|
