CI performance and improvements to export mech (#182)

RobPasMue · web-flow · commit 06ea1ee2e668 · 2022-10-20T10:08:10.000+02:00
diff --git a/.github/workflows/ci_cd.yml b/.github/workflows/ci_cd.yml
@@ -61,12 +61,60 @@ jobs:
           vale_flags: "--config=doc/.vale.ini"
 
   smoke-tests:
-    name: Build and Smoke tests
-    runs-on: ${{ matrix.os }}
+    name: Build and Smoke tests (Ubuntu only)
+    runs-on: ubuntu-latest
     needs: [style]
     strategy:
       matrix:
-        os: [windows-latest, ubuntu-latest, macos-latest]
+        python-version: ['3.7', '3.8', '3.9', '3.10']
+      fail-fast: false
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: 'pip'
+          cache-dependency-path: 'pyproject.toml'
+
+      - name: Install packages for building
+        run: |
+          pip install --upgrade build wheel
+          pip install .
+
+      - name: Smoke test
+        run: python -c "from ansys.geometry.core import __version__; print(__version__)"
+
+      - name: Store version
+        run: |
+          echo "PYGEOM_VERSION=$(python -c "from ansys.geometry.core import __version__; print(__version__)")" >> $GITHUB_ENV
+
+      - name: Generate wheelhouse
+        run: |
+          pip wheel . -w wheelhouse
+
+      - name: Zip wheelhouse
+        uses: vimtor/action-zip@v1
+        with:
+          files: wheelhouse
+          dest: ${{ env.PACKAGE_NAME }}-v${{ env.PYGEOM_VERSION }}-wheelhouse-${{ runner.os }}-${{ matrix.python-version }}.zip
+
+      - name: Upload Wheelhouse
+        uses: actions/upload-artifact@v3
+        with:
+          name: ${{ env.PACKAGE_NAME }}-v${{ env.PYGEOM_VERSION }}-wheelhouse-${{ runner.os }}-${{ matrix.python-version }}
+          path: '*.zip'
+          retention-days: 7
+
+  remaining-smoke-tests:
+    name: Build and Smoke tests (Windows, macOS)
+    runs-on: ${{ matrix.os }}
+    needs: [smoke-tests]
+    strategy:
+      matrix:
+        os: [windows-latest, macos-latest]
         python-version: ['3.7', '3.8', '3.9', '3.10']
       fail-fast: false
 
@@ -251,7 +299,7 @@ jobs:
 
   package:
     name: Package library
-    needs: [testing, docs]
+    needs: [testing, docs, remaining-smoke-tests]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
diff --git a/doc/source/_static/thumbnails/basic_usage.png b/doc/source/_static/thumbnails/basic_usage.png
diff --git a/doc/source/_static/thumbnails/dynamic_sketch_plane.png b/doc/source/_static/thumbnails/dynamic_sketch_plane.png
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -121,6 +121,7 @@
 }
 nbsphinx_thumbnails = {
     "examples/basic_usage": "_static/thumbnails/basic_usage.png",
+    "examples/dynamic_sketch_plane": "_static/thumbnails/dynamic_sketch_plane.png",
 }
 
 typehints_defaults = "comma"
diff --git a/src/ansys/geometry/core/designer/__init__.py b/src/ansys/geometry/core/designer/__init__.py
@@ -2,7 +2,7 @@
 
 from ansys.geometry.core.designer.body import Body
 from ansys.geometry.core.designer.component import Component, SharedTopologyType
-from ansys.geometry.core.designer.design import Design
+from ansys.geometry.core.designer.design import Design, DesignFileFormat
 from ansys.geometry.core.designer.edge import CurveType, Edge
 from ansys.geometry.core.designer.face import Face, SurfaceType
 from ansys.geometry.core.designer.selection import NamedSelection
@@ -12,6 +12,7 @@
     "Component",
     "CurveType",
     "Design",
+    "DesignFileFormat",
     "Edge",
     "Face",
     "NamedSelection",
