Logoscore: Framework changes (#317)

 Framework changes for Logoscore

Author: PearsonWhite

pyproject.toml

@@ -39,4 +39,4 @@ python_files = ["test_*.py"]
 python_classes = ["Test*"]
 python_functions = ["test_*"]
 asyncio_mode = "auto"
-addopts = "-ra"
+addopts = "-ra --import-mode=importlib"

src/deployments/core/builders.py

@@ -30,7 +30,7 @@
     build_pod_spec,
     build_pod_template_spec,
 )
-from src.deployments.core.configs.service import ServiceConfig, build_service
+from src.deployments.core.configs.service import ServiceConfig, ServiceSpecType, build_service
 from src.deployments.core.configs.statefulset import StatefulSetConfig, build_stateful_set
 
 logger = logging.getLogger(__name__)
@@ -42,7 +42,9 @@ class StatefulSetBuilder(BaseModel):
     def with_image_in_container(
         self, image: Image, container_name: str, *, overwrite: bool = False
     ) -> Self:
-        with_image_for_container(self.config, container_name, image, overwrite=overwrite)
+        with_image_for_container(
+            config=self.config, image=image, container_name=container_name, overwrite=overwrite
+        )
         return self
 
     def with_replicas(self, replicas: int) -> Self:
@@ -115,8 +117,78 @@ def build(self) -> V1StatefulSet:
 class PodBuilder(BaseModel):
     config: PodConfig = Field(default_factory=PodConfig)
 
-    def with_app(self, app: str, *, overwrite: bool = False) -> Self:
-        self.config.with_app(app, overwrite=overwrite)
+    def model_post_init(self, __context) -> None:
+        self._register_dependencies()
+
+    @property
+    def name(self) -> str | None:
+        return self.config.name
+
+    @name.setter
+    def name(self, value: str) -> None:
+        self.config.name = value
+        self._reconcile("name")
+
+    @property
+    def namespace(self) -> str | None:
+        return self.config.namespace
+
+    @namespace.setter
+    def namespace(self, value: str) -> None:
+        self.config.namespace = value
+        self._reconcile("namespace")
+
+    @property
+    def app(self) -> str | None:
+        try:
+            return self.config.labels["app"]
+        except (TypeError, KeyError):
+            return None
+
+    @app.setter
+    def app(self, value: str) -> None:
+        self.config.with_app(value, overwrite=True)
+        self._reconcile("app")
+
+    def with_name(self, name: str) -> Self:
+        self.name = name
+        return self
+
+    def with_namespace(self, namespace: str) -> Self:
+        self.namespace = namespace
+        return self
+
+    def with_app(self, app: str) -> Self:
+        self.app = app
+        return self
+
+    def with_image_in_container(
+        self, image: Image, container_name: str, *, overwrite: bool = False
+    ) -> Self:
+        with_image_for_container(
+            config=self.config, image=image, container_name=container_name, overwrite=overwrite
+        )
+        return self
+
+    def _register_dependencies(self) -> None:
+        self._dependency_registry = {}
+        for cls in type(self).mro():
+            for name, maybe_method in cls.__dict__.items():
+                fields = getattr(maybe_method, "_depends_on_fields", None)
+                if fields:
+                    for field in fields:
+                        self._dependency_registry.setdefault(field, []).append(name)
+
+    def _reconcile(self, changed_field: Optional[str] = None) -> Self:
+        if changed_field is None:
+            return self
+
+        for method_name in self._dependency_registry.get(changed_field, []):
+            method = getattr(self, method_name)
+            required_fields = getattr(method, "_depends_on_fields", set())
+            if all(getattr(self, field, None) is not None for field in required_fields):
+                method()
+
         return self
 
     def build(self) -> V1Pod:
@@ -142,10 +214,12 @@ def with_selector(self, key: str, value: str) -> Self:
         self.config.service_spec.with_selector(key, value)
         return self
 
-    def with_port(self, port: V1ServicePort) -> Self:
-        if self.config.service_spec.ports is None:
-            self.config.service_spec.ports = []
-        self.config.service_spec.ports.append(port)
+    def with_port(self, new_port: V1ServicePort) -> Self:
+        self.config.service_spec.with_port(new_port)
+        return self
+
+    def with_type(self, spec_type: ServiceSpecType) -> Self:
+        self.config.service_spec.spec_type = spec_type
         return self
 
     def with_publish_not_ready_addresses(self, value: bool = True) -> Self:

src/deployments/core/configs/command.py

@@ -9,6 +9,8 @@
 
 T = TypeVar("T")
 
+_sentinel = object()
+
 
 class Command(BaseModel):
     pre_command: Optional[str] = None
@@ -162,13 +164,13 @@ def insert_commands(
         *,
         index: Optional[SupportsIndex] = None,
     ):
