Pytest options to envvar and runtime error replacement (#1953)

* Changing runtime error for MapdlRuntimeError

* Using an env var for pytest options

* Fixing tests

* Adding missing import

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Camille <[email protected]>

Author: 3 people

.github/workflows/ci.yml

@@ -21,6 +21,8 @@ env:
   DOCKER_PACKAGE: ghcr.io/pyansys/pymapdl/mapdl
   DOCKER_IMAGE_VERSION_DOCS_BUILD: v22.2.0
   ON_CI: True
+  PYTEST_ARGUMENTS: '-vv --durations=10 --maxfail=10 --reruns 7 --reruns-delay 5 --cov=ansys.mapdl.core --cov-report=html'
+
   # Following env vars when changed will "reset" the mentioned cache,
   # by changing the cache file name. It is rendered as ...-v%RESET_XXX%-...
   # You should go up in number, if you go down (or repeat a previous value)
@@ -61,7 +63,7 @@ jobs:
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
         python-version: ['3.7', '3.8', '3.9', '3.10', '3.11']
-        # Only perform wheelhouse builds for Windows and macOS when releasing
+        # Only perform wheelhouse builds for macOS when releasing
         should-release: 
           - ${{ github.event_name == 'push' && contains(github.ref, 'refs/tags') }}
         exclude:
@@ -328,9 +330,9 @@ jobs:
       - name: "Unit testing"
         run: |
           if [[ "${{ matrix.mapdl-version }}" == *"ubuntu"* ]]; then export ON_UBUNTU=true;fi
-          xvfb-run pytest -v --durations=10 \
-              --maxfail=3  --reruns 7 --reruns-delay 5 \
-              --cov=ansys.mapdl.core --cov-report=xml:centos-${{ matrix.mapdl-version }}-remote.xml --cov-report=html
+          xvfb-run pytest \
+            ${{ env.PYTEST_ARGUMENTS }} \
+            --cov-report=xml:centos-${{ matrix.mapdl-version }}-remote.xml
 
       - uses: codecov/codecov-action@v3
         name: "Upload coverage to Codecov"
@@ -476,10 +478,9 @@ jobs:
           unset PYMAPDL_START_INSTANCE
           export ANSYSLMD_LICENSE_FILE=1055@${{ secrets.LICENSE_SERVER }}
           export AWP_ROOT222=/ansys_inc
-          xvfb-run pytest -v -k "not test_database and not test_dpf" \
-            --durations=10 \
-            --maxfail=10 --reruns 7 --reruns-delay 5 \
-            --cov=ansys.mapdl.core --cov-report=xml:ubuntu-v22.2.0-local.xml --cov-report=html
+          xvfb-run pytest -k "not test_database and not test_dpf" \
+            ${{ env.PYTEST_ARGUMENTS }} \
+            --cov-report=xml:ubuntu-v22.2.0-local.xml
 
       - uses: codecov/codecov-action@v3
         name: "Upload coverage to Codecov"
@@ -546,10 +547,9 @@ jobs:
         run: |
           set PYMAPDL_PORT=
           set PYMAPDL_START_INSTANCE=
-          python -m pytest -v -k "not test_database and not test_dpf" \
-            --durations=10 \
-            --maxfail=3  --reruns 7 --reruns-delay 5 \
-            --cov=ansys.mapdl.core --cov-report=xml:windows-v22.2.0-local.xml --cov-report=html
+          python -m pytest -k "not test_database and not test_dpf" \
+            ${{ env.PYTEST_ARGUMENTS }} \
+            --cov-report=xml:windows-v22.2.0-local.xml
 
       - uses: codecov/codecov-action@v3
         name: "Upload coverage to Codecov"

src/ansys/mapdl/core/_commands/apdl/array_param.py

@@ -1481,7 +1481,7 @@ def vwrite(
         """
         # cannot be in interactive mode
         if not self._store_commands:
-            raise RuntimeError(
+            raise MapdlRuntimeError(
                 "VWRTIE cannot run interactively.  \n\nPlease use "
                 "``with mapdl.non_interactive:``"
             )

src/ansys/mapdl/core/_commands/session/run_controls.py

@@ -2,6 +2,7 @@
 session, including the jobname, Graphical User Interface behavior, and
 file switching.
 """
+from ansys.mapdl.core.errors import MapdlRuntimeError
 
 
 class RunControls:
@@ -143,7 +144,7 @@ def cwd(self, dirpath="", **kwargs):
         """
         dirpath = str(dirpath)
         if not (dirpath.startswith("'") and dirpath.endswith("'")) and "'" in dirpath:
-            raise RuntimeError(
+            raise MapdlRuntimeError(
                 'The CWD command does not accept paths that contain singular quotes "'
             )
         return self.run(f"/CWD,'{dirpath}'", **kwargs)

src/ansys/mapdl/core/database/database.py

@@ -9,6 +9,8 @@
 from ansys.api.mapdl.v0 import mapdl_db_pb2_grpc
 import grpc
 
+from ansys.mapdl.core.errors import MapdlConnectionError
+
 from ..mapdl_grpc import MapdlGrpc
 
 VALID_MAPDL_VERSIONS = [21.1, 21.2, 22.1, 22.2]
@@ -264,7 +266,7 @@ def start(self, timeout=10):
             time.sleep(0.01)
 
         if not self._state._matured:  # pragma: no cover
-            raise RuntimeError(
+            raise MapdlConnectionError(
                 "Unable to establish connection to MAPDL database server"
             )
         self._mapdl._log.debug("Established connection to MAPDL database server")

src/ansys/mapdl/core/database/elems.py

@@ -8,6 +8,8 @@
 
 from ansys.api.mapdl.v0 import mapdl_db_pb2
 
+from ansys.mapdl.core.errors import MapdlRuntimeError
+
 from . import DBDef, MapdlDb, check_mapdl_db_is_alive
 
 
@@ -130,7 +132,9 @@ def next(self):
 
         """
         if self._itelm == -1:
-            raise RuntimeError("You first have to call the `DbElems.first` method.")
+            raise MapdlRuntimeError(
+                "You first have to call the `DbElems.first` method."
+            )
 
         request = mapdl_db_pb2.ElmRequest(next=self._itelm)
         result = self._db._stub.ElmNext(request)

src/ansys/mapdl/core/database/nodes.py

@@ -11,6 +11,8 @@
 import numpy as np
 from numpy.lib import recfunctions
 
+from ansys.mapdl.core.errors import MapdlRuntimeError
+
 from ..common_grpc import DEFAULT_CHUNKSIZE
 from .database import DBDef, MapdlDb, check_mapdl_db_is_alive
 
@@ -157,7 +159,9 @@ def next(self):
 
         """
         if self._itnod == -1:
-            raise RuntimeError("You first have to call the `DbNodes.first` method.")
+            raise MapdlRuntimeError(
+                "You first have to call the `DbNodes.first` method."
+            )
 
         request = mapdl_db_pb2.NodRequest(next=self._itnod)
         result = self._db._stub.NodNext(request)

src/ansys/mapdl/core/inline_functions/core.py

@@ -59,7 +59,7 @@ def _run_query(self, command: str, integer: bool) -> Union[int, float]:
 
         # non_interactive mode won't work with these commands
         if self._mapdl._store_commands:
-            raise RuntimeError(
+            raise MapdlRuntimeError(
                 "Inline MAPDL functions are incompatible with the "
                 "non_interactive mode."
             )
@@ -69,7 +69,7 @@ def _run_query(self, command: str, integer: bool) -> Union[int, float]:
         if isinstance(self._mapdl, MapdlGrpc):
             value = self._mapdl.scalar_param(QUERY_NAME)
             if value is None:
-                raise RuntimeError(resp)
+                raise MapdlRuntimeError(resp)
             if integer:
                 return int(value)
             return value

src/ansys/mapdl/core/launcher.py

@@ -25,7 +25,12 @@
 from ansys.mapdl import core as pymapdl
 from ansys.mapdl.core import LINUX_DEFAULT_DIRS, LOG
 from ansys.mapdl.core._version import SUPPORTED_ANSYS_VERSIONS
-from ansys.mapdl.core.errors import LockFileException, MapdlDidNotStart, VersionError
+from ansys.mapdl.core.errors import (
+    LockFileException,
+    MapdlDidNotStart,
+    MapdlRuntimeError,
+    VersionError,
+)
 from ansys.mapdl.core.licensing import ALLOWABLE_LICENSES, LicenseChecker
 from ansys.mapdl.core.mapdl import _MapdlCore
 from ansys.mapdl.core.mapdl_grpc import MAX_MESSAGE_LENGTH, MapdlGrpc
@@ -141,7 +146,7 @@ def _version_from_path(path):
     # replace \\ with / to account for possible windows path
     matches = re.findall(r"v(\d\d\d).ansys", path.replace("\\", "/"), re.IGNORECASE)
     if not matches:
-        raise RuntimeError(f"Unable to extract Ansys version from {path}")
+        raise MapdlRuntimeError(f"Unable to extract Ansys version from {path}")
     return int(matches[-1])
 
 
@@ -1876,7 +1881,7 @@ def launch_mapdl(
                 os.mkdir(run_location)
                 LOG.debug("Created run location at %s", run_location)
             except:
-                raise RuntimeError(
+                raise MapdlRuntimeError(
                     "Unable to create the temporary working "
                     f'directory "{run_location}"\n'
                     "Please specify run_location="

src/ansys/mapdl/core/mapdl.py

@@ -503,7 +503,7 @@ def solution(self):
         >>> mapdl.solution.converged
         """
         if self._exited:
-            raise RuntimeError("MAPDL exited.")
+            raise MapdlRuntimeError("MAPDL exited.")
         return self._solution
 
     @property
@@ -526,7 +526,7 @@ def post_processing(self):
                5.70333124e-05, 8.58600402e-05, 1.07445726e-04])
         """
         if self._exited:
-            raise RuntimeError(
+            raise MapdlRuntimeError(
                 "MAPDL exited.\n\nCan only postprocess a live " "MAPDL instance."
             )
         return self._post
@@ -560,7 +560,7 @@ def chain_commands(self):
 
         """
         if self._distributed:
