Releasing v24.4

Author: Taarini Sarath Chander

docs/changelog/2024/april.rst

@@ -0,0 +1,102 @@
+April 2024
+==========
+
+ - Unicon v24.4 
+------------------------
+
+
+
+.. csv-table:: Module Versions
+    :header: "Modules", "Versions"
+
+        ``unicon.plugins``, v24.4 
+        ``unicon``, v24.4 
+
+Install Instructions
+^^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: bash
+
+    bash$ pip install unicon.plugins
+    bash$ pip install unicon
+
+Upgrade Instructions
+^^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: bash
+
+    bash$ pip install --upgrade unicon.plugins
+    bash$ pip install --upgrade unicon
+
+Features and Bug Fixes:
+^^^^^^^^^^^^^^^^^^^^^^^
+
+
+
+
+Changelogs
+^^^^^^^^^^
+--------------------------------------------------------------------------------
+                                      Fix                                       
+--------------------------------------------------------------------------------
+
+* sshutils
+    * add_tunnel
+        * add logic to handle allocating ports based on the tunnel type.
+
+* unicon
+    * Bases/Routers
+        * Do learn hostname if only the learn pattern is in the statmachine patterns.
+        * Update the connection init logic.
+    * Patterns
+        * Add Bad secrets to bad_passwords pattern.
+
+* unicon/bases
+    * Router/connection_provider
+        * Update logic to not learn the hostname when the device is in shell mode.
+
+
+--------------------------------------------------------------------------------
+                                      New                                       
+--------------------------------------------------------------------------------
+
+* unicon
+    * Connection provider
+        * Add args and kwargs for connect function
+
+
+--------------------------------------------------------------------------------
+                                      New                                       
+--------------------------------------------------------------------------------
+
+* iosxe
+    * statemachine
+        * add pki_hexmode state for iosxe
+
+* iosxr
+    * Added get_commit_cmd
+        * Added support for 'commit best-effort' command.
+
+* stackresetstandbyrp
+    * Added iosxe/stack StackResetStandbyRP
+        * iosxe/stack service reset_standby_rp
+        * Check whole stack readiness to decide the result of reset_standby_rp
+
+
+--------------------------------------------------------------------------------
+                                      Fix                                       
+--------------------------------------------------------------------------------
+
+* iosxr/spitfire
+    * Modified Prompt Recovery Commands
+        * Updated prompt recovery commands to user CTRL+C.
+
+* iosxe
+    * connection provider
+        * Get the pattern for the enable statment from state machine for handeling device prompts after
+
+* resetstandbyrp
+    * Modified generic ResetStandbyRP
+        * Fixed to handle the optinal argument "reply"
+
+

docs/changelog/index.rst

@@ -4,6 +4,7 @@ Changelog
 .. toctree::
    :maxdepth: 2
 
+   2024/april
    2024/march
    2024/february
    2024/january

docs/changelog_plugins/2024/april.rst

@@ -0,0 +1,67 @@
+April 2024
+==========
+
+ - Unicon.Plugins v24.4 
+------------------------
+
+
+
+.. csv-table:: Module Versions
+    :header: "Modules", "Versions"
+
+        ``unicon.plugins``, v24.4 
+        ``unicon``, v24.4 
+
+Install Instructions
+^^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: bash
+
+    bash$ pip install unicon.plugins
+    bash$ pip install unicon
+
+Upgrade Instructions
+^^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: bash
+
+    bash$ pip install --upgrade unicon.plugins
+    bash$ pip install --upgrade unicon
+
+Features and Bug Fixes:
+^^^^^^^^^^^^^^^^^^^^^^^
+
+
+
+
+Changelogs
+^^^^^^^^^^
+--------------------------------------------------------------------------------
+                                      Fix                                       
+--------------------------------------------------------------------------------
+
+* generic
+    * Use stricter pattern for enable password
+    * Update standby locked pattern
+    * Add connection closed statement to execute service
+    * Add standby locked state to single RP statemachine
+    * Update escape character handler timing settings
+    * Revert adding connection closed statement to execute service
+    * Update config transition logic
+    * Add `result_check_per_command` option to disable/enable error checking per configuration command
+
+* iosxe
+    * Fix operating mode logic
+    * More prompt handling updated
+    * Added statements to token discovery dialog
+
+* iosxr
+    * Add standby locked state to single RP statemachine
+    * Change default behavior of ``configure()`` service, error check after all commands by default
+    * Add handler for `show configuration failed` errors to ``configure()`` service.
+    * Add `SHOW_CONFIG_FAILED_CMD` setting for command to use, default `show configuration failed`
+
+* other
+    * update pid token list
+
+

docs/changelog_plugins/index.rst

@@ -4,6 +4,7 @@ Plugins Changelog
 .. toctree::
    :maxdepth: 2
 
+   2024/april
    2024/march
    2024/february
    2024/january

src/unicon/plugins/__init__.py

@@ -1,4 +1,4 @@
-__version__ = '24.3'
+__version__ = '24.4'
 
 supported_chassis = [
     'single_rp',

src/unicon/plugins/cheetah/ap/__init__.py

@@ -54,4 +54,4 @@ class ApSingleRpConnection(BaseSingleRpConnection):
     state_machine_class = ApSingleRpStateMachine
     connection_provider_class = ApSingleRpConnectionProvider
     subcommand_list = ApServiceList
-    settings = ApSettings()
+    settings = ApSettings()

src/unicon/plugins/cheetah/ap/patterns.py

@@ -9,4 +9,4 @@ class CheetahAPPatterns(GenericPatterns):
 
     def __init__(self):
         super().__init__()
-        self.ap_shell_prompt = r'^(.*?)\w+:\/(.*?)#\s?$'
+        self.ap_shell_prompt = r'^(.*?)\w+:\/(.*?)#\s?$'

src/unicon/plugins/cheetah/ap/service_implementation.py

@@ -21,4 +21,4 @@ def call_service(self, command=None, reply=Dialog([]), timeout=None, *args,
 class Reload(GenericReload):
     def __init__(self, connection, context, **kwargs):
         super().__init__(connection, context, **kwargs)
-        self.dialog = self.dialog + Dialog(ap_reload_list)
+        self.dialog = self.dialog + Dialog(ap_reload_list)

src/unicon/plugins/cheetah/ap/service_patterns.py

@@ -5,5 +5,4 @@
 class APReloadPatterns(ReloadPatterns):
     def __init__(self):
         super().__init__()
-        self.ap_shell_prompt = r'^Proceed with reload (command (\W+cold\W)?)?(\?) (\[)+confirm+(\])$'
-        
+        self.ap_shell_prompt = r'^Proceed with reload (command (\W+cold\W)?)?(\?) (\[)+confirm+(\])$'

src/unicon/plugins/cheetah/ap/service_statement.py

@@ -1,10 +1,8 @@
 """
 Module:
     unicon.plugins.generic
-
 Authors:
     pyATS TEAM ([email protected], [email protected])
-
 Description:
     Module for defining all Services Statement, handlers(callback) and Statement
     list for service dialog would be defined here.
@@ -34,5 +32,4 @@ def send_response(spawn, response=""):
                             continue_timer=False)
 
 ap_reload_list = list(reload_statement_list)
-ap_reload_list.insert(0,ap_shell_prompt)
-
+ap_reload_list.insert(0,ap_shell_prompt)