Use mw_environment_variables module to access environment variable names

Author: prabhakk-mw

jupyter_matlab_proxy/__init__.py

@@ -1,14 +1,15 @@
 # Copyright 2020-2021 The MathWorks, Inc.
 
 import os
+from jupyter_matlab_proxy import mw_environment_variables as mw_env
 
 
 def _get_env(port, base_url):
     return {
-        "APP_PORT": str(port),
-        "BASE_URL": f"{base_url}matlab",
-        "APP_HOST": "127.0.0.1",
-        "MHLM_CONTEXT": "MATLAB_JUPYTER",
+        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",
     }
 
 

jupyter_matlab_proxy/app.py

@@ -11,6 +11,7 @@
 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
 import pkgutil
 import mimetypes
 
@@ -154,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 os.environ.get("TEST", "False").lower() != "true":
+    if not mw_env.is_testing_mode_enabled():
         sys.exit(0)
 
 
@@ -360,9 +361,7 @@ def create_app():
     app = web.Application()
 
     # Get application settings
-    app["settings"] = settings.get(
-        dev=(os.environ.get("DEV", "false").lower() == "true")
-    )
+    app["settings"] = settings.get(dev=(mw_env.is_development_mode_enabled()))
 
     # TODO Validate any settings
 
@@ -371,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 os.environ.get("DEV", "false").lower() != "true":
+    if not mw_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)

jupyter_matlab_proxy/app_state.py

@@ -1,6 +1,7 @@
 # Copyright 2020-2021 The MathWorks, Inc.
 
 import asyncio
+from jupyter_matlab_proxy import mw_environment_variables as mw_env
 import xml.etree.ElementTree as ET
 import os
 import json
@@ -60,7 +61,6 @@ def __delete_cached_licensing_file(self):
             # The file being absent is acceptable.
             pass
 
-
     def __reset_and_delete_cached_licensing(self):
         logger.info(f"Resetting cached licensing information...")
         self.licensing = None
@@ -312,7 +312,10 @@ def reserve_matlab_port(self):
         # FIXME Because of https://github.com/http-party/node-http-proxy/issues/1342 the
         # node application in development mode always uses port 31515 to bypass the
         # reverse proxy. Once this is addressed, remove this special case.
-        if os.getenv("DEV") == "true" and os.getenv("TEST", "false").lower() != "true":
+        if (
+            mw_env.is_development_mode_enabled()
+            and not mw_env.is_testing_mode_enabled()
+        ):
             self.matlab_port = 31515
         else:
 
