Rename files to include mwi_ prefix

Author: prabhakk-mw

jupyter_matlab_proxy/__init__.py

@@ -1,15 +1,15 @@
 # Copyright 2020-2021 The MathWorks, Inc.
 
 import os
-from jupyter_matlab_proxy import mw_environment_variables as mw_env
+from jupyter_matlab_proxy import mwi_environment_variables as mwi_env
 
 
 def _get_env(port, base_url):
     return {
-        mw_env.get_env_name_app_port(): str(port),
-        mw_env.get_env_name_base_url(): f"{base_url}matlab",
-        mw_env.get_env_name_app_host(): "127.0.0.1",
-        mw_env.get_env_name_mhlm_context(): "MATLAB_JUPYTER",
+        mwi_env.get_env_name_app_port(): str(port),
+        mwi_env.get_env_name_base_url(): f"{base_url}matlab",
+        mwi_env.get_env_name_app_host(): "127.0.0.1",
+        mwi_env.get_env_name_mhlm_context(): "MATLAB_JUPYTER",
     }
 
 

jupyter_matlab_proxy/app.py

@@ -9,9 +9,9 @@
 import signal
 from . import settings
 from .app_state import AppState
-from .util import mw_logger
-from .util.exceptions import LicensingError
-from jupyter_matlab_proxy import mw_environment_variables as mw_env
+from .util import mwi_logger
+from .util.mwi_exceptions import LicensingError
+from jupyter_matlab_proxy import mwi_environment_variables as mwi_env
 import pkgutil
 import mimetypes
 
@@ -155,7 +155,7 @@ async def termination_integration_delete(req):
     '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
     """
-    if not mw_env.is_testing_mode_enabled():
+    if not mwi_env.is_testing_mode_enabled():
         sys.exit(0)
 
 
@@ -202,7 +202,7 @@ def make_static_route_table(app):
                         content_type = mimetypes.guess_type(name)[0]
 
                     headers = {"content-type": content_type}
-                    headers.update(app["settings"]["custom_http_headers"])
+                    headers.update(app["settings"]["mwi_custom_http_headers"])
 
                     table[f"{base_url}{parent}/{name}"] = {
                         "mod": mod,
@@ -286,7 +286,7 @@ async def wsforward(ws_from, ws_to):
 
                     headers = res.headers.copy()
                     body = await res.read()
-                    headers.update(req.app["settings"]["custom_http_headers"])
+                    headers.update(req.app["settings"]["mwi_custom_http_headers"])
 
                     return web.Response(headers=headers, status=res.status, body=body)
             except Exception:
@@ -361,7 +361,7 @@ def create_app():
     app = web.Application()
 
     # Get application settings
-    app["settings"] = settings.get(dev=(mw_env.is_development_mode_enabled()))
+    app["settings"] = settings.get(dev=(mwi_env.is_development_mode_enabled()))
 
     # TODO Validate any settings
 
@@ -370,7 +370,7 @@ def create_app():
 
     # In development mode, the node development server proxies requests to this
     # development server instead of serving the static files directly
-    if not mw_env.is_development_mode_enabled():
+    if not mwi_env.is_development_mode_enabled():
         app["static_route_table"] = make_static_route_table(app)
         for key in app["static_route_table"].keys():
             app.router.add_route("GET", key, static_get)
@@ -401,7 +401,7 @@ def get_supported_termination_signals():
 
 def main():
 
-    logger = mw_logger.get(init=True)
+    logger = mwi_logger.get(init=True)
 
     logger.info("Starting MATLAB proxy-app")
 

jupyter_matlab_proxy/app_state.py

@@ -1,7 +1,7 @@
 # Copyright 2020-2021 The MathWorks, Inc.
 
 import asyncio
-from jupyter_matlab_proxy import mw_environment_variables as mw_env
+from jupyter_matlab_proxy import mwi_environment_variables as mwi_env
 import xml.etree.ElementTree as ET
 import os
 import json
@@ -13,8 +13,8 @@
 import socket
 import errno
 from collections import deque
-from .util import mw, mw_logger, validators
-from .util.exceptions import (
+from .util import mw, mwi_logger, mwi_validators
+from .util.mwi_exceptions import (
     LicensingError,
     InternalError,
     OnlineLicensingError,
@@ -25,7 +25,7 @@
 )
 
 
-logger = mw_logger.get()
+logger = mwi_logger.get()
 
 
 class AppState:
@@ -313,8 +313,8 @@ def reserve_matlab_port(self):
         # node application in development mode always uses port 31515 to bypass the
         # reverse proxy. Once this is addressed, remove this special case.
         if (
-            mw_env.is_development_mode_enabled()
-            and not mw_env.is_testing_mode_enabled()
+            mwi_env.is_development_mode_enabled()
+            and not mwi_env.is_testing_mode_enabled()
         ):
             self.matlab_port = 31515
         else:
@@ -402,7 +402,7 @@ async def start_matlab(self, restart=False):
             matlab_env["MW_LOGIN_DISPLAY_NAME"] = self.licensing["display_name"]
             matlab_env["MW_LOGIN_USER_ID"] = self.licensing["user_id"]
             matlab_env["MW_LOGIN_PROFILE_ID"] = self.licensing["profile_id"]
-            if os.getenv(mw_env.get_env_name_mhlm_context()) is None:
+            if os.getenv(mwi_env.get_env_name_mhlm_context()) is None:
                 matlab_env["MHLM_CONTEXT"] = "MATLAB_JAVASCRIPT_DESKTOP"
 
         elif self.licensing["type"] == "nlm":

jupyter_matlab_proxy/devel.py

@@ -4,7 +4,7 @@
 import asyncio, aiohttp
 from aiohttp import web
 import socket, time, os, sys
-from jupyter_matlab_proxy import mw_environment_variables as mw_env
+from jupyter_matlab_proxy import mwi_environment_variables as mwi_env
 
 desktop_html = b"""
 <h1>Fake MATLAB Web Desktop</h1>
