matlab-proxy 0.23.4__py3-none-any.whl → 0.24.2__py3-none-any.whl

matlab_proxy_manager/storage/server.py

@@ -1,9 +1,11 @@
-# Copyright 2024 The MathWorks, Inc.
+# Copyright 2024-2025 The MathWorks, Inc.
 import json
 from dataclasses import asdict, dataclass, field
 from pathlib import Path
 from typing import Optional
 
+import psutil
+
 from matlab_proxy_manager.utils import helpers, logger
 
 log = logger.get()
@@ -96,8 +98,31 @@ class ServerProcess:
             return shutdown_resp
         except Exception as e:
             log.debug("Exception while shutting down matlab proxy: %s", e)
+
+            # Force kill matlab-proxy and its process tree if termination
+            # via shutdown_integration endpoint fails
+            matlab_proxy_process = psutil.Process(int(self.pid))
+            self.terminate_process_tree(matlab_proxy_process)
             return None
 
+    def terminate_process_tree(self, matlab_proxy_process):
+        """
+        Terminates the process tree of the MATLAB proxy server.
+
+        This method terminates all child processes of the MATLAB proxy process,
+        waits for a short period, and then forcefully kills any remaining processes.
+        Finally, it kills the main MATLAB proxy process itself.
+        """
+        matlab_proxy_child_processes = matlab_proxy_process.children(recursive=True)
+        for child_process in matlab_proxy_child_processes:
+            child_process.terminate()
+        _, alive = psutil.wait_procs(matlab_proxy_child_processes, timeout=5)
+        for process in alive:
+            # Kill the processes which are alive even after waiting for 5 seconds
+            process.kill()
+        matlab_proxy_process.kill()
+        log.debug("Killed matlab-proxy process with PID: %s", self.pid)
+
     def is_server_alive(self) -> bool:
         """
         Checks if the server process is alive and ready.

tests/unit/conftest.py

@@ -1,7 +1,6 @@
 # Copyright 2020-2022 The MathWorks, Inc.
 
-""" The conftest.py file is run by the pytest framework for setting things up for the test session.
-"""
+"""The conftest.py file is run by the pytest framework for setting things up for the test session."""
 
 import os
 import shutil

tests/unit/test_app_state.py

@@ -1,4 +1,4 @@
-# Copyright 2023-2024 The MathWorks, Inc.
+# Copyright 2023-2025 The MathWorks, Inc.
 
 import asyncio
 import json
@@ -13,7 +13,11 @@ from matlab_proxy import settings
 from matlab_proxy import settings
 from matlab_proxy.app_state import AppState
 from matlab_proxy.constants import MWI_AUTH_TOKEN_NAME_FOR_HTTP
-from matlab_proxy.util.mwi.exceptions import LicensingError, MatlabError
+from matlab_proxy.util.mwi.exceptions import (
+    LicensingError,
+    MatlabError,
+    MatlabInstallError,
+)
 from matlab_proxy.constants import (
     CONNECTOR_SECUREPORT_FILENAME,
     USER_CODE_OUTPUT_FILE_NAME,
@@ -415,7 +419,7 @@ async def test_track_embedded_connector_posix(
     spy.assert_called_once()
 
 
-@pytest.mark.parametrize("platform", [("windows")])
+@pytest.mark.parametrize("platform", ["windows"])
 async def test_track_embedded_connector(mocker_os_patching_fixture, app_state_fixture):
     """Test to check track_embedded_connector task on windows.
 
@@ -611,6 +615,29 @@ async def test_start_matlab_without_xvfb(app_state_fixture, mocker):
     assert app_state_fixture.processes["matlab"] is mock_matlab
 
 
