port-ocean 0.15.1__py3-none-any.whl → 0.15.3__py3-none-any.whl

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/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/cli/cookiecutter/{{cookiecutter.integration_slug}}/.env.example

@@ -1,2 +1,6 @@
-OCEAN__PORT__CLIENT_ID="<port-client-id>"
-OCEAN__PORT__CLIENT_SECRET="<port-client-secret>"
+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/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/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/debug_cli.py

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

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.dist-info → port_ocean-0.15.3.dist-info}/METADATA

@@ -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.dist-info → port_ocean-0.15.3.dist-info}/RECORD

@@ -17,15 +17,15 @@ port_ocean/cli/commands/defaults/dock.py,sha256=pFtHrU_LTvb5Ddrzj09Wxy-jg1Ym10wB
 port_ocean/cli/commands/defaults/group.py,sha256=hii_4CYoQ7jSMePbnP4AmruO_RKWCUcoV7dXXBlZafc,115
 port_ocean/cli/commands/list_integrations.py,sha256=DVVioFruGUE-_v6UUHlcemWNN6RlWwCrf1X4HmAXsf8,1134
 port_ocean/cli/commands/main.py,sha256=gj0lmuLep2XeLNuabB7Wk0UVYPT7_CD_rAw5AoUQWSE,1057
-port_ocean/cli/commands/new.py,sha256=39_RnEZHoY0pWf59z_oXrLXAyVwzmFY0XcpCJrtZINI,3496
+port_ocean/cli/commands/new.py,sha256=qJ6fQG1t95U574Cvx5pMRgxabrmdB6kxEI0bwuTryb8,3262
 port_ocean/cli/commands/pull.py,sha256=VvrRjLNlfPuLIf7KzeIcbzzdi98Z0M9wCRpXC3QPxdI,2306
 port_ocean/cli/commands/sail.py,sha256=rY7rEMjfy_KXiWvtL0T72TTLgeQ3HW4SOzKkz9wL9nI,2282
 port_ocean/cli/commands/version.py,sha256=hEuIEIcm6Zkamz41Z9nxeSM_4g3oNlAgWwQyDGboh-E,536
 port_ocean/cli/cookiecutter/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-port_ocean/cli/cookiecutter/cookiecutter.json,sha256=N5UrAP2e5JbgEDz_WTQFIZlzSveME6x32sHeA7idjh0,481
+port_ocean/cli/cookiecutter/cookiecutter.json,sha256=ie-LJjg-ek3lP2RRosY2u_q2W4y2TykXm_Gynjjt6Es,814
 port_ocean/cli/cookiecutter/extensions.py,sha256=eQNjZvy2enDkJpvMbBGil77Xk9-38f862wfnmCjdoBc,446
 port_ocean/cli/cookiecutter/hooks/post_gen_project.py,sha256=tFqtsjSbu7HMN32WIiFO37S1a_dfHezvdPwmM6MmNJk,1182
-port_ocean/cli/cookiecutter/{{cookiecutter.integration_slug}}/.env.example,sha256=LnNPRe3RnzjWPL4tNLYEQiMvFEZHSy3ceqwQEapcpwE,92
+port_ocean/cli/cookiecutter/{{cookiecutter.integration_slug}}/.env.example,sha256=ywAmZto6YBGXyhEmpG1uYsgaHr2N1ZBRjdtRNt6Vkpw,388
 port_ocean/cli/cookiecutter/{{cookiecutter.integration_slug}}/.gitignore,sha256=32p1lDW_g5hyBz486GWfDeR9m7ikFlASVri5a8vmNoo,2698
 port_ocean/cli/cookiecutter/{{cookiecutter.integration_slug}}/.port/resources/.gitignore,sha256=kCpRPdl3S_jqYYZaOrc0-xa6-l3KqVjNRXc6jCkd_-Q,12
 port_ocean/cli/cookiecutter/{{cookiecutter.integration_slug}}/.port/resources/blueprints.json,sha256=9kf5gY4YjP78vEPfd9j7347sV6wiqeHzmBz7UJkvmDg,1187