-        """Insert multiple commands starting at a given index.
+        """Insert multiple commands before the given index.
 
         :param commands: List of commands to insert. `str` commands are assumed to have no args.
 
         :param index: Starting position. If None, appends all commands to the end."""
         indices = (
-            [position for position in range(index, len(commands))]
+            [position for position in range(index, len(commands) + 1)]
             if index is not None
             else [None for _ in range(len(commands))]
         )
@@ -189,18 +191,16 @@ def insert_command(
         if args is None:
             args = []
         if index is None:
-            index = len(self.commands)
+            index = len(self.commands) + 1
         self.commands.insert(index, Command(command=command, args=args, multiline=multiline))
 
-    _sentinel = object()
-
-    def find_command(self, command_name: str) -> Command | None:
+    def find_command(self, command_name: str, default: str | object = _sentinel) -> Command | None:
         """Finds the Command for the given command in the ContainerConfig"""
         result = next(
             (command for command in self.commands if command.command == command_name),
-            None,
+            default,
         )
-        if result is CommandConfig._sentinel:
+        if result is _sentinel:
             raise CommandNotFoundError(
                 f"Failed to find command in config. name: `{command_name}` config: `{self}`"
             )

src/deployments/core/configs/container.py

@@ -95,7 +95,7 @@ def with_env_var(self, var: V1EnvVar, *, overwrite: bool = False):
         index = next(
             iter([index for index, item in enumerate(self.env) if item.name == var.name]), None
         )
-        if index:
+        if index is not None:
             if not overwrite:
                 raise ValueError(
                     f"Attempt to add duplicate environment variable to {type(self)}. "

src/deployments/core/configs/helpers/identity.py

@@ -0,0 +1,52 @@
+# Python Imports
+from typing import Optional
+
+# Project Imports
+from src.deployments.core.configs.helpers.utils import HigherConfigTypes
+from src.deployments.core.configs.pod import PodConfig, PodTemplateSpecConfig
+from src.deployments.core.configs.statefulset import StatefulSetConfig, StatefulSetSpecConfig
+
+
+def apply_pod_config(config: PodConfig, namespace: str, name: str, app: str):
+    config.name = name
+    config.namespace = namespace
+    if app:
+        config.with_app(app, overwrite=True)
+
+
+def apply_pod_template_spec_config(
+    config: PodTemplateSpecConfig, namespace: str, name: str, app: str
+):
+    config.name = name
+    config.namespace = namespace
+    if app:
+        config.with_app(app, overwrite=True)
+
+
+def apply_stateful_set_spec_config(
+    config: StatefulSetSpecConfig, namespace: str, name: str, app: str
+):
+    if app:
+        config.with_app(app, overwrite=True)
+    apply_pod_template_spec_config(config.pod_template_spec_config, namespace, name, app)
+
+
+def apply_stateful_set_config(
+    config: StatefulSetConfig, namespace: str, name: str, app: Optional[str] = None
+):
+    config.name = name
+    config.namespace = namespace
+    apply_stateful_set_spec_config(config.stateful_set_spec, namespace, name, app)
+
+
+def apply_identity(config: HigherConfigTypes, name: str, namespace: str, app: Optional[str] = None):
+    if isinstance(config, StatefulSetConfig):
+        return apply_stateful_set_config(config, namespace=namespace, name=name, app=app)
+    if isinstance(config, StatefulSetSpecConfig):
+        return apply_stateful_set_spec_config(config, namespace=namespace, name=name, app=app)
+    if isinstance(config, PodConfig):
+        return apply_pod_config(config, namespace=namespace, name=name, app=app)
+    elif isinstance(config, PodTemplateSpecConfig):
+        return apply_pod_template_spec_config(config, namespace=namespace, name=name, app=app)
+
+    raise ValueError(f"Unknown config type: {type(config)}")

src/deployments/core/configs/helpers/tests/test_identity.py

@@ -0,0 +1,52 @@
+import pytest
+
+from src.deployments.core.configs.helpers.identity import apply_identity
+from src.deployments.core.configs.pod import PodConfig, PodTemplateSpecConfig
+from src.deployments.core.configs.statefulset import StatefulSetConfig, StatefulSetSpecConfig
+
+
+def test_apply_identity_on_pod_config():
+    config = PodConfig()
+    apply_identity(config, name="n", namespace="ns", app="app")
+    assert config.name == "n"
+    assert config.namespace == "ns"
+    assert config.labels["app"] == "app"
+
+
+def test_apply_identity_on_pod_template_spec_config():
+    config = PodTemplateSpecConfig()
+    apply_identity(config, name="n", namespace="ns", app="app")
+    assert config.name == "n"
+    assert config.namespace == "ns"
+    assert config.labels["app"] == "app"
+
+
+def test_apply_identity_on_statefulset_spec_config():
+    config = StatefulSetSpecConfig()
+    apply_identity(config, name="n", namespace="ns", app="app")
+    assert config.pod_template_spec_config.name == "n"
+    assert config.pod_template_spec_config.namespace == "ns"
+    assert config.pod_template_spec_config.labels["app"] == "app"
+
+
+def test_apply_identity_on_statefulset_config():
+    config = StatefulSetConfig()
+    apply_identity(config, name="n", namespace="ns", app="app")
+    assert config.name == "n"
+    assert config.namespace == "ns"
+    assert config.stateful_set_spec.pod_template_spec_config.name == "n"
+    assert config.stateful_set_spec.pod_template_spec_config.namespace == "ns"
+    assert config.stateful_set_spec.pod_template_spec_config.labels["app"] == "app"
+
+
+def test_apply_identity_without_app_does_not_set_label():
+    config = PodConfig()
+    apply_identity(config, name="n", namespace="ns", app=None)
+    assert config.name == "n"
+    assert config.namespace == "ns"
+    assert config.labels is None
+
+
+def test_apply_identity_unknown_type_raises():
+    with pytest.raises(ValueError):
+        apply_identity(object(), name="n", namespace="ns", app="app")

src/deployments/core/configs/helpers/utils.py

@@ -8,7 +8,7 @@
 # Project Imports
 from src.deployments.core.configs.command import CommandConfig
 from src.deployments.core.configs.container import ContainerConfig, Image
-from src.deployments.core.configs.pod import PodSpecConfig, PodTemplateSpecConfig
+from src.deployments.core.configs.pod import PodConfig, PodSpecConfig, PodTemplateSpecConfig
 from src.deployments.core.configs.statefulset import StatefulSetConfig, StatefulSetSpecConfig
 from src.deployments.core.k8s_object import dict_to_k8s_object
 
@@ -21,7 +21,7 @@ class ContainerNotFoundError(ValueError):
 
 
 HigherConfigTypes = (
-    StatefulSetConfig | StatefulSetSpecConfig | PodTemplateSpecConfig | PodSpecConfig
+    StatefulSetConfig | StatefulSetSpecConfig | PodConfig | PodTemplateSpecConfig | PodSpecConfig
 )
 
 
@@ -51,6 +51,9 @@ def check_done():
         if isinstance(config, StatefulSetSpecConfig):
             config = config.pod_template_spec_config
         check_done()
+        if isinstance(config, PodConfig):
+            config = config.pod_spec_config
+        check_done()
         if isinstance(config, PodTemplateSpecConfig):
             config = config.pod_spec_config
         check_done()
@@ -77,7 +80,7 @@ def find_container_config(
 
 
 def with_image_for_container(
-    config: StatefulSetSpecConfig | StatefulSetConfig | PodTemplateSpecConfig,
+    config: StatefulSetSpecConfig | StatefulSetConfig | PodTemplateSpecConfig | PodConfig,
     image: Image,
     container_name: str,
     *,

src/deployments/core/configs/pod.py

@@ -30,27 +30,48 @@ class PodSpecConfig(BaseModel):
     security_context: Optional[V1PodSecurityContext] = None
     automount_service_account_token: Optional[bool] = None
 
-    def with_dns_service(self, service: str, *, overwrite: bool = False):
+    def with_dns_search(self, dns_search: str, *, overwrite: bool = False):
         if self.dns_config is None:
             self.dns_config = V1PodDNSConfig(searches=[])
-
-        if service in self.dns_config.searches and not overwrite:
+        current_service = next(
+            (item for item in self.dns_config.searches if item == dns_search), None
+        )
+        if current_service:
+            if not overwrite:
+                raise ValueError(
+                    f"DNS service already exists in {type(self)}. service: `{dns_search}` config: `{self}`"
+                )
+            self.dns_config.searches.remove(current_service)
+        self.dns_config.searches.append(dns_search)
+
+    def remove_dns_search(self, dns_search: str, *, missing_ok: bool = True):
+        if self.dns_config is None:
+            if missing_ok == False:
+                raise ValueError(
+                    f"Attempted to remove nonexistent dns search. service: `{dns_search}` config: `{self}`"
+                )
+            return
+        current_service = next(
+            (item for item in self.dns_config.searches if item == dns_search), None
+        )
+        if not current_service:
+            if missing_ok:
+                return
             raise ValueError(
-                f"The {type(self)} already has dns service. "
-                f"service: `{service}` config: `{self}`"
+                f"Attempted to remove nonexistent dns search. service: `{dns_search}` config: `{self}`"
             )
-
-        self.dns_config.searches.append(service)
+        self.dns_config.searches.remove(current_service)
 
     def with_volume(self, volume: V1Volume, *, overwrite: bool = False):
         if self.volumes is None:
             self.volumes = []
-
-        if not overwrite and volume.name in [item.name for item in self.volumes]:
-            raise ValueError(
-                f"Volume already exists in {type(self)}. volume: `{volume}` config: `{self}`"
-            )
-
+        current_volume = next((item for item in self.volumes if item.name == volume.name), None)
+        if current_volume:
+            if not overwrite:
+                raise ValueError(
+                    f"Volume already exists in {type(self)}. volume: `{volume}` config: `{self}`"
+                )
+            self.volumes.remove(current_volume)
         self.volumes.append(volume)
 
     def add_init_container(