port-ocean 0.24.20__tar.gz → 0.24.22__tar.gz

{port_ocean-0.24.20 → port_ocean-0.24.22}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: port-ocean
-Version: 0.24.20
+Version: 0.24.22
 Summary: Port Ocean is a CLI tool for managing your Port projects.
 Home-page: https://app.getport.io
 Keywords: ocean,port-ocean,port

{port_ocean-0.24.20 → port_ocean-0.24.22}/port_ocean/clients/port/mixins/integrations.py

@@ -228,9 +228,11 @@ class IntegrationClientMixin:
     async def put_integration_sync_metrics(self, kind_metrics: dict[str, Any]) -> None:
         logger.debug("starting PUT metrics request", kind_metrics=kind_metrics)
         metrics_attributes = await self.get_metrics_attributes()
+        event_id = quote_plus(kind_metrics["eventId"])
+        kind_identifier = quote_plus(kind_metrics["kindIdentifier"])
         url = (
             metrics_attributes["ingestUrl"]
-            + f"/syncMetrics/resync/{kind_metrics['eventId']}/kind/{kind_metrics['kindIdentifier']}"
+            + f"/syncMetrics/resync/{event_id}/kind/{kind_identifier}"
         )
         headers = await self.auth.headers()
         response = await self.client.put(

{port_ocean-0.24.20 → port_ocean-0.24.22}/port_ocean/config/dynamic.py

@@ -2,12 +2,37 @@ import json
 from typing import Type, Any, Optional
 
 from humps import decamelize
-from pydantic import BaseModel, AnyUrl, create_model, Extra, parse_obj_as, validator
+from pydantic import (
+    BaseConfig,
+    BaseModel,
+    AnyUrl,
+    create_model,
+    Extra,
+    parse_obj_as,
+    validator,
+)
 from pydantic.fields import ModelField, Field
 
 from port_ocean.config.base import BaseOceanModel
 
 
+class NoTrailingSlashUrl(AnyUrl):
+    @classmethod
+    def validate(cls, value: Any, field: ModelField, config: BaseConfig) -> "AnyUrl":
+        if value is not None:
+            if isinstance(value, (bytes, bytearray)):
+                try:
+                    value = value.decode()
+                except UnicodeDecodeError as exc:
+                    raise ValueError("URL bytes must be valid UTF-8") from exc
+            else:
+                value = str(value)
+
+            if value != "/":
+                value = value.rstrip("/")
+        return super().validate(value, field, config)
+
+
 class Configuration(BaseModel, extra=Extra.allow):
     name: str
     type: str
@@ -39,7 +64,7 @@ def default_config_factory(configurations: Any) -> Type[BaseModel]:
             case "object":
                 field_type = dict
             case "url":
-                field_type = AnyUrl
+                field_type = NoTrailingSlashUrl
             case "string":
                 field_type = str
             case "integer":

port_ocean-0.24.22/port_ocean/tests/clients/port/mixins/test_integrations.py

@@ -0,0 +1,205 @@
+from typing import Any
+from unittest.mock import MagicMock, patch, AsyncMock
+
+import pytest
+import httpx
+
+from port_ocean.clients.port.mixins.integrations import IntegrationClientMixin
+
+
+TEST_INTEGRATION_IDENTIFIER = "test-integration"
+TEST_INTEGRATION_VERSION = "1.0.0"
+TEST_INGEST_URL = "https://api.example.com"
+
+BASIC_KIND_METRICS = {
+    "eventId": "event-123",
+    "kindIdentifier": "service",
+    "metrics": {"count": 5},
+}
+
+KIND_METRICS_WITH_SLASH = {
+    "eventId": "event-456",
+    "kindIdentifier": "kind/kind1",
+    "metrics": {"count": 10},
+}
+
+EVENT_METRICS_WITH_SLASH = {
+    "eventId": "event/123",
+    "kindIdentifier": "service",
+    "metrics": {"count": 15},
+}
+
+BOTH_METRICS_WITH_SLASH = {
+    "eventId": "namespace/event/123",
+    "kindIdentifier": "app/service/v1",
+    "metrics": {"count": 20},
+}
+
+COMPLEX_KIND_METRICS = {
+    "eventId": "complete/test/123",
+    "kindIdentifier": "complex/kind/identifier",
+    "syncStart": "2024-01-01T00:00:00Z",
+    "syncEnd": "2024-01-01T01:00:00Z",
+    "metrics": {"totalEntities": 100, "successfulEntities": 95, "failedEntities": 5},
+}
+
+
+@pytest.fixture
+def integration_client(monkeypatch: Any) -> IntegrationClientMixin:
+    """Create an IntegrationClientMixin instance with mocked dependencies."""
+    auth = MagicMock()
+    auth.headers = AsyncMock()
+    auth.headers.return_value = {"Authorization": "Bearer test-token"}
+
+    client = MagicMock()
+    client.put = AsyncMock()
+    client.put.return_value = MagicMock()
+    client.put.return_value.status_code = 200
+    client.put.return_value.is_error = False
+
+    integration_client = IntegrationClientMixin(
+        integration_identifier=TEST_INTEGRATION_IDENTIFIER,
+        integration_version=TEST_INTEGRATION_VERSION,
+        auth=auth,
+        client=client,
+    )
+
+    mock_get_metrics_attributes = AsyncMock()
+    mock_get_metrics_attributes.return_value = {"ingestUrl": TEST_INGEST_URL}
+    monkeypatch.setattr(
+        integration_client, "get_metrics_attributes", mock_get_metrics_attributes
+    )
+
+    return integration_client
+
+
+async def test_put_integration_sync_metrics_basic(
+    integration_client: IntegrationClientMixin,
+) -> None:
+    """Test basic functionality of put_integration_sync_metrics."""
+    with patch(
+        "port_ocean.clients.port.mixins.integrations.handle_port_status_code"
+    ) as mock_handle:
+        await integration_client.put_integration_sync_metrics(BASIC_KIND_METRICS)
+
+        integration_client.get_metrics_attributes.assert_called_once()
+
+        integration_client.auth.headers.assert_called_once()
+
+        integration_client.client.put.assert_called_once()
+        call_args = integration_client.client.put.call_args
+
+        expected_url = f"{TEST_INGEST_URL}/syncMetrics/resync/event-123/kind/service"
+        assert call_args[0][0] == expected_url
+
+        expected_headers = {"Authorization": "Bearer test-token"}
+        assert call_args[1]["headers"] == expected_headers
+
+        expected_json = {"syncKindMetrics": BASIC_KIND_METRICS}
+        assert call_args[1]["json"] == expected_json
+
+        mock_handle.assert_called_once_with(
+            integration_client.client.put.return_value, should_log=False
+        )
+
+
+async def test_put_integration_sync_metrics_with_slash_in_kind_identifier(
+    integration_client: IntegrationClientMixin,
+) -> None:
+    """Test put_integration_sync_metrics with forward slash in kindIdentifier."""
+    with patch("port_ocean.clients.port.mixins.integrations.handle_port_status_code"):
+        await integration_client.put_integration_sync_metrics(KIND_METRICS_WITH_SLASH)
+
+        integration_client.client.put.assert_called_once()
+        call_args = integration_client.client.put.call_args
+
+        expected_url = (
+            f"{TEST_INGEST_URL}/syncMetrics/resync/event-456/kind/kind%2Fkind1"
+        )
+        assert call_args[0][0] == expected_url
+
+        expected_json = {"syncKindMetrics": KIND_METRICS_WITH_SLASH}
+        assert call_args[1]["json"] == expected_json
+
+
+async def test_put_integration_sync_metrics_with_slash_in_event_id(
+    integration_client: IntegrationClientMixin,
+) -> None:
+    """Test put_integration_sync_metrics with forward slash in eventId."""
+    with patch("port_ocean.clients.port.mixins.integrations.handle_port_status_code"):
+        await integration_client.put_integration_sync_metrics(EVENT_METRICS_WITH_SLASH)
+
+        integration_client.client.put.assert_called_once()
+        call_args = integration_client.client.put.call_args
+
+        expected_url = f"{TEST_INGEST_URL}/syncMetrics/resync/event%2F123/kind/service"
+        assert call_args[0][0] == expected_url
+
+
+async def test_put_integration_sync_metrics_with_slashes_in_both_fields(
+    integration_client: IntegrationClientMixin,
+) -> None:
+    """Test put_integration_sync_metrics with forward slashes in both eventId and kindIdentifier."""
+    with patch("port_ocean.clients.port.mixins.integrations.handle_port_status_code"):
+        await integration_client.put_integration_sync_metrics(BOTH_METRICS_WITH_SLASH)
+
+        integration_client.client.put.assert_called_once()
+        call_args = integration_client.client.put.call_args
+
+        expected_url = f"{TEST_INGEST_URL}/syncMetrics/resync/namespace%2Fevent%2F123/kind/app%2Fservice%2Fv1"
+        assert call_args[0][0] == expected_url
+
+
+async def test_put_integration_sync_metrics_with_special_characters(
+    integration_client: IntegrationClientMixin,
+) -> None:
+    """Test put_integration_sync_metrics with various special characters that need URL encoding."""
+    special_metrics = {
+        "eventId": "event@123#test",
+        "kindIdentifier": "kind with spaces+symbols",
+        "metrics": {"count": 25},
+    }
+
+    with patch("port_ocean.clients.port.mixins.integrations.handle_port_status_code"):
+        await integration_client.put_integration_sync_metrics(special_metrics)
+
+        integration_client.client.put.assert_called_once()
+        call_args = integration_client.client.put.call_args
+
+        expected_url = f"{TEST_INGEST_URL}/syncMetrics/resync/event%40123%23test/kind/kind+with+spaces%2Bsymbols"
+        assert call_args[0][0] == expected_url
+
+
+async def test_put_integration_sync_metrics_complete_flow(
+    integration_client: IntegrationClientMixin,
+) -> None:
+    """Test the complete flow of put_integration_sync_metrics method."""
+    with patch("port_ocean.clients.port.mixins.integrations.handle_port_status_code"):
+        await integration_client.put_integration_sync_metrics(COMPLEX_KIND_METRICS)
+
+        integration_client.get_metrics_attributes.assert_called_once()
+        integration_client.auth.headers.assert_called_once()
+        integration_client.client.put.assert_called_once()
+
+        call_args = integration_client.client.put.call_args
+        assert "complete%2Ftest%2F123" in call_args[0][0]
+        assert "complex%2Fkind%2Fidentifier" in call_args[0][0]
+
+        assert call_args[1]["json"]["syncKindMetrics"] == COMPLEX_KIND_METRICS
+
+
+async def test_put_integration_sync_metrics_error_handling(
+    integration_client: IntegrationClientMixin,
+    monkeypatch: Any,
+) -> None:
+    """Test that put_integration_sync_metrics properly handles errors."""
+    mock_get_metrics_attributes = AsyncMock()
+    mock_get_metrics_attributes.side_effect = httpx.HTTPStatusError(
+        message="Test error", request=MagicMock(), response=MagicMock()
+    )
+    monkeypatch.setattr(
+        integration_client, "get_metrics_attributes", mock_get_metrics_attributes
+    )
+
+    with pytest.raises(httpx.HTTPStatusError):
+        await integration_client.put_integration_sync_metrics(BASIC_KIND_METRICS)

port_ocean-0.24.22/port_ocean/tests/config/test_config.py

@@ -0,0 +1,38 @@
+import pytest
+from pydantic import BaseModel
+from port_ocean.config.dynamic import NoTrailingSlashUrl
+from typing import cast
+
+
+class TestClass(BaseModel):
+    url: NoTrailingSlashUrl | None
+
+
+def as_no_trailing_slash_url(value: str | None) -> NoTrailingSlashUrl:
+    # mypy casting
+    return cast(NoTrailingSlashUrl, value)
+
+
+def test_trailing_slash_valid() -> None:
+    cls = TestClass(url=as_no_trailing_slash_url("http://example"))
+    assert cls.url == "http://example"
+
+
+def test_trailing_slash_valid_remove_slash() -> None:
+    cls = TestClass(url=as_no_trailing_slash_url("http://example/"))
+    assert cls.url == "http://example"
+
+
+def test_trailing_slash_not_valid() -> None:
+    with pytest.raises(ValueError):
+        TestClass(url=as_no_trailing_slash_url("/"))
+
+
+def test_trailing_slash_not_valid_no_domain() -> None:
+    with pytest.raises(ValueError):
+        TestClass(url=as_no_trailing_slash_url("http:///"))
+
+
+def test_trailing_empty() -> None:
+    cls = TestClass(url=None)
+    assert cls.url is None

{port_ocean-0.24.20 → port_ocean-0.24.22}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "port-ocean"
-version = "0.24.20"
+version = "0.24.22"
 description = "Port Ocean is a CLI tool for managing your Port projects."
 readme = "README.md"
 homepage = "https://app.getport.io"