fix: generate new snmp engine for every task (#1290)

* fix: generate new snmp engine for every task

* test: fix unit test [run-int-tests]

* chore: update changelog

Author: ajasnosz

CHANGELOG.md

@@ -11,8 +11,9 @@
   - Enabled AOF persistence by default for data durability
 - add CounterBasedGauge64 and ZeroBasedCounter64 as metrics types
 
-### Fixes
+### Fixed
 - fix problem with service rendering when `traps.service.usemetallb` is set to false
+- fix reusing the snmp engine for snmpv3 calls
 
 ## [1.14.1]
 - update mongodb volumePermission image repository to `bitnamileagcy`

splunk_connect_for_snmp/snmp/auth.py

@@ -185,5 +185,7 @@ def get_auth(
         return get_auth_v1(ir)
     elif ir.version == "2c":
         return get_auth_v2c(ir)
-    else:
+    elif ir.version == "3":
         return get_auth_v3(logger, ir, snmp_engine)
+    else:
+        raise SnmpActionError(f"Wrong SNMP version {ir.version}")

splunk_connect_for_snmp/snmp/manager.py

@@ -291,9 +291,9 @@ def __init__(self, **kwargs):
         self.profiles_collection = ProfileCollection(self.profiles)
         self.profiles_collection.process_profiles()
         self.last_modified = time.time()
-        self.snmpEngine = SnmpEngine()
+        self.snmp_engine = SnmpEngine()
         self.already_loaded_mibs = set()
-        self.builder = self.snmpEngine.getMibBuilder()
+        self.builder = self.snmp_engine.getMibBuilder()
         self.mib_view_controller = view.MibViewController(self.builder)
         compiler.addMibCompiler(self.builder, sources=[MIB_SOURCES])
 
@@ -315,6 +315,18 @@ def __init__(self, **kwargs):
                 f"Unable to load mib map from index http error {self.mib_response.status_code}"
             )
 
+    def get_snmp_engine(self, version="", create_new=False) -> SnmpEngine:
+        """
+        :returns: The new SnmpEngine with mibViewController cache attached if snmp version is 3,
+        else it reuses already defined snmp poller.
+        """
+        if version == "3" or create_new:
+            snmp_engine = SnmpEngine()
+            snmp_engine.cache["mibViewController"] = self.mib_view_controller
+            return snmp_engine
+        else:
+            return self.snmp_engine
+
     def do_work(
         self,
         ir: InventoryRecord,
@@ -335,7 +347,7 @@ def do_work(
             address, walk=walk, profiles=profiles
         )
 
-        auth_data = get_auth(logger, ir, self.snmpEngine)
+        auth_data = get_auth(logger, ir, self.get_snmp_engine(ir.version))
         context_data = get_context_data()
 
         transport = setup_transport_target(ir)
@@ -399,7 +411,11 @@ def run_get_request(
                 error_index,
                 varbind_table,
             ) in getCmd(
-                self.snmpEngine, auth_data, transport, context_data, *varbind_chunk
+                self.get_snmp_engine(create_new=True),
+                auth_data,
+                transport,
+                context_data,
+                *varbind_chunk,
             ):
                 if not _any_failure_happened(
                     error_indication,
@@ -429,7 +445,7 @@ def run_bulk_request(
             error_index,
             varbind_table,
         ) in bulkCmd(
-            self.snmpEngine,
+            self.get_snmp_engine(create_new=True),
             auth_data,
             transport,
             context_data,

test/snmp/test_do_work.py

@@ -33,7 +33,7 @@ class TestDoWork(TestCase):
     def test_do_work_no_work_to_do(self):
         poller = Poller.__new__(Poller)
         poller.last_modified = 1609675634
-        poller.snmpEngine = None
+        poller.snmp_engine = None
         poller.profiles_manager = MagicMock()
         poller.profiles_collection = MagicMock()
         poller.profiles_collection.process_profiles = MagicMock()
@@ -57,14 +57,15 @@ def test_do_work_no_work_to_do(self):
     @patch("mongolock.MongoLock.release", MagicMock())
     @patch("splunk_connect_for_snmp.snmp.auth.get_auth", None)
     @patch("splunk_connect_for_snmp.snmp.manager.get_context_data", MagicMock())
+    @patch("splunk_connect_for_snmp.snmp.manager.Poller.get_snmp_engine", MagicMock())
     @patch("splunk_connect_for_snmp.snmp.manager.setup_transport_target", MagicMock())
     @patch("splunk_connect_for_snmp.snmp.manager.bulkCmd")
     @patch("splunk_connect_for_snmp.snmp.manager.getCmd")
     @patch("splunk_connect_for_snmp.common.collection_manager.ProfilesManager")
     def test_do_work_bulk(self, load_profiles, getCmd, bulkCmd):
         poller = Poller.__new__(Poller)
         poller.last_modified = 1609675634
-        poller.snmpEngine = None
+        poller.snmp_engine = None
         poller.builder = MagicMock()
         poller.profiles_manager = MagicMock()
         m_process_data = MagicMock()
@@ -93,6 +94,7 @@ def test_do_work_bulk(self, load_profiles, getCmd, bulkCmd):
     @patch("mongolock.MongoLock.release", MagicMock())
     @patch("splunk_connect_for_snmp.snmp.auth.get_auth", None)
     @patch("splunk_connect_for_snmp.snmp.manager.get_context_data", MagicMock())
+    @patch("splunk_connect_for_snmp.snmp.manager.Poller.get_snmp_engine", MagicMock())
     @patch("splunk_connect_for_snmp.snmp.manager.setup_transport_target", MagicMock())
     @patch("splunk_connect_for_snmp.snmp.manager.bulkCmd")
     @patch("splunk_connect_for_snmp.snmp.manager.getCmd")
@@ -102,7 +104,7 @@ def test_do_work_bulk(self, load_profiles, getCmd, bulkCmd):
     def test_do_work_get(self, load_profiles, getCmd, bulkCmd):
         poller = Poller.__new__(Poller)
         poller.last_modified = 1609675634
-        poller.snmpEngine = None
+        poller.snmp_engine = None
         poller.builder = MagicMock()
         poller.process_snmp_data = MagicMock()
         poller.profiles_manager = MagicMock()
@@ -136,6 +138,7 @@ def test_do_work_get(self, load_profiles, getCmd, bulkCmd):
     @patch("mongolock.MongoLock.release", MagicMock())
     @patch("splunk_connect_for_snmp.snmp.auth.get_auth", None)
     @patch("splunk_connect_for_snmp.snmp.manager.get_context_data", MagicMock())
+    @patch("splunk_connect_for_snmp.snmp.manager.Poller.get_snmp_engine", MagicMock())
     @patch("splunk_connect_for_snmp.snmp.manager.setup_transport_target", MagicMock())
     @patch("splunk_connect_for_snmp.snmp.manager.bulkCmd")
     @patch("splunk_connect_for_snmp.snmp.manager.getCmd")
@@ -145,7 +148,7 @@ def test_do_work_get(self, load_profiles, getCmd, bulkCmd):
     def test_do_work_errors(self, load_profiles, getCmd, bulkCmd):
         poller = Poller.__new__(Poller)
         poller.last_modified = 1609675634
-        poller.snmpEngine = None
+        poller.snmp_engine = None
         poller.builder = MagicMock()
         poller.process_snmp_data = MagicMock()
         poller.profiles_manager = MagicMock()