Injecting env vars in MAPDL process (#1219)

* First commit. Implementation + tests

* increasing coverage

* reordering tests to run some

* Now tests in test_launcher needs to be individually skipped.

* Apply suggestions from code review

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

Author: germa89

src/ansys/mapdl/core/launcher.py

@@ -220,6 +220,8 @@ def launch_grpc(
     override=True,
     timeout=20,
     verbose=False,
+    add_env_vars=None,
+    replace_env_vars=None,
     **kwargs,
 ) -> tuple:  # pragma: no cover
     """Start MAPDL locally in gRPC mode.
@@ -496,9 +498,14 @@ def launch_grpc(
             ]
         )
         command = " ".join(command_parm)
+
+    env_vars = update_env_vars(add_env_vars, replace_env_vars)
+
     LOG.info(f"Running in {ip}:{port} the following command: '{command}'")
-    if verbose:
-        subprocess.Popen(command, shell=os.name != "nt", cwd=run_location)
+
+    if verbose:  # pragma: no cover
+        subprocess.Popen(command, shell=os.name != "nt", cwd=run_location, env=env_vars)
+
     else:
         subprocess.Popen(
             command,
@@ -507,6 +514,7 @@ def launch_grpc(
             stdin=subprocess.DEVNULL,
             stdout=subprocess.DEVNULL,
             stderr=subprocess.DEVNULL,
+            env=env_vars,
         )
 
     # watch for the creation of temporary files at the run_directory.
@@ -978,6 +986,8 @@ def launch_mapdl(
     license_server_check=True,
     license_type=None,
     print_com=False,
+    add_env_vars=None,
+    replace_env_vars=None,
     **kwargs,
 ) -> _MapdlCore:
     """Start MAPDL locally.
@@ -1109,6 +1119,16 @@ def launch_mapdl(
         Print the command ``/COM`` arguments to the standard output.
         Default ``False``.
 
+    add_env_vars : dict, optional
+        The provided dictionary will be used to extend the system or process
+        environment variables. If you want to control all of the environment
+        variables, use ``replace_env_vars``. Defaults to ``None``.
+
+    replace_env_vars : dict, optional
+        The provided dictionary will be used to replace all the system or process
+        environment variables. To just add some environment variables to the MAPDL
+        process, use ``add_env_vars``. Defaults to ``None``.
+
     Returns
     -------
     ansys.mapdl.core.mapdl._MapdlCore
@@ -1483,7 +1503,12 @@ def launch_mapdl(
             )
         elif mode == "grpc":
             port, actual_run_location = launch_grpc(
-                port=port, verbose=verbose_mapdl, ip=ip, **start_parm
+                port=port,
+                verbose=verbose_mapdl,
+                ip=ip,
+                add_env_vars=add_env_vars,
+                replace_env_vars=replace_env_vars,
+                **start_parm,
             )
             mapdl = MapdlGrpc(
                 ip=ip,
@@ -1567,3 +1592,48 @@ def check_mode(mode, version):
         warnings.warn("MAPDL as a service has not been tested on MAPDL < v13")
 
     return mode
+
+
+def update_env_vars(add_env_vars, replace_env_vars):
+    """
+    Update environment variables for the MAPDL process.
+
+    Parameters
+    ----------
+    add_env_vars : dict, None
+        Dictionary with a mapping of env variables.
+    replace_env_vars : dict, None
+        Dictionary with a mapping of env variables.
+
+    Raises
+    ------
+    TypeError
+        'add_env_vars' and 'replace_env_vars' are incompatible. Please provide only one.
+    TypeError
+        The variable 'add_env_vars' should be a dict with env vars.
+    TypeError
+        The variable 'replace_env_vars' should be a dict with env vars.
+    """
+
+    # Expanding/replacing env variables for the process.
+    if add_env_vars and replace_env_vars:
+        raise ValueError(
+            "'add_env_vars' and 'replace_env_vars' are incompatible. Please provide only one."
+        )
+
+    elif add_env_vars:
+        if not isinstance(add_env_vars, dict):
+            raise TypeError(
+                "The variable 'add_env_vars' should be a dict with env vars."
+            )
+
+        add_env_vars.update(os.environ)
+        return add_env_vars
+
+    elif replace_env_vars:
+        if not isinstance(replace_env_vars, dict):
+            raise TypeError(
+                "The variable 'replace_env_vars' should be a dict with env vars."
+            )
+
+        return replace_env_vars

tests/test_launcher.py

@@ -13,6 +13,7 @@
     is_valid_executable_path,
     launch_mapdl,
     save_ansys_path,
+    update_env_vars,
     warn_uncommon_executable_path,
 )
 from ansys.mapdl.core.licensing import LICENSES
@@ -50,9 +51,6 @@
 
 V150_EXEC = get_ansys_bin("150")
 
-if not valid_versions:
-    pytestmark = pytest.mark.skip("Requires MAPDL")
-
 paths = [
     ("/usr/dir_v2019.1/slv/ansys_inc/v211/ansys/bin/ansys211", 211),
     ("C:/Program Files/ANSYS Inc/v202/ansys/bin/win64/ANSYS202.exe", 202),
@@ -63,6 +61,7 @@
 @pytest.mark.skipif(
     not get_start_instance(), reason="Skip when start instance is disabled"
 )
+@pytest.mark.skipif(not valid_versions, reason="Requires MAPDL installed.")
 @pytest.mark.skipif(os.name != "nt", reason="Requires Windows")
 def test_validate_sw():
     # ensure that windows adds msmpi
@@ -75,6 +74,7 @@ def test_validate_sw():
 @pytest.mark.skipif(
     not get_start_instance(), reason="Skip when start instance is disabled"
 )
+@pytest.mark.skipif(not valid_versions, reason="Requires MAPDL installed.")
 @pytest.mark.parametrize("path_data", paths)
 def test_version_from_path(path_data):
     exec_file, version = path_data
@@ -84,6 +84,7 @@ def test_version_from_path(path_data):
 @pytest.mark.skipif(
     not get_start_instance(), reason="Skip when start instance is disabled"
 )
+@pytest.mark.skipif(not valid_versions, reason="Requires MAPDL installed.")
 def test_catch_version_from_path():
     with pytest.raises(RuntimeError):
         _version_from_path("abc")
@@ -92,8 +93,8 @@ def test_catch_version_from_path():
 @pytest.mark.skipif(
     not get_start_instance(), reason="Skip when start instance is disabled"
 )
+@pytest.mark.skipif(not valid_versions, reason="Requires MAPDL installed.")
 @pytest.mark.skipif(os.name != "posix", reason="Requires Linux")
-@pytest.mark.skipif(not versions, reason="Requires ANSYS install")
 def test_find_ansys_linux():
     # assuming ansys is installed, should be able to find it on linux
     # without env var
@@ -105,6 +106,7 @@ def test_find_ansys_linux():
 @pytest.mark.skipif(
     not get_start_instance(), reason="Skip when start instance is disabled"
 )
+@pytest.mark.skipif(not valid_versions, reason="Requires MAPDL installed.")
 def test_invalid_mode():
     with pytest.raises(ValueError):
         exec_file = get_ansys_bin(valid_versions[0])
@@ -114,6 +116,7 @@ def test_invalid_mode():
 @pytest.mark.skipif(
     not get_start_instance(), reason="Skip when start instance is disabled"
 )
+@pytest.mark.skipif(not valid_versions, reason="Requires MAPDL installed.")
 @pytest.mark.skipif(not os.path.isfile(V150_EXEC), reason="Requires v150")
 def test_old_version():
     exec_file = get_ansys_bin("150")
@@ -124,6 +127,7 @@ def test_old_version():
 @pytest.mark.skipif(
     not get_start_instance(), reason="Skip when start instance is disabled"
 )
+@pytest.mark.skipif(not valid_versions, reason="Requires MAPDL installed.")
 @pytest.mark.skipif(not os.name == "nt", reason="Requires windows")
 @pytest.mark.console
 def test_failed_console():
@@ -135,6 +139,7 @@ def test_failed_console():
 @pytest.mark.skipif(
     not get_start_instance(), reason="Skip when start instance is disabled"
 )
+@pytest.mark.skipif(not valid_versions, reason="Requires MAPDL installed.")
 @pytest.mark.parametrize("version", valid_versions)
 @pytest.mark.console
 @pytest.mark.skipif(os.name != "posix", reason="Only supported on Linux")
@@ -147,6 +152,7 @@ def test_launch_console(version):
 @pytest.mark.skipif(
     not get_start_instance(), reason="Skip when start instance is disabled"
 )
+@pytest.mark.skipif(not valid_versions, reason="Requires MAPDL installed.")
 @pytest.mark.corba
 @pytest.mark.parametrize("version", valid_versions)
 def test_launch_corba(version):
@@ -163,6 +169,7 @@ def test_launch_corba(version):
 @pytest.mark.skipif(
     not get_start_instance(), reason="Skip when start instance is disabled"
 )
+@pytest.mark.skipif(not valid_versions, reason="Requires MAPDL installed.")
 def test_license_type_keyword():
     # This test might became a way to check available licenses, which is not the purpose.
 
@@ -189,6 +196,7 @@ def test_license_type_keyword():
 @pytest.mark.skipif(
     not get_start_instance(), reason="Skip when start instance is disabled"
 )
+@pytest.mark.skipif(not valid_versions, reason="Requires MAPDL installed.")
 def test_license_type_keyword_names():
     # This test might became a way to check available licenses, which is not the purpose.
 
@@ -209,6 +217,7 @@ def test_license_type_keyword_names():
 @pytest.mark.skipif(
     not get_start_instance(), reason="Skip when start instance is disabled"
 )
+@pytest.mark.skipif(not valid_versions, reason="Requires MAPDL installed.")
 def test_license_type_additional_switch():
     # This test might became a way to check available licenses, which is not the purpose.
     successful_check = False
@@ -233,6 +242,7 @@ def test_license_type_additional_switch():
     mapdl.exit()
 
 
+@pytest.mark.skipif(not valid_versions, reason="Requires MAPDL installed.")
 @pytest.mark.parametrize(
     "exe_loc",
     [
@@ -246,6 +256,7 @@ def test_save_ansys_path(exe_loc):
     assert os.path.exists(path_)
 
 
+@pytest.mark.skipif(not valid_versions, reason="Requires MAPDL installed.")
 @pytest.mark.parametrize(
     "file,result",
     [
@@ -265,6 +276,7 @@ def test_is_valid_executable_path(tmpdir, file, result):
     assert is_valid_executable_path(filename) == result
 
 
+@pytest.mark.skipif(not valid_versions, reason="Requires MAPDL installed.")
 @pytest.mark.parametrize(
     "file_path,result",
     [
@@ -301,6 +313,26 @@ def test_warn_uncommon_executable_path():
         warn_uncommon_executable_path("")
 
 
+def test_env_injection():
+
+    assert update_env_vars(None, None) is None
+
+    assert "myenvvar" in update_env_vars({"myenvvar": "True"}, None)
+
+    _env_vars = update_env_vars(None, {"myenvvar": "True"})
+    assert len(_env_vars) == 1
+    assert "myenvvar" in _env_vars
+
+    with pytest.raises(ValueError):
+        update_env_vars({"myenvvar": "True"}, {"myenvvar": "True"})
+
+    with pytest.raises(TypeError):
+        update_env_vars("asdf", None)
+
+    with pytest.raises(TypeError):
+        update_env_vars(None, "asdf")
+
+
 @pytest.mark.requires_gui
 def test_open_gui(mapdl):