"""Dependency injector creational providers unittests.""" import unittest2 as unittest from dependency_injector import providers, injections, utils, errors class Example(object): """Example class for Factory provider tests.""" def __init__(self, init_arg1=None, init_arg2=None, init_arg3=None, init_arg4=None): """Initializer.""" self.init_arg1 = init_arg1 self.init_arg2 = init_arg2 self.init_arg3 = init_arg3 self.init_arg4 = init_arg4 self.attribute1 = None self.attribute2 = None class FactoryTests(unittest.TestCase): """Factory test cases.""" def test_is_provider(self): """Test `is_provider` check.""" self.assertTrue(utils.is_provider(providers.Factory(Example))) def test_init_with_callable(self): """Test creation of provider with a callable.""" self.assertTrue(providers.Factory(credits)) def test_init_with_not_callable(self): """Test creation of provider with not a callable.""" self.assertRaises(errors.Error, providers.Factory, 123) def test_init_with_valid_provided_type(self): """Test creation with not valid provided type.""" class ExampleProvider(providers.Factory): """Example provider.""" provided_type = Example example_provider = ExampleProvider(Example, 1, 2) self.assertIsInstance(example_provider(), Example) def test_init_with_valid_provided_subtype(self): """Test creation with not valid provided type.""" class ExampleProvider(providers.Factory): """Example provider.""" provided_type = Example class NewExampe(Example): """Example class subclass.""" example_provider = ExampleProvider(NewExampe, 1, 2) self.assertIsInstance(example_provider(), NewExampe) def test_init_with_invalid_provided_type(self): """Test creation with not valid provided type.""" class ExampleProvider(providers.Factory): """Example provider.""" provided_type = Example with self.assertRaises(errors.Error): ExampleProvider(list) def test_call(self): """Test call.""" provider = providers.Factory(Example) instance1 = provider() instance2 = provider() self.assertIsNot(instance1, instance2) self.assertIsInstance(instance1, Example) self.assertIsInstance(instance2, Example) def test_call_with_init_positional_args(self): """Test call with init positional args.""" provider = providers.Factory(Example, 'i1', 'i2') instance1 = provider() instance2 = provider() self.assertEqual(instance1.init_arg1, 'i1') self.assertEqual(instance1.init_arg2, 'i2') self.assertEqual(instance2.init_arg1, 'i1') self.assertEqual(instance2.init_arg2, 'i2') self.assertIsNot(instance1, instance2) self.assertIsInstance(instance1, Example) self.assertIsInstance(instance2, Example) def test_call_with_init_keyword_args(self): """Test call with init keyword args.""" provider = providers.Factory(Example, init_arg1='i1', init_arg2='i2') instance1 = provider() instance2 = provider() self.assertEqual(instance1.init_arg1, 'i1') self.assertEqual(instance1.init_arg2, 'i2') self.assertEqual(instance2.init_arg1, 'i1') self.assertEqual(instance2.init_arg2, 'i2') self.assertIsNot(instance1, instance2) self.assertIsInstance(instance1, Example) self.assertIsInstance(instance2, Example) def test_call_with_init_positional_and_keyword_args(self): """Test call with init positional and keyword args.""" provider = providers.Factory(Example, 'i1', init_arg2='i2') instance1 = provider() instance2 = provider() self.assertEqual(instance1.init_arg1, 'i1') self.assertEqual(instance1.init_arg2, 'i2') self.assertEqual(instance2.init_arg1, 'i1') self.assertEqual(instance2.init_arg2, 'i2') self.assertIsNot(instance1, instance2) self.assertIsInstance(instance1, Example) self.assertIsInstance(instance2, Example) def test_call_with_attributes(self): """Test call with attribute injections.""" provider = providers.Factory(Example) provider.add_attributes(attribute1='a1', attribute2='a2') instance1 = provider() instance2 = provider() self.assertEqual(instance1.attribute1, 'a1') self.assertEqual(instance1.attribute2, 'a2') self.assertEqual(instance2.attribute1, 'a1') self.assertEqual(instance2.attribute2, 'a2') self.assertIsNot(instance1, instance2) self.assertIsInstance(instance1, Example) self.assertIsInstance(instance2, Example) def test_call_with_context_args(self): """Test call with context args.""" provider = providers.Factory(Example, 11, 22) instance = provider(33, 44) self.assertEqual(instance.init_arg1, 11) self.assertEqual(instance.init_arg2, 22) self.assertEqual(instance.init_arg3, 33) self.assertEqual(instance.init_arg4, 44) def test_call_with_context_kwargs(self): """Test call with context kwargs.""" provider = providers.Factory(Example, init_arg1=1) instance1 = provider(init_arg2=22) self.assertEqual(instance1.init_arg1, 1) self.assertEqual(instance1.init_arg2, 22) instance2 = provider(init_arg1=11, init_arg2=22) self.assertEqual(instance2.init_arg1, 11) self.assertEqual(instance2.init_arg2, 22) def test_call_with_context_args_and_kwargs(self): """Test call with context args and kwargs.""" provider = providers.Factory(Example, 11) instance = provider(22, init_arg3=33, init_arg4=44) self.assertEqual(instance.init_arg1, 11) self.assertEqual(instance.init_arg2, 22) self.assertEqual(instance.init_arg3, 33) self.assertEqual(instance.init_arg4, 44) def test_fluent_interface(self): """Test injections definition with fluent interface.""" provider = providers.Factory(Example) \ .add_args(1, 2) \ .add_kwargs(init_arg3=3, init_arg4=4) \ .add_attributes(attribute1=5, attribute2=6) instance = provider() self.assertEqual(instance.init_arg1, 1) self.assertEqual(instance.init_arg2, 2) self.assertEqual(instance.init_arg3, 3) self.assertEqual(instance.init_arg4, 4) self.assertEqual(instance.attribute1, 5) self.assertEqual(instance.attribute2, 6) def test_call_overridden(self): """Test call on overridden provider.""" provider = providers.Factory(Example) overriding_provider1 = providers.Factory(dict) overriding_provider2 = providers.Factory(list) provider.override(overriding_provider1) provider.override(overriding_provider2) instance1 = provider() instance2 = provider() self.assertIsNot(instance1, instance2) self.assertIsInstance(instance1, list) self.assertIsInstance(instance2, list) def test_repr(self): """Test representation of provider.""" provider = providers.Factory(Example) self.assertEqual(repr(provider), ''.format( repr(Example), hex(id(provider)))) class DelegatedFactoryTests(unittest.TestCase): """DelegatedFactory test cases.""" def test_inheritance(self): """Test inheritance.""" self.assertIsInstance(providers.DelegatedFactory(object), providers.Factory) def test_is_provider(self): """Test is_provider.""" self.assertTrue(utils.is_provider(providers.DelegatedFactory(object))) def test_is_delegated_provider(self): """Test is_delegated_provider.""" provider = providers.DelegatedFactory(object) self.assertIs(provider.provide_injection(), provider) class SingletonTests(unittest.TestCase): """Singleton test cases.""" def test_is_provider(self): """Test `is_provider` check.""" self.assertTrue(utils.is_provider(providers.Singleton(Example))) def test_init_with_callable(self): """Test creation of provider with a callable.""" self.assertTrue(providers.Singleton(credits)) def test_init_with_not_callable(self): """Test creation of provider with not a callable.""" self.assertRaises(errors.Error, providers.Singleton, 123) def test_init_with_valid_provided_type(self): """Test creation with not valid provided type.""" class ExampleProvider(providers.Singleton): """Example provider.""" provided_type = Example example_provider = ExampleProvider(Example, 1, 2) self.assertIsInstance(example_provider(), Example) def test_init_with_valid_provided_subtype(self): """Test creation with not valid provided type.""" class ExampleProvider(providers.Singleton): """Example provider.""" provided_type = Example class NewExampe(Example): """Example class subclass.""" example_provider = ExampleProvider(NewExampe, 1, 2) self.assertIsInstance(example_provider(), NewExampe) def test_init_with_invalid_provided_type(self): """Test creation with not valid provided type.""" class ExampleProvider(providers.Singleton): """Example provider.""" provided_type = Example with self.assertRaises(errors.Error): ExampleProvider(list) def test_call(self): """Test getting of instances.""" provider = providers.Singleton(Example) instance1 = provider() instance2 = provider() self.assertIs(instance1, instance2) self.assertIsInstance(instance1, Example) self.assertIsInstance(instance2, Example) def test_call_with_init_positional_args(self): """Test getting of instances with init positional args.""" provider = providers.Singleton(Example, 'i1', 'i2') instance1 = provider() instance2 = provider() self.assertEqual(instance1.init_arg1, 'i1') self.assertEqual(instance1.init_arg2, 'i2') self.assertEqual(instance2.init_arg1, 'i1') self.assertEqual(instance2.init_arg2, 'i2') self.assertIs(instance1, instance2) self.assertIsInstance(instance1, Example) self.assertIsInstance(instance2, Example) def test_call_with_init_keyword_args(self): """Test getting of instances with init keyword args.""" provider = providers.Singleton(Example, init_arg1='i1', init_arg2='i2') instance1 = provider() instance2 = provider() self.assertEqual(instance1.init_arg1, 'i1') self.assertEqual(instance1.init_arg2, 'i2') self.assertEqual(instance2.init_arg1, 'i1') self.assertEqual(instance2.init_arg2, 'i2') self.assertIs(instance1, instance2) self.assertIsInstance(instance1, Example) self.assertIsInstance(instance2, Example) def test_call_with_init_positional_and_keyword_args(self): """Test getting of instances with init positional and keyword args.""" provider = providers.Singleton(Example, 'i1', init_arg2='i2') instance1 = provider() instance2 = provider() self.assertEqual(instance1.init_arg1, 'i1') self.assertEqual(instance1.init_arg2, 'i2') self.assertEqual(instance2.init_arg1, 'i1') self.assertEqual(instance2.init_arg2, 'i2') self.assertIs(instance1, instance2) self.assertIsInstance(instance1, Example) self.assertIsInstance(instance2, Example) def test_call_with_attributes(self): """Test getting of instances with attribute injections.""" provider = providers.Singleton(Example) provider.add_attributes(attribute1='a1', attribute2='a2') instance1 = provider() instance2 = provider() self.assertEqual(instance1.attribute1, 'a1') self.assertEqual(instance1.attribute2, 'a2') self.assertEqual(instance2.attribute1, 'a1') self.assertEqual(instance2.attribute2, 'a2') self.assertIs(instance1, instance2) self.assertIsInstance(instance1, Example) self.assertIsInstance(instance2, Example) def test_call_with_context_args(self): """Test getting of instances with context args.""" provider = providers.Singleton(Example) instance = provider(11, 22) self.assertEqual(instance.init_arg1, 11) self.assertEqual(instance.init_arg2, 22) def test_call_with_context_kwargs(self): """Test getting of instances with context kwargs.""" provider = providers.Singleton(Example, init_arg1=1) instance1 = provider(init_arg2=22) self.assertEqual(instance1.init_arg1, 1) self.assertEqual(instance1.init_arg2, 22) # Instance is created earlier instance1 = provider(init_arg1=11, init_arg2=22) self.assertEqual(instance1.init_arg1, 1) self.assertEqual(instance1.init_arg2, 22) def test_call_with_context_args_and_kwargs(self): """Test getting of instances with context args and kwargs.""" provider = providers.Singleton(Example, 11) instance = provider(22, init_arg3=33, init_arg4=44) self.assertEqual(instance.init_arg1, 11) self.assertEqual(instance.init_arg2, 22) self.assertEqual(instance.init_arg3, 33) self.assertEqual(instance.init_arg4, 44) def test_fluent_interface(self): """Test injections definition with fluent interface.""" provider = providers.Singleton(Example) \ .add_args(1, 2) \ .add_kwargs(init_arg3=3, init_arg4=4) \ .add_attributes(attribute1=5, attribute2=6) instance = provider() self.assertEqual(instance.init_arg1, 1) self.assertEqual(instance.init_arg2, 2) self.assertEqual(instance.init_arg3, 3) self.assertEqual(instance.init_arg4, 4) self.assertEqual(instance.attribute1, 5) self.assertEqual(instance.attribute2, 6) def test_call_overridden(self): """Test getting of instances on overridden provider.""" provider = providers.Singleton(Example) overriding_provider1 = providers.Singleton(dict) overriding_provider2 = providers.Singleton(object) provider.override(overriding_provider1) provider.override(overriding_provider2) instance1 = provider() instance2 = provider() self.assertIs(instance1, instance2) self.assertIsInstance(instance1, object) self.assertIsInstance(instance2, object) def test_reset(self): """Test creation and reset of single object.""" provider = providers.Singleton(object) instance1 = provider() self.assertIsInstance(instance1, object) provider.reset() instance2 = provider() self.assertIsInstance(instance1, object) self.assertIsNot(instance1, instance2) def test_repr(self): """Test representation of provider.""" provider = providers.Singleton(Example) self.assertEqual(repr(provider), ''.format( repr(Example), hex(id(provider)))) class DelegatedSingletonTests(unittest.TestCase): """DelegatedSingleton test cases.""" def test_inheritance(self): """Test inheritance.""" self.assertIsInstance(providers.DelegatedSingleton(object), providers.Singleton) def test_is_provider(self): """Test is_provider.""" self.assertTrue(utils.is_provider( providers.DelegatedSingleton(object))) def test_is_delegated_provider(self): """Test is_delegated_provider.""" provider = providers.DelegatedSingleton(object) self.assertIs(provider.provide_injection(), provider) class ThreadLocalSingletonTests(unittest.TestCase): """ThreadLocalSingleton test cases.""" def test_is_provider(self): """Test `is_provider` check.""" self.assertTrue( utils.is_provider(providers.ThreadLocalSingleton(Example))) def test_init_with_callable(self): """Test creation of provider with a callable.""" self.assertTrue(providers.ThreadLocalSingleton(credits)) def test_init_with_not_callable(self): """Test creation of provider with not a callable.""" self.assertRaises(errors.Error, providers.ThreadLocalSingleton, 123) def test_init_with_valid_provided_type(self): """Test creation with not valid provided type.""" class ExampleProvider(providers.ThreadLocalSingleton): """Example provider.""" provided_type = Example example_provider = ExampleProvider(Example, 1, 2) self.assertIsInstance(example_provider(), Example) def test_init_with_valid_provided_subtype(self): """Test creation with not valid provided type.""" class ExampleProvider(providers.ThreadLocalSingleton): """Example provider.""" provided_type = Example class NewExampe(Example): """Example class subclass.""" example_provider = ExampleProvider(NewExampe, 1, 2) self.assertIsInstance(example_provider(), NewExampe) def test_init_with_invalid_provided_type(self): """Test creation with not valid provided type.""" class ExampleProvider(providers.ThreadLocalSingleton): """Example provider.""" provided_type = Example with self.assertRaises(errors.Error): ExampleProvider(list) def test_call(self): """Test getting of instances.""" provider = providers.ThreadLocalSingleton(Example) instance1 = provider() instance2 = provider() self.assertIs(instance1, instance2) self.assertIsInstance(instance1, Example) self.assertIsInstance(instance2, Example) def test_call_with_init_positional_args(self): """Test getting of instances with init positional args.""" provider = providers.ThreadLocalSingleton(Example, 'i1', 'i2') instance1 = provider() instance2 = provider() self.assertEqual(instance1.init_arg1, 'i1') self.assertEqual(instance1.init_arg2, 'i2') self.assertEqual(instance2.init_arg1, 'i1') self.assertEqual(instance2.init_arg2, 'i2') self.assertIs(instance1, instance2) self.assertIsInstance(instance1, Example) self.assertIsInstance(instance2, Example) def test_call_with_init_keyword_args(self): """Test getting of instances with init keyword args.""" provider = providers.ThreadLocalSingleton(Example, init_arg1='i1', init_arg2='i2') instance1 = provider() instance2 = provider() self.assertEqual(instance1.init_arg1, 'i1') self.assertEqual(instance1.init_arg2, 'i2') self.assertEqual(instance2.init_arg1, 'i1') self.assertEqual(instance2.init_arg2, 'i2') self.assertIs(instance1, instance2) self.assertIsInstance(instance1, Example) self.assertIsInstance(instance2, Example) def test_call_with_init_positional_and_keyword_args(self): """Test getting of instances with init positional and keyword args.""" provider = providers.ThreadLocalSingleton(Example, 'i1', init_arg2='i2') instance1 = provider() instance2 = provider() self.assertEqual(instance1.init_arg1, 'i1') self.assertEqual(instance1.init_arg2, 'i2') self.assertEqual(instance2.init_arg1, 'i1') self.assertEqual(instance2.init_arg2, 'i2') self.assertIs(instance1, instance2) self.assertIsInstance(instance1, Example) self.assertIsInstance(instance2, Example) def test_call_with_attributes(self): """Test getting of instances with attribute injections.""" provider = providers.ThreadLocalSingleton(Example) provider.add_attributes(attribute1='a1', attribute2='a2') instance1 = provider() instance2 = provider() self.assertEqual(instance1.attribute1, 'a1') self.assertEqual(instance1.attribute2, 'a2') self.assertEqual(instance2.attribute1, 'a1') self.assertEqual(instance2.attribute2, 'a2') self.assertIs(instance1, instance2) self.assertIsInstance(instance1, Example) self.assertIsInstance(instance2, Example) def test_call_with_context_args(self): """Test getting of instances with context args.""" provider = providers.ThreadLocalSingleton(Example) instance = provider(11, 22) self.assertEqual(instance.init_arg1, 11) self.assertEqual(instance.init_arg2, 22) def test_call_with_context_kwargs(self): """Test getting of instances with context kwargs.""" provider = providers.ThreadLocalSingleton(Example, init_arg1=1) instance1 = provider(init_arg2=22) self.assertEqual(instance1.init_arg1, 1) self.assertEqual(instance1.init_arg2, 22) # Instance is created earlier instance1 = provider(init_arg1=11, init_arg2=22) self.assertEqual(instance1.init_arg1, 1) self.assertEqual(instance1.init_arg2, 22) def test_call_with_context_args_and_kwargs(self): """Test getting of instances with context args and kwargs.""" provider = providers.ThreadLocalSingleton(Example, 11) instance = provider(22, init_arg3=33, init_arg4=44) self.assertEqual(instance.init_arg1, 11) self.assertEqual(instance.init_arg2, 22) self.assertEqual(instance.init_arg3, 33) self.assertEqual(instance.init_arg4, 44) def test_fluent_interface(self): """Test injections definition with fluent interface.""" provider = providers.ThreadLocalSingleton(Example) \ .add_args(1, 2) \ .add_kwargs(init_arg3=3, init_arg4=4) \ .add_attributes(attribute1=5, attribute2=6) instance = provider() self.assertEqual(instance.init_arg1, 1) self.assertEqual(instance.init_arg2, 2) self.assertEqual(instance.init_arg3, 3) self.assertEqual(instance.init_arg4, 4) self.assertEqual(instance.attribute1, 5) self.assertEqual(instance.attribute2, 6) def test_call_overridden(self): """Test getting of instances on overridden provider.""" provider = providers.ThreadLocalSingleton(Example) overriding_provider1 = providers.ThreadLocalSingleton(dict) overriding_provider2 = providers.ThreadLocalSingleton(object) provider.override(overriding_provider1) provider.override(overriding_provider2) instance1 = provider() instance2 = provider() self.assertIs(instance1, instance2) self.assertIsInstance(instance1, object) self.assertIsInstance(instance2, object) def test_reset(self): """Test creation and reset of single object.""" provider = providers.ThreadLocalSingleton(object) instance1 = provider() self.assertIsInstance(instance1, object) provider.reset() instance2 = provider() self.assertIsInstance(instance1, object) self.assertIsNot(instance1, instance2) def test_repr(self): """Test representation of provider.""" provider = providers.ThreadLocalSingleton(Example) self.assertEqual(repr(provider), ''.format( repr(Example), hex(id(provider)))) class DelegatedThreadLocalSingletonTests(unittest.TestCase): """DelegatedThreadLocalSingleton test cases.""" def test_inheritance(self): """Test inheritance.""" self.assertIsInstance(providers.DelegatedThreadLocalSingleton(object), providers.ThreadLocalSingleton) def test_is_provider(self): """Test is_provider.""" self.assertTrue(utils.is_provider( providers.DelegatedThreadLocalSingleton(object))) def test_is_delegated_provider(self): """Test is_delegated_provider.""" provider = providers.DelegatedThreadLocalSingleton(object) self.assertIs(provider.provide_injection(), provider) class FactoryAsDecoratorTests(unittest.TestCase): """Factory as decorator tests.""" def test_decoration(self): """Test decoration of some class with Factory provider.""" @providers.Factory class AuthService(object): """Auth service.""" @providers.Factory @injections.inject(auth_service=AuthService) class UsersService(object): """Users service.""" def __init__(self, auth_service): """Initializer.""" self.auth_service = auth_service users_service = UsersService() self.assertIsInstance(users_service, UsersService.cls) self.assertIsInstance(users_service.auth_service, AuthService.cls) def test_decoration_and_overriding(self): """Test decoration of some class with Factory provider.""" @providers.Factory class AuthService(object): """Auth service.""" @providers.override(AuthService) @providers.Factory class ExtAuthService(AuthService.cls): """Extended auth service.""" auth_service = AuthService() self.assertIsInstance(auth_service, ExtAuthService.cls)