diff --git a/src/ansys/geometry/core/designer/design.py b/src/ansys/geometry/core/designer/design.py
@@ -1,5 +1,6 @@
 """``Design`` class module."""
 
+from enum import Enum
 from pathlib import Path
 from typing import List, Optional, Union
 
@@ -30,6 +31,15 @@
 from ansys.geometry.core.misc import check_type
 
 
+class DesignFileFormat(Enum):
+    """Available file formats supported by the Design class for download."""
+
+    SCDOCX = "SCDOCX", None
+    PARASOLID_TEXT = "PARASOLID_TEXT", PartExportFormat.PARTEXPORTFORMAT_PARASOLID_TEXT
+    PARASOLID_BIN = "PARASOLID_BIN", PartExportFormat.PARTEXPORTFORMAT_PARASOLID_BINARY
+    INVALID = "INVALID", None
+
+
 class Design(Component):
     """
     Provides a ``Design`` for organizing geometry assemblies.
@@ -125,72 +135,62 @@ def save(self, file_location: Union[Path, str]) -> None:
         self._grpc_client.log.debug(f"Design successfully saved at location {file_location}.")
 
     @protect_grpc
-    def download(self, file_location: Union[Path, str], as_stream: Optional[bool] = False) -> None:
+    def download(
+        self,
+        file_location: Union[Path, str],
+        format: Optional[DesignFileFormat] = DesignFileFormat.SCDOCX,
+        as_stream: Optional[bool] = False,
+    ) -> None:
         """Downloads a design from the active geometry server instance.
 
         Parameters
         ----------
         file_location : Union[Path, str]
             Location on disk where the file should be saved.