@@ -399,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("MHLM_CONTEXT") is None:
+            if os.getenv(mw_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,6 +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
 
 desktop_html = b"""
 <h1>Fake MATLAB Web Desktop</h1>
@@ -69,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("MLM_LICENSE_FILE")
+    nlm = os.environ.get(mw_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

@@ -1,6 +1,8 @@
 # Copyright 2021 The MathWorks, Inc.
 """This file lists and exposes the environment variables which are used by the integration."""
 
+import os
+
 
 def get_env_name_network_license_manager():
     """Specifies the path to valid license file or address of a network license server"""
@@ -47,9 +49,29 @@ def get_env_name_app_host():
     return "APP_HOST"
 
 
+def get_env_name_mhlm_context():
+    """Specifies the context from which MHLM was initiated. Used by DDUX in MATLAB."""
+    return "MHLM_CONTEXT"
+
+
 def get_env_name_testing():
+    """Set to true when we are running tests in development mode."""
     return "TEST"
 
 
 def get_env_name_development():
+    """Set to true when we are in development mode."""
     return "DEV"
+
+
+def is_development_mode_enabled():
+    """Returns true if the app is in development mode."""
+    return os.getenv(get_env_name_development()).lower() == "true"
+
+
+def is_testing_mode_enabled():
+    """Returns true if the app is in testing mode."""
+    return (
+        is_development_mode_enabled()
+        and os.getenv(get_env_name_testing()).lower() == "true"
+    )

jupyter_matlab_proxy/settings.py

@@ -8,6 +8,7 @@
 import socket
 import shutil
 from .util import custom_http_headers, validators
+from jupyter_matlab_proxy import mw_environment_variables as mw_env
 
 
 def get_matlab_path():
@@ -57,13 +58,13 @@ def get_dev_settings():
         ],
         "create_xvfb_cmd": create_xvfb_cmd,
         "matlab_ready_file": matlab_ready_file,
-        "base_url": os.environ.get("BASE_URL", ""),
-        "app_port": os.environ.get("APP_PORT", 8000),
-        "host_interface": os.environ.get("APP_HOST", "127.0.0.1"),
+        "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"),
         "mwapikey": str(uuid.uuid4()),
         "matlab_protocol": "http",
         "matlab_display": ":1",
-        "nlm_conn_str": os.environ.get("MLM_LICENSE_FILE"),
+        "nlm_conn_str": os.environ.get(mw_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",
@@ -89,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 os.environ.get("TEST", "False").lower() == "true":
+        if mw_env.is_testing_mode_enabled():
 
             # Set ready_delay value to 0 for faster fake MATLAB startup.
             ready_delay = ["--ready-delay", "0"]
@@ -127,13 +128,13 @@ def get(dev=False):
             ],
             "create_xvfb_cmd": create_xvfb_cmd,
             "matlab_ready_file": Path(tempfile.gettempdir()) / "connector.securePort",
-            "base_url": os.environ["BASE_URL"],
-            "app_port": os.environ["APP_PORT"],
-            "host_interface": os.environ.get("APP_HOST"),
+            "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()),
             "mwapikey": str(uuid.uuid4()),
             "matlab_protocol": "https",
             "nlm_conn_str": validators.validate_mlm_license_file(
-                os.environ.get("MLM_LICENSE_FILE")
+                os.environ.get(mw_env.get_env_name_network_license_manager())
             ),
             "matlab_config_file": Path.home() / ".matlab" / "proxy_app_config.json",
             "ws_env": ws_env,

jupyter_matlab_proxy/util/custom_http_headers.py

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

jupyter_matlab_proxy/util/mw_logger.py

@@ -4,6 +4,7 @@
 
 import logging
 import os
+from jupyter_matlab_proxy import mw_environment_variables as mw_env
 
 
 def get(init=False):
@@ -67,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 = "LOG_FILE"
-    __log_level_environment_variable_name = "LOG_LEVEL"
+    __log_file_environment_variable_name = mw_env.get_env_name_log_file()
+    __log_level_environment_variable_name = mw_env.get_env_name_logging_level()
     return __log_level_environment_variable_name, __log_file_environment_variable_name
 
 

tests/test_devel.py

@@ -2,6 +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 collections import namedtuple
 
 """
@@ -37,7 +38,7 @@ def valid_nlm_fixture(monkeypatch):
         monkeypatch : A built-in pytest fixture
     """
 
-    monkeypatch.setenv("MLM_LICENSE_FILE", "abc@nlm")
+    monkeypatch.setenv(mw_env.get_env_name_network_license_manager(), "abc@nlm")
 
 
 @pytest.fixture(name="invalid_nlm")
@@ -51,7 +52,7 @@ def invalid_nlm_fixture(monkeypatch):
         monkeypatch : A built-in pytest fixture
     """
 
-    monkeypatch.setenv("MLM_LICENSE_FILE", "123@brokenhost")
+    monkeypatch.setenv(mw_env.get_env_name_network_license_manager(), "123@brokenhost")
 
 
 @pytest.fixture(name="matlab_process_setup")

tests/test_non_dev_mode.py

@@ -1,13 +1,11 @@
 # Copyright 2021 The MathWorks, Inc.
 
-import pytest, os, socket, subprocess, tempfile, uuid, shutil
+import pytest, os, shutil
 from unittest.mock import patch
-from aiohttp import web
-from jupyter_matlab_proxy import app
 from distutils.dir_util import copy_tree
 from pathlib import Path
-from jupyter_matlab_proxy import settings
 import jupyter_matlab_proxy
+from jupyter_matlab_proxy import mw_environment_variables as mw_env
 from tests.test_app import FakeServer
 
 """
@@ -24,7 +22,7 @@ def matlab_port_fixture(monkeypatch):
     Args:
         monkeypatch : A built-in pytest fixture
     """
-    monkeypatch.setenv("DEV", "false")
+    monkeypatch.setenv(mw_env.get_env_name_development(), "false")
 
 
 @pytest.fixture(name="build_frontend")

tests/test_settings.py

@@ -1,6 +1,7 @@
 # Copyright 2021 The MathWorks, Inc.
 
 import jupyter_matlab_proxy.settings as settings
+from jupyter_matlab_proxy import mw_environment_variables as mw_env
 import pytest
 from pathlib import Path
 import os
@@ -132,7 +133,7 @@ def patch_env_variables_fixture(monkeypatch):
     monkeypatch.setenv("BASE_URL", "localhost")
     monkeypatch.setenv("APP_PORT", "8900")
     monkeypatch.setenv("APP_HOST", "localhost")
-    monkeypatch.setenv("MLM_LICENSE_FILE", "123@nlm")
+    monkeypatch.setenv(mw_env.get_env_name_network_license_manager(), "123@nlm")
 
 
 def test_get_dev_false(patch_env_variables, mock_shutil_which):

tests/util/test_custom_headers.py

@@ -3,6 +3,7 @@
 from json.decoder import JSONDecodeError
 import pytest, os, time, json, stat
 from jupyter_matlab_proxy.util import custom_http_headers
+from jupyter_matlab_proxy import mw_environment_variables as mw_env
 from pathlib import Path
 from contextlib import nullcontext as does_not_raise
 
@@ -44,7 +45,7 @@ def monkeypatch_env_var_with_json_file_fixture(
                                         to non-existent file in a temporary directory.
     """
     monkeypatch.setenv(
-        custom_http_headers.__get_custom_header_env_var(),
+        mw_env.get_env_name_custom_http_headers(),
         str(non_existent_temp_json_file),
     )
 
@@ -186,7 +187,7 @@ def test_get_with_json_file_no_error(
                               have a non-existent temporary json file.
         valid_json_content : Pytest fixture which returns valid json data as a string.
     """
-    tmp_file_path = os.getenv(custom_http_headers.__get_custom_header_env_var())
+    tmp_file_path = os.getenv(mw_env.get_env_name_custom_http_headers())
 
     with open(tmp_file_path, "w") as f:
         f.write(valid_json_content)
@@ -205,7 +206,7 @@ def test_get_with_json_file_raise_exception(
                               have a non-existent temporary json file.
         invalid_json_content : Pytest fixture which returns invalid json data as a string.
     """
-    tmp_file_path = os.getenv(custom_http_headers.__get_custom_header_env_var())
+    tmp_file_path = os.getenv(mw_env.get_env_name_custom_http_headers())
 
     with open(tmp_file_path, "w") as f:
         f.write(invalid_json_content)
@@ -228,9 +229,7 @@ def monkeypatch_env_var_with_invalid_json_string_fixture(
         non_existent_temp_json_file: Pytest fixture which returns a string containing path
                                         to non-existent file in a temporary directory.
     """
-    monkeypatch.setenv(
-        custom_http_headers.__get_custom_header_env_var(), invalid_json_content
-    )
+    monkeypatch.setenv(mw_env.get_env_name_custom_http_headers(), invalid_json_content)
 
 
 def test_get_with_invalid_json_string(
@@ -259,9 +258,7 @@ def monkeypatch_env_var_with_valid_json_string_fixture(monkeypatch, valid_json_c
         non_existent_temp_json_file: Pytest fixture which returns a string containing path
                                         to non-existent file in a temporary directory.
     """
-    monkeypatch.setenv(
-        custom_http_headers.__get_custom_header_env_var(), valid_json_content
-    )
+    monkeypatch.setenv(mw_env.get_env_name_custom_http_headers(), valid_json_content)
 
 
 def test_get_with_valid_json_string(monkeypatch_env_var_with_valid_json_string):
@@ -272,5 +269,5 @@ def test_get_with_valid_json_string(monkeypatch_env_var_with_valid_json_string):
         monkeypatch_env_var_with_valid_json_string : Pytest fixture which monkeypatches the env variable returned by __get_custom_header_env_var() to
                                                      contain valid JSON data as a string.
     """
-    headers = json.loads(os.getenv(custom_http_headers.__get_custom_header_env_var()))
+    headers = json.loads(os.getenv(mw_env.get_env_name_custom_http_headers()))
     assert headers == custom_http_headers.get()

tests/util/test_mw_validators.py

@@ -39,4 +39,3 @@ def test_get_with_environment_variables(monkeypatch):
         assert conn_str == str(path)
     finally:
         os.remove(path)
-