Finished release 0.112.

Changelog.md

@@ -2,6 +2,11 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.112] - 2023-11-20
+- correctly handled timeout error for some RPC requests
+- handle inactive bundle configs populating cache
+- addressed potential issues with bundle formatting in cache for /poller/speeds endpoint
+
 ## [0.111] - 2023-11-6
 - fixed retrieving netconf interface-information
 - return speeds in /poller/speed exclusively via netconf interface-information

inventory_provider/juniper.py

@@ -4,6 +4,7 @@ import re
 import ipaddress
 
 import ncclient
+import ncclient.operations
 import ncclient.manager
 from jnpr.junos import Device
 from jnpr.junos import exception as EzErrors
@@ -138,7 +139,7 @@ def _nc_connection(host_params, ssh_params):
 
     try:
         yield conn  # wait here until caller context ends
-    except EzErrors.ConnectTimeoutError:
+    except (EzErrors.ConnectTimeoutError, ncclient.operations.errors.TimeoutExpiredError):
         raise TimeoutError
     finally:
         conn.close_session()
@@ -232,10 +233,10 @@ def list_interfaces(netconf_config):
     def _ifc_info(e):
         # warning: this structure should match the default
         #          returned from routes.classifier.juniper_link_info
-        name = e.find('name')
-        assert name is not None, "expected interface 'name' child element"
+        _name = e.find('name')
+        assert _name is not None, "expected interface 'name' child element"
         ifc = {
-            'name': name.text,
+            'name': _name.text,
             'description': '',
             'bundle': [],
             'speed': ''  # set elsewhere but needs to be included to maintain default structure
@@ -244,12 +245,11 @@ def list_interfaces(netconf_config):
         if description is not None:
             ifc['description'] = description.text
 
-        for b in i.iterfind(".//bundle"):
-            ifc['bundle'].append(b.text)
-
+        ifc['bundle'] = e.xpath(
+            "./gigether-options[not(@inactive='inactive')]"
+            "/ieee-802.3ad[not(@inactive='inactive')]/bundle/text()")
         ifc['ipv4'] = e.xpath('./family/inet/address/name/text()')
         ifc['ipv6'] = e.xpath('./family/inet6/address/name/text()')
-
         return ifc
 
     def _inactive(interface_node):

inventory_provider/routes/poller.py

@@ -84,6 +84,7 @@ routes = Blueprint('poller-support-routes', __name__)
 
 Mb = 1 << 20
 Gb = 1 << 30
+OC = Mb * 51.84
 
 
 class INTERFACE_TYPES(Enum):
@@ -713,8 +714,6 @@ def _add_speeds(interfaces):
         nc_ifc = netconf_interface_index.get(f"{ifc['router']}---{ifc['name']}", {})
         if 'speed' in nc_ifc:
             ifc['speed'] = nc_ifc['speed']
-        else:
-            ifc['speed'] = ''
         yield ifc
 
 
@@ -726,6 +725,9 @@ def _add_bundle_parents(interfaces, hostname=None):
     :param hostname: hostname or None for all
     :return: generator with bundle-parents populated in each element
     """
+    def _get_base_name(name):
+        return name.split('.')[0]
+
     bundles = _load_interface_bundles(
         current_app.config['INVENTORY_PROVIDER_CONFIG'], hostname)
     # create a quick look-up for interface details
@@ -734,8 +736,8 @@ def _add_bundle_parents(interfaces, hostname=None):
     for ifc in interfaces:
         router_bundle = bundles.get(ifc['router'], None)
         if router_bundle:
-            base_ifc = ifc['name'].split('.')[0]
-            bundle_parents = [interface_index.get(f"{ifc['router']}---{bundle_ifc}")
+            base_ifc = _get_base_name(ifc['name'])
+            bundle_parents = [interface_index.get(f"{ifc['router']}---{_get_base_name(bundle_ifc)}")
                               for bundle_ifc in router_bundle.get(base_ifc, [])]
             ifc['bundle-parents'] = bundle_parents
         yield ifc
@@ -878,25 +880,32 @@ def interface_speed(ifc):
         return -1
 
     def _get_speed(ifc):
+
         rate_conversions = {
             "mbps": Mb,
             "gbps": Gb
+
         }
 
         if "speed" in ifc:
             speed = ifc["speed"]
-            match = re.match(r"(\d+)(.+)", speed)
-            if match:
-                value = int(match.group(1))
-                rate = match.group(2).strip().lower()
+            rate_match = re.match(r"(\d+)(.+)", speed)
+            if rate_match:
+                value = int(rate_match.group(1))
+                rate = rate_match.group(2).strip().lower()
                 if rate in rate_conversions:
-                    return value * rate_conversions[rate]
+                    return int(value * rate_conversions[rate])
                 else:
                     logger.warning(f'unrecognised rate: {rate}, using _name_to_speed fallback')
                     return _name_to_speed(ifc['name'])
             else:
-                logger.warning(f'unrecognised speed: {speed}, using _name_to_speed fallback')
-                return _name_to_speed(ifc['name'])
+                oc_match = re.match(r"OC(\d+)", speed)
+                if oc_match:
+                    value = int(oc_match.group(1))
+                    return int(value * OC)
+                else:
+                    logger.warning(f'unrecognised speed: {speed}, using _name_to_speed fallback')
+                    return _name_to_speed(ifc['name'])
         else:
             logger.warning('no speed data for interface, using _name_to_speed fallback')
             return _name_to_speed(ifc['name'])
@@ -905,9 +914,9 @@ def interface_speed(ifc):
         if not ifc['name'].startswith('ae'):
             logger.warning(
                 f'ifc has bundle-parents, but name is {ifc["name"]}')
-        return sum(_get_speed(parent_ifc) for parent_ifc in ifc['bundle-parents'])
+        return int(sum(_get_speed(parent_ifc) for parent_ifc in ifc['bundle-parents']))
 
-    return _get_speed(ifc)
+    return int(_get_speed(ifc))
 
 
 def _load_interfaces_and_speeds(hostname=None):

setup.py

@@ -2,7 +2,7 @@ from setuptools import setup, find_packages
 
 setup(
     name='inventory-provider',
-    version="0.111",
+    version="0.112",
     author='GEANT',
     author_email='swd@geant.org',
     description='Dashboard inventory provider',

test/test_juniper_data_global.py

 import ast
 import netifaces
 import ipaddress
+import os
 
+from lxml import etree
 import pytest
 
 from inventory_provider import juniper
@@ -89,3 +91,32 @@ def test_asn_to_int_functionality():
     with pytest.raises(ValueError):
         asn_to_int('66512.2')
         asn_to_int('Test')
+
+
+def test_DBOARD3_833():
+    """Test that the bundle inactive attribute is handled correctly.
+
+    The test data contains an interface: et-4/0/2 with the bundle
+    configuration (for ae6) marked as 'inactive'.  et-4/0/2 also
+    has a logical interface configured.
+
+    This test confirms that neither et-4/0/2 nor et-4/0/2.0 are
+    part of a bundle.
+    """
+
+    test_filename = os.path.join(
+        os.path.dirname(__file__),
+        'data',
+        'DBOARD3-833.xml')
+    with open(test_filename, 'r') as f:
+        netconf_config = etree.XML(f.read())
+
+    interfaces = {
+        i['name']: i for i in juniper.list_interfaces(netconf_config)}
+
+    assert not interfaces['et-4/0/2']['bundle']
+    assert not interfaces['et-4/0/2.0']['bundle']
+
+    # additional sanity check: parent bundle should be empty or exactly one
+    for ifc in interfaces.values():
+        assert len(ifc['bundle']) in (0, 1)