Releasing v25.2

Taarini Sarath Chander · Taarini Sarath Chander · commit cd4ea25c0f34 · 2025-02-28T13:18:48.000-05:00
diff --git a/Makefile b/Makefile
@@ -11,7 +11,7 @@ PYPIREPO      = pypitest
 
 DEPENDENCIES = robotframework pyyaml dill coverage Sphinx \
 			   sphinxcontrib-napoleon sphinxcontrib-mockautodoc \
-			   sphinx-rtd-theme asyncssh PrettyTable "cryptography>=44.0"
+			   sphinx-rtd-theme asyncssh PrettyTable "cryptography>=43.0"
 
 
 .PHONY: clean package distribute develop undevelop help devnet\
diff --git a/docs/changelog/2025/february.rst b/docs/changelog/2025/february.rst
@@ -0,0 +1,48 @@
+February 2025
+==========
+
+February 25 - Unicon v25.2 
+------------------------
+
+
+
+.. csv-table:: Module Versions
+    :header: "Modules", "Versions"
+
+        ``unicon.plugins``, v25.2 
+        ``unicon``, v25.2 
+
+
+
+
+Changelogs
+^^^^^^^^^^
+--------------------------------------------------------------------------------
+                                      Fix                                       
+--------------------------------------------------------------------------------
+
+* router.connection_provider
+    * Modified disconnect
+        * Added sendline('exit') on disconnect
+
+
+--------------------------------------------------------------------------------
+                                      Fix                                       
+--------------------------------------------------------------------------------
+
+* generic
+    * updated exception for Recover device using golden image if reload is failed.
+
+
+--------------------------------------------------------------------------------
+                                      New                                       
+--------------------------------------------------------------------------------
+
+* iosxe/vpagent
+    * Add connection provider for vpagent
+
+* iosxe
+    * Added to Configure Error Patterns
+        * Added the regex to match error pattern "127.0 / 255.0 is an invalid network."
+
+
diff --git a/docs/changelog/2025/january.rst b/docs/changelog/2025/january.rst
@@ -56,6 +56,4 @@ Changelogs
     * Added below config error patterns
         * % VLAN [<vlan_id>] already in use
     * Added below config error patterns
-        * % VNI <VNI_ID> is either already in use or exceeds the maximum allowable VNIs.
-
-
+        * % VNI <VNI_ID> is either already in use or exceeds the maximum allowable VNIs.
diff --git a/docs/changelog/index.rst b/docs/changelog/index.rst
@@ -4,6 +4,7 @@ Changelog
 .. toctree::
    :maxdepth: 2
 
+   2025/february
    2025/january
    2024/november
    2024/october
diff --git a/docs/changelog_plugins/2025/february.rst b/docs/changelog_plugins/2025/february.rst
@@ -0,0 +1,36 @@
+February 2025
+==========
+
+February 25 - Unicon.Plugins v25.2 
+------------------------
+
+
+
+.. csv-table:: Module Versions
+    :header: "Modules", "Versions"
+
+        ``unicon.plugins``, v25.2 
+        ``unicon``, v25.2 
+
+
+
+
+Changelogs
+^^^^^^^^^^
+--------------------------------------------------------------------------------
+                                      Fix                                       
+--------------------------------------------------------------------------------
+
+* generic
+    * Updates to setup patterns
+    * Update connection refused handler to clear line after max count
+    * Update token discovery to use rv1 parsers
+    * Update token discovery to handle standby locked devices
+
+* staros
+    * Update prompt pattern
+
+* iosxe
+    * Updated the enable, disable and maintenance states to support `(unlicensed)` prompt
+
+
diff --git a/docs/changelog_plugins/2025/january.rst b/docs/changelog_plugins/2025/january.rst
@@ -37,6 +37,4 @@ Changelogs
     * update syslog message pattern
 
 * unicon.plugins
-    * Fix syntax warning
-
-
+    * Fix syntax warning
diff --git a/docs/changelog_plugins/index.rst b/docs/changelog_plugins/index.rst
@@ -4,6 +4,7 @@ Plugins Changelog
 .. toctree::
    :maxdepth: 2
 