@@ -70,7 +70,7 @@ async def fake_matlab_started(app):
 
     # If "123@brokenhost" is specified as the MLM_LICENSE_FILE, exit to simulate an
     # error
-    nlm = os.environ.get(mw_env.get_env_name_network_license_manager())
+    nlm = os.environ.get(mwi_env.get_env_name_network_license_manager())
     if nlm == "123@brokenhost":
         # TODO This should output the exact same text as MATLAB would in the same error
         # state

jupyter_matlab_proxy/mw_environment_variables.py renamed to jupyter_matlab_proxy/mwi_environment_variables.py

@@ -7,8 +7,8 @@
 import uuid
 import socket
 import shutil
-from .util import custom_http_headers, validators
-from jupyter_matlab_proxy import mw_environment_variables as mw_env
+from .util import mwi_custom_http_headers, mwi_validators
+from jupyter_matlab_proxy import mwi_environment_variables as mwi_env
 
 
 def get_matlab_path():
@@ -58,19 +58,19 @@ def get_dev_settings():
         ],
         "create_xvfb_cmd": create_xvfb_cmd,
         "matlab_ready_file": matlab_ready_file,
-        "base_url": os.environ.get(mw_env.get_env_name_base_url(), ""),
-        "app_port": os.environ.get(mw_env.get_env_name_app_port(), 8000),
-        "host_interface": os.environ.get(mw_env.get_env_name_app_host(), "127.0.0.1"),
+        "base_url": os.environ.get(mwi_env.get_env_name_base_url(), ""),
+        "app_port": os.environ.get(mwi_env.get_env_name_app_port(), 8000),
+        "host_interface": os.environ.get(mwi_env.get_env_name_app_host(), "127.0.0.1"),
         "mwapikey": str(uuid.uuid4()),
         "matlab_protocol": "http",
         "matlab_display": ":1",
-        "nlm_conn_str": os.environ.get(mw_env.get_env_name_network_license_manager()),
+        "nlm_conn_str": os.environ.get(mwi_env.get_env_name_network_license_manager()),
         "matlab_config_file": matlab_temp_dir / "proxy_app_config.json",
         "ws_env": ws_env,
         "mwa_api_endpoint": f"https://login{ws_env_suffix}.mathworks.com/authenticationws/service/v4",
         "mhlm_api_endpoint": f"https://licensing{ws_env_suffix}.mathworks.com/mls/service/v1/entitlement/list",
         "mwa_login": f"https://login{ws_env_suffix}.mathworks.com",
-        "custom_http_headers": custom_http_headers.get(),
+        "mwi_custom_http_headers": mwi_custom_http_headers.get(),
     }
 
 
@@ -90,7 +90,7 @@ def get(dev=False):
 
         # If running tests using Pytest, it will set environment variable TEST to true before running tests.
         # Will make test env specific changes before returning the settings.
