mirror of
https://github.com/ets-labs/python-dependency-injector.git
synced 2024-11-22 09:36:48 +03:00
f961ff536a
* Add single container prototype * Add multiple containers prototype * Add integration tests * Implement from_*() methods and add tests * Prototype inline injections * Add integration test for inline providers * Refactor integration tests * Add integration test for reordered schema * Remove unused imports from tests * Refactor schema module * Update tests to match latest schemas * Add mypy_boto3_s3 to the test requirements * Add boto3 to the test requirements * Add set_provides for Callable, Factory, and Singleton providers * Fix warnings in tests * Add typing stubs for Callable, Factory, and Singleton .set_provides() attributes * Fix singleton children to have optional provides * Implement provider to provider resolving * Fix pypy3 tests * Implement boto3 session use case and add tests * Implement lazy initialization and improve copying for Callable, Factory, Singleton, and Coroutine providers * Fix Python 2 tests * Add region name for boto3 integration example * Remove f-strings from set_provides() * Fix schema flake8 errors * Implement lazy initialization and improve copying for Delegate provider * Implement lazy initialization and improve copying for Object provider * Speed up wiring tests * Implement lazy initialization and improve copying for FactoryAggregate provider * Implement lazy initialization and improve copying for Selector provider * Implement lazy initialization and improve copying for Dependency provider * Implement lazy initialization and improve copying for Resource provider * Implement lazy initialization and improve copying for Configuration provider * Implement lazy initialization and improve copying for ProvidedInstance provider * Implement lazy initialization and improve copying for AttributeGetter provider * Implement lazy initialization and improve copying for ItemGetter provider * Implement lazy initialization and improve copying for MethodCaller provder * Update changelog * Fix typing in wiring module * Fix wiring module loader uninstallation issue * Fix provided instance providers error handing in asynchronous mode Co-authored-by: Roman Mogylatov <rmk@Romans-MacBook-Pro.local>
606 lines
18 KiB
Python
606 lines
18 KiB
Python
"""Dependency injector resource provider unit tests."""
|
|
|
|
import asyncio
|
|
|
|
import unittest
|
|
|
|
from dependency_injector import containers, providers, resources, errors
|
|
|
|
# Runtime import to get asyncutils module
|
|
import os
|
|
_TOP_DIR = os.path.abspath(
|
|
os.path.sep.join((
|
|
os.path.dirname(__file__),
|
|
'../',
|
|
)),
|
|
)
|
|
import sys
|
|
sys.path.append(_TOP_DIR)
|
|
|
|
from asyncutils import AsyncTestCase
|
|
|
|
|
|
def init_fn(*args, **kwargs):
|
|
return args, kwargs
|
|
|
|
|
|
class ResourceTests(unittest.TestCase):
|
|
|
|
def test_is_provider(self):
|
|
self.assertTrue(providers.is_provider(providers.Resource(init_fn)))
|
|
|
|
def test_init_optional_provides(self):
|
|
provider = providers.Resource()
|
|
provider.set_provides(init_fn)
|
|
self.assertIs(provider.provides, init_fn)
|
|
self.assertEqual(provider(), (tuple(), dict()))
|
|
|
|
def test_set_provides_returns_self(self):
|
|
provider = providers.Resource()
|
|
self.assertIs(provider.set_provides(init_fn), provider)
|
|
|
|
def test_provided_instance_provider(self):
|
|
provider = providers.Resource(init_fn)
|
|
self.assertIsInstance(provider.provided, providers.ProvidedInstance)
|
|
|
|
def test_injection(self):
|
|
resource = object()
|
|
|
|
def _init():
|
|
_init.counter += 1
|
|
return resource
|
|
_init.counter = 0
|
|
|
|
class Container(containers.DeclarativeContainer):
|
|
resource = providers.Resource(_init)
|
|
dependency1 = providers.List(resource)
|
|
dependency2 = providers.List(resource)
|
|
|
|
container = Container()
|
|
list1 = container.dependency1()
|
|
list2 = container.dependency2()
|
|
|
|
self.assertEqual(list1, [resource])
|
|
self.assertIs(list1[0], resource)
|
|
|
|
self.assertEqual(list2, [resource])
|
|
self.assertIs(list2[0], resource)
|
|
|
|
self.assertEqual(_init.counter, 1)
|
|
|
|
def test_init_function(self):
|
|
def _init():
|
|
_init.counter += 1
|
|
_init.counter = 0
|
|
|
|
provider = providers.Resource(_init)
|
|
|
|
result1 = provider()
|
|
self.assertIsNone(result1)
|
|
self.assertEqual(_init.counter, 1)
|
|
|
|
result2 = provider()
|
|
self.assertIsNone(result2)
|
|
self.assertEqual(_init.counter, 1)
|
|
|
|
provider.shutdown()
|
|
|
|
def test_init_generator(self):
|
|
def _init():
|
|
_init.init_counter += 1
|
|
yield
|
|
_init.shutdown_counter += 1
|
|
|
|
_init.init_counter = 0
|
|
_init.shutdown_counter = 0
|
|
|
|
provider = providers.Resource(_init)
|
|
|
|
result1 = provider()
|
|
self.assertIsNone(result1)
|
|
self.assertEqual(_init.init_counter, 1)
|
|
self.assertEqual(_init.shutdown_counter, 0)
|
|
|
|
provider.shutdown()
|
|
self.assertEqual(_init.init_counter, 1)
|
|
self.assertEqual(_init.shutdown_counter, 1)
|
|
|
|
result2 = provider()
|
|
self.assertIsNone(result2)
|
|
self.assertEqual(_init.init_counter, 2)
|
|
self.assertEqual(_init.shutdown_counter, 1)
|
|
|
|
provider.shutdown()
|
|
self.assertEqual(_init.init_counter, 2)
|
|
self.assertEqual(_init.shutdown_counter, 2)
|
|
|
|
def test_init_class(self):
|
|
class TestResource(resources.Resource):
|
|
init_counter = 0
|
|
shutdown_counter = 0
|
|
|
|
def init(self):
|
|
self.__class__.init_counter += 1
|
|
|
|
def shutdown(self, _):
|
|
self.__class__.shutdown_counter += 1
|
|
|
|
provider = providers.Resource(TestResource)
|
|
|
|
result1 = provider()
|
|
self.assertIsNone(result1)
|
|
self.assertEqual(TestResource.init_counter, 1)
|
|
self.assertEqual(TestResource.shutdown_counter, 0)
|
|
|
|
provider.shutdown()
|
|
self.assertEqual(TestResource.init_counter, 1)
|
|
self.assertEqual(TestResource.shutdown_counter, 1)
|
|
|
|
result2 = provider()
|
|
self.assertIsNone(result2)
|
|
self.assertEqual(TestResource.init_counter, 2)
|
|
self.assertEqual(TestResource.shutdown_counter, 1)
|
|
|
|
provider.shutdown()
|
|
self.assertEqual(TestResource.init_counter, 2)
|
|
self.assertEqual(TestResource.shutdown_counter, 2)
|
|
|
|
def test_init_not_callable(self):
|
|
provider = providers.Resource(1)
|
|
with self.assertRaises(errors.Error):
|
|
provider.init()
|
|
|
|
def test_init_and_shutdown(self):
|
|
def _init():
|
|
_init.init_counter += 1
|
|
yield
|
|
_init.shutdown_counter += 1
|
|
|
|
_init.init_counter = 0
|
|
_init.shutdown_counter = 0
|
|
|
|
provider = providers.Resource(_init)
|
|
|
|
result1 = provider.init()
|
|
self.assertIsNone(result1)
|
|
self.assertEqual(_init.init_counter, 1)
|
|
self.assertEqual(_init.shutdown_counter, 0)
|
|
|
|
provider.shutdown()
|
|
self.assertEqual(_init.init_counter, 1)
|
|
self.assertEqual(_init.shutdown_counter, 1)
|
|
|
|
result2 = provider.init()
|
|
self.assertIsNone(result2)
|
|
self.assertEqual(_init.init_counter, 2)
|
|
self.assertEqual(_init.shutdown_counter, 1)
|
|
|
|
provider.shutdown()
|
|
self.assertEqual(_init.init_counter, 2)
|
|
self.assertEqual(_init.shutdown_counter, 2)
|
|
|
|
def test_shutdown_of_not_initialized(self):
|
|
def _init():
|
|
yield
|
|
|
|
provider = providers.Resource(_init)
|
|
|
|
result = provider.shutdown()
|
|
self.assertIsNone(result)
|
|
|
|
def test_initialized(self):
|
|
provider = providers.Resource(init_fn)
|
|
self.assertFalse(provider.initialized)
|
|
|
|
provider.init()
|
|
self.assertTrue(provider.initialized)
|
|
|
|
provider.shutdown()
|
|
self.assertFalse(provider.initialized)
|
|
|
|
def test_call_with_context_args(self):
|
|
provider = providers.Resource(init_fn, 'i1', 'i2')
|
|
self.assertEqual(provider('i3', i4=4), (('i1', 'i2', 'i3'), {'i4': 4}))
|
|
|
|
def test_fluent_interface(self):
|
|
provider = providers.Resource(init_fn) \
|
|
.add_args(1, 2) \
|
|
.add_kwargs(a3=3, a4=4)
|
|
|
|
self.assertEqual(provider(), ((1, 2), {'a3': 3, 'a4': 4}))
|
|
|
|
def test_set_args(self):
|
|
provider = providers.Resource(init_fn) \
|
|
.add_args(1, 2) \
|
|
.set_args(3, 4)
|
|
self.assertEqual(provider.args, (3, 4))
|
|
|
|
def test_clear_args(self):
|
|
provider = providers.Resource(init_fn) \
|
|
.add_args(1, 2) \
|
|
.clear_args()
|
|
self.assertEqual(provider.args, tuple())
|
|
|
|
def test_set_kwargs(self):
|
|
provider = providers.Resource(init_fn) \
|
|
.add_kwargs(a1='i1', a2='i2') \
|
|
.set_kwargs(a3='i3', a4='i4')
|
|
self.assertEqual(provider.kwargs, {'a3': 'i3', 'a4': 'i4'})
|
|
|
|
def test_clear_kwargs(self):
|
|
provider = providers.Resource(init_fn) \
|
|
.add_kwargs(a1='i1', a2='i2') \
|
|
.clear_kwargs()
|
|
self.assertEqual(provider.kwargs, {})
|
|
|
|
def test_call_overridden(self):
|
|
provider = providers.Resource(init_fn, 1)
|
|
overriding_provider1 = providers.Resource(init_fn, 2)
|
|
overriding_provider2 = providers.Resource(init_fn, 3)
|
|
|
|
provider.override(overriding_provider1)
|
|
provider.override(overriding_provider2)
|
|
|
|
instance1 = provider()
|
|
instance2 = provider()
|
|
|
|
self.assertIs(instance1, instance2)
|
|
self.assertEqual(instance1, ((3,), {}))
|
|
self.assertEqual(instance2, ((3,), {}))
|
|
|
|
def test_deepcopy(self):
|
|
provider = providers.Resource(init_fn, 1, 2, a3=3, a4=4)
|
|
|
|
provider_copy = providers.deepcopy(provider)
|
|
|
|
self.assertIsNot(provider, provider_copy)
|
|
self.assertEqual(provider.args, provider_copy.args)
|
|
self.assertEqual(provider.kwargs, provider_copy.kwargs)
|
|
self.assertIsInstance(provider, providers.Resource)
|
|
|
|
def test_deepcopy_initialized(self):
|
|
provider = providers.Resource(init_fn)
|
|
provider.init()
|
|
|
|
with self.assertRaises(errors.Error):
|
|
providers.deepcopy(provider)
|
|
|
|
def test_deepcopy_from_memo(self):
|
|
provider = providers.Resource(init_fn)
|
|
provider_copy_memo = providers.Resource(init_fn)
|
|
|
|
provider_copy = providers.deepcopy(
|
|
provider,
|
|
memo={id(provider): provider_copy_memo},
|
|
)
|
|
|
|
self.assertIs(provider_copy, provider_copy_memo)
|
|
|
|
def test_deepcopy_args(self):
|
|
provider = providers.Resource(init_fn)
|
|
dependent_provider1 = providers.Factory(list)
|
|
dependent_provider2 = providers.Factory(dict)
|
|
|
|
provider.add_args(dependent_provider1, dependent_provider2)
|
|
|
|
provider_copy = providers.deepcopy(provider)
|
|
dependent_provider_copy1 = provider_copy.args[0]
|
|
dependent_provider_copy2 = provider_copy.args[1]
|
|
|
|
self.assertNotEqual(provider.args, provider_copy.args)
|
|
|
|
self.assertIs(dependent_provider1.cls, dependent_provider_copy1.cls)
|
|
self.assertIsNot(dependent_provider1, dependent_provider_copy1)
|
|
|
|
self.assertIs(dependent_provider2.cls, dependent_provider_copy2.cls)
|
|
self.assertIsNot(dependent_provider2, dependent_provider_copy2)
|
|
|
|
def test_deepcopy_kwargs(self):
|
|
provider = providers.Resource(init_fn)
|
|
dependent_provider1 = providers.Factory(list)
|
|
dependent_provider2 = providers.Factory(dict)
|
|
|
|
provider.add_kwargs(d1=dependent_provider1, d2=dependent_provider2)
|
|
|
|
provider_copy = providers.deepcopy(provider)
|
|
dependent_provider_copy1 = provider_copy.kwargs['d1']
|
|
dependent_provider_copy2 = provider_copy.kwargs['d2']
|
|
|
|
self.assertNotEqual(provider.kwargs, provider_copy.kwargs)
|
|
|
|
self.assertIs(dependent_provider1.cls, dependent_provider_copy1.cls)
|
|
self.assertIsNot(dependent_provider1, dependent_provider_copy1)
|
|
|
|
self.assertIs(dependent_provider2.cls, dependent_provider_copy2.cls)
|
|
self.assertIsNot(dependent_provider2, dependent_provider_copy2)
|
|
|
|
def test_deepcopy_overridden(self):
|
|
provider = providers.Resource(init_fn)
|
|
object_provider = providers.Object(object())
|
|
|
|
provider.override(object_provider)
|
|
|
|
provider_copy = providers.deepcopy(provider)
|
|
object_provider_copy = provider_copy.overridden[0]
|
|
|
|
self.assertIsNot(provider, provider_copy)
|
|
self.assertEqual(provider.args, provider_copy.args)
|
|
self.assertIsInstance(provider, providers.Resource)
|
|
|
|
self.assertIsNot(object_provider, object_provider_copy)
|
|
self.assertIsInstance(object_provider_copy, providers.Object)
|
|
|
|
def test_deepcopy_with_sys_streams(self):
|
|
provider = providers.Resource(init_fn)
|
|
provider.add_args(sys.stdin, sys.stdout, sys.stderr)
|
|
|
|
provider_copy = providers.deepcopy(provider)
|
|
|
|
self.assertIsNot(provider, provider_copy)
|
|
self.assertIsInstance(provider_copy, providers.Resource)
|
|
self.assertIs(provider.args[0], sys.stdin)
|
|
self.assertIs(provider.args[1], sys.stdout)
|
|
self.assertIs(provider.args[2], sys.stderr)
|
|
|
|
def test_repr(self):
|
|
provider = providers.Resource(init_fn)
|
|
|
|
self.assertEqual(
|
|
repr(provider),
|
|
'<dependency_injector.providers.Resource({0}) at {1}>'.format(
|
|
repr(init_fn),
|
|
hex(id(provider)),
|
|
)
|
|
)
|
|
|
|
|
|
class AsyncResourceTest(AsyncTestCase):
|
|
|
|
def test_init_async_function(self):
|
|
resource = object()
|
|
|
|
async def _init():
|
|
await asyncio.sleep(0.001)
|
|
_init.counter += 1
|
|
return resource
|
|
_init.counter = 0
|
|
|
|
provider = providers.Resource(_init)
|
|
|
|
result1 = self._run(provider())
|
|
self.assertIs(result1, resource)
|
|
self.assertEqual(_init.counter, 1)
|
|
|
|
result2 = self._run(provider())
|
|
self.assertIs(result2, resource)
|
|
self.assertEqual(_init.counter, 1)
|
|
|
|
self._run(provider.shutdown())
|
|
|
|
def test_init_async_generator(self):
|
|
resource = object()
|
|
|
|
async def _init():
|
|
await asyncio.sleep(0.001)
|
|
_init.init_counter += 1
|
|
|
|
yield resource
|
|
|
|
await asyncio.sleep(0.001)
|
|
_init.shutdown_counter += 1
|
|
|
|
_init.init_counter = 0
|
|
_init.shutdown_counter = 0
|
|
|
|
provider = providers.Resource(_init)
|
|
|
|
result1 = self._run(provider())
|
|
self.assertIs(result1, resource)
|
|
self.assertEqual(_init.init_counter, 1)
|
|
self.assertEqual(_init.shutdown_counter, 0)
|
|
|
|
self._run(provider.shutdown())
|
|
self.assertEqual(_init.init_counter, 1)
|
|
self.assertEqual(_init.shutdown_counter, 1)
|
|
|
|
result2 = self._run(provider())
|
|
self.assertIs(result2, resource)
|
|
self.assertEqual(_init.init_counter, 2)
|
|
self.assertEqual(_init.shutdown_counter, 1)
|
|
|
|
self._run(provider.shutdown())
|
|
self.assertEqual(_init.init_counter, 2)
|
|
self.assertEqual(_init.shutdown_counter, 2)
|
|
|
|
def test_init_async_class(self):
|
|
resource = object()
|
|
|
|
class TestResource(resources.AsyncResource):
|
|
init_counter = 0
|
|
shutdown_counter = 0
|
|
|
|
async def init(self):
|
|
await asyncio.sleep(0.001)
|
|
self.__class__.init_counter += 1
|
|
return resource
|
|
|
|
async def shutdown(self, resource_):
|
|
await asyncio.sleep(0.001)
|
|
self.__class__.shutdown_counter += 1
|
|
assert resource_ is resource
|
|
|
|
provider = providers.Resource(TestResource)
|
|
|
|
result1 = self._run(provider())
|
|
self.assertIs(result1, resource)
|
|
self.assertEqual(TestResource.init_counter, 1)
|
|
self.assertEqual(TestResource.shutdown_counter, 0)
|
|
|
|
self._run(provider.shutdown())
|
|
self.assertEqual(TestResource.init_counter, 1)
|
|
self.assertEqual(TestResource.shutdown_counter, 1)
|
|
|
|
result2 = self._run(provider())
|
|
self.assertIs(result2, resource)
|
|
self.assertEqual(TestResource.init_counter, 2)
|
|
self.assertEqual(TestResource.shutdown_counter, 1)
|
|
|
|
self._run(provider.shutdown())
|
|
self.assertEqual(TestResource.init_counter, 2)
|
|
self.assertEqual(TestResource.shutdown_counter, 2)
|
|
|
|
def test_init_with_error(self):
|
|
async def _init():
|
|
raise RuntimeError()
|
|
|
|
provider = providers.Resource(_init)
|
|
|
|
future = provider()
|
|
self.assertTrue(provider.initialized)
|
|
self.assertTrue(provider.is_async_mode_enabled())
|
|
|
|
with self.assertRaises(RuntimeError):
|
|
self._run(future)
|
|
|
|
self.assertFalse(provider.initialized)
|
|
self.assertTrue(provider.is_async_mode_enabled())
|
|
|
|
def test_init_async_gen_with_error(self):
|
|
async def _init():
|
|
raise RuntimeError()
|
|
yield
|
|
|
|
provider = providers.Resource(_init)
|
|
|
|
future = provider()
|
|
self.assertTrue(provider.initialized)
|
|
self.assertTrue(provider.is_async_mode_enabled())
|
|
|
|
with self.assertRaises(RuntimeError):
|
|
self._run(future)
|
|
|
|
self.assertFalse(provider.initialized)
|
|
self.assertTrue(provider.is_async_mode_enabled())
|
|
|
|
def test_init_async_subclass_with_error(self):
|
|
class _Resource(resources.AsyncResource):
|
|
async def init(self):
|
|
raise RuntimeError()
|
|
|
|
async def shutdown(self, resource):
|
|
pass
|
|
|
|
provider = providers.Resource(_Resource)
|
|
|
|
future = provider()
|
|
self.assertTrue(provider.initialized)
|
|
self.assertTrue(provider.is_async_mode_enabled())
|
|
|
|
with self.assertRaises(RuntimeError):
|
|
self._run(future)
|
|
|
|
self.assertFalse(provider.initialized)
|
|
self.assertTrue(provider.is_async_mode_enabled())
|
|
|
|
def test_init_with_dependency_to_other_resource(self):
|
|
# See: https://github.com/ets-labs/python-dependency-injector/issues/361
|
|
async def init_db_connection(db_url: str):
|
|
await asyncio.sleep(0.001)
|
|
yield {'connection': 'ok', 'url': db_url}
|
|
|
|
async def init_user_session(db):
|
|
await asyncio.sleep(0.001)
|
|
yield {'session': 'ok', 'db': db}
|
|
|
|
class Container(containers.DeclarativeContainer):
|
|
config = providers.Configuration()
|
|
|
|
db_connection = providers.Resource(
|
|
init_db_connection,
|
|
db_url=config.db_url,
|
|
)
|
|
|
|
user_session = providers.Resource(
|
|
init_user_session,
|
|
db=db_connection
|
|
)
|
|
|
|
async def main():
|
|
container = Container(config={'db_url': 'postgres://...'})
|
|
try:
|
|
return await container.user_session()
|
|
finally:
|
|
await container.shutdown_resources()
|
|
|
|
result = self._run(main())
|
|
|
|
self.assertEqual(
|
|
result,
|
|
{'session': 'ok', 'db': {'connection': 'ok', 'url': 'postgres://...'}},
|
|
)
|
|
|
|
def test_init_and_shutdown_methods(self):
|
|
async def _init():
|
|
await asyncio.sleep(0.001)
|
|
_init.init_counter += 1
|
|
|
|
yield
|
|
|
|
await asyncio.sleep(0.001)
|
|
_init.shutdown_counter += 1
|
|
|
|
_init.init_counter = 0
|
|
_init.shutdown_counter = 0
|
|
|
|
provider = providers.Resource(_init)
|
|
|
|
self._run(provider.init())
|
|
self.assertEqual(_init.init_counter, 1)
|
|
self.assertEqual(_init.shutdown_counter, 0)
|
|
|
|
self._run(provider.shutdown())
|
|
self.assertEqual(_init.init_counter, 1)
|
|
self.assertEqual(_init.shutdown_counter, 1)
|
|
|
|
self._run(provider.init())
|
|
self.assertEqual(_init.init_counter, 2)
|
|
self.assertEqual(_init.shutdown_counter, 1)
|
|
|
|
self._run(provider.shutdown())
|
|
self.assertEqual(_init.init_counter, 2)
|
|
self.assertEqual(_init.shutdown_counter, 2)
|
|
|
|
def test_shutdown_of_not_initialized(self):
|
|
async def _init():
|
|
yield
|
|
|
|
provider = providers.Resource(_init)
|
|
provider.enable_async_mode()
|
|
|
|
result = self._run(provider.shutdown())
|
|
self.assertIsNone(result)
|
|
|
|
def test_concurrent_init(self):
|
|
resource = object()
|
|
|
|
async def _init():
|
|
await asyncio.sleep(0.001)
|
|
_init.counter += 1
|
|
return resource
|
|
_init.counter = 0
|
|
|
|
provider = providers.Resource(_init)
|
|
|
|
result1, result2 = self._run(
|
|
asyncio.gather(
|
|
provider(),
|
|
provider()
|
|
),
|
|
)
|
|
|
|
self.assertIs(result1, resource)
|
|
self.assertEqual(_init.counter, 1)
|
|
|
|
self.assertIs(result2, resource)
|
|
self.assertEqual(_init.counter, 1)
|