Introduce Windows® Operating System support for the matlab-proxy package.

Author: diningPhilosopher64

.gitignore

@@ -3,7 +3,7 @@
 __pycache__/
 build/
 dist/
-.venv/
+.venv*/
 .vscode/
 htmlcov/
 .coverage

README.md

@@ -1,5 +1,4 @@
 # MATLAB Proxy
-
 [![GitHub Workflow Status](https://img.shields.io/github/workflow/status/mathworks/matlab-proxy/Testing%20MATLAB%20Proxy?logo=github)](https://github.com/mathworks/matlab-proxy/actions)   [![PyPI badge](https://img.shields.io/pypi/v/matlab-proxy.svg?logo=pypi)](https://pypi.python.org/pypi/matlab-proxy)    [![codecov](https://codecov.io/gh/mathworks/matlab-proxy/branch/main/graph/badge.svg?token=ZW3SESKCSS)](https://codecov.io/gh/mathworks/matlab-proxy)   [![Downloads](https://static.pepy.tech/personalized-badge/matlab-proxy?period=month&units=international_system&left_color=grey&right_color=blue&left_text=PyPI%20downloads/month)](https://pepy.tech/project/matlab-proxy)
 
 Copyright (c) 2020-2022 The MathWorks, Inc. All rights reserved.
@@ -26,16 +25,18 @@ The MATLAB Proxy is under active development. For support or to report issues, s
 - [Feedback](#feedback)
 
 ## Requirements
-* Linux® operating system
+* Linux® or a Windows® Operating System
 
 * MATLAB® R2020b or later is installed and on the system PATH.
   ```bash
   # Confirm MATLAB is on the PATH
   which matlab
-  ```
+  ```  
 * The dependencies required to run MATLAB.
   Refer to the Dockerfiles in the [matlab-deps](https://github.com/mathworks-ref-arch/container-images/tree/master/matlab-deps) repository for the desired version of MATLAB.
-* X Virtual Frame Buffer (Xvfb)
+  
+* X Virtual Frame Buffer (Xvfb) : (only for Linux® based systems)
+
   Install it on your linux machine using:
   ```bash
   # On a Debian/Ubuntu based system:
@@ -130,6 +131,28 @@ The following options are available in the status panel (some options are only a
 * For upgrading **matlab-proxy** in an existing Docker image, see this [Dockerfile.upgrade.matlab-proxy](./examples/Dockerfile.upgrade.matlab-proxy) and its [README](./examples/README.md#upgrading-matlab-proxy-package-in-a-docker-image).*
 * For usage in a Jupyter environment, see [jupyter-matlab-proxy](https://github.com/mathworks/jupyter-matlab-proxy).
 
+## Platform Support
+
+### Linux
+This package is fully supported for the Linux Operating System.
+
+### Windows
+
+Windows® Operating System support was introduced in package version `v0.4.0`. If you encounter any errors, see the [Feedback](#feedback) section to report them.
+
+Install the version >=0.4.0 to use the package on Windows.
+```bash
+# To upgrade an existing installation of matlab-proxy package:
+$ pip install --upgrade matlab-proxy>=0.4.0
+
+# Or to make a new installation of the latest version:
+$ pip install matlab-proxy 
+```
+
+### MacOS
+
+This package is not supported for the Apple® Mac Operating System. 
+
 ## Limitations
 This package supports the same subset of MATLAB features and commands as MATLAB® Online, except there is no support for Simulink® Online.
 [Click here for a full list of Specifications and Limitations for MATLAB Online](https://www.mathworks.com/products/matlab-online/limitations.html). 

conftest.py

@@ -0,0 +1,50 @@
+# Copyright 2020-2021 The MathWorks, Inc.
+
+import os
+import shutil
+
+import pytest
+
+from matlab_proxy import settings
+from matlab_proxy.util.mwi import environment_variables as mwi_env
+
+
+def pytest_generate_tests(metafunc):
+    os.environ[mwi_env.get_env_name_development()] = "true"
+
+
+def __get_matlab_config_file():
+    return settings.get(dev=True)["matlab_config_file"]
+
+
+def __delete_matlab_config_file():
+    os.remove(__get_matlab_config_file())
+
+
+@pytest.fixture(autouse=True, scope="session")
+def pre_test_cleanup():
+    """A pytest fixture which deletes matlab_config_file before executing tests.
+
+    If a previous pytest run fails, this file may have an empty Dict which leads
+    to the server never starting up matlab.
+    """
+    try:
+        __delete_matlab_config_file()
+    except FileNotFoundError:
+        pass
+
+
+@pytest.fixture(scope="session", autouse=True)
+def cleanup(request):
+    """Cleanup the temp directory once we are finished."""
+
+    def delete_matlab_test_dir():
+        # Delete matlab_config_file & its owning directory
+        matlab_config_file = __get_matlab_config_file()
+        matlab_config_dir = os.path.dirname(matlab_config_file)
+        try:
+            shutil.rmtree(matlab_config_dir)
+        except FileNotFoundError:
+            pass
+
+    request.addfinalizer(delete_matlab_test_dir)

matlab_proxy/__init__.py

@@ -1,4 +1,5 @@
 # Copyright (c) 2020-2022 The MathWorks, Inc.
+from matlab_proxy.util import system
 
 
 def get_entrypoint_name():
@@ -34,8 +35,9 @@ def __get_matlab_proxy_base_ddux_value():
     Returns:
         str : DDUX value for MATLAB use.
     """
+    current_os = system.get_os().upper()
 
-    return "MATLAB_PROXY:BASE:V1"
+    return f"MATLAB_PROXY:BASE:{current_os}:V1"
 
 
 def get_mwi_ddux_value(extension_name):

matlab_proxy/app.py

@@ -95,6 +95,7 @@ async def create_status_response(app, loadUrl=None):
         JSONResponse: A JSONResponse object containing the generic state of the server, MATLAB and MATLAB Licensing.
     """
     state = app["state"]
+
     return web.json_response(
         {
             "matlab": {
@@ -250,20 +251,23 @@ async def termination_integration_delete(req):
     Args:
         req (HTTPRequest): HTTPRequest Object
     """
+    logger.debug("Terminating the integration...")
     state = req.app["state"]
 
     # Send response manually because this has to happen before the application exits
     res = await create_status_response(req.app, "../")
     await res.prepare(req)
     await res.write_eof()
 
+    logger.debug("Shutting down the server...")
     # End termination with 0 exit code to indicate intentional termination
     await req.app.shutdown()
     await req.app.cleanup()
     """When testing with pytest, its not possible to catch sys.exit(0) using the construct 
     'with pytest.raises()', there by causing the test : test_termination_integration_delete() 
     to fail. Inorder to avoid this, adding the below if condition to check to skip sys.exit(0) when testing
     """
+    logger.debug("Exiting with return code 0")
     if not mwi_env.is_testing_mode_enabled():
         sys.exit(0)
 
@@ -523,7 +527,8 @@ async def cleanup_background_tasks(app):
     # First stop matlab
     state = app["state"]
     state.clean_up_mwi_server_session()
-    await state.stop_matlab()
+
+    await state.stop_matlab(force_quit=True)
 
     # Stop any running async tasks
     logger = mwi.logger.get()
@@ -671,21 +676,23 @@ def main():
     app = configure_and_start(app)
 
     loop = util.get_event_loop()
+
     # Add signal handlers for the current python process
     loop = util.add_signal_handlers(loop)
-    loop.run_forever()
+    try:
+        loop.run_forever()
+    except SystemExit:
+        pass
 
     async def shutdown():
         """Shuts down the app in the event of a signal interrupt."""
         logger.info("Shutting down MATLAB proxy-app")
+
         await app.shutdown()
         await app.cleanup()
-        for task in asyncio.Task.all_tasks():
-            logger.debug(f"calling cancel on all_tasks: {task}")
-            task.cancel()
-            await task
 
-        asyncio.ensure_future(exit())
+        # Shutdown any running tasks.
+        await util.cancel_tasks(asyncio.all_tasks())
 
     try:
         loop.run_until_complete(shutdown())