-        as_stream : bool, Default: False
-            Boolean indicating whether to use the gRPC stream functionality.
+        format : Optional[DesignFileFormat]
+            Format in which to export the design. By default, as an ``SCDOCX`` file.
+        as_stream : bool, default: False
+            Boolean indicating whether to use the gRPC stream functionality (if possible).
             or the single message approach. By default, ``False``
         """
         # Sanity checks on inputs
         if isinstance(file_location, Path):
             file_location = str(file_location)
         check_type(file_location, str)
+        check_type(format, DesignFileFormat)
+        check_type(as_stream, bool)
 
         # Process response (as stream or single file)
+        stream_msg = f"Downloading design in {format.value[0]} format using stream mechanism."
+        single_msg = (
+            f"Downloading design in {format.value[0]} format using single-message mechanism."
+        )
         received_bytes = bytes()
-        if as_stream:
-            self._grpc_client.log.debug("Downloading design using stream mechanism.")
-            response_iterator = self._commands_stub.DownloadFileStream(Empty())
-            for response in response_iterator:
-                received_bytes += response.chunk
-        else:
-            self._grpc_client.log.debug("Downloading design using single-message mechanism.")
-            response = self._commands_stub.DownloadFile(Empty())
+        if format is DesignFileFormat.SCDOCX:
+            if as_stream:
+                self._grpc_client.log.debug(stream_msg)
+                response_iterator = self._commands_stub.DownloadFileStream(Empty())
+                for response in response_iterator:
+                    received_bytes += response.chunk
+            else:
+                self._grpc_client.log.debug(single_msg)
+                response = self._commands_stub.DownloadFile(Empty())
+                received_bytes += response.data
+        elif (format is DesignFileFormat.PARASOLID_TEXT) or (
+            format is DesignFileFormat.PARASOLID_BIN
+        ):
+            if as_stream:
+                self._grpc_client.log.warning(
+                    "Streaming mechanism not supported for Parasolid format."
+                )
+            self._grpc_client.log.debug(single_msg)
+            response = self._design_stub.ExportDesign(ExportDesignRequest(format=format.value[1]))
             received_bytes += response.data
-
-        # Write to file
-        downloaded_file = open(file_location, "wb")
-        downloaded_file.write(received_bytes)
-        downloaded_file.close()
-
-        self._grpc_client.log.debug(f"Design successfully downloaded at location {file_location}.")
-
-    @protect_grpc
-    def export_parasolid(
-        self, file_location: Union[Path, str], export_text_format: Optional[bool] = False
-    ) -> None:
-        """Downloads a design in parasolid format from the active geometry server instance.
-
-        Parameters
-        ----------
-        file_location : Union[Path, str]
-            Location on disk where the file should be saved.
-        export_text_format : bool, default: False
-            Boolean indicating whether to request in binary format or in text format.
-            ``True`` will request text format, ``False`` will request binary format.
-            By default, ``False``.
-        """
-        if isinstance(file_location, Path):
-            file_location = str(file_location)
-        check_type(file_location, str)
-
-        self._grpc_client.log.debug("Downloading design parasolid using single-message mechanism.")
-
-        # Process response as single file
-        received_bytes = bytes()
-        response = self._design_stub.ExportDesign(
-            ExportDesignRequest(
-                format=PartExportFormat.PARTEXPORTFORMAT_PARASOLID_TEXT
-                if export_text_format
-                else PartExportFormat.PARTEXPORTFORMAT_PARASOLID_BINARY
+        else:
+            self._grpc_client.log.warning(
+                f"{format.value[0]} format requested not supported. Ignoring download request."
             )
-        )
-        received_bytes += response.data
+            return
 
         # Write to file
         downloaded_file = open(file_location, "wb")
diff --git a/tests/integration/test_design.py b/tests/integration/test_design.py
@@ -4,7 +4,12 @@
 import pytest
 
 from ansys.geometry.core import Modeler
-from ansys.geometry.core.designer import CurveType, SharedTopologyType, SurfaceType
+from ansys.geometry.core.designer import (
+    CurveType,
+    DesignFileFormat,
+    SharedTopologyType,
+    SurfaceType,
+)
 from ansys.geometry.core.designer.face import FaceLoopType
 from ansys.geometry.core.materials import Material, MaterialProperty, MaterialPropertyType
 from ansys.geometry.core.math import UNITVECTOR3D_Z, Frame, Plane, Point2D, Point3D, UnitVector3D
@@ -731,11 +736,16 @@ def test_download_file(modeler: Modeler, tmp_path_factory: pytest.TempPathFactor
     # Check for parasolid exports
     binary_parasolid_file = tmp_path_factory.mktemp("scdoc_files_download") / "cylinder.x_b"
     text_parasolid_file = tmp_path_factory.mktemp("scdoc_files_download") / "cylinder_stream.x_t"
-    design.export_parasolid(binary_parasolid_file, export_text_format=False)
-    design.export_parasolid(text_parasolid_file, export_text_format=True)
+    design.download(binary_parasolid_file, format=DesignFileFormat.PARASOLID_BIN, as_stream=True)
+    design.download(text_parasolid_file, format=DesignFileFormat.PARASOLID_TEXT)
     assert binary_parasolid_file.exists()
     assert text_parasolid_file.exists()
 
+    # Check also the invalid format is not supported - no download performed
+    invalid_file = tmp_path_factory.mktemp("scdoc_files_download") / "invalid.file"
+    design.download(invalid_file, format=DesignFileFormat.INVALID, as_stream=True)
+    assert not invalid_file.exists()
+
 
 def test_slot_extrusion(modeler: Modeler):
     """Test the extrusion of a slot."""

Original file line number	Diff line number	Diff line change
`@@ -121,6 +121,7 @@`
`121`	`121`	`}`
`122`	`122`	`nbsphinx_thumbnails = {`
`123`	`123`	`"examples/basic_usage": "_static/thumbnails/basic_usage.png",`
	`124`	`+ "examples/dynamic_sketch_plane": "_static/thumbnails/dynamic_sketch_plane.png",`
`124`	`125`	`}`
`125`	`126`
`126`	`127`	`typehints_defaults = "comma"`