cognite-toolkit 0.6.107__tar.gz → 0.6.108__tar.gz

{cognite_toolkit-0.6.107 → cognite_toolkit-0.6.108}/.github/workflows/demo.yml

@@ -19,7 +19,7 @@ jobs:
         LOGIN_FLOW: client_credentials
     name: Loadmaster
     steps:
-      - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5
+      - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6
       - uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6
         with:
           python-version: ${{ env.PYTHON_VERSION }}

{cognite_toolkit-0.6.107 → cognite_toolkit-0.6.108}/.github/workflows/release.yaml

@@ -18,7 +18,7 @@ jobs:
       IDP_CLIENT_SECRET: ${{ secrets.IDP_CLIENT_SECRET }}
       IDP_TOKEN_URL: ${{ vars.IDP_TOKEN_URL }}
     steps:
-      - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5
+      - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6
       - uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6
         with:
           python-version: 3.11
@@ -39,7 +39,7 @@ jobs:
     runs-on: ubuntu-latest
     environment: CD
     steps:
-      - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5
+      - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6
         with:
           fetch-depth: 0
       - uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6

{cognite_toolkit-0.6.107 → cognite_toolkit-0.6.108}/.pre-commit-config.yaml

@@ -2,7 +2,7 @@
 repos:
   - repo: https://github.com/astral-sh/uv-pre-commit
     # uv version.
-    rev: 0.9.9
+    rev: 0.9.11
     hooks:
       - id: uv-lock
 
@@ -21,7 +21,7 @@ repos:
     rev: v0.14.5
 
   - repo: https://github.com/igorshubovych/markdownlint-cli
-    rev: v0.45.0
+    rev: v0.46.0
     hooks:
     - id: markdownlint
     

{cognite_toolkit-0.6.107 → cognite_toolkit-0.6.108}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cognite_toolkit
-Version: 0.6.107
+Version: 0.6.108
 Summary: Official Cognite Data Fusion tool for project templates and configuration deployment
 Project-URL: Homepage, https://docs.cognite.com/cdf/deploy/cdf_toolkit/
 Project-URL: Changelog, https://github.com/cognitedata/toolkit/releases

{cognite_toolkit-0.6.107 → cognite_toolkit-0.6.108}/cdf.toml

@@ -33,7 +33,7 @@ dev = true
 [modules]
 # This is the version of the modules. It should not be changed manually.
 # It will be updated by the 'cdf modules upgrade' command.
-version = "0.6.107"
+version = "0.6.108"
 
 
 [library.toolkit-data]

{cognite_toolkit-0.6.107 → cognite_toolkit-0.6.108}/cognite_toolkit/_cdf_tk/client/api/migration.py

@@ -10,6 +10,7 @@ from cognite.client.data_classes.data_modeling import (
     NodeApplyResultList,
     NodeId,
     NodeList,
+    ViewId,
     filters,
     query,
 )
@@ -347,6 +348,9 @@ class SpaceSourceAPI:
         return results
 
 
+_T_Cached = TypeVar("_T_Cached", bound=NodeId | ViewId)
+
+
 class LookupAPI:
     def __init__(self, instance_api: ExtendedInstancesAPI, resource_type: AssetCentricType) -> None:
         self._instance_api = instance_api
@@ -354,13 +358,15 @@ class LookupAPI:
         self._view_id = InstanceSource.get_source()
         self._node_id_by_id: dict[int, NodeId | None] = {}
         self._node_id_by_external_id: dict[str, NodeId | None] = {}
+        self._consumer_view_id_by_id: dict[int, ViewId | None] = {}
+        self._consumer_view_id_by_external_id: dict[str, ViewId | None] = {}
         self._RETRIEVE_LIMIT = 1000
 
     @overload
     def __call__(self, id: int, external_id: None = None) -> NodeId | None: ...
 
     @overload
-    def __call__(self, id: Sequence[int], external_id: None = None) -> dict[int, NodeId]: ...
+    def __call__(self, id: SequenceNotStr[int], external_id: None = None) -> dict[int, NodeId]: ...
 
     @overload
     def __call__(self, *, external_id: str) -> NodeId | None: ...
@@ -369,7 +375,7 @@ class LookupAPI:
     def __call__(self, *, external_id: SequenceNotStr[str]) -> dict[str, NodeId]: ...
 
     def __call__(
-        self, id: int | Sequence[int] | None = None, external_id: str | SequenceNotStr[str] | None = None
+        self, id: int | SequenceNotStr[int] | None = None, external_id: str | SequenceNotStr[str] | None = None
     ) -> dict[int, NodeId] | dict[str, NodeId] | NodeId | None:
         """Lookup NodeId by either internal ID or external ID.
 
@@ -382,35 +388,87 @@ class LookupAPI:
 
         """
         if id is not None and external_id is None:
-            return self._lookup_by_id(id)
+            return self._lookup(
+                identifier=id,
+                cache=self._node_id_by_id,
+                property_name="id",
+                return_type=NodeId,
+                input_type=int,
+            )
         elif external_id is not None and id is None:
-            return self._lookup_by_external_id(external_id)
+            return self._lookup(
+                identifier=external_id,
+                cache=self._node_id_by_external_id,
+                property_name="classicExternalId",
+                return_type=NodeId,
+                input_type=str,
+            )
         else:
-            raise ValueError("Either id or external_id must be provided, but not both.")
+            raise TypeError("Either id or external_id must be provided, but not both.")
 
-    def _lookup_by_id(self, id: int | Sequence[int]) -> dict[int, NodeId] | NodeId | None:
-        ids: list[int] = [id] if isinstance(id, int) else list(id)
+    @overload
+    def consumer_view(self, id: int, external_id: None = None) -> ViewId | None: ...
 
-        missing = [id_ for id_ in ids if id_ not in self._node_id_by_id]
-        if missing:
-            self._fetch_and_cache(missing, by="id")
-        if isinstance(id, int):
-            return self._node_id_by_id.get(id)
-        return {id_: node_id for id_ in ids if isinstance(node_id := self._node_id_by_id.get(id_), NodeId)}
+    @overload
+    def consumer_view(self, id: SequenceNotStr[int], external_id: None = None) -> dict[int, ViewId]: ...
 
-    def _lookup_by_external_id(self, external_id: str | SequenceNotStr[str]) -> dict[str, NodeId] | NodeId | None:
-        external_ids: list[str] = [external_id] if isinstance(external_id, str) else list(external_id)
+    @overload
+    def consumer_view(self, *, external_id: str) -> ViewId | None: ...
+
+    @overload
+    def consumer_view(self, *, external_id: SequenceNotStr[str]) -> dict[str, ViewId]: ...
+
+    def consumer_view(
+        self, id: int | SequenceNotStr[int] | None = None, external_id: str | SequenceNotStr[str] | None = None
+    ) -> dict[int, ViewId] | dict[str, ViewId] | ViewId | None:
+        """Lookup Consumer ViewId by either internal ID or external ID.
+
+        Args:
+            id (int | Sequence[int] | None): The internal ID(s) to lookup.
+            external_id (str | SequenceNotStr[str] | None): The external ID(s) to lookup.
+        Returns:
+            ViewId | dict[int, ViewId] | dict[str, ViewId] | None
+        """
+        if id is not None and external_id is None:
+            return self._lookup(
+                identifier=id,
+                cache=self._consumer_view_id_by_id,
+                property_name="id",
+                return_type=ViewId,
+                input_type=int,
+            )
+        elif external_id is not None and id is None:
+            return self._lookup(
+                identifier=external_id,
+                cache=self._consumer_view_id_by_external_id,
+                property_name="classicExternalId",
+                return_type=ViewId,
+                input_type=str,
+            )
+        else:
+            raise TypeError("Either id or external_id must be provided, but not both.")
 
-        missing = [ext_id for ext_id in external_ids if ext_id not in self._node_id_by_external_id]
+    def _lookup(
+        self,
+        identifier: _T | SequenceNotStr[_T],
+        cache: dict[_T, _T_Cached | None],
+        property_name: Literal["id", "classicExternalId"],
+        return_type: type[_T_Cached],
+        input_type: type[_T],
+    ) -> dict[_T, _T_Cached] | _T_Cached | None:
+        """Generic lookup method for both NodeId and ViewId by id or external_id."""
+        is_single = isinstance(identifier, input_type)
+        # MyPy does not understand that if is_single is True, identifier is _T, else SequenceNotStr[_T].
+        identifiers: list[_T] = [identifier] if is_single else list(identifier)  # type: ignore[arg-type, list-item]
+
+        missing = [id_ for id_ in identifiers if id_ not in cache]
         if missing:
-            self._fetch_and_cache(missing, by="classicExternalId")
-        if isinstance(external_id, str):
-            return self._node_id_by_external_id.get(external_id)
-        return {
-            ext_id: node_id
-            for ext_id in external_ids
-            if isinstance(node_id := self._node_id_by_external_id.get(ext_id), NodeId)
-        }
+            self._fetch_and_cache(missing, by=property_name)
+
+        if is_single:
+            return cache.get(identifier)  # type: ignore[arg-type]
+
+        return {id_: value for id_ in identifiers if isinstance(value := cache.get(id_), return_type)}
 
     def _fetch_and_cache(self, identifiers: Sequence[int | str], by: Literal["id", "classicExternalId"]) -> None:
         for chunk in chunker_sequence(identifiers, self._RETRIEVE_LIMIT):
@@ -433,17 +491,25 @@ class LookupAPI:
                 instance_source = InstanceSource._load(item.dump())
                 node_id = instance_source.as_id()
                 self._node_id_by_id[instance_source.id_] = node_id
+                self._consumer_view_id_by_id[instance_source.id_] = instance_source.consumer_view()
                 if instance_source.classic_external_id:
                     self._node_id_by_external_id[instance_source.classic_external_id] = node_id
+                    self._consumer_view_id_by_external_id[instance_source.classic_external_id] = (
+                        instance_source.consumer_view()
+                    )
             missing = set(chunk) - set(self._node_id_by_id.keys()) - set(self._node_id_by_external_id.keys())
             if by == "id":
                 for missing_id in cast(set[int], missing):
                     if missing_id not in self._node_id_by_id:
                         self._node_id_by_id[missing_id] = None
+                    if missing_id not in self._consumer_view_id_by_id:
+                        self._consumer_view_id_by_id[missing_id] = None
             elif by == "classicExternalId":
                 for missing_ext_id in cast(set[str], missing):
                     if missing_ext_id not in self._node_id_by_external_id:
                         self._node_id_by_external_id[missing_ext_id] = None
+                    if missing_ext_id not in self._consumer_view_id_by_external_id:
+                        self._consumer_view_id_by_external_id[missing_ext_id] = None
 
 
 class MigrationLookupAPI:

{cognite_toolkit-0.6.107 → cognite_toolkit-0.6.108}/cognite_toolkit/_cdf_tk/client/data_classes/migration.py

@@ -114,6 +114,14 @@ class InstanceSource(_InstanceSourceProperties, TypedNode):
         self.preferred_consumer_view_id = preferred_consumer_view_id
         self.ingestion_view = DirectRelationReference.load(ingestion_view) if ingestion_view else None
 
+    def dump(self, camel_case: bool = True) -> dict[str, Any]:
+        output = super().dump(camel_case)
+        if self.preferred_consumer_view_id:
+            output["properties"]["cognite_migration"]["InstanceSource/v1"]["preferredConsumerViewId"] = (
+                self.preferred_consumer_view_id.dump(camel_case=camel_case)
+            )
+        return output
+
     @classmethod
     def _load_properties(cls, resource: dict[str, Any]) -> dict[str, Any]:
         if "preferredConsumerViewId" in resource:

{cognite_toolkit-0.6.107 → cognite_toolkit-0.6.108}/cognite_toolkit/_cdf_tk/cruds/_resource_cruds/agent.py

@@ -2,7 +2,7 @@ from collections.abc import Hashable, Iterable, Sequence
 from typing import Any
 
 from cognite.client.data_classes.agents import Agent, AgentList, AgentUpsert, AgentUpsertList
-from cognite.client.data_classes.capabilities import Capability
+from cognite.client.data_classes.capabilities import AgentsAcl, Capability
 from cognite.client.exceptions import CogniteAPIError
 from cognite.client.utils.useful_types import SequenceNotStr
 
