Merge pull request #93 from CiscoTestAutomation/release_23.11

domachad · web-flow · commit d9d4036b148d · 2023-11-29T08:21:45.000-05:00
Releasing 23.11
diff --git a/docs/changelog/2023/november.rst b/docs/changelog/2023/november.rst
@@ -0,0 +1,50 @@
+November 2023
+==========
+
+November 27 - Unicon v23.11
+------------------------
+
+
+
+.. csv-table:: Module Versions
+    :header: "Modules", "Versions"
+
+        ``unicon.plugins``, v23.11
+        ``unicon``, v23.11
+
+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
+    * Modified test_init_commands
+        * Added SONiC as a valid OS
+
+* pluginmanager
+    * Modified get_plugin method to allow missing keys in lookup
+
+
diff --git a/docs/changelog/2023/october.rst b/docs/changelog/2023/october.rst
@@ -1,8 +1,8 @@
 October 2023
-==========
+============
 
 October 31 - Unicon v23.10
-------------------------
+--------------------------
 
 
 
diff --git a/docs/changelog/2023/september.rst b/docs/changelog/2023/september.rst
@@ -1,8 +1,8 @@
 September 2023
-==========
+==============
 
 September 26 - Unicon v23.9 
-------------------------
+---------------------------
 
 
 
diff --git a/docs/changelog/index.rst b/docs/changelog/index.rst
@@ -4,6 +4,7 @@ Changelog
 .. toctree::
    :maxdepth: 2
 
+   2023/november
    2023/october
    2023/september
    2023/august
@@ -26,6 +27,7 @@ Changelog
    2022/february
    2022/january
    2021/december
+   2021/october
    2021/september
    2021/august
    2021/july
diff --git a/docs/changelog_plugins/2023/april.rst b/docs/changelog_plugins/2023/april.rst
@@ -2,7 +2,7 @@ April 2023
 ==========
 
 April 25 - Unicon.Plugins v23.4 
-------------------------
+-------------------------------
 
 
 
diff --git a/docs/changelog_plugins/2023/august.rst b/docs/changelog_plugins/2023/august.rst
@@ -1,8 +1,8 @@
 August 2023
-==========
+===========
 
 August 29 - Unicon.Plugins v23.8
-------------------------
+--------------------------------
 
 
 
diff --git a/docs/changelog_plugins/2023/february.rst b/docs/changelog_plugins/2023/february.rst
@@ -1,8 +1,8 @@
 February 2023
-==========
+=============
 
 February 24 - Unicon.Plugins v23.2 
-------------------------
+----------------------------------
 
 
 
diff --git a/docs/changelog_plugins/2023/january.rst b/docs/changelog_plugins/2023/january.rst
@@ -1,8 +1,8 @@
 January 2023
-==========
+============
 
 January 31 - Unicon v23.1 
-------------------------
+-------------------------
 
 
 
diff --git a/docs/changelog_plugins/2023/july.rst b/docs/changelog_plugins/2023/july.rst
@@ -1,8 +1,8 @@
 July 2023
-==========
+=========
 
 July 24 - Unicon.Plugins v23.7
-------------------------
+------------------------------
 
 
 
diff --git a/docs/changelog_plugins/2023/june.rst b/docs/changelog_plugins/2023/june.rst
@@ -2,7 +2,7 @@ June 2023
 ==========
 
 June 27 - Unicon.Plugins v23.6 
-------------------------
+------------------------------
 
 
 
diff --git a/docs/changelog_plugins/2023/march.rst b/docs/changelog_plugins/2023/march.rst
@@ -2,7 +2,7 @@ March 2023
 ==========
 
 March 28 - Unicon.Plugins v23.3
-------------------------
+-------------------------------
 
 
 
diff --git a/docs/changelog_plugins/2023/may.rst b/docs/changelog_plugins/2023/may.rst
@@ -2,7 +2,7 @@ May 2023
 ==========
 
 May 30 - Unicon.Plugins v23.5 
-------------------------
+-----------------------------
 
 
 
diff --git a/docs/changelog_plugins/2023/november.rst b/docs/changelog_plugins/2023/november.rst
@@ -0,0 +1,54 @@
+November 2023
+==========
+
+November 27 - Unicon.Plugins v23.11
+------------------------
+
+
+
+.. csv-table:: Module Versions
+    :header: "Modules", "Versions"
+
+        ``unicon.plugins``, v23.11
+        ``unicon``, v23.11
+
+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
+^^^^^^^^^^
+--------------------------------------------------------------------------------
+                                      New                                       
+--------------------------------------------------------------------------------
+
+* sonic
+    * Add connection class for SONiC that inherits from Linux
+
+
+--------------------------------------------------------------------------------
+                                      Fix                                       
+--------------------------------------------------------------------------------
+
+* generic
+    * Update logic for switchover service to detect standby state
+
+
diff --git a/docs/changelog_plugins/2023/october.rst b/docs/changelog_plugins/2023/october.rst
@@ -1,8 +1,8 @@
 October 2023
-==========
+============
 
 October 31 - Unicon.Plugins v23.10
-------------------------
+----------------------------------
 
 
 
diff --git a/docs/changelog_plugins/2023/september.rst b/docs/changelog_plugins/2023/september.rst
@@ -1,8 +1,8 @@
 September 2023
-==========
+==============
 
 September 26 - Unicon.Plugins v23.9 
