memfaultd 1.26.1

Memfault daemon for embedded Linux systems. Observability, logging, crash reporting, and updating all in one service. Learn more at https://docs.memfault.com/
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

//
// Copyright (c) Memfault, Inc.
// See License.txt for details
use crate::mar::DeviceAttribute;
use crate::metrics::MetricStringKey;
use argh::FromArgValue;
use serde_json::Value;
use std::str::FromStr;

impl FromArgValue for DeviceAttribute {
    fn from_arg_value(value: &str) -> Result<Self, String> {
        let (key, value_str) = value
            .split_once('=')
            .ok_or("Each attribute should be specified as KEY=VALUE")?;

        // Let's ensure the key is valid first:
        let metric_key = MetricStringKey::from_str(key)?;
        let value = match serde_json::from_str::<Value>(value_str) {
            Ok(value) => {
                if value.is_array() || value.is_object() {
                    return Err("Invalid value: arrays or objects are not allowed".to_string());
                }
                value
            }
            // Default to string value:
            Err(_) => value_str.into(),
        };
        Ok(DeviceAttribute::new(metric_key, value))
    }
}

#[cfg(test)]
mod tests {
    use rstest::rstest;

    use super::*;

    #[rstest]
    #[case("")]
    #[case("KEY")]
    #[case("KEY:VALUE")]
    fn split_failed(#[case] input: &str) {
        assert!(DeviceAttribute::from_arg_value(input)
            .err()
            .unwrap()
            .contains("Each attribute should be specified as KEY=VALUE"));
    }

    #[rstest]
    fn invalid_key() {
        assert_eq!(
            DeviceAttribute::from_arg_value("\u{1F4A9}=smelly")
                .err()
                .unwrap(),
            "Invalid key: must be ASCII"
        );
    }

    #[rstest]
    #[case("key=[]")]
    #[case("key={}")]
    fn invalid_value(#[case] input: &str) {
        assert_eq!(
            DeviceAttribute::from_arg_value(input).err().unwrap(),
            "Invalid value: arrays or objects are not allowed"
        );
    }

    #[rstest]
    #[case("key=", ("key", "").try_into())]
    #[case("key=my_string", ("key", "my_string").try_into())]
    #[case("key=123", ("key", 123).try_into())]
    #[case("key=123.456", ("key", 123.456).try_into())]
    #[case("key=true", ("key", true).try_into())]
    #[case("key=false", ("key", false).try_into())]
    #[case("key=\"false\"", ("key", "false").try_into())]
    #[case("key=\"[]\"", ("key", "[]").try_into())]
    #[case("key=\"{}\"", ("key", "{}").try_into())]
    fn parsed_ok(#[case] input: &str, #[case] expected: Result<DeviceAttribute, String>) {
        assert_eq!(DeviceAttribute::from_arg_value(input), expected);
    }
}