Remove repeated defaults from streams-bootstrap values

kpops/components/common/kubernetes_model.py

@@ -1,13 +1,12 @@
 import enum
+from typing import Annotated
 
+import pydantic
 from pydantic import Field
 
 from kpops.utils.docstring import describe_attr
 from kpops.utils.pydantic import DescConfigModel
 
-# Matches plain integer or numbers with valid suffixes: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-memory
-MEMORY_PATTERN = r"^\d+([EPTGMk]|Ei|Pi|Ti|Gi|Mi|Ki)?$"
-
 
 class ServiceType(str, enum.Enum):
     """Represents the different Kubernetes service types.
@@ -72,13 +71,11 @@ class Toleration(DescConfigModel):
     :param toleration_seconds: The duration for which the toleration is valid.
     """
 
-    key: str = Field(default=..., description=describe_attr("key", __doc__))
+    key: str = Field(description=describe_attr("key", __doc__))
 
-    operator: Operation = Field(
-        default=Operation.EQUAL, description=describe_attr("operator", __doc__)
-    )
+    operator: Operation = Field(description=describe_attr("operator", __doc__))
 
-    effect: Effects = Field(default=..., description=describe_attr("effect", __doc__))
+    effect: Effects = Field(description=describe_attr("effect", __doc__))
 
     value: str | None = Field(default=None, description=describe_attr("value", __doc__))
 
@@ -87,16 +84,27 @@ class Toleration(DescConfigModel):
     )
 
 
+CPUStr = Annotated[str, pydantic.StringConstraints(pattern=r"^\d+m$")]
+MemoryStr = Annotated[
+    # Matches plain number string or number with valid suffixes: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-memory
+    str, pydantic.StringConstraints(pattern=r"^\d+([EPTGMk]|Ei|Pi|Ti|Gi|Mi|Ki)?$")
+]
+
+
 class ResourceDefinition(DescConfigModel):
-    """Model representing the 'limits' or `request` section of Kubernetes resource specifications.
+    """Model representing the `limits` or `requests` section of Kubernetes resource specifications.
 
     :param cpu: The maximum amount of CPU a container can use, expressed in milli CPUs (e.g., '300m').
-    :param memory: The maximum amount of memory a container can use, with valid units such as 'Mi' or 'Gi' (e.g., '2G').
+    :param memory: The maximum amount of memory a container can use, as integer or string with valid units such as 'Mi' or 'Gi' (e.g., '2G').
     """
 
-    cpu: str | int = Field(pattern=r"^\d+m$", description=describe_attr("cpu", __doc__))
-    memory: str = Field(
-        pattern=MEMORY_PATTERN, description=describe_attr("memory", __doc__)
+    cpu: CPUStr | pydantic.PositiveInt | None = Field(
+        default=None,
+        description=describe_attr("cpu", __doc__),
+    )
+    memory: MemoryStr | pydantic.PositiveInt | None = Field(
+        default=None,
+        description=describe_attr("memory", __doc__),
     )
 
 

kpops/components/streams_bootstrap/base.py

@@ -76,7 +76,9 @@ def version_validator(cls, version: str) -> str:
 
     @pydantic.model_validator(mode="after")
     def warning_for_latest_image_tag(self) -> Self:
-        if self.validate_ and self.values.image_tag == "latest":
+        if self.validate_ and (
+            not self.values.image_tag or self.values.image_tag == "latest"
+        ):
             log.warning(
                 f"The image tag for component '{self.name}' is set or defaulted to 'latest'. Please, consider providing a stable image tag."
             )

kpops/components/streams_bootstrap/model.py

@@ -9,7 +9,6 @@
 from kpops.components.common.kubernetes_model import (
     ImagePullPolicy,
     ProtocolSchema,
-    ResourceDefinition,
     Resources,
     ServiceType,
     Toleration,
@@ -69,8 +68,8 @@ class ServiceConfig(CamelCaseConfigModel, DescConfigModel):
         default_factory=dict,
         description=describe_attr("labels", __doc__),
     )
-    type: ServiceType = Field(
-        default=ServiceType.CLUSTER_IP,
+    type: ServiceType | None = Field(
+        default=None,
         description=describe_attr("type", __doc__),
     )
 
@@ -82,8 +81,8 @@ class JavaOptions(CamelCaseConfigModel, DescConfigModel):
     :param others: List of Java VM options passed to the streams app.
     """
 
