Merge pull request #121 from CiscoTestAutomation/release_26.1

Release 26.1

Author: omehrabi

docs/changelog/2026/january.rst

@@ -0,0 +1,85 @@
+January 2026
+==========
+
+January 27 - Unicon v26.1 
+------------------------
+
+
+
+.. csv-table:: Module Versions
+    :header: "Modules", "Versions"
+
+        ``unicon.plugins``, v26.1 
+        ``unicon``, v26.1 
+
+
+
+
+Changelogs
+^^^^^^^^^^
+--------------------------------------------------------------------------------
+                                      Fix                                       
+--------------------------------------------------------------------------------
+
+* unicon/patterns
+    * Update connection refused pattern to include "Requested line is busy!"
+
+* routers/connection_providers
+    * connect
+        * Unwrap connection kwargs and assign to device object for the arguments to be used by underlying connection providers.
+
+* bases/router/connection_provider
+    * Use enable service to transition to enable mode
+
+
+--------------------------------------------------------------------------------
+                                      Add                                       
+--------------------------------------------------------------------------------
+
+* nxos/n9kv
+    * Added AttachModuleConsoleN9k service to attach to module console of N9K devices.
+
+
+--------------------------------------------------------------------------------
+                                      New                                       
+--------------------------------------------------------------------------------
+
+* iosxe/c8kv/statemachine
+    * Added IosXEC8kvSingleRpStateMachine and IosXEC8kvDualRpStateMachine
+        * Added new state machine for C8KV devices to support boot statement
+
+* iosxe/cat9k/c9350/stack
+    * Added the support for stack for c9350 devices
+    * Added C9350StackReload service
+
+
+--------------------------------------------------------------------------------
+                                   Recovery.                                    
+--------------------------------------------------------------------------------
+
+* iosxe/c8kv/statements
+    * Added boot_image statement for C8KV devices
+        * Modified the statement to support C8KV grub> mode by adding send(cmd)
+
+
+--------------------------------------------------------------------------------
+                                      Fix                                       
+--------------------------------------------------------------------------------
+
+* pid_tokens
+    * Updated proper platform/model for IR1101 devices.
+
+* generic/service_pattern
+    * Modified ping validate pattern to match the "Validate reply data? [no]" prompt correctly in generic patterns.
+
+* generic/service_implementation
+    * enable
+        * Updated UniconAuthenticationError and CredentialsExhaustedError as exceptions as they were wrapped inside the subcommand failure for a failing UT.
+
+* iosxe/patterns
+    * Updated enable_prompt regex patterns to include 'eWLC' and allow alphanumeric characters in the device identifier section.
+
+* generic/statemachine
+    * Fixed config transition retry handling to avoid resending configure terminal when configuration mode is already entered.
+
+

docs/changelog/index.rst

@@ -4,6 +4,7 @@ Changelog
 .. toctree::
    :maxdepth: 2
 
+   2026/january
    2025/december
    2025/october
    2025/september

docs/changelog_plugins/2026/january.rst

@@ -0,0 +1,40 @@
+January 2026
+==========
+
+January 27 - Unicon v26.1  
+------------------------
+
+
+
+.. csv-table:: Module Versions
+    :header: "Modules", "Versions"
+
+        ``unicon.plugins``, v26.1 
+        ``unicon``, v26.1 
+
+
+
+
+Changelogs
+^^^^^^^^^^
+--------------------------------------------------------------------------------
+                                      Fix                                       
+--------------------------------------------------------------------------------
+
+* generic
+    * Update enable service to user transition dialog
+    * Update escape_char_stmt to handle 2 check for buffer for connection refuse
+
+* iosxe
+    * Add Enable service to explicitly add "enable" command
+
+* unicon.plugins
+    * IOSXE/C9500/SVL_STACK
+        * Add dis_state prompt statement  to stack_switchover_stmt_list preventing timeout when the standby comes up at disable mode.
+    * IOSXE
+        * updated the configure service logic to support the multiline banner
+
+* iosxr
+    * Updated the run_prompt regex to avoid mixing standalone # in execution output with enable prompt.
+
+

docs/changelog_plugins/index.rst

@@ -4,6 +4,7 @@ Plugins Changelog
 .. toctree::
    :maxdepth: 2
 
+   2026/january
    2025/december
    2025/october
    2025/september

