ProxyPC - Juniper

moler/device/juniper_ex3.py

@@ -0,0 +1,59 @@
+# -*- coding: utf-8 -*-
+"""
+JuniperEX module.
+"""
+
+__author__ = 'Sylwester Golonka, Jakub Kupiec, Marcin Usielski'
+__copyright__ = 'Copyright (C) 2019-2024, Nokia'
+__email__ = '[email protected], [email protected], [email protected]'
+
+from moler.device.junipergeneric3 import JuniperGeneric3
+from moler.helpers import call_base_class_method_with_same_name
+
+
+@call_base_class_method_with_same_name
+class JuniperEX3(JuniperGeneric3):
+    r"""
+    Juniperex device class.
+
+
+    ::
+
+
+      Example of device in yaml configuration file:
+      - with PROXY_PC:
+        JUNIPER_EX_PROXY_PC:
+          DEVICE_CLASS: moler.device.juniper_ex3.JuniperEX3
+          CONNECTION_HOPS:
+            PROXY_PC:
+              CLI:
+                execute_command: ssh
+                command_params:
+                  host: cli_host
+                  login: cli_login
+                  password: password
+            UNIX_LOCAL:
+              PROXY_PC:
+                execute_command: ssh
+                command_params:
+                  expected_prompt: "proxy_pc#"
+                  host: proxy_pc_host
+                  login: proxy_pc_login
+                  password: password
+            CLI:
+              PROXY_PC:
+                execute_command: exit
+                command_params:
+                  expected_prompt: "proxy_pc#"
+      - without PROXY_PC:
+        JUNIPER_EX:
+          DEVICE_CLASS: moler.device.juniper_ex3.JuniperEX3
+          CONNECTION_HOPS:
+            UNIX_LOCAL:
+              CLI:
+                execute_command: ssh # default value
+                command_params:
+                  host: cli_host
+                  login: cli_login
+                  password: password
+    """

moler/device/junipergeneric.py

@@ -124,8 +124,10 @@ def _get_default_sm_configuration_without_proxy_pc(self):
                     JuniperGeneric.unix_local: {  # to
                         "execute_command": "exit",  # using command
                         "command_params": {  # with parameters
-                            "expected_prompt": r'^moler_bash#'
+                            "expected_prompt": r'^moler_bash#',
+                            "target_newline": "\n",
                         },
+                        "required_command_params": [],
                     },
                     JuniperGeneric.configure: {
                         "execute_command": "configure",
@@ -313,6 +315,7 @@ def _prepare_state_hops_without_proxy_pc(self):
                 JuniperGeneric.configure: JuniperGeneric.cli,
             },
             JuniperGeneric.unix_local_root: {
+                JuniperGeneric.not_connected: JuniperGeneric.unix_local,
                 JuniperGeneric.cli: JuniperGeneric.unix_local,
                 JuniperGeneric.configure: JuniperGeneric.unix_local,
             },

moler/device/junipergeneric3.py

@@ -0,0 +1,237 @@
+# -*- coding: utf-8 -*-
+"""
+Juniper Generic module.
+"""
+
+__author__ = 'Sylwester Golonka, Jakub Kupiec, Marcin Usielski'
+__copyright__ = 'Copyright (C) 2019-2024, Nokia'
+__email__ = '[email protected], [email protected], [email protected]'
+
+import logging
+from abc import ABCMeta
+from six import add_metaclass
+from moler.device.proxy_pc3 import ProxyPc3
+from moler.helpers import call_base_class_method_with_same_name, mark_to_call_base_class_method_with_same_name
+
+
+@call_base_class_method_with_same_name
+@add_metaclass(ABCMeta)
+class JuniperGeneric3(ProxyPc3):
+    """Junipergeneric device class."""
+
+    cli = "CLI"
+    configure = "CONFIGURE"
+
+    def __init__(self, sm_params, name=None, io_connection=None, io_type=None, variant=None,
+                 io_constructor_kwargs=None, initial_state=None, lazy_cmds_events=False):
+        """
+        Create unix device communicating over io_connection.
+
+        :param sm_params: params with machine state description.
+        :param name: name of device.
+        :param io_connection: External-IO connection having embedded moler-connection
+        :param io_type: External-IO connection connection type
+        :param variant: External-IO connection variant
+        :param io_constructor_kwargs: additional parameters for constructor of selected io_type
+        :param initial_state: Initial state for device
+        :param lazy_cmds_events: set False to load all commands and events when device is initialized, set True to load
+                        commands and events when they are required for the first time.
+        """
+        sm_params = sm_params.copy()
+        initial_state = initial_state if initial_state is not None else JuniperGeneric3.cli
+        super(JuniperGeneric3, self).__init__(sm_params=sm_params, name=name, io_connection=io_connection,
+                                             io_type=io_type, variant=variant,
+                                             io_constructor_kwargs=io_constructor_kwargs,
+                                             initial_state=initial_state, lazy_cmds_events=lazy_cmds_events)
+        self.logger = logging.getLogger('moler.juniper')
+
+    @mark_to_call_base_class_method_with_same_name
+    def _get_default_sm_configuration_with_proxy_pc(self):
+        """
+        Return State Machine default configuration with proxy_pc state.
+
+        :return: default sm configuration with proxy_pc state.
+        """
+        config = {
+            JuniperGeneric3.connection_hops: {
+                JuniperGeneric3.proxy_pc: {  # from
+                    JuniperGeneric3.cli: {  # to
+                        "execute_command": "ssh",  # using command
+                        "command_params": {  # with parameters
+                            "set_timeout": None,
+                            "expected_prompt": "^admin@switch>"
+                        },
+                        "required_command_params": [
+                            "host",
+                            "login",
+                            "password",
+                        ]
+                    }
+                },
+                JuniperGeneric3.cli: {  # from
+                    JuniperGeneric3.proxy_pc: {  # to
+                        "execute_command": "exit",  # using command
+                        "command_params": {  # with parameters
+                        },
+                        "required_command_params": [
+                            "expected_prompt"
+                        ]
+                    },
+                    JuniperGeneric3.configure: {
+                        "execute_command": "configure",
+                        "command_params": {
+                            "expected_prompt": "^admin@switch#"
+                        }
+                    }
+                },
+                JuniperGeneric3.configure: {  # from
+                    JuniperGeneric3.cli: {  # to
+                        "execute_command": "exit_configure",  # using command
+                        "command_params": {  # with parameters
+                            "expected_prompt": "^admin@switch>"
+                        }
+                    },
+                }
+
+            }
+        }
+        return config
+
+    @mark_to_call_base_class_method_with_same_name
+    def _prepare_transitions_with_proxy_pc(self):
+        """
+        Prepare transitions to change states with proxy_pc state.
+
+        :return: transitions with proxy_pc state.
+        """
+
+        transitions = {
+            JuniperGeneric3.proxy_pc: {
+                JuniperGeneric3.cli: {
+                    "action": [
+                        "_execute_command_to_change_state"
+                    ],
+                },
+            },
+            JuniperGeneric3.cli: {
+
+                JuniperGeneric3.proxy_pc: {
+                    "action": [
+                        "_execute_command_to_change_state"
+                    ],
+                },
+                JuniperGeneric3.configure: {
+                    "action": [
+                        "_execute_command_to_change_state"
+                    ],
+                },
+            },
+            JuniperGeneric3.configure: {
+                JuniperGeneric3.cli: {
+                    "action": [
+                        "_execute_command_to_change_state"
+                    ],
+                }
+            }
+        }
+        return transitions
+
+    @mark_to_call_base_class_method_with_same_name
+    def _prepare_state_prompts_with_proxy_pc(self):
+        """
+        Prepare textual prompt for each state for State Machine with proxy_pc state.
+
+        :return: textual prompt for each state with proxy_pc state.
+        """
+        state_prompts = {
+            JuniperGeneric3.cli:
+                self._configurations[JuniperGeneric3.connection_hops][JuniperGeneric3.proxy_pc][
+                    JuniperGeneric3.cli][
+                    "command_params"]["expected_prompt"],
+            JuniperGeneric3.configure:
+                self._configurations[JuniperGeneric3.connection_hops][JuniperGeneric3.cli][JuniperGeneric3.configure][
+                    "command_params"]["expected_prompt"]
+        }
+        return state_prompts
+
+    @mark_to_call_base_class_method_with_same_name
+    def _prepare_state_prompts_without_proxy_pc(self):
+        """
+        Prepare textual prompt for each state for State Machine without proxy_pc state.
+
+        :return: textual prompt for each state without proxy_pc state.
+        """
+        state_prompts = {
+            JuniperGeneric3.cli:
+                self._configurations[JuniperGeneric3.connection_hops][JuniperGeneric3.unix_local][JuniperGeneric3.cli][
+                    "command_params"]["expected_prompt"],
+            JuniperGeneric3.configure:
+                self._configurations[JuniperGeneric3.connection_hops][JuniperGeneric3.cli][JuniperGeneric3.configure][
+                    "command_params"]["expected_prompt"]
+        }
+        return state_prompts
+
+    @mark_to_call_base_class_method_with_same_name
+    def _prepare_state_hops_with_proxy_pc(self):
+        """
+        Prepare non direct transitions for each state for State Machine with proxy_pc state.
+
+        :return: non direct transitions for each state with proxy_pc state.
+        """
+        state_hops = {
+            JuniperGeneric3.not_connected: {
+                JuniperGeneric3.cli: JuniperGeneric3.unix_local,
+                JuniperGeneric3.configure: JuniperGeneric3.unix_local,
+            },
+            JuniperGeneric3.cli: {
+                JuniperGeneric3.not_connected: JuniperGeneric3.proxy_pc,
+                JuniperGeneric3.unix_local: JuniperGeneric3.proxy_pc,
+                JuniperGeneric3.unix_local_root: JuniperGeneric3.proxy_pc,
+            },
+            JuniperGeneric3.configure: {
+                JuniperGeneric3.unix_local: JuniperGeneric3.cli,
+                JuniperGeneric3.proxy_pc: JuniperGeneric3.cli,
+                JuniperGeneric3.not_connected: JuniperGeneric3.cli,
+                JuniperGeneric3.unix_local_root: JuniperGeneric3.cli
+            },
+            JuniperGeneric3.unix_local: {
+                JuniperGeneric3.cli: JuniperGeneric3.proxy_pc,
+                JuniperGeneric3.configure: JuniperGeneric3.proxy_pc,
+            },
+            JuniperGeneric3.unix_local_root: {
+                JuniperGeneric3.not_connected: JuniperGeneric3.unix_local,
+                JuniperGeneric3.cli: JuniperGeneric3.unix_local,
+                JuniperGeneric3.configure: JuniperGeneric3.unix_local,
+            },
+            JuniperGeneric3.proxy_pc: {
+                JuniperGeneric3.not_connected: JuniperGeneric3.unix_local,
+                JuniperGeneric3.configure: JuniperGeneric3.cli,
+            }
+        }
+        return state_hops
+
+    def _get_packages_for_state(self, state, observer):
+        """
+        Get available packages contain cmds and events for each state.
+
+        :param state: device state.
+        :param observer: observer type, available: cmd, events
+        :return: available cmds or events for specific device state.
+        """
+        available = super(JuniperGeneric3, self)._get_packages_for_state(state, observer)
+
+        if not available:
+            if state == JuniperGeneric3.cli:
+                available = {
+                    JuniperGeneric3.cmds: ['moler.cmd.unix', 'moler.cmd.juniper.cli', 'moler.cmd.juniper_ex.cli'],
+                    JuniperGeneric3.events: ['moler.events.unix', 'moler.events.juniper', 'moler.events.juniper_ex']}
+            elif state == JuniperGeneric3.configure:
+                available = {
+                    JuniperGeneric3.cmds: ['moler.events.unix', 'moler.cmd.juniper.configure',
+                                          'moler.cmd.juniper_ex.configure'],
+                    JuniperGeneric3.events: ['moler.events.unix', 'moler.events.juniper', 'moler.events.juniper_ex']}
+
+            if available:
+                return available[observer]
+
+        return available