Python 3.10 and 3.12 compatibility changes and package version compatibility updates (#41)

These changes are fixes for datetime.utcnow() deprecation in python 3.10 and the change in randint to only accept integer arguments.

Author: YuvalShAz

.github/workflows/python-package.yml

@@ -16,7 +16,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
 
     steps:
     - uses: actions/checkout@v3

src/aws_secretsmanager_caching/cache/items.py

@@ -16,7 +16,7 @@
 import threading
 from abc import ABCMeta, abstractmethod
 from copy import deepcopy
-from datetime import datetime, timedelta
+from datetime import datetime, timedelta, timezone
 from random import randint
 
 from .lru import LRUCache
@@ -61,7 +61,7 @@ def _is_refresh_needed(self):
             return False
         if self._next_retry_time is None:
             return False
-        return self._next_retry_time <= datetime.utcnow()
+        return self._next_retry_time <= datetime.now(timezone.utc)
 
     @abstractmethod
     def _execute_refresh(self):
@@ -102,7 +102,7 @@ def __refresh(self):
             )
             self._exception_count += 1
             delay = min(delay, self._config.exception_retry_delay_max)
-            self._next_retry_time = datetime.utcnow() + timedelta(milliseconds=delay)
+            self._next_retry_time = datetime.now(timezone.utc) + timedelta(milliseconds=delay)
 
     def get_secret_value(self, version_stage=None):
         """Get the cached secret value for the given version stage.
@@ -156,7 +156,7 @@ def __init__(self, config, client, secret_id):
         """
         super(SecretCacheItem, self).__init__(config, client, secret_id)
         self._versions = LRUCache(10)
-        self._next_refresh_time = datetime.utcnow()
+        self._next_refresh_time = datetime.now(timezone.utc)
 
     def _is_refresh_needed(self):
         """Determine if the cached item should be refreshed.
@@ -168,7 +168,7 @@ def _is_refresh_needed(self):
             return True
         if self._exception:
             return False
-        return self._next_refresh_time <= datetime.utcnow()
+        return self._next_refresh_time <= datetime.now(timezone.utc)
 
     @staticmethod
     def _get_version_id(result, version_stage):
@@ -200,7 +200,7 @@ def _execute_refresh(self):
         """
         result = self._client.describe_secret(SecretId=self._secret_id)
         ttl = self._config.secret_refresh_interval
-        self._next_refresh_time = datetime.utcnow() + timedelta(seconds=randint(round(ttl / 2), ttl))
+        self._next_refresh_time = datetime.now(timezone.utc) + timedelta(seconds=randint(round(ttl / 2), ttl))
         return result
 
     def _get_version(self, version_stage):

src/aws_secretsmanager_caching/config.py

@@ -13,7 +13,6 @@
 """Secret cache configuration object."""
 
 from copy import deepcopy
-from datetime import timedelta
 
 
 class SecretCacheConfig:
@@ -54,7 +53,7 @@ class SecretCacheConfig:
         "exception_retry_growth_factor": 2,
         "exception_retry_delay_max": 3600,
         "default_version_stage": "AWSCURRENT",
-        "secret_refresh_interval": timedelta(hours=1).total_seconds(),
+        "secret_refresh_interval": 3600,
         "secret_cache_hook": None
     }
 

test/unit/test_config.py

@@ -33,3 +33,7 @@ def test_config_default_version_stage(self):
         stage = 'nothing'
         config = SecretCacheConfig(default_version_stage=stage)
         self.assertEqual(config.default_version_stage, stage)
+
+    def test_default_secret_refresh_interval_typing(self):
+        config = SecretCacheConfig()
+        self.assertIsInstance(config.secret_refresh_interval, int)

test/unit/test_items.py