+   2025/february
    2025/january
    2024/november
    2024/october
diff --git a/setup.py b/setup.py
@@ -51,7 +51,7 @@ def version_info(*paths):
 install_requires = ['unicon {range}'.format(range = version_range),
                     'pyyaml',
                     'PrettyTable',
-                    'cryptography>=44.0']
+                    'cryptography>=43.0']
 
 # launch setup
 setup(
diff --git a/src/unicon/plugins/__init__.py b/src/unicon/plugins/__init__.py
@@ -1,4 +1,4 @@
-__version__ = '25.1'
+__version__ = '25.2'
 
 supported_chassis = [
     'single_rp',
diff --git a/src/unicon/plugins/generic/patterns.py b/src/unicon/plugins/generic/patterns.py
@@ -51,8 +51,8 @@ def __init__(self):
         self.press_ctrlx = r"^(.*?)Press Ctrl\+x to Exit the session"
         self.connected = r'^(.*?)Connected.'
 
-        self.enter_basic_mgmt_setup = r'Would you like to enter basic management setup\? \[yes/no\]:'
-        self.kerberos_no_realm = r'^(.*)Kerberos:\s*No default realm defined for Kerberos!'
+        self.enter_basic_mgmt_setup = r'Would you like to enter basic management setup\? \[yes/no\]:\s*$'
+        self.kerberos_no_realm = r'^(.*)Kerberos:\s*No default realm defined for Kerberos!\s*$'
 
         self.passphrase_prompt = r'^.*Enter passphrase for key .*?:\s*?'
 
diff --git a/src/unicon/plugins/generic/service_implementation.py b/src/unicon/plugins/generic/service_implementation.py
@@ -1172,7 +1172,8 @@ def call_service(self,
         except Exception as e:
             if hasattr(con.device, 'clean') and hasattr(con.device.clean, 'device_recovery') and\
                 con.device.clean.device_recovery.get('golden_image'):
-                    con.log.error(f'Reload failed booting device using golden image: {con.device.clean.device_recovery["golden_image"]}')
+                    con.log.exception(f"Reload failed to install with file: {getattr(con.device.clean, 'images', [None])[0]}")
+                    con.log.info(f'Booting the device using golden_image.')
                     con.device.api.device_recovery_boot(golden_image=con.device.clean.device_recovery['golden_image'])
                     con.log.info('Successfully booted the device using golden_image.')
                     raise
diff --git a/src/unicon/plugins/generic/settings.py b/src/unicon/plugins/generic/settings.py
@@ -55,6 +55,7 @@ def __init__(self):
         self.CONSOLE_TIMEOUT = 60
         self.BOOT_TIMEOUT = 600
         self.MAX_BOOT_ATTEMPTS = 3
+        self.CONNECTION_REFUSED_MAX_COUNT = 3
 
         # Temporary enable secret used during setup
         # this is used if no password is available
diff --git a/src/unicon/plugins/generic/statements.py b/src/unicon/plugins/generic/statements.py
@@ -43,13 +43,16 @@ def terminal_position_handler(spawn, session, context):
     spawn.send('\x1b[0;200R')
 
 
-def connection_refused_handler(spawn):
+def connection_refused_handler(spawn, context):
     """ handles connection refused scenarios
     """
-    if spawn.device:
-        spawn.device.api.execute_clear_line()
-        spawn.device.connect()
-        return
+    context.setdefault('connection_refused_count', 0)
+    context['connection_refused_count'] += 1
+    if context.get('connection_refused_count') < spawn.settings.CONNECTION_REFUSED_MAX_COUNT:
+        if spawn.device:
+            spawn.device.api.execute_clear_line()
+            spawn.device.connect()
+            return
     raise Exception('Connection refused to device %s' % (str(spawn)))
 
 
diff --git a/src/unicon/plugins/iosxe/patterns.py b/src/unicon/plugins/iosxe/patterns.py
@@ -23,11 +23,11 @@ def __init__(self):
         self.want_continue_confirm = r'.*Do you want to continue\?\s*\[confirm]\s*$'
         self.want_continue_yes = r'.*Do you want to continue\?\s*\[y/n]\?\s*\[yes]:\s*$'
         self.disable_prompt = \
-            r'^(.*?)(WLC|Router|RouterRP|Switch|ios|switch|%N)([0-9])?(\(standby\))?(-stby)?(-standby)?(\(boot\))?(\(recovery-mode\))?>\s?$'
+            r'^(.*?)(\(unlicensed\))?(WLC|Router|RouterRP|Switch|ios|switch|%N)([0-9])?(\(standby\))?(-stby)?(-standby)?(\(boot\))?(\(recovery-mode\))?>\s?$'
         self.enable_prompt = \
-            r'^(.*?)(WLC|Router|RouterRP|Switch|ios|switch|%N)([0-9])?(\(standby\))?(-stby)?(-standby)?(\(boot\))?(\(recovery-mode\))?#[\s\x07]*$'
+            r'^(.*?)(\(unlicensed\))?(WLC|Router|RouterRP|Switch|ios|switch|%N)([0-9])?(\(standby\))?(-stby)?(-standby)?(\(boot\))?(\(recovery-mode\))?#[\s\x07]*$'
         self.maintenance_mode_prompt = \
-            r'^(.*?)(WLC|Router|RouterRP|Switch|ios|switch|%N)([0-9])?(\(standby\))?(-stby)?(-standby)?(\(boot\))?\(maint-mode\)#[\s\x07]*$'
+            r'^(.*?)(\(unlicensed\))?(WLC|Router|RouterRP|Switch|ios|switch|%N)([0-9])?(\(standby\))?(-stby)?(-standby)?(\(boot\))?\(maint-mode\)#[\s\x07]*$'
         self.press_enter = ReloadPatterns().press_enter
         self.config_prompt = r'^(.*)\((?!.*pki-hexmode).*(con|cfg|ipsec-profile|ca-trustpoint|ca-certificate-map|cs-server|ca-profile|gkm-local-server|cloud|host-list|config-gkm-group|gkm-sa-ipsec|gdoi-coop-ks-config|wsma|enforce-rule|DDNS)\S*\)#\s?$'
 
diff --git a/src/unicon/plugins/iosxe/settings.py b/src/unicon/plugins/iosxe/settings.py
@@ -26,6 +26,7 @@ def __init__(self):
             r'routing table \S+ does not exist',
             r'^%\s*SR feature is not configured yet, please enable Segment-routing first.',
             r'^%\s*\S+ overlaps with \S+',
+            r'^\S+ / \S+ is an [Ii]nvalid network\.',
             r'^%\S+ is linked to a VRF. Enable \S+ on that VRF first.',
             r'% VRF \S+ not configured',
             r'% Incomplete command.',
diff --git a/src/unicon/plugins/iosxe/statements.py b/src/unicon/plugins/iosxe/statements.py
@@ -230,10 +230,11 @@ def boot_finished_deco(func):
     '''
 
     @wraps(func)
-    def wrapper(spawn, context, session):
+    def wrapper(spawn, session, context, **kwargs):
+        args = [a for a in [spawn, session, context] if a]
         if context:
             context.pop('boot_start_time', None)
-        return func(spawn)
+        return func(*args, **kwargs)
     return wrapper
 
 
diff --git a/src/unicon/plugins/iosxe/vpagent/__init__.py b/src/unicon/plugins/iosxe/vpagent/__init__.py
@@ -0,0 +1,11 @@
+from unicon.plugins.iosxe import IosXESingleRpConnection
+from unicon.plugins.iosxe.vpagent.settings import VpagentIosxeSettings
+from unicon.plugins.iosxe.vpagent.connection_provider import  VpagentSingleRpConnectionProvider
+
+
+
+class VpagentSingleRpConnection(IosXESingleRpConnection):
+    platform = 'vpagent'
+    chassis_type = 'single_rp'
+    connection_provider_class = VpagentSingleRpConnectionProvider
+    settings = VpagentIosxeSettings()
diff --git a/src/unicon/plugins/iosxe/vpagent/connection_provider.py b/src/unicon/plugins/iosxe/vpagent/connection_provider.py
@@ -0,0 +1,88 @@
+from time import sleep
+
+from unicon.plugins.iosxe.connection_provider import IosxeSingleRpConnectionProvider
+
+
+class VpagentSingleRpConnectionProvider(IosxeSingleRpConnectionProvider):
+    """ Implements Vpagent singleRP Connection Provider,
+        This class overrides the base class with the
+        additional dialogs and steps required for
+        connecting to any device via generic implementation
+    """
+
+    def __init__(self, *args, **kwargs):
+
+        """ Initializes the generic connection provider
+        """
+        super().__init__(*args, **kwargs)
+
+
+    def establish_connection(self):
+        """ Reads the device state and brings it to the right state
+        Note: Passive hostname learning is enabled by default and will
+        give a warning if the device hostname does not match the learned
+        hostname. The learned hostname is only used if user specifies
+        `learn_hostname=True`. A timeout may occur if the prompt pattern
+        uses the hostname, the timeout error includes the hostname and
+        a hint to check the hostname if a mismatch was detected.
+        """
+        con = self.connection
+
+        # Enable hostname learning by default
+        con.state_machine.learn_hostname = True
+        con.state_machine.learn_pattern = con.settings.DEFAULT_LEARNED_HOSTNAME
+
+        context = self.connection.context
+        if (login_creds := context.get('login_creds')):
+            context.update(cred_list=login_creds)
+
+        # Before accessing the vm since device is not ready and connection may be 
+        # closed by vcenter manger we need to wait before accessing the device.
+        timeout = con.settings.WAITE_TIMEOUT 
+        con.log.info(f'sleeping for {timeout} seconds before accessing the device!')
+        sleep(timeout)
+
+        dialog  = self.get_connection_dialog()
+        # Try to bring device to any state connection may be closed during bring the device
+        # to a valid and cause an IO error 
+        output = self._get_device_to_any(con, context, dialog)
+        # if device is still in generic state that means we could not bring device to any state and 
+        # spawn is closed so we need to create a new spawn and try again to bring device to any state
+        if con.state_machine.current_state == 'generic':
+            con.setup_connection()
+            output = self._get_device_to_any(con, context, dialog)
+
+        if con.state_machine.current_state == "config":
+            con.state_machine.go_to('enable',
+                                    self.connection.spawn,
+                                    context=context,
+                                    prompt_recovery=self.prompt_recovery,
+                                    timeout=self.connection.connection_timeout)
+
+        if con.state_machine.current_state not in ['rommon', 'standby_locked', 'shell']:
+            cur_state = con.state_machine.get_state(con.state_machine.current_state)
+            # if the learn hostname is set to True the pattern for state machine updated with
+            # '(?P<hostname00...)' regex patterns so we check for the pattern before learning the hostname
+            if 'P<hostname' in cur_state.pattern:
+                self.learn_hostname()
+            # If device is found in one of the above states, init_handle()
+            # will change the device state to enable, after which
+            # hostname learning and token discovery is done.
+            self.learn_tokens()
+
+        con.state_machine.learn_hostname = False
+        context.pop('cred_list', None)
+
+        return output
+
+    def _get_device_to_any(self, connection, context, dialog):
+        try:       
+            connection.state_machine.go_to('any',
+                                            self.connection.spawn,
+                                            context=context,
+                                            prompt_recovery=self.prompt_recovery,
+                                            timeout=self.connection.connection_timeout,
+                                            dialog=dialog)
+        except Exception:
+            connection.setup_connection()
+            self._get_device_to_any(connection, context, dialog)
diff --git a/src/unicon/plugins/iosxe/vpagent/settings.py b/src/unicon/plugins/iosxe/vpagent/settings.py
@@ -0,0 +1,9 @@
+""" Vpagent IOS-XE Settings. """
+
+from unicon.plugins.iosxe.settings import IosXESettings
+
+class VpagentIosxeSettings(IosXESettings):
+
+    def __init__(self):
+        super().__init__()
+        self.WAITE_TIMEOUT = 60
diff --git a/src/unicon/plugins/iosxr/settings.py b/src/unicon/plugins/iosxr/settings.py
@@ -49,6 +49,8 @@ def __init__(self):
             r'^%\s*Failed to commit.*'
         ]
 
+        self.HA_STANDBY_UNLOCK_COMMANDS = []
+
         self.EXECUTE_MATCHED_RETRIES = 1
         self.EXECUTE_MATCHED_RETRY_SLEEP = 0.1
 
diff --git a/src/unicon/plugins/staros/patterns.py b/src/unicon/plugins/staros/patterns.py
@@ -5,8 +5,8 @@
 class StarosPatterns(GenericPatterns):
     def __init__(self):
         super().__init__()
-        self.exec_prompt = r'^(.*?)(\[\S+\]%N[#>])\s*$'
-        self.config_prompt = r'^(.*?)(\[\S+\]%N\(\S+\)[#>])\s*$'
+        self.exec_prompt = r'^(.*?)(\[\S+\] ?%N[#>])\s*$'
+        self.config_prompt = r'^(.*?)(\[\S+\] ?%N\(\S+\)[#>])\s*$'
         self.monitor_main_prompt = r'^(.*?\(Q\)uit,\s+<ESC> Prev Menu,\s+<SPACE> Pause,\s+<ENTER> Re-Display Options.*)$'
         self.monitor_sub_prompt = r'^(.*?\(B\)egin Protocol Decoding\s+\(Q\)uit,\s+<ESC> Prev Menu,\s+<ENTER> Re-Display Options\s+Select:)\s*'
         self.yes_no_prompt = r'^(.*?)Are you sure \? \[Yes | No\]:\s*'
diff --git a/src/unicon/plugins/tests/mock_data/iosxe/iosxe_mock_data.yaml b/src/unicon/plugins/tests/mock_data/iosxe/iosxe_mock_data.yaml
@@ -1654,6 +1654,12 @@ transition_to_general_enable2:
     "":
       new_state: general_enable
 
+connection_refused_loop:
+  commands:
+    "":
+      response: |
+        telnet: connect to address 127.0.0.1: Connection refused
+
 
 confirm_abort_copy:
   preface: |
@@ -1681,3 +1687,10 @@ general_enable_no_operating_mode:
   commands:
     <<: *gen_enable_cmds
     "show version | include operating mode" : "unexpected output"
+
+unlicensed_prompt:
+  prompt: "(unlicensed)UUT#"
+  commands:
+    "show version | include operating mode": ""
+    "end":
+      new_state: general_enable
diff --git a/src/unicon/plugins/tests/mock_data/iosxe/iosxe_mock_data_vpagent.yaml b/src/unicon/plugins/tests/mock_data/iosxe/iosxe_mock_data_vpagent.yaml
diff --git a/src/unicon/plugins/tests/mock_data/staros/staros_mock_data.yaml b/src/unicon/plugins/tests/mock_data/staros/staros_mock_data.yaml
diff --git a/src/unicon/plugins/tests/test_plugin_generic.py b/src/unicon/plugins/tests/test_plugin_generic.py
diff --git a/src/unicon/plugins/tests/test_plugin_iosxe.py b/src/unicon/plugins/tests/test_plugin_iosxe.py
diff --git a/src/unicon/plugins/tests/test_plugin_staros.py b/src/unicon/plugins/tests/test_plugin_staros.py
diff --git a/src/unicon/plugins/utils.py b/src/unicon/plugins/utils.py

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-__version__ = '25.1'`
	`1`	`+__version__ = '25.2'`
`2`	`2`
`3`	`3`	`supported_chassis = [`
`4`	`4`	`'single_rp',`