[prep CDF-24982] 🎪Duplicate canvas

cognite_toolkit/_cdf_tk/client/data_classes/canvas.py

@@ -1,5 +1,6 @@
 from collections.abc import Sequence
 from datetime import datetime
+from uuid import uuid4
 
 from cognite.client.data_classes.data_modeling import DirectRelationReference, filters, query
 from cognite.client.data_classes.data_modeling.ids import EdgeId, NodeId, ViewId
@@ -825,10 +826,9 @@ def as_instance_ids(self, include_solution_tags: bool = False) -> list[NodeId |
         instances = self.as_instances()
         ids: list[NodeId | EdgeId] = []
         for instance in instances:
-            if isinstance(instance, NodeApply) and (
-                include_solution_tags or not isinstance(instance, CogniteSolutionTagApply)
-            ):
-                ids.append(NodeId(instance.space, instance.external_id))
+            if isinstance(instance, NodeApply):
+                if include_solution_tags or not isinstance(instance, CogniteSolutionTagApply):
+                    ids.append(NodeId(instance.space, instance.external_id))
             elif isinstance(instance, EdgeApply):
                 ids.append(EdgeId(instance.space, instance.external_id))
             else:
@@ -858,6 +858,32 @@ def dump(self, exclude_existing_version: bool = False) -> dict[str, object]:
                     del value["existingVersion"]
         return output
 
+    def duplicate(self) -> "IndustrialCanvasApply":
+        """Create a duplicate of the IndustrialCanvasApply instance."""
+        new_canvas_id = str(uuid4())
+        new_canvas = CanvasApply._load(self.canvas.dump())
+        new_canvas.external_id = new_canvas_id
+        # Solution tags are not duplicated, they are reused
+        new_container = IndustrialCanvasApply(new_canvas, [], [], [], solution_tags=self.solution_tags)
+        items: list[ContainerReferenceApply] | list[CanvasAnnotationApply] | list[FdmInstanceContainerReferenceApply]
+        item_cls: type[CanvasAnnotationApply] | type[ContainerReferenceApply] | type[FdmInstanceContainerReferenceApply]
+        new_item_list: list[NodeApply]
+        for items, item_cls, new_item_list in [  # type: ignore[assignment]
+            (self.annotations, CanvasAnnotationApply, new_container.annotations),
+            (self.container_references, ContainerReferenceApply, new_container.container_references),
+            (
+                self.fdm_instance_container_references,
+                FdmInstanceContainerReferenceApply,
+                new_container.fdm_instance_container_references,
+            ),
+        ]:
+            for item in items:
+                new_item = item_cls._load(item.dump())
+                new_item.id_ = str(uuid4())
+                new_item.external_id = f"{new_canvas_id}_{new_item.external_id}"
+                new_item_list.append(new_item)
+        return new_container
+
 
 class IndustrialCanvas:
     """This class represents one instances of the Canvas with all connected data."""

tests/test_unit/test_cdf_tk/test_client/test_canvas.py

@@ -19,6 +19,7 @@
     ContainerReferenceApply,
     FdmInstanceContainerReference,
     FdmInstanceContainerReferenceApply,
+    IndustrialCanvasApply,
 )
 from tests.test_unit.utils import FakeCogniteResourceGenerator
 
@@ -46,6 +47,22 @@ def test_dump_reload(self, node_cls: type[CogniteResource]) -> None:
 
         assert reloaded == instance, f"Expected: {instance}, but got: {reloaded}"
 
+    def test_duplicate_industrial(self) -> None:
+        instance = FakeCogniteResourceGenerator().create_instance(IndustrialCanvasApply)
+
+        duplicated = instance.duplicate()
+
+        original_ids = set(instance.as_instance_ids(include_solution_tags=False))
+        duplicated_ids = set(duplicated.as_instance_ids(include_solution_tags=False))
+        overlapping_ids = original_ids.intersection(duplicated_ids)
+        assert not overlapping_ids
+
+        original_ids = set(instance.as_instance_ids(include_solution_tags=True))
+        duplicated_ids = set(duplicated.as_instance_ids(include_solution_tags=True))
+        overlapping_ids = original_ids.intersection(duplicated_ids)
+        solution_tags_ids = {tag.as_id() for tag in instance.solution_tags}
+        assert solution_tags_ids == overlapping_ids, "Expected original IDs to match solution tags IDs"
+
 
 @pytest.fixture()
 def instance_api() -> MagicMock: