feat: adding check_has_mapdl (#3576)

* fix: promote to exposed function

* tests: adding tests

* chore: adding changelog file 3576.miscellaneous.md [dependabot-skip]

* fix: test

* fix: adding missing import

---------

Co-authored-by: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com>

doc/changelog.d/3576.miscellaneous.md

@@ -0,0 +1 @@
+feat: adding ``check_has_mapdl``

src/ansys/mapdl/core/__init__.py

@@ -115,7 +115,7 @@
 
 from ansys.mapdl.core.information import Information
 from ansys.mapdl.core.mapdl_grpc import MapdlGrpc as Mapdl
-from ansys.mapdl.core.misc import _check_has_ansys
+from ansys.mapdl.core.misc import check_has_mapdl
 from ansys.mapdl.core.pool import MapdlPool
 from ansys.mapdl.core.report import Report
 

src/ansys/mapdl/core/misc.py

@@ -112,7 +112,7 @@ def random_string(stringLength: int = 10, letters: str = string.ascii_lowercase)
     return "".join(secrets.choice(letters) for _ in range(stringLength))
 
 
-def _check_has_ansys() -> bool:
+def check_has_mapdl() -> bool:
     """Safely wraps check_valid_ansys
 
     Returns
@@ -125,7 +125,10 @@ def _check_has_ansys() -> bool:
 
     try:
         return check_valid_ansys()
-    except:
+    except Exception as err:
+        LOG.error(
+            f"An error was obtained when checking for a valid MAPDL installation:\n{str(err)}"
+        )
         return False
 
 

tests/common.py

@@ -24,6 +24,7 @@
 from collections import namedtuple
 import os
 import subprocess
+import time
 from typing import Dict, List
 
 import psutil

tests/test_launcher.py

@@ -73,7 +73,7 @@
     update_env_vars,
 )
 from ansys.mapdl.core.licensing import LICENSES
-from ansys.mapdl.core.misc import stack
+from ansys.mapdl.core.misc import check_has_mapdl, stack
 from conftest import (
     ON_LOCAL,
     PATCH_MAPDL,
@@ -1931,3 +1931,19 @@ def test_args_pass(monkeypatch, arg, value, method):
     mapdl = launch_mapdl(**kwargs)
     meth = getattr(mapdl, method)
     assert meth == value
+
+
+def test_check_has_mapdl():
+    if TESTING_MINIMAL:
+        assert check_has_mapdl() is False
+    else:
+        assert check_has_mapdl() == ON_LOCAL
+
+
+def raising():
+    raise Exception("An error")
+
+
+@patch("ansys.mapdl.core.launcher.check_valid_ansys", raising)
+def test_check_has_mapdl_failed():
+    assert check_has_mapdl() is False