feat: verifying backwards compatibility (#2124)

Co-authored-by: pyansys-ci-bot <[email protected]>
Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>

Author: 3 people

.github/workflows/backwards_compatibility.yml

@@ -0,0 +1,131 @@
+name: Backwards compatibility tests
+on:
+  pull_request:
+  workflow_dispatch:
+  push:
+    tags:
+      - "*"
+    branches:
+      - main
+
+env:
+  MAIN_PYTHON_VERSION: '3.13'
+  ANSRV_GEO_IMAGE: 'ghcr.io/ansys/geometry'
+  ANSRV_GEO_PORT: 700
+  ANSRV_GEO_LICENSE_SERVER: ${{ secrets.LICENSE_SERVER }}
+  GEO_CONT_NAME: ans_geo
+  IS_WORKFLOW_RUNNING: True
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+  packages: read
+  id-token: write
+
+jobs:
+
+  # =================================================================================================
+  # vvvvvvvvvvvvvvvvvvvvvvvvvvvvvv    RUNNING ON SELF-HOSTED RUNNER    vvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
+  # =================================================================================================
+
+  testing-backwards-compatibility-windows:
+    name: Windows ${{ matrix.backend-version }}
+    runs-on: [self-hosted, Windows, pygeometry]
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - image-tag: "windows-24.1"
+            backend-version: "24.1"
+          - image-tag: "windows-24.2"
+            backend-version: "24.2"
+          - image-tag: "windows-25.1"
+            backend-version: "25.1"
+          - image-tag: "core-windows-25.2"
+            backend-version: "25.2"
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+
+      - name: Set up Python
+        uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
+        with:
+          python-version: ${{ env.MAIN_PYTHON_VERSION }}
+
+      - name: Set up headless display
+        uses: pyvista/setup-headless-display-action@7d84ae825e6d9297a8e99bdbbae20d1b919a0b19 # v4.2
+
+      - name: Create Python venv
+        run: |
+          python -m venv .venv
+          .\.venv\Scripts\Activate.ps1
+
+      - name: Install packages for testing
+        run: |
+          .\.venv\Scripts\Activate.ps1
+          python -m pip install --upgrade pip
+          pip install --upgrade build wheel
+          pip install .[tests]
+
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@74a5d142397b4f367a81961eba4e8cd7edddf772 # v3.4.0
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Download Geometry service container (if needed)
+        run: docker pull ${{ env.ANSRV_GEO_IMAGE }}:${{ matrix.image-tag }}
+
+      - name: Check location of self-hosted runner and define license server accordingly
+        if: runner.name == 'pygeometry-ci-2'
+        run:
+          echo "ANSRV_GEO_LICENSE_SERVER=${{ secrets.INTERNAL_LICENSE_SERVER }}" | Out-File -FilePath $env:GITHUB_ENV -Append
+
+      - name: Stop any running containers
+        run: |
+          $dockerContainers = docker ps -a -q
+          if (-not [string]::IsNullOrEmpty($dockerContainers)) {
+              docker stop $dockerContainers
+              docker rm $dockerContainers
+          }
+
+      - name: Start Geometry service and verify start
+        run: |
+          .\.venv\Scripts\Activate.ps1
+          docker run --detach --name ${{ env.GEO_CONT_NAME }} -e LICENSE_SERVER=${{ env.ANSRV_GEO_LICENSE_SERVER }} -p ${{ env.ANSRV_GEO_PORT }}:50051 ${{ env.ANSRV_GEO_IMAGE }}:${{ matrix.image-tag }}
+          python -c "from ansys.geometry.core.connection.validate import validate; validate()"
+
+      - name: Testing
+        run: |
+          .\.venv\Scripts\Activate.ps1
+          pytest -v --backwards-compatibility=yes --backend-version=${{ matrix.backend-version }} -rf
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@18283e04ce6e62d37312384ff67231eb8fd56d24 # v5.4.3
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+        with:
+          files: .cov/xml
+
+      - name: Stop the Geometry service
+        if: always()
+        run: |
+          docker stop ${{ env.GEO_CONT_NAME }}
+          docker logs ${{ env.GEO_CONT_NAME }}
+          docker rm ${{ env.GEO_CONT_NAME }}
+
+      - name: Stop any remaining containers
+        if: always()
+        run: |
+          $dockerContainers = docker ps -a -q
+          if (-not [string]::IsNullOrEmpty($dockerContainers)) {
+              docker stop $dockerContainers
+              docker rm $dockerContainers
+          }
+
+# =================================================================================================
+# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^    RUNNING ON SELF-HOSTED RUNNER    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+# =================================================================================================

.github/workflows/ci_cd.yml

@@ -320,6 +320,10 @@ jobs:
               docker rm $dockerContainers
           }
 
