python-dependency-injector/tests/unit/providers/test_configuration_py2_py3.py

1580 lines
56 KiB
Python
Raw Normal View History

2016-12-02 14:53:37 +03:00
"""Dependency injector config providers unit tests."""
2020-06-25 04:04:30 +03:00
import contextlib
import decimal
2020-06-23 23:46:24 +03:00
import os
2020-06-25 04:23:05 +03:00
import sys
2020-06-23 23:46:24 +03:00
import tempfile
import unittest
2016-12-02 14:53:37 +03:00
2020-06-25 04:04:30 +03:00
from dependency_injector import containers, providers, errors
try:
import yaml
except ImportError:
yaml = None
2016-12-02 14:53:37 +03:00
try:
import pydantic
except ImportError:
pydantic = None
2016-12-02 14:53:37 +03:00
class ConfigTests(unittest.TestCase):
def setUp(self):
2021-10-01 03:09:42 +03:00
self.config = providers.Configuration(name="config")
2016-12-02 14:53:37 +03:00
def tearDown(self):
del self.config
Schemas (#429) * 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>
2021-03-20 20:16:51 +03:00
def test_init_optional(self):
provider = providers.Configuration()
2021-10-01 03:09:42 +03:00
provider.set_name("myconfig")
provider.set_default({"foo": "bar"})
Schemas (#429) * 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>
2021-03-20 20:16:51 +03:00
provider.set_strict(True)
2021-10-01 03:09:42 +03:00
self.assertEqual(provider.get_name(), "myconfig")
self.assertEqual(provider.get_default(), {"foo": "bar"})
Schemas (#429) * 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>
2021-03-20 20:16:51 +03:00
self.assertTrue(provider.get_strict())
def test_set_name_returns_self(self):
provider = providers.Configuration()
2021-10-01 03:09:42 +03:00
self.assertIs(provider.set_name("myconfig"), provider)
Schemas (#429) * 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>
2021-03-20 20:16:51 +03:00
def test_set_default_returns_self(self):
provider = providers.Configuration()
self.assertIs(provider.set_default({}), provider)
def test_set_strict_returns_self(self):
provider = providers.Configuration()
self.assertIs(provider.set_strict(True), provider)
def test_default_name(self):
config = providers.Configuration()
2021-10-01 03:09:42 +03:00
self.assertEqual(config.get_name(), "config")
2016-12-02 14:53:37 +03:00
def test_providers_are_providers(self):
self.assertTrue(providers.is_provider(self.config.a))
self.assertTrue(providers.is_provider(self.config.a.b))
self.assertTrue(providers.is_provider(self.config.a.b.c))
self.assertTrue(providers.is_provider(self.config.a.b.d))
def test_providers_are_not_delegates(self):
self.assertFalse(providers.is_delegated(self.config.a))
self.assertFalse(providers.is_delegated(self.config.a.b))
self.assertFalse(providers.is_delegated(self.config.a.b.c))
self.assertFalse(providers.is_delegated(self.config.a.b.d))
def test_providers_identity(self):
self.assertIs(self.config.a, self.config.a)
self.assertIs(self.config.a.b, self.config.a.b)
self.assertIs(self.config.a.b.c, self.config.a.b.c)
self.assertIs(self.config.a.b.d, self.config.a.b.d)
def test_get_name(self):
2021-10-01 03:09:42 +03:00
self.assertEqual(self.config.a.b.c.get_name(), "config.a.b.c")
2016-12-02 14:53:37 +03:00
def test_providers_value_setting(self):
a = self.config.a
ab = self.config.a.b
abc = self.config.a.b.c
abd = self.config.a.b.d
2021-10-01 03:09:42 +03:00
self.config.update({"a": {"b": {"c": 1, "d": 2}}})
2016-12-02 14:53:37 +03:00
2021-10-01 03:09:42 +03:00
self.assertEqual(a(), {"b": {"c": 1, "d": 2}})
self.assertEqual(ab(), {"c": 1, "d": 2})
2016-12-02 14:53:37 +03:00
self.assertEqual(abc(), 1)
self.assertEqual(abd(), 2)
2016-12-02 20:29:17 +03:00
def test_providers_with_already_set_value(self):
2021-10-01 03:09:42 +03:00
self.config.update({"a": {"b": {"c": 1, "d": 2}}})
2016-12-02 20:29:17 +03:00
a = self.config.a
ab = self.config.a.b
abc = self.config.a.b.c
abd = self.config.a.b.d
2021-10-01 03:09:42 +03:00
self.assertEqual(a(), {"b": {"c": 1, "d": 2}})
self.assertEqual(ab(), {"c": 1, "d": 2})
2016-12-02 20:29:17 +03:00
self.assertEqual(abc(), 1)
self.assertEqual(abd(), 2)
def test_as_int(self):
value_provider = providers.Callable(lambda value: value, self.config.test.as_int())
2021-10-01 03:09:42 +03:00
self.config.from_dict({"test": "123"})
value = value_provider()
self.assertEqual(value, 123)
def test_as_float(self):
value_provider = providers.Callable(lambda value: value, self.config.test.as_float())
2021-10-01 03:09:42 +03:00
self.config.from_dict({"test": "123.123"})
value = value_provider()
self.assertEqual(value, 123.123)
def test_as_(self):
value_provider = providers.Callable(
lambda value: value,
self.config.test.as_(decimal.Decimal),
)
2021-10-01 03:09:42 +03:00
self.config.from_dict({"test": "123.123"})
value = value_provider()
2021-10-01 03:09:42 +03:00
self.assertEqual(value, decimal.Decimal("123.123"))
2021-10-01 03:09:42 +03:00
@unittest.skipIf(sys.version_info[:2] == (2, 7), "Python 2.7 does not support this assert")
def test_required(self):
provider = providers.Callable(
lambda value: value,
self.config.a.required(),
)
2021-10-01 03:09:42 +03:00
with self.assertRaisesRegex(errors.Error, "Undefined configuration option \"config.a\""):
provider()
def test_required_defined_none(self):
provider = providers.Callable(
lambda value: value,
self.config.a.required(),
)
2021-10-01 03:09:42 +03:00
self.config.from_dict({"a": None})
self.assertIsNone(provider())
def test_required_no_side_effect(self):
_ = providers.Callable(
lambda value: value,
self.config.a.required(),
)
self.assertIsNone(self.config.a())
def test_required_as_(self):
provider = providers.List(
self.config.int_test.required().as_int(),
self.config.float_test.required().as_float(),
self.config._as_test.required().as_(decimal.Decimal),
)
2021-10-01 03:09:42 +03:00
self.config.from_dict({"int_test": "1", "float_test": "2.0", "_as_test": "3.0"})
2021-10-01 03:09:42 +03:00
self.assertEqual(provider(), [1, 2.0, decimal.Decimal("3.0")])
2018-01-24 20:58:03 +03:00
def test_providers_value_override(self):
a = self.config.a
ab = self.config.a.b
abc = self.config.a.b.c
abd = self.config.a.b.d
2021-10-01 03:09:42 +03:00
self.config.override({"a": {"b": {"c": 1, "d": 2}}})
2018-01-24 20:58:03 +03:00
2021-10-01 03:09:42 +03:00
self.assertEqual(a(), {"b": {"c": 1, "d": 2}})
self.assertEqual(ab(), {"c": 1, "d": 2})
2018-01-24 20:58:03 +03:00
self.assertEqual(abc(), 1)
self.assertEqual(abd(), 2)
def test_configuration_option_override_and_reset_override(self):
# Bug: https://github.com/ets-labs/python-dependency-injector/issues/319
2021-10-01 03:09:42 +03:00
self.config.from_dict({"a": {"b": {"c": 1}}})
self.assertEqual(self.config.a.b.c(), 1)
2021-10-01 03:09:42 +03:00
with self.config.set("a.b.c", "xxx"):
self.assertEqual(self.config.a.b.c(), "xxx")
self.assertEqual(self.config.a.b.c(), 1)
2021-10-01 03:09:42 +03:00
with self.config.a.b.c.override("yyy"):
self.assertEqual(self.config.a.b.c(), "yyy")
self.assertEqual(self.config.a.b.c(), 1)
2018-01-24 20:58:03 +03:00
def test_providers_with_already_overridden_value(self):
2021-10-01 03:09:42 +03:00
self.config.override({"a": {"b": {"c": 1, "d": 2}}})
2018-01-24 20:58:03 +03:00
a = self.config.a
ab = self.config.a.b
abc = self.config.a.b.c
abd = self.config.a.b.d
2021-10-01 03:09:42 +03:00
self.assertEqual(a(), {"b": {"c": 1, "d": 2}})
self.assertEqual(ab(), {"c": 1, "d": 2})
2018-01-24 20:58:03 +03:00
self.assertEqual(abc(), 1)
self.assertEqual(abd(), 2)
def test_providers_with_default_value(self):
self.config = providers.Configuration(
2021-10-01 03:09:42 +03:00
name="config", default={"a": {"b": {"c": 1, "d": 2}}})
a = self.config.a
ab = self.config.a.b
abc = self.config.a.b.c
abd = self.config.a.b.d
2021-10-01 03:09:42 +03:00
self.assertEqual(a(), {"b": {"c": 1, "d": 2}})
self.assertEqual(ab(), {"c": 1, "d": 2})
self.assertEqual(abc(), 1)
self.assertEqual(abd(), 2)
2018-01-24 20:58:03 +03:00
def test_providers_with_default_value_overriding(self):
self.config = providers.Configuration(
2021-10-01 03:09:42 +03:00
name="config", default={"a": {"b": {"c": 1, "d": 2}}})
2018-01-24 20:58:03 +03:00
2021-10-01 03:09:42 +03:00
self.assertEqual(self.config.a(), {"b": {"c": 1, "d": 2}})
self.assertEqual(self.config.a.b(), {"c": 1, "d": 2})
2018-01-24 20:58:03 +03:00
self.assertEqual(self.config.a.b.c(), 1)
self.assertEqual(self.config.a.b.d(), 2)
2021-10-01 03:09:42 +03:00
self.config.override({"a": {"b": {"c": 3, "d": 4}}})
self.assertEqual(self.config.a(), {"b": {"c": 3, "d": 4}})
self.assertEqual(self.config.a.b(), {"c": 3, "d": 4})
2018-01-24 20:58:03 +03:00
self.assertEqual(self.config.a.b.c(), 3)
self.assertEqual(self.config.a.b.d(), 4)
self.config.reset_override()
2021-10-01 03:09:42 +03:00
self.assertEqual(self.config.a(), {"b": {"c": 1, "d": 2}})
self.assertEqual(self.config.a.b(), {"c": 1, "d": 2})
2018-01-24 20:58:03 +03:00
self.assertEqual(self.config.a.b.c(), 1)
self.assertEqual(self.config.a.b.d(), 2)
2016-12-02 14:53:37 +03:00
def test_value_of_undefined_option(self):
self.assertIsNone(self.config.a())
2021-10-01 03:09:42 +03:00
@unittest.skipIf(sys.version_info[:2] == (2, 7), "Python 2.7 does not support this assert")
def test_value_of_undefined_option_in_strict_mode(self):
self.config = providers.Configuration(strict=True)
2021-10-01 03:09:42 +03:00
with self.assertRaisesRegex(errors.Error, "Undefined configuration option \"config.a\""):
self.config.a()
2021-10-01 03:09:42 +03:00
@unittest.skipIf(sys.version_info[:2] == (2, 7), "Python 2.7 does not support this assert")
def test_value_of_undefined_option_with_root_none_in_strict_mode(self):
self.config = providers.Configuration(strict=True)
self.config.override(None)
2021-10-01 03:09:42 +03:00
with self.assertRaisesRegex(errors.Error, "Undefined configuration option \"config.a\""):
self.config.a()
def test_value_of_defined_none_option_in_strict_mode(self):
self.config = providers.Configuration(strict=True)
2021-10-01 03:09:42 +03:00
self.config.from_dict({"a": None})
self.assertIsNone(self.config.a())
def test_getting_of_special_attributes(self):
with self.assertRaises(AttributeError):
self.config.__name__
def test_getting_of_special_attributes_from_child(self):
a = self.config.a
with self.assertRaises(AttributeError):
a.__name__
def test_context_manager_alias(self):
class Container(containers.DeclarativeContainer):
config = providers.Configuration()
container = Container()
with container.config as cfg:
2021-10-01 03:09:42 +03:00
cfg.override({"foo": "foo", "bar": "bar"})
2021-10-01 03:09:42 +03:00
self.assertEqual(container.config(), {"foo": "foo", "bar": "bar"})
self.assertEqual(cfg(), {"foo": "foo", "bar": "bar"})
self.assertIs(container.config, cfg)
def test_option_context_manager_alias(self):
class Container(containers.DeclarativeContainer):
config = providers.Configuration()
container = Container()
with container.config.option as opt:
2021-10-01 03:09:42 +03:00
opt.override({"foo": "foo", "bar": "bar"})
2021-10-01 03:09:42 +03:00
self.assertEqual(container.config(), {"option": {"foo": "foo", "bar": "bar"}})
self.assertEqual(container.config.option(), {"foo": "foo", "bar": "bar"})
self.assertEqual(opt(), {"foo": "foo", "bar": "bar"})
self.assertIs(container.config.option, opt)
def test_missing_key(self):
# See: https://github.com/ets-labs/python-dependency-injector/issues/358
self.config.override(None)
value = self.config.key()
self.assertIsNone(value)
2016-12-02 14:53:37 +03:00
def test_deepcopy(self):
2021-10-01 03:09:42 +03:00
provider = providers.Configuration("config")
2016-12-02 14:53:37 +03:00
provider_copy = providers.deepcopy(provider)
self.assertIsNot(provider, provider_copy)
self.assertIsInstance(provider, providers.Configuration)
def test_deepcopy_from_memo(self):
2021-10-01 03:09:42 +03:00
provider = providers.Configuration("config")
provider_copy_memo = providers.Configuration("config")
2016-12-02 14:53:37 +03:00
provider_copy = providers.deepcopy(
provider, memo={id(provider): provider_copy_memo})
self.assertIs(provider_copy, provider_copy_memo)
def test_deepcopy_overridden(self):
2021-10-01 03:09:42 +03:00
provider = providers.Configuration("config")
2016-12-02 14:53:37 +03:00
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.assertIsInstance(provider, providers.Configuration)
self.assertIsNot(object_provider, object_provider_copy)
self.assertIsInstance(object_provider_copy, providers.Object)
def test_repr(self):
self.assertEqual(repr(self.config),
2021-10-01 03:09:42 +03:00
"<dependency_injector.providers."
"Configuration({0}) at {1}>".format(
repr("config"),
2016-12-02 14:53:37 +03:00
hex(id(self.config))))
def test_repr_child(self):
self.assertEqual(repr(self.config.a.b.c),
2021-10-01 03:09:42 +03:00
"<dependency_injector.providers."
"ConfigurationOption({0}) at {1}>".format(
repr("config.a.b.c"),
2016-12-02 14:53:37 +03:00
hex(id(self.config.a.b.c))))
class ConfigLinkingTests(unittest.TestCase):
class TestCore(containers.DeclarativeContainer):
2021-10-01 03:09:42 +03:00
config = providers.Configuration("core")
value_getter = providers.Callable(lambda _: _, config.value)
class TestServices(containers.DeclarativeContainer):
2021-10-01 03:09:42 +03:00
config = providers.Configuration("services")
value_getter = providers.Callable(lambda _: _, config.value)
def test(self):
2021-10-01 03:09:42 +03:00
root_config = providers.Configuration("main")
core = self.TestCore(config=root_config.core)
services = self.TestServices(config=root_config.services)
root_config.override(
{
2021-10-01 03:09:42 +03:00
"core": {
"value": "core",
},
2021-10-01 03:09:42 +03:00
"services": {
"value": "services",
},
},
)
2021-10-01 03:09:42 +03:00
self.assertEqual(core.config(), {"value": "core"})
self.assertEqual(core.config.value(), "core")
self.assertEqual(core.value_getter(), "core")
2021-10-01 03:09:42 +03:00
self.assertEqual(services.config(), {"value": "services"})
self.assertEqual(services.config.value(), "services")
self.assertEqual(services.value_getter(), "services")
def test_double_override(self):
2021-10-01 03:09:42 +03:00
root_config = providers.Configuration("main")
core = self.TestCore(config=root_config.core)
services = self.TestServices(config=root_config.services)
root_config.override(
{
2021-10-01 03:09:42 +03:00
"core": {
"value": "core1",
},
2021-10-01 03:09:42 +03:00
"services": {
"value": "services1",
},
},
)
root_config.override(
{
2021-10-01 03:09:42 +03:00
"core": {
"value": "core2",
},
2021-10-01 03:09:42 +03:00
"services": {
"value": "services2",
},
},
)
2021-10-01 03:09:42 +03:00
self.assertEqual(core.config(), {"value": "core2"})
self.assertEqual(core.config.value(), "core2")
self.assertEqual(core.value_getter(), "core2")
2021-10-01 03:09:42 +03:00
self.assertEqual(services.config(), {"value": "services2"})
self.assertEqual(services.config.value(), "services2")
self.assertEqual(services.value_getter(), "services2")
2020-06-23 23:46:24 +03:00
def test_reset_overriding_cache(self):
# See: https://github.com/ets-labs/python-dependency-injector/issues/428
class Core(containers.DeclarativeContainer):
config = providers.Configuration()
greetings = providers.Factory(str, config.greeting)
class Application(containers.DeclarativeContainer):
config = providers.Configuration()
core = providers.Container(
Core,
config=config,
)
greetings = providers.Factory(str, config.greeting)
container = Application()
2021-10-01 03:09:42 +03:00
container.config.set("greeting", "Hello World")
self.assertEqual(container.greetings(), "Hello World")
self.assertEqual(container.core.greetings(), "Hello World")
2021-10-01 03:09:42 +03:00
container.config.set("greeting", "Hello Bob")
self.assertEqual(container.greetings(), "Hello Bob")
self.assertEqual(container.core.greetings(), "Hello Bob")
def test_reset_overriding_cache_for_option(self):
# See: https://github.com/ets-labs/python-dependency-injector/issues/428
class Core(containers.DeclarativeContainer):
config = providers.Configuration()
greetings = providers.Factory(str, config.greeting)
class Application(containers.DeclarativeContainer):
config = providers.Configuration()
core = providers.Container(
Core,
config=config.option,
)
greetings = providers.Factory(str, config.option.greeting)
container = Application()
2021-10-01 03:09:42 +03:00
container.config.set("option.greeting", "Hello World")
self.assertEqual(container.greetings(), "Hello World")
self.assertEqual(container.core.greetings(), "Hello World")
2021-10-01 03:09:42 +03:00
container.config.set("option.greeting", "Hello Bob")
self.assertEqual(container.greetings(), "Hello Bob")
self.assertEqual(container.core.greetings(), "Hello Bob")
2020-06-23 23:46:24 +03:00
class ConfigFromIniTests(unittest.TestCase):
def setUp(self):
2021-10-01 03:09:42 +03:00
self.config = providers.Configuration(name="config")
2020-06-23 23:46:24 +03:00
2020-06-24 01:09:20 +03:00
_, self.config_file_1 = tempfile.mkstemp()
2021-10-01 03:09:42 +03:00
with open(self.config_file_1, "w") as config_file:
2020-06-23 23:46:24 +03:00
config_file.write(
2021-10-01 03:09:42 +03:00
"[section1]\n"
"value1=1\n"
"\n"
"[section2]\n"
"value2=2\n"
2020-06-23 23:46:24 +03:00
)
2020-06-24 01:09:20 +03:00
_, self.config_file_2 = tempfile.mkstemp()
2021-10-01 03:09:42 +03:00
with open(self.config_file_2, "w") as config_file:
2020-06-24 01:09:20 +03:00
config_file.write(
2021-10-01 03:09:42 +03:00
"[section1]\n"
"value1=11\n"
"value11=11\n"
"[section3]\n"
"value3=3\n"
2020-06-24 01:09:20 +03:00
)
2020-06-23 23:46:24 +03:00
def tearDown(self):
del self.config
2020-06-24 01:09:20 +03:00
os.unlink(self.config_file_1)
os.unlink(self.config_file_2)
2020-06-23 23:46:24 +03:00
def test(self):
2020-06-24 01:09:20 +03:00
self.config.from_ini(self.config_file_1)
2020-06-23 23:46:24 +03:00
2021-10-01 03:09:42 +03:00
self.assertEqual(self.config(), {"section1": {"value1": "1"}, "section2": {"value2": "2"}})
self.assertEqual(self.config.section1(), {"value1": "1"})
self.assertEqual(self.config.section1.value1(), "1")
self.assertEqual(self.config.section2(), {"value2": "2"})
self.assertEqual(self.config.section2.value2(), "2")
2020-06-24 01:09:20 +03:00
def test_option(self):
self.config.option.from_ini(self.config_file_1)
2021-10-01 03:09:42 +03:00
self.assertEqual(self.config(), {"option": {"section1": {"value1": "1"}, "section2": {"value2": "2"}}})
self.assertEqual(self.config.option(), {"section1": {"value1": "1"}, "section2": {"value2": "2"}})
self.assertEqual(self.config.option.section1(), {"value1": "1"})
self.assertEqual(self.config.option.section1.value1(), "1")
self.assertEqual(self.config.option.section2(), {"value2": "2"})
self.assertEqual(self.config.option.section2.value2(), "2")
2020-06-24 01:09:20 +03:00
def test_merge(self):
self.config.from_ini(self.config_file_1)
self.config.from_ini(self.config_file_2)
self.assertEqual(
self.config(),
{
2021-10-01 03:09:42 +03:00
"section1": {
"value1": "11",
"value11": "11",
2020-06-24 01:09:20 +03:00
},
2021-10-01 03:09:42 +03:00
"section2": {
"value2": "2",
2020-06-24 01:09:20 +03:00
},
2021-10-01 03:09:42 +03:00
"section3": {
"value3": "3",
2020-06-24 01:09:20 +03:00
},
},
)
2021-10-01 03:09:42 +03:00
self.assertEqual(self.config.section1(), {"value1": "11", "value11": "11"})
self.assertEqual(self.config.section1.value1(), "11")
self.assertEqual(self.config.section1.value11(), "11")
self.assertEqual(self.config.section2(), {"value2": "2"})
self.assertEqual(self.config.section2.value2(), "2")
self.assertEqual(self.config.section3(), {"value3": "3"})
self.assertEqual(self.config.section3.value3(), "3")
2020-06-25 04:04:30 +03:00
def test_file_does_not_exist(self):
2021-10-01 03:09:42 +03:00
self.config.from_ini("./does_not_exist.ini")
self.assertEqual(self.config(), {})
def test_file_does_not_exist_strict_mode(self):
self.config = providers.Configuration(strict=True)
with self.assertRaises(IOError):
2021-10-01 03:09:42 +03:00
self.config.from_ini("./does_not_exist.ini")
def test_option_file_does_not_exist(self):
2021-10-01 03:09:42 +03:00
self.config.option.from_ini("does_not_exist.ini")
self.assertIsNone(self.config.option.undefined())
def test_option_file_does_not_exist_strict_mode(self):
self.config = providers.Configuration(strict=True)
with self.assertRaises(IOError):
2021-10-01 03:09:42 +03:00
self.config.option.from_ini("./does_not_exist.ini")
def test_required_file_does_not_exist(self):
with self.assertRaises(IOError):
2021-10-01 03:09:42 +03:00
self.config.from_ini("./does_not_exist.ini", required=True)
def test_required_option_file_does_not_exist(self):
with self.assertRaises(IOError):
2021-10-01 03:09:42 +03:00
self.config.option.from_ini("./does_not_exist.ini", required=True)
def test_not_required_file_does_not_exist_strict_mode(self):
self.config = providers.Configuration(strict=True)
2021-10-01 03:09:42 +03:00
self.config.from_ini("./does_not_exist.ini", required=False)
self.assertEqual(self.config(), {})
def test_not_required_option_file_does_not_exist_strict_mode(self):
self.config = providers.Configuration(strict=True)
2021-10-01 03:09:42 +03:00
self.config.option.from_ini("./does_not_exist.ini", required=False)
with self.assertRaises(errors.Error):
self.config.option()
2020-06-25 04:04:30 +03:00
class ConfigFromIniWithEnvInterpolationTests(unittest.TestCase):
def setUp(self):
2021-10-01 03:09:42 +03:00
self.config = providers.Configuration(name="config")
2021-10-01 03:09:42 +03:00
os.environ["CONFIG_TEST_ENV"] = "test-value"
os.environ["CONFIG_TEST_PATH"] = "test-path"
_, self.config_file = tempfile.mkstemp()
2021-10-01 03:09:42 +03:00
with open(self.config_file, "w") as config_file:
config_file.write(
2021-10-01 03:09:42 +03:00
"[section1]\n"
"value1=${CONFIG_TEST_ENV}\n"
"value2=${CONFIG_TEST_PATH}/path\n"
)
def tearDown(self):
del self.config
2021-10-01 03:09:42 +03:00
os.environ.pop("CONFIG_TEST_ENV", None)
os.environ.pop("CONFIG_TEST_PATH", None)
os.unlink(self.config_file)
def test_env_variable_interpolation(self):
self.config.from_ini(self.config_file)
self.assertEqual(
self.config(),
{
2021-10-01 03:09:42 +03:00
"section1": {
"value1": "test-value",
"value2": "test-path/path",
},
},
)
self.assertEqual(
self.config.section1(),
{
2021-10-01 03:09:42 +03:00
"value1": "test-value",
"value2": "test-path/path",
},
)
2021-10-01 03:09:42 +03:00
self.assertEqual(self.config.section1.value1(), "test-value")
self.assertEqual(self.config.section1.value2(), "test-path/path")
def test_missing_envs_not_required(self):
2021-10-01 03:09:42 +03:00
del os.environ["CONFIG_TEST_ENV"]
del os.environ["CONFIG_TEST_PATH"]
self.config.from_ini(self.config_file)
self.assertEqual(
self.config(),
{
2021-10-01 03:09:42 +03:00
"section1": {
"value1": "",
"value2": "/path",
},
},
)
self.assertEqual(
self.config.section1(),
{
2021-10-01 03:09:42 +03:00
"value1": "",
"value2": "/path",
},
)
2021-10-01 03:09:42 +03:00
self.assertEqual(self.config.section1.value1(), "")
self.assertEqual(self.config.section1.value2(), "/path")
def test_missing_envs_required(self):
2021-10-01 03:09:42 +03:00
with open(self.config_file, "w") as config_file:
config_file.write(
2021-10-01 03:09:42 +03:00
"[section]\n"
"undefined=${UNDEFINED}\n"
)
with self.assertRaises(ValueError) as context:
self.config.from_ini(self.config_file, envs_required=True)
self.assertEqual(
str(context.exception),
2021-10-01 03:09:42 +03:00
"Missing required environment variable \"UNDEFINED\"",
)
def test_missing_envs_strict_mode(self):
2021-10-01 03:09:42 +03:00
with open(self.config_file, "w") as config_file:
config_file.write(
2021-10-01 03:09:42 +03:00
"[section]\n"
"undefined=${UNDEFINED}\n"
)
self.config.set_strict(True)
with self.assertRaises(ValueError) as context:
self.config.from_ini(self.config_file)
self.assertEqual(
str(context.exception),
2021-10-01 03:09:42 +03:00
"Missing required environment variable \"UNDEFINED\"",
)
def test_option_missing_envs_not_required(self):
2021-10-01 03:09:42 +03:00
del os.environ["CONFIG_TEST_ENV"]
del os.environ["CONFIG_TEST_PATH"]
self.config.option.from_ini(self.config_file)
self.assertEqual(
self.config.option(),
{
2021-10-01 03:09:42 +03:00
"section1": {
"value1": "",
"value2": "/path",
},
},
)
self.assertEqual(
self.config.option.section1(),
{
2021-10-01 03:09:42 +03:00
"value1": "",
"value2": "/path",
},
)
2021-10-01 03:09:42 +03:00
self.assertEqual(self.config.option.section1.value1(), "")
self.assertEqual(self.config.option.section1.value2(), "/path")
def test_option_missing_envs_required(self):
2021-10-01 03:09:42 +03:00
with open(self.config_file, "w") as config_file:
config_file.write(
2021-10-01 03:09:42 +03:00
"[section]\n"
"undefined=${UNDEFINED}\n"
)
with self.assertRaises(ValueError) as context:
self.config.option.from_ini(self.config_file, envs_required=True)
self.assertEqual(
str(context.exception),
2021-10-01 03:09:42 +03:00
"Missing required environment variable \"UNDEFINED\"",
)
def test_option_missing_envs_strict_mode(self):
2021-10-01 03:09:42 +03:00
with open(self.config_file, "w") as config_file:
config_file.write(
2021-10-01 03:09:42 +03:00
"[section]\n"
"undefined=${UNDEFINED}\n"
)
self.config.set_strict(True)
with self.assertRaises(ValueError) as context:
self.config.option.from_ini(self.config_file)
self.assertEqual(
str(context.exception),
2021-10-01 03:09:42 +03:00
"Missing required environment variable \"UNDEFINED\"",
)
def test_default_values(self):
2021-10-01 03:09:42 +03:00
os.environ["DEFINED"] = "defined"
self.addCleanup(os.environ.pop, "DEFINED")
2021-10-01 03:09:42 +03:00
with open(self.config_file, "w") as config_file:
config_file.write(
2021-10-01 03:09:42 +03:00
"[section]\n"
"defined_with_default=${DEFINED:default}\n"
"undefined_with_default=${UNDEFINED:default}\n"
"complex=${DEFINED}/path/${DEFINED:default}/${UNDEFINED}/${UNDEFINED:default}\n"
)
self.config.from_ini(self.config_file)
self.assertEqual(
self.config.section(),
{
2021-10-01 03:09:42 +03:00
"defined_with_default": "defined",
"undefined_with_default": "default",
"complex": "defined/path/defined//default",
},
)
2020-06-25 04:04:30 +03:00
class ConfigFromYamlTests(unittest.TestCase):
def setUp(self):
2021-10-01 03:09:42 +03:00
self.config = providers.Configuration(name="config")
2020-06-25 04:04:30 +03:00
_, self.config_file_1 = tempfile.mkstemp()
2021-10-01 03:09:42 +03:00
with open(self.config_file_1, "w") as config_file:
2020-06-25 04:04:30 +03:00
config_file.write(
2021-10-01 03:09:42 +03:00
"section1:\n"
" value1: 1\n"
"\n"
"section2:\n"
" value2: 2\n"
2020-06-25 04:04:30 +03:00
)
_, self.config_file_2 = tempfile.mkstemp()
2021-10-01 03:09:42 +03:00
with open(self.config_file_2, "w") as config_file:
2020-06-25 04:04:30 +03:00
config_file.write(
2021-10-01 03:09:42 +03:00
"section1:\n"
" value1: 11\n"
" value11: 11\n"
"section3:\n"
" value3: 3\n"
2020-06-25 04:04:30 +03:00
)
def tearDown(self):
del self.config
os.unlink(self.config_file_1)
os.unlink(self.config_file_2)
2021-10-01 03:09:42 +03:00
@unittest.skipIf(sys.version_info[:2] == (3, 4), "PyYAML does not support Python 3.4")
2020-06-25 04:04:30 +03:00
def test(self):
self.config.from_yaml(self.config_file_1)
2021-10-01 03:09:42 +03:00
self.assertEqual(self.config(), {"section1": {"value1": 1}, "section2": {"value2": 2}})
self.assertEqual(self.config.section1(), {"value1": 1})
2020-06-25 04:04:30 +03:00
self.assertEqual(self.config.section1.value1(), 1)
2021-10-01 03:09:42 +03:00
self.assertEqual(self.config.section2(), {"value2": 2})
2020-06-25 04:04:30 +03:00
self.assertEqual(self.config.section2.value2(), 2)
2021-10-01 03:09:42 +03:00
@unittest.skipIf(sys.version_info[:2] == (3, 4), "PyYAML does not support Python 3.4")
2020-06-25 04:04:30 +03:00
def test_merge(self):
self.config.from_yaml(self.config_file_1)
self.config.from_yaml(self.config_file_2)
self.assertEqual(
self.config(),
{
2021-10-01 03:09:42 +03:00
"section1": {
"value1": 11,
"value11": 11,
2020-06-25 04:04:30 +03:00
},
2021-10-01 03:09:42 +03:00
"section2": {
"value2": 2,
2020-06-25 04:04:30 +03:00
},
2021-10-01 03:09:42 +03:00
"section3": {
"value3": 3,
2020-06-25 04:04:30 +03:00
},
},
)
2021-10-01 03:09:42 +03:00
self.assertEqual(self.config.section1(), {"value1": 11, "value11": 11})
2020-06-25 04:04:30 +03:00
self.assertEqual(self.config.section1.value1(), 11)
self.assertEqual(self.config.section1.value11(), 11)
2021-10-01 03:09:42 +03:00
self.assertEqual(self.config.section2(), {"value2": 2})
2020-06-25 04:04:30 +03:00
self.assertEqual(self.config.section2.value2(), 2)
2021-10-01 03:09:42 +03:00
self.assertEqual(self.config.section3(), {"value3": 3})
2020-06-25 04:04:30 +03:00
self.assertEqual(self.config.section3.value3(), 3)
2021-10-01 03:09:42 +03:00
@unittest.skipIf(sys.version_info[:2] == (3, 4), "PyYAML does not support Python 3.4")
def test_file_does_not_exist(self):
2021-10-01 03:09:42 +03:00
self.config.from_yaml("./does_not_exist.yml")
self.assertEqual(self.config(), {})
2021-10-01 03:09:42 +03:00
@unittest.skipIf(sys.version_info[:2] == (3, 4), "PyYAML does not support Python 3.4")
def test_file_does_not_exist_strict_mode(self):
self.config = providers.Configuration(strict=True)
with self.assertRaises(IOError):
2021-10-01 03:09:42 +03:00
self.config.from_yaml("./does_not_exist.yml")
2021-10-01 03:09:42 +03:00
@unittest.skipIf(sys.version_info[:2] == (3, 4), "PyYAML does not support Python 3.4")
def test_option_file_does_not_exist(self):
2021-10-01 03:09:42 +03:00
self.config.option.from_yaml("./does_not_exist.yml")
self.assertIsNone(self.config.option())
2021-10-01 03:09:42 +03:00
@unittest.skipIf(sys.version_info[:2] == (3, 4), "PyYAML does not support Python 3.4")
def test_option_file_does_not_exist_strict_mode(self):
self.config = providers.Configuration(strict=True)
with self.assertRaises(IOError):
2021-10-01 03:09:42 +03:00
self.config.option.from_yaml("./does_not_exist.yml")
2021-10-01 03:09:42 +03:00
@unittest.skipIf(sys.version_info[:2] == (3, 4), "PyYAML does not support Python 3.4")
def test_required_file_does_not_exist(self):
with self.assertRaises(IOError):
2021-10-01 03:09:42 +03:00
self.config.from_yaml("./does_not_exist.yml", required=True)
2021-10-01 03:09:42 +03:00
@unittest.skipIf(sys.version_info[:2] == (3, 4), "PyYAML does not support Python 3.4")
def test_required_option_file_does_not_exist(self):
with self.assertRaises(IOError):
2021-10-01 03:09:42 +03:00
self.config.option.from_yaml("./does_not_exist.yml", required=True)
2021-10-01 03:09:42 +03:00
@unittest.skipIf(sys.version_info[:2] == (3, 4), "PyYAML does not support Python 3.4")
def test_not_required_file_does_not_exist_strict_mode(self):
self.config = providers.Configuration(strict=True)
2021-10-01 03:09:42 +03:00
self.config.from_yaml("./does_not_exist.yml", required=False)
self.assertEqual(self.config(), {})
2021-10-01 03:09:42 +03:00
@unittest.skipIf(sys.version_info[:2] == (3, 4), "PyYAML does not support Python 3.4")
def test_not_required_option_file_does_not_exist_strict_mode(self):
self.config = providers.Configuration(strict=True)
2021-10-01 03:09:42 +03:00
self.config.option.from_yaml("./does_not_exist.yml", required=False)
with self.assertRaises(errors.Error):
self.config.option()
2020-06-25 04:04:30 +03:00
def test_no_yaml_installed(self):
@contextlib.contextmanager
def no_yaml_module():
yaml = providers.yaml
providers.yaml = None
yield
providers.yaml = yaml
with no_yaml_module():
with self.assertRaises(errors.Error) as error:
self.config.from_yaml(self.config_file_1)
self.assertEqual(
error.exception.args[0],
2021-10-01 03:09:42 +03:00
"Unable to load yaml configuration - PyYAML is not installed. "
"Install PyYAML or install Dependency Injector with yaml extras: "
"\"pip install dependency-injector[yaml]\"",
2020-06-25 04:04:30 +03:00
)
def test_option_no_yaml_installed(self):
@contextlib.contextmanager
def no_yaml_module():
yaml = providers.yaml
providers.yaml = None
yield
providers.yaml = yaml
with no_yaml_module():
with self.assertRaises(errors.Error) as error:
self.config.option.from_yaml(self.config_file_1)
self.assertEqual(
error.exception.args[0],
2021-10-01 03:09:42 +03:00
"Unable to load yaml configuration - PyYAML is not installed. "
"Install PyYAML or install Dependency Injector with yaml extras: "
"\"pip install dependency-injector[yaml]\"",
)
class ConfigFromYamlWithEnvInterpolationTests(unittest.TestCase):
def setUp(self):
2021-10-01 03:09:42 +03:00
self.config = providers.Configuration(name="config")
2021-10-01 03:09:42 +03:00
os.environ["CONFIG_TEST_ENV"] = "test-value"
os.environ["CONFIG_TEST_PATH"] = "test-path"
_, self.config_file = tempfile.mkstemp()
2021-10-01 03:09:42 +03:00
with open(self.config_file, "w") as config_file:
config_file.write(
2021-10-01 03:09:42 +03:00
"section1:\n"
" value1: ${CONFIG_TEST_ENV}\n"
" value2: ${CONFIG_TEST_PATH}/path\n"
)
def tearDown(self):
del self.config
2021-10-01 03:09:42 +03:00
os.environ.pop("CONFIG_TEST_ENV", None)
os.environ.pop("CONFIG_TEST_PATH", None)
os.unlink(self.config_file)
2021-10-01 03:09:42 +03:00
@unittest.skipIf(sys.version_info[:2] == (3, 4), "PyYAML does not support Python 3.4")
def test_env_variable_interpolation(self):
self.config.from_yaml(self.config_file)
self.assertEqual(
self.config(),
{
2021-10-01 03:09:42 +03:00
"section1": {
"value1": "test-value",
"value2": "test-path/path",
},
},
)
self.assertEqual(
self.config.section1(),
{
2021-10-01 03:09:42 +03:00
"value1": "test-value",
"value2": "test-path/path",
},
)
2021-10-01 03:09:42 +03:00
self.assertEqual(self.config.section1.value1(), "test-value")
self.assertEqual(self.config.section1.value2(), "test-path/path")
2021-10-01 03:09:42 +03:00
@unittest.skipIf(sys.version_info[:2] == (3, 4), "PyYAML does not support Python 3.4")
def test_missing_envs_not_required(self):
2021-10-01 03:09:42 +03:00
del os.environ["CONFIG_TEST_ENV"]
del os.environ["CONFIG_TEST_PATH"]
self.config.from_yaml(self.config_file)
self.assertEqual(
self.config(),
{
2021-10-01 03:09:42 +03:00
"section1": {
"value1": None,
"value2": "/path",
},
},
)
self.assertEqual(
self.config.section1(),
{
2021-10-01 03:09:42 +03:00
"value1": None,
"value2": "/path",
},
)
self.assertIsNone(self.config.section1.value1())
2021-10-01 03:09:42 +03:00
self.assertEqual(self.config.section1.value2(), "/path")
2021-10-01 03:09:42 +03:00
@unittest.skipIf(sys.version_info[:2] == (3, 4), "PyYAML does not support Python 3.4")
def test_missing_envs_required(self):
2021-10-01 03:09:42 +03:00
with open(self.config_file, "w") as config_file:
config_file.write(
2021-10-01 03:09:42 +03:00
"section:\n"
" undefined: ${UNDEFINED}\n"
)
with self.assertRaises(ValueError) as context:
self.config.from_yaml(self.config_file, envs_required=True)
self.assertEqual(
str(context.exception),
2021-10-01 03:09:42 +03:00
"Missing required environment variable \"UNDEFINED\"",
)
2021-10-01 03:09:42 +03:00
@unittest.skipIf(sys.version_info[:2] == (3, 4), "PyYAML does not support Python 3.4")
def test_missing_envs_strict_mode(self):
2021-10-01 03:09:42 +03:00
with open(self.config_file, "w") as config_file:
config_file.write(
2021-10-01 03:09:42 +03:00
"section:\n"
" undefined: ${UNDEFINED}\n"
)
self.config.set_strict(True)
with self.assertRaises(ValueError) as context:
self.config.from_yaml(self.config_file)
self.assertEqual(
str(context.exception),
2021-10-01 03:09:42 +03:00
"Missing required environment variable \"UNDEFINED\"",
)
2021-10-01 03:09:42 +03:00
@unittest.skipIf(sys.version_info[:2] == (3, 4), "PyYAML does not support Python 3.4")
def test_option_missing_envs_not_required(self):
2021-10-01 03:09:42 +03:00
del os.environ["CONFIG_TEST_ENV"]
del os.environ["CONFIG_TEST_PATH"]
self.config.option.from_yaml(self.config_file)
self.assertEqual(
self.config.option(),
{
2021-10-01 03:09:42 +03:00
"section1": {
"value1": None,
"value2": "/path",
},
},
)
self.assertEqual(
self.config.option.section1(),
{
2021-10-01 03:09:42 +03:00
"value1": None,
"value2": "/path",
},
)
self.assertIsNone(self.config.option.section1.value1())
2021-10-01 03:09:42 +03:00
self.assertEqual(self.config.option.section1.value2(), "/path")
2021-10-01 03:09:42 +03:00
@unittest.skipIf(sys.version_info[:2] == (3, 4), "PyYAML does not support Python 3.4")
def test_option_missing_envs_required(self):
2021-10-01 03:09:42 +03:00
with open(self.config_file, "w") as config_file:
config_file.write(
2021-10-01 03:09:42 +03:00
"section:\n"
" undefined: ${UNDEFINED}\n"
)
with self.assertRaises(ValueError) as context:
self.config.option.from_yaml(self.config_file, envs_required=True)
self.assertEqual(
str(context.exception),
2021-10-01 03:09:42 +03:00
"Missing required environment variable \"UNDEFINED\"",
)
2021-10-01 03:09:42 +03:00
@unittest.skipIf(sys.version_info[:2] == (3, 4), "PyYAML does not support Python 3.4")
def test_option_missing_envs_strict_mode(self):
2021-10-01 03:09:42 +03:00
with open(self.config_file, "w") as config_file:
config_file.write(
2021-10-01 03:09:42 +03:00
"section:\n"
" undefined: ${UNDEFINED}\n"
)
self.config.set_strict(True)
with self.assertRaises(ValueError) as context:
self.config.option.from_yaml(self.config_file)
self.assertEqual(
str(context.exception),
2021-10-01 03:09:42 +03:00
"Missing required environment variable \"UNDEFINED\"",
)
2021-10-01 03:09:42 +03:00
@unittest.skipIf(sys.version_info[:2] == (3, 4), "PyYAML does not support Python 3.4")
def test_default_values(self):
2021-10-01 03:09:42 +03:00
os.environ["DEFINED"] = "defined"
self.addCleanup(os.environ.pop, "DEFINED")
2021-10-01 03:09:42 +03:00
with open(self.config_file, "w") as config_file:
config_file.write(
2021-10-01 03:09:42 +03:00
"section:\n"
" defined_with_default: ${DEFINED:default}\n"
" undefined_with_default: ${UNDEFINED:default}\n"
" complex: ${DEFINED}/path/${DEFINED:default}/${UNDEFINED}/${UNDEFINED:default}\n"
)
self.config.from_yaml(self.config_file)
self.assertEqual(
self.config.section(),
{
2021-10-01 03:09:42 +03:00
"defined_with_default": "defined",
"undefined_with_default": "default",
"complex": "defined/path/defined//default",
},
)
2021-10-01 03:09:42 +03:00
@unittest.skipIf(sys.version_info[:2] == (3, 4), "PyYAML does not support Python 3.4")
def test_option_env_variable_interpolation(self):
self.config.option.from_yaml(self.config_file)
self.assertEqual(
self.config.option(),
{
2021-10-01 03:09:42 +03:00
"section1": {
"value1": "test-value",
"value2": "test-path/path",
},
},
)
self.assertEqual(
self.config.option.section1(),
{
2021-10-01 03:09:42 +03:00
"value1": "test-value",
"value2": "test-path/path",
},
)
2021-10-01 03:09:42 +03:00
self.assertEqual(self.config.option.section1.value1(), "test-value")
self.assertEqual(self.config.option.section1.value2(), "test-path/path")
2021-10-01 03:09:42 +03:00
@unittest.skipIf(sys.version_info[:2] == (3, 4), "PyYAML does not support Python 3.4")
def test_env_variable_interpolation_custom_loader(self):
self.config.from_yaml(self.config_file, loader=yaml.UnsafeLoader)
self.assertEqual(
self.config.section1(),
{
2021-10-01 03:09:42 +03:00
"value1": "test-value",
"value2": "test-path/path",
},
)
2021-10-01 03:09:42 +03:00
self.assertEqual(self.config.section1.value1(), "test-value")
self.assertEqual(self.config.section1.value2(), "test-path/path")
2021-10-01 03:09:42 +03:00
@unittest.skipIf(sys.version_info[:2] == (3, 4), "PyYAML does not support Python 3.4")
def test_option_env_variable_interpolation_custom_loader(self):
self.config.option.from_yaml(self.config_file, loader=yaml.UnsafeLoader)
self.assertEqual(
self.config.option.section1(),
{
2021-10-01 03:09:42 +03:00
"value1": "test-value",
"value2": "test-path/path",
},
)
2021-10-01 03:09:42 +03:00
self.assertEqual(self.config.option.section1.value1(), "test-value")
self.assertEqual(self.config.option.section1.value2(), "test-path/path")
class ConfigFromPydanticTests(unittest.TestCase):
def setUp(self):
2021-10-01 03:09:42 +03:00
self.config = providers.Configuration(name="config")
class Section11(pydantic.BaseModel):
value1 = 1
class Section12(pydantic.BaseModel):
value2 = 2
class Settings1(pydantic.BaseSettings):
section1 = Section11()
section2 = Section12()
self.Settings1 = Settings1
class Section21(pydantic.BaseModel):
value1 = 11
value11 = 11
class Section3(pydantic.BaseModel):
value3 = 3
class Settings2(pydantic.BaseSettings):
section1 = Section21()
section3 = Section3()
self.Settings2 = Settings2
2021-10-01 03:09:42 +03:00
@unittest.skipIf(sys.version_info[:2] < (3, 6), "Pydantic supports Python 3.6+")
def test(self):
self.config.from_pydantic(self.Settings1())
2021-10-01 03:09:42 +03:00
self.assertEqual(self.config(), {"section1": {"value1": 1}, "section2": {"value2": 2}})
self.assertEqual(self.config.section1(), {"value1": 1})
self.assertEqual(self.config.section1.value1(), 1)
2021-10-01 03:09:42 +03:00
self.assertEqual(self.config.section2(), {"value2": 2})
self.assertEqual(self.config.section2.value2(), 2)
2021-10-01 03:09:42 +03:00
@unittest.skipIf(sys.version_info[:2] < (3, 6), "Pydantic supports Python 3.6+")
def test_kwarg(self):
2021-10-01 03:09:42 +03:00
self.config.from_pydantic(self.Settings1(), exclude={"section2"})
2021-10-01 03:09:42 +03:00
self.assertEqual(self.config(), {"section1": {"value1": 1}})
self.assertEqual(self.config.section1(), {"value1": 1})
self.assertEqual(self.config.section1.value1(), 1)
2021-10-01 03:09:42 +03:00
@unittest.skipIf(sys.version_info[:2] < (3, 6), "Pydantic supports Python 3.6+")
def test_merge(self):
self.config.from_pydantic(self.Settings1())
self.config.from_pydantic(self.Settings2())
self.assertEqual(
self.config(),
{
2021-10-01 03:09:42 +03:00
"section1": {
"value1": 11,
"value11": 11,
},
2021-10-01 03:09:42 +03:00
"section2": {
"value2": 2,
},
2021-10-01 03:09:42 +03:00
"section3": {
"value3": 3,
},
},
)
2021-10-01 03:09:42 +03:00
self.assertEqual(self.config.section1(), {"value1": 11, "value11": 11})
self.assertEqual(self.config.section1.value1(), 11)
self.assertEqual(self.config.section1.value11(), 11)
2021-10-01 03:09:42 +03:00
self.assertEqual(self.config.section2(), {"value2": 2})
self.assertEqual(self.config.section2.value2(), 2)
2021-10-01 03:09:42 +03:00
self.assertEqual(self.config.section3(), {"value3": 3})
self.assertEqual(self.config.section3.value3(), 3)
2021-10-01 03:09:42 +03:00
@unittest.skipIf(sys.version_info[:2] < (3, 6), "Pydantic supports Python 3.6+")
def test_empty_settings(self):
self.config.from_pydantic(pydantic.BaseSettings())
self.assertEqual(self.config(), {})
2021-10-01 03:09:42 +03:00
@unittest.skipIf(sys.version_info[:2] < (3, 6), "Pydantic supports Python 3.6+")
def test_empty_settings_strict_mode(self):
self.config = providers.Configuration(strict=True)
with self.assertRaises(ValueError):
self.config.from_pydantic(pydantic.BaseSettings())
2021-10-01 03:09:42 +03:00
@unittest.skipIf(sys.version_info[:2] < (3, 6), "Pydantic supports Python 3.6+")
def test_option_empty_settings(self):
self.config.option.from_pydantic(pydantic.BaseSettings())
self.assertEqual(self.config.option(), {})
2021-10-01 03:09:42 +03:00
@unittest.skipIf(sys.version_info[:2] < (3, 6), "Pydantic supports Python 3.6+")
def test_option_empty_settings_strict_mode(self):
self.config = providers.Configuration(strict=True)
with self.assertRaises(ValueError):
self.config.option.from_pydantic(pydantic.BaseSettings())
2021-10-01 03:09:42 +03:00
@unittest.skipIf(sys.version_info[:2] < (3, 6), "Pydantic supports Python 3.6+")
def test_required_empty_settings(self):
with self.assertRaises(ValueError):
self.config.from_pydantic(pydantic.BaseSettings(), required=True)
2021-10-01 03:09:42 +03:00
@unittest.skipIf(sys.version_info[:2] < (3, 6), "Pydantic supports Python 3.6+")
def test_required_option_empty_settings(self):
with self.assertRaises(ValueError):
self.config.option.from_pydantic(pydantic.BaseSettings(), required=True)
2021-10-01 03:09:42 +03:00
@unittest.skipIf(sys.version_info[:2] < (3, 6), "Pydantic supports Python 3.6+")
def test_not_required_empty_settings_strict_mode(self):
self.config = providers.Configuration(strict=True)
self.config.from_pydantic(pydantic.BaseSettings(), required=False)
self.assertEqual(self.config(), {})
2021-10-01 03:09:42 +03:00
@unittest.skipIf(sys.version_info[:2] < (3, 6), "Pydantic supports Python 3.6+")
def test_not_required_option_empty_settings_strict_mode(self):
self.config = providers.Configuration(strict=True)
self.config.option.from_pydantic(pydantic.BaseSettings(), required=False)
self.assertEqual(self.config.option(), {})
2021-10-01 03:09:42 +03:00
self.assertEqual(self.config(), {"option": {}})
2021-10-01 03:09:42 +03:00
@unittest.skipIf(sys.version_info[:2] < (3, 6), "Pydantic supports Python 3.6+")
def test_not_instance_of_settings(self):
with self.assertRaises(errors.Error) as error:
self.config.from_pydantic({})
self.assertEqual(
error.exception.args[0],
2021-10-01 03:09:42 +03:00
"Unable to recognize settings instance, expect \"pydantic.BaseSettings\", "
"got {0} instead".format({})
)
2021-10-01 03:09:42 +03:00
@unittest.skipIf(sys.version_info[:2] < (3, 6), "Pydantic supports Python 3.6+")
def test_option_not_instance_of_settings(self):
with self.assertRaises(errors.Error) as error:
self.config.option.from_pydantic({})
self.assertEqual(
error.exception.args[0],
2021-10-01 03:09:42 +03:00
"Unable to recognize settings instance, expect \"pydantic.BaseSettings\", "
"got {0} instead".format({})
)
2021-10-01 03:09:42 +03:00
@unittest.skipIf(sys.version_info[:2] < (3, 6), "Pydantic supports Python 3.6+")
def test_subclass_instead_of_instance(self):
with self.assertRaises(errors.Error) as error:
self.config.from_pydantic(self.Settings1)
self.assertEqual(
error.exception.args[0],
2021-10-01 03:09:42 +03:00
"Got settings class, but expect instance: "
"instead \"Settings1\" use \"Settings1()\""
)
2021-10-01 03:09:42 +03:00
@unittest.skipIf(sys.version_info[:2] < (3, 6), "Pydantic supports Python 3.6+")
def test_option_subclass_instead_of_instance(self):
with self.assertRaises(errors.Error) as error:
self.config.option.from_pydantic(self.Settings1)
self.assertEqual(
error.exception.args[0],
2021-10-01 03:09:42 +03:00
"Got settings class, but expect instance: "
"instead \"Settings1\" use \"Settings1()\""
)
2021-10-01 03:09:42 +03:00
@unittest.skipIf(sys.version_info[:2] < (3, 6), "Pydantic supports Python 3.6+")
def test_no_pydantic_installed(self):
@contextlib.contextmanager
def no_pydantic_module():
pydantic = providers.pydantic
providers.pydantic = None
yield
providers.pydantic = pydantic
with no_pydantic_module():
with self.assertRaises(errors.Error) as error:
self.config.from_pydantic(self.Settings1())
self.assertEqual(
error.exception.args[0],
2021-10-01 03:09:42 +03:00
"Unable to load pydantic configuration - pydantic is not installed. "
"Install pydantic or install Dependency Injector with pydantic extras: "
"\"pip install dependency-injector[pydantic]\"",
)
2021-10-01 03:09:42 +03:00
@unittest.skipIf(sys.version_info[:2] < (3, 6), "Pydantic supports Python 3.6+")
def test_option_no_pydantic_installed(self):
@contextlib.contextmanager
def no_pydantic_module():
pydantic = providers.pydantic
providers.pydantic = None
yield
providers.pydantic = pydantic
with no_pydantic_module():
with self.assertRaises(errors.Error) as error:
self.config.option.from_pydantic(self.Settings1())
self.assertEqual(
error.exception.args[0],
2021-10-01 03:09:42 +03:00
"Unable to load pydantic configuration - pydantic is not installed. "
"Install pydantic or install Dependency Injector with pydantic extras: "
"\"pip install dependency-injector[pydantic]\"",
)
class ConfigFromDict(unittest.TestCase):
def setUp(self):
2021-10-01 03:09:42 +03:00
self.config = providers.Configuration(name="config")
self.config_options_1 = {
2021-10-01 03:09:42 +03:00
"section1": {
"value1": "1",
},
2021-10-01 03:09:42 +03:00
"section2": {
"value2": "2",
},
}
self.config_options_2 = {
2021-10-01 03:09:42 +03:00
"section1": {
"value1": "11",
"value11": "11",
},
2021-10-01 03:09:42 +03:00
"section3": {
"value3": "3",
},
}
def test(self):
self.config.from_dict(self.config_options_1)
2021-10-01 03:09:42 +03:00
self.assertEqual(self.config(), {"section1": {"value1": "1"}, "section2": {"value2": "2"}})
self.assertEqual(self.config.section1(), {"value1": "1"})
self.assertEqual(self.config.section1.value1(), "1")
self.assertEqual(self.config.section2(), {"value2": "2"})
self.assertEqual(self.config.section2.value2(), "2")
def test_merge(self):
self.config.from_dict(self.config_options_1)
self.config.from_dict(self.config_options_2)
self.assertEqual(
self.config(),
{
2021-10-01 03:09:42 +03:00
"section1": {
"value1": "11",
"value11": "11",
},
2021-10-01 03:09:42 +03:00
"section2": {
"value2": "2",
},
2021-10-01 03:09:42 +03:00
"section3": {
"value3": "3",
},
},
)
2021-10-01 03:09:42 +03:00
self.assertEqual(self.config.section1(), {"value1": "11", "value11": "11"})
self.assertEqual(self.config.section1.value1(), "11")
self.assertEqual(self.config.section1.value11(), "11")
self.assertEqual(self.config.section2(), {"value2": "2"})
self.assertEqual(self.config.section2.value2(), "2")
self.assertEqual(self.config.section3(), {"value3": "3"})
self.assertEqual(self.config.section3.value3(), "3")
def test_empty_dict(self):
self.config.from_dict({})
self.assertEqual(self.config(), {})
def test_option_empty_dict(self):
self.config.option.from_dict({})
self.assertEqual(self.config.option(), {})
def test_empty_dict_in_strict_mode(self):
self.config = providers.Configuration(strict=True)
with self.assertRaises(ValueError):
self.config.from_dict({})
def test_option_empty_dict_in_strict_mode(self):
self.config = providers.Configuration(strict=True)
with self.assertRaises(ValueError):
self.config.option.from_dict({})
def test_required_empty_dict(self):
with self.assertRaises(ValueError):
self.config.from_dict({}, required=True)
def test_required_option_empty_dict(self):
with self.assertRaises(ValueError):
self.config.option.from_dict({}, required=True)
def test_not_required_empty_dict_strict_mode(self):
self.config = providers.Configuration(strict=True)
self.config.from_dict({}, required=False)
self.assertEqual(self.config(), {})
def test_not_required_option_empty_dict_strict_mode(self):
self.config = providers.Configuration(strict=True)
self.config.option.from_dict({}, required=False)
self.assertEqual(self.config.option(), {})
2021-10-01 03:09:42 +03:00
self.assertEqual(self.config(), {"option": {}})
class ConfigFromEnvTests(unittest.TestCase):
def setUp(self):
2021-10-01 03:09:42 +03:00
self.config = providers.Configuration(name="config")
os.environ["CONFIG_TEST_ENV"] = "test-value"
def tearDown(self):
del self.config
2021-10-01 03:09:42 +03:00
del os.environ["CONFIG_TEST_ENV"]
def test(self):
2021-10-01 03:09:42 +03:00
self.config.from_env("CONFIG_TEST_ENV")
self.assertEqual(self.config(), "test-value")
def test_with_children(self):
2021-10-01 03:09:42 +03:00
self.config.section1.value1.from_env("CONFIG_TEST_ENV")
2021-10-01 03:09:42 +03:00
self.assertEqual(self.config(), {"section1": {"value1": "test-value"}})
self.assertEqual(self.config.section1(), {"value1": "test-value"})
self.assertEqual(self.config.section1.value1(), "test-value")
def test_default(self):
2021-10-01 03:09:42 +03:00
self.config.from_env("UNDEFINED_ENV", "default-value")
self.assertEqual(self.config(), "default-value")
def test_default_none(self):
2021-10-01 03:09:42 +03:00
self.config.from_env("UNDEFINED_ENV")
self.assertIsNone(self.config())
def test_option_default_none(self):
2021-10-01 03:09:42 +03:00
self.config.option.from_env("UNDEFINED_ENV")
self.assertIsNone(self.config.option())
def test_undefined_in_strict_mode(self):
self.config = providers.Configuration(strict=True)
with self.assertRaises(ValueError):
2021-10-01 03:09:42 +03:00
self.config.from_env("UNDEFINED_ENV")
def test_option_undefined_in_strict_mode(self):
self.config = providers.Configuration(strict=True)
with self.assertRaises(ValueError):
2021-10-01 03:09:42 +03:00
self.config.option.from_env("UNDEFINED_ENV")
def test_undefined_in_strict_mode_with_default(self):
self.config = providers.Configuration(strict=True)
2021-10-01 03:09:42 +03:00
self.config.from_env("UNDEFINED_ENV", "default-value")
self.assertEqual(self.config(), "default-value")
def test_option_undefined_in_strict_mode_with_default(self):
self.config = providers.Configuration(strict=True)
2021-10-01 03:09:42 +03:00
self.config.option.from_env("UNDEFINED_ENV", "default-value")
self.assertEqual(self.config.option(), "default-value")
def test_required_undefined(self):
with self.assertRaises(ValueError):
2021-10-01 03:09:42 +03:00
self.config.from_env("UNDEFINED_ENV", required=True)
def test_required_undefined_with_default(self):
2021-10-01 03:09:42 +03:00
self.config.from_env("UNDEFINED_ENV", default="default-value", required=True)
self.assertEqual(self.config(), "default-value")
def test_option_required_undefined(self):
with self.assertRaises(ValueError):
2021-10-01 03:09:42 +03:00
self.config.option.from_env("UNDEFINED_ENV", required=True)
def test_option_required_undefined_with_default(self):
2021-10-01 03:09:42 +03:00
self.config.option.from_env("UNDEFINED_ENV", default="default-value", required=True)
self.assertEqual(self.config.option(), "default-value")
def test_not_required_undefined_in_strict_mode(self):
self.config = providers.Configuration(strict=True)
2021-10-01 03:09:42 +03:00
self.config.from_env("UNDEFINED_ENV", required=False)
self.assertIsNone(self.config())
def test_option_not_required_undefined_in_strict_mode(self):
self.config = providers.Configuration(strict=True)
2021-10-01 03:09:42 +03:00
self.config.option.from_env("UNDEFINED_ENV", required=False)
self.assertIsNone(self.config.option())
def test_not_required_undefined_with_default_in_strict_mode(self):
self.config = providers.Configuration(strict=True)
2021-10-01 03:09:42 +03:00
self.config.from_env("UNDEFINED_ENV", default="default-value", required=False)
self.assertEqual(self.config(), "default-value")
def test_option_not_required_undefined_with_default_in_strict_mode(self):
self.config = providers.Configuration(strict=True)
2021-10-01 03:09:42 +03:00
self.config.option.from_env("UNDEFINED_ENV", default="default-value", required=False)
self.assertEqual(self.config.option(), "default-value")
class ConfigFromValueTests(unittest.TestCase):
def setUp(self):
2021-10-01 03:09:42 +03:00
self.config = providers.Configuration(name="config")
def test_from_value(self):
test_value = 123321
self.config.from_value(test_value)
self.assertEqual(self.config(), test_value)
def test_option_from_value(self):
test_value_1 = 123
test_value_2 = 321
self.config.option1.from_value(test_value_1)
self.config.option2.from_value(test_value_2)
2021-10-01 03:09:42 +03:00
self.assertEqual(self.config(), {"option1": test_value_1, "option2": test_value_2})
self.assertEqual(self.config.option1(), test_value_1)
self.assertEqual(self.config.option2(), test_value_2)