Releasing v23.10

bastell · bastell · commit ee65274fb6ec · 2023-11-01T17:22:50.000-04:00
diff --git a/docs/changelog/2023/october.rst b/docs/changelog/2023/october.rst
@@ -0,0 +1,77 @@
+October 2023
+==========
+
+October 31 - Unicon v23.10
+------------------------
+
+
+
+.. csv-table:: Module Versions
+    :header: "Modules", "Versions"
+
+        ``unicon.plugins``, v23.10
+        ``unicon``, v23.10
+
+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                                       
+--------------------------------------------------------------------------------
+
+* unicon.eal.backend
+    * Added telnetlib backend.
+    * Set `<connection_object>.settings.BACKEND = "auto"` to use the new telnetlib backend.
+
+* unicon.mock
+    * Update mock_device_cli to work with telnetlib backend
+
+* unicon.bases.connection
+    * learn_hostname
+        * skip hostname learning if the device is in bash shell.
+
+* unicon.bases.routers
+    * Modified BaseSingleRpConnectionProvider
+        * Updated establish_connection method to update cred_list in context if login_creds is not None
+
+
+--------------------------------------------------------------------------------
+                                      New                                       
+--------------------------------------------------------------------------------
+
+* unicon.adapters
+    * updated topology
+        * add fallback credentials to the context for each connection.
+        * Update pattern for invalid password.
+
+
+--------------------------------------------------------------------------------
+                                      Fix                                       
+--------------------------------------------------------------------------------
+
+* cheetah
+    * ap
+        * Added support for device reload.
+
+
diff --git a/docs/changelog/index.rst b/docs/changelog/index.rst
@@ -4,6 +4,7 @@ Changelog
 .. toctree::
    :maxdepth: 2
 
+   2023/october
    2023/september
    2023/august
    2023/july
diff --git a/docs/changelog_plugins/2023/october.rst b/docs/changelog_plugins/2023/october.rst
@@ -0,0 +1,64 @@
+October 2023
+==========
+
+October 31 - Unicon.Plugins v23.10
+------------------------
+
+
+
+.. csv-table:: Module Versions
+    :header: "Modules", "Versions"
+
+        ``unicon.plugins``, v23.10
+        ``unicon``, v23.10
+
+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
+    * Empty sendline to get the prompt for go_to any state
+
+* iosxe/cat9k
+    * Updated container ssh prompt pattern
+
+* nxos
+    * Modified
+        * Added alt_cred password lab2 in nxos_mock_data_n5k.yaml
+
+
+--------------------------------------------------------------------------------
+                                      New                                       
+--------------------------------------------------------------------------------
+
+* generic
+    * Adding fallback credentials for handling authentication failure.
+
+* iosxe
+    * Adding new password statement for setting up the password on the device after the device has booted in controller mode.
+
+
diff --git a/docs/changelog_plugins/index.rst b/docs/changelog_plugins/index.rst
@@ -4,6 +4,7 @@ Plugins Changelog
 .. toctree::
    :maxdepth: 2
 
+   2023/october
    2023/september
    2023/august
    2023/july
