add Doctest in pipelines (#103)

* update pipelines

* update doc strings

Author: cbellot000

.ci/azure-pipelines.yml

@@ -44,21 +44,49 @@ jobs:
 
     - script: |
         pip install -r requirements_test.txt
+      displayName: Install Test Environment
+
+    - script: |
         set THISDIR=$(System.DefaultWorkingDirectory)
-        cd tests=$(System.DefaultWorkingDirectory)
+        cd tests
         set AWP_ROOT212=%THISDIR%\server\v212
         pytest -v --junitxml=junit/test-results.xml --cov ansys.dpf.core --cov-report=xml --reruns 3
         
       displayName: Test Core API
-      
+      timeoutInMinutes: 10
+
     - task: PublishTestResults@2
       inputs:
         testResultsFormat: 'JUnit'
-        testResultsFiles: 'junit/test-results.xml' 
+        testResultsFiles: 'tests/junit/test-results.xml'
         testRunTitle: 'windowsTests'
-        publishRunAttachments: true      
+        publishRunAttachments: true
       condition: always()
-      
+
+    - script: |
+        set THISDIR=$(System.DefaultWorkingDirectory)
+        cd $(System.DefaultWorkingDirectory)
+        set AWP_ROOT212=%THISDIR%\server\v212
+        pytest --doctest-modules --junitxml=junit/test-doctests-results.xml ansys\dpf\core
+      condition: always()
+      displayName: Test API Docstrings
+      timeoutInMinutes: 5
+
+    - task: PublishTestResults@2
+      inputs:
+        testResultsFormat: 'JUnit'
+        testResultsFiles: 'junit/test-doctests-results.xml'
+        testRunTitle: 'docTestsTests'
+        publishRunAttachments: true
+      condition: always()
+
+    - script:  |
+        set THISDIR=$(System.DefaultWorkingDirectory)
+        set AWP_ROOT212=%THISDIR%\server\v212
+        python .ci/run_examples.py
+      displayName: 'Run example scripts'
+      timeoutInMinutes: 5
+
     - script: |
         pip install twine
         python setup.py sdist

.ci/run_examples.py

@@ -0,0 +1,20 @@
+import os
+import glob
+import pathlib
+from ansys.dpf import core
+
+core.disable_off_screen_rendering()
+
+actual_path = pathlib.Path(__file__).parent.absolute()
+print(os.path.join(actual_path, os.path.pardir, "examples"))
+for root, subdirectories, files in os.walk(os.path.join(actual_path, os.path.pardir, "examples")):
+    for subdirectory in subdirectories:
+        subdir = os.path.join(root, subdirectory)
+        for file in glob.iglob(os.path.join(subdir, "*.py")):
+            print("\n\n--------------------------------------------------\n")
+            print(file)
+            print("--------------------------------------------------\n")
+            exec(
+                open(file, mode="r", encoding="utf8").read(),
+                globals(),
+                globals())

ansys/dpf/core/__init__.py

@@ -104,3 +104,16 @@
 SERVER = None
 
 _server_instances = []
+
+def disable_off_screen_rendering() -> None:
+    # enable matplotlib off_screen plotting to avoid test interruption
+    if module_exists("matplotlib"):
+        import matplotlib as mpl
+
+        mpl.use("Agg")
+
+    # enable off_screen plotting to avoid test interruption
+    if module_exists("pyvista"):
+        import pyvista as pv
+
+        pv.OFF_SCREEN = True

ansys/dpf/core/aeneid.py

@@ -63,9 +63,13 @@ def solid_fields(self, timeid=None, complexid=None):
 
         Examples
         --------
+        >>> from ansys.dpf import core as dpf
+        >>> from ansys.dpf.core import examples
+        >>> model = dpf.Model(examples.download_all_kinds_of_complexity_modal())
+        >>> fc = model.results.displacement.split_by_shape.eval()
         >>> len(fc.solid_fields())
-        45
-        >>> len(fc.solid_fields(timeid=3))
+        1
+        >>> len(fc.solid_fields(timeid=1))
         1
 
         """
@@ -94,6 +98,10 @@ def shell_fields(self, timeid=None, complexid=None):
 
         Examples
         --------
+        >>> from ansys.dpf import core as dpf
+        >>> from ansys.dpf.core import examples
+        >>> model = dpf.Model(examples.download_all_kinds_of_complexity_modal())
+        >>> fc = model.results.displacement.on_all_time_freqs.split_by_shape.eval()
         >>> len(fc.shell_fields())
         45
         >>> len(fc.shell_fields(timeid=3))
@@ -125,6 +133,10 @@ def beam_fields(self, timeid=None, complexid=None):
 
         Examples
         --------
+        >>> from ansys.dpf import core as dpf
+        >>> from ansys.dpf.core import examples
+        >>> model = dpf.Model(examples.download_all_kinds_of_complexity_modal())
+        >>> fc = model.results.displacement.on_all_time_freqs.split_by_shape.eval()
         >>> len(fc.beam_fields())
         45
         >>> len(fc.beam_fields(timeid=3))
@@ -156,6 +168,10 @@ def solid_field(self, timeid=None, complexid=None):
 
         Examples
         --------
+        >>> from ansys.dpf import core as dpf
+        >>> from ansys.dpf.core import examples
+        >>> model = dpf.Model(examples.download_all_kinds_of_complexity_modal())
+        >>> fc = model.results.displacement.on_all_time_freqs.split_by_shape.eval()
         >>> field = fc.solid_field(timeid=3)
 
         """
@@ -185,6 +201,10 @@ def shell_field(self, timeid=None, complexid=None):
 
         Examples
         --------
+        >>> from ansys.dpf import core as dpf
+        >>> from ansys.dpf.core import examples
+        >>> model = dpf.Model(examples.download_all_kinds_of_complexity_modal())
+        >>> fc = model.results.displacement.on_all_time_freqs.split_by_shape.eval()
         >>> field = fc.shell_field(timeid=3)
 
         """
@@ -213,6 +233,10 @@ def beam_field(self, timeid=None, complexid=None):
 
         Examples
         --------
+        >>> from ansys.dpf import core as dpf
+        >>> from ansys.dpf.core import examples
+        >>> model = dpf.Model(examples.download_all_kinds_of_complexity_modal())
+        >>> fc = model.results.displacement.on_all_time_freqs.split_by_shape.eval()
         >>> field = fc.beam_field(timeid=3)
 
         """
@@ -280,6 +304,10 @@ def get_fields_by_mat_id(self, matid, timeid=None, complexid=None):
 
         Examples
         --------
+        >>> from ansys.dpf import core as dpf
+        >>> from ansys.dpf.core import examples
+        >>> model = dpf.Model(examples.download_all_kinds_of_complexity_modal())
+        >>> fc = model.results.displacement.on_all_time_freqs.split_by_body.eval()
         >>> len(fc.get_fields_by_mat_id(1))
         45
         >>> len(fc.get_fields_by_mat_id(1, timeid=3))
@@ -313,6 +341,10 @@ def get_field_by_mat_id(self, matid, timeid=None, complexid=None):
 
         Examples
         --------
+        >>> from ansys.dpf import core as dpf
+        >>> from ansys.dpf.core import examples
+        >>> model = dpf.Model(examples.download_all_kinds_of_complexity_modal())
+        >>> fc = model.results.displacement.on_all_time_freqs.split_by_body.eval()
         >>> f_time_2 = fc.get_field_by_mat_id(45, timeid=2)
 
         """

ansys/dpf/core/custom_fields_container.py

@@ -91,6 +91,10 @@ def _add_sub_res_operators(self, sub_results):
 
         Examples
         --------
+        >>> from ansys.dpf.core import Model
+        >>> from ansys.dpf.core import examples
+        >>> model = Model(examples.static_rst)
+        >>> disp_oper = model.results.displacement()
         >>> disp_oper = model.results.displacement()
         >>> disp_x = model.results.displacement().X()
         >>> disp_y = model.results.displacement().Y()

ansys/dpf/core/dpf_operator.py

@@ -65,6 +65,11 @@ def node_ids(self):
 
         Examples
         --------
+        >>> import ansys.dpf.core as dpf
+        >>> from ansys.dpf.core import examples
+        >>> model = dpf.Model(examples.static_rst)
+        >>> elements = model.metadata.meshed_region.elements
+        >>> element = elements[0]
         >>> element.node_ids
         [1, 26, 14, 12, 2, 27, 15, 13, 33, 64, 59, 30, 37, 65, 61, 34, 28, 81, 63, 58]
 
@@ -105,6 +110,11 @@ def nodes(self):
 
         Examples
         --------
+        >>> import ansys.dpf.core as dpf
+        >>> from ansys.dpf.core import examples
+        >>> model = dpf.Model(examples.static_rst)
+        >>> elements = model.metadata.meshed_region.elements
+        >>> element = elements[0]
         >>> first_node = element.nodes[0]
 
         """
@@ -142,6 +152,11 @@ def type(self) -> int:
 
         Examples
         --------
+        >>> import ansys.dpf.core as dpf
+        >>> from ansys.dpf.core import examples
+        >>> model = dpf.Model(examples.static_rst)
+        >>> elements = model.metadata.meshed_region.elements
+        >>> element = elements[0]
         >>> element.type
         <element_types.Hex20: 1>
 
@@ -170,6 +185,11 @@ def shape(self) -> str:
 
         Examples
         --------
+        >>> import ansys.dpf.core as dpf
+        >>> from ansys.dpf.core import examples
+        >>> model = dpf.Model(examples.static_rst)
+        >>> elements = model.metadata.meshed_region.elements
+        >>> element = elements[0]
         >>> element.shape
         'solid'
 
@@ -434,6 +454,10 @@ def scoping(self) -> scoping.Scoping:
 
         Examples
         --------
+        >>> import ansys.dpf.core as dpf
+        >>> from ansys.dpf.core import examples
+        >>> model = dpf.Model(examples.static_rst)
+        >>> elements = model.metadata.meshed_region.elements
         >>> my_scoping = elements.scoping
 
         """
@@ -450,6 +474,10 @@ def element_types_field(self):
 
         Examples
         --------
+        >>> import ansys.dpf.core as dpf
+        >>> from ansys.dpf.core import examples
+        >>> model = dpf.Model(examples.static_rst)
+        >>> elements = model.metadata.meshed_region.elements
         >>> field = elements.element_types_field
         >>> field.data
         array([1, 1, 1, 1, 1, 1, 1, 1])
@@ -476,6 +504,10 @@ def materials_field(self):
         --------
         Extract the material IDs from the materials_field
 
+        >>> import ansys.dpf.core as dpf
+        >>> from ansys.dpf.core import examples
+        >>> model = dpf.Model(examples.static_rst)
+        >>> elements = model.metadata.meshed_region.elements
         >>> elements.materials_field.data
         array([1, 1, 1, 1, 1, 1, 1, 1])
 
@@ -498,6 +530,10 @@ def connectivities_field(self):
 
         Examples
         --------
+        >>> import ansys.dpf.core as dpf
+        >>> from ansys.dpf.core import examples
+        >>> model = dpf.Model(examples.static_rst)
+        >>> elements = model.metadata.meshed_region.elements
         >>> field = elements.connectivities_field
         >>> field.get_entity_data(1)
         array([ 0, 11, 13, 25,  2,  9,  8,  3, 29, 58, 63, 32, 40, 52, 42, 37, 28,
@@ -535,8 +571,11 @@ def mapping_id_to_index(self) -> dict:
 
         Examples
         --------
-        >>> meshed_region.nodes.mapping_id_to_index
-        {1: 0, 2: 1, 3: 2, 4: 3}
+        >>> import ansys.dpf.core as dpf
+        >>> from ansys.dpf.core import examples
+        >>> model = dpf.Model(examples.simple_bar)
+        >>> meshed_region = model.metadata.meshed_region
+        >>> map = meshed_region.nodes.mapping_id_to_index
 
         """
         if self._mapping_id_to_index is None: