Includes HOSTNAME in the directory structure into which matlab-proxy stores logs. This fixes issues related to mounted HOME folders in multi-host environments.

fixes #27

Author: diningPhilosopher64

matlab_proxy/settings.py

@@ -132,8 +132,22 @@ def get_ws_env_settings():
 def get_mwi_config_folder(dev=False):
     if dev:
         return get_test_temp_dir()
+
     else:
-        return Path.home() / ".matlab" / "MWI"
+        config_folder_path = Path.home() / ".matlab" / "MWI"
+        # In multi-host environments, Path.home() can be the same for
+        # multiple hosts and can cause issues when different hosts launch
+        # matlab-proxy on the same port.
+        # Using hostname to be part of the path of the config folder would avoid collisions.
+        hostname = socket.gethostname()
+        if hostname:
+            config_folder_path = config_folder_path / "hosts" / hostname
+
+        logger.debug(
+            f"{'Hostname could not be determined. ' if not hostname else '' }Using the folder: {config_folder_path} for storing all matlab-proxy related session information"
+        )
+
+        return config_folder_path
 
 
 def get_mwi_logs_root_dir(dev=False):

tests/unit/test_devel.py

@@ -34,13 +34,20 @@ def matlab_log_dir_fixture(monkeypatch, tmp_path):
         monkeypatch : A built-in pytest fixture.
         tmp_path: tmp_path fixture provides a temporary directory unique to the test invocation.
     """
-    matlab_log_dir = str(tmp_path)
-    monkeypatch.setenv("MATLAB_LOG_DIR", matlab_log_dir)
+    hostname = socket.gethostname()
+    matlab_log_dir = Path(tmp_path)
+
+    if hostname:
+        matlab_log_dir = matlab_log_dir / "hosts" / hostname
+        matlab_log_dir.mkdir(parents=True, exist_ok=True)
+
+    monkeypatch.setenv("MATLAB_LOG_DIR", str(matlab_log_dir))
+
     return matlab_log_dir
 
 
 @pytest.fixture(name="matlab_ready_file")
-def matlab_ready_file_fixture(matlab_log_dir, monkeypatch):
+def matlab_ready_file_fixture(matlab_log_dir):
     """A pytest fixture to create the matlab_ready_file.
 
     This fixture creates the matlab readyfile path based on the matlab_log_dir fixture output.
@@ -124,8 +131,7 @@ def matlab_process_valid_nlm_fixture(matlab_log_dir, matlab_process_setup, valid
     """
 
     matlab_process = subprocess.Popen(
-        matlab_process_setup.matlab_cmd,
-        stderr=subprocess.PIPE,
+        matlab_process_setup.matlab_cmd, stderr=subprocess.PIPE
     )
 
     yield

tests/unit/test_settings.py

@@ -2,6 +2,7 @@
 
 import os
 import time
+import tempfile
 
 import matlab_proxy
 import matlab_proxy.settings as settings
@@ -324,3 +325,51 @@ def test_get_process_timeout(timeout_value, monkeypatch):
 
     # Assert
     assert expected_timeout == actual_timeout
+
+
+def test_get_mwi_config_folder_dev():
+    ## Arrange
+    expected_config_dir = Path(tempfile.gettempdir()) / "MWI" / "tests"
+
+    # Act
+    actual_config_dir = settings.get_mwi_config_folder(dev=True)
+
+    # Assert
+    assert expected_config_dir == actual_config_dir
+
+
+@pytest.mark.parametrize(
+    "hostname, home, expected_mwi_config_dir",
+    [
+        (
+            "bob",
+            Path("/home/bob"),
+            Path("/home/bob") / ".matlab" / "MWI" / "hosts" / "bob",
+        ),
+        (
+            "bob",
+            Path("/home/CommonProject"),
+            Path("/home/CommonProject") / ".matlab" / "MWI" / "hosts" / "bob",
+        ),
+        (
+            None,
+            Path("/home/CommonProject"),
+            Path("/home/CommonProject") / ".matlab" / "MWI",
+        ),
+    ],
+    ids=[
+        "Single host machine with unique $HOME per host",
+        "Multi-host machine with common $HOME for multiple hosts",
+        "default directory when hostname is missing",
+    ],
+)
+def test_get_mwi_config_folder(mocker, hostname, home, expected_mwi_config_dir):
+    # Arrange
+    mocker.patch("matlab_proxy.settings.Path.home", return_value=home)
+    mocker.patch("matlab_proxy.settings.socket.gethostname", return_value=hostname)
+
+    # Act
+    actual_config_dir = settings.get_mwi_config_folder()
+
+    # Assert
+    assert expected_mwi_config_dir == actual_config_dir