diff --git a/src/unicon/plugins/__init__.py b/src/unicon/plugins/__init__.py
@@ -1,4 +1,4 @@
-__version__ = '23.9'
+__version__ = '23.10'
 
 supported_chassis = [
     'single_rp',
diff --git a/src/unicon/plugins/cheetah/ap/__init__.py b/src/unicon/plugins/cheetah/ap/__init__.py
@@ -19,7 +19,7 @@ def __init__(self):
         self.expect = gsvc.Expect
         self.enable = gsvc.Enable
         self.disable = gsvc.Disable
-        self.reload = gsvc.Reload
+        self.reload = svc.Reload
         self.log_user = gsvc.LogUser
         self.bash_console = iosxe_svc.BashService
 
diff --git a/src/unicon/plugins/cheetah/ap/service_implementation.py b/src/unicon/plugins/cheetah/ap/service_implementation.py
@@ -3,9 +3,12 @@
 
 from unicon.plugins.generic.service_implementation import \
     Execute as GenericExecute
+from unicon.plugins.generic.service_implementation import \
+    Reload as GenericReload
 from unicon.eal.dialogs import Dialog
 from unicon.plugins.iosxe.service_statements import confirm
 
+from .service_statement import ap_reload_list
 
 class Execute(GenericExecute):
     def call_service(self, command=None, reply=Dialog([]), timeout=None, *args,
@@ -14,3 +17,8 @@ def call_service(self, command=None, reply=Dialog([]), timeout=None, *args,
         super().call_service(command,
                              reply=reply + Dialog([confirm,]),
                              timeout=timeout, *args, **kwargs)
+        
+class Reload(GenericReload):
+    def __init__(self, connection, context, **kwargs):
+        super().__init__(connection, context, **kwargs)
+        self.dialog = self.dialog + Dialog(ap_reload_list)
diff --git a/src/unicon/plugins/cheetah/ap/service_patterns.py b/src/unicon/plugins/cheetah/ap/service_patterns.py
@@ -0,0 +1,9 @@
+"""AP Reload Service Patterns"""
+
+from unicon.plugins.generic.service_patterns import ReloadPatterns
+
+class APReloadPatterns(ReloadPatterns):
+    def __init__(self):
+        super().__init__()
+        self.ap_shell_prompt = r'^Proceed with reload (command (\W+cold\W)?)?(\?) (\[)+confirm+(\])$'
+        
diff --git a/src/unicon/plugins/cheetah/ap/service_statement.py b/src/unicon/plugins/cheetah/ap/service_statement.py
@@ -0,0 +1,38 @@
+"""
+Module:
+    unicon.plugins.generic
+
+Authors:
+    pyATS TEAM (pyats-support@cisco.com, pyats-support-ext@cisco.com)
+
+Description:
+    Module for defining all Services Statement, handlers(callback) and Statement
+    list for service dialog would be defined here.
+"""
+
+from time import sleep
+
+from unicon.eal.dialogs import Statement
+from unicon.plugins.generic.statements import  chatty_term_wait
+from .service_patterns import APReloadPatterns
+from unicon.plugins.generic.service_statements import reload_statement_list
+
+pat = APReloadPatterns()
+
+
+def send_response(spawn, response=""):
+    chatty_term_wait(spawn)
+    spawn.sendline(response)
+
+# ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++#
+# Reload  Statements
+# ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++#
+
+ap_shell_prompt = Statement(pattern=pat.ap_shell_prompt,
+                            action=send_response, args={'response': '\r'},
+                            loop_continue=True,
+                            continue_timer=False)
+
+ap_reload_list = list(reload_statement_list)
+ap_reload_list.insert(0,ap_shell_prompt)
+
diff --git a/src/unicon/plugins/generic/patterns.py b/src/unicon/plugins/generic/patterns.py
@@ -83,3 +83,5 @@ def __init__(self):
 
         # VT100 patterns
         self.get_cursor_position = r'\x1b\[6n'
+
+        self.new_password = r'^(Enter new password|Confirm password):\s*$'
diff --git a/src/unicon/plugins/generic/service_implementation.py b/src/unicon/plugins/generic/service_implementation.py
@@ -1200,7 +1200,7 @@ def call_service(self,
                 if (current_time - start_time) > timeout_time:
                     con.log.info('Time out, trying to acces device..')
                     break
-
+            con.sendline()
         try:
             con.context = context
             con.connection_provider.connect()
diff --git a/src/unicon/plugins/generic/statements.py b/src/unicon/plugins/generic/statements.py
@@ -15,12 +15,14 @@
 from unicon.eal.dialogs import Statement
 from unicon.eal.helpers import sendline
 from unicon.core.errors import UniconAuthenticationError
+from unicon.core.errors import CredentialsExhaustedError
 from unicon.core.errors import ConnectionError as UniconConnectionError
 from unicon.utils import Utils
 
 from unicon.plugins.generic.patterns import GenericPatterns
 from unicon.plugins.utils import (
     get_current_credential,
+    _get_creds_to_try,
     common_cred_username_handler,
     common_cred_password_handler,
 )
@@ -282,6 +284,55 @@ def enable_password_handler(spawn, context, session):
     else:
         spawn.sendline(context['enable_password'])
 
+def set_new_password(spawn, context, session):
+    '''setting up the new password on the device.
+
+        For setting up the password we need to do these 2 steps
+        to make sure we don't get CredentialsExhaustedError:
+            1- remove the current_credential(this is the last credential used for login into device)
+               from session.
+            2- remove the cred_iter(an iterable of login credentials) from session.
+        after removing these 2 we reset credentials and we could use the default password from the default credentials
+        for setting up the password on the device.
+    '''
+    # remove the current credential from session
+    if session.get('current_credential'):
+        session.pop('current_credential')
+    # remove the cred_iter from session
+    if session.get('cred_iter'):
+        session.pop('cred_iter')
+    # calling the password handler for sending the passowrd.
+    password_handler(spawn, context, session )
+
+
+def enable_secret_handler(spawn, context, session):
+    if 'password_attempts' not in session:
+        session['password_attempts'] = 1
+    else:
+        session['password_attempts'] += 1
+    if session.password_attempts > spawn.settings.PASSWORD_ATTEMPTS:
+        raise UniconAuthenticationError('Too many enable password retries')
+
+    enable_credential_password = get_enable_credential_password(context=context)
+    if enable_credential_password and len(enable_credential_password) >= \
+            spawn.settings.ENABLE_SECRET_MIN_LENGTH:
+        spawn.sendline(enable_credential_password)
+    else:
+        spawn.log.warning('Using enable secret from TEMP_ENABLE_SECRET setting')
+        enable_secret = spawn.settings.TEMP_ENABLE_SECRET
+        context['setup_selection'] = 0
+        spawn.sendline(enable_secret)
+
+
+def setup_enter_selection(spawn, context):
+    selection = context.get('setup_selection')
+    if selection is not None:
+        if str(selection) == '0':
+            spawn.log.warning('Not saving setup configuration')
+        spawn.sendline(f'{selection}')
+    else:
+        spawn.sendline('2')
+
 
 def enable_secret_handler(spawn, context, session):
     if 'password_attempts' not in session:
@@ -369,10 +420,28 @@ def passphrase_handler(spawn, context, session):
                                         "for credential {}.".format(credential))
 
 
-def bad_password_handler(spawn):
+def bad_password_handler(spawn, context, session):
     """ handles bad password prompt
     """
-    raise UniconAuthenticationError('Bad Password sent to device %s' % (str(spawn),))
+    # check if there is a fallback credential
+    if context['fallback_creds']:
+        spawn.log.info('Using fallback credentials for logging in to the device!')
+        # Update the session with fallback credentials
+        if not session.get('fallback_creds'):
+            session['fallback_creds'] = iter(context['fallback_creds'])
+            # this list keep track of the fallback credentials being used
+            session['cred_list'] = []
+        try:
+            # update the current credential with the next fallback credential
+            session['current_credential'] = next(session['fallback_creds'])
+            spawn.log.info(f"Using {session['current_credential']} from fallback credential list.")
+            # update the list of fallback credentials
+            session['cred_list'].append(session['current_credential'])
+        except StopIteration:
+            raise CredentialsExhaustedError(
+                creds_tried= _get_creds_to_try(context) + (session['cred_list']))
+    else:
+        raise UniconAuthenticationError('Bad Password sent to device %s' % (str(spawn),))
 
 
 def incorrect_login_handler(spawn, context, session):
@@ -527,7 +596,7 @@ def __init__(self):
         self.bad_password_stmt = Statement(pattern=pat.bad_passwords,
                                            action=bad_password_handler,
                                            args=None,
-                                           loop_continue=False,
+                                           loop_continue=True,
                                            continue_timer=False)
 
         self.login_incorrect = Statement(pattern=pat.login_incorrect,
@@ -556,6 +625,11 @@ def __init__(self):
                                        args=None,
                                        loop_continue=True,
                                        continue_timer=False)
+        self.new_password_stmt = Statement(pattern=pat.new_password,
+                                           action=set_new_password,
+                                           args=None,
+                                           loop_continue=True,
+                                           continue_timer=False)
         self.enable_password_stmt = Statement(pattern=pat.password,
                                               action=enable_password_handler,
                                               args=None,
@@ -715,6 +789,7 @@ def __init__(self):
                                  generic_statements.login_incorrect,
                                  generic_statements.login_stmt,
                                  generic_statements.useraccess_stmt,
+                                 generic_statements.new_password_stmt,
                                  generic_statements.password_stmt,
                                  generic_statements.clear_kerberos_no_realm,
                                  generic_statements.password_ok_stmt,
diff --git a/src/unicon/plugins/iosxe/cat9k/patterns.py b/src/unicon/plugins/iosxe/cat9k/patterns.py
@@ -8,4 +8,4 @@ def __init__(self):
         super().__init__()
         self.boot_interrupt_prompt = r'Preparing to autoboot. \[Press Ctrl-C to interrupt\]'
         self.container_shell_prompt = r'^(.*?)\n(/(\S+)?)+\s+#\s*$'
-        self.container_ssh_prompt = r'^(.*?)(\w+-){6,}.*?[\$#]\s*$'
+        self.container_ssh_prompt = r'^(.*?)(\w\w-){6,}.*?[\$#]\s*$'
diff --git a/src/unicon/plugins/tests/mock_data/cheetah/cheetah_mock_data.yaml b/src/unicon/plugins/tests/mock_data/cheetah/cheetah_mock_data.yaml
diff --git a/src/unicon/plugins/tests/mock_data/cheetah/cheetah_reload.txt b/src/unicon/plugins/tests/mock_data/cheetah/cheetah_reload.txt
diff --git a/src/unicon/plugins/tests/mock_data/iosxe/iosxe_mock_cat9k.yaml b/src/unicon/plugins/tests/mock_data/iosxe/iosxe_mock_cat9k.yaml
diff --git a/src/unicon/plugins/tests/mock_data/nxos/nxos_mock_data_n5k.yaml b/src/unicon/plugins/tests/mock_data/nxos/nxos_mock_data_n5k.yaml
diff --git a/src/unicon/plugins/tests/test_plugin_cheetah_ap.py b/src/unicon/plugins/tests/test_plugin_cheetah_ap.py
diff --git a/src/unicon/plugins/tests/test_plugin_iosxe_cat9k.py b/src/unicon/plugins/tests/test_plugin_iosxe_cat9k.py

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