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

tests/unit/test_devel.py

@@ -0,0 +1,246 @@
+# Copyright 2020-2024 The MathWorks, Inc.
+
+import os
+import socket
+import subprocess
+import sys
+import time
+from collections import namedtuple
+from pathlib import Path
+
+import pytest
+import aiohttp
+from matlab_proxy.util.mwi import environment_variables as mwi_env
+from matlab_proxy.constants import CONNECTOR_SECUREPORT_FILENAME
+
+"""
+This file consists of tests which check the devel.py file
+"""
+
+TWO_MAX_TRIES = 2
+FIVE_MAX_TRIES = 5
+HALF_SECOND_DELAY = 0.5
+ONE_SECOND_DELAY = 1
+
+
+@pytest.fixture(name="matlab_log_dir")
+def matlab_log_dir_fixture(monkeypatch, tmp_path):
+    """A pytest fixture to monkeypatch an environment variable.
+
+    This fixture monkeypatches MATLAB_LOG_DIR env variable which the
+    fake matlab server utilizes to write the matlab_ready_file into.
+
+    Args:
+        monkeypatch : A built-in pytest fixture.
+        tmp_path: tmp_path fixture provides a temporary directory unique to the test invocation.
+    """
+    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):
+    """A pytest fixture to create the matlab_ready_file.
+
+    This fixture creates the matlab readyfile path based on the matlab_log_dir fixture output.
+
+    Args:
+        matlab_log_dir: pytest fixture that returns a temp dir to be used as matlab_log_dir
+
+    Returns:
+        Path: Returns path of the matlab_ready_file
+    """
+    return Path(f"{matlab_log_dir}/{CONNECTOR_SECUREPORT_FILENAME}")
+
+
+@pytest.fixture(name="valid_nlm")
+def valid_nlm_fixture(monkeypatch):
+    """A pytest fixture to monkeypatch an environment variable.
+
+    This fixture monkeypatches MLM_LICENSE_FILE with a valid NLM connection string.
+
+    Args:
+        monkeypatch : A built-in pytest fixture
+    """
+
+    monkeypatch.setenv(mwi_env.get_env_name_network_license_manager(), "123@nlm")
+
+
+@pytest.fixture(name="invalid_nlm")
+def invalid_nlm_fixture(monkeypatch):
+    """A pytest fixture to monkeypatch an environment variable.
+
+    This fixture monkeypatches MLM_LICENSE_FILE with an invalid NLM connection string.
+
+
+    Args:
+        monkeypatch : A built-in pytest fixture
+    """
+
+    monkeypatch.setenv(mwi_env.get_env_name_network_license_manager(), "123@brokenhost")
+
+
+@pytest.fixture(name="matlab_process_setup")
+def matlab_process_setup_fixture():
+    """A pytest fixture which creates a NamedTuple required for creating a fake matlab process
+
+    This fixture returns a NamedTuple containing values required to run the fake matlab process
+
+    Returns:
+        variables : A NamedTuple containing the following values:
+
+            devel_file = Path to devel_file
+            matlab_cmd = The matlab command to start the matlab process
+    """
+
+    matlab_setup_variables = namedtuple(
+        "matlab_setup_variables",
+        ["devel_file", "matlab_cmd"],
+    )
+    devel_file = Path(os.path.join(os.getcwd(), "matlab_proxy", "devel.py"))
+
+    python_executable = sys.executable
+
+    matlab_cmd = [
+        python_executable,
+        "-u",
+        str(devel_file),
+        "matlab",
+        "--ready-delay",
+        "0",
+    ]
+    variables = matlab_setup_variables(devel_file, matlab_cmd)
+
+    return variables
+
+
+@pytest.fixture(name="matlab_process_valid_nlm")
+def matlab_process_valid_nlm_fixture(matlab_log_dir, matlab_process_setup, valid_nlm):
+    """A pytest fixture which creates a fake matlab process with a valid NLM connection string.
+
+    This  pytest fixture creates a matlab process and yields control to the test which utilizes this
+    fixture. After completion of tests stops the matlab process
+    """
+
+    matlab_process = subprocess.Popen(
+        matlab_process_setup.matlab_cmd, stderr=subprocess.PIPE
+    )
+
+    yield
+
+    matlab_process.terminate()
+    matlab_process.wait()
+
+
+async def test_matlab_valid_nlm(matlab_ready_file, matlab_process_valid_nlm):
+    """Test if the Fake Matlab server has started and is able to serve content.
+
+    This test checks if the fake matlab process is able to start a web server and serve some
+    fake content.
+
+    Args:
+        matlab_process_valid_nlm : A pytest fixture which creates the fake matlab process which starts the web server
+
+    Raises:
+        ConnectionError: If the fake matlab server doesn't startup, after the specified number of max_tries this test
+        raises a ConnectionError.
+    """
+
+    matlab_port = get_matlab_port_from_ready_file(matlab_ready_file)
+    if matlab_port is None:
+        raise FileNotFoundError(f"matlab_ready_file at {matlab_ready_file} not found")
+
+    count = 0
+    while True:
+        try:
+            url = f"http://localhost:{matlab_port}/index-jsd-cr.html"
+            async with aiohttp.ClientSession(trust_env=True) as session:
+                async with session.get(url) as resp:
+                    assert resp.content_type == "text/html"
+                    assert resp.status == 200
+                    assert resp.content is not None
+            break
+        except:
+            count += 1
+            if count > FIVE_MAX_TRIES:
+                raise ConnectionError
+            time.sleep(ONE_SECOND_DELAY)
+
+
+@pytest.fixture(name="matlab_process_invalid_nlm")
+def matlab_process_invalid_nlm_fixture(
+    matlab_log_dir, matlab_process_setup, invalid_nlm
+):
+    """A pytest fixture which creates a fake matlab server with an invalid NLM connection string.
+
+    Utilizes matlab_log_dir, matlab_process_setup and invalid_nlm fixtures for creating a
+    fake matlab web server then yields control for tests to utilize it.
+
+
+    Args:
+        matlab_log_dir : A pytest fixture which monkeypatches an environment variable.
+        matlab_process_setup (NamedTuple): A NamedTuple which contains values to start the matlab process
+        invalid_nlm : A pytest fixture which monkeypatches an invalid nlm connection string
+    """
+
+    matlab_process = subprocess.Popen(
+        matlab_process_setup.matlab_cmd,
+        stderr=subprocess.PIPE,
+    )
+
+    yield
+
+    matlab_process.terminate()
+    matlab_process.wait()
+
+
+async def test_matlab_invalid_nlm(matlab_ready_file, matlab_process_invalid_nlm):
+    """Test which checks if the fake Matlab process stops when NLM string is invalid
+
+    When the NLM string is invalid, the fake matlab server will automatically
+    exit. This test checks if a ConnectionError is raised when a GET request is sent to it.
+
+    Args:
+        matlab_process_invalid_nlm (Process): A process which starts a fake Matlab WebServer.
+    """
+    matlab_port = get_matlab_port_from_ready_file(matlab_ready_file)
+    count = 0
+
+    with pytest.raises(ConnectionError):
+        while True:
+            try:
+                url = f"http://localhost:{matlab_port}/index-jsd-cr.html"
+
+                async with aiohttp.ClientSession(trust_env=True) as session:
+                    async with session.get(url) as resp:
+                        assert resp.content_type == "text/html"
+                        assert resp.status == 200
+                        assert resp.content is not None
+
+                break
+            except:
+                count += 1
+                if count > TWO_MAX_TRIES:
+                    raise ConnectionError
+                time.sleep(HALF_SECOND_DELAY)
+
+
+def get_matlab_port_from_ready_file(matlab_ready_file):
+    for i in range(FIVE_MAX_TRIES):
+        try:
+            with open(matlab_ready_file) as f:
+                return int(f.read())
+        # Retry in the event that matlab_ready_file isn't created yet or
+        # it has been created but the matlab_port information is not yet
+        # written into the file which throws ValueError while converting to int.
+        except (FileNotFoundError, ValueError):
+            time.sleep(HALF_SECOND_DELAY)
+            continue

