Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions src/aws_secretsmanager_caching/decorators.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
"""Decorators for use with caching library"""

import json
import inspect
from functools import wraps


Expand Down Expand Up @@ -50,8 +51,19 @@ def _wrapped_func(*args, **kwargs):
"""
secret = self.cache.get_secret_string(secret_id=self.secret_id)

# Prevent clobbering self arg in class methods
if args and hasattr(args[0].__class__, func.__name__):
# Only reserve self for an instance method wrapping this function.
is_instance_method = False
if args:
for cls in type(args[0]).__mro__:
method = cls.__dict__.get(func.__name__)
if isinstance(method, (staticmethod, classmethod)):
continue
if isinstance(method, property):
method = method.fget
if inspect.unwrap(method) is inspect.unwrap(func):
is_instance_method = True
break
if is_instance_method:
new_args = (args[0], secret) + args[1:]
else:
new_args = (secret,) + args
Expand Down
83 changes: 83 additions & 0 deletions test/unit/test_decorators.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@
"""
import json
import unittest
from functools import lru_cache
from unittest.mock import Mock

import botocore
from aws_secretsmanager_caching.decorators import InjectKeywordedSecretString, InjectSecretString
Expand Down Expand Up @@ -145,6 +147,87 @@ def function_to_be_decorated(func_username, func_password, keyworded_argument='f

class TestAwsSecretsManagerCachingInjectSecretStringDecorator(unittest.TestCase):

def test_plain_get_function_keeps_dictionary_after_secret(self):
cache = Mock()
cache.get_secret_string.return_value = 'secret'

@InjectSecretString('test', cache)
def get(secret, request):
return secret, request

request = {'user': 'bob'}
self.assertEqual(get(request), ('secret', request))

def test_static_method_keeps_instance_argument_after_secret(self):
cache = Mock()
cache.get_secret_string.return_value = 'secret'

class Example:
@staticmethod
@InjectSecretString('test', cache)
def get(secret, request):
return secret, request

request = Example()
self.assertEqual(Example.get(request), ('secret', request))

def test_inherited_instance_method_keeps_self_before_secret(self):
cache = Mock()
cache.get_secret_string.return_value = 'secret'

class Parent:
@InjectSecretString('test', cache)
def get(self, secret, request):
return self, secret, request

class Child(Parent):
pass

instance = Child()
self.assertEqual(instance.get('request'), (instance, 'secret', 'request'))

def test_overridden_instance_method_can_call_decorated_parent(self):
cache = Mock()
cache.get_secret_string.return_value = 'secret'

class Parent:
@InjectSecretString('test', cache)
def get(self, secret, request):
return self, secret, request

class Child(Parent):
def get(self, request):
return super().get(request)

instance = Child()
self.assertEqual(instance.get('request'), (instance, 'secret', 'request'))

def test_cached_instance_method_keeps_self_before_secret(self):
cache = Mock()
cache.get_secret_string.return_value = 'secret'

class Example:
@lru_cache(maxsize=None)
@InjectSecretString('test', cache)
def get(self, secret):
return self, secret

instance = Example()
self.assertEqual(instance.get(), (instance, 'secret'))

def test_property_keeps_self_before_secret(self):
cache = Mock()
cache.get_secret_string.return_value = 'secret'

class Example:
@property
@InjectSecretString('test', cache)
def get(self, secret):
return self, secret

instance = Example()
self.assertEqual(instance.get, (instance, 'secret'))

def get_client(self, response={}, versions=None, version_response=None):
client = botocore.session.get_session().create_client('secretsmanager', region_name='us-west-2')
stubber = Stubber(client)
Expand Down