src/unicon/plugins/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "25.11"
+__version__ = "26.1"
 
 supported_chassis = [
     'single_rp',

src/unicon/plugins/generic/service_implementation.py

@@ -28,7 +28,8 @@
 
 from unicon.bases.routers.services import BaseService
 from unicon.core.errors import SubCommandFailure, StateMachineError, \
-    CopyBadNetworkError, TimeoutError, UniconBackendDecodeError
+    CopyBadNetworkError, TimeoutError, UniconBackendDecodeError, \
+    UniconAuthenticationError, CredentialsExhaustedError
 from unicon.eal.dialogs import Dialog
 from unicon.eal.dialogs import Statement
 from unicon.plugins.generic.statements import (
@@ -47,6 +48,7 @@
 
 from unicon.plugins.generic.utils import GenericUtils
 from .service_statements import execution_statement_list, configure_statement_list
+from .statements import disable_enable_transition_statements
 from unicon.plugins.generic.statemachine import config_transition
 
 utils = GenericUtils()
@@ -480,6 +482,7 @@ def __init__(self, connection, context, **kwargs):
         super().__init__(connection, context, **kwargs)
         self.start_state = 'enable'
         self.end_state = 'enable'
+        self.dialog = Dialog(disable_enable_transition_statements)
         self.__dict__.update(kwargs)
 
     def pre_service(self, *args, **kwargs):
@@ -491,7 +494,7 @@ def call_service(self, target=None, command='', *args, **kwargs):
         handle = self.get_handle(target)
         spawn = self.get_spawn(target)
         sm = self.get_sm(target)
-        timeout = kwargs.get('timeout', None)
+        timeout = kwargs.get('timeout', None) or handle.settings.ENABLE_TIMEOUT
 
         # If the device is in rommon, enable() will use the
         # image_to_boot info to boot the image specified
@@ -511,9 +514,13 @@ def call_service(self, target=None, command='', *args, **kwargs):
                      spawn,
                      context=handle.context,
                      timeout=timeout)
+        except (UniconAuthenticationError, CredentialsExhaustedError):
+            # Don't wrap auth errors - re-raise them directly
+            raise
         except Exception as err:
             raise SubCommandFailure("Failed to Bring device to Enable State",
                                     err) from err
+
         self.result = True
 
 
@@ -604,6 +611,7 @@ def __init__(self, connection, context, **kwargs):
         self.matched_retry_sleep = connection.settings.EXECUTE_MATCHED_RETRY_SLEEP
         self.state_change_matched_retries = connection.settings.EXECUTE_STATE_CHANGE_MATCH_RETRIES
         self.state_change_matched_retry_sleep = connection.settings.EXECUTE_STATE_CHANGE_MATCH_RETRY_SLEEP
+        self.detect_state = True
 
     def log_service_call(self):
         pass
@@ -620,12 +628,15 @@ def call_service(self, command=[],  # noqa: C901
                      allow_state_change=None,
                      matched_retries=None,
                      matched_retry_sleep=None,
+                     detect_state=None,
                      *args, **kwargs):
         con = self.connection
         sm = self.get_sm()
         if allow_state_change is None:
             allow_state_change = con.settings.EXEC_ALLOW_STATE_CHANGE
 
+        self.detect_state = detect_state if detect_state is not None else self.detect_state
+
         timeout = timeout or self.timeout
 
         if error_pattern is None:
@@ -682,24 +693,25 @@ def call_service(self, command=[],  # noqa: C901
             if custom_auth_stmt:
                 dialog += Dialog(custom_auth_stmt)
 
-        # Add all known states to detect state changes.
-        for state in sm.states:
-            # The current state is already added by the service_dialog method
-            if state.name != sm.current_state:
-                if allow_state_change:
-                    dialog.append(Statement(
-                        pattern=state.pattern,
-                        matched_retries=self.state_change_matched_retries,
-                        matched_retry_sleep=self.state_change_matched_retry_sleep
-                    ))
-                else:
-                    dialog.append(Statement(
-                        pattern=state.pattern,
-                        action=invalid_state_change_action,
-                        args={'err_state': state, 'sm': sm},
-                        matched_retries=self.state_change_matched_retries,
-                        matched_retry_sleep=self.state_change_matched_retry_sleep
-                    ))
+        if self.detect_state:
+            # Add all known states to detect state changes.
+            for state in sm.states:
+                # The current state is already added by the service_dialog method
+                if state.name != sm.current_state:
+                    if allow_state_change:
+                        dialog.append(Statement(
+                            pattern=state.pattern,
+                            matched_retries=self.state_change_matched_retries,
+                            matched_retry_sleep=self.state_change_matched_retry_sleep
+                        ))
+                    else:
+                        dialog.append(Statement(
+                            pattern=state.pattern,
+                            action=invalid_state_change_action,
+                            args={'err_state': state, 'sm': sm},
+                            matched_retries=self.state_change_matched_retries,
+                            matched_retry_sleep=self.state_change_matched_retry_sleep
+                        ))
 
         # store the last used dialog, used by unittest
         self._last_dialog = dialog
@@ -926,7 +938,6 @@ def config_state_change(spawn, from_state, sm):
         if command:
             flat_cmd = self.utils.flatten_splitlines_command(command)
             dialog = self.dialog + self.service_dialog(handle=handle, service_dialog=reply)
-            sp = handle.spawn
             # Add all known states to detect state changes.
             for state in sm.states:
                 # The current state is already added by the service_dialog method
@@ -945,38 +956,52 @@ def config_state_change(spawn, from_state, sm):
                                 matched_retries=self.state_change_matched_retries,
                                 matched_retry_sleep=self.state_change_matched_retry_sleep
                             ))