tests/unit/test_non_dev_mode.py

@@ -0,0 +1,169 @@
+# Copyright 2020-2022 The MathWorks, Inc.
+
+import os
+import shutil
+from pathlib import Path
+
+import matlab_proxy
+import pytest
+from matlab_proxy.util.mwi import environment_variables as mwi_env
+
+from tests.unit.test_app import FakeServer
+
+"""
+This file checks whether static assets are being added successfully to the
+test web server's static route table in non-dev mode.
+"""
+
+
+@pytest.fixture(name="matlab_port_setup")
+def matlab_port_fixture(monkeypatch):
+    """A pytest fixture which monkeypatches an environment variable.
+
+    Pytest by default sets MWI_DEV to true.
+    Args:
+        monkeypatch : A built-in pytest fixture
+    """
+    # For the test: test_non_dev, when run independently, works as expected.
+    # But, when all the tests are run, if port 8000 was picked
+    # by some previous test and was not released yet, then test_non_dev will fail to bind to it.
+    # To overcome this, I've temporarily patched MWI_APP_PORT to pick a random port.
+    try:
+        import socket
+
+        s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+        s.bind(("", 0))
+        port = s.getsockname()[1]
+        s.close()
+    except Exception as e:
+        pass
+
+    monkeypatch.setenv(mwi_env.get_env_name_development(), "false")
+    monkeypatch.setenv(mwi_env.get_env_name_app_port(), str(port))
+
+
+@pytest.fixture(name="build_frontend")
+def build_frontend_fixture():
+    """A method to build react front-end and place it in matlab_proxy directory
+
+    This method builds react front-end and copies the built files to matlab_proxy/gui.
+    Then adds __init__.py to each folder within it to make it accessible for python.
+    This prework is for the purpose of adding the built files as static assets to the server.
+    """
+
+    static_files_dir = os.path.join(os.getcwd(), "matlab_proxy", "gui")
+
+    try:
+        shutil.rmtree(static_files_dir)
+
+    except FileNotFoundError:
+        pass
+
+    finally:
+        # Create static files
+        os.mkdir(static_files_dir)
+        with open(Path(static_files_dir) / "index.html", "w") as f:
+            f.write("<h1> Hello World </h1>")
+
+        with open(Path(static_files_dir) / "manifest.json", "w") as f:
+            f.write('{"display: "standalone"}')
+
+        build_contents = [
+            {
+                "dir": "css",
+                "file": "index.css",
+                "file_content": "html { height: 100%;}",
+            },
+            {
+                "dir": "js",
+                "file": "index.js",
+                "file_content": "import React from 'react';'",
+            },
+            {
+                "dir": "media",
+                "file": "media.txt",
+                "file_content": "Copyright (c) 2020-2022 The Mathworks, Inc.",
+            },
+        ]
+
+        for build_content in build_contents:
+            os.makedirs(Path(static_files_dir) / "static" / build_content["dir"])
+            with open(
+                Path(static_files_dir)
+                / "static"
+                / build_content["dir"]
+                / build_content["file"],
+                "w",
+            ) as f:
+                f.write(build_content["file_content"])
+
+        (Path(static_files_dir) / "__init__.py").touch(exist_ok=True)
+
+        for path, directories, filenames in os.walk(static_files_dir):
+            for directory in directories:
+                (Path(path) / directory / "__init__.py").touch(exist_ok=True)
+
+        # Yield to execute test
+        yield
+
+        # Delete the static files after executing test.
+        shutil.rmtree(static_files_dir)
+
+
+@pytest.fixture(name="mock_settings_get")
+def mock_settings_get_fixture(mocker):
+    """Pytest fixture which mocks settings.get() method to return
+    dev settings.
+
+    Args:
+        mocker : Built in pytest fixture
+    """
+    mocker.patch(
+        "matlab_proxy.settings.get",
+        return_value=matlab_proxy.settings.get(dev=True),
+    )
+
+
+@pytest.fixture(name="test_server")
+def test_server_fixture(
+    loop,
+    aiohttp_client,
+    build_frontend,
+    matlab_port_setup,
+    mock_settings_get,
+):
+    """A pytest fixture which yields a test server.
+
+    This test server is used to test various endpoints. After gaining control back, gracefully shuts
+    down the server.
+
+    This fixture 'initializes' the test server with different constraints from the test server in test_app.py
+
+    Args:
+        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
+        mock_settings_get: Pytest fixture which mocks settings.get() to return dev settings when env 'MWI_DEV' is set to False.
+
+    Yields:
+        [aiohttp_client]: A aiohttp_client to send HTTP requests.
+    """
+
+    with FakeServer(loop, aiohttp_client) as test_server:
+        yield test_server
+
+
+async def test_non_dev(test_server):
+    """Tests whether static files are being added to the web server.
+
+    This test checks if the test_server successfully added the static files built and
+    copied into matlab_proxy/gui folder are added to the static_route_table of the server.
+
+    Args:
+        test_server (aiohttp_client): A aiohttp server to send HTTP requests to.
+    """
+    resp = await test_server.get("/get_status")
+    assert resp.status == 200
+
+    assert test_server.app["static_route_table"] is not None