arista-eosplus · dlyssenko · Jun 6, 2023 · Aug 7, 2018 · Oct 25, 2019 · Jan 27, 2020
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,33 @@
+---
+name: CI
+on: [ pull_request, workflow_dispatch ]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.7', '3.8', '3.9', '3.10']
+      fail-fast: false
+    name: Test on Python ${{ matrix.python-version }}
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install wheel
+        run: pip install wheel
+      - name: Install dev requirements
+        run: pip install -r dev-requirements.txt
+      - name: Upgrade flake8
+        run: pip install --upgrade flake8
+      - name: Clean
+        run: make clean
+      - name: pep8
+        run: make pep8
+      - name: flake8
+        run: make flake8
+      - name: check
+        run: make check
+      - name: unittest
+        run: make unittest
diff --git a/.travis.yml b/.travis.yml
diff --git a/Makefile b/Makefile
@@ -31,14 +31,14 @@ VERSION := $(shell cat VERSION)
 all: clean check pep8 flake8 tests
 
 pep8:
-	pycodestyle -r --ignore=E402,E731,E501,E221,W291,W391,E302,E251,E203,W293,E231,E303,E201,E225,E261,E241 pyeapi/ test/
+	pycodestyle -r --ignore=E402,E731,E501,E221,W291,W391,E302,E251,E203,W293,E231,E303,E201,E202,E225,E261,E241,E128 pyeapi/ test/
 
 pyflakes:
 	pyflakes pyeapi/ test/
 
 flake8:
-	flake8 --ignore=E302,E303,E402,E731,W391 --exit-zero pyeapi/
-	flake8 --ignore=E302,E303,E402,E731,W391,N802 --max-line-length=100 test/
+	flake8 --ignore=E128,E201,E202,E302,E303,E402,E731,W391 --exit-zero pyeapi/
+	flake8 --ignore=E128,E201,E202,E302,E303,E402,E731,W391,N802 --max-line-length=100 test/
 
 check:
 	check-manifest

diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-0.8.3
+1.0.0
diff --git a/dev-requirements.txt b/dev-requirements.txt
@@ -9,5 +9,7 @@ coverage
 sphinx
 sphinxcontrib-napoleon
 flake8
-flake8-print
-flake8-debugger
+#commenting below 2 lines until switchover to python3 is complete
+#flake8-print
+#flake8-debugger
+sphinx_rtd_theme
diff --git a/docs/Makefile b/docs/Makefile
@@ -8,7 +8,7 @@ PAPER         =
 BUILDDIR      = _build
 APIDIR   	    = api_modules
 CLIENTDIR     = client_modules
-CWD						:= $(shell pwd)
+CWD						:= '$(shell pwd)'
 
 # User-friendly check for sphinx-build
 ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)

diff --git a/docs/conf.py b/docs/conf.py
@@ -20,7 +20,7 @@
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-sys.path.insert(0, '../pyeapi')
+sys.path.insert(0, os.path.abspath('..') )
 
 # -- General configuration ------------------------------------------------
 
@@ -35,7 +35,7 @@
     'sphinx.ext.coverage',
     'sphinx.ext.viewcode',
     'sphinx.ext.doctest',
-    'sphinxcontrib.napoleon'
+    'sphinx.ext.napoleon'
 ]
 
 # Add any paths that contain templates here, relative to this directory.

diff --git a/docs/configfile.rst b/docs/configfile.rst
@@ -119,6 +119,16 @@ As the table above indicates, a pyeapi configuration file is required in
   [connection:localhost]
   transport: http_local
 
+Pay attention: once ``eapi.conf`` exists, the respective protocol method must be
+configured on the box. E.g., for the above ``eapi.conf`` sample, the following
+configuration must also exist:
+
+.. code-block:: console
+
+  switch(config)#management http-server
+  switch(config-mgmt-http-server)#protocol http localhost
+
+
 Using HTTP or HTTPS
 ===================
 
@@ -172,6 +182,11 @@ As the table above indicates, a pyeapi configuration file is required in
   username: admin
   password: admin
 
+.. Note:: avoid using ``localhost`` name in the connection description (i.e.: ``[connection:localhost]``). 
+          The name ``localhost`` is reserved solely for ``on-box`` connection method and it won't work when
+          connecting ``off-box``
+
+
 Using HTTPS with Certificates
 =============================
 