-        if mw_env.is_testing_mode_enabled():
+        if mwi_env.is_testing_mode_enabled():
 
             # Set ready_delay value to 0 for faster fake MATLAB startup.
             ready_delay = ["--ready-delay", "0"]
@@ -128,20 +128,20 @@ def get(dev=False):
             ],
             "create_xvfb_cmd": create_xvfb_cmd,
             "matlab_ready_file": Path(tempfile.gettempdir()) / "connector.securePort",
-            "base_url": os.environ[mw_env.get_env_name_base_url()],
-            "app_port": os.environ[mw_env.get_env_name_app_port()],
-            "host_interface": os.environ.get(mw_env.get_env_name_app_host()),
+            "base_url": os.environ[mwi_env.get_env_name_base_url()],
+            "app_port": os.environ[mwi_env.get_env_name_app_port()],
+            "host_interface": os.environ.get(mwi_env.get_env_name_app_host()),
             "mwapikey": str(uuid.uuid4()),
             "matlab_protocol": "https",
-            "nlm_conn_str": validators.validate_mlm_license_file(
-                os.environ.get(mw_env.get_env_name_network_license_manager())
+            "nlm_conn_str": mwi_validators.validate_mlm_license_file(
+                os.environ.get(mwi_env.get_env_name_network_license_manager())
             ),
             "matlab_config_file": Path.home() / ".matlab" / "proxy_app_config.json",
             "ws_env": ws_env,
             "mwa_api_endpoint": f"https://login{ws_env_suffix}.mathworks.com/authenticationws/service/v4",
             "mhlm_api_endpoint": f"https://licensing{ws_env_suffix}.mathworks.com/mls/service/v1/entitlement/list",
             "mwa_login": f"https://login{ws_env_suffix}.mathworks.com",
-            "custom_http_headers": custom_http_headers.get(),
+            "mwi_custom_http_headers": mwi_custom_http_headers.get(),
         }
 
 

jupyter_matlab_proxy/settings.py

@@ -2,15 +2,15 @@
 
 import xml.etree.ElementTree as ET
 import aiohttp, os, asyncio, select, logging
