Add a retrocompatibility workflow (#310)

* Add a retro-compatibility workflow

* Trigger on pull_requests to retro/ branches
Trigger also for release/ branches

* Update pydpf-actions to 2.1.1

* Update to trigger on pull_requests FROM a retro or release branch

* Fix vtk version in setup.py extras_require[plotting]

* Add concurrency criterion

* Revert Fix vtk version in setup.py extras_require[plotting]: vtk 9.0.3 not available for Python 3.10

* Fix unbuntu doctest error due to unsorted available_property_fields list

* Rename job

* Update run criteria

* Update run criteria

* Go back to Windows 3.8 only

* Add empty line at end-of-file

Co-authored-by: Paul P <[email protected]>

Author: PProfizi

.github/workflows/retro.yml

@@ -0,0 +1,43 @@
+name: Retro-Compatibility check
+
+on:
+  schedule:  # UTC at 0400
+    - cron: '0 4 * * *'
+  pull_request:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+env:
+  PACKAGE_NAME: ansys-dpf-core
+  MODULE: core
+
+jobs:
+  Retro_221:
+    if: startsWith(github.head_ref, 'master') || contains(github.head_ref, 'retro')
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.8"]
+        os: [ "windows-latest"]
+    env:
+      ANSYS_VERSION: 221
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: "Build Package"
+        uses: pyansys/pydpf-actions/[email protected]
+        with:
+          python-version: ${{ matrix.python-version }}
+          ANSYS_VERSION: ${{env.ANSYS_VERSION}}
+          PACKAGE_NAME: ${{env.PACKAGE_NAME}}
+          MODULE: ${{env.MODULE}}
+          dpf-standalone-TOKEN: ${{secrets.DPF_PIPELINE}}
+          install_extras: plotting
+
+      - name: "Test Package"
+        uses: pyansys/pydpf-actions/[email protected]
+        with:
+          MODULE: ${{env.MODULE}}

ansys/dpf/core/meshed_region.py

@@ -230,7 +230,7 @@ def available_property_fields(self):
         -------
         available_property_fields : list str
         """
-        return self._stub.List(self._message).available_prop
+        return sorted(self._stub.List(self._message).available_prop)
 
     def property_field(self, property_name):
         """

tests/test_meshregion.py

@@ -41,7 +41,7 @@ def test_vtk_grid_from_model(simple_bar_model):
 
 def test_meshed_region_available_property_fields(simple_bar_model):
     mesh = simple_bar_model.metadata.meshed_region
-    properties = ['connectivity', 'elprops', 'eltype', 'apdl_element_type', 'mat']
+    properties = sorted(['connectivity', 'elprops', 'eltype', 'apdl_element_type', 'mat'])
     assert mesh.available_property_fields == properties