matlab-proxy 0.24.1__py3-none-any.whl → 0.25.0__py3-none-any.whl

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,193 @@ 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_startup_profiling(mocker):
+    # Arrange
+    mocker.patch("matlab_proxy.settings.system.is_windows", return_value=False)
     mocker.patch(
-        "matlab_proxy.settings.get_matlab_executable_and_root_path",
-        return_value=("matlab", None),
+        "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_token_auth.py

@@ -1,4 +1,4 @@
-# Copyright 2023-2024 The MathWorks, Inc.
+# Copyright 2023-2025 The MathWorks, Inc.
 
 import pytest
 from aiohttp import web
@@ -90,7 +90,7 @@ async def fake_endpoint(request):
 
 @pytest.fixture
 def fake_server_with_auth_enabled(
-    loop, aiohttp_client, monkeypatch, get_custom_auth_token_str
+    event_loop, aiohttp_client, monkeypatch, get_custom_auth_token_str
 ):
     auth_token = get_custom_auth_token_str
     auth_enablement = "True"
@@ -120,7 +120,7 @@ def fake_server_with_auth_enabled(
     aiohttp_session_setup(
         app, EncryptedCookieStorage(f, cookie_name="matlab-proxy-session")
     )
-    return loop.run_until_complete(aiohttp_client(app))
+    return event_loop.run_until_complete(aiohttp_client(app))
 
 
 async def test_set_value_with_token(
@@ -256,7 +256,7 @@ async def test_get_value_with_token_in_query_params(
 
 
 @pytest.fixture
-def fake_server_without_auth_enabled(loop, aiohttp_client, monkeypatch):
+def fake_server_without_auth_enabled(event_loop, aiohttp_client, monkeypatch):
     auth_enablement = "False"
     monkeypatch.setenv(
         mwi_env.get_env_name_enable_mwi_auth_token(), str(auth_enablement)
@@ -281,7 +281,7 @@ def fake_server_without_auth_enabled(loop, aiohttp_client, monkeypatch):
     aiohttp_session_setup(
         app, EncryptedCookieStorage(f, cookie_name="matlab-proxy-session")
     )
-    return loop.run_until_complete(aiohttp_client(app))
+    return event_loop.run_until_complete(aiohttp_client(app))
 
 
 async def test_get_value(fake_server_without_auth_enabled):

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(

tests/unit/util/test_mw.py

@@ -1,4 +1,4 @@
-# Copyright 2020-2023 The MathWorks, Inc.
+# Copyright 2020-2025 The MathWorks, Inc.
 
 import datetime
 import random
@@ -519,7 +519,7 @@ def test_range_matlab_connector_ports():
     not system.is_linux(),
     reason="Xvfb is only required on linux based operating systems",
 )
-async def test_create_xvfb_process(loop):
+async def test_create_xvfb_process(event_loop):
     """Test to check if more than 1 xvfb process can be created with -displayfd flag
 
     Creates 2 xvfb processes with '-displayfd' flag and  checks if the processes are

tests/unit/util/test_util.py

@@ -1,4 +1,4 @@
-# Copyright 2020-2024 The MathWorks, Inc.
+# Copyright 2020-2025 The MathWorks, Inc.
 
 import asyncio
 import pytest
@@ -19,19 +19,19 @@ def test_get_supported_termination_signals():
     assert len(system.get_supported_termination_signals()) >= 1
 
 
-def test_add_signal_handlers(loop: asyncio.AbstractEventLoop):
-    """Test to check if signal handlers are being added to asyncio loop
+def test_add_signal_handlers(event_loop: asyncio.AbstractEventLoop):
+    """Test to check if signal handlers are being added to asyncio event_loop
 
     Args:
-        loop (asyncio loop): In built-in pytest fixture.
+        event_loop (asyncio event loop): built-in pytest fixture.
     """
 
-    loop = add_signal_handlers(loop)
+    event_loop = add_signal_handlers(event_loop)
 
     # In posix systems, event loop is modified with new signal handlers
     if system.is_posix():
-        assert loop._signal_handlers is not None
-        assert loop._signal_handlers.items() is not None
+        assert event_loop._signal_handlers is not None
+        assert event_loop._signal_handlers.items() is not None
 
     else:
         import signal