-from .exceptions import (
+from .mwi_exceptions import (
     OnlineLicensingError,
     EntitlementError,
     NetworkLicensingError,
     MatlabError,
 )
-from . import mw_logger
+from . import mwi_logger
 
-logger = mw_logger.get()
+logger = mwi_logger.get()
 
 
 def __get_licensing_url():

jupyter_matlab_proxy/util/mw.py

@@ -2,10 +2,10 @@
 
 import os, json, sys
 from json.decoder import JSONDecodeError
-from . import mw_logger
-from jupyter_matlab_proxy import mw_environment_variables as mw_env
+from . import mwi_logger
+from jupyter_matlab_proxy import mwi_environment_variables as mwi_env
 
-logger = mw_logger.get()
+logger = mwi_logger.get()
 
 
 def get():
@@ -181,7 +181,7 @@ def __get_custom_header_env_var():
     Returns:
         String: Environment variable containing path to the file containing custom headers.
     """
-    return mw_env.get_env_name_custom_http_headers()
+    return mwi_env.get_env_name_custom_http_headers()
 
 
 def __get_exception_statement():

jupyter_matlab_proxy/util/custom_http_headers.py renamed to jupyter_matlab_proxy/util/mwi_custom_http_headers.py

@@ -4,7 +4,7 @@
 
 import logging
 import os
-from jupyter_matlab_proxy import mw_environment_variables as mw_env
+from jupyter_matlab_proxy import mwi_environment_variables as mwi_env
 
 
 def get(init=False):
@@ -68,8 +68,8 @@ def get_environment_variable_names():
         {tuple}: name of environment variable to control log level,
                 name of environment variable to control logging to file
     """
-    __log_file_environment_variable_name = mw_env.get_env_name_log_file()
-    __log_level_environment_variable_name = mw_env.get_env_name_logging_level()
+    __log_file_environment_variable_name = mwi_env.get_env_name_log_file()
+    __log_level_environment_variable_name = mwi_env.get_env_name_logging_level()
     return __log_level_environment_variable_name, __log_file_environment_variable_name
 
 

jupyter_matlab_proxy/util/exceptions.py renamed to jupyter_matlab_proxy/util/mwi_exceptions.py

@@ -20,10 +20,10 @@ def validate_mlm_license_file(nlm_conn_str):
     """
     import re
     import os
-    from . import mw_logger
-    from .exceptions import NetworkLicensingError
+    from . import mwi_logger
+    from .mwi_exceptions import NetworkLicensingError
 
-    logger = mw_logger.get()
+    logger = mwi_logger.get()
 
     if nlm_conn_str is None:
         return None

jupyter_matlab_proxy/util/mw_logger.py renamed to jupyter_matlab_proxy/util/mwi_logger.py

@@ -2,11 +2,11 @@
 
 import os, pytest, shutil
 from jupyter_matlab_proxy import settings
-from jupyter_matlab_proxy import mw_environment_variables as mw_env
+from jupyter_matlab_proxy import mwi_environment_variables as mwi_env
 
 
 def pytest_generate_tests(metafunc):
-    os.environ[mw_env.get_env_name_development()] = "true"
+    os.environ[mwi_env.get_env_name_development()] = "true"
 
 
 def __get_matlab_config_file():

jupyter_matlab_proxy/util/validators.py renamed to jupyter_matlab_proxy/util/mwi_validators.py

@@ -4,7 +4,7 @@
 from unittest.mock import patch
 from aiohttp import web
 from jupyter_matlab_proxy import app, settings
-from jupyter_matlab_proxy.util.exceptions import MatlabInstallError
+from jupyter_matlab_proxy.util.mwi_exceptions import MatlabInstallError
 from subprocess import Popen, PIPE
 from jupyter_matlab_proxy.app_state import AppState
 from distutils.dir_util import copy_tree

tests/conftest.py

@@ -2,7 +2,7 @@
 
 import pytest, asyncio, socket, os, tempfile, requests, pty, time, subprocess, sys
 from pathlib import Path
-from jupyter_matlab_proxy import mw_environment_variables as mw_env
+from jupyter_matlab_proxy import mwi_environment_variables as mwi_env
 from collections import namedtuple
 
 """
@@ -38,7 +38,7 @@ def valid_nlm_fixture(monkeypatch):
         monkeypatch : A built-in pytest fixture
     """
 
-    monkeypatch.setenv(mw_env.get_env_name_network_license_manager(), "abc@nlm")
+    monkeypatch.setenv(mwi_env.get_env_name_network_license_manager(), "abc@nlm")
 
 
 @pytest.fixture(name="invalid_nlm")
@@ -52,7 +52,7 @@ def invalid_nlm_fixture(monkeypatch):
         monkeypatch : A built-in pytest fixture
     """
 
-    monkeypatch.setenv(mw_env.get_env_name_network_license_manager(), "123@brokenhost")
+    monkeypatch.setenv(mwi_env.get_env_name_network_license_manager(), "123@brokenhost")
 
 
 @pytest.fixture(name="matlab_process_setup")

tests/test_app.py

@@ -3,15 +3,15 @@
 import jupyter_matlab_proxy
 import os
 from pathlib import Path
-from jupyter_matlab_proxy import mw_environment_variables as mw_env
+from jupyter_matlab_proxy import mwi_environment_variables as mwi_env
 
 
 def test_get_env():
     port = 10000
     base_url = "/foo/"
     r = jupyter_matlab_proxy._get_env(port, base_url)
-    assert r[mw_env.get_env_name_app_port()] == str(port)
-    assert r[mw_env.get_env_name_base_url()] == f"{base_url}matlab"
+    assert r[mwi_env.get_env_name_app_port()] == str(port)
+    assert r[mwi_env.get_env_name_base_url()] == f"{base_url}matlab"
 
 
 def test_setup_matlab():

tests/test_devel.py

@@ -5,7 +5,7 @@
 from distutils.dir_util import copy_tree
 from pathlib import Path
 import jupyter_matlab_proxy
-from jupyter_matlab_proxy import mw_environment_variables as mw_env
+from jupyter_matlab_proxy import mwi_environment_variables as mwi_env
 from tests.test_app import FakeServer
 
 """
@@ -22,7 +22,7 @@ def matlab_port_fixture(monkeypatch):
     Args:
         monkeypatch : A built-in pytest fixture
     """
-    monkeypatch.setenv(mw_env.get_env_name_development(), "false")
+    monkeypatch.setenv(mwi_env.get_env_name_development(), "false")
 
 
 @pytest.fixture(name="build_frontend")