port-ocean 0.13.1.dev1__py3-none-any.whl → 0.14.0__py3-none-any.whl

port_ocean/cli/commands/defaults/clean.py

@@ -51,4 +51,6 @@ def clean(path: str, force: bool, wait: bool) -> None:
         default_app,
     )
 
-    clean_defaults(app.integration.AppConfigHandlerClass.CONFIG_CLASS, force, wait)
+    clean_defaults(
+        app.integration.AppConfigHandlerClass.CONFIG_CLASS, app.config, force, wait
+    )

port_ocean/config/settings.py

@@ -78,6 +78,7 @@ class IntegrationConfiguration(BaseOceanSettings, extra=Extra.allow):
         default_factory=lambda: IntegrationSettings(type="", identifier="")
     )
     runtime: Runtime = Runtime.OnPrem
+    resources_path: str = Field(default=".port/resources")
 
     @root_validator()
     def validate_integration_config(cls, values: dict[str, Any]) -> dict[str, Any]:

port_ocean/core/defaults/clean.py

@@ -4,6 +4,7 @@ from typing import Type
 import httpx
 from loguru import logger
 
+from port_ocean.config.settings import IntegrationConfiguration
 from port_ocean.context.ocean import ocean
 from port_ocean.core.defaults.common import (
     get_port_integration_defaults,
@@ -14,12 +15,13 @@ from port_ocean.core.handlers.port_app_config.models import PortAppConfig
 
 def clean_defaults(
     config_class: Type[PortAppConfig],
+    integration_config: IntegrationConfiguration,
     force: bool,
     wait: bool,
 ) -> None:
     try:
         asyncio.new_event_loop().run_until_complete(
-            _clean_defaults(config_class, force, wait)
+            _clean_defaults(config_class, integration_config, force, wait)
         )
 
     except Exception as e:
@@ -27,13 +29,18 @@ def clean_defaults(
 
 
 async def _clean_defaults(
-    config_class: Type[PortAppConfig], force: bool, wait: bool
+    config_class: Type[PortAppConfig],
+    integration_config: IntegrationConfiguration,
+    force: bool,
+    wait: bool,
 ) -> None:
     port_client = ocean.port_client
     is_exists = await is_integration_exists(port_client)
     if not is_exists:
         return None
-    defaults = get_port_integration_defaults(config_class)
+    defaults = get_port_integration_defaults(
+        config_class, integration_config.resources_path
+    )
     if not defaults:
         return None
 

port_ocean/core/defaults/common.py

@@ -3,6 +3,7 @@ from pathlib import Path
 from typing import Type, Any, TypedDict, Optional
 
 import httpx
+from loguru import logger
 import yaml
 from pydantic import BaseModel, Field
 from starlette import status
@@ -77,18 +78,33 @@ def deconstruct_blueprints_to_creation_steps(
     )
 
 
+def is_valid_dir(path: Path) -> bool:
+    return path.is_dir()
+
+
 def get_port_integration_defaults(
-    port_app_config_class: Type[PortAppConfig], base_path: Path = Path(".")
+    port_app_config_class: Type[PortAppConfig],
+    custom_defaults_dir: Optional[str] = None,
+    base_path: Path = Path("."),
 ) -> Defaults | None:
-    defaults_dir = base_path / ".port/resources"
-    if not defaults_dir.exists():
-        return None
-
-    if not defaults_dir.is_dir():
-        raise UnsupportedDefaultFileType(
-            f"Defaults directory is not a directory: {defaults_dir}"
+    fallback_dir = base_path / ".port/resources"
+
+    if custom_defaults_dir and is_valid_dir(base_path / custom_defaults_dir):
+        defaults_dir = base_path / custom_defaults_dir
+    elif is_valid_dir(fallback_dir):
+        logger.info(
+            f"Could not find custom defaults directory {custom_defaults_dir}, falling back to {fallback_dir}",
+            fallback_dir=fallback_dir,
+            custom_defaults_dir=custom_defaults_dir,
+        )
+        defaults_dir = fallback_dir
+    else:
+        logger.warning(
+            f"Could not find defaults directory {fallback_dir}, skipping defaults"
         )
+        return None
 
+    logger.info(f"Loading defaults from {defaults_dir}", defaults_dir=defaults_dir)
     default_jsons = {}
     allowed_file_names = [
         field_model.alias for _, field_model in Defaults.__fields__.items()

port_ocean/core/defaults/initialize.py

@@ -198,7 +198,9 @@ async def _initialize_defaults(
     config_class: Type[PortAppConfig], integration_config: IntegrationConfiguration
 ) -> None:
     port_client = ocean.port_client
-    defaults = get_port_integration_defaults(config_class)
+    defaults = get_port_integration_defaults(
+        config_class, integration_config.resources_path
+    )
     if not defaults:
         logger.warning("No defaults found. Skipping initialization...")
         return None

port_ocean/ocean.py

@@ -114,7 +114,7 @@ class Ocean:
             )
             await repeated_function()
 
-    def initialize_app(self):
+    def initialize_app(self) -> None:
         self.fast_api_app.include_router(self.integration_router, prefix="/integration")
 
         @asynccontextmanager

port_ocean/tests/core/defaults/test_common.py

@@ -0,0 +1,166 @@
+import pytest
+import json
+from unittest.mock import patch
+from pathlib import Path
+from port_ocean.core.handlers.port_app_config.models import PortAppConfig
+from port_ocean.core.defaults.common import (
+    get_port_integration_defaults,
+    Defaults,
+)
+
+
+@pytest.fixture
+def setup_mock_directories(tmp_path: Path) -> tuple[Path, Path, Path]:
+    # Create .port/resources with sample files
+    default_dir = tmp_path / ".port/resources"
+    default_dir.mkdir(parents=True, exist_ok=True)
+
+    # Create mock JSON and YAML files with expected content
+    (default_dir / "blueprints.json").write_text(
+        json.dumps(
+            [
+                {
+                    "identifier": "mock-identifier",
+                    "title": "mock-title",
+                    "icon": "mock-icon",
+                    "schema": {
+                        "type": "object",
+                        "properties": {"key": {"type": "string"}},
+                    },
+                }
+            ]
+        )
+    )
+    (default_dir / "port-app-config.json").write_text(
+        json.dumps(
+            {
+                "resources": [
+                    {
+                        "kind": "mock-kind",
+                        "selector": {"query": "true"},
+                        "port": {
+                            "entity": {
+                                "mappings": {
+                                    "identifier": ".id",
+                                    "title": ".title",
+                                    "blueprint": '"mock-identifier"',
+                                }
+                            }
+                        },
+                    }
+                ]
+            }
+        )
+    )
+
+    # Create .port/custom_resources with different sample files
+    custom_resources_dir = tmp_path / ".port/custom_resources"
+    custom_resources_dir.mkdir(parents=True, exist_ok=True)
+
+    # Create mock JSON and YAML files with expected content
+    (custom_resources_dir / "blueprints.json").write_text(
+        json.dumps(
+            [
+                {
+                    "identifier": "mock-custom-identifier",
+                    "title": "mock-custom-title",
+                    "icon": "mock-custom-icon",
+                    "schema": {
+                        "type": "object",
+                        "properties": {"key": {"type": "string"}},
+                    },
+                }
+            ]
+        )
+    )
+    (custom_resources_dir / "port-app-config.json").write_text(
+        json.dumps(
+            {
+                "resources": [
+                    {
+                        "kind": "mock-custom-kind",
+                        "selector": {"query": "true"},
+                        "port": {
+                            "entity": {
+                                "mappings": {
+                                    "identifier": ".id",
+                                    "title": ".title",
+                                    "blueprint": '"mock-custom-identifier"',
+                                }
+                            }
+                        },
+                    }
+                ]
+            }
+        )
+    )
+
+    # Define the non-existing directory path
+    non_existing_dir = tmp_path / ".port/do_not_exist"
+
+    return default_dir, custom_resources_dir, non_existing_dir
+
+
+def test_custom_defaults_dir_used_if_valid(
+    setup_mock_directories: tuple[Path, Path, Path]
+) -> None:
+    # Arrange
+    _, custom_resources_dir, _ = setup_mock_directories
+
+    with (
+        patch("port_ocean.core.defaults.common.is_valid_dir") as mock_is_valid_dir,
+        patch(
+            "pathlib.Path.iterdir",
+            return_value=custom_resources_dir.iterdir(),
+        ),
+    ):
+        mock_is_valid_dir.side_effect = lambda path: path == custom_resources_dir
+
+        # Act
+        defaults = get_port_integration_defaults(
+            port_app_config_class=PortAppConfig,
+            custom_defaults_dir=".port/custom_resources",
+            base_path=custom_resources_dir.parent.parent,
+        )
+
+        # Assert
+        assert isinstance(defaults, Defaults)
+        assert defaults.blueprints[0].get("identifier") == "mock-custom-identifier"
+        assert defaults.port_app_config is not None
+        assert defaults.port_app_config.resources[0].kind == "mock-custom-kind"
+
+
+def test_fallback_to_default_dir_if_custom_dir_invalid(
+    setup_mock_directories: tuple[Path, Path, Path]
+) -> None:
+    resources_dir, _, non_existing_dir = setup_mock_directories
+
+    # Arrange
+    with (
+        patch("port_ocean.core.defaults.common.is_valid_dir") as mock_is_valid_dir,
+        patch("pathlib.Path.iterdir", return_value=resources_dir.iterdir()),
+    ):
+
+        mock_is_valid_dir.side_effect = lambda path: path == resources_dir
+
+        # Act
+        custom_defaults_dir = str(non_existing_dir.relative_to(resources_dir.parent))
+        defaults = get_port_integration_defaults(
+            port_app_config_class=PortAppConfig,
+            custom_defaults_dir=custom_defaults_dir,
+            base_path=resources_dir.parent.parent,
+        )
+
+        # Assert
+        assert isinstance(defaults, Defaults)
+        assert defaults.blueprints[0].get("identifier") == "mock-identifier"
+        assert defaults.port_app_config is not None
+        assert defaults.port_app_config.resources[0].kind == "mock-kind"
+
+
+def test_default_resources_path_does_not_exist() -> None:
+    # Act
+    defaults = get_port_integration_defaults(port_app_config_class=PortAppConfig)
+
+    # Assert
+    assert defaults is None

{port_ocean-0.13.1.dev1.dist-info → port_ocean-0.14.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: port-ocean
-Version: 0.13.1.dev1
+Version: 0.14.0
 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.13.1.dev1.dist-info → port_ocean-0.14.0.dist-info}/RECORD

@@ -4,7 +4,7 @@ port_ocean/cli/__init__.py,sha256=ZjTGS305llhbjC2BH2KkVj34gCASBGwqc5HZEO_0T_Q,32
 port_ocean/cli/cli.py,sha256=RvWTELEn5YFw9aM0vaNqm5YqZZrL50ILaBs27ptiGl0,57
 port_ocean/cli/commands/__init__.py,sha256=Y9Q6jeYw_ZAZ-mdfE_5DZTdS2KHhieQZoUTggk_AkwM,369
 port_ocean/cli/commands/defaults/__init___.py,sha256=5OKgakO79bTbplFv1_yWCrw1x_JJqSdRXAHHqKSuEpQ,88
-port_ocean/cli/commands/defaults/clean.py,sha256=b3MVxAc9pASGxG3O6AjbDJiFngw82UqclVuCZObVPGM,1544
+port_ocean/cli/commands/defaults/clean.py,sha256=258rOSC1xGT-NTBIkv-V8HTY57ZipnOD-gV5yEenut0,1570
 port_ocean/cli/commands/defaults/dock.py,sha256=pFtHrU_LTvb5Ddrzj09Wxy-jg1Ym10wBYD-0tpDRugE,1104
 port_ocean/cli/commands/defaults/group.py,sha256=hii_4CYoQ7jSMePbnP4AmruO_RKWCUcoV7dXXBlZafc,115
 port_ocean/cli/commands/list_integrations.py,sha256=DVVioFruGUE-_v6UUHlcemWNN6RlWwCrf1X4HmAXsf8,1134
@@ -52,7 +52,7 @@ port_ocean/clients/port/utils.py,sha256=5B6rHgiVrtiL4YWh7Eq7_ncIeDwrDsB7jIvRik5x
 port_ocean/config/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 port_ocean/config/base.py,sha256=x1gFbzujrxn7EJudRT81C6eN9WsYAb3vOHwcpcpX8Tc,6370
 port_ocean/config/dynamic.py,sha256=qOFkRoJsn_BW7581omi_AoMxoHqasf_foxDQ_G11_SI,2030
-port_ocean/config/settings.py,sha256=77MtPz-ZpOWjuuOcorAy4MSNuYhRE2a9DDBKx3sRrV8,4274
+port_ocean/config/settings.py,sha256=65LATPdQ4YBdUTgQHMtZvzzPVrOxWUqAP7eerwFGZvg,4333
 port_ocean/consumers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 port_ocean/consumers/kafka_consumer.py,sha256=N8KocjBi9aR0BOPG8hgKovg-ns_ggpEjrSxqSqF_BSo,4710
 port_ocean/context/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -61,9 +61,9 @@ port_ocean/context/ocean.py,sha256=2EreWOj-N2H7QUjEt5wGiv5KHP4pTZc70tn_wHcpF4w,4
 port_ocean/context/resource.py,sha256=yDj63URzQelj8zJPh4BAzTtPhpKr9Gw9DRn7I_0mJ1s,1692
 port_ocean/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 port_ocean/core/defaults/__init__.py,sha256=8qCZg8n06WAdMu9s_FiRtDYLGPGHbOuS60vapeUoAks,142
-port_ocean/core/defaults/clean.py,sha256=S3UAfca-oU89WJKIB4OgGjGjPr0vxBQ2aRZsLTZhQ04,2185
-port_ocean/core/defaults/common.py,sha256=uVUg6VEn4RqtXQwLwMNGfkmT5zYRN_h5USfKw3poVyo,3561
-port_ocean/core/defaults/initialize.py,sha256=qg4JLIWjp0c5-9w09X99muHRYX4k1cGZ_77vYo-tnpU,8422
+port_ocean/core/defaults/clean.py,sha256=TOVe5b5FAjFspAkQuKA70k2BClCEFbrQ3xgiAoKXKYE,2427
+port_ocean/core/defaults/common.py,sha256=zJsj7jvlqIMLGXhdASUlbKS8GIAf-FDKKB0O7jB6nx0,4166
+port_ocean/core/defaults/initialize.py,sha256=M1EXgfbnrvP5e3f9or8Bi0-4zXECznfRfy7sJn2Gc14,8471
 port_ocean/core/event_listener/__init__.py,sha256=mzJ33wRq0kh60fpVdOHVmvMTUQIvz3vxmifyBgwDn0E,889
 port_ocean/core/event_listener/base.py,sha256=1Nmpg00OfT2AD2L8eFm4VQEcdG2TClpSWJMhWhAjkEE,2356
 port_ocean/core/event_listener/factory.py,sha256=AYYfSHPAF7P5H-uQECXT0JVJjKDHrYkWJJBSL4mGkg8,3697
@@ -115,13 +115,14 @@ port_ocean/log/handlers.py,sha256=ncVjgqrZRh6BhyRrA6DQG86Wsbxph1yWYuEC0cWfe-Q,36
 port_ocean/log/logger_setup.py,sha256=CoEDowe5OwNOL_5clU6Z4faktfh0VWaOTS0VLmyhHjw,2404
 port_ocean/log/sensetive.py,sha256=lVKiZH6b7TkrZAMmhEJRhcl67HNM94e56x12DwFgCQk,2920
 port_ocean/middlewares.py,sha256=9wYCdyzRZGK1vjEJ28FY_DkfwDNENmXp504UKPf5NaQ,2727
-port_ocean/ocean.py,sha256=oUNY9XT30oZ6e6asD6yM2dbd01-uD6RvtJXkmobUn7U,5282
+port_ocean/ocean.py,sha256=NVdvooP0AiGyVs38VE8xXj6bzeT3XLoIPnh5FAS5ouM,5290
 port_ocean/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 port_ocean/run.py,sha256=rTxBlrQd4yyrtgErCFJCHCEHs7d1OXrRiJehUYmIbN0,2212
 port_ocean/sonar-project.properties,sha256=X_wLzDOkEVmpGLRMb2fg9Rb0DxWwUFSvESId8qpvrPI,73
 port_ocean/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 port_ocean/tests/clients/port/mixins/test_entities.py,sha256=A9myrnkLhKSQrnOLv1Zz2wiOVSxW65Q9RIUIRbn_V7w,1586
 port_ocean/tests/conftest.py,sha256=JXASSS0IY0nnR6bxBflhzxS25kf4iNaABmThyZ0mZt8,101
+port_ocean/tests/core/defaults/test_common.py,sha256=sR7RqB3ZYV6Xn6NIg-c8k5K6JcGsYZ2SCe_PYX5vLYM,5560
 port_ocean/tests/core/handlers/entity_processor/test_jq_entity_processor.py,sha256=Yv03P-LDcJCKZ21exiTFrcT1eu0zn6Z954dilxrb52Y,10842
 port_ocean/tests/helpers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 port_ocean/tests/helpers/fixtures.py,sha256=IQEplbHhRgjrAsZlnXrgSYA5YQEn25I9HgO3_Fjibxg,1481
@@ -142,8 +143,8 @@ port_ocean/utils/repeat.py,sha256=0EFWM9d8lLXAhZmAyczY20LAnijw6UbIECf5lpGbOas,32
 port_ocean/utils/signal.py,sha256=K-6kKFQTltcmKDhtyZAcn0IMa3sUpOHGOAUdWKgx0_E,1369
 port_ocean/utils/time.py,sha256=pufAOH5ZQI7gXvOvJoQXZXZJV-Dqktoj9Qp9eiRwmJ4,1939
 port_ocean/version.py,sha256=UsuJdvdQlazzKGD3Hd5-U7N69STh8Dq9ggJzQFnu9fU,177
-port_ocean-0.13.1.dev1.dist-info/LICENSE.md,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
-port_ocean-0.13.1.dev1.dist-info/METADATA,sha256=y1F3De2qTYoHTZufqBoGQA2n-Y-dtmk8dJj4SMNtS0g,6678
-port_ocean-0.13.1.dev1.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-port_ocean-0.13.1.dev1.dist-info/entry_points.txt,sha256=F_DNUmGZU2Kme-8NsWM5LLE8piGMafYZygRYhOVtcjA,54
-port_ocean-0.13.1.dev1.dist-info/RECORD,,
+port_ocean-0.14.0.dist-info/LICENSE.md,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
+port_ocean-0.14.0.dist-info/METADATA,sha256=A_jE7vo5o-cE6dE8fLzRZGFh7wOJFNquJN5LyZ_ygCA,6673
+port_ocean-0.14.0.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+port_ocean-0.14.0.dist-info/entry_points.txt,sha256=F_DNUmGZU2Kme-8NsWM5LLE8piGMafYZygRYhOVtcjA,54
+port_ocean-0.14.0.dist-info/RECORD,,