port-ocean 0.25.0__tar.gz → 0.25.3__tar.gz

{port_ocean-0.25.0 → port_ocean-0.25.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: port-ocean
-Version: 0.25.0
+Version: 0.25.3
 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.25.0 → port_ocean-0.25.3}/integrations/_infra/Dockerfile.Deb

@@ -18,8 +18,9 @@ COPY ./${BUILD_CONTEXT}/pyproject.toml ./${BUILD_CONTEXT}/poetry.lock /app/
 RUN poetry install --without dev --no-root --no-interaction --no-ansi --no-cache
 
 FROM ${BASE_RUNNER_PYTHON_IMAGE} AS prod
+ARG OCEAN_USER_ID=999
 
-RUN groupadd -r appgroup && useradd -r -g appgroup -m ocean
+RUN groupadd -r appgroup && useradd -r -g appgroup -m -u ${OCEAN_USER_ID} ocean
 
 RUN mkdir -p /tmp/ocean
 
@@ -38,6 +39,7 @@ RUN apt-get update \
         ca-certificates \
         openssl \
         curl \
+        acl \
     && apt-get clean
 
 LABEL INTEGRATION_VERSION=${INTEGRATION_VERSION}
@@ -64,7 +66,8 @@ RUN chmod a+x /app/.venv/bin/ocean
 
 RUN chmod a+x /app/init.sh
 RUN ln -s /app/.venv/bin/ocean /usr/bin/ocean
-
+# Add ocean user to ssl certs group
+RUN setfacl -m u:ocean:rwX /etc/ssl/certs
 USER ocean
 # Run the application
 CMD ["bash", "/app/init.sh"]

{port_ocean-0.25.0 → port_ocean-0.25.3}/integrations/_infra/Dockerfile.local

@@ -2,9 +2,10 @@ ARG BASE_PYTHON_IMAGE=debian:trixie-slim
 # debian:trixie-slim - Python 3.12
 FROM ${BASE_PYTHON_IMAGE}
 
-RUN groupadd -r appgroup && useradd -r -g appgroup -m ocean
+ARG OCEAN_USER_ID=999
+RUN groupadd -r appgroup && useradd -r -g appgroup -m -u ${OCEAN_USER_ID} ocean
 
-RUN mkdir -p /tmp/ocean && chown -R ocean:appgroup /tmp/ocean && chmod -R 755 /tmp/ocean
+RUN mkdir -p /tmp/ocean
 
 
 RUN apt-get update \
@@ -27,6 +28,7 @@ RUN apt-get update \
         build-essential\
         git \
         python3-venv \
+        acl \
     && apt-get clean
 
 ARG BUILD_CONTEXT
@@ -40,7 +42,6 @@ ENV PROMETHEUS_MULTIPROC_DIR=${PROMETHEUS_MULTIPROC_DIR}
 RUN mkdir -p ${PROMETHEUS_MULTIPROC_DIR}
 
 WORKDIR /app
-USER ocean
 
 COPY . .
 RUN rm -rf .venv-docker ${BUILD_CONTEXT}/.venv-docker
@@ -51,5 +52,11 @@ RUN python3 -m venv ${BUILD_CONTEXT}/.venv-docker
 WORKDIR /app/${BUILD_CONTEXT}
 
 WORKDIR /app
+RUN chown -R ocean:appgroup /app && chmod -R 755 /app
+RUN chown -R ocean:appgroup /app/${BUILD_CONTEXT} && chmod -R 755 /app/${BUILD_CONTEXT}
+RUN chown -R ocean:appgroup /tmp/ocean && chmod -R 755 /tmp/ocean
+# Add ocean user to ssl certs group
+RUN setfacl -m u:ocean:rwX /etc/ssl/certs
+USER ocean
 
 ENTRYPOINT ["./integrations/_infra/entry_local.sh"]

port_ocean-0.25.3/integrations/_infra/README.md

