rneter 0.4.4

SSH connection manager for network devices with intelligent state machine handling
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

use crate::device::{DeviceHandler, DeviceHandlerConfig, StateMachineDiagnostics};
use crate::error::ConnectError;

use super::catalog::BUILTIN_TEMPLATES;
use super::linux::{LinuxTemplateConfig, linux_handler_config};
use super::network::{
    arista_config, array_config, chaitin_config, checkpoint_config, cisco_config, dptech_config,
    fortinet_config, h3c_config, hillstone_config, huawei_config, juniper_config, maipu_config,
    paloalto_config, qianxin_config, topsec_config, venustech_config,
};

/// Creates a built-in template by name (case-insensitive).
pub fn by_name(name: &str) -> Result<DeviceHandler, ConnectError> {
    by_name_config(name)?.build()
}

/// Exports the underlying handler configuration for a built-in template by name.
pub fn by_name_config(name: &str) -> Result<DeviceHandlerConfig, ConnectError> {
    match name.to_ascii_lowercase().as_str() {
        "cisco" => Ok(cisco_config()),
        "huawei" => Ok(huawei_config()),
        "h3c" => Ok(h3c_config()),
        "hillstone" => Ok(hillstone_config()),
        "juniper" => Ok(juniper_config()),
        "array" => Ok(array_config()),
        "linux" => Ok(linux_handler_config(LinuxTemplateConfig::default())),
        "arista" => Ok(arista_config()),
        "fortinet" => Ok(fortinet_config()),
        "paloalto" => Ok(paloalto_config()),
        "topsec" => Ok(topsec_config()),
        "venustech" => Ok(venustech_config()),
        "dptech" => Ok(dptech_config()),
        "chaitin" => Ok(chaitin_config()),
        "qianxin" => Ok(qianxin_config()),
        "maipu" => Ok(maipu_config()),
        "checkpoint" => Ok(checkpoint_config()),
        _ => Err(ConnectError::TemplateNotFound(name.to_string())),
    }
}

/// Builds a template by name and returns its state-machine diagnostics.
pub fn diagnose_template(name: &str) -> Result<StateMachineDiagnostics, ConnectError> {
    let handler = by_name(name)?;
    Ok(handler.diagnose_state_machine())
}

/// Builds a template by name and exports diagnostics as pretty JSON.
pub fn diagnose_template_json(name: &str) -> Result<String, ConnectError> {
    let report = diagnose_template(name)?;
    serde_json::to_string_pretty(&report)
        .map_err(|e| ConnectError::InternalServerError(format!("encode diagnostics json: {e}")))
}

/// Exports diagnostics for all built-in templates as pretty JSON.
pub fn diagnose_all_templates_json() -> Result<String, ConnectError> {
    let mut reports = std::collections::BTreeMap::new();
    for name in BUILTIN_TEMPLATES {
        reports.insert((*name).to_string(), diagnose_template(name)?);
    }
    serde_json::to_string_pretty(&reports)
        .map_err(|e| ConnectError::InternalServerError(format!("encode diagnostics json: {e}")))
}

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

    #[test]
    fn by_name_is_case_insensitive() {
        let handler = by_name("CiScO").expect("cisco template should load");
        let diagnostics = handler.diagnose_state_machine();
        assert!(diagnostics.missing_edge_sources.is_empty());
        assert!(diagnostics.missing_edge_targets.is_empty());
    }

    #[test]
    fn by_name_config_builds_equivalent_handler() {
        let config = by_name_config("CiScO").expect("cisco config should load");
        let handler = by_name("cisco").expect("cisco handler should load");
        let rebuilt = config.build().expect("config should build");

        assert!(handler.is_equivalent(&rebuilt));
    }

    #[test]
    fn by_name_returns_template_not_found_for_unknown_name() {
        let err = match by_name("unknown-vendor") {
            Ok(_) => panic!("unknown template should fail"),
            Err(err) => err,
        };
        assert!(matches!(err, ConnectError::TemplateNotFound(_)));
    }

    #[test]
    fn diagnose_template_returns_report() {
        let report = diagnose_template("huawei").expect("diagnostics should succeed");
        assert!(report.total_states > 0);
    }

    #[test]
    fn diagnose_template_json_returns_valid_json() {
        let json = diagnose_template_json("cisco").expect("json diagnostics");
        let report: StateMachineDiagnostics =
            serde_json::from_str(&json).expect("parse diagnostics json");
        assert!(report.total_states > 0);
    }

    #[test]
    fn diagnose_all_templates_json_includes_builtin_template_keys() {
        let json = diagnose_all_templates_json().expect("all diagnostics json");
        let value: serde_json::Value = serde_json::from_str(&json).expect("parse json");
        for name in BUILTIN_TEMPLATES {
            assert!(value.get(*name).is_some(), "missing template key: {name}");
        }
    }
}