cognite-toolkit 0.6.104__tar.gz → 0.6.105__tar.gz

{cognite_toolkit-0.6.104 → cognite_toolkit-0.6.105}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cognite_toolkit
-Version: 0.6.104
+Version: 0.6.105
 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.104 → cognite_toolkit-0.6.105}/cdf.toml

@@ -22,6 +22,7 @@ upload = true
 function-cognite-file = true
 external-libraries = true
 v07 = true
+streams = true
 
 [plugins]
 run = true
@@ -32,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.104"
+version = "0.6.105"
 
 
 [library.toolkit-data]

{cognite_toolkit-0.6.104 → cognite_toolkit-0.6.105}/cognite_toolkit/_cdf_tk/client/data_classes/streams.py

@@ -29,13 +29,12 @@ class StreamRequestList(UserList[StreamRequest], ResourceRequestListProtocol):
     """List of Stream request resources."""
 
     _RESOURCE = StreamRequest
-    items: list[StreamRequest]
 
     def __init__(self, initlist: list[StreamRequest] | None = None, **_: Any) -> None:
         super().__init__(initlist or [])
 
     def dump(self, camel_case: bool = True) -> list[dict[str, Any]]:
-        return [item.dump(camel_case) for item in self.items]
+        return [item.dump(camel_case) for item in self.data]
 
     @classmethod
     def load(cls, data: list[dict[str, Any]], cognite_client: CogniteClient | None = None) -> "StreamRequestList":
@@ -78,19 +77,25 @@ class StreamResponse(ResponseResource["StreamRequest"]):
 
     external_id: str
     created_time: int
-    created_from_template: StreamTemplateName | None = None
-    type: Literal["Mutable", "Immutable"] | None = None
+    created_from_template: StreamTemplateName
+    type: Literal["Mutable", "Immutable"]
     settings: StreamSettings | None = None
 
     def as_request_resource(self) -> StreamRequest:
-        template_name = self.created_from_template or "BasicArchive"
-        return StreamRequest(
-            external_id=self.external_id,
-            settings={"template": {"name": template_name}},
+        return StreamRequest.model_validate(
+            {
+                "externalId": self.external_id,
+                "settings": {"template": {"name": self.created_from_template}},
+            }
         )
 
-    def as_write(self) -> Self:
-        return self
+    def as_write(self) -> StreamRequest:
+        return StreamRequest.model_validate(
+            {
+                "externalId": self.external_id,
+                "settings": {"template": {"name": self.created_from_template}},
+            }
+        )
 
 
 class StreamResponseList(UserList[StreamResponse], ResourceResponseListProtocol):

{cognite_toolkit-0.6.104 → cognite_toolkit-0.6.105}/cognite_toolkit/_cdf_tk/constants.py

@@ -182,4 +182,7 @@ MISSING_INSTANCE_SPACE = "<InstanceSpaceMissing>"
 MISSING_EXTERNAL_ID = "INTERNAL_ID_project_{project}_id_{id}"
 
 # Stream Template names
+STREAM_IMMUTABLE_TEMPLATE_NAME = frozenset(("ImmutableTestStream", "BasicArchive"))
+STREAM_MUTABLE_TEMPLATE_NAME = frozenset(("BasicLiveData",))
+
 StreamTemplateName: TypeAlias = Literal["ImmutableTestStream", "BasicArchive", "BasicLiveData"]

{cognite_toolkit-0.6.104 → cognite_toolkit-0.6.105}/cognite_toolkit/_cdf_tk/cruds/__init__.py

@@ -60,6 +60,7 @@ from ._resource_cruds import (
     SequenceCRUD,
     SequenceRowCRUD,
     SpaceCRUD,
+    StreamCRUD,
     StreamlitCRUD,
     ThreeDModelCRUD,
     TimeSeriesCRUD,
@@ -85,6 +86,8 @@ if not FeatureFlag.is_enabled(Flags.MIGRATE):
     _EXCLUDED_CRUDS.add(ResourceViewMappingCRUD)
 if not FeatureFlag.is_enabled(Flags.SEARCH_CONFIG):
     _EXCLUDED_CRUDS.add(SearchConfigCRUD)
+if not FeatureFlag.is_enabled(Flags.STREAMS):
+    _EXCLUDED_CRUDS.add(StreamCRUD)
 
 
 CRUDS_BY_FOLDER_NAME: dict[str, list[type[Loader]]] = {}
@@ -132,6 +135,7 @@ ResourceTypes: TypeAlias = Literal[
     "functions",
     "raw",
     "robotics",
+    "streams",
     "streamlit",
     "workflows",
 ]

{cognite_toolkit-0.6.104 → cognite_toolkit-0.6.105}/cognite_toolkit/_cdf_tk/cruds/_resource_cruds/__init__.py

@@ -35,6 +35,7 @@ from .robotics import (
     RoboticMapCRUD,
     RoboticsDataPostProcessingCRUD,
 )
+from .streams import StreamCRUD
 from .three_d_model import ThreeDModelCRUD
 from .timeseries import DatapointSubscriptionCRUD, TimeSeriesCRUD
 from .transformation import TransformationCRUD, TransformationNotificationCRUD, TransformationScheduleCRUD
@@ -82,6 +83,7 @@ __all__ = [
     "SequenceCRUD",
     "SequenceRowCRUD",
     "SpaceCRUD",
+    "StreamCRUD",
     "StreamlitCRUD",
     "ThreeDModelCRUD",
     "TimeSeriesCRUD",

cognite_toolkit-0.6.105/cognite_toolkit/_cdf_tk/cruds/_resource_cruds/streams.py

@@ -0,0 +1,99 @@
+from collections.abc import Hashable, Iterable, Sequence
+from typing import Any, final
+
+from cognite.client.data_classes.capabilities import Capability, StreamsAcl
+from cognite.client.utils.useful_types import SequenceNotStr
+
+from cognite_toolkit._cdf_tk.client.data_classes.streams import (
+    StreamRequest,
+    StreamRequestList,
+    StreamResponse,
+    StreamResponseList,
+)
+from cognite_toolkit._cdf_tk.cruds._base_cruds import ResourceCRUD
+from cognite_toolkit._cdf_tk.resource_classes import StreamYAML
+from cognite_toolkit._cdf_tk.utils.http_client import ToolkitAPIError
+
+from .datamodel import ContainerCRUD
+
+
+@final
+class StreamCRUD(ResourceCRUD[str, StreamRequest, StreamResponse, StreamRequestList, StreamResponseList]):
+    folder_name = "streams"
+    filename_pattern = r"^.*\.Streams$"
+    filetypes = frozenset({"yaml", "yml"})
+    resource_cls = StreamResponse
+    resource_write_cls = StreamRequest
+    list_cls = StreamResponseList
+    list_write_cls = StreamRequestList
+    kind = "Streams"
+    yaml_cls = StreamYAML
+    dependencies = frozenset({ContainerCRUD})
+    _doc_url = "Streams/operation/createStream"
+    support_update = False
+
+    @property
+    def display_name(self) -> str:
+        return "streams"
+
+    @classmethod
+    def get_id(cls, item: StreamRequest | StreamResponse | dict) -> str:
+        if isinstance(item, dict):
+            return item["externalId"]
+        return item.external_id
+
+    @classmethod
+    def dump_id(cls, id: str) -> dict[str, Any]:
+        return {"externalId": id}
+
+    @classmethod
+    def get_required_capability(
+        cls, items: Sequence[StreamRequest] | None, read_only: bool
+    ) -> Capability | list[Capability]:
+        if not items and items is not None:
+            return []
+
+        actions = (
+            [StreamsAcl.Action.Read]
+            if read_only
+            else [StreamsAcl.Action.Read, StreamsAcl.Action.Create, StreamsAcl.Action.Delete]
+        )
+        return StreamsAcl(actions, StreamsAcl.Scope.All())
+
+    def create(self, items: StreamRequestList) -> StreamResponseList:
+        created = self.client.streams.create(list(items))
+        return StreamResponseList(created)
+
+    def retrieve(self, ids: SequenceNotStr[str]) -> StreamResponseList:
+        retrieved: list[StreamResponse] = []
+        for _id in ids:
+            try:
+                _resp = self.client.streams.retrieve(_id)
+            except ToolkitAPIError:
+                continue
+            if _resp is not None:
+                retrieved.append(_resp)
+        return StreamResponseList(retrieved)
+
+    def delete(self, ids: SequenceNotStr[str]) -> int:
+        count = 0
+        for _id in ids:
+            try:
+                self.client.streams.delete(_id)
+            except ToolkitAPIError:
+                continue
+            count += 1
+        return count
+
+    def _iterate(
+        self,
+        data_set_external_id: str | None = None,
+        space: str | None = None,
+        parent_ids: list[Hashable] | None = None,
+    ) -> Iterable[StreamResponse]:
+        if data_set_external_id or space or parent_ids:
+            # These filters are not supported for Streams
+            return iter([])
+
+        all_streams = self.client.streams.list()
+        return iter(all_streams)

{cognite_toolkit-0.6.104 → cognite_toolkit-0.6.105}/cognite_toolkit/_cdf_tk/resource_classes/__init__.py

@@ -41,6 +41,7 @@ from .securitycategories import SecurityCategoriesYAML
 from .sequence import SequenceRowYAML, SequenceYAML
 from .space import SpaceYAML
 from .streamlit_ import StreamlitYAML
+from .streams import StreamYAML
 from .threedmodels import ThreeDModelYAML
 from .timeseries import TimeSeriesYAML
 from .transformation_notification import TransformationNotificationYAML
@@ -92,6 +93,7 @@ __all__ = [
     "SequenceRowYAML",
     "SequenceYAML",
     "SpaceYAML",
+    "StreamYAML",
     "StreamlitYAML",
     "TableYAML",
     "ThreeDModelYAML",

{cognite_toolkit-0.6.104 → cognite_toolkit-0.6.105}/cognite_toolkit/_repo_files/GitHub/.github/workflows/deploy.yaml

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

{cognite_toolkit-0.6.104 → cognite_toolkit-0.6.105}/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.104
+      image: cognite/toolkit:0.6.105
       env:
         CDF_CLUSTER: ${{ vars.CDF_CLUSTER }}
         CDF_PROJECT: ${{ vars.CDF_PROJECT }}

{cognite_toolkit-0.6.104 → cognite_toolkit-0.6.105}/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.104"
+version = "0.6.105"
 
 [alpha_flags]
 external-libraries = true

cognite_toolkit-0.6.105/cognite_toolkit/_version.py

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

cognite_toolkit-0.6.105/last_changelog_entry.md

@@ -0,0 +1,9 @@
+## cdf 
+
+### Added
+
+- [alpha] support for `Streams` resources in `build/deploy`.
+
+## templates
+
+No changes.

cognite_toolkit-0.6.105/last_git_message.txt

@@ -0,0 +1,22 @@
+[CDF-26213] 🪡 Streams CRUD (#2210)
+
+# Description
+
+This PR implements the Stream CRUD and support for new resource
+`Streams` in toolkit. The implementation follows pattern similar to
+`Infield V1 CDM CRUD` without using `cognite-sdk`.
+
+## Changelog
+
+- [x] Patch
+- [ ] Skip
+
+## cdf
+
+### Added
+
+- [alpha] support for `Streams` resources in `build/deploy`.
+
+## templates
+
+No changes.

cognite_toolkit-0.6.105/last_version.txt

@@ -0,0 +1 @@
+0.6.104

{cognite_toolkit-0.6.104 → cognite_toolkit-0.6.105}/pyproject.toml

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

{cognite_toolkit-0.6.104 → cognite_toolkit-0.6.105}/tests/test_unit/approval_client/client.py

@@ -66,8 +66,9 @@ from cognite_toolkit._cdf_tk.client import ToolkitClient, ToolkitClientConfig
 from cognite_toolkit._cdf_tk.client.data_classes.graphql_data_models import GraphQLDataModelWrite
 from cognite_toolkit._cdf_tk.client.data_classes.project import ProjectStatus, ProjectStatusList
 from cognite_toolkit._cdf_tk.client.data_classes.raw import RawDatabase
+from cognite_toolkit._cdf_tk.client.data_classes.streams import StreamResponse, StreamResponseList
 from cognite_toolkit._cdf_tk.client.testing import ToolkitClientMock
-from cognite_toolkit._cdf_tk.constants import INDEX_PATTERN
+from cognite_toolkit._cdf_tk.constants import INDEX_PATTERN, STREAM_IMMUTABLE_TEMPLATE_NAME
 from cognite_toolkit._cdf_tk.cruds import FileCRUD
 from cognite_toolkit._cdf_tk.utils import calculate_hash
 from cognite_toolkit._cdf_tk.utils.auth import CLIENT_NAME
@@ -426,6 +427,21 @@ class ApprovalToolkitClient:
                 # Groups needs special handling to convert the write to read
                 # to account for Unknown ACLs.
                 return resource_list_cls(_group_write_to_read(c) for c in created)
+            if resource_cls is StreamResponse:
+                return StreamResponseList.load(
+                    [
+                        {
+                            "externalId": c.external_id,
+                            "createdTime": 0,
+                            "createdFromTemplate": c.settings["template"]["name"],
+                            "type": "Immutable"
+                            if c.settings["template"]["name"] in STREAM_IMMUTABLE_TEMPLATE_NAME
+                            else "Mutable",
+                        }
+                        for c in created
+                    ],
+                    cognite_client=client,
+                )
 
             read_list = resource_list_cls.load(
                 [

{cognite_toolkit-0.6.104 → cognite_toolkit-0.6.105}/tests/test_unit/approval_client/config.py

@@ -176,6 +176,12 @@ from cognite_toolkit._cdf_tk.client.data_classes.search_config import (
     SearchConfigWrite,
     SearchConfigWriteList,
 )
+from cognite_toolkit._cdf_tk.client.data_classes.streams import (
+    StreamRequest,
+    StreamRequestList,
+    StreamResponse,
+    StreamResponseList,
+)
 
 from .data_classes import APIResource, Method
 
@@ -849,4 +855,19 @@ API_RESOURCES = [
             ],
         },
     ),
+    APIResource(
+        api_name="streams",
+        resource_cls=StreamResponse,
+        list_cls=StreamResponseList,
+        _write_cls=StreamRequest,
+        _write_list_cls=StreamRequestList,
+        methods={
+            "create": [Method(api_class_method="create", mock_class_method="create_multiple")],
+            "retrieve": [
+                Method(api_class_method="list", mock_class_method="return_values"),
+                Method(api_class_method="retrieve", mock_class_method="return_value"),
+            ],
+            "delete": [Method(api_class_method="delete", mock_class_method="delete_id_external_id")],
+        },
+    ),
 ]

{cognite_toolkit-0.6.104 → cognite_toolkit-0.6.105}/tests/test_unit/test_cdf_tk/test_cruds/test_base.py

@@ -229,6 +229,8 @@ def test_resource_types_is_up_to_date() -> None:
         extra.discard("cdf_applications")
     if not FeatureFlag.is_enabled(Flags.MIGRATE):
         extra.discard("migration")
+    if not FeatureFlag.is_enabled(Flags.STREAMS):
+        extra.discard("streams")
 
     assert not missing, f"Missing {missing=}"
     assert not extra, f"Extra {extra=}"

{cognite_toolkit-0.6.104 → cognite_toolkit-0.6.105}/tests/test_unit/test_cdf_tk/test_resource_classes/test_streams.py

@@ -3,9 +3,12 @@ from pathlib import Path
 
 import pytest
 
+from cognite_toolkit._cdf_tk.constants import MODULES
 from cognite_toolkit._cdf_tk.resource_classes.streams import StreamYAML
 from cognite_toolkit._cdf_tk.tk_warnings.fileread import ResourceFormatWarning
 from cognite_toolkit._cdf_tk.validation import validate_resource_yaml_pydantic
+from tests.data import COMPLETE_ORG_ALPHA_FLAGS
+from tests.test_unit.utils import find_resources
 
 
 def invalid_stream_test_cases() -> Iterable:
@@ -97,3 +100,8 @@ class TestStreamYAML:
         assert isinstance(format_warning, ResourceFormatWarning)
 
         assert set(format_warning.errors) == expected_errors
+
+    @pytest.mark.parametrize("data", list(find_resources("Streams", base=COMPLETE_ORG_ALPHA_FLAGS / MODULES)))
+    def test_load_valid_stream(self, data: dict[str, object]) -> None:
+        loaded = StreamYAML.model_validate(data)
+        assert loaded.model_dump(exclude_unset=True, by_alias=True) == data

{cognite_toolkit-0.6.104 → cognite_toolkit-0.6.105}/tests/test_unit/test_cli/test_build_deploy_snapshots/complete_org_alpha_flags.yaml

@@ -274,3 +274,8 @@ SearchConfig:
 Space:
 - space: sp_instance
 - space: sp_schema
+StreamResponse:
+- externalId: my-stream
+  settings:
+    template:
+      name: ImmutableTestStream

{cognite_toolkit-0.6.104 → cognite_toolkit-0.6.105}/uv.lock

@@ -272,7 +272,7 @@ wheels = [
 
 [[package]]
 name = "cognite-toolkit"
-version = "0.6.104"
+version = "0.6.105"
 source = { editable = "." }
 dependencies = [
     { name = "cognite-sdk" },

cognite_toolkit-0.6.104/cognite_toolkit/_version.py

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

cognite_toolkit-0.6.104/last_changelog_entry.md

@@ -1,9 +0,0 @@
-## cdf 
-
-### Added
-
-- [alpha] `cdf data upload <directory>` can now upload charts.
-
-## templates
-
-No changes.

cognite_toolkit-0.6.104/last_git_message.txt

@@ -1,20 +0,0 @@
-[CDF-24844] 📉 Upload charts (#2211)
-
-# Description
-
-Minor adjustments were necessary to upload charts.
-
-## Changelog
-
-- [x] Patch
-- [ ] Skip
-
-## cdf
-
-### Added
-
-- [alpha] `cdf data upload <directory>` can now upload charts.
-
-## templates
-
-No changes.

cognite_toolkit-0.6.104/last_version.txt

@@ -1 +0,0 @@
-0.6.103