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
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

use once_cell::sync::Lazy;
use serde_json::Value;

use super::command_flow_template::{
    CommandFlowTemplate, CommandFlowTemplatePrompt, CommandFlowTemplateStep,
    CommandFlowTemplateVar, CommandFlowTemplateVarKind,
};

const DEFAULT_TRANSFER_TIMEOUT_SECS: u64 = 300;

static CISCO_LIKE_COMMAND_FLOW_TEMPLATE: Lazy<CommandFlowTemplate> = Lazy::new(|| {
    CommandFlowTemplate::new(
        "cisco_like_copy",
        vec![
            CommandFlowTemplateStep::from_template("{{command}}")
                .with_timeout_secs(DEFAULT_TRANSFER_TIMEOUT_SECS)
                .with_prompts(vec![
                    CommandFlowTemplatePrompt::from_template(
                        vec![r"(?i)^Address or name of remote host.*\?\s*$".to_string()],
                        "{{server_addr}}",
                    )
                    .with_append_newline(true)
                    .with_record_input(true),
                    CommandFlowTemplatePrompt::new(
                        vec![r"(?i)^Source (?:file ?name|filename).*\?\s*$".to_string()],
                        "{{remote_path}}",
                    )
                    .with_append_newline(true)
                    .with_record_input(true),
                    CommandFlowTemplatePrompt::new(
                        vec![r"(?i)^Destination (?:file ?name|filename).*\?\s*$".to_string()],
                        "{{remote_path}}",
                    )
                    .with_append_newline(true)
                    .with_record_input(true),
                    CommandFlowTemplatePrompt::from_template(
                        vec![
                            r"(?i)^Source username.*\?\s*$".to_string(),
                            r"(?i)^Destination username.*\?\s*$".to_string(),
                        ],
                        "{{transfer_username}}",
                    )
                    .with_append_newline(true)
                    .with_record_input(true),
                    CommandFlowTemplatePrompt::from_template(
                        vec![r"(?i)^.*password.*:\s*$".to_string()],
                        "{{transfer_password}}",
                    )
                    .with_append_newline(true),
                    CommandFlowTemplatePrompt::new(vec![r"(?i)^.*\[confirm\]\s*$".to_string()], "")
                        .with_append_newline(true),
                    CommandFlowTemplatePrompt::from_template(
                        vec![
                            r"(?i)^.*(?:overwrite|over write).*\[(?:y\/n|yes\/no)\].*$".to_string(),
                        ],
                        "{{overwrite_answer}}",
                    )
                    .with_append_newline(true),
                ]),
        ],
    )
    .with_description("Generic interactive SCP/TFTP copy flow for Cisco-like CLIs.")
    .with_default_mode("Enable")
    .with_vars(vec![
        CommandFlowTemplateVar::new("command")
            .with_label("Copy Command")
            .with_description("Full device-side copy command, e.g. `copy scp: flash:/image.bin`.")
            .with_required(true)
            .with_placeholder("copy scp: flash:/image.bin"),
        CommandFlowTemplateVar::new("server_addr")
            .with_label("Server Address")
            .with_description("SCP/TFTP server reachable from the target device.")
            .with_required(true)
            .with_placeholder("192.0.2.10"),
        CommandFlowTemplateVar::new("remote_path")
            .with_label("Remote Path")
            .with_description("Response used for Source/Destination file name prompts.")
            .with_required(true)
            .with_placeholder("/images/image.bin"),
        CommandFlowTemplateVar::new("transfer_username")
            .with_label("Transfer Username")
            .with_description("Required when the protocol is SCP.")
            .with_placeholder("backup"),
        CommandFlowTemplateVar::new("transfer_password")
            .with_label("Transfer Password")
            .with_description("Required when the protocol is SCP.")
            .with_kind(CommandFlowTemplateVarKind::Secret),
        CommandFlowTemplateVar::new("overwrite_answer")
            .with_label("Overwrite Answer")
            .with_description("Response for overwrite confirmation prompts.")
            .with_default_value(Value::String("y".to_string())),
    ])
});