@@ -0,0 +1,30 @@
+# Running the Ocean image locally using vscode / Cursor
+
+In order to run the local image of Ocean you need to follow these steps:
+
+1. Build the image:
+
+    ```bash
+    docker build -f integrations/_infra/Dockerfile.local --build-arg BUILD_CONTEXT=integrations/<integration_type> --platform linux/arm64 -t <my-local-image>:<local> .
+    ```
+
+2. Run the image
+   1. `5678` is the debugpy port mentioned in the `entry_local.sh` file
+   2. `8000` is the port of the Ocean FastAPI server
+   3. the `-v` option mounts your local Ocean directory to the pod, allowing you not to constantly build the image.
+      1. Make sure to run the command from the root directory of the Ocean repository.
+
+    ```bash
+    docker run --rm -it \
+    -v $(pwd):/app \
+    -p 5678:5678 \
+    -p 8000:8000 \
+    -e BUILD_CONTEXT=integrations/<integration_type> \
+    -e OCEAN__PORT__CLIENT_ID=<MY_CLIENT_ID> \
+    -e OCEAN__PORT__CLIENT_SECRET=<MY_CLIENT_SECRET> \
+    -e OCEAN__PORT__MY_OTHER_CONFIGURATION=<MY_OTHER_CONFIGURATION> \
+    <my-local-image>:<local>
+    ```
+
+3. In vscode/Cursor, run the `Attach to docker fake-integration integration` Running configuration from the `launch.json`.
+4. Have fun debugging!

{port_ocean-0.25.0 → port_ocean-0.25.3}/integrations/_infra/entry_local.sh

@@ -22,4 +22,5 @@ fi
 source .venv-docker/bin/activate
 python -m pip install -e ../../
 
-ocean sail
+python -m pip install debugpy
+python -m debugpy --listen 0.0.0.0:5678 --wait-for-client debug.py

{port_ocean-0.25.0 → port_ocean-0.25.3}/port_ocean/core/handlers/entities_state_applier/port/get_related_entities.py

@@ -2,6 +2,8 @@ import asyncio
 from collections import defaultdict
 from itertools import groupby
 
+from loguru import logger
+
 from port_ocean.clients.port.client import PortClient
 from port_ocean.core.models import Entity
 