-------------------------
+-----------------------------------
 
 
 
diff --git a/docs/changelog_plugins/index.rst b/docs/changelog_plugins/index.rst
@@ -4,6 +4,7 @@ Plugins Changelog
 .. toctree::
    :maxdepth: 2
 
+   2023/november
    2023/october
    2023/september
    2023/august
@@ -26,6 +27,7 @@ Plugins Changelog
    2022/february
    2022/january
    2021/december
+   2021/october
    2021/september
    2021/august
    2021/july
diff --git a/docs/user_guide/passwords.rst b/docs/user_guide/passwords.rst
@@ -290,14 +290,13 @@ The following command connects to the router and enters enable mode using
     device.connect()
 
 How enable password is chosen
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+-----------------------------
 
 When a router asks for an enable password, the password sent is determined
 by the following checks.  If all checks are done and still no enable password
 is found then an exception is raised.
 
-#. The ``enable_password`` field of the credential specified by the
-   ``login_creds`` in the connect call.
+#. The ``enable_password`` field of the credential specified by the ``login_creds`` in the connect call.
 #. The ``default`` credential ``enable_password``
 #. The ``enable`` credential ``password`` (legacy)
 #. The ``default`` credential ``password`` (legacy)
diff --git a/docs/user_guide/services/generic_services.rst b/docs/user_guide/services/generic_services.rst
@@ -664,9 +664,9 @@ due to console messages over terminal and this results in reload timeout.
 In such a case `prompt_recovery` can be used to recover the device.
 Refer :ref:`prompt_recovery_label` for details on prompt_recovery feature.
 
-====================      =======================      ================================================================================
+=====================     =======================      ====================================================================================
 Argument                  Type                         Description
-====================      =======================      ================================================================================
+=====================     =======================      ====================================================================================
 reload_command            str                          reload command to be issued on device.
                                                        default reload_command is "reload"
 reply                     Dialog                       additional dialogs/new dialogs which are not handled by default.
@@ -678,9 +678,9 @@ return_output             bool (default False)         Return namedtuple with re
 image_to_boot             str                          Image to boot from rommon. Available for iosxe/cat3k and iosxe/cat9k
 error_pattern             list                         List of regex strings to check output for errors.
 append_error_pattern      list                         List of regex strings append to error_pattern.
-post_reload_wait_time     int (default 60)             Number of seconds to wait after reload, before reconnecting, 
+post_reload_wait_time     int (default 60)             Number of seconds to wait after reload, before reconnecting,
                                                        Default Value is 60 sec
-====================      =======================      ================================================================================
+=====================     =======================      ====================================================================================
 
     return :
         * True on Success
diff --git a/docs/user_guide/services/linux.rst b/docs/user_guide/services/linux.rst
@@ -398,7 +398,7 @@ Example with device.sudo().
 
 Example with sudo command argument.
 
-.. code-block:: python
+.. code-block::
 
       In [5]: dev.sudo('ls')
 
diff --git a/docs/user_guide/supported_platforms.rst b/docs/user_guide/supported_platforms.rst
@@ -95,7 +95,7 @@ the iosxe table, it will fallback to use the generic ``iosxe`` plugin. If
     ``eos``
     ``sros``
     ``viptela``,,,"Identical to os=sdwan, platform=viptela."
-    ``windows``
+    ``windows``,,,"Only command shell (cmd) is supported. Powershell is not supported"
 
 To use this table - locate your device's os/platform/model information, and fill
 your pyATS testbed YAML with it:
diff --git a/src/unicon/plugins/__init__.py b/src/unicon/plugins/__init__.py
@@ -1,4 +1,4 @@
-__version__ = '23.10'
+__version__ = '23.11'
 
 supported_chassis = [
     'single_rp',
@@ -8,37 +8,38 @@
 ]
 
 supported_os = [
-    'generic',
-    'ios',
-    'nxos',
-    'iosxe',
-    'iosxr',
+    'aci',
     'aireos',
-    'linux',
-    'cheetah',
-    'ise',
+    'apic',
     'asa',
-    'nso',
-    'confd',
-    'vos',
+    'cheetah',
     'cimc',
-    'fxos',
-    'junos',
-    'staros',
-    'aci',
-    'sdwan',
-    'sros',
-    'apic',
-    'windows',
     'comware',
-    'ironware',
+    'confd',
+    'dnos6',
+    'dnos10',
     'eos',
+    'fxos',
     'gaia',
+    'generic',
     'hvrp',
-    'slxos',
+    'ios',
+    'iosxe',
+    'iosxr',
+    'ironware',
+    'ise',
+    'junos',
+    'linux',
     'nd',
-    'viptela',
-    'dnos6',
-    'dnos10',
+    'nso',
+    'nxos',
     'ons',
+    'sdwan',
+    'slxos',
+    'sonic',
+    'sros',
+    'staros',
+    'viptela',
+    'vos',
+    'windows'
 ]
diff --git a/src/unicon/plugins/generic/service_implementation.py b/src/unicon/plugins/generic/service_implementation.py
diff --git a/src/unicon/plugins/sonic/__init__.py b/src/unicon/plugins/sonic/__init__.py
diff --git a/src/unicon/plugins/sonic/settings.py b/src/unicon/plugins/sonic/settings.py
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_sonic.py b/src/unicon/plugins/tests/test_plugin_sonic.py