+# =================================================================================================
+# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^    RUNNING ON SELF-HOSTED RUNNER    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+# =================================================================================================
+
   docs:
     name: Documentation
     needs: [docs-style]
@@ -356,11 +360,6 @@ jobs:
           docker logs ${{ env.GEO_CONT_NAME }}
           docker rm ${{ env.GEO_CONT_NAME }}
 
-
-# =================================================================================================
-# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^    RUNNING ON SELF-HOSTED RUNNER    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-# =================================================================================================
-
   testing-linux:
     name: Testing and coverage (Linux)
     needs: [smoke-tests, manifests]

doc/changelog.d/2124.added.md

@@ -0,0 +1 @@
+Verifying backwards compatibility

pyproject.toml

@@ -73,6 +73,7 @@ tests = [
     "pytest-cov==6.2.1",
     "pytest-pyvista==0.2.0",
     "pyvista[jupyter]==0.45.3",
+    "pyyaml==6.0.2",
     "requests==2.32.4",
     "scipy==1.15.3",
     "semver==3.0.4",
@@ -83,6 +84,7 @@ tests-minimal = [
     "pytest==8.4.1",
     "pytest-cov==6.2.1",
     "pytest-pyvista==0.2.0",
+    "pyyaml==6.0.2",
 ]
 doc = [
     "ansys-sphinx-theme[autoapi]==1.5.3",

src/ansys/geometry/core/_grpc/_services/v0/bodies.py

@@ -30,6 +30,7 @@
 from ..base.bodies import GRPCBodyService
 from ..base.conversions import from_measurement_to_server_angle, from_measurement_to_server_length
 from .conversions import (
+    _nurbs_curves_compatibility,
     build_grpc_id,
     from_frame_to_grpc_frame,
     from_grpc_material_to_material,
@@ -102,6 +103,10 @@ def create_extruded_body(self, **kwargs) -> dict:  # noqa: D102
             ),
         )
 
+        # HACK: we should inform the user that NURBS curve sketches are not supported
+        # prior to 26R1... and if passed, raise an error
+        _nurbs_curves_compatibility(kwargs["backend_version"], request.geometries)
+
         # Call the gRPC service
         resp = self.stub.CreateExtrudedBody(request=request)
 
@@ -128,6 +133,10 @@ def create_sweeping_profile_body(self, **kwargs) -> dict:  # noqa: D102
             path=[from_trimmed_curve_to_grpc_trimmed_curve(tc) for tc in kwargs["path"]],
         )
 
+        # HACK: we should inform the user that NURBS curve sketches are not supported
+        # prior to 26R1... and if passed, raise an error
+        _nurbs_curves_compatibility(kwargs["backend_version"], request.geometries)
+
         # Call the gRPC service
         resp = self.stub.CreateSweepingProfile(request=request)
 
@@ -229,6 +238,10 @@ def create_planar_body(self, **kwargs) -> dict:  # noqa: D102
             ),
         )
 
+        # HACK: we should inform the user that NURBS curve sketches are not supported
+        # prior to 26R1... and if passed, raise an error
+        _nurbs_curves_compatibility(kwargs["backend_version"], request.geometries)
+
         # Call the gRPC service
         resp = self.stub.CreatePlanarBody(request=request)
 

src/ansys/geometry/core/_grpc/_services/v0/conversions.py

@@ -55,10 +55,12 @@
     TrimmedCurve as GRPCTrimmedCurve,
     TrimmedSurface as GRPCTrimmedSurface,
 )
+from ansys.geometry.core.errors import GeometryRuntimeError
 from ansys.geometry.core.misc.checks import graphics_required
 
 if TYPE_CHECKING:  # pragma: no cover
     import pyvista as pv
+    import semver
 
     from ansys.geometry.core.connection.backend import BackendType
     from ansys.geometry.core.designer.design import DesignFileFormat
@@ -1136,3 +1138,26 @@ def from_material_to_grpc_material(
             for property in material.properties.values()
         ],
     )
+
+
+def _nurbs_curves_compatibility(backend_version: "semver.Version", grpc_geometries: GRPCGeometries):
+    """Check if the backend version is compatible with NURBS curves in sketches.
+
+    Parameters
+    ----------
+    backend_version : semver.Version
+        The version of the backend.
+    grpc_geometries : GRPCGeometries
+        The gRPC geometries potentially containing NURBS curves.
+
+    Raises
+    ------
+    GeometryRuntimeError
+        If the backend version is lower than 26.1.0 and NURBS curves are present.
+    """
+    if grpc_geometries.nurbs_curves and backend_version < (26, 1, 0):
+        raise GeometryRuntimeError(
+            "The usage of NURBS in sketches requires a minimum Ansys release version of "  # noqa: E501
+            + "26.1.0, but the current version used is "
+            + f"{backend_version}."
+        )

src/ansys/geometry/core/_grpc/_services/v0/measurement_tools.py

