opsview 0.1.12

A Rust Opsview API Client Library with batteries included
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

use crate::prelude::*;
use serde::{Deserialize, Serialize};

// Example SNMPInterfaces JSON:
//
// "snmpinterfaces" : [
//    {
//       "active" : "0",
//       "discards_critical" : "15",
//       "discards_warning" : null,
//       "duplicatename" : "0",
//       "errors_critical" : "10",
//       "errors_warning" : null,
//       "indexid" : "0",
//       "interfacename" : "",
//       "throughput_critical" : "50%",
//       "throughput_warning" : null
//    },
//    {
//       "active" : "0",
//       "discards_critical" : "",
//       "discards_warning" : "",
//       "duplicatename" : "0",
//       "errors_critical" : "",
//       "errors_warning" : "",
//       "indexid" : "0",
//       "interfacename" : "eth0",
//       "throughput_critical" : "",
//       "throughput_warning" : ""
//    },
// ],

/// SNMPInterface represents a single SNMP interface configuration.
#[derive(Clone, Default, Debug, Serialize, Deserialize, PartialEq, Eq)]
pub struct SNMPInterface {
    /// Enables or disables the SNMP interface.
    #[serde(
        skip_serializing_if = "Option::is_none",
        deserialize_with = "deserialize_string_or_number_to_option_bool",
        serialize_with = "serialize_option_bool_as_string",
        default
    )]
    pub active: Option<bool>,

    /// The critical threshold for interface discards.
    pub discards_critical: Option<String>,

    /// The warning threshold for interface discards.
    pub discards_warning: Option<String>,

    /// TODO: Verify the meaning of this field.
    #[serde(
        skip_serializing_if = "Option::is_none",
        deserialize_with = "deserialize_string_or_number_to_option_bool",
        serialize_with = "serialize_option_bool_as_string",
        default
    )]
    pub duplicatename: Option<bool>,

    /// The critical threshold for interface errors.
    pub errors_critical: Option<String>,

    /// The warning threshold for interface errors.
    pub errors_warning: Option<String>,
    #[serde(
        skip_serializing_if = "Option::is_none",
        deserialize_with = "deserialize_string_or_number_to_u64",
        default
    )]

    /// The index ID of the interface.
    pub indexid: Option<u64>,

    /// The name of the interface.
    pub interfacename: Option<String>,

    /// The critical threshold for interface throughput.
    pub throughput_critical: Option<String>,

    /// The warning threshold for interface throughput.
    pub throughput_warning: Option<String>,
}

/// SNMPInterfaces is a list of SNMPInterface objects.
///
/// This type is used to represent the `snmpinterfaces` field in the Opsview JSON configuration.
///
/// The first SNMPInterface object in the list represents the default settings for all interfaces
/// and must have an `indexid` of 0 and an empty `interfacename`. This row is required when
/// submitting the list of interfaces to the Opsview API server.
pub type SNMPInterfaces = Vec<SNMPInterface>;

/// SNMPInterfacesExt provides additional methods for the SNMPInterfaces type.
pub trait SNMPInterfacesExt {
    /// Validates the SNMPInterfaces object.
    fn validate(&self) -> Result<(), OpsviewConfigError>;
}

impl SNMPInterfacesExt for SNMPInterfaces {
    fn validate(&self) -> Result<(), OpsviewConfigError> {
        if !self.is_empty() && self[0].interfacename != Some("".to_string()) {
            return Err(OpsviewConfigError::SNMPInterfacesIndex0InvalidName);
        }

        // TODO: Add additional validation logic.

        Ok(())
    }
}

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

    #[test]
    fn test_invalid_name_for_index_0() {
        let mut i: SNMPInterface = Default::default();
        i.interfacename = Some("eth0".to_string());
        i.indexid = Some(0);
        let i = i;

        let mut interfaces = SNMPInterfaces::new();
        interfaces.push(i);
        let interfaces = interfaces;

        let result = interfaces.validate();

        match result {
            Err(OpsviewConfigError::SNMPInterfacesIndex0InvalidName) => (),
            _ => panic!("Expected SNMPInterfacesIndex0InvalidName error"),
        }
    }
}