+async def test_start_matlab_without_xvfb_and_matlab(app_state_fixture):
+    """Test to check if MATLAB doesn't start and sets the error variable to MatlabInstallError when
+    there is not MATLAB on system PATH
+
+    Args:
+        app_state_fixture (AppState): Object of AppState class with defaults set
+    """
+    # Arrange
+    app_state_fixture.settings["is_xvfb_available"] = False
+    app_state_fixture.settings["matlab_cmd"] = None
+
+    # Act
+    await app_state_fixture.start_matlab()
+
+    # Assert
+    # Check if Xvfb has not started
+    assert app_state_fixture.processes["xvfb"] is None
+    # Check if Matlab has not started
+    assert app_state_fixture.processes["matlab"] is None
+    # Check if MatlabInstallError is set as the error
+    assert isinstance(app_state_fixture.error, MatlabInstallError)
+
+
 @pytest.mark.parametrize(
     "is_desktop, client_id, is_client_id_present, expected_is_active_client",
     [

tests/unit/test_settings.py

@@ -1,9 +1,9 @@
-# Copyright 2020-2024 The MathWorks, Inc.
+# Copyright 2020-2025 The MathWorks, Inc.
 
 import os
-import ssl
 import time
 import tempfile
+import platform
 
 import matlab_proxy
 import matlab_proxy.settings as settings
@@ -467,29 +467,208 @@ def test_get_ssl_context_with_invalid_custom_ssl_files_raises_exception(
 )
 def test_get_matlab_settings_custom_code(
     monkeypatch,
-    mocker,
     expected_value_for_has_custom_code,
     custom_code,
     has_custom_code_exception_matlab_cmd,
 ):
     # Arrange
     monkeypatch.setenv(mwi_env.get_env_name_custom_matlab_code(), custom_code)
+
+    # Act
+    has_custom_code, code_to_execute = settings._get_matlab_code_to_execute()
+    exception_present_in_matlab_cmd = "MATLABCustomStartupCodeError" in code_to_execute
+
+    # Assert
+    assert has_custom_code == expected_value_for_has_custom_code
+    assert exception_present_in_matlab_cmd == has_custom_code_exception_matlab_cmd
+
+
+def test_get_nlm_conn_str(monkeypatch):
+    # Arrange
+    test_nlm_str = "123@license_server_address"
+    monkeypatch.setenv(mwi_env.get_env_name_network_license_manager(), test_nlm_str)
+
+    # Act
+    nlm_conn_str = settings._get_nlm_conn_str()
+
+    # Assert
+    assert nlm_conn_str == test_nlm_str
+
+
+@pytest.mark.parametrize("ws_env_suffix", ["", "-dev", "-test"])
+def test_get_mw_licensing_urls(ws_env_suffix):
+    # Act
+    urls = settings._get_mw_licensing_urls(ws_env_suffix)
+
+    # Assert
+    assert all(ws_env_suffix in url for url in urls.values())
+
+
+@pytest.mark.parametrize("nlm_conn_str", [None, "1234@testserver"])
+def test_get_matlab_cmd_posix(nlm_conn_str, mocker):
+    # Arrange
+    matlab_executable_path = "/path/to/matlab"
+    code_to_execute = "disp('Test')"
+    mocker.patch("matlab_proxy.settings.system.is_windows", return_value=False)
+
+    # Act
+    cmd = settings._get_matlab_cmd(
+        matlab_executable_path, code_to_execute, nlm_conn_str
+    )
+
+    # Assert
+    assert cmd[0] == matlab_executable_path
+    assert "-noDisplayDesktop" not in cmd
+
+    if nlm_conn_str:
+        assert "-licmode" in cmd
+        assert "file" in cmd
+    else:
+        assert "-licmode" not in cmd
+
+
+def test_get_matlab_cmd_windows(mocker):
+    # Arrange
+    matlab_executable_path = "C:\\path\\to\\matlab.exe"
+    code_to_execute = "disp('Test')"
+    mocker.patch("matlab_proxy.settings.system.is_windows", return_value=True)
+
+    # Act
+    cmd = settings._get_matlab_cmd(matlab_executable_path, code_to_execute, None)
+
+    # Assert
+    assert "-noDisplayDesktop" in cmd
+    assert "-wait" in cmd
+    assert "-log" in cmd
+    assert ".exe" in cmd[0]  # Assert .exe suffix in matlab_executable_path
+
+
+def test_get_matlab_cmd_with_mpa_flags(mocker):
+    # Arrange
     mocker.patch(
-        "matlab_proxy.settings.get_matlab_executable_and_root_path",
-        return_value=("matlab", None),
+        "matlab_proxy.settings.mwi_env.Experimental.is_mpa_enabled", return_value=True
     )
+    matlab_executable_path = "/path/to/matlab"
+    code_to_execute = "disp('Test')"
+
+    # Act
+    cmd = settings._get_matlab_cmd(matlab_executable_path, code_to_execute, None)
+
+    # Assert
+    assert all(mpa_flag in cmd for mpa_flag in mwi_env.Experimental.get_mpa_flags())
+
+
+def test_get_matlab_cmd_with_startup_profiling(mocker):
+    # Arrange
+    mocker.patch("matlab_proxy.settings.system.is_windows", return_value=False)
+    mocker.patch(
+        "matlab_proxy.settings.mwi_env.Experimental.is_matlab_startup_profiling_enabled",
+        return_value=True,
+    )
+
+    matlab_executable_path = "/path/to/matlab"
+    code_to_execute = "disp('Test')"
+
+    # Act
+    cmd = settings._get_matlab_cmd(matlab_executable_path, code_to_execute, None)
+
+    # Assert
+    assert "-timing" in cmd
+
+
+def test_get_matlab_settings_no_matlab_on_path(mocker):
+    # Arrange
+    mocker.patch("matlab_proxy.settings.shutil.which", return_value=None)
 
     # Act
     matlab_settings = settings.get_matlab_settings()
-    exception_present_in_matlab_cmd = (
-        "MATLABCustomStartupCodeError" in matlab_settings["matlab_cmd"][-1]
+
+    # Assert
+    assert isinstance(matlab_settings["error"], MatlabInstallError)
+
+
+def test_get_matlab_settings_matlab_softlink(mocker, tmp_path):
+    # Arrange
+    matlab_root_path = Path(tmp_path)
+    matlab_exec_path = matlab_root_path / "bin" / "matlab"
+    mocker.patch("matlab_proxy.settings.shutil.which", return_value=matlab_exec_path)
+    mocker.patch(
+        "matlab_proxy.settings.mwi.validators.validate_matlab_root_path",
+        return_value=matlab_root_path,
     )
-    print(matlab_settings)
+
+    # Act
+    matlab_settings = settings.get_matlab_settings()
+
+    # Assert
+    assert str(matlab_exec_path) in str(matlab_settings["matlab_cmd"][0])
+    assert matlab_settings["matlab_path"] == matlab_root_path
+    assert (
+        matlab_settings["matlab_version"] is None
+    )  # There's no VersionInfo.xml file in the mock setup
+
+
+def test_get_matlab_settings_matlab_wrapper(mocker, tmp_path):
+    # Arrange
+    matlab_exec_path = Path(tmp_path) / "matlab"
+    mocker.patch("matlab_proxy.settings.shutil.which", return_value=matlab_exec_path)
+
+    # Act
+    matlab_settings = settings.get_matlab_settings()
 
     # Assert
+    assert str(matlab_exec_path) in str(matlab_settings["matlab_cmd"][0])
+    assert (
+        matlab_settings["matlab_path"] is None
+    )  # Matlab root could not be determined because wrapper script is being used
+    assert matlab_settings["matlab_version"] is None
     assert (
-        matlab_settings["has_custom_code_to_execute"]
-        == expected_value_for_has_custom_code
+        matlab_settings["error"] is None
+    )  # Error has to be None when matlab executable is on PATH but root path could not be determined
+
+
+def test_get_matlab_settings_valid_custom_matlab_root(mocker, monkeypatch, tmp_path):
+    # Arrange
+    matlab_root_path = Path(tmp_path)
+    matlab_exec_path = matlab_root_path / "bin" / "matlab"
+    matlab_version = "R2024b"
+    monkeypatch.setenv(mwi_env.get_env_name_custom_matlab_root(), str(matlab_root_path))
+    mocker.patch(
+        "matlab_proxy.settings.mwi.validators.validate_matlab_root_path",
+        return_value=matlab_root_path,
+    )
+    mocker.patch(
+        "matlab_proxy.settings.get_matlab_version", return_value=matlab_version
     )
 
-    assert exception_present_in_matlab_cmd == has_custom_code_exception_matlab_cmd
+    # Act
+    matlab_settings = settings.get_matlab_settings()
+
+    # Assert
+    assert str(matlab_exec_path) in str(matlab_settings["matlab_cmd"][0])
+    assert matlab_settings["matlab_path"] == matlab_root_path
+    assert matlab_settings["matlab_version"] == matlab_version
+    assert matlab_settings["error"] is None
+
+
+def test_get_matlab_settings_invalid_custom_matlab_root(mocker, monkeypatch, tmp_path):
+    # Arrange
+    matlab_root_path = Path(tmp_path)
+    monkeypatch.setenv(mwi_env.get_env_name_custom_matlab_root(), str(matlab_root_path))
+
+    # Act
+    matlab_settings = settings.get_matlab_settings()
+
+    # Assert
+    # When custom MATLAB root is supplied, it must be the actual MATLAB root ie.
+    # VersionInfo.xml file must to be there
+    # matlab executable inside the bin folder must be there
+    # If not, MATLAB related settings should be None and custom MATLAB root error should be present
+    assert matlab_settings["matlab_cmd"] is None
+    assert matlab_settings["matlab_path"] is None
+    assert matlab_settings["matlab_version"] is None
+    assert (
+        isinstance(matlab_settings["error"], MatlabInstallError)
+        and mwi_env.get_env_name_custom_matlab_root()
+        in matlab_settings["error"].message
+    )

tests/unit/util/mwi/test_logger.py

@@ -1,6 +1,5 @@
 # Copyright 2020-2024 The MathWorks, Inc.
-"""This file tests methods present in matlab_proxy/util/mwi_logger.py
-"""
+"""This file tests methods present in matlab_proxy/util/mwi_logger.py"""
 
 import logging
 import os

tests/unit/util/mwi/test_validators.py

@@ -1,4 +1,4 @@
-# Copyright 2020-2024 The MathWorks, Inc.
+# Copyright 2020-2025 The MathWorks, Inc.
 
 """Tests for functions in matlab_proxy/util/mwi_validators.py"""
 
@@ -295,7 +295,7 @@ def test_validate_matlab_root_path(tmp_path):
     assert actual_matlab_root_custom == matlab_root
 
 
-def test_validate_matlab_root_path_invalid_root_path(tmp_path):
+def test_validate_matlab_root_path_non_existent_root_path(tmp_path):
     """Checks if validate_matlab_root_path raises MatlabInstallError when non-existent path is supplied"""
     # Arrange
     matlab_root = Path(tmp_path) / "MATLAB"
@@ -315,22 +315,27 @@ def test_validate_matlab_root_path_invalid_root_path(tmp_path):
 
 
 def test_validate_matlab_root_path_non_existent_versioninfo_file(tmp_path):
-    """Checks if validate_matlab_root_path does not raise any exceptions even if VersionInfo.xml file does not exist"""
+    """Checks if validate_matlab_root_path does not raise any exceptions even if VersionInfo.xml file does not exist
+    when matlab wrapper is used and raises an exception when custom matlab root is used.
+    """
     # Arrange
     matlab_root = Path(tmp_path) / "MATLAB"
     os.mkdir(matlab_root)
 
     # Act
+    # Location of VersionInfo.xml can't be determined with matlab wrapper script
+    # and error should not be raised
     actual_matlab_root = validate_matlab_root_path(
         matlab_root, is_custom_matlab_root=False
     )
-    actual_matlab_root_custom = validate_matlab_root_path(
-        matlab_root, is_custom_matlab_root=True
-    )
+
+    # Location of VersionInfo.xml must be determinable when custom MATLAB root is supplied.
+    # If not, an exception must be raised
+    with pytest.raises(MatlabInstallError):
+        validate_matlab_root_path(matlab_root, is_custom_matlab_root=True)
 
     # Assert
     assert actual_matlab_root is None
-    assert actual_matlab_root_custom is None
 
 
 @pytest.mark.parametrize(

matlab_proxy/gui/asset-manifest.json

@@ -1,44 +0,0 @@
-{
-  "files": {
-    "main.css": "./static/css/main.efa05ff9.css",
-    "main.js": "./static/js/main.ce0f5505.js",
-    "static/media/mathworks-pictograms.svg?20181009": "./static/media/mathworks-pictograms.f6f087b008b5a9435f26.svg",
-    "static/media/MATLAB-env-blur.png": "./static/media/MATLAB-env-blur.4fc94edbc82d3184e5cb.png",
-    "static/media/mathworks.svg?20181004": "./static/media/mathworks.80a3218e1ba29f0573fb.svg",
-    "static/media/glyphicons-halflings-regular.svg": "./static/media/glyphicons-halflings-regular.060b2710bdbbe3dfe48b.svg",
-    "static/media/mathworks-pictograms.woff?20181009": "./static/media/mathworks-pictograms.3fc6513a06dce552eeb1.woff",
-    "static/media/mathworks-pictograms.ttf?20181009": "./static/media/mathworks-pictograms.6e128c0e7fc1a11f92ee.ttf",
-    "static/media/glyphicons-halflings-regular.ttf": "./static/media/glyphicons-halflings-regular.4692b9ec53fd5972caa2.ttf",
-    "static/media/mathworks.woff?20181004": "./static/media/mathworks.37a563ef6aeda1593bf6.woff",
-    "static/media/mathworks.ttf?20181004": "./static/media/mathworks.c422935b9ae545ac2ab5.ttf",
-    "static/media/glyphicons-halflings-regular.woff": "./static/media/glyphicons-halflings-regular.82b1212e45a2bc35dd73.woff",
-    "static/media/glyphicons-halflings-regular.eot": "./static/media/glyphicons-halflings-regular.5be1347c682810f199c7.eot",
-    "static/media/glyphicons-halflings-regular.woff2": "./static/media/glyphicons-halflings-regular.be810be3a3e14c682a25.woff2",
-    "static/media/mathworks-eps.svg?20181004": "./static/media/mathworks-eps.df1428dfa69cea896c05.svg",
-    "static/media/ico-sprite.png": "./static/media/ico-sprite.cbdb66c0ea4c2a7fd21c.png",
-    "static/media/mathworks-eps.woff?20181004": "./static/media/mathworks-eps.e5c41e8478df02cbdce1.woff",
-    "static/media/mathworks-eps.ttf?20181004": "./static/media/mathworks-eps.4d20e0ee46ea74bccfc1.ttf",
-    "static/media/trigger-error.svg": "./static/media/trigger-error.3f1c4ef23ab8f3e60b0e.svg",
-    "static/media/trigger-ok.svg": "./static/media/trigger-ok.7b9c238be42f685c4fa7.svg",
-    "static/media/ico-header-account-hover.svg": "./static/media/ico-header-account-hover.89438e91d0632893b106.svg",
-    "static/media/ico-header-account.svg": "./static/media/ico-header-account.86b10d7b4a2a511f6ca9.svg",
-    "static/media/feedback.svg": "./static/media/feedback.6e8d50eb812cf35e0e76.svg",
-    "static/media/terminate.svg": "./static/media/terminate.7ea1363ee0fa72344ef6.svg",
-    "static/media/help.svg": "./static/media/help.15e5bfab03a2b9c7148e.svg",
-    "static/media/ico-header-contact-hover.svg": "./static/media/ico-header-contact-hover.0958c44200d781def822.svg",
-    "static/media/ico-header-contact.svg": "./static/media/ico-header-contact.ae9169c8dcae37c6e04b.svg",
-    "static/media/restart.svg": "./static/media/restart.7987508a01e84678361a.svg",
-    "static/media/stop.svg": "./static/media/stop.30c9a9ab6d625032235a.svg",
-    "static/media/sign-out.svg": "./static/media/sign-out.08356b675ec854afaa77.svg",
-    "static/media/start.svg": "./static/media/start.50c4596fab2049b4a3a3.svg",
-    "index.html": "./index.html",
-    "static/media/gripper.svg": "./static/media/gripper.9defbc5e76d0de8bb6e0.svg",
-    "static/media/arrow.svg": "./static/media/arrow.0c2968b90bd9a64c8c3f.svg",
-    "main.efa05ff9.css.map": "./static/css/main.efa05ff9.css.map",
-    "main.ce0f5505.js.map": "./static/js/main.ce0f5505.js.map"
-  },
-  "entrypoints": [
-    "static/css/main.efa05ff9.css",
-    "static/js/main.ce0f5505.js"
-  ]
-}