Adding a test for stalekey engine changes.

salt/engines/stalekey.py

@@ -70,19 +70,18 @@ def _read_presence(presence_file):
     if os.path.exists(presence_file):
         try:
             with salt.utils.files.fopen(presence_file, "rb") as f:
-                minions = salt.utils.msgpack.load(f)
+                _minions = salt.utils.msgpack.load(f)
 
                 # ensure all keys are unicode, not bytes.
-                _minions = {}
-                for minion in minions:
+                for minion in _minions:
                     _minion = salt.utils.stringutils.to_unicode(minion)
-                    _minions[_minion] = minions[minion]
+                    minions[_minion] = _minions[minion]
 
         except OSError as e:
             error = True
             log.error("Could not open presence file %s: %s", presence_file, e)
 
-    return error, _minions
+    return error, minions
 
 
 def _write_presence(presence_file, minions):

tests/unit/engines/test_stalekey.py

@@ -0,0 +1,79 @@
+"""
+unit tests for the stalekey engine
+"""
+
+import logging
+
+import salt.engines.stalekey as stalekey
+from tests.support.mixins import LoaderModuleMockMixin
+from tests.support.mock import MagicMock, mock_open, patch
+from tests.support.unit import TestCase
+
+log = logging.getLogger(__name__)
+
+
+class MockWheel:
+    def __init__(self, *args, **kwargs):
+        pass
+
+    def cmd(self, *args, **kwargs):
+        return True
+
+
+class EngineStalekeyTestCase(TestCase, LoaderModuleMockMixin):
+    """
+    Test cases for salt.engine.stalekeys
+    """
+
+    def setup_loader_modules(self):
+        return {stalekey: {}}
+
+    def test__delete_keys(self):
+        """
+        Test to ensure the _delete_keys function deletes multiple keys
+        """
+        with patch("salt.wheel.WheelClient", MockWheel):
+            stale_keys = ["minion1", "minion2"]
+            minions = {
+                "minion1": 1601430462.5281658,
+                "minion2": 1601430462.5281658,
+            }
+
+            ret = stalekey._delete_keys(stale_keys, minions)
+            self.assertEqual(ret, {})
+
+            stale_keys = ["minion1"]
+            minions = {
+                "minion1": 1601430462.5281658,
+                "minion2": 1601430462.5281658,
+            }
+
+            ret = stalekey._delete_keys(stale_keys, minions)
+            self.assertEqual(ret, {"minion2": 1601430462.5281658})
+
+    def test__read_presence(self):
+        """
+        Test for _read_presence returning False for no error and minions presence data
+        """
+        presence_data = {b"minion": 1601477127.532849}
+        expected = (False, {"minion": 1601477127.532849})
+        with patch("os.path.exists", return_value=True):
+            with patch("salt.utils.files.fopen", mock_open()):
+                with patch(
+                    "salt.utils.msgpack.load", MagicMock(return_value=presence_data)
+                ):
+                    ret = stalekey._read_presence("presence_file")
+                    self.assertEqual(ret, expected)
+
+    def test__write_presence(self):
+        """
+        Test for _write_presence returning False, meaning no error has occured
+        """
+        expected = False
+        minions = {
+            "minion1": 1601430462.5281658,
+            "minion2": 1601430462.5281658,
+        }
+        with patch("salt.utils.files.fopen", mock_open()):
+            ret = stalekey._write_presence("presence_file", minions)
+            self.assertEqual(ret, expected)