diff --git a/docs/configsessions.rst b/docs/configsessions.rst
@@ -0,0 +1,52 @@
+Using Config Sessions via Python Client for eAPI
+=======================================================
+
+Config Sessions can be used via Pyeapi. Config sessions allow a block of config
+to be added as one operation instead of as individual lines. Configurations applied
+in this manner allow the user to abort all the config being applied if an error occurs.
+
+Using Config Sessions:
+
+.. code-block:: python
+
+  import pyeapi
+  node = pyeapi.connect_to('veos01')
+  vlans = node.api('vlans')
+
+  node.configure_session()
+
+  node.diff()  # Sends "configure session 9c27d0e8-afef-4afd-95ae-3e3200bb7a3e" and "show session-config diff"
+
+  """
+  =>
+  --- system:/running-config
+  +++ session:/9c27d0e8-afef-4afd-95ae-3e3200bb7a3e-session-config
+  @@ -32,7 +32,7 @@
+   !
+   clock timezone Asia/Tokyo
+   !
+  -vlan 1000,3001-3006
+  +vlan 100,1000,3001-3006
+   !
+   interface Port-Channel1
+      switchport trunk allowed vlan 3001-3003
+  """
+
+  node.abort()  # Sends "configure session 9c27d0e8-afef-4afd-95ae-3e3200bb7a3e" and "abort"
+  # or
+  node.commit() # Sends "configure session 9c27d0e8-afef-4afd-95ae-3e3200bb7a3e" and "commit"
+
+Config Session with invalid config line:
+
+.. code-block:: python
+
+  node = pyeapi.connect_to('veos01')
+  interfaces = node.api('interfaces')
+  node.configure_session()
+
+  if not (interfaces.configure(['interface Eth6', 'no switchport', 'ip address 172.16.0.1/30']) and \
+      interfaces.configure(['interface Eth7', 'no switchport', 'ip address 172.16.0.1/30'])):
+      node.abort()  # This aborts everything!!
+
+For more detailed information about using Configure Sessions in EOS, reference the user
+manual for the version of EOS running on your switch.
diff --git a/docs/generate_modules.py b/docs/generate_modules.py
@@ -1,4 +1,4 @@
-#!/usr/bin/python
+#!/usr/bin/python3
 
 from os import listdir, path, makedirs
 from os.path import isfile, join, exists
@@ -22,7 +22,7 @@ def get_module_names(p):
     mods = list()
     mods = [f.split('.')[0] for f in listdir(p)
             if isfile(join(p, f)) and not f.endswith('.pyc') and not f.startswith('__')]
-    print len(mods)
+    print( len(mods) )
     return mods
 
 def process_modules(modules):