@@ -37,6 +39,11 @@ async def get_related_entities(
     blueprints_to_relations = defaultdict(list)
     for entity, blueprint in entity_to_blueprint:
         for relation_name, relation in entity.relations.items():
+            if relation_name not in blueprint.relations:
+                logger.warning(
+                    f"Relation {relation_name} found in entity {entity.identifier} but not in blueprint {blueprint.identifier}"
+                )
+                continue
             relation_blueprint = blueprint.relations[relation_name].target
             blueprints_to_relations[relation_blueprint].extend(
                 relation if isinstance(relation, list) else [relation]

{port_ocean-0.25.0 → port_ocean-0.25.3}/port_ocean/core/handlers/entity_processor/jq_entity_processor.py

@@ -1,6 +1,7 @@
 import asyncio
 from asyncio import Task
 from dataclasses import dataclass, field
+
 from functools import lru_cache
 from typing import Any, Optional
 import jq  # type: ignore
@@ -23,6 +24,49 @@ from port_ocean.exceptions.core import EntityProcessorException
 from port_ocean.utils.queue_utils import process_in_queue
 
 
+class ExampleStates:
+    __succeed: list[dict[str, Any]]
+    __errors: list[dict[str, Any]]
+    __max_size: int
+
+    def __init__(self, max_size: int = 0) -> None:
+        """
+        Store two sequences:
+          - succeed: items that succeeded
+          - errors:  items that failed
+        """
+        self.__succeed = []
+        self.__errors = []
+        self.__max_size = max_size
+
+    def add_example(self, succeed: bool, item: dict[str, Any]) -> None:
+        if succeed:
+            self.__succeed.append(item)
+        else:
+            self.__errors.append(item)
+
+    def __len__(self) -> int:
+        """
+        Total number of items (successes + errors).
+        """
+        return len(self.__succeed) + len(self.__errors)
+
+    def get_examples(self, number: int = 0) -> list[dict[str, Any]]:
+        """
+        Return a list of up to number items, taking successes first,
+        """
+        if number <= 0:
+            number = self.__max_size
+        # how many from succeed?
+        s_count = min(number, len(self.__succeed))
+        result = list(self.__succeed[:s_count])
+        # how many more from errors?
+        e_count = number - s_count
+        if e_count > 0:
+            result.extend(self.__errors[:e_count])
+        return result
+
+
 @dataclass
 class MappedEntity:
     """Represents the entity after applying the mapping
@@ -182,11 +226,16 @@ class JQEntityProcessor(BaseEntityProcessor):
             return MappedEntity(
                 mapped_entity,
                 did_entity_pass_selector=should_run,
-                raw_data=data if should_run else None,
+                raw_data=data,
                 misconfigurations=misconfigurations,
             )
 
-        return MappedEntity()
+        return MappedEntity(
+            {},
+            did_entity_pass_selector=False,
+            raw_data=data,
+            misconfigurations={},
+        )
 
     async def _calculate_entity(
         self,
@@ -264,24 +313,26 @@ class JQEntityProcessor(BaseEntityProcessor):
 
         passed_entities = []
         failed_entities = []
-        examples_to_send: list[dict[str, Any]] = []
+        examples_to_send = ExampleStates(send_raw_data_examples_amount)
         entity_misconfigurations: dict[str, str] = {}
         missing_required_fields: bool = False
         entity_mapping_fault_counter: int = 0
-
         for result in calculated_entities_results:
             if len(result.misconfigurations) > 0:
                 entity_misconfigurations |= result.misconfigurations
 
+            if (
+                len(examples_to_send) < send_raw_data_examples_amount
+                and result.raw_data is not None
+            ):
+                examples_to_send.add_example(
+                    result.did_entity_pass_selector, result.raw_data
+                )
+
             if result.entity.get("identifier") and result.entity.get("blueprint"):
                 parsed_entity = Entity.parse_obj(result.entity)
                 if result.did_entity_pass_selector:
                     passed_entities.append(parsed_entity)
-                    if (
-                        len(examples_to_send) < send_raw_data_examples_amount
-                        and result.raw_data is not None
-                    ):
-                        examples_to_send.append(result.raw_data)
                 else:
                     failed_entities.append(parsed_entity)
             else:
@@ -294,20 +345,10 @@ class JQEntityProcessor(BaseEntityProcessor):
             entity_mapping_fault_counter,
         )
 
-        if (
-            not calculated_entities_results
-            and raw_results
-            and send_raw_data_examples_amount > 0
-        ):
-            logger.warning(
-                f"No entities were parsed from {len(raw_results)} raw results, sending raw data examples"
-            )
-            examples_to_send = raw_results[:send_raw_data_examples_amount]
-
-        await self._send_examples(examples_to_send, mapping.kind)
+        await self._send_examples(examples_to_send.get_examples(), mapping.kind)
 
         return CalculationResult(
             EntitySelectorDiff(passed=passed_entities, failed=failed_entities),
             errors,
-            misonfigured_entity_keys=entity_misconfigurations,
+            misconfigured_entity_keys=entity_misconfigurations,
         )

{port_ocean-0.25.0 → port_ocean-0.25.3}/port_ocean/core/integrations/mixins/sync_raw.py

@@ -332,7 +332,7 @@ class SyncRawMixin(HandlerMixin, EventsMixin):
                 passed=modified_objects
             ),
             errors=objects_diff[0].errors,
-            misonfigured_entity_keys=objects_diff[0].misonfigured_entity_keys,
+            misconfigured_entity_keys=objects_diff[0].misconfigured_entity_keys
         )
 
     async def _unregister_resource_raw(

{port_ocean-0.25.0 → port_ocean-0.25.3}/port_ocean/core/ocean_types.py

@@ -42,7 +42,7 @@ class CalculationResult(NamedTuple):
     entity_selector_diff: EntitySelectorDiff
     errors: list[Exception]
     number_of_transformed_entities: int = 0
-    misonfigured_entity_keys: dict[str, str] = field(default_factory=dict)
+    misconfigured_entity_keys: dict[str, str] = field(default_factory=dict)
 
 
 class IntegrationEventsCallbacks(TypedDict):

{port_ocean-0.25.0 → port_ocean-0.25.3}/port_ocean/tests/core/handlers/entity_processor/test_jq_entity_processor.py

@@ -1,4 +1,4 @@
-from typing import Any
+from typing import cast, Any
 from unittest.mock import AsyncMock, Mock
 from loguru import logger
 import pytest
@@ -10,6 +10,7 @@ from port_ocean.core.handlers.entity_processor.jq_entity_processor import (
 )
 from port_ocean.core.ocean_types import CalculationResult
 from port_ocean.exceptions.core import EntityProcessorException
+from unittest.mock import patch
 
 
 @pytest.mark.asyncio
@@ -296,15 +297,23 @@ class TestJQEntityProcessor:
             },
             {"foo": "bar", "baz": "bazbar", "bar": {"foobar": "foobar"}},
         ]
-        result = await mocked_processor._parse_items(mapping, raw_results)
-        assert len(result.misonfigured_entity_keys) > 0
-        assert len(result.misonfigured_entity_keys) == 4
-        assert result.misonfigured_entity_keys == {
-            "identifier": ".ark",
-            "description": ".bazbar",
-            "url": ".foobar",
-            "defaultBranch": ".bar.baz",
-        }
+        with patch(
+            "port_ocean.core.handlers.entity_processor.jq_entity_processor.JQEntityProcessor._send_examples"
+        ) as mock_send_examples:
+            result = await mocked_processor._parse_items(
+                mapping, raw_results, send_raw_data_examples_amount=1
+            )
+            assert len(result.misconfigured_entity_keys) > 0
+            assert len(result.misconfigured_entity_keys) == 4
+            assert result.misconfigured_entity_keys == {
+                "identifier": ".ark",
+                "description": ".bazbar",
+                "url": ".foobar",
+                "defaultBranch": ".bar.baz",
+            }
+            assert mock_send_examples.await_args is not None, "mock was not awaited"
+            args, _ = mock_send_examples.await_args
+            assert len(cast(list[Any], args[0])) > 0
 
     async def test_parse_items_empty_required(
         self, mocked_processor: JQEntityProcessor
@@ -324,15 +333,15 @@ class TestJQEntityProcessor:
             {"foo": "identifierMapped", "bar": ""},
         ]
         result = await mocked_processor._parse_items(mapping, raw_results)
-        assert "identifier" not in result.misonfigured_entity_keys
-        assert "blueprint" not in result.misonfigured_entity_keys
+        assert "identifier" not in result.misconfigured_entity_keys
+        assert "blueprint" not in result.misconfigured_entity_keys
 
         raw_results = [
             {"foo": "identifierMapped", "bar": None},
             {"foo": None, "bar": ""},
         ]
         result = await mocked_processor._parse_items(mapping, raw_results)
-        assert result.misonfigured_entity_keys == {
+        assert result.misconfigured_entity_keys == {
             "identifier": ".foo",
             "blueprint": ".bar",
         }

{port_ocean-0.25.0 → port_ocean-0.25.3}/port_ocean/tests/core/handlers/mixins/test_live_events.py

@@ -334,7 +334,7 @@ async def test_parse_raw_event_results_to_entities_creation(
     calculation_result = CalculationResult(
         entity_selector_diff=EntitySelectorDiff(passed=[entity], failed=[]),
         errors=[],
-        misonfigured_entity_keys={},
+        misconfigured_entity_keys={},
     )
     mock_live_events_mixin.entity_processor.parse_items.return_value = (
         calculation_result
@@ -361,7 +361,7 @@ async def test_parse_raw_event_results_to_entities_deletion(
     calculation_result = CalculationResult(
         entity_selector_diff=EntitySelectorDiff(passed=[entity], failed=[]),
         errors=[],
-        misonfigured_entity_keys={},
+        misconfigured_entity_keys={},
     )
     mock_live_events_mixin.entity_processor.parse_items.return_value = (
         calculation_result

{port_ocean-0.25.0 → port_ocean-0.25.3}/port_ocean/tests/core/handlers/mixins/test_sync_raw.py

@@ -113,7 +113,7 @@ async def test_sync_raw_mixin_self_dependency(
     calc_result_mock.number_of_transformed_entities = len(
         entities
     )  # Add this to match real behavior
-    calc_result_mock.misonfigured_entity_keys = {}  # Add this to match real behavior
+    calc_result_mock.misconfigured_entity_keys = {}  # Add this to match real behavior
 
     mock_sync_raw_mixin.entity_processor.parse_items = AsyncMock(return_value=calc_result_mock)  # type: ignore
 
@@ -234,7 +234,7 @@ async def test_sync_raw_mixin_circular_dependency(
     calc_result_mock.number_of_transformed_entities = len(
         entities
     )  # Add this to match real behavior
-    calc_result_mock.misonfigured_entity_keys = {}  # Add this to match real behavior
+    calc_result_mock.misconfigured_entity_keys = {}  # Add this to match real behavior
 
     mock_sync_raw_mixin.entity_processor.parse_items = AsyncMock(return_value=calc_result_mock)  # type: ignore
 
@@ -378,7 +378,7 @@ async def test_sync_raw_mixin_dependency(
     calc_result_mock.number_of_transformed_entities = len(
         entities
     )  # Add this to match real behavior
-    calc_result_mock.misonfigured_entity_keys = {}  # Add this to match real behavior
+    calc_result_mock.misconfigured_entity_keys = {}  # Add this to match real behavior
 
     # Mock the parse_items method to return our realistic mock
     mock_sync_raw_mixin.entity_processor.parse_items = AsyncMock(return_value=calc_result_mock)  # type: ignore
@@ -773,7 +773,7 @@ class CalculationResult:
     entity_selector_diff: EntitySelectorDiff
     errors: List[Any]
     misconfigurations: List[Any]
-    misonfigured_entity_keys: Optional[List[Any]] = None
+    misconfigured_entity_keys: Optional[List[Any]] = None
 
 
 @pytest.mark.asyncio
@@ -782,7 +782,7 @@ async def test_register_resource_raw_no_changes_upsert_not_called_entitiy_is_ret
     mock_port_app_config: PortAppConfig,
 ) -> None:
     entity = Entity(identifier="1", blueprint="service")
-    mock_sync_raw_mixin._calculate_raw = AsyncMock(return_value=[CalculationResult(entity_selector_diff=EntitySelectorDiff(passed=[entity], failed=[]), errors=[], misconfigurations=[], misonfigured_entity_keys=[])])  # type: ignore
+    mock_sync_raw_mixin._calculate_raw = AsyncMock(return_value=[CalculationResult(entity_selector_diff=EntitySelectorDiff(passed=[entity], failed=[]), errors=[], misconfigurations=[], misconfigured_entity_keys=[])])  # type: ignore
     mock_sync_raw_mixin._map_entities_compared_with_port = AsyncMock(return_value=([]))  # type: ignore
     mock_sync_raw_mixin.entities_state_applier.upsert = AsyncMock()  # type: ignore
 
@@ -809,7 +809,7 @@ async def test_register_resource_raw_with_changes_upsert_called_and_entities_are
     mock_port_app_config: PortAppConfig,
 ) -> None:
     entity = Entity(identifier="1", blueprint="service")
-    mock_sync_raw_mixin._calculate_raw = AsyncMock(return_value=[CalculationResult(entity_selector_diff=EntitySelectorDiff(passed=[entity], failed=[]), errors=[], misconfigurations=[], misonfigured_entity_keys=[])])  # type: ignore
+    mock_sync_raw_mixin._calculate_raw = AsyncMock(return_value=[CalculationResult(entity_selector_diff=EntitySelectorDiff(passed=[entity], failed=[]), errors=[], misconfigurations=[], misconfigured_entity_keys=[])])  # type: ignore
     mock_sync_raw_mixin._map_entities_compared_with_port = AsyncMock(return_value=([entity]))  # type: ignore
     mock_sync_raw_mixin.entities_state_applier.upsert = AsyncMock(return_value=[entity])  # type: ignore
 
@@ -836,7 +836,7 @@ async def test_register_resource_raw_with_errors(
 ) -> None:
     failed_entity = Entity(identifier="1", blueprint="service")
     error = Exception("Test error")
-    mock_sync_raw_mixin._calculate_raw = AsyncMock(return_value=[CalculationResult(entity_selector_diff=EntitySelectorDiff(passed=[], failed=[failed_entity]), errors=[error], misconfigurations=[], misonfigured_entity_keys=[])])  # type: ignore
+    mock_sync_raw_mixin._calculate_raw = AsyncMock(return_value=[CalculationResult(entity_selector_diff=EntitySelectorDiff(passed=[], failed=[failed_entity]), errors=[error], misconfigurations=[], misconfigured_entity_keys=[])])  # type: ignore
     mock_sync_raw_mixin._map_entities_compared_with_port = AsyncMock(return_value=([]))  # type: ignore
     mock_sync_raw_mixin.entities_state_applier.upsert = AsyncMock()  # type: ignore
 
@@ -873,7 +873,7 @@ async def test_register_resource_raw_skip_event_type_http_request_upsert_called_
         entity_selector_diff=EntitySelectorDiff(passed=[entity], failed=[]),
         errors=[],
         misconfigurations=[],
-        misonfigured_entity_keys=[],
+        misconfigured_entity_keys=[],
     )
     mock_sync_raw_mixin._calculate_raw = AsyncMock(return_value=[calculation_result])  # type: ignore
     mock_sync_raw_mixin._map_entities_compared_with_port = AsyncMock()  # type: ignore

{port_ocean-0.25.0 → port_ocean-0.25.3}/pyproject.toml

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