feat: inserting document into existing design (#930)

Co-authored-by: pyansys-ci-bot <pyansys.github.bot@ansys.com>
Co-authored-by: m-bini <matteo.bini@ansys.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: 4 people

doc/changelog.d/930.added.md

@@ -0,0 +1 @@
+feat: inserting document into existing design

src/ansys/geometry/core/designer/design.py

@@ -25,7 +25,7 @@
 from pathlib import Path
 
 from ansys.api.dbu.v0.dbumodels_pb2 import EntityIdentifier, PartExportFormat
-from ansys.api.dbu.v0.designs_pb2 import NewRequest, SaveAsRequest
+from ansys.api.dbu.v0.designs_pb2 import InsertRequest, NewRequest, SaveAsRequest
 from ansys.api.dbu.v0.designs_pb2_grpc import DesignsStub
 from ansys.api.geometry.v0.commands_pb2 import (
     AssignMidSurfaceOffsetTypeRequest,
@@ -68,7 +68,7 @@
 from ansys.geometry.core.math.plane import Plane
 from ansys.geometry.core.math.point import Point3D
 from ansys.geometry.core.math.vector import UnitVector3D, Vector3D
-from ansys.geometry.core.misc.checks import ensure_design_is_active
+from ansys.geometry.core.misc.checks import ensure_design_is_active, min_backend_version
 from ansys.geometry.core.misc.measurements import DEFAULT_UNITS, Distance
 from ansys.geometry.core.modeler import Modeler
 from ansys.geometry.core.typing import RealSequence
@@ -581,6 +581,58 @@ def delete_beam_profile(self, beam_profile: Union[BeamProfile, str]) -> None:
                 + " Ignoring request."
             )
 
+    @protect_grpc
+    @check_input_types
+    @ensure_design_is_active
+    @min_backend_version(24, 2, 0)
+    def insert_file(self, file_location: Union[Path, str]) -> Component:
+        """
+        Insert a file into the design.
+
+        Parameters
+        ----------
+        file_location : Union[~pathlib.Path, str]
+            Location on disk where the file is located.
+
+        Returns
+        -------
+        Component
+            The newly inserted component.
+        """
+        # Upload the file to the server
+        filepath_server = self._modeler._upload_file(file_location)
+
+        # Insert the file into the design
+        self._design_stub.Insert(InsertRequest(filepath=filepath_server))
+        self._grpc_client.log.debug(f"File {file_location} successfully inserted into design.")
+
+        # Get a temporal design object to update the current one
+        tmp_design = Design("", self._modeler, read_existing_design=True)
+
+        # Update the reference to the design
+        for component in tmp_design.components:
+            component._parent_component = self
+
+        # Update the design's components - add the new one
+        #
+        # If the list is empty, add the components from the new design
+        if not self._components:
+            self._components.extend(tmp_design.components)
+        else:
+            # Insert operation adds the inserted file as a component to the design.
+            for tmp_component in tmp_design.components:
+                # Otherwise, check which is the new component added
+                for component in self._components:
+                    if component.id == tmp_component.id:
+                        break
+                    # If not equal, add the component - since it has not been found
+                    self._components.append(tmp_component)
+
+        self._grpc_client.log.debug(f"Design {self.name} is successfully updated.")
+
+        # Return the newly inserted component
+        return self._components[-1]
+
     def __repr__(self) -> str:
         """Represent the ``Design`` as a string."""
         alive_bodies = [1 if body.is_alive else 0 for body in self.bodies]

tests/integration/__init__.py

@@ -0,0 +1,21 @@
+# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.

tests/integration/conftest.py

@@ -43,6 +43,15 @@
 pv.OFF_SCREEN = True
 
 
+# TODO: re-enable when Linux service is able to use measurement tools
+def skip_if_linux(modeler: Modeler, test_name: str, element_not_available: str):
+    """Skip test if running on Linux."""
+    if modeler.client.backend_type == BackendType.LINUX_SERVICE:
+        pytest.skip(
+            f"Skipping '{test_name}'. '{element_not_available}' not available on Linux service."
+        )  # skip!
+
+
 @pytest.fixture(scope="session")
 def docker_instance(use_existing_service):
     # This will only have a value in case that:

tests/integration/test_design.py

@@ -60,12 +60,7 @@
 from ansys.geometry.core.shapes.parameterization import Interval, ParamUV
 from ansys.geometry.core.sketch import Sketch
 
-
-# TODO: re-enable when Linux service is able to use measurement tools
-def skip_if_linux(modeler: Modeler):
-    """Skip test if running on Linux."""
-    if modeler.client.backend_type == BackendType.LINUX_SERVICE:
-        pytest.skip("Measurement tools not available on Linux service.")
+from .conftest import skip_if_linux
 
 
 def test_design_extrusion_and_material_assignment(modeler: Modeler):
@@ -1932,7 +1927,7 @@ def test_get_active_design(modeler: Modeler):
 
 def test_get_collision(modeler: Modeler):
     """Test the collision state between two bodies."""
-    skip_if_linux(modeler)  # Skip test on Linux
+    skip_if_linux(modeler, test_get_collision.__name__, "get_collision")  # Skip test on Linux
     design = modeler.open_file("./tests/integration/files/MixingTank.scdocx")
     body1 = design.bodies[0]
     body2 = design.bodies[1]
@@ -1959,7 +1954,7 @@ def test_body_scale(modeler: Modeler):
 
 def test_body_mapping(modeler: Modeler):
     """Verify the correct mapping of a body."""
-    skip_if_linux(modeler)
+    skip_if_linux(modeler, test_body_mapping.__name__, "map")
     design = modeler.create_design("BodyMap_Test")
 
     # non-symmetric shape to allow determination of mirroring
@@ -2052,7 +2047,7 @@ def test_body_mapping(modeler: Modeler):
 
 def test_sphere_creation(modeler: Modeler):
     """Test the creation of a sphere body with a given radius."""
-    skip_if_linux(modeler)
+    skip_if_linux(modeler, test_sphere_creation.__name__, "create_sphere")
     design = modeler.create_design("Spheretest")
     center_point = Point3D([10, 10, 10], UNITS.m)
     radius = Distance(1, UNITS.m)
@@ -2064,7 +2059,7 @@ def test_sphere_creation(modeler: Modeler):
 
 def test_body_mirror(modeler: Modeler):
     """Test the mirroring of a body."""
-    skip_if_linux(modeler)
+    skip_if_linux(modeler, test_body_mirror.__name__, "mirror")
     design = modeler.create_design("Design1")
 
     # Create shape with no lines of symmetry in any axis
@@ -2183,7 +2178,7 @@ def test_body_mirror(modeler: Modeler):
 def test_sweep_sketch(modeler: Modeler):
     """Test revolving a circle profile around a circular axis to make a donut."""
 
-    skip_if_linux(modeler)
+    skip_if_linux(modeler, test_sweep_sketch.__name__, "sweep_sketch")
     design_sketch = modeler.create_design("donut")
 
     path_radius = 5
@@ -2221,7 +2216,7 @@ def test_sweep_chain(modeler: Modeler):
     """Test revolving a semi-elliptical profile around a circular axis to make a
     bowl."""
 
-    skip_if_linux(modeler)
+    skip_if_linux(modeler, test_sweep_chain.__name__, "sweep_chain")
     design_chain = modeler.create_design("bowl")
 
     radius = 10
@@ -2269,7 +2264,9 @@ def test_sweep_chain(modeler: Modeler):
 
 def test_create_body_from_loft_profile(modeler: Modeler):
     """Test the ``create_body_from_loft_profile()`` method to create a vase shape."""
-    skip_if_linux(modeler)
+    skip_if_linux(
+        modeler, test_create_body_from_loft_profile.__name__, "'create_body_from_loft_profile'"
+    )
     design_sketch = modeler.create_design("loftprofile")
 
     profile1 = Circle(origin=[0, 0, 0], radius=8).trim(Interval(0, 2 * np.pi))

tests/integration/test_design_import.py

@@ -33,6 +33,8 @@
 from ansys.geometry.core.misc import UNITS
 from ansys.geometry.core.sketch import Sketch
 
+from .conftest import skip_if_linux
+
 
 def _checker_method(comp: Component, comp_ref: Component, precise_check: bool = True) -> None:
     # Check component features
@@ -130,18 +132,19 @@ def test_design_import_with_surfaces_issue834(modeler: Modeler):
     For more info see https://github.com/ansys/pyansys-geometry/issues/834
     """
     # TODO: to be reactivated by https://github.com/ansys/pyansys-geometry/issues/799
-    if modeler.client.backend_type != BackendType.LINUX_SERVICE:
-        # Open the design
-        design = modeler.open_file("./tests/integration/files/DuplicateFacesDesignBefore.scdocx")
+    skip_if_linux(modeler, test_design_import_with_surfaces_issue834.__name__, "open_file")
+
+    # Open the design
+    design = modeler.open_file("./tests/integration/files/DuplicateFacesDesignBefore.scdocx")
 
-        # Check that there are two bodies
-        assert len(design.bodies) == 2
+    # Check that there are two bodies
+    assert len(design.bodies) == 2
 
-        # Check some basic properties - whether they are surfaces or not!
-        assert design.bodies[0].name == "BoxBody"
-        assert design.bodies[0].is_surface == False
-        assert design.bodies[1].name == "DuplicatesSurface"
-        assert design.bodies[1].is_surface == True
+    # Check some basic properties - whether they are surfaces or not!
+    assert design.bodies[0].name == "BoxBody"
+    assert design.bodies[0].is_surface == False
+    assert design.bodies[1].name == "DuplicatesSurface"
+    assert design.bodies[1].is_surface == True
 
 
 @pytest.mark.skip(reason="Get the OpenSSL GeometryService through before fixing hoops")
@@ -240,3 +243,48 @@ def test_open_file(modeler: Modeler, tmp_path_factory: pytest.TempPathFactory):
         # .prt
         design2 = modeler.open_file("./tests/integration/files/import/disk1.prt")
         assert len(design2.bodies) == 1
+
+
+def test_design_insert(modeler: Modeler):
+    """Test inserting a file into the design."""
+
+    # Skip for Linux service
+    skip_if_linux(modeler, test_design_insert.__name__, "insert_file")
+
+    # Create a design and sketch a circle
+    design = modeler.create_design("Insert")
+    sketch = Sketch()
+    sketch.circle(Point2D([0, 0]), 10)
+    comp = design.add_component("Component_Cylinder")
+    comp.extrude_sketch("Body_Cylinder", sketch, 5)
+
+    # Insert a different file
+    design.insert_file("./tests/integration/files/DuplicateFacesDesignBefore.scdocx")
+
+    # Check that there are two components
+    assert len(design.components) == 2
+    assert design.components[0].name == "Component_Cylinder"
+    assert design.components[1].name == "DuplicatesDesign"
+
+
+def test_design_insert_with_import(modeler: Modeler):
+    """Test inserting a file into the design through the external format import
+    process."""
+
+    # Skip for Linux service
+    skip_if_linux(modeler, test_design_insert_with_import.__name__, "insert_file")
+
+    # Create a design and sketch a circle
+    design = modeler.create_design("Insert")
+    sketch = Sketch()
+    sketch.circle(Point2D([0, 0]), 10)
+    comp = design.add_component("Component_Cylinder")
+    comp.extrude_sketch("Body_Cylinder", sketch, 5)
+
+    # Import and insert a different file
+    design.insert_file("./tests/integration/files/import/catia_car/Wheel1.CATPart")
+
+    # Check that there are two components
+    assert len(design.components) == 2
+    assert design.components[0].name == "Component_Cylinder"
+    assert design.components[1].name == "Wheel1"

tests/integration/test_measurement_tools.py

@@ -21,19 +21,11 @@
 # SOFTWARE.
 """"Testing of measurement tools."""
 
-import pytest
-
-from ansys.geometry.core.connection.backend import BackendType
 from ansys.geometry.core.misc.measurements import Distance
 from ansys.geometry.core.modeler import Modeler
 from ansys.geometry.core.tools.measurement_tools import Gap
 
-
-# TODO: re-enable when Linux service is able to use measurement tools
-def skip_if_linux(modeler: Modeler):
-    """Skip test if running on Linux."""
-    if modeler.client.backend_type == BackendType.LINUX_SERVICE:
-        pytest.skip("Measurement tools not available on Linux service.")
+from .conftest import skip_if_linux
 
 
 def test_distance_property(modeler: Modeler):
@@ -44,7 +36,9 @@ def test_distance_property(modeler: Modeler):
 
 def test_min_distance_between_objects(modeler: Modeler):
     """Test if split edge problem areas are detectable."""
-    skip_if_linux(modeler)  # Skip test on Linux
+    skip_if_linux(
+        modeler, test_min_distance_between_objects.__name__, "measurement_tools"
+    )  # Skip test on Linux
     design = modeler.open_file("./tests/integration/files/MixingTank.scdocx")
     gap = modeler.measurement_tools.min_distance_between_objects(design.bodies[2], design.bodies[1])
     assert abs(gap.distance._value - 0.0892) <= 0.01