-    max_RAM_percentage: int = Field(
-        default=75,
+    max_RAM_percentage: int | None = Field(
+        default=None,
         description=describe_attr("max_RAM_percentage", __doc__),
     )
     others: list[str] = Field(
@@ -120,14 +119,14 @@ class StreamsBootstrapValues(HelmAppValues):
         description=describe_attr("image", __doc__),
     )
 
-    image_tag: str = Field(
-        default="latest",
+    image_tag: str | None = Field(
+        default=None,
         pattern=IMAGE_TAG_PATTERN,
         description=describe_attr("image_tag", __doc__),
     )
 
-    image_pull_policy: ImagePullPolicy = Field(
-        default=ImagePullPolicy.ALWAYS,
+    image_pull_policy: ImagePullPolicy | None = Field(
+        default=None,
         description=describe_attr("image_pull_policy", __doc__),
     )
 
@@ -140,11 +139,8 @@ class StreamsBootstrapValues(HelmAppValues):
         description=describe_attr("kafka", __doc__),
     )
 
-    resources: Resources = Field(
-        default=Resources(
-            requests=ResourceDefinition(cpu="100m", memory="500Mi"),
-            limits=ResourceDefinition(cpu="300m", memory="2G"),
-        ),
+    resources: Resources | None = Field(
+        default=None,
         description=describe_attr("resources", __doc__),
     )
 
@@ -153,13 +149,13 @@ class StreamsBootstrapValues(HelmAppValues):
         description=describe_attr("ports", __doc__),
     )
 
-    service: ServiceConfig = Field(
-        default_factory=ServiceConfig,
+    service: ServiceConfig | None = Field(
+        default=None,
         description=describe_attr("service", __doc__),
     )
 
-    configuration_env_prefix: str = Field(
-        default="APP",
+    configuration_env_prefix: str | None = Field(
+        default=None,
         description=describe_attr("configuration_env_prefix", __doc__),
     )
 
@@ -193,8 +189,8 @@ class StreamsBootstrapValues(HelmAppValues):
         description=describe_attr("files", __doc__),
     )
 
-    java_options: JavaOptions = Field(
-        default_factory=JavaOptions,
+    java_options: JavaOptions | None = Field(
+        default=None,
         description=describe_attr("java_options", __doc__),
     )
 

kpops/components/streams_bootstrap/streams/model.py

@@ -7,7 +7,6 @@
 
 from kpops.components.common.kubernetes_model import (
     ImagePullPolicy,
-    ResourceDefinition,
     Resources,
 )
 from kpops.components.common.topic import KafkaTopic, KafkaTopicStr
@@ -217,7 +216,7 @@ class PersistenceConfig(BaseModel):
 
     enabled: bool = Field(
         default=False,
-        description="Whether to use a persistent volume to store the state of the streams app.	",
+        description="Whether to use a persistent volume to store the state of the streams app.",
     )
     size: str | None = Field(
         default=None,
@@ -247,36 +246,33 @@ class PrometheusJMXExporterConfig(CamelCaseConfigModel, DescConfigModel):
         :param resources: JMX Exporter resources configuration.
         """
 
-        enabled: bool = Field(
-            default=True,
+        enabled: bool | None = Field(
+            default=None,
             description=describe_attr("enabled", __doc__),
         )
-        image: str = Field(
-            default="solsson/kafka-prometheus-jmx-exporter@sha256",
+        image: str | None = Field(
+            default=None,
             description=describe_attr("image", __doc__),
         )
-        image_tag: str = Field(
-            default="6f82e2b0464f50da8104acd7363fb9b995001ddff77d248379f8788e78946143",
+        image_tag: str | None = Field(
+            default=None,
             description=describe_attr("image_tag", __doc__),
         )
-        image_pull_policy: ImagePullPolicy = Field(
-            default=ImagePullPolicy.IF_NOT_PRESENT,
+        image_pull_policy: ImagePullPolicy | None = Field(
+            default=None,
             description=describe_attr("image_pull_policy", __doc__),
         )
-        port: int = Field(
-            default=5556,
+        port: int | None = Field(
+            default=None,
             description=describe_attr("port", __doc__),
         )
-        resources: Resources = Field(
-            default=Resources(
-                requests=ResourceDefinition(cpu="100m", memory="500Mi"),
-                limits=ResourceDefinition(cpu="300m", memory="2G"),
-            ),
+        resources: Resources | None = Field(
+            default=None,
             description=describe_attr("resources", __doc__),
         )
 
-    jmx: PrometheusJMXExporterConfig = Field(
-        default_factory=PrometheusJMXExporterConfig,
+    jmx: PrometheusJMXExporterConfig | None = Field(
+        default=None,
         description=describe_attr("jmx", __doc__),
     )
 
@@ -288,13 +284,13 @@ class JMXConfig(CamelCaseConfigModel, DescConfigModel):
     :param metric_rules: List of JMX metric rules.
     """
 
-    port: int = Field(
-        default=5555,
+    port: int | None = Field(
+        default=None,
         description=describe_attr("port", __doc__),
     )
 
     metric_rules: list[str] = Field(
-        default=[".*"],
+        default_factory=list,
         description=describe_attr("metric_rules", __doc__),
     )
 
@@ -332,18 +328,18 @@ class StreamsAppValues(StreamsBootstrapValues):
         description=describe_attr("persistence", __doc__),
     )
 
-    prometheus: PrometheusExporterConfig = Field(
-        default_factory=PrometheusExporterConfig,
+    prometheus: PrometheusExporterConfig | None = Field(
+        default=None,
         description=describe_attr("prometheus", __doc__),
     )
 
-    jmx: JMXConfig = Field(
-        default_factory=JMXConfig,
+    jmx: JMXConfig | None = Field(
+        default=None,
         description=describe_attr("jmx", __doc__),
     )
 
-    termination_grace_period_seconds: int = Field(
-        default=300,
+    termination_grace_period_seconds: int | None = Field(
+        default=None,
         description=describe_attr("termination_grace_period_seconds", __doc__),
     )
 

tests/components/streams_bootstrap/test_streams_bootstrap.py

@@ -1,6 +1,9 @@
 import re
+from contextlib import nullcontext as does_not_raise
+from typing import Any
 
 import pytest
+from _pytest.python_api import RaisesContext
 from pydantic import ValidationError
 from pytest_mock import MockerFixture
 
@@ -9,6 +12,7 @@
     HelmUpgradeInstallFlags,
 )
 from kpops.component_handlers.helm_wrapper.utils import create_helm_release_name
+from kpops.components.common.kubernetes_model import ResourceDefinition
 from kpops.components.streams_bootstrap.base import StreamsBootstrap
 from kpops.components.streams_bootstrap.model import StreamsBootstrapValues
 
@@ -34,7 +38,7 @@ def test_default_configs(self):
         )
         assert streams_bootstrap.version == "3.0.1"
         assert streams_bootstrap.namespace == "test-namespace"
-        assert streams_bootstrap.values.image_tag == "latest"
+        assert streams_bootstrap.values.image_tag is None
 
     @pytest.mark.asyncio()
     async def test_should_deploy_streams_bootstrap_app(self, mocker: MockerFixture):
@@ -126,3 +130,52 @@ async def test_should_raise_validation_error_for_invalid_helm_chart_version(self
                     "version": "2.1.0",
                 },
             )
+
+    @pytest.mark.parametrize(
+        ("input", "expectation"),
+        [
+            pytest.param({"cpu": 1}, does_not_raise(), id="cpu int"),
+            pytest.param({"cpu": "1"}, does_not_raise(), id="cpu str without unit"),
+            pytest.param({"cpu": "10m"}, does_not_raise(), id="cpu str milli CPU"),
+            pytest.param(
+                {"cpu": "100foo"},
+                pytest.raises(ValidationError),
+                id="cpu str disallow regex mismatch",
+            ),
+            pytest.param(
+                {"cpu": 0}, pytest.raises(ValidationError), id="cpu int disallow 0"
+            ),
+            pytest.param(
+                {"cpu": -1},
+                pytest.raises(ValidationError),
+                id="cpu int disallow negative",
+            ),
+            pytest.param({"memory": 1}, does_not_raise(), id="memory int"),
+            pytest.param(
+                {"memory": "1"}, does_not_raise(), id="memory str without unit"
+            ),
+            pytest.param({"memory": "10G"}, does_not_raise(), id="memory str gigabyte"),
+            pytest.param({"memory": "1Gi"}, does_not_raise(), id="memory str gibibyte"),
+            pytest.param({"memory": "10M"}, does_not_raise(), id="memory str megabyte"),
+            pytest.param(
+                {"memory": "10Mi"}, does_not_raise(), id="memory str mebibyte"
+            ),
+            pytest.param(
+                {"memory": 0},
+                pytest.raises(ValidationError),
+                id="memory int disallow 0",
+            ),
+            pytest.param(
+                {"memory": -1},
+                pytest.raises(ValidationError),
+                id="memory int disallow negative",
+            ),
+        ],
+    )
+    def test_resource_definition(
+        self,
+        input: dict[str, Any],
+        expectation: RaisesContext[ValidationError] | does_not_raise[None],
+    ):
+        with expectation:
+            assert ResourceDefinition.model_validate(input)