-            raise RuntimeError(
+            raise MapdlRuntimeError(
                 "Chained commands are not permitted in distributed ansys."
             )
         return self._chain_commands(self)
@@ -972,7 +972,7 @@ def open_apdl_log(self, filename, mode="w"):
         >>> mapdl.open_apdl_log("log.inp")
         """
         if self._apdl_log is not None:
-            raise RuntimeError("APDL command logging already enabled")
+            raise MapdlRuntimeError("APDL command logging already enabled")
         self._log.debug("Opening ANSYS log file at %s", filename)
 
         if mode not in ["w", "a", "x"]:
@@ -1041,7 +1041,7 @@ def open_gui(self, include_result=None, inplace=None):  # pragma: no cover
         from ansys.mapdl.core.launcher import get_ansys_path
 
         if not self._local:
-            raise RuntimeError(
+            raise MapdlRuntimeError(
                 "``open_gui`` can only be called from a local MAPDL instance."
             )
 
@@ -2055,7 +2055,9 @@ def result(self) -> "ansys.mapdl.reader.rst.Result":
                 result = Result(result_path, read_mesh=False)
                 if result._is_cyclic:
                     if not os.path.isfile(self._result_file):
-                        raise RuntimeError("Distributed Cyclic result not supported")
+                        raise MapdlRuntimeError(
+                            "Distributed Cyclic result not supported"
+                        )
                     result_path = self._result_file
             else:
                 result_path = self._result_file
@@ -2862,13 +2864,13 @@ def run(self, command, write_to_log=True, mute=None, **kwargs) -> str:
             )
 
         if command[:3].upper() in INVAL_COMMANDS:
-            exception = RuntimeError(
+            exception = MapdlRuntimeError(
                 'Invalid PyMAPDL command "%s"\n\n%s'
                 % (command, INVAL_COMMANDS[command[:3].upper()])
             )
             raise exception
         elif command[:4].upper() in INVAL_COMMANDS:
-            exception = RuntimeError(
+            exception = MapdlRuntimeError(
                 'Invalid PyMAPDL command "%s"\n\n%s'
                 % (command, INVAL_COMMANDS[command[:4].upper()])
             )
@@ -3341,7 +3343,7 @@ def get_array(
         while arr.size == 1 and arr[0] == -1:
             arr = self._get_array(entity, entnum, item1, it1num, item2, it2num, kloop)
             if ntry > 5:
-                raise RuntimeError("Unable to get array for %s" % entity)
+                raise MapdlRuntimeError("Unable to get array for %s" % entity)
             ntry += 1
         return arr
 

src/ansys/mapdl/core/mapdl_console.py

@@ -6,7 +6,7 @@
 import re
 import time
 
-from ansys.mapdl.core.errors import MapdlExitedError
+from ansys.mapdl.core.errors import MapdlExitedError, MapdlRuntimeError
 
 # from ansys.mapdl.core.misc import kill_process
 from ansys.mapdl.core.mapdl import _MapdlCore
@@ -186,7 +186,7 @@ def _run(self, command, **kwargs):
                     ready_items[i].decode("utf-8"),
                 )
                 self._log.info(response + ready_items[i].decode("utf-8"))
-                raise RuntimeError(
+                raise MapdlRuntimeError(
                     "User input expected.  " "Try using ``with mapdl.non_interactive``"
                 )
             else:  # continue item