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

tests/unit/test_app.py

@@ -1,4 +1,4 @@
-# Copyright 2020-2024 The MathWorks, Inc.
+# Copyright 2020-2025 The MathWorks, Inc.
 
 import asyncio
 import datetime
@@ -9,13 +9,18 @@ import time
 from datetime import timedelta, timezone
 from http import HTTPStatus
 
-import aiohttp
 import pytest
-import tests.unit.test_constants as test_constants
+from aiohttp import WSMsgType
+from aiohttp.web import WebSocketResponse
+from multidict import CIMultiDict
 
+import tests.unit.test_constants as test_constants
 from matlab_proxy import app, util
+from matlab_proxy.app import matlab_view
 from matlab_proxy.util.mwi import environment_variables as mwi_env
 from matlab_proxy.util.mwi.exceptions import EntitlementError, MatlabInstallError
+from tests.unit.fixtures.fixture_auth import patch_authenticate_access_decorator
+from tests.unit.mocks.mock_client import MockWebSocketClient
 
 
 @pytest.mark.parametrize(
@@ -61,7 +66,7 @@ def test_configure_no_proxy_in_env(monkeypatch, no_proxy_user_configuration):
     )
 
 
-def test_create_app(loop):
+def test_create_app(event_loop):
     """Test if aiohttp server is being created successfully.
 
     Checks if the aiohttp server is created successfully, routes, startup and cleanup
@@ -75,7 +80,7 @@ def test_create_app(loop):
     # Verify app server has a cleanup task
     # By default there is 1 for clean up task
     assert len(test_server.on_cleanup) > 1
-    loop.run_until_complete(test_server["state"].stop_server_tasks())
+    event_loop.run_until_complete(test_server["state"].stop_server_tasks())
 
 
 def get_email():
@@ -245,9 +250,33 @@ class FakeServer:
         self.loop.run_until_complete(self.server.cleanup())
 
 
+@pytest.fixture
+def mock_request(mocker):
+    """Creates a mock request with required attributes"""
+    req = mocker.MagicMock()
+    req.app = {
+        "state": mocker.MagicMock(matlab_port=8000),
+        "settings": {"matlab_protocol": "http", "mwapikey": "test-key"},
+    }
+    req.headers = CIMultiDict()
+    req.cookies = {}
+    return req
+
+
+@pytest.fixture(name="mock_websocket_messages")
+def mock_messages(mocker):
+    # Mock WebSocket messages
+    return [
+        mocker.MagicMock(type=WSMsgType.TEXT, data="test message"),
+        mocker.MagicMock(type=WSMsgType.BINARY, data=b"test binary"),
+        mocker.MagicMock(type=WSMsgType.PING),
+        mocker.MagicMock(type=WSMsgType.PONG),
+    ]
+
+
 @pytest.fixture(name="test_server")
 def test_server_fixture(
-    loop,
+    event_loop,
     aiohttp_client,
     monkeypatch,
 ):
@@ -263,7 +292,7 @@ def test_server_fixture(
     # Disabling the authentication token mechanism explicitly
     monkeypatch.setenv(mwi_env.get_env_name_enable_mwi_auth_token(), "False")
     try:
-        with FakeServer(loop, aiohttp_client) as test_server:
+        with FakeServer(event_loop, aiohttp_client) as test_server:
             yield test_server
     except ProcessLookupError:
         pass
@@ -306,8 +335,6 @@ async def test_get_env_config(test_server):
         test_server (aiohttp_client): A aiohttp_client server for sending GET request.
     """
     expected_json_structure = {
-        "useMOS": False,
-        "useMRE": False,
         "authentication": {"enabled": False, "status": False},
         "matlab": {
             "status": "up",
@@ -350,7 +377,7 @@ async def test_start_matlab_route(test_server):
     await __check_for_matlab_status(test_server, "starting")
 
 
-async def __check_for_matlab_status(test_server, status):
+async def __check_for_matlab_status(test_server, status, sleep_interval=0.5):
     """Helper function to check if the status of MATLAB returned by the server is either of the values mentioned in statuses
 
     Args:
@@ -369,7 +396,7 @@ async def __check_for_matlab_status(test_server, status):
             break
         else:
             count += 1
-            await asyncio.sleep(0.5)
+            await asyncio.sleep(sleep_interval)
             if count > test_constants.FIVE_MAX_TRIES:
                 raise ConnectionError
 
@@ -592,19 +619,6 @@ async def test_matlab_proxy_http_post_request(proxy_payload, test_server):
             raise ConnectionError
 
 
-# While acceessing matlab-proxy directly, the web socket request looks like
-#     {
-#         "connection": "Upgrade",
-#         "Upgrade": "websocket",
-#     }
-# whereas while accessing matlab-proxy with nginx as the reverse proxy, the nginx server
-# modifies the web socket request to
-#     {
-#         "connection": "upgrade",
-#         "upgrade": "websocket",
-#     }
-
-
 async def test_set_licensing_info_put_nlm(test_server):
     """Test to check endpoint : "/set_licensing_info"
 
@@ -641,35 +655,70 @@ async def test_set_licensing_info_put_invalid_license(test_server):
     assert resp.status == HTTPStatus.BAD_REQUEST
 
 
+# While acceessing matlab-proxy directly, the web socket request looks like
+#     {
+#         "connection": "Upgrade",
+#         "Upgrade": "websocket",
+#     }
+# whereas while accessing matlab-proxy with nginx as the reverse proxy, the nginx server
+# modifies the web socket request to
+#     {
+#         "connection": "upgrade",
+#         "upgrade": "websocket",
+#     }
 @pytest.mark.parametrize(
     "headers",
     [
-        {
-            "connection": "Upgrade",
-            "Upgrade": "websocket",
-        },
-        {
-            "connection": "upgrade",
-            "upgrade": "websocket",
-        },
+        CIMultiDict(
+            {
+                "connection": "Upgrade",
+                "Upgrade": "websocket",
+            }
+        ),
+        CIMultiDict(
+            {
+                "connection": "upgrade",
+                "upgrade": "websocket",
+            }
+        ),
     ],
     ids=["Uppercase header", "Lowercase header"],
 )
-async def test_matlab_proxy_web_socket(test_server, headers):
-    """Test to check if test_server proxies web socket request to fake matlab server
+async def test_matlab_view_websocket_success(
+    mocker,
+    mock_request,
+    mock_websocket_messages,
+    headers,
+    patch_authenticate_access_decorator,
+):
+    """Test successful websocket connection and message forwarding"""
 
-    Args:
-        test_server (aiohttp_client): Test Server to send HTTP Requests.
-    """
+    # Configure request for WebSocket
+    mock_request.headers = headers
+    mock_request.method = "GET"
+    mock_request.path_qs = "/test"
 
-    await wait_for_matlab_to_be_up(test_server, test_constants.ONE_SECOND_DELAY)
-    resp = await test_server.ws_connect("/http_ws_request.html/", headers=headers)
-    text = await resp.receive()
-    websocket_response_string = (
-        "Hello world"  # This string is set by the web_socket_handler in devel.py
+    # Mock WebSocket setup
+    mock_ws_server = mocker.MagicMock(spec=WebSocketResponse)
+    mocker.patch(
+        "matlab_proxy.app.aiohttp.web.WebSocketResponse", return_value=mock_ws_server
+    )
+
+    # Mock WebSocket client
+    mock_ws_client = MockWebSocketClient(messages=mock_websocket_messages)
+    mocker.patch(
+        "matlab_proxy.app.aiohttp.ClientSession.ws_connect", return_value=mock_ws_client
     )
-    assert text.type == aiohttp.WSMsgType.TEXT
-    assert text.data == websocket_response_string
+
+    # Execute
+    result = await matlab_view(mock_request)
+
+    # Assertions
+    assert result == mock_ws_server
+    assert mock_ws_server.send_str.call_count == 1
+    assert mock_ws_server.send_bytes.call_count == 1
+    assert mock_ws_server.ping.call_count == 1
+    assert mock_ws_server.pong.call_count == 1
 
 
 async def test_set_licensing_info_put_mhlm(test_server):
@@ -992,7 +1041,7 @@ async def test_set_licensing_mhlm_single_entitlement(
     assert resp_json["licensing"]["entitlementId"] == "Entitlement3"
 
     # validate that MATLAB has started correctly
-    await __check_for_matlab_status(test_server, "up")
+    await __check_for_matlab_status(test_server, "up", sleep_interval=2)
 
     # test-cleanup: unset licensing
     # without this, we can leave test drool related to cached license file

tests/unit/test_app_state.py

@@ -43,6 +43,7 @@ def sample_settings_fixture(tmp_path):
         "warnings": [],
         "matlab_config_file": tmp_file,
         "is_xvfb_available": True,
+        "is_windowmanager_available": True,
         "mwi_server_url": "dummy",
         "mwi_logs_root_dir": Path(settings.get_mwi_config_folder(dev=True)),
         "app_port": 12345,
@@ -55,12 +56,12 @@ def sample_settings_fixture(tmp_path):
 
 
 @pytest.fixture
-def app_state_fixture(sample_settings_fixture, loop):
+def app_state_fixture(sample_settings_fixture, event_loop):
     """A pytest fixture which returns an instance of AppState class with no errors.
 
     Args:
         sample_settings_fixture (dict): A dictionary of sample settings to be used by
-        loop : A pytest builtin fixture
+        event_loop : A pytest builtin fixture
 
     Returns:
         AppState: An object of the AppState class
@@ -71,7 +72,7 @@ def app_state_fixture(sample_settings_fixture, loop):
 
     yield app_state
 
-    loop.run_until_complete(app_state.stop_server_tasks())
+    event_loop.run_until_complete(app_state.stop_server_tasks())
 
 
 @pytest.fixture
@@ -108,13 +109,13 @@ def app_state_with_token_auth_fixture(
 
 
 @pytest.fixture
-def mocker_os_patching_fixture(mocker, platform, loop):
+def mocker_os_patching_fixture(mocker, platform, event_loop):
     """A pytest fixture which patches the is_* functions in system.py module
 
     Args:
         mocker : Built in pytest fixture
         platform (str): A string representing "windows", "linux" or "mac"
-        loop : A pytest builtin fixture
+        event_loop : A pytest builtin fixture
 
     Returns:
         mocker: Built in pytest fixture with patched calls to system.py module.
@@ -123,7 +124,7 @@ def mocker_os_patching_fixture(mocker, platform, loop):
     mocker.patch("matlab_proxy.app_state.system.is_windows", return_value=False)
     mocker.patch("matlab_proxy.app_state.system.is_mac", return_value=False)
     mocker.patch("matlab_proxy.app_state.system.is_posix", return_value=False)
-    mocker.patch("matlab_proxy.app_state.util.get_event_loop", return_value=loop)
+    mocker.patch("matlab_proxy.app_state.util.get_event_loop", return_value=event_loop)
 
     if platform == "linux":
         mocker.patch("matlab_proxy.app_state.system.is_linux", return_value=True)
@@ -820,7 +821,7 @@ async def test_decrement_timer_runs_out(sample_settings_fixture, mocker):
     app_state.processes = {"matlab": None, "xvfb": None}
     app_state.licensing = {"type": "existing_license"}
 
-    # mock util.get_event_loop() to return a new loop for the test to assert
+    # mock util.get_event_loop() to return a new event_loop for the test to assert
     mock_loop = asyncio.new_event_loop()
     mocker.patch("matlab_proxy.app_state.util.get_event_loop", return_value=mock_loop)
 

tests/unit/test_non_dev_mode.py

@@ -1,4 +1,4 @@
-# Copyright 2020-2022 The MathWorks, Inc.
+# Copyright 2020-2025 The MathWorks, Inc.
 
 import os
 import shutil
@@ -126,7 +126,7 @@ def mock_settings_get_fixture(mocker):
 
 @pytest.fixture(name="test_server")
 def test_server_fixture(
-    loop,
+    event_loop,
     aiohttp_client,
     build_frontend,
     matlab_port_setup,
@@ -140,7 +140,7 @@ def test_server_fixture(
     This fixture 'initializes' the test server with different constraints from the test server in test_app.py
 
     Args:
-        loop : Event Loop
+        event_loop : Event loop
         aiohttp_client : A built-in pytest fixture
         build_frontend: Pytest fixture which generates the directory structure of static files with some placeholder content
         matlab_port_setup: Pytest fixture which monkeypatches 'MWI_DEV' env to False. This is required for the test_server to add static content
@@ -150,7 +150,7 @@ def test_server_fixture(
         [aiohttp_client]: A aiohttp_client to send HTTP requests.
     """
 
-    with FakeServer(loop, aiohttp_client) as test_server:
+    with FakeServer(event_loop, aiohttp_client) as test_server:
         yield test_server
 
 

tests/unit/test_settings.py

@@ -543,21 +543,6 @@ def test_get_matlab_cmd_windows(mocker):
     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.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)

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/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