+
+            banner_lines, command_lines, banner_delim = self.get_banner_lines(flat_cmd)
+
+            # Populate context for banner_text_handler only if banner was detected
+            if banner_lines:
+                self.connection.log.info('Banner detected, configuring banners without state detection')
+
+                # Send banner lines
+                for line in banner_lines:
+                    handle.spawn.sendline(line)
+                    time.sleep(0.1)
+                    handle.spawn.read_update_buffer()
+
+
             if bulk:
                 indicator = handle.settings.BULK_CONFIG_END_INDICATOR
-                cmd_lst = list(chain(flat_cmd, [indicator]))
+                cmd_lst = list(chain(command_lines, [indicator]))
                 if bulk_chunk_lines == 0:
                     chunks = [cmd_lst]
                 else:
                     chunks = [cmd_lst[i:i + bulk_chunk_lines]
                               for i in range(0, len(cmd_lst), bulk_chunk_lines)]
                 for idx, chunk in enumerate(chunks, 1):
                     chunk_cmd = '\n'.join(chunk)
-                    sp.sendline(chunk_cmd)
+                    handle.spawn.sendline(chunk_cmd)
                     if idx != len(chunks):
                         sleep(bulk_chunk_sleep)
-                        sp.read_update_buffer()
+                        handle.spawn.read_update_buffer()
                     else:
                         try:
-                            sp.expect([indicator], timeout=timeout,
+                            handle.spawn.expect([indicator], timeout=timeout,
                                       trim_buffer=False)
-                            self.result, _, sp.buffer = \
-                                sp.buffer.rpartition(indicator)
+                            self.result, _, handle.spawn.buffer = \
+                                handle.spawn.buffer.rpartition(indicator)
                         except Exception as err:
                             raise SubCommandFailure('Configuration failed',
                                                     err) from err
                 self.process_dialog_on_handle(handle, dialog, timeout)
                 if self.commit_cmd:
-                    sp.sendline(self.commit_cmd)
+                    handle.spawn.sendline(self.commit_cmd)
                     self.process_dialog_on_handle(handle, dialog, timeout)
             else:
-                cmds = chain(flat_cmd, [self.commit_cmd]) \
-                    if self.commit_cmd else flat_cmd
+                cmds = chain(command_lines, [self.commit_cmd]) \
+                    if self.commit_cmd else command_lines
                 for cmd in cmds:
-                    sp.sendline(cmd)
+                    handle.spawn.sendline(cmd)
                     self.update_hostname_if_needed([cmd])
                     self.process_dialog_on_handle(handle, dialog, timeout)
                     # To handle the session
@@ -986,7 +1011,7 @@ def config_state_change(spawn, from_state, sm):
                         sleep(self.connection.settings.CONFIG_LOCK_RETRY_SLEEP)
                         config_transition(handle.state_machine, handle.spawn, handle.context)
                         handle.context['config_session_locked'] = False
-                        sp.sendline(cmd)
+                        handle.spawn.sendline(cmd)
                         self.process_dialog_on_handle(handle, dialog, timeout)
 
         # store config_result so it can be returned to the user later
@@ -1005,6 +1030,37 @@ def config_state_change(spawn, from_state, sm):
         # return the config_result to the user via self.result
         self.result = config_result
 
+
+    def get_banner_lines(self, config_lines):
+        """ Process lines related to the banner command
+        Args:
+            config_lines (list): list of config lines
+        Returns:
+            tuple: (banner_lines, command_lines, banner_delim)
+        """
+        banner_lines = []
+        command_lines = []
+        banner_delim = None
+
+        for line in config_lines:
+
+            match = re.match(r'^\s*banner\s+(login|motd|exec|incoming)\s+(\S)', line)
+            if match:
+                banner_lines.append(line)
+                banner_delim = match.group(2)
+                continue
+
+            if banner_delim:
+                banner_lines.append(line)
+                # End of banner when delimiter repeats as a full line
+                if line.strip() == banner_delim:
+                    banner_delim = None
+                continue
+
+            command_lines.append(line)
+
+        return banner_lines, command_lines, banner_delim
+
     def process_dialog_on_handle(self, handle, dialog, timeout):
         try:
             cmd_result = dialog.process(

src/unicon/plugins/generic/service_patterns.py

@@ -99,7 +99,7 @@ def __init__(self):
         self.verbomode = r'^.*Verbose mode\? \[.+\]\s?: $'
         self.ext_cmds_source = r'^.*Source .*address( or interface)?\s?: $'
         self.tos = r'^.*Type of service \[.+\]\s?: $'
-        self.validate = r'^.*Validate reply data\? \[.+\]\s?: $'
+        self.validate = r'^.*Validate reply data\?\s*\[.+\]:\s*$'
         self.data_pattern = r'^.*Data pattern \[.+\]\s?: $'
         self.dfbit_header = r'^.*Set DF bit in IP header(\?)? \[.+\]\s?: $'
         self.dscp = r'^.*DSCP .*\[.+\]\s?: $'