@@ -14,8 +14,10 @@
 Unit test suite for items module
 """
 import unittest
+from datetime import timezone, datetime, timedelta
+from unittest.mock import Mock
 
-from aws_secretsmanager_caching.cache.items import SecretCacheObject
+from aws_secretsmanager_caching.cache.items import SecretCacheObject, SecretCacheItem
 from aws_secretsmanager_caching.config import SecretCacheConfig
 
 
@@ -47,3 +49,89 @@ def test_simple_2(self):
         self.assertIsNone(sco.get_secret_value())
         sco._exception = Exception("test")
         self.assertRaises(Exception, sco.get_secret_value)
+
+    def test_datetime_fix_is_refresh_needed(self):
+        secret_cached_object = TestSecretCacheObject.TestObject(SecretCacheConfig(), None, None)
+
+        # Variable values set in order to be able to test modified line with assert statement (False is not None)
+        secret_cached_object._next_retry_time = datetime.now(tz=timezone.utc)
+        secret_cached_object._refresh_needed = False
+        secret_cached_object._exception = not None
+
+        self.assertTrue(secret_cached_object._is_refresh_needed())
+
+    def test_datetime_fix_refresh(self):
+        exp_factor = 11
+
+        secret_cached_object = SecretCacheObject(
+            SecretCacheConfig(exception_retry_delay_base=1, exception_retry_growth_factor=2),
+            None, None
+        )
+        secret_cached_object._set_result = Mock(side_effect=Exception("exception used for test"))
+        secret_cached_object._refresh_needed = True
+        secret_cached_object._exception_count = exp_factor  # delay = min(1*(2^exp_factor) = 2048, 3600)
+
+        t_before = datetime.now(tz=timezone.utc)
+        secret_cached_object._SecretCacheObject__refresh()
+        t_after = datetime.now(tz=timezone.utc)
+
+        t_before_delay = t_before + timedelta(
+            milliseconds=secret_cached_object._config.exception_retry_delay_base * (
+                    secret_cached_object._config.exception_retry_growth_factor ** exp_factor
+            )
+        )
+        self.assertLessEqual(t_before_delay, secret_cached_object._next_retry_time)
+
+        t_after_delay = t_after + timedelta(
+            milliseconds=secret_cached_object._config.exception_retry_delay_base * (
+                    secret_cached_object._config.exception_retry_growth_factor ** exp_factor
+            )
+        )
+        self.assertGreaterEqual(t_after_delay, secret_cached_object._next_retry_time)
+
+class TestSecretCacheItem(unittest.TestCase):
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def test_datetime_fix_SCI_init(self):
+        config = SecretCacheConfig()
+        t_before = datetime.now(tz=timezone.utc)
+        secret_cache_item = SecretCacheItem(config, None, None)
+        t_after = datetime.now(tz=timezone.utc)
+
+        self.assertGreaterEqual(secret_cache_item._next_refresh_time, t_before)
+        self.assertLessEqual(secret_cache_item._next_refresh_time, t_after)
+
+    def test_datetime_fix_refresh_needed(self):
+        config = SecretCacheConfig()
+        secret_cache_item = SecretCacheItem(config, None, None)
+
+        # Variable values set in order to be able to test modified line with assert statement (False is not None)
+        secret_cache_item._refresh_needed = False
+        secret_cache_item._exception = False
+        secret_cache_item._next_retry_time = None
+
+        self.assertTrue(secret_cache_item._is_refresh_needed())
+
+    def test_datetime_fix_execute_refresh(self):
+        client_mock = Mock()
+        client_mock.describe_secret = Mock()
+        client_mock.describe_secret.return_value = "test"
+
+        config = SecretCacheConfig()
+        secret_cache_item = SecretCacheItem(config, client_mock, None)
+
+        t_before = datetime.now(tz=timezone.utc)
+        secret_cache_item._execute_refresh()
+        t_after = datetime.now(tz=timezone.utc)
+
+        # Make sure that the timezone is correctly set
+        self.assertEqual(secret_cache_item._next_refresh_time.tzinfo, timezone.utc)
+
+        # Check that secret_refresh_interval addition works as intended
+        self.assertGreaterEqual(secret_cache_item._next_refresh_time, t_before)
+        t_max_after = t_after + timedelta(seconds=config.secret_refresh_interval)
+        self.assertLessEqual(secret_cache_item._next_refresh_time, t_max_after)