@@ -56,15 +56,19 @@ def min_distance_between_objects(self, **kwargs) -> dict:  # noqa: D102
         # Request is different based on backend_version (25.2 vs. earlier)
         if kwargs["backend_version"] < (25, 2, 0):
             request = MinDistanceBetweenObjectsRequest(bodies=kwargs["selection"])
+
+            # Call the gRPC service
+            response = self.stub.MinDistanceBetweenObjects(request)
+
         else:
             from ansys.api.dbu.v0.dbumodels_pb2 import EntityIdentifier
 
             request = MinDistanceBetweenObjectsRequest(
                 selection=[EntityIdentifier(id=item) for item in kwargs["selection"]]
             )
 
-        # Call the gRPC service
-        response = self.stub.MinDistanceBetweenSelectionObjects(request)
+            # Call the gRPC service
+            response = self.stub.MinDistanceBetweenSelectionObjects(request)
 
         # Return the response - formatted as a dictionary
         return {"distance": to_distance(response.gap.distance)}

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

@@ -299,8 +299,14 @@ def set_name(self, name: str) -> None:
         self._name = name
 
     @property
+    @min_backend_version(25, 1, 0)
     def instance_name(self) -> str:
-        """Name of the component instance."""
+        """Name of the component instance.
+
+        Warnings
+        --------
+        This method is only available starting on Ansys release 25R1.
+        """
         return self._instance_name
 
     @property
@@ -597,6 +603,7 @@ def extrude_sketch(
             sketch=sketch,
             distance=distance,
             direction=direction.get_multiplier(),
+            backend_version=self._grpc_client.backend_version,
         )
         created_body = self.__build_body_from_response(response)
 
@@ -656,6 +663,7 @@ def sweep_sketch(
             parent_id=self.id,
             sketch=sketch,
             path=path,
+            backend_version=self._grpc_client.backend_version,
         )
         return self.__build_body_from_response(response)
 
@@ -811,7 +819,7 @@ def extrude_face(
 
     @check_input_types
     @ensure_design_is_active
-    @min_backend_version(24, 2, 0)
+    @min_backend_version(25, 1, 0)
     def create_sphere(self, name: str, center: Point3D, radius: Distance) -> Body:
         """Create a sphere body defined by the center point and the radius.
 
@@ -831,7 +839,7 @@ def create_sphere(self, name: str, center: Point3D, radius: Distance) -> Body:
 
         Warnings
         --------
-        This method is only available starting on Ansys release 24R2.
+        This method is only available starting on Ansys release 25R1.
         """
         self._grpc_client.log.debug(f"Creating a sphere body on {self.id}.")
         response = self._grpc_client.services.bodies.create_sphere_body(
@@ -925,7 +933,10 @@ def create_surface(self, name: str, sketch: Sketch) -> Body:
             f"Creating planar surface from sketch provided on {self.id}. Creating body..."
         )
         response = self._grpc_client.services.bodies.create_planar_body(
-            name=name, parent_id=self.id, sketch=sketch
+            name=name,
+            parent_id=self.id,
+            sketch=sketch,
+            backend_version=self._grpc_client.backend_version,
         )
 
         return self.__build_body_from_response(response)

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

@@ -1126,7 +1126,9 @@ def __read_existing_design(self) -> None:
                 mp = MaterialProperty(mp_type, property.display_name, mp_quantity)
                 properties.append(mp)
                 if mp.type == MaterialPropertyType.DENSITY:
-                    density = mp.quantity
+                    density = (
+                        mp.quantity if isinstance(mp.quantity, Quantity) else Quantity(mp.quantity)
+                    )
 
             m = Material(material.name, density, properties)
             self.materials.append(m)

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

@@ -585,6 +585,8 @@ def rename_object(
         )
         return result.success
 
+    @protect_grpc
+    @min_backend_version(25, 2, 0)
     def create_linear_pattern(
         self,
         selection: Union["Face", list["Face"]],
@@ -618,6 +620,10 @@ def create_linear_pattern(
         -------
         bool
             ``True`` when successful, ``False`` when failed.
+
+        Warnings
+        --------
+        This method is only available starting on Ansys release 25R2.
         """
         from ansys.geometry.core.designer.face import Face
 
@@ -1173,6 +1179,8 @@ def revolve_faces_by_helix(
             self._grpc_client.log.info("Failed to revolve faces.")
             return []
 
+    @protect_grpc
+    @min_backend_version(25, 2, 0)
     def replace_face(
         self,
         target_selection: Union["Face", list["Face"]],
@@ -1191,6 +1199,10 @@ def replace_face(
         -------
         bool
             ``True`` when successful, ``False`` when failed.
+
+        Warnings
+        --------
+        This method is only available starting on Ansys release 25R2.
         """
         target_selection: list["Face"] = (
             target_selection if isinstance(target_selection, list) else [target_selection]