diff --git a/docs/release-notes-0.8.4.rst b/docs/release-notes-0.8.4.rst
@@ -0,0 +1,23 @@
+Release 0.8.4
+-------------
+
+2020-11-13
+
+New Modules
+^^^^^^^^^^^
+
+
+Enhancements
+^^^^^^^^^^^^
+
+* Add streaming capability for eapi interface
+
+* Add Power ppc64le support with CI
+
+Fixed
+^^^^^
+
+Known Caveats
+^^^^^^^^^^^^^
+
+
diff --git a/docs/release-notes-1.0.0.rst b/docs/release-notes-1.0.0.rst
@@ -0,0 +1,64 @@
+Release 1.0.0
+-------------
+
+2023-06-06
+
+- This is a Python3 (3.7 onwards) release only (Python2 is no longer supported)
+- Arista EOS 4.22 or later required
+
+New Modules
+^^^^^^^^^^^
+
+Enhancements
+^^^^^^^^^^^^
+
+Fixed
+^^^^^
+
+* Let ``config`` method to raise ``ConnectionError`` exception (`198 <https://github.com/arista-eosplus/pyeapi/issues/198>`_)
+    The fix ensures that the behavior is consistent with other methods.
+* Fixed parsing of VLAN groupings by ``vlans.getall()`` (`200 <https://github.com/arista-eosplus/pyeapi/pull/200>`_)
+    The fix allows handling a case when multiple VLANs in the configs may be grouped under a common (group) name.
+* Enhanced ``vlans.get()`` to return an actual list of VLANs (`202 <https://github.com/arista-eosplus/pyeapi/pull/202>`_)
+    The method used to return the argument itself (e.g., an RE: ``200-.*``), now the actual list of matched VLANs is returned
+* Fixed a corner crash in ``portsVlans.getall()``  (`213 <https://github.com/arista-eosplus/pyeapi/issues/213>`_)
+    The crash may occur when the switchport is configured with a VLAN profile 
+* Improved ``switchports.getall()`` behavior (`216 <https://github.com/arista-eosplus/pyeapi/pull/216>`_)
+    The method will not consider subinterfaces anymore
+* Improved JSON parsing speed (`166 <https://github.com/arista-eosplus/pyeapi/pull/166>`_)
+    User may improve the speed by using ``ujson`` or ``rapidjson`` modules. The standard ``json`` is used as a fallback.
+* Allow user to specify an SSL context (`234 <https://github.com/arista-eosplus/pyeapi/issues/234>`_)
+    Provided the argument option ``context`` to specify an SSL context in ``connection()`` method.
+* Fixed user password vulnerability in tracebacks (`238 <https://github.com/arista-eosplus/pyeapi/pull/238>`_)
+    A user password is exposed in a traceback, which could occur due to invalid credentials.
+* Added support for login password exclusively for ssh-key authentication (`227 <https://github.com/arista-eosplus/pyeapi/pull/227>`_)
+    Catching up with EOS CLI which already supports such login password.
+* Fixed user password vulnerability in debugs (`242 <https://github.com/arista-eosplus/pyeapi/pull/242>`_)
+    A user password was exposed in user enabled debugs. With this commit the user password is masked out now.
+* Added option not to include config defaults (`221 <https://github.com/arista-eosplus/pyeapi/pull/221>`_)
+    Reading running-config or startup-config with default values is not always a desirable behavior. This commit adds an option to control such behavior.
+* Fixed a corner crash in ``ipinterfaces`` module (`210 <https://github.com/arista-eosplus/pyeapi/issues/210>`_)
+    Fixed a crash when MTU value is not present in the interface configuration (this is rather a corner case condition).
+* Fixed a bug where vxlan floodlist might return a bogus data (`193 <https://github.com/arista-eosplus/pyeapi/issues/193>`_)
+    Fixed the issue with ``interfaces`` module, where ``get()`` method returned vxlan data structure with ``flood_list`` parsed incorrectly.  
+* Improved performance of config parsing (`220 <https://github.com/arista-eosplus/pyeapi/pull/220>`_)
+    Drastically improved perfromance of config parsing by cacheing section splitting results. This fix also tightens the prior relaxed section match behavior by allowing matching only section line (as vs entire section's content)     
+* Enhanced PR (`220 <https://github.com/arista-eosplus/pyeapi/pull/220>`_) allowing to match sub-sections (`245 <https://github.com/arista-eosplus/pyeapi/pull/245>`_)
+    After PR #220, matching subsections was impossible (only entire section could have been matched). This enhancement brings back such functionality.     
+* Added support for a session based authentication (`203 <https://github.com/arista-eosplus/pyeapi/pull/203>`_)
+    Added a couple new transport options (``http_session`` and ``https_session``) to ``connect()`` method to support a session based authentication.     
+* Added support infrastructure to handle deprecated EOS CLI (`247 <https://github.com/arista-eosplus/pyeapi/pull/247>`_)
+    The added ``CliVariants`` class helps managing transitions from deprecated EOS CLI (by allowing specifying both, new and deprecated CLI variants).
+* Added support for parsing secondary ip addresses (`251 <https://github.com/arista-eosplus/pyeapi/pull/251>`_)
+    The added fix extends the return result for ``get()`` method of ``ipinterfaces`` module with the parsed secondary ip addresses (if present).
+* A minor fix to include internal exception handling (`252 <https://github.com/arista-eosplus/pyeapi/pull/252>`_)
+    With this fix the ``pyeapi.eapilib.CommandError`` exception will elaborate on the causes of internal errors.
+* Enhance parsing of BGP router section with ``asdot`` notation (`256 <https://github.com/arista-eosplus/pyeapi/pull/256>`_)
+    Allow matching and parsing ``router bgp`` sections if spelled with ``asdot`` notation.
+* removed and updated deprecations (`204 <https://github.com/arista-eosplus/pyeapi/pull/204>`_, `212 <https://github.com/arista-eosplus/pyeapi/pull/212>`_, `235 <https://github.com/arista-eosplus/pyeapi/pull/235>`_, `260 <https://github.com/arista-eosplus/pyeapi/pull/260>`_, `262 <https://github.com/arista-eosplus/pyeapi/pull/262>`_, `263 <https://github.com/arista-eosplus/pyeapi/pull/263>`_)
+* documentation fixes and updates (`209 <https://github.com/arista-eosplus/pyeapi/pull/209>`_, `225 <https://github.com/arista-eosplus/pyeapi/pull/225>`_, `239 <https://github.com/arista-eosplus/pyeapi/pull/239>`_, `257 <https://github.com/arista-eosplus/pyeapi/pull/257>`_, `259 <https://github.com/arista-eosplus/pyeapi/pull/259>`_)
+
+Known Caveats
+^^^^^^^^^^^^^
+
+
diff --git a/docs/release-notes.rst b/docs/release-notes.rst
@@ -6,6 +6,9 @@ Release Notes
     :maxdepth: 2
     :titlesonly:
 
+    release-notes-1.0.0.rst
+    release-notes-0.8.4.rst
+    release-notes-0.8.3.rst
     release-notes-0.8.2.rst
     release-notes-0.8.1.rst
     release-notes-0.8.0.rst

diff --git a/docs/requirements.rst b/docs/requirements.rst
@@ -2,10 +2,10 @@
 Requirements
 ############
 
-* Arista EOS 4.12 or later
+* Arista EOS 4.22 or later
 * Arista eAPI enabled for at least one transport (see Official EOS Config Guide
   at arista.com for details)
-* Python 2.7 or 3.4+ (Python 3 support is work in progress)
+* Python 3.7+
 * Pyeapi requires the netaddr Python module
 
 .. Note:: netaddr gets installed automatically if you use pip to install pyeapi
diff --git a/pyeapi/__init__.py b/pyeapi/__init__.py
@@ -29,7 +29,7 @@
 # OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
 # IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 #
-__version__ = '0.8.3'
+__version__ = '1.0.0'
 __author__ = 'Arista EOS+'
 
 

diff --git a/pyeapi/api/abstract.py b/pyeapi/api/abstract.py
@@ -40,9 +40,9 @@
 ultimately derive from BaseEntity which provides some common functions to
 make building API modules easier.
 """
-from collections import Callable, Mapping
 
-from pyeapi.eapilib import CommandError, ConnectionError
+from collections.abc import Callable, Mapping
+from pyeapi.eapilib import CommandError
 from pyeapi.utils import make_iterable
 
 
@@ -123,7 +123,7 @@ def configure(self, commands):
         try:
             self.node.config(commands)
             return True
-        except (CommandError, ConnectionError):
+        except (CommandError):
             return False
 
     def command_builder(self, string, value=None, default=None, disable=None):

diff --git a/pyeapi/api/bgp.py b/pyeapi/api/bgp.py
@@ -78,8 +78,8 @@ def get(self):
         return response
 
     def _parse_bgp_as(self, config):
-        match = re.search(r'^router bgp (\d+)', config)
-        return dict(bgp_as=int(match.group(1)))
+        as_num = re.search(r'(?<=^router bgp ).*', config).group(0)
+        return { 'bgp_as': int(as_num) if as_num.isnumeric() else as_num }
 
     def _parse_router_id(self, config):
         match = re.search(r'router-id ([^\s]+)', config)
@@ -214,10 +214,9 @@ def _parse_peer_group(self, config, name):
         return dict(peer_group=value)
 
     def _parse_remote_as(self, config, name):
-        regexp = r'neighbor {} remote-as (\d+)'.format(name)
-        match = re.search(regexp, config)
-        value = match.group(1) if match else None
-        return dict(remote_as=value)
+        remote_as_re = rf'(?<=neighbor {name} remote-as ).*'
+        match = re.search(remote_as_re, config)
+        return { 'remote_as': match.group(0) if match else None}
 
     def _parse_send_community(self, config, name):
         exp = 'no neighbor {} send-community'.format(name)