@@ -102,9 +102,10 @@ port_ocean/core/integrations/mixins/handler.py,sha256=mZ7-0UlG3LcrwJttFbMe-R4xcO
 port_ocean/core/integrations/mixins/sync.py,sha256=B9fEs8faaYLLikH9GBjE_E61vo0bQDjIGQsQ1SRXOlA,3931
 port_ocean/core/integrations/mixins/sync_raw.py,sha256=BGS5EnZ2N3ifcAi94Wo-ZassSJ-_Se9eFJMpBDT7pNY,18841
 port_ocean/core/integrations/mixins/utils.py,sha256=7y1rGETZIjOQadyIjFJXIHKkQFKx_SwiP-TrAIsyyLY,2303
-port_ocean/core/models.py,sha256=YWLy-b3N3VnMjD__BTytHqXG78lNjVqnIuhvcVLSlrs,1484
+port_ocean/core/models.py,sha256=71QIFHl-p401h2HnSDQ-aaLXhu6z3iHTwCBI0TewJos,1902
 port_ocean/core/ocean_types.py,sha256=3_d8-n626f1kWLQ_Jxw194LEyrOVupz05qs_Y1pvB-A,990
-port_ocean/core/utils.py,sha256=40UjRauRJO47WDSNn9bkCRD2bfhfB3e-dnOLULnuVzE,3631
+port_ocean/core/utils.py,sha256=QSRuF9wlhbOw6cELlDlek_UIX6ciIuKWml8QhBmHU_k,3703
+port_ocean/debug_cli.py,sha256=gHrv-Ey3cImKOcGZpjoHlo4pa_zfmyOl6TUM4o9VtcA,96
 port_ocean/exceptions/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 port_ocean/exceptions/api.py,sha256=TLmTMqn4uHGaHgZK8PMIJ0TVJlPB4iP7xl9rx7GtCyY,426
 port_ocean/exceptions/base.py,sha256=uY4DX7fIITDFfemCJDWpaZi3bD51lcANc5swpoNvMJA,46
@@ -130,6 +131,7 @@ port_ocean/tests/clients/port/mixins/test_entities.py,sha256=A9myrnkLhKSQrnOLv1Z
 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/core/test_utils.py,sha256=94940TerN38jy81ebLJ2Fzf5JJUaV9krnce75APCwmM,2641
 port_ocean/tests/helpers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 port_ocean/tests/helpers/fake_port_api.py,sha256=9rtjC6iTQMfzWK6WipkDzzG0b1IIaRmvdJLOyV613vE,6479
 port_ocean/tests/helpers/fixtures.py,sha256=IQEplbHhRgjrAsZlnXrgSYA5YQEn25I9HgO3_Fjibxg,1481
@@ -151,8 +153,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.15.1.dist-info/LICENSE.md,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
-port_ocean-0.15.1.dist-info/METADATA,sha256=1TN3ywl0FoNAvU1dTww8197vioantB9hlQO2hQnMP04,6673
-port_ocean-0.15.1.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-port_ocean-0.15.1.dist-info/entry_points.txt,sha256=F_DNUmGZU2Kme-8NsWM5LLE8piGMafYZygRYhOVtcjA,54
-port_ocean-0.15.1.dist-info/RECORD,,
+port_ocean-0.15.3.dist-info/LICENSE.md,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
+port_ocean-0.15.3.dist-info/METADATA,sha256=97A1rlQ3w2zUQl6-OKN_6n_yJvMquXcJWwsJ3bNJ3hg,6673
+port_ocean-0.15.3.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+port_ocean-0.15.3.dist-info/entry_points.txt,sha256=F_DNUmGZU2Kme-8NsWM5LLE8piGMafYZygRYhOVtcjA,54
+port_ocean-0.15.3.dist-info/RECORD,,