Merge pull request #2084 from DSD-DBS/expose-additional-ports

feat: Expose additional ports for sessions internally

backend/capellacollab/sessions/routes.py

@@ -24,6 +24,7 @@
 from capellacollab.tools import exceptions as tools_exceptions
 from capellacollab.tools import injectables as tools_injectables
 from capellacollab.tools import models as tools_models
+from capellacollab.tools import util as tools_util
 from capellacollab.users import crud as users_crud
 from capellacollab.users import exceptions as users_exceptions
 from capellacollab.users import injectables as users_injectables
@@ -205,7 +206,7 @@ async def request_session(
         tool=tool,
         environment=environment,
         init_environment=init_environment,
-        ports=connection_method.ports.model_dump(),
+        ports=tools_util.resolve_tool_ports(connection_method.ports),
         volumes=volumes,
         init_volumes=init_volumes,
         annotations=annotations,

backend/capellacollab/tools/models.py

@@ -29,6 +29,29 @@ class SessionPorts(core_pydantic.BaseModel):
         default=9118,
         description="Port of the metrics endpoint in the container.",
     )
+    additional: dict[str, int] = pydantic.Field(
+        default={},
+        description="Additional ports in a identifier/port mapping.",
+    )
+
+    @pydantic.model_validator(mode="after")
+    def check_additional_ports(self) -> t.Self:
+        if len(self.additional) != len(set(self.additional.values())):
+            raise ValueError("All additional ports must be unique.")
+        for identifier, port in self.additional.items():
+            if identifier in ("http", "metrics"):
+                raise ValueError(
+                    f"Identifier '{identifier}' is reserved and can't be used as additional identifier."
+                )
+            if port in (self.model_dump().values()):
+                raise ValueError(
+                    f"Port '{port}' of the identifier '{identifier}' is already in use."
+                )
+            if port == 80:
+                raise ValueError(
+                    f"Port '{port}' is reserved and can't be used as additional port."
+                )
+        return self
 
 
 class RDPPorts(SessionPorts):

backend/capellacollab/tools/util.py

@@ -0,0 +1,15 @@
+# SPDX-FileCopyrightText: Copyright DB InfraGO AG and contributors
+# SPDX-License-Identifier: Apache-2.0
+
+import typing as t
+
+if t.TYPE_CHECKING:
+    from . import models
+
+
+def resolve_tool_ports(ports: "models.SessionPorts") -> dict[str, int]:
+    model = ports.model_dump()
+    additional = model["additional"]
+    del model["additional"]
+
+    return model | additional

backend/tests/tools/test_tools.py

@@ -0,0 +1,56 @@
+# SPDX-FileCopyrightText: Copyright DB InfraGO AG and contributors
+# SPDX-License-Identifier: Apache-2.0
+
+import pytest
+
+from capellacollab.tools import models as tools_models
+from capellacollab.tools import util as tools_util
+
+
+def test_additional_ports_are_unique():
+    with pytest.raises(ValueError):
+        tools_models.HTTPPorts(
+            metrics=9118,
+            http=8080,
+            additional={"restapi": 5007, "restapi2": 5007},
+        )
+
+
+def test_additional_ports_not_reserved_keys():
+    with pytest.raises(ValueError):
+        tools_models.HTTPPorts(
+            metrics=9118,
+            http=8080,
+            additional={"http": 5007},
+        )
+
+
+def test_additional_port_already_in_use():
+    with pytest.raises(ValueError):
+        tools_models.HTTPPorts(
+            metrics=9118,
+            http=8080,
+            additional={"restapi": 8080},
+        )
+
+
+def test_additional_ports_reserved_port():
+    with pytest.raises(ValueError):
+        tools_models.HTTPPorts(
+            metrics=9118,
+            http=8080,
+            additional={"test": 80},
+        )
+
+
+def test_environment_resolution():
+    ports = tools_models.HTTPPorts(
+        metrics=9118,
+        http=8080,
+        additional={"restapi": 5007},
+    )
+    assert tools_util.resolve_tool_ports(ports) == {
+        "metrics": 9118,
+        "http": 8080,
+        "restapi": 5007,
+    }

frontend/src/storybook/tool.ts

@@ -20,6 +20,7 @@ export const mockHttpConnectionMethod: Readonly<HTTPConnectionMethodOutput> = {
   ports: {
     http: 0,
     metrics: 0,
+    additional: {},
   },
   environment: {},
   redirect_url: 'https://example.com',