port-ocean 0.15.1__tar.gz → 0.15.3__tar.gz

{port_ocean-0.15.1 → port_ocean-0.15.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: port-ocean
-Version: 0.15.1
+Version: 0.15.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.15.1 → port_ocean-0.15.3}/port_ocean/cli/commands/new.py

@@ -77,18 +77,15 @@ def new(path: str, is_private_integration: bool) -> None:
     )
     console.print("Here are your next steps:\n", style="bold")
     console.print(
-        "⚓️ Install necessary packages: Run [bold][blue]make install[/blue][/bold] to install all required packages for your project.\n"
-        f"▶️ [bold][blue]cd {path}/{name} && make install && . .venv/bin/activate[/blue][/bold]\n"
+        f"⚓️ Install necessary packages: Run [bold][blue]cd {path}/{name} && make install && . .venv/bin/activate[/blue][/bold] to install all required packages for your project."
     )
     console.print(
-        f"⚓️ Copy example env file: Run [bold][blue]cp {path}/{name}.env.example {path}/{name}/.env [/blue][/bold] and set your port credentials in the created file.\n"
+        "⚓️ Copy example env file: Run [bold][blue]cp .env.example .env [/blue][/bold] and update your integration's configuration in the .env file."
     )
     console.print(
-        "⚓️ Set sail with [blue]Ocean[/blue]: Run [bold][blue]ocean sail[/blue] <path_to_integration>[/bold] to run the project using Ocean.\n"
-        f"▶️ [bold][blue]ocean sail {path}/{name}[/blue][/bold] \n"
+        "⚓️ Set sail with [blue]Ocean[/blue]: Run [bold][blue]ocean sail[/blue][/bold] to run the project using Ocean."
     )
     if not final_private_integration:
         console.print(
-            "⚓️ Smooth sailing with [blue]Make[/blue]: Alternatively, you can run [bold][blue]make run[/blue][/bold] to launch your project using Make. \n"
-            f"▶️ [bold][blue]make run {path}/{name}[/blue][/bold]"
+            f"⚓️ Smooth sailing with [blue]Make[/blue]: Alternatively, you can run [bold][blue]make run {path}/{name}[/blue][/bold] to launch your project using Make."
         )

{port_ocean-0.15.1 → port_ocean-0.15.3}/port_ocean/cli/cookiecutter/cookiecutter.json

@@ -6,6 +6,9 @@
     "email": "Your address email <you@example.com>",
     "release_date": "{% now 'local' %}",
     "is_private_integration": true,
