matlab-proxy 0.13.1__py3-none-any.whl → 0.15.0__py3-none-any.whl

matlab_proxy/util/mw.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2020-2023 The MathWorks, Inc.
+# Copyright 2020-2024 The MathWorks, Inc.
 
 import asyncio
 import os
@@ -46,7 +46,7 @@ async def fetch_entitlements(mhlm_api_endpoint, access_token, matlab_release):
         list: Representing a list of Dicts containing the id, label and license_number.
     """
     # Get entitlements for token
-    async with aiohttp.ClientSession() as client_session:
+    async with aiohttp.ClientSession(trust_env=True) as client_session:
         async with client_session.post(
             mhlm_api_endpoint,
             headers={"content-type": "application/x-www-form-urlencoded"},
@@ -99,7 +99,7 @@ async def fetch_expand_token(mwa_api_endpoint, identity_token, source_id):
     Returns:
         Dict: Containing User and License expiration details.
     """
-    async with aiohttp.ClientSession() as client_session:
+    async with aiohttp.ClientSession(trust_env=True) as client_session:
         async with client_session.post(
             f"{mwa_api_endpoint}/tokens",
             headers={
@@ -146,7 +146,7 @@ async def fetch_access_token(mwa_api_endpoint, identity_token, source_id):
     Returns:
         Dict : Containing the Access token.
     """
-    async with aiohttp.ClientSession() as client_session:
+    async with aiohttp.ClientSession(trust_env=True) as client_session:
         async with client_session.post(
             f"{mwa_api_endpoint}/tokens/access",
             headers={

matlab_proxy/util/mwi/download.py

@@ -0,0 +1,145 @@
+# Copyright 2024 The MathWorks, Inc.
+
+# This file contains functions required to enable downloads from the file browser
+from matlab_proxy.util.mwi import logger as mwi_logger
+from matlab_proxy.util import mwi, system
+
+logger = mwi_logger.get()
+
+
+def _is_null_base_url(base_url):
+    return base_url == "/" or base_url == ""
+
+
+def is_download_request(req):
+    """
+    Determine if the incoming request is for a download action.
+
+    This function checks if the request's relative URL path starts with
+    '/download/' or with '{base_url}/download/', depending on the base URL
+    specified in the application settings.
+
+    Parameters:
+        req (HTTPRequest): HTTPRequest Object
+
+    Returns:
+    - bool: True if the request is for a download, False otherwise.
+    ```
+    """
+
+    base_url = req.app["settings"]["base_url"]
+    if _is_null_base_url(base_url):
+        return req.rel_url.path.startswith("/download")
+    else:
+        return req.rel_url.path.startswith(f"{base_url}/download")
+
+
+async def get_download_url(req):
+    """
+    Asynchronously generates a download URL for a file.
+
+    This function takes a request object, extracts the full path to the file, and
+    uses the MATLAB Web Interface (MWI) to generate a download URL for that file.
+    It logs the full path and the response from the MWI. If successful, it returns
+    the download URL; otherwise, it returns None.
+
+    Parameters:
+        The request object containing necessary information to process the download.
+    Returns:
+        The download URL string if successful, None otherwise.
+    Raises:
+        Logs an error message and returns None if an error occurs.
+    """
+    full_path_to_file = _get_download_payload_path(req)
+    logger.debug(f"full_path_to_file: {full_path_to_file}")
+
+    args = [full_path_to_file, 1.0]
+    data = mwi.embedded_connector.helpers.get_data_to_feval_mcode(
+        "matlab.ui.internal.URLUtils.getURLToUserFile", *args, nargout=1
+    )
+
+    try:
+        state = req.app["state"]
+        headers = state._get_token_auth_headers()
+        url = mwi.embedded_connector.helpers.get_mvm_endpoint(
+            state.settings["mwi_server_url"]
+        )
+        resp_json = await mwi.embedded_connector.send_request(
+            url=url,
+            method="POST",
+            data=data,
+            headers=headers,
+        )
+
+        logger.debug(f"EC Response URL: {resp_json}")
+
+        resp = resp_json["messages"]["FEvalResponse"][0]
+
+        if not resp["isError"]:
+            # No error detected, proceed to fetch the results
+            download_url = resp["results"][0]
+            logger.debug(f"download_url: {download_url}")
+            base_url = req.app["settings"]["base_url"]
+            return (
+                download_url
+                if _is_null_base_url(base_url)
+                else f"{base_url}{download_url}"
+            )
+
+    except KeyError as key_err:
+        logger.error(f"Invalid Key Usage Detected! Check key: {key_err}")
+        pass
+
+    except Exception as err:
+        logger.error(
+            f"Failed to create download url from the Embedded Connector due to err: {err}"
+        )
+        pass
+
+    # In case of any failures.
+    return None
+
+
+def _get_download_payload_path(req):
+    """
+    Constructs the file system path to the payload for a download request.
+
+    This function analyzes the incoming request to determine the intended file path
+    for download. It takes into account the base URL from the application settings,
+    the nature of the request (whether it's a download request), and the operating
+    system to format the path correctly. The function supports different path
+    formatting for Windows and Unix-like systems due to their differences in file
+    system path syntax.
+
+    Note:
+        This function is intended to be used internally and starts with an underscore
+        to indicate it is a private member of the module.
+
+    Args:
+        req: An object representing the incoming request, which includes the relative
+             URL from which the file path can be deduced.
+
+    Returns:
+        A string representing the file system path to the requested download payload,
+        or None if the request is not a download request.
+    """
+    base_url = req.app["settings"]["base_url"]
+    if is_download_request(req):
+        from pathlib import Path
+
+        compare_str = (
+            "/download" if _is_null_base_url(base_url) else f"{base_url}/download"
+        )
+
+        if system.is_windows():
+            # On Windows, the URL is of the form : /downloadC:\some\path\to\file.txt
+            return str(
+                Path((req.rel_url.path).replace("/download", "/download/")).relative_to(
+                    f"{compare_str}"
+                )
+            )
+        else:
+            # On Posix, the URL is of the form : /download/some/path/to/file.txt
+            return "/" + str(Path((req.rel_url.path)).relative_to(f"{compare_str}"))
+
+    return None

matlab_proxy/util/mwi/embedded_connector/helpers.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2020-2022 The MathWorks, Inc.
+# Copyright 2020-2024 The MathWorks, Inc.
 
 """ This file contains helper methods which return the details required for sending
 a HTTP request to the Embedded Connector. """

matlab_proxy/util/mwi/embedded_connector/request.py

@@ -1,4 +1,4 @@
-# Copyright 2020-2023 The MathWorks, Inc.
+# Copyright 2020-2024 The MathWorks, Inc.
 
 """ 
 This file contains the methods to communicate with the embedded connector.
@@ -42,7 +42,7 @@ async def send_request(url: str, data: dict, method: str, headers: dict = None)
         data = json.dumps(data)
 
     try:
-        async with aiohttp.ClientSession() as session:
+        async with aiohttp.ClientSession(trust_env=True) as session:
             logger.debug(
                 f"sending request: method={method}, url={url}, data={data}, headers={headers}, "
             )
@@ -106,7 +106,7 @@ async def get_state(mwi_server_url, headers=None):
             return "up"
     except Exception as err:
         logger.debug(
-            f"{err}: Embbeded connector is currently not responding to ping requests."
+            f"{err}: Embedded connector is currently not responding to ping requests."
         )
         pass
 

{matlab_proxy-0.13.1.dist-info → matlab_proxy-0.15.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: matlab-proxy
-Version: 0.13.1
+Version: 0.15.0
 Summary: Python® package enables you to launch MATLAB® and access it from a web browser.
 Home-page: https://github.com/mathworks/matlab-proxy/
 Author: The MathWorks, Inc.
@@ -26,6 +26,7 @@ Requires-Dist: black ; extra == 'dev'
 Requires-Dist: pytest ; extra == 'dev'
 Requires-Dist: pytest-env ; extra == 'dev'
 Requires-Dist: pytest-cov ; extra == 'dev'
+Requires-Dist: pytest-timeout ; extra == 'dev'
 Requires-Dist: pytest-mock ; extra == 'dev'
 Requires-Dist: pytest-aiohttp ; extra == 'dev'
 Requires-Dist: psutil ; extra == 'dev'

{matlab_proxy-0.13.1.dist-info → matlab_proxy-0.15.0.dist-info}/RECORD

@@ -1,14 +1,14 @@
 matlab_proxy/__init__.py,sha256=6cwi8buKCMtw9OeWaOYUHEoqwl5MyJ_s6GxgNuqPuNg,1673
-matlab_proxy/app.py,sha256=8fHTYuh5FlPiVZNkSX00OA4OdxgNf5QIKk-4EGoPMHo,31411
+matlab_proxy/app.py,sha256=ABCfuYtHE6zoVm3fUkNdaFMUvbKx8n53JOM5WeklWjo,33584
 matlab_proxy/app_state.py,sha256=HV4_igTkUVf-CQWPKc7s3z4Ea_MkSBbV7k3I-AG-m28,55374
-matlab_proxy/constants.py,sha256=GTuIP6ibk1HcoxVihBRcy7SOfoQdb4hy0vhj2nH99sc,910
+matlab_proxy/constants.py,sha256=k9vESSF1HSrr2-tCgIEomJ47Q7UR4wbrMCWzZnLLoPc,924
 matlab_proxy/default_configuration.py,sha256=DxQaHzAivzstiPl_nDfxs8SOyP9oaK9v3RP4LtroJl4,843
 matlab_proxy/devel.py,sha256=nR6XPVBUEdQ-RZGtYvX1YHTp8gj9cuw5Hp8ahasMBc8,14310
 matlab_proxy/settings.py,sha256=YjchyZAzvLfl-CiwxAPtSaTTo7aRgD6inS4-jZmsuNY,24687
 matlab_proxy/gui/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-matlab_proxy/gui/asset-manifest.json,sha256=MJLLvEjjgcmPdtFTp8qXnIGt2dYZNmuzgn6R2tkxs30,3516
+matlab_proxy/gui/asset-manifest.json,sha256=0eynKD0QHNdOgsiH3IuXXNkRQph4sd_QV4S89qocW2k,3516
 matlab_proxy/gui/favicon.ico,sha256=7w7Ki1uQP2Rgwc64dOV4-NrTu97I3WsZw8OvRSoY1A0,130876
-matlab_proxy/gui/index.html,sha256=gZN6QFkIfSTSSR5KeHcRhKkZRi5xoO07VX3Zu0wixzs,637
+matlab_proxy/gui/index.html,sha256=IxsvWXcW8bVcVPdnnMQoolow1BFirTUyCo-O9uYGYTQ,637
 matlab_proxy/gui/manifest.json,sha256=NwDbrALM5auYyj2bbEf4aGwAUDqNl1FzMFQpPiG2Ty4,286
 matlab_proxy/gui/robots.txt,sha256=kNJLw79pisHhc3OVAimMzKcq3x9WT6sF9IS4xI0crdI,67
 matlab_proxy/gui/static/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -16,9 +16,9 @@ matlab_proxy/gui/static/css/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMp
 matlab_proxy/gui/static/css/main.47712126.css,sha256=OT5ccyC0a6fVg956C-8b6uDVbZZVgcpXbHjdO6v4ZBI,274313
 matlab_proxy/gui/static/css/main.47712126.css.map,sha256=RdfmXfQvzvvh4XZuDWShm8CD8pA2Gb2K6MtMzrgJyKM,350495
 matlab_proxy/gui/static/js/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-matlab_proxy/gui/static/js/main.0fcee5e5.js,sha256=i4lfyMV_uy39l6y2ntwTJiTwM57HdenZ2C8dbeOs0Ks,294074
-matlab_proxy/gui/static/js/main.0fcee5e5.js.LICENSE.txt,sha256=3cj3DrwM51esz1ogL9VVU1ZyXyXJ6u-Ec2CI9CCcI_A,1689
-matlab_proxy/gui/static/js/main.0fcee5e5.js.map,sha256=RAEWfkRjY9m2SjT8xzIks9zL3ARWuAyef94zMKofM1o,935126
+matlab_proxy/gui/static/js/main.14aa7840.js,sha256=Eu6ZKinNe4gYoD1KV-CsYDJHg0DNKVq4-Qxy2sT2A-U,294128
+matlab_proxy/gui/static/js/main.14aa7840.js.LICENSE.txt,sha256=3cj3DrwM51esz1ogL9VVU1ZyXyXJ6u-Ec2CI9CCcI_A,1689
+matlab_proxy/gui/static/js/main.14aa7840.js.map,sha256=JbKOBbRaQIVoticAYynd6nEc1msGas1RXxnzvA1eWDs,935545
 matlab_proxy/gui/static/media/MATLAB-env-blur.4fc94edbc82d3184e5cb.png,sha256=QpmQTLDvBu2-b7ev83Rvpt0Q72R6wdQGkuJMPPpjv7M,220290
 matlab_proxy/gui/static/media/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 matlab_proxy/gui/static/media/arrow.0c2968b90bd9a64c8c3f.svg,sha256=XtmvDWzGZnwCZm08TKBnqt5hc1wphJnNupG0Fx_faAY,327
@@ -56,22 +56,35 @@ matlab_proxy/matlab/startup.m,sha256=YRtI8P2flDJSDcPxJ2008B2l1T9JpqiUbzhQxA0frbc
 matlab_proxy/util/__init__.py,sha256=bRfvYEbxsaiYhtWq5imTZM7PRrSEJ7GTlVBptvunaYQ,7902
 matlab_proxy/util/event_loop.py,sha256=Zqd282jlvPHHyc4kg8IjIzlzh9zLM_SAc5xjqUOrm04,1144
 matlab_proxy/util/list_servers.py,sha256=M93coVZjyQCdIvCCxsNOU_XDWNjBSysOJ5tWXaTjP8Y,1369
-matlab_proxy/util/mw.py,sha256=KCttG57vInsflRoHs1sEyUvQpd9faAs-ZiJE1rzfHDM,11048
+matlab_proxy/util/mw.py,sha256=dLGSdfcTZiwKR1MMZA-39o-8na13IEPZOGBqcaHmKVI,11086
 matlab_proxy/util/system.py,sha256=XoT3Rv5MwPkdfhk2oMvUwxxlzZmADMlxzi9IRQyGgbA,1692
 matlab_proxy/util/windows.py,sha256=R9-VA7f0snVanSR7IgbHz3kvSnthZuUYe2UhBd5QWMQ,3440
 matlab_proxy/util/mwi/__init__.py,sha256=zI-X1lafr8H3j17PyA0oSZ0q5nINfK-WDA7VmJKmSAQ,158
 matlab_proxy/util/mwi/custom_http_headers.py,sha256=kfDjSnEXEVzoF2pZuEn76LKayeD2WKoQEDu2Y9EMOAo,7154
+matlab_proxy/util/mwi/download.py,sha256=-GJj3yOsL4vF_9baqRXkgBI-vu_OwjZMQVkJXFS8GMc,4965
 matlab_proxy/util/mwi/environment_variables.py,sha256=bIz0QFWo0pgyvSeJ_kAobUCS17V05CSmFWm3zYIOIsA,7139
 matlab_proxy/util/mwi/exceptions.py,sha256=93HrHbOq24KI4Md2el23XN01wIqVShEK29Pbt2V0Jr8,4628
 matlab_proxy/util/mwi/logger.py,sha256=e7wTPclrtJ-aX5mPk_pUJMX7-1QD_snGBW1P2ks-ETE,3311
 matlab_proxy/util/mwi/token_auth.py,sha256=25uQE2cul6MZNTj1HQqukiBS014dj7URZfMOFPKcS3Y,9606
 matlab_proxy/util/mwi/validators.py,sha256=BMMOD-0tdjGIALm1MmG4yXVRoD2ZUXkrJXLWP_D5FGo,11712
 matlab_proxy/util/mwi/embedded_connector/__init__.py,sha256=SVSckEJ4zQQ2KkNPT_un8ndMAImcMOTrai7ShAbmFY4,114
-matlab_proxy/util/mwi/embedded_connector/helpers.py,sha256=SfrwpCnZ6QGJBko-sR2bIG4-_qZOn29zCZV9qwVBnkM,3395
-matlab_proxy/util/mwi/embedded_connector/request.py,sha256=0NyfnE7-0g3BBPTPmjbkDrTOGiTNqFDrqKDObcRc2Jw,3716
-matlab_proxy-0.13.1.dist-info/LICENSE.md,sha256=oF0h3UdSF-rlUiMGYwi086ZHqelzz7yOOk9HFDv9ELo,2344
-matlab_proxy-0.13.1.dist-info/METADATA,sha256=Za6gLklVrZk-1Ok3sS8ROhEoQ4LfHRZYpqcvWaizGEo,10061
-matlab_proxy-0.13.1.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-matlab_proxy-0.13.1.dist-info/entry_points.txt,sha256=DbBLYgnRt8UGiOpd0zHigRTyyMdZYhMdvCvSYP7wPN0,244
-matlab_proxy-0.13.1.dist-info/top_level.txt,sha256=3-Lxje1LZvSfK__TVoRksU4th_PCj6cMMJwhH8P0_3I,13
-matlab_proxy-0.13.1.dist-info/RECORD,,
+matlab_proxy/util/mwi/embedded_connector/helpers.py,sha256=p6TedefbvhlZT64IMwFjrb0panWCXf-T3XPoztDbxM0,3391
+matlab_proxy/util/mwi/embedded_connector/request.py,sha256=-6DL9K8JWjX5u5XVOEGaqBUIwQ-oCVW30-VP3qk_rzw,3730
+tests/integration/__init__.py,sha256=ttzJ8xKWGxOJZz56qOiWOn6sp5LGomkZMn_w4KJLRMU,42
+tests/integration/integration_tests_with_license/__init__.py,sha256=vVYZCur-QhmIGCxUmn-WZjIywtDQidaLDmlmrRHRlgY,37
+tests/integration/integration_tests_with_license/conftest.py,sha256=sCaIXB8d4vf05C7JWSVA7g5gnPjbpRq3dftuBpWyp1s,1599
+tests/integration/integration_tests_with_license/test_http_end_points.py,sha256=fDA2VyauxM8x0Gw9ArZLI4YFOVduX6Wg-UiHdr5tmHk,7411
+tests/integration/integration_tests_without_license/__init__.py,sha256=vVYZCur-QhmIGCxUmn-WZjIywtDQidaLDmlmrRHRlgY,37
+tests/integration/integration_tests_without_license/conftest.py,sha256=z5r_hALWo7Lh0kyN-h1N2oCj1jIug3-0RXQm92XTtPI,3426
+tests/integration/integration_tests_without_license/test_matlab_is_down_if_unlicensed.py,sha256=Nd87UkEjZk6eh_3y8VybKrB0uQUErw90w_Jnu02OHXY,1536
+tests/integration/utils/__init__.py,sha256=ttzJ8xKWGxOJZz56qOiWOn6sp5LGomkZMn_w4KJLRMU,42
+tests/integration/utils/integration_tests_utils.py,sha256=IbJ9CedFHiz3k85FBY-8GwotTnjPF3jF4AHdKio7jqk,10321
+tests/integration/utils/licensing.py,sha256=rEBjvMXO8R3mL6KnePu2lojmOsjD4GXl9frf9N0Wacs,4842
+tests/utils/__init__.py,sha256=ttzJ8xKWGxOJZz56qOiWOn6sp5LGomkZMn_w4KJLRMU,42
+tests/utils/logging_util.py,sha256=VBy_NRvwau3C_CVTBjK5RMROrQimnJYHO2U0aKSZiRw,2234
+matlab_proxy-0.15.0.dist-info/LICENSE.md,sha256=oF0h3UdSF-rlUiMGYwi086ZHqelzz7yOOk9HFDv9ELo,2344
+matlab_proxy-0.15.0.dist-info/METADATA,sha256=TFAiv_gJ5Mt79rX7mf8RPrIMkU6uvYRGaRA4_zTWDHw,10108
+matlab_proxy-0.15.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+matlab_proxy-0.15.0.dist-info/entry_points.txt,sha256=DbBLYgnRt8UGiOpd0zHigRTyyMdZYhMdvCvSYP7wPN0,244
+matlab_proxy-0.15.0.dist-info/top_level.txt,sha256=9uVTjsUCAS4TwsxueTBxrBg3PdBiTSsYowAkHPv9VY0,19
+matlab_proxy-0.15.0.dist-info/RECORD,,

{matlab_proxy-0.13.1.dist-info → matlab_proxy-0.15.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.42.0)
+Generator: bdist_wheel (0.43.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

{matlab_proxy-0.13.1.dist-info → matlab_proxy-0.15.0.dist-info}/top_level.txt

@@ -1 +1,2 @@
 matlab_proxy
+tests

tests/integration/__init__.py

@@ -0,0 +1 @@
+# Copyright 2023-2024 The MathWorks, Inc.

tests/integration/integration_tests_with_license/__init__.py

@@ -0,0 +1 @@
+# Copyright 2023 The MathWorks, Inc.

tests/integration/integration_tests_with_license/conftest.py

@@ -0,0 +1,47 @@
+# Copyright 2023-2024 The MathWorks, Inc.
+
+import os
+from tests.integration.utils import integration_tests_utils as utils
+import pytest
+from matlab_proxy.util.mwi import environment_variables as mwi_env
+from tests.utils.logging_util import create_integ_test_logger
+
+
+_logger = create_integ_test_logger(
+    __name__, log_file_path=os.getenv("MWI_INTEG_TESTS_LOG_FILE_PATH")
+)
+
+
+@pytest.fixture(scope="module", name="module_monkeypatch")
+def monkeypatch_module_scope_fixture():
+    """
+    To ensure that modifications made with the monkeypatch fixture
+    persist across all tests in the module, this fixture
+    has been created in 'module' scope. This is done because a 'module'
+    scope object is needed with matlab-proxy 'module' scope fixture.
+    This allows us to patch certain aspects, like environment variables,
+    for all tests within the module.
+
+    Yields:
+        class object: Object of class MonkeyPatch
+    """
+    with pytest.MonkeyPatch.context() as mp:
+        yield mp
+
+
+@pytest.fixture(autouse=True, scope="module")
+def matlab_proxy_fixture(module_monkeypatch, request):
+    """
+    Pytest fixture for managing a standalone matlab-proxy process
+    for testing purposes. This fixture sets up a matlab-proxy process in
+    the module scope, and tears it down after all the tests are executed.
+    """
+
+    utils.perform_basic_checks()
+
+    module_monkeypatch.setenv(mwi_env.get_env_name_testing(), "false")
+    module_monkeypatch.setenv(mwi_env.get_env_name_development(), "false")
+    _logger.info("Started MATLAB Proxy process")
+
+    # Run the matlab proxy tests
+    yield

tests/integration/integration_tests_with_license/test_http_end_points.py

@@ -0,0 +1,223 @@
+# Copyright 2023-2024 The MathWorks, Inc.
+
+import json
+import os
+import time
+import matlab_proxy.settings as settings
+from tests.integration.utils import integration_tests_utils as utils
+import pytest
+from matlab_proxy.util import system
+import requests
+import re
+from requests.adapters import HTTPAdapter, Retry
+from urllib.parse import urlparse, parse_qs
+from tests.utils.logging_util import create_integ_test_logger
+from logging import DEBUG
+
+_logger = create_integ_test_logger(__name__)
+
+# Timeout for polling the matlab-proxy http endpoints
+# matlab proxy in Mac machines takes more time to be 'up'
+
+MAX_TIMEOUT = settings.get_process_startup_timeout()
+
+
+class RealMATLABServer:
+    """
+    Context Manager class which returns matlab proxy web server serving real MATLAB
+    for testing.
+
+    Setting up the server in the context of Pytest.
+    """
+
+    def __init__(self, event_loop):
+        self.event_loop = event_loop
+
+    def __enter__(self):
+        # Store the matlab proxy logs in os.pipe for testing
+        # os.pipe2 is only supported in Linux systems
+        _logger.info("Setting up MATLAB Server for integration test")
+
+        _logger.debug("Entering RealMATLABServer enter section.")
+        self.dpipe = os.pipe2(os.O_NONBLOCK) if system.is_linux() else os.pipe()
+        self.mwi_app_port = utils.get_random_free_port()
+        self.matlab_config_file_path = str(utils.get_matlab_config_file())
+
+        self.temp_dir_path = os.path.dirname(
+            os.path.dirname(self.matlab_config_file_path)
+        )
+
+        self.temp_dir_name = "temp_dir"
+        self.mwi_base_url = "/matlab-test"
+
+        # Environment variables to launch matlab proxy
+        input_env = {
+            "MWI_APP_PORT": self.mwi_app_port,
+            "MWI_BASE_URL": self.mwi_base_url,
+        }
+
+        self.proc = self.event_loop.run_until_complete(
+            utils.start_matlab_proxy_app(out=self.dpipe[1], input_env=input_env)
+        )
+
+        utils.wait_server_info_ready(self.mwi_app_port)
+        parsed_url = urlparse(utils.get_connection_string(self.mwi_app_port))
+
+        self.headers = {
+            "mwi_auth_token": (
+                parse_qs(parsed_url.query)["mwi_auth_token"][0]
+                if "mwi_auth_token" in parse_qs(parsed_url.query)
+                else ""
+            )
+        }
+        self.connection_scheme = parsed_url.scheme
+        self.url = parsed_url.scheme + "://" + parsed_url.netloc + parsed_url.path
+        return self
+
+    async def _terminate_process(self, timeout=0):
+        """
+        Asynchronous helper method to terminate the process with a timeout.
+
+        Args:
+            timeout: Maximum number of seconds to wait
+                    for the process to terminate
+
+        """
+        import asyncio
+
+        process = self.proc
+        try:
+            process.terminate()
+            await asyncio.wait_for(process.wait(), timeout=timeout)
+        except asyncio.TimeoutError:
+            _logger.warning(
+                "Termination of the MATLAB Server process timed out. Attempting to kill."
+            )
+            process.kill()
+            await process.wait()
+            _logger.debug("Killed the MATLAB process after timeout.")
+
+    def __exit__(self, exc_type, exc_value, exc_traceback):
+        _logger.info("Tearing down the MATLAB Server.")
+        self.event_loop.run_until_complete(self._terminate_process(timeout=10))
+        _logger.debug("Terminated the MATLAB process.")
+
+
+def _send_http_get_request(uri, connection_scheme, headers, http_endpoint=""):
+    """Send HTTP request to matlab-proxy server.
+    Returns HTTP response JSON"""
+
+    request_uri = uri + http_endpoint
+
+    json_response = None
+    with requests.Session() as s:
+        retries = Retry(total=10, backoff_factor=0.1)
+        s.mount(f"{connection_scheme}://", HTTPAdapter(max_retries=retries))
+        response = s.get(request_uri, headers=headers, verify=False)
+        json_response = json.loads(response.text)
+
+    return json_response
+
+
+def _check_matlab_status(matlab_proxy_app_fixture, status):
+    uri = matlab_proxy_app_fixture.url
+    connection_scheme = matlab_proxy_app_fixture.connection_scheme
+    headers = matlab_proxy_app_fixture.headers
+
+    matlab_status = None
+
+    start_time = time.time()
+    while matlab_status != status and (time.time() - start_time < MAX_TIMEOUT):
+        time.sleep(1)
+        res = _send_http_get_request(
+            uri, connection_scheme, headers, http_endpoint="/get_status"
+        )
+        matlab_status = res["matlab"]["status"]
+
+    return matlab_status
+
+
+@pytest.fixture
+def matlab_proxy_app_fixture(
+    loop,
+):
+    """A pytest fixture which yields a real matlab server to be used by tests.
+
+    Args:
+        loop (Event event_loop): The built-in event event_loop provided by pytest.
+
+    Yields:
+        real_matlab_server : A real matlab web server used by tests.
+    """
+
+    try:
+        with RealMATLABServer(loop) as matlab_proxy_app:
+            yield matlab_proxy_app
+    except ProcessLookupError as e:
+        _logger.debug("ProcessLookupError found in matlab proxy app fixture")
+        _logger.debug(e)
+        pass
+
+
+def test_matlab_is_up(matlab_proxy_app_fixture):
+    """Test that the status switches from 'starting' to 'up' within a timeout.
+
+    Args:
+        matlab_proxy_app_fixture: A pytest fixture which yields a real matlab server to be used by tests.
+    """
+
+    status = _check_matlab_status(matlab_proxy_app_fixture, "up")
+    assert status == "up"
+
+
+def test_stop_matlab(matlab_proxy_app_fixture):
+    """Test to check that matlab is in 'down' state when
+    we send the delete request to 'stop_matlab' endpoint
+
+    Args:
+        matlab_proxy_app_fixture: A pytest fixture which yields a real matlab server to be used by tests.
+    """
+    status = _check_matlab_status(matlab_proxy_app_fixture, "up")
+    assert status == "up"
+
+    http_endpoint_to_test = "/stop_matlab"
+    stop_url = matlab_proxy_app_fixture.url + http_endpoint_to_test
+
+    with requests.Session() as s:
+        retries = Retry(total=10, backoff_factor=0.1)
+        s.mount(
+            f"{matlab_proxy_app_fixture.connection_scheme}://",
+            HTTPAdapter(max_retries=retries),
+        )
+        s.delete(stop_url, headers=matlab_proxy_app_fixture.headers, verify=False)
+
+    status = _check_matlab_status(matlab_proxy_app_fixture, "down")
+    assert status == "down"
+
+
+# FIXME: If output has logging or extra debug info, 600 bytes might not be enough.
+async def test_print_message(matlab_proxy_app_fixture):
+    """Test if the right logs are printed
+
+    Args:
+        matlab_proxy_app_fixture: A pytest fixture which yields a real matlab server to be used by tests.
+
+    """
+    # Checks if matlab proxy is in "up" state or not
+    status = _check_matlab_status(matlab_proxy_app_fixture, "up")
+    assert status == "up"
+
+    uri_regex = f"{matlab_proxy_app_fixture.connection_scheme}://[a-zA-Z0-9\-_.]+:{matlab_proxy_app_fixture.mwi_app_port}{matlab_proxy_app_fixture.mwi_base_url}"
+
+    read_descriptor, write_descriptor = matlab_proxy_app_fixture.dpipe
+    number_of_bytes = 600
+
+    if read_descriptor:
+        line = os.read(read_descriptor, number_of_bytes).decode("utf-8")
+        process_logs = line.strip()
+
+    assert bool(re.search(uri_regex, process_logs)) == True
+
+    # Close the read and write descriptors.
+    os.close(read_descriptor)
+    os.close(write_descriptor)

tests/integration/integration_tests_without_license/__init__.py

@@ -0,0 +1 @@
+# Copyright 2023 The MathWorks, Inc.