/// Built-in copy workflow template for Cisco-like CLIs.
///
/// This template is intended for devices whose interactive copy prompts follow
/// Cisco-style wording, including built-in `cisco`, `arista`, `chaitin`,
/// `maipu`, and `venustech` handler profiles.
pub fn cisco_like_copy_template() -> CommandFlowTemplate {
    CISCO_LIKE_COMMAND_FLOW_TEMPLATE.clone()
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::templates::CommandFlowTemplateRuntime;
    use serde_json::json;

    #[test]
    fn cisco_like_copy_template_exposes_expected_metadata() {
        let template = cisco_like_copy_template();

        assert_eq!(template.name, "cisco_like_copy");
        assert_eq!(template.default_mode.as_deref(), Some("Enable"));
        assert_eq!(template.steps.len(), 1);
        assert_eq!(template.vars.len(), 6);
    }

    #[test]
    fn cisco_like_copy_template_renders_scp_to_device_flow() {
        let template = cisco_like_copy_template();
        let flow = template
            .to_command_flow(
                &CommandFlowTemplateRuntime::new()
                    .with_default_mode("Enable")
                    .with_vars(json!({
                        "command": "copy scp: flash:/image.bin",
                        "server_addr": "192.0.2.10",
                        "remote_path": "/pub/image.bin",
                        "transfer_username": "deploy",
                        "transfer_password": "secret",
                    })),
            )
            .expect("render flow");

        assert!(flow.stop_on_error);
        assert_eq!(flow.steps.len(), 1);

        let command = &flow.steps[0];
        assert_eq!(command.mode, "Enable");
        assert_eq!(command.command, "copy scp: flash:/image.bin");
        assert_eq!(command.timeout, Some(DEFAULT_TRANSFER_TIMEOUT_SECS));
        assert!(command.dyn_params.is_empty());
        assert_eq!(command.interaction.prompts.len(), 7);
        assert_eq!(command.interaction.prompts[0].response, "192.0.2.10\n");
        assert_eq!(command.interaction.prompts[1].response, "/pub/image.bin\n");
        assert_eq!(command.interaction.prompts[2].response, "/pub/image.bin\n");
        assert_eq!(command.interaction.prompts[3].response, "deploy\n");
        assert_eq!(command.interaction.prompts[4].response, "secret\n");
        assert_eq!(command.interaction.prompts[5].response, "\n");
        assert_eq!(command.interaction.prompts[6].response, "y\n");
    }

    #[test]
    fn cisco_like_copy_template_renders_tftp_from_device_flow() {
        let template = cisco_like_copy_template();
        let flow = template
            .to_command_flow(
                &CommandFlowTemplateRuntime::new()
                    .with_default_mode("Config")
                    .with_vars(json!({
                        "command": "copy startup-config tftp:",
                        "server_addr": "198.51.100.20",
                        "remote_path": "configs/r1.cfg",
                    })),
            )
            .expect("render flow");

        let command = &flow.steps[0];

        assert_eq!(command.command, "copy startup-config tftp:");
        assert_eq!(command.mode, "Config");
        assert_eq!(command.timeout, Some(DEFAULT_TRANSFER_TIMEOUT_SECS));
        assert!(command.dyn_params.is_empty());
        assert_eq!(command.interaction.prompts.len(), 7);
        assert_eq!(command.interaction.prompts[0].response, "198.51.100.20\n");
        assert_eq!(command.interaction.prompts[1].response, "configs/r1.cfg\n");
        assert_eq!(command.interaction.prompts[2].response, "configs/r1.cfg\n");
        assert_eq!(command.interaction.prompts[6].response, "y\n");
    }

    #[test]
    fn cisco_like_copy_template_renders_empty_optional_scp_credentials() {
        let template = cisco_like_copy_template();
        let flow = template
            .to_command_flow(&CommandFlowTemplateRuntime::new().with_vars(json!({
                "command": "copy startup-config scp:",
                "server_addr": "198.51.100.20",
                "remote_path": "configs/r1.cfg",
            })))
            .expect("render flow");

        assert_eq!(flow.steps.len(), 1);
        assert_eq!(flow.steps[0].interaction.prompts[3].response, "\n");
        assert_eq!(flow.steps[0].interaction.prompts[4].response, "\n");
        assert_eq!(flow.steps[0].interaction.prompts[6].response, "y\n");
    }

    #[test]
    fn cisco_like_copy_template_renders_custom_overwrite_answer() {
        let template = cisco_like_copy_template();
        let flow = template
            .to_command_flow(&CommandFlowTemplateRuntime::new().with_vars(json!({
                "command": "copy scp: flash:/image.bin",
                "server_addr": "198.51.100.20",
                "remote_path": "/pub/image.bin",
                "overwrite_answer": "n",
            })))
            .expect("render flow");

        assert_eq!(flow.steps[0].interaction.prompts[6].response, "n\n");
    }
}