Feat/adding license selection to launcher (#659)

* Added dict with license names and descriptions.

* Added license_type functionality

* Added tests for the 'license_type' optional keyword.

* Added mapping in 'license_type' keyword
to being able to use the license description.

Added test to reflect that new capability.

* Removed unused import.

* Update ansys/mapdl/core/launcher.py

Using rst style instead of markdown for docstrings.

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

* Apply suggestions from code review

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

* Apply suggestions from code review

* minor changes

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

Author: germa89

ansys/mapdl/core/launcher.py

@@ -19,6 +19,8 @@
 )
 from ansys.mapdl.core.mapdl_grpc import MapdlGrpc
 from ansys.mapdl.core.licensing import LicenseChecker
+from ansys.mapdl.core.licensing import ALLOWABLE_LICENSES
+from ansys.mapdl.core import LOG
 
 # settings directory
 SETTINGS_DIR = appdirs.user_data_dir("ansys_mapdl_core")
@@ -751,6 +753,7 @@ def launch_mapdl(
     log_apdl=False,
     verbose_mapdl=False,
     license_server_check=True,
+    license_type=None,
     **kwargs,
 ):
     """Start MAPDL locally in gRPC mode.
@@ -864,7 +867,16 @@ def launch_mapdl(
 
     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
+        start.  Only available on ``mode='grpc'``. Defaults ``True``.
+
+    license_type : str, optional
+        Enable license type selection. You can input a string for its
+        license name (for example ``'meba'`` or ``'ansys'``) or its description
+        ("enterprise solver" or "enterprise" respectively).
+        You can also use legacy licenses (for example ``'aa_t_a'``) but it will
+        also raise a warning. If it is not used (``None``), no specific license
+        will be requested, being up to the license server to provide a specific
+        license type. Default is ``None``.
 
     Notes
     -----
@@ -1041,6 +1053,59 @@ def launch_mapdl(
     additional_switches = _validate_add_sw(
         additional_switches, exec_file, kwargs.pop("force_intel", False)
     )
+
+    if isinstance(license_type, str):
+        # In newer license server versions an invalid license name just get discarded and produces no effect or warning.
+        # For example:
+        # ```bash
+        # mapdl.exe -p meba    # works fine because 'meba' is a valid license in ALLOWABLE_LICENSES.
+        # mapdl.exe -p yoyoyo  # The -p flag is ignored and it run the default license.
+        # ```
+        #
+        # In older versions probably it might raise an error. But not sure.
+        license_type = license_type.lower().strip()
+
+        if 'enterprise' in license_type and 'solver' not in license_type:
+            license_type = 'ansys'
+
+        elif 'enterprise' in license_type and 'solver' in license_type:
+            license_type = 'meba'
+
+        elif 'premium' in license_type:
+            license_type = 'mech_2'
+
+        elif 'pro' in license_type:
+            license_type = 'mech_1'
+
+        elif license_type not in ALLOWABLE_LICENSES:
+            allow_lics = [f"'{each}'" for each in ALLOWABLE_LICENSES]
+            warn_text = \
+                f"The keyword argument 'license_type' value ('{license_type}') is not a recognized license name or has been deprecated.\n" + \
+                "Still PyMAPDL will try to use it but in older versions you might experience problems connecting to the server.\n" + \
+                f"Recognized license names: {' '.join(allow_lics)}"
+            warnings.warn(warn_text, UserWarning)
+
+        additional_switches += ' -p ' + license_type
+        LOG.debug(f"Using specified license name '{license_type}' in the 'license_type' keyword argument.")
+
+    elif '-p ' in additional_switches:
+        # There is already a license request in additional switches.
+        license_type = re.findall(r'-p \b(\w*)', additional_switches)[0]  # getting only the first product license.
+
+        if license_type not in ALLOWABLE_LICENSES:
+            allow_lics = [f"'{each}'" for each in ALLOWABLE_LICENSES]
+            warn_text = \
+                f"The additional switch product value ('-p {license_type}') is not a recognized license name or has been deprecated.\n" + \
+                "Still PyMAPDL will try to use it but in older versions you might experience problems connecting to the server.\n" + \
+                f"Recognized license names: {' '.join(allow_lics)}"
+            warnings.warn(warn_text, UserWarning)
+            LOG.warning(warn_text)
+
+        LOG.debug(f"Using specified license name '{license_type}' in the additional switches parameter.")
+
+    elif license_type is not None:
+        raise TypeError("The argument 'license_type' does only accept str or None.")
+
     start_parm = {
         "exec_file": exec_file,
         "run_location": run_location,

ansys/mapdl/core/licensing.py

@@ -14,7 +14,14 @@
 LIC_FILE_ENVAR = "ANSYSLMD_LICENSE_FILE"
 APP_NAME = "FEAT_ANSYS"  # TODO: We need to make sure this is the type of feature we need to checkout.
 LIC_TO_CHECK =  ["mech_1"]
-ALLOWABLE_LICENSES = ["ansys", "meba", "mech_2", "mech_1"]
+
+LICENSES = {
+    "ansys": "Ansys Mechanical Enterprise",
+    "meba": "Ansys Mechanical Enterprise Solver",
+    "mech_2": "Ansys Mechanical Premium",
+    "mech_1": "Ansys Mechanical Pro"
+}
+ALLOWABLE_LICENSES = list(LICENSES)
 
 ## Regarding license checking.
 # The available licenses we can check against are (in order of

tests/test_launcher.py

@@ -4,8 +4,9 @@
 
 import pytest
 from ansys.mapdl import core as pymapdl
-from ansys.mapdl.core.launcher import _version_from_path, get_start_instance, _validate_add_sw
+from ansys.mapdl.core.launcher import _version_from_path, get_start_instance, _validate_add_sw, launch_mapdl
 from ansys.mapdl.core.misc import get_ansys_bin
+from ansys.mapdl.core.licensing import LICENSES
 
 try:
     import ansys_corba  # noqa: F401
@@ -124,3 +125,64 @@ def test_launch_corba(version):
     mapdl_ref = weakref.ref(mapdl)
     del mapdl
     assert mapdl_ref() is None
+
+
+def test_license_type_keyword():
+    # This test might became a way to check available licenses, which is not the purpose.
+
+    checks = []
+    for license_name, license_description in LICENSES.items():
+        mapdl = launch_mapdl(license_type=license_name)
+
+        #Using first line to ensure not picking up other stuff.
+        checks.append(license_description in mapdl.__str__().split('\n')[0])
+        mapdl.exit()
+
+    breakpoint()
+    assert any(checks)
+
+    dummy_license_name = 'dummy'
+    # I had to scape the parenthesis because the match argument uses regex.
+    expected_warn = f"The keyword argument 'license_type' value \('{dummy_license_name}'\) is not a recognized license name or has been deprecated"
+    with pytest.warns(UserWarning, match=expected_warn):
+        mapdl = launch_mapdl(license_type=dummy_license_name)
+        # regardless the license specification, it should lunch.
+        assert mapdl.is_alive
+    mapdl.exit()
+
+
+def test_license_type_keyword_names():
+    # This test might became a way to check available licenses, which is not the purpose.
+
+    successful_check = False
+    for license_description, each_keyword in zip(LICENSES.values(), keywords):
+        mapdl = launch_mapdl(license_type=each_keyword)
+
+        #Using first line to ensure not picking up other stuff.
+        successful_check = license_description in mapdl.__str__().split('\n')[0] or successful_check
+        assert license_description in mapdl.__str__().split('\n')[0]
+        mapdl.exit()
+
+    assert successful_check # if at least one license is ok, this should be true.
+
+
+def test_license_type_additional_switch():
+    # This test might became a way to check available licenses, which is not the purpose.
+    successful_check = False
+    for license_name, license_description in LICENSES.items():
+        mapdl = launch_mapdl(additional_switches=' -p' + license_name)
+
+        #Using first line to ensure not picking up other stuff.
+        successful_check = license_description in mapdl.__str__().split('\n')[0] or successful_check
+        mapdl.exit()
+
+    assert successful_check # if at least one license is ok, this should be true.
+
+    dummy_license_name = 'dummy'
+    # I had to scape the parenthesis because the match argument uses regex.
+    expected_warn = f"The additional switch product value \('-p {dummy_license_name}'\) is not a recognized license name or has been deprecated"
+    with  pytest.warns(UserWarning, match=expected_warn):
+        mapdl = launch_mapdl(additional_switches=f' -p {dummy_license_name}')
+        # regardless the license specification, it should lunch.
+        assert mapdl.is_alive
+    mapdl.exit()