@@ -37,7 +37,12 @@ class AgentCRUD(ResourceCRUD[str, AgentUpsert, Agent, AgentUpsertList, AgentList
     def get_required_capability(
         cls, items: Sequence[AgentUpsert] | None, read_only: bool
     ) -> Capability | list[Capability]:
-        return []
+        if not items and items is not None:
+            return []
+
+        actions = [AgentsAcl.Action.READ] if read_only else [AgentsAcl.Action.READ, AgentsAcl.Action.WRITE]
+
+        return AgentsAcl(actions, AgentsAcl.Scope.All())
 
     def create(self, items: AgentUpsertList) -> AgentList:
         return self.client.agents.upsert(items)

{cognite_toolkit-0.6.107 → cognite_toolkit-0.6.108}/cognite_toolkit/_cdf_tk/cruds/_resource_cruds/robotics.py

@@ -81,7 +81,6 @@ class RoboticFrameCRUD(ResourceCRUD[str, FrameWrite, Frame, FrameWriteList, Fram
                 capabilities.RoboticsAcl.Action.Create,
                 capabilities.RoboticsAcl.Action.Delete,
                 capabilities.RoboticsAcl.Action.Update,
-                capabilities.RoboticsAcl.Action.Delete,
             ],
             capabilities.RoboticsAcl.Scope.All(),
         )
@@ -154,7 +153,6 @@ class RoboticLocationCRUD(ResourceCRUD[str, LocationWrite, Location, LocationWri
                 capabilities.RoboticsAcl.Action.Create,
                 capabilities.RoboticsAcl.Action.Delete,
                 capabilities.RoboticsAcl.Action.Update,
-                capabilities.RoboticsAcl.Action.Delete,
             ]
         )
 
@@ -230,7 +228,6 @@ class RoboticsDataPostProcessingCRUD(
                 capabilities.RoboticsAcl.Action.Create,
                 capabilities.RoboticsAcl.Action.Delete,
                 capabilities.RoboticsAcl.Action.Update,
-                capabilities.RoboticsAcl.Action.Delete,
             ]
         )
 
@@ -325,7 +322,6 @@ class RobotCapabilityCRUD(
                 capabilities.RoboticsAcl.Action.Create,
                 capabilities.RoboticsAcl.Action.Delete,
                 capabilities.RoboticsAcl.Action.Update,
-                capabilities.RoboticsAcl.Action.Delete,
             ]
         )
 
@@ -423,7 +419,6 @@ class RoboticMapCRUD(ResourceCRUD[str, MapWrite, Map, MapWriteList, MapList]):
                 capabilities.RoboticsAcl.Action.Create,
                 capabilities.RoboticsAcl.Action.Delete,
                 capabilities.RoboticsAcl.Action.Update,
-                capabilities.RoboticsAcl.Action.Delete,
             ]
         )
 

{cognite_toolkit-0.6.107 → cognite_toolkit-0.6.108}/cognite_toolkit/_repo_files/GitHub/.github/workflows/deploy.yaml

@@ -12,7 +12,7 @@ jobs:
     environment: dev
     name: Deploy
     container:
-      image: cognite/toolkit:0.6.107
+      image: cognite/toolkit:0.6.108
       env:
         CDF_CLUSTER: ${{ vars.CDF_CLUSTER }}
         CDF_PROJECT: ${{ vars.CDF_PROJECT }}

{cognite_toolkit-0.6.107 → cognite_toolkit-0.6.108}/cognite_toolkit/_repo_files/GitHub/.github/workflows/dry-run.yaml

@@ -10,7 +10,7 @@ jobs:
     environment: dev
     name: Deploy Dry Run
     container:
-      image: cognite/toolkit:0.6.107
+      image: cognite/toolkit:0.6.108
       env:
         CDF_CLUSTER: ${{ vars.CDF_CLUSTER }}
         CDF_PROJECT: ${{ vars.CDF_PROJECT }}

{cognite_toolkit-0.6.107 → cognite_toolkit-0.6.108}/cognite_toolkit/_resources/cdf.toml

@@ -4,7 +4,7 @@ default_env = "<DEFAULT_ENV_PLACEHOLDER>"
 [modules]
 # This is the version of the modules. It should not be changed manually.
 # It will be updated by the 'cdf modules upgrade' command.
-version = "0.6.107"
+version = "0.6.108"
 
 [alpha_flags]
 external-libraries = true

cognite_toolkit-0.6.108/cognite_toolkit/_version.py

@@ -0,0 +1 @@
+__version__ = "0.6.108"

cognite_toolkit-0.6.108/last_changelog_entry.md

@@ -0,0 +1,10 @@
+## cdf 
+
+### Fixed
+
+- updated `AgentCRUD` capabilities
+- removed repeated delete action in `Robotics` resource
+
+## templates
+
+No changes.

cognite_toolkit-0.6.108/last_git_message.txt

@@ -0,0 +1,21 @@
+[CDF-25958] Resouce Capability Update (#2231)
+
+# Description
+
+This PR intendeds to update the Resources missing capabilities.
+
+## Changelog
+
+- [x] Patch
+- [ ] Skip
+
+## cdf
+
+### Fixed
+
+- updated `AgentCRUD` capabilities
+- removed repeated delete action in `Robotics` resource
+
+## templates
+
+No changes.

cognite_toolkit-0.6.108/last_version.txt

@@ -0,0 +1 @@
+0.6.107

{cognite_toolkit-0.6.107 → cognite_toolkit-0.6.108}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "cognite_toolkit"
-version = "0.6.107"
+version = "0.6.108"
 description = "Official Cognite Data Fusion tool for project templates and configuration deployment"
 authors = [
     {name ="Cognite AS", email="support@cognite.com"}

{cognite_toolkit-0.6.107 → cognite_toolkit-0.6.108}/tests/test_unit/test_cdf_tk/test_client/test_migration.py

@@ -2,7 +2,7 @@ from typing import Any, ClassVar
 
 import pytest
 import responses
-from cognite.client.data_classes.data_modeling import NodeId
+from cognite.client.data_classes.data_modeling import NodeId, ViewId
 
 from cognite_toolkit._cdf_tk.client import ToolkitClient, ToolkitClientConfig
 from cognite_toolkit._cdf_tk.client.data_classes.migration import InstanceSource
@@ -30,6 +30,7 @@ class TestMigrationLookup:
     EXISTING_ID = 123
     EXISTING_EXTERNAL_ID = "node_123"
     EXISTING_NODE_ID = NodeId(SPACE, "node_123")
+    CONSUMER_VIEW = ViewId("cdf_cdm", "CogniteAsset", "v1")
     QUERY_RESPONSE: ClassVar[dict[str, Any]] = {
         "items": {
             "instanceSource": [
@@ -42,6 +43,7 @@ class TestMigrationLookup:
                     resource_type="asset",
                     id_=EXISTING_ID,
                     classic_external_id=EXISTING_EXTERNAL_ID,
+                    preferred_consumer_view_id=CONSUMER_VIEW,
                 ).dump()
             ]
         },
@@ -88,3 +90,56 @@ class TestMigrationLookup:
         _ = client.migration.lookup.assets(-1)
 
         assert len(rsps.calls) == 1, "Expected only one API call for multiple lookups of the same non-existing ID"
+
+    def test_invalid_input(self, toolkit_config: ToolkitClientConfig):
+        client = ToolkitClient(config=toolkit_config)
+        with pytest.raises(TypeError):
+            _ = client.migration.lookup.assets(id=self.EXISTING_ID, external_id=self.EXISTING_EXTERNAL_ID)
+
+    @pytest.mark.parametrize(
+        "args, expected_return",
+        [
+            pytest.param({"id": EXISTING_ID}, CONSUMER_VIEW, id="Existing single ID"),
+            pytest.param({"external_id": EXISTING_EXTERNAL_ID}, CONSUMER_VIEW, id="Existing single external ID"),
+            pytest.param({"id": -1}, None, id="Non-existing single ID"),
+            pytest.param({"external_id": "non_existing_external_id"}, None, id="Non-existing single external ID"),
+            pytest.param(
+                {"id": {EXISTING_ID, -1}}, {EXISTING_ID: CONSUMER_VIEW}, id="Mixed existing and non-existing IDs"
+            ),
+            pytest.param(
+                {"external_id": [EXISTING_EXTERNAL_ID, "non_existing_external_id"]},
+                {EXISTING_EXTERNAL_ID: CONSUMER_VIEW},
+                id="Mixed existing and non-existing external IDs",
+            ),
+        ],
+    )
+    def test_get_preferred_consumer_view(
+        self,
+        args: dict[str, Any],
+        expected_return: ViewId,
+        lookup_client: tuple[ToolkitClient, responses.RequestsMock],
+    ) -> None:
+        client, _ = lookup_client
+        actual_return = client.migration.lookup.assets.consumer_view(**args)
+        assert actual_return == expected_return
+
+    def test_consumer_view_single_api_call(self, lookup_client: tuple[ToolkitClient, responses.RequestsMock]) -> None:
+        client, rsps = lookup_client
+        _ = client.migration.lookup.assets.consumer_view(self.EXISTING_ID)
+        _ = client.migration.lookup.assets.consumer_view(self.EXISTING_ID)
+
+        assert len(rsps.calls) == 1, "Expected only one API call for multiple lookups of the same ID"
+
+    def test_consumer_view_non_existing_single_api_call(
+        self, lookup_client: tuple[ToolkitClient, responses.RequestsMock]
+    ) -> None:
+        client, rsps = lookup_client
+        _ = client.migration.lookup.assets.consumer_view(-1)
+        _ = client.migration.lookup.assets.consumer_view(-1)
+
+        assert len(rsps.calls) == 1, "Expected only one API call for multiple lookups of the same non-existing ID"
+
+    def test_consumer_view_invalid_input(self, toolkit_config: ToolkitClientConfig):
+        client = ToolkitClient(config=toolkit_config)
+        with pytest.raises(TypeError):
+            _ = client.migration.lookup.assets.consumer_view(id=self.EXISTING_ID, external_id=self.EXISTING_EXTERNAL_ID)