Fix/default freq dynamic (#160)

* fix: apply default frequency for dynamic profiles

* fix: fixes

* fix: fixes

* refactor: PR comments

* refactor: PR comments

Author: weliasz

splunk_connect_for_snmp_poller/manager/const.py

@@ -36,3 +36,5 @@
     "AES256BLMT": config.usmAesBlumenthalCfb256Protocol,
     "NONE": config.usmNoPrivProtocol,
 }
+
+DEFAULT_POLLING_FREQUENCY = 60

splunk_connect_for_snmp_poller/manager/poller.py

@@ -292,7 +292,7 @@ def process_unmatched_devices(self, server_config):
 
                         if any(descr):
                             assigned_profiles = assign_profiles_to_device(
-                                profiles["profiles"], descr
+                                profiles["profiles"], descr, host
                             )
                             processed_devices.add(host)
 

splunk_connect_for_snmp_poller/manager/poller_utilities.py

@@ -20,6 +20,7 @@
 import schedule
 from pysnmp.hlapi import ObjectIdentity, ObjectType, UdpTransportTarget, getCmd
 
+from splunk_connect_for_snmp_poller.manager.const import DEFAULT_POLLING_FREQUENCY
 from splunk_connect_for_snmp_poller.manager.data.inventory_record import InventoryRecord
 from splunk_connect_for_snmp_poller.manager.realtime.oid_constant import OidConstant
 from splunk_connect_for_snmp_poller.manager.realtime.real_time_data import (
@@ -76,20 +77,20 @@ def parse_inventory_file(inventory_file_path, profiles, fetch_frequency=True):
                     agent["version"],
                     agent["community"],
                     agent["profile"],
-                    get_frequency(agent, profiles, 60)
+                    get_frequency(agent, profiles, DEFAULT_POLLING_FREQUENCY)
                     if fetch_frequency and agent["profile"] != DYNAMIC_PROFILE
                     else None,
                 )
 
 
 def get_frequency(agent, profiles, default_frequency):
-    if "profile" in agent:
-        frequency = multi_key_lookup(
-            profiles, ("profiles", agent["profile"], "frequency")
-        )
-        if frequency:
-            return frequency
-    logger.debug(f'Default frequency was assigned for agent = {agent.get("host")}')
+    frequency = multi_key_lookup(profiles, ("profiles", agent["profile"], "frequency"))
+    if frequency:
+        return frequency
+    logger.debug(
+        f'Default frequency={DEFAULT_POLLING_FREQUENCY} was assigned for agent={agent.get("host")}, '
+        f'profile={agent["profile"]}'
+    )
     return default_frequency
 
 

splunk_connect_for_snmp_poller/manager/profile_matching.py

@@ -18,6 +18,7 @@
 
 import yaml
 
+from splunk_connect_for_snmp_poller.manager.const import DEFAULT_POLLING_FREQUENCY
 from splunk_connect_for_snmp_poller.manager.mib_server_client import get_mib_profiles
 from splunk_connect_for_snmp_poller.manager.realtime.oid_constant import OidConstant
 from splunk_connect_for_snmp_poller.utilities import multi_key_lookup
@@ -33,20 +34,28 @@ def extract_desc(realtime_collection):
     return sys_descr, sys_object_id
 
 
-def assign_profiles_to_device(profiles, device_desc):
+def assign_profiles_to_device(profiles, device_desc, host):
     result = []
     for profile in profiles:
-        if "patterns" in profiles[profile]:
-            match_profile_with_device(device_desc, profile, profiles, result)
+        if profiles[profile].get("patterns"):
+            match_profile_with_device(device_desc, profile, profiles, result, host)
     return result
 
 
-def match_profile_with_device(device_desc, profile, profiles, result):
+def match_profile_with_device(device_desc, profile, profiles, result, host):
     for pattern in profiles[profile]["patterns"]:
         compiled = re.compile(pattern)
         for desc in device_desc:
             if desc and compiled.match(desc):
-                result.append((profile, profiles[profile]["frequency"]))
+                if "frequency" in profiles[profile]:
+                    frequency = profiles[profile]["frequency"]
+                else:
+                    frequency = DEFAULT_POLLING_FREQUENCY
+                    logger.debug(
+                        f"Default frequency={DEFAULT_POLLING_FREQUENCY} was assigned for agent={host}, "
+                        f"profile={profile}"
+                    )
+                result.append((profile, frequency))
                 return
 
 

tests/test_poller_utilities.py

@@ -54,12 +54,6 @@ def test_return_frequency(self):
         result = get_frequency(agent, profiles, 60)
         self.assertEqual(result, 20)
 
-    def test_return_default_frequency_when_agent_does_not_have_profile(self):
-        agent = {}
-        profiles = {"profiles": {"some_profile": {"frequency": 20}}}
-        result = get_frequency(agent, profiles, 60)
-        self.assertEqual(result, 60)
-
     def test_return_default_frequency_when_agent_profile_not_present_in_profiles(self):
         agent = {"profile": "some_profile"}
         profiles = {"profiles": {"some_profile_2": {"frequency": 20}}}

tests/test_profile_matching.py

@@ -58,7 +58,9 @@ def test_return_tuple_with_none_values(self):
     def test_assign_profile_to_device(self):
         profiles = {"zeus": {"patterns": [".*zeus.*"], "frequency": 20}}
 
-        result = assign_profiles_to_device(profiles, ("My zeus device", None))
+        result = assign_profiles_to_device(
+            profiles, ("My zeus device", None), "localhost"
+        )
 
         self.assertEqual(len(result), 1)
         profile, frequency = next(iter(result))
@@ -72,7 +74,7 @@ def test_assign_multiple_profile_to_device(self):
         }
 
         result = assign_profiles_to_device(
-            profiles, ("My zeus device, linux 2.3.4", None)
+            profiles, ("My zeus device, linux 2.3.4", None), "localhost"
         )
 
         self.assertEqual(len(result), 2)
@@ -90,7 +92,9 @@ def test_assign_multiple_profile_to_device_from_different_descs(self):
             "linux": {"patterns": [".*linux.*"], "frequency": 30},
         }
 
-        result = assign_profiles_to_device(profiles, ("My zeus device", "linux 2.3.4"))
+        result = assign_profiles_to_device(
+            profiles, ("My zeus device", "linux 2.3.4"), "localhost"
+        )
 
         self.assertEqual(len(result), 2)
         profile, frequency = result[0]
@@ -104,6 +108,7 @@ def test_assign_multiple_profile_to_device_from_different_descs(self):
     def test_no_assignment_when_patterns_are_missing(self):
         profiles = {"zeus": {"frequency": 20}}
 
-        result = assign_profiles_to_device(profiles, ("My zeus device", None))
-
+        result = assign_profiles_to_device(
+            profiles, ("My zeus device", None), "localhost"
+        )
         self.assertEqual(len(result), 0)