+    "port_client_id": "you can find it using: https://docs.getport.io/build-your-software-catalog/custom-integration/api/#find-your-port-credentials",
+    "port_client_secret": "you can find it using: https://docs.getport.io/build-your-software-catalog/custom-integration/api/#find-your-port-credentials",
+    "is_us_region": false,
     "_extensions": [
         "jinja2_time.TimeExtension",
         "extensions.VersionExtension"

port_ocean-0.15.3/port_ocean/cli/cookiecutter/{{cookiecutter.integration_slug}}/.env.example

@@ -0,0 +1,6 @@
+OCEAN__PORT__CLIENT_ID={{ cookiecutter.port_client_id }}
+OCEAN__PORT__CLIENT_SECRET={{ cookiecutter.port_client_secret }}
+OCEAN__INTEGRATION__IDENTIFIER={{ cookiecutter.integration_slug }}
+OCEAN__PORT__BASE_URL={% if cookiecutter.is_us_region %}https://api.us.getport.io{% else %}https://api.getport.io{% endif %}
+OCEAN__EVENT_LISTENER__TYPE=POLLING
+OCEAN__INITIALIZE_PORT_RESOURCES=true

{port_ocean-0.15.1 → port_ocean-0.15.3}/port_ocean/core/models.py

@@ -8,12 +8,23 @@ from pydantic.fields import Field
 
 class Runtime(Enum):
     Saas = "Saas"
-    SaasOauth2 = "SaasOauth2"
     OnPrem = "OnPrem"
 
     @property
     def is_saas_runtime(self) -> bool:
-        return self in [Runtime.Saas, Runtime.SaasOauth2]
+        return self in [Runtime.Saas]
+
+    def is_installation_type_compatible(self, installation_type: str) -> bool:
+        """
+        Check if the installation type is compatible with the runtime
+
+        if the runtime is Saas, the installation type should start with Saas
+        else the installation type should be OnPrem
+        """
+        return (
+            self.value == Runtime.Saas.value
+            and installation_type.startswith(self.value)
+        ) or installation_type == self.value
 
 
 class Entity(BaseModel):

{port_ocean-0.15.1 → port_ocean-0.15.3}/port_ocean/core/utils.py

@@ -42,10 +42,12 @@ async def validate_integration_runtime(
     current_integration = await port_client.get_current_integration(
         should_raise=False, should_log=False
     )
-    current_runtime = current_integration.get("installationType", "OnPrem")
-    if current_integration and current_runtime != requested_runtime.value:
+    current_installation_type = current_integration.get("installationType", "OnPrem")
+    if current_integration and not requested_runtime.is_installation_type_compatible(
+        current_installation_type
+    ):
         raise IntegrationRuntimeException(
-            f"Invalid Runtime! Requested to run existing {current_runtime} integration in {requested_runtime} runtime."
+            f"Invalid Runtime! Requested to run existing {current_installation_type} integration in {requested_runtime} runtime."
         )
 
 

port_ocean-0.15.3/port_ocean/debug_cli.py

@@ -0,0 +1,5 @@
+from port_ocean.cli.commands.main import cli_start
+
+
+if __name__ == "__main__":
+    cli_start()

port_ocean-0.15.3/port_ocean/tests/core/test_utils.py

@@ -0,0 +1,73 @@
+from unittest.mock import AsyncMock, patch
+
+import pytest
+
+from port_ocean.core.utils import validate_integration_runtime
+from port_ocean.clients.port.client import PortClient
+from port_ocean.core.models import Runtime
+from port_ocean.tests.helpers.port_client import get_port_client_for_integration
+from port_ocean.exceptions.core import IntegrationRuntimeException
+
+
+class TestValidateIntegrationRuntime:
+
+    @pytest.mark.asyncio
+    @pytest.mark.parametrize(
+        "requested_runtime, installation_type, should_raise",
+        [
+            (Runtime.Saas, "Saas", False),
+            (Runtime.Saas, "SaasOauth2", False),
+            (Runtime.Saas, "OnPrem", True),
+            (Runtime.OnPrem, "OnPrem", False),
+            (Runtime.OnPrem, "SaasOauth2", True),
+        ],
+    )
+    @patch.object(PortClient, "get_current_integration", new_callable=AsyncMock)
+    async def test_validate_integration_runtime(
+        self,
+        mock_get_current_integration: AsyncMock,
+        requested_runtime: Runtime,
+        installation_type: str,
+        should_raise: bool,
+    ) -> None:
+        # Arrange
+        port_client = get_port_client_for_integration(
+            client_id="mock-client-id",
+            client_secret="mock-client-secret",
+            integration_identifier="mock-integration-identifier",
+            integration_type="mock-integration-type",
+            integration_version="mock-integration-version",
+            base_url="mock-base-url",
+        )
+
+        # Mock the return value of get_current_integration
+        mock_get_current_integration.return_value = {
+            "installationType": installation_type
+        }
+
+        # Act & Assert
+        if should_raise:
+            with pytest.raises(IntegrationRuntimeException):
+                await validate_integration_runtime(port_client, requested_runtime)
+        else:
+            await validate_integration_runtime(port_client, requested_runtime)
+
+        # Verify that get_current_integration was called once
+        mock_get_current_integration.assert_called_once()
+
+    @pytest.mark.parametrize(
+        "requested_runtime, installation_type, expected",
+        [
+            (Runtime.Saas, "SaasOauth2", True),
+            (Runtime.Saas, "OnPrem", False),
+            (Runtime.OnPrem, "OnPrem", True),
+            (Runtime.OnPrem, "SaasCloud", False),
+        ],
+    )
+    def test_runtime_installation_compatibility(
+        self, requested_runtime: Runtime, installation_type: str, expected: bool
+    ) -> None:
+        assert (
+            requested_runtime.is_installation_type_compatible(installation_type)
+            == expected
+        )

{port_ocean-0.15.1 → port_ocean-0.15.3}/pyproject.toml

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

port_ocean-0.15.1/port_ocean/cli/cookiecutter/{{cookiecutter.integration_slug}}/.env.example

@@ -1,2 +0,0 @@
-OCEAN__PORT__CLIENT_ID="<port-client-id>"
-OCEAN__PORT__CLIENT_SECRET="<port-client-secret>"