Merge pull request #305 from minos-framework/issue-150-config-v2

#150 - Add `ConfigV2`

Author: Sergio García Prado

packages/core/minos-microservice-common/minos/common/__init__.py

@@ -3,11 +3,13 @@
 __version__ = "0.5.3"
 
 from .builders import (
+    BuildableMixin,
     Builder,
 )
 from .config import (
     Config,
     ConfigV1,
+    ConfigV2,
     MinosConfig,
 )
 from .database import (

packages/core/minos-microservice-common/minos/common/builders.py

@@ -70,4 +70,34 @@ def build(self) -> Instance:
         """
 
 
+Ins = TypeVar("Ins", bound="BuildableMixin")
+
+
+class BuildableMixin(SetupMixin):
+    """Buildable Mixin class."""
+
+    _builder_cls: type[Builder[Ins]]
+
+    @classmethod
+    def _from_config(cls: type[Ins], config: Config, **kwargs) -> Ins:
+        return cls.get_builder().new().with_config(config).with_kwargs(kwargs).build()
+
+    @classmethod
+    def set_builder(cls: type[Ins], builder: type[Builder[Ins]]) -> None:
+        """Set a builder class.
+
+        :param builder: The builder class to be set.
+        :return: This method does not return anything.
+        """
+        cls._builder_cls = builder
+
+    @classmethod
+    def get_builder(cls) -> type[Builder[Ins]]:
+        """Get the builder class.
+
+        :return: A ``Builder`` subclass.
+        """
+        return cls._builder_cls
+
+
 B = TypeVar("B", bound=Builder)

packages/core/minos-microservice-common/minos/common/config/__init__.py

@@ -5,3 +5,6 @@
 from .v1 import (
     ConfigV1,
 )
+from .v2 import (
+    ConfigV2,
+)

packages/core/minos-microservice-common/minos/common/config/abc.py

@@ -14,6 +14,9 @@
 from collections.abc import (
     Callable,
 )
+from contextlib import (
+    suppress,
+)
 from pathlib import (
     Path,
 )
@@ -45,9 +48,6 @@
 class Config(ABC):
     """Config base class."""
 
-    _PARAMETERIZED_MAPPER: dict = dict()
-    _ENVIRONMENT_MAPPER: dict = dict()
-
     __slots__ = ("_file_path", "_data", "_with_environment", "_parameterized")
 
     def __init__(self, path: Union[Path, str], with_environment: bool = True, **kwargs):
@@ -68,11 +68,15 @@ def __new__(cls, *args, **kwargs) -> Config:
         from .v1 import (
             ConfigV1,
         )
+        from .v2 import (
+            ConfigV2,
+        )
 
         version_mapper = defaultdict(
             lambda: ConfigV1,
             {
                 1: ConfigV1,
+                2: ConfigV2,
             },
         )
 
@@ -185,6 +189,17 @@ def get_interfaces(self) -> dict[str, dict[str, Any]]:
     def _get_interfaces(self) -> dict[str, dict[str, Any]]:
         raise NotImplementedError
 
+    def get_pools(self) -> dict[str, type]:
+        """Get the pools value.
+
+        :return: A ``dict`` with pool names as keys and pools as values.
+        """
+        return self._get_pools()
+
+    @abstractmethod
+    def _get_pools(self) -> dict[str, type]:
+        raise NotImplementedError
+
     def get_routers(self) -> list[type]:
         """Get the routers value.
 
@@ -266,26 +281,41 @@ def get_by_key(self, key: str) -> Any:
         :param key: The key that identifies the value.
         :return: A value instance.
         """
-        if key in self._PARAMETERIZED_MAPPER and self._PARAMETERIZED_MAPPER[key] in self._parameterized:
-            return self._parameterized[self._PARAMETERIZED_MAPPER[key]]
 
-        if self._with_environment and key in self._ENVIRONMENT_MAPPER and self._ENVIRONMENT_MAPPER[key] in os.environ:
-            return os.environ[self._ENVIRONMENT_MAPPER[key]]
+        def _fn(k: str, data: dict[str, Any], previous: str) -> Any:
+            current, _sep, following = k.partition(".")
+            full = f"{previous}.{current}".lstrip(".")
+
+            with suppress(KeyError):
+                return self._parameterized[self._to_parameterized_variable(full)]
 
-        def _fn(k: str, data: dict[str, Any]) -> Any:
-            current, _, following = k.partition(".")
+            if self._with_environment:
+                with suppress(KeyError):
+                    return os.environ[self._to_environment_variable(full)]
 
             part = data[current]
             if not following:
-                return part
+                if not isinstance(part, dict):
+                    return part
 
-            return _fn(following, part)
+                result = dict()
+                for subpart in part:
+                    result[subpart] = _fn(subpart, part, full)
+                return result
+
+            return _fn(following, part, full)
 
         try:
-            return _fn(key, self._data)
+            return _fn(key, self._data, str())
         except Exception:
             raise MinosConfigException(f"{key!r} field is not defined on the configuration!")
 
+    def _to_parameterized_variable(self, key: str) -> str:
+        raise KeyError
+
+    def _to_environment_variable(self, key: str) -> str:
+        raise KeyError
+
 
 # noinspection PyUnusedLocal
 def _get_version(path: Union[str, Path], *args, **kwargs) -> int:

packages/core/minos-microservice-common/minos/common/config/v1.py

@@ -112,6 +112,7 @@ def _get_name(self) -> str:
     def _get_aggregate(self) -> dict[str, Any]:
         return {
             "entities": [self.get_type_by_key("service.aggregate")],
+            "repositories": dict(),
         }
 
     def _get_saga(self) -> dict[str, Any]:
@@ -203,6 +204,9 @@ def _get_services(self) -> list[type]:
 
         return services
 
+    def _get_pools(self) -> dict[str, type]:
+        return dict()
+
     def _get_routers(self) -> list[type]:
         try:
             routers = self.get_by_key("routers")
@@ -279,3 +283,9 @@ def _get_discovery(self) -> dict[str, Any]:
             "host": self.get_by_key("discovery.host"),
             "port": self.get_by_key("discovery.port"),
         }
+
+    def _to_parameterized_variable(self, key: str) -> str:
+        return self._PARAMETERIZED_MAPPER[key]
+
+    def _to_environment_variable(self, key: str) -> str:
+        return self._ENVIRONMENT_MAPPER[key]