Fix/Implement license server check (#603)

* Added main structure of the code.

Added also a function which ping an IP:Port using python.

Helping fix issue #595

* Added 'check_license_server' before running MAPDL
in any of the modes.

* Added error class for
license_sever_connection_error.

* Implemented error handeling in `launcher`

* Fixing license server ip and port check.

* Fixing grammar.

* Added optional argument to `launch_mapdl` to
avoid license server check.

* Implemented lmutil license check.
However it seems to not work properly.
This method is not recommended anymore but it is keep for the moment.

* Created `license.py`.
Preparing to move everything related to licensing there.

* Moved license functions to license.py

* Adding new local license file check.

* Adding new functions for checking the file.

* Major changes.

Added file server log checking.
Restructured completelely 'license.py'
Added thread behaviour to the license checking in launcher.py
Improved behaviour of `LicenseServerConnectionError`

# Aiming to fix #595

* Fixed the license client file name.
Now it is dynamically obtained from passed version parameter.

Added detailed message to `LicenseServerConnectionError`.

* Cleaning a bit

* Doing some cosmetical changes.

Removing unnecessary parameter.

* Implemented `ansysli_util` method.

* Formating error class.

* Added functionality to check multiple licenses when
using ansysli_util

* Refurbished 'LicenseServerConnectionError' class.

* Format fixing

* Format fixing

* Added licdebug naming pattern to match
previous and future versions.

* Added some comments.

* Apply suggestions from code review

Co-authored-by: jleonatti <[email protected]>

* Update ansys/mapdl/core/license.py

Co-authored-by: jleonatti <[email protected]>

* Apply suggestions from code review

Co-authored-by: jleonatti <[email protected]>

* Format fixing

* flake8 fixes

* cleanup licensing

* style fixes

* Fixed file name spelling

* Removed unnecesary functions.

Format file using flake8.

* Removed unnecesary test function

* Debugging

* Added docstrings.

Format fixed.

* Format fxing

* Spell checking.

* Fixing test_licensing.
Many test cannot be executed when the license is not local.

* Fixing import function.

* Added a way-out to the while in `check_license_file`

Added global variables.

* Fixing testing

* Spell checking.

* More details to check_license_file docstring.

* More details to check_license_file docstring.

* Update ansys/mapdl/core/errors.py

Co-authored-by: Alex Kaszynski <[email protected]>

* Update ansys/mapdl/core/licensing.py

Co-authored-by: Alex Kaszynski <[email protected]>

* add basic test for licencing for get_licdebug_msg

* additional fixes

* style fixes

* renaming function

* Added a bit in docstring.

* fix windows testing

* ``get_licdebug_tail`` now gets all the lines, not one by one.

Added double quote wrapper around cmd command in case of Windows.

* Reduced the amount of attemps at connect in 'mapdl_grpc'.

implemented more robuts time limit for checking.
Now it stops if timeout or the maximum amount of attemps is reached.

* Reduced the amount of attemps at connect in 'mapdl_grpc'.

implemented more robuts time limit for checking.
Now it stops if timeout or the maximum amount of attemps is reached.

* Fixing licensing tests.

* Grammar fixing.

* Fixing test in docker.

* format fxing.

* Small changes in the documentation.
In the section of running MAPDL to clarify when to use `launch_mapdl` or `Mapdl`.

* Fixing wrong rst markup.

* Cleaning PR.

* Small fixes and cleaning.

* permit failed MAPDL start

* add additional licensing docs and options

* fix test asserts on pass

* Update ansys/mapdl/core/licensing.py

Co-authored-by: German <[email protected]>

Co-authored-by: jleonatti <[email protected]>
Co-authored-by: Alex Kaszynski <[email protected]>

Author: 3 people

.flake8

@@ -1,5 +1,5 @@
 [flake8]
-exclude = venv, __init__.py, build
+exclude = venv, __init__.py, build, doc/source/examples
 # To be added after refactoring code to be compliant: E501 
 select = W191, W291, W293, W391, E115, E117, E122, E124, E125, E225, E231, E301, E303, F401, F403
 count = True

.github/workflows/ci.yml

@@ -34,6 +34,7 @@ jobs:
           make
 
       - name: flake8
+        if: always()
         run: |
           make flake8
 

ansys/mapdl/core/errors.py

@@ -75,6 +75,13 @@ def __init__(self, msg=LOCKFILE_MSG):
         RuntimeError.__init__(self, msg)
 
 
+class LicenseServerConnectionError(RuntimeError):
+    """Error when the license server is not available."""
+
+    def __init__(self, msg=""):
+        RuntimeError.__init__(self, msg)
+
+
 # handler for protect_grpc
 def handler(sig, frame):  # pragma: no cover
     """Pass signal to custom interrupt handler."""

ansys/mapdl/core/launcher.py

@@ -12,8 +12,12 @@
 
 from ansys.mapdl import core as pymapdl
 from ansys.mapdl.core.misc import is_float, random_string, create_temp_dir, threaded
-from ansys.mapdl.core.errors import LockFileException, VersionError
+from ansys.mapdl.core.errors import (
+    LockFileException,
+    VersionError,
+)
 from ansys.mapdl.core.mapdl_grpc import MapdlGrpc
+from ansys.mapdl.core.licensing import LicenseChecker
 
 # settings directory
 SETTINGS_DIR = appdirs.user_data_dir("ansys_mapdl_core")
@@ -674,7 +678,7 @@ def check_lock_file(path, jobname, override):
                 raise LockFileException(
                     "Unable to remove lock file.  "
                     "Another instance of MAPDL might be "
-                    'running at "%s"' % path
+                    f"running at '{path}'"
                 )
 
 
@@ -703,8 +707,8 @@ def _validate_add_sw(add_sw, exec_path, force_intel=False):
     if "smp" not in add_sw:  # pragma: no cover
         # Ubuntu ANSYS fails to launch without I_MPI_SHM_LMT
         if _is_ubuntu():
-            os.environ['I_MPI_SHM_LMT'] = 'shm'
-        if os.name == 'nt' and not force_intel:
+            os.environ["I_MPI_SHM_LMT"] = "shm"
+        if os.name == "nt" and not force_intel:
             # Workaround to fix a problem when launching ansys in 'dmp' mode in the
             # recent windows version and using VPN.
             #
@@ -715,14 +719,14 @@ def _validate_add_sw(add_sw, exec_path, force_intel=False):
             #
             # Adding '-mpi msmpi' to the launch parameter fix it.
 
-            if 'intelmpi' in add_sw:
+            if "intelmpi" in add_sw:
                 # Remove intel flag.
                 regex = "(-mpi)( *?)(intelmpi)"
-                add_sw = re.sub(regex, '', add_sw)
+                add_sw = re.sub(regex, "", add_sw)
                 warnings.warn(INTEL_MSG)
 
             if _version_from_path(exec_path) >= 210:
-                add_sw += ' -mpi msmpi'
+                add_sw += " -mpi msmpi"
 
     return add_sw
 
@@ -745,6 +749,7 @@ def launch_mapdl(
     clear_on_connect=True,
     log_apdl=False,
     verbose_mapdl=False,
+    license_server_check=True,
     **kwargs,
 ):
     """Start MAPDL locally in gRPC mode.
@@ -856,6 +861,10 @@ def launch_mapdl(
         MAPDL.  This should be used for debugging only as output can
         be tracked within pymapdl.  Default ``False``.
 
+    license_server_check : bool, optional
+        Check if the license server is available if MAPDL fails to
+        start.  Only available on ``mode='grpc'``. Defaults to True
+
     Notes
     -----
     These are the MAPDL switch options as of 2020R2 applicable for
@@ -1028,8 +1037,9 @@ def launch_mapdl(
     mode = check_mode(mode, _version_from_path(exec_file))
 
     # cache start parameters
-    additional_switches = _validate_add_sw(additional_switches, exec_file,
-                                          kwargs.pop('force_intel', False))
+    additional_switches = _validate_add_sw(
+        additional_switches, exec_file, kwargs.pop("force_intel", False)
+    )
     start_parm = {
         "exec_file": exec_file,
         "run_location": run_location,
@@ -1045,46 +1055,61 @@ def launch_mapdl(
         start_parm["override"] = override
         start_parm["timeout"] = start_timeout
 
-    if mode == "console":
-        from ansys.mapdl.core.mapdl_console import MapdlConsole
-
-        mapdl = MapdlConsole(loglevel=loglevel, log_apdl=log_apdl, **start_parm)
-    elif mode == "corba":
-        try:
-            # pending deprication to ansys-mapdl-corba
-            from ansys.mapdl.core.mapdl_corba import MapdlCorba
-        except ImportError:
-            raise ImportError(
-                "To use this feature, install the MAPDL CORBA package"
-                " with:\n\npip install ansys_corba"
-            ) from None
-
-        broadcast = kwargs.get("log_broadcast", False)
-        mapdl = MapdlCorba(
-            loglevel=loglevel,
-            log_apdl=log_apdl,
-            log_broadcast=broadcast,
-            verbose=verbose_mapdl,
-            **start_parm,
-        )
-    elif mode == "grpc":
-        port, actual_run_location = launch_grpc(
-            port=port, verbose=verbose_mapdl, ip=ip, **start_parm
-        )
-        mapdl = MapdlGrpc(
-            ip=ip,
-            port=port,
-            cleanup_on_exit=cleanup_on_exit,
-            loglevel=loglevel,
-            set_no_abort=set_no_abort,
-            remove_temp_files=kwargs.pop("remove_temp_files", False),
-            log_apdl=log_apdl,
-            **start_parm,
+    # Check the license server
+    if license_server_check:
+        # configure timeout to be 90% of the wait time of the startup
+        # time for Ansys.
+        lic_check = LicenseChecker(
+            timeout=start_timeout*0.9, verbose=verbose_mapdl
         )
-        if run_location is None:
-            mapdl._path = actual_run_location
-    else:
-        raise ValueError("Invalid mode %s" % mode)
+        lic_check.start()
+
+    try:
+        if mode == "console":
+            from ansys.mapdl.core.mapdl_console import MapdlConsole
+
+            mapdl = MapdlConsole(loglevel=loglevel, log_apdl=log_apdl, **start_parm)
+        elif mode == "corba":
+            try:
+                # pending deprication to ansys-mapdl-corba
+                from ansys.mapdl.core.mapdl_corba import MapdlCorba
+            except ImportError:
+                raise ImportError(
+                    "To use this feature, install the MAPDL CORBA package"
+                    " with:\n\npip install ansys_corba"
+                ) from None
+
+            broadcast = kwargs.get("log_broadcast", False)
+            mapdl = MapdlCorba(
+                loglevel=loglevel,
+                log_apdl=log_apdl,
+                log_broadcast=broadcast,
+                verbose=verbose_mapdl,
+                **start_parm,
+            )
+        elif mode == "grpc":
+            port, actual_run_location = launch_grpc(
+                port=port, verbose=verbose_mapdl, ip=ip, **start_parm
+            )
+            mapdl = MapdlGrpc(
+                ip=ip,
+                port=port,
+                cleanup_on_exit=cleanup_on_exit,
+                loglevel=loglevel,
+                set_no_abort=set_no_abort,
+                remove_temp_files=kwargs.pop("remove_temp_files", False),
+                log_apdl=log_apdl,
+                **start_parm,
+            )
+            if run_location is None:
+                mapdl._path = actual_run_location
+    except Exception as exception:
+        # Failed to launch for some reason.  Check if failure was due
+        # to the license check
+        if license_server_check:
+            lic_check.check()
+            # pass
+        raise exception
 
     return mapdl