Prefix all environment variables needed by integration with MWI_

Update README.md with new names for environment variables

Author: prabhakk-mw

Development_Customization_Info.md

@@ -26,7 +26,7 @@ source .venv/bin/activate
 # Install the Python package (and dependencies) in development mode (skip this if already done)
 pip install -e .[dev]
 # Start the development server
-DEV=true adev runserver jupyter_matlab_proxy/app.py
+MWI_DEV=true adev runserver jupyter_matlab_proxy/app.py
 ```
 
 If you make any changes to either the JavaScript code or the Python code, then these apps will reload immediately showing the results. Bear in mind that this kind of live-reloading can have an impact on application state (on the serverside particularly). This occurs independently for the JavaScript and Python applications. So if you are working only on the frontend, the backend state will never be affected by changes to the frontend and vice-versa.

README.md

@@ -90,22 +90,22 @@ If you want to use this integration with JupyterHub®, then you must install the
 
 ### Environment Variables
 
-To control the behavior of the MATLAB integration for Jupyter, you can optionally specify the environment variables described in this section. You must specify these variables before starting your Jupyter environment. For example, specify the variable `APP_PORT` to be equal to 8888 when you start the Jupyter notebook using the command below:
+To control the behavior of the MATLAB integration for Jupyter, you can optionally specify the environment variables described in this section. You must specify these variables before starting your Jupyter environment. For example, specify the variable `MWI_APP_PORT` to be equal to 8888 when you start the Jupyter notebook using the command below:
 
 ```bash
-env APP_PORT=8888 jupyter notebook
+env MWI_APP_PORT=8888 jupyter notebook
 ```
 **MARKDOWN TABLE**
 
 These values are preset for you when you access the integration from the Jupyter console.
 | Name | Type | Example Value | Description |
 | ---- | ---- | ------------- | ----------- |
 | **MLM_LICENSE_FILE** | string | `"[email protected]"` | When you want to use either a license file or a network license manager to license MATLAB, specify this variable.</br> For example, specify the location of the network license manager to be `123@hostname`|                                                                         
-| **LOG_LEVEL** | string | `"CRITICAL"` | Specify the Python log level to be one of the following `NOTSET`, `DEBUG`, `INFO`, `WARN`, `ERROR`, or `CRITICAL`. For more information on Python log levels, see [Logging Levels](https://docs.python.org/3/library/logging.html#logging-levels) .<br />The default value is `INFO`. |
-| **LOG_FILE** | string | `"/tmp/logs.txt"` | Specify the full path to the file where you want the logs to be written. |
-| **BASE_URL** | string | `"/matlab"` | Set to control the base URL of the app. BASE_URL should start with `/` or be `empty`. |
-| **APP_PORT** | integer | `8080` | Specify the port for the HTTP server to listen on. |
-| **CUSTOM_HTTP_HEADERS** | string  |`'{"Content-Security-Policy": "frame-ancestors *.example.com:*"}'`<br /> OR <br />`"/path/to/your/custom/http-headers.json"` |Specify valid HTTP headers as JSON data in a string format<br />OR <br /> Specify the full path to the JSON file containing (valid) HTTP headers. These headers would be injected into the HTTP response sent to the browser. </br> For  more information, see the CUSTOM_HTTP_HEADERS sub-section in the Advanced Usage section. |
+| **MWI_LOG_LEVEL** | string | `"CRITICAL"` | Specify the Python log level to be one of the following `NOTSET`, `DEBUG`, `INFO`, `WARN`, `ERROR`, or `CRITICAL`. For more information on Python log levels, see [Logging Levels](https://docs.python.org/3/library/logging.html#logging-levels) .<br />The default value is `INFO`. |
+| **MWI_LOG_FILE** | string | `"/tmp/logs.txt"` | Specify the full path to the file where you want the logs to be written. |
+| **MWI_BASE_URL** | string | `"/matlab"` | Set to control the base URL of the app. MWI_BASE_URL should start with `/` or be `empty`. |
+| **MWI_APP_PORT** | integer | `8080` | Specify the port for the HTTP server to listen on. |
+| **MWI_CUSTOM_HTTP_HEADERS** | string  |`'{"Content-Security-Policy": "frame-ancestors *.example.com:*"}'`<br /> OR <br />`"/path/to/your/custom/http-headers.json"` |Specify valid HTTP headers as JSON data in a string format<br />OR <br /> Specify the full path to the JSON file containing (valid) HTTP headers. These headers would be injected into the HTTP response sent to the browser. </br> For  more information, see the MWI_CUSTOM_HTTP_HEADERS sub-section in the Advanced Usage section. |
 
 
 ## Feedback
@@ -115,7 +115,7 @@ We encourage you to try this repository with your environment and provide feedba
 
 ## Advanced Usage
 
-#### CUSTOM_HTTP_HEADERS: 
+#### MWI_CUSTOM_HTTP_HEADERS: 
 If the browser renders the MATLAB Integration for Jupyter with some other content, then web browsers could block the integration because of mismatch of `Content-Security-Policy` header in the response headers from the integration.
 
 To avoid this, providing custom HTTP headers allow browsers to load the content.
@@ -131,7 +131,7 @@ If this integration is rendered along with some other content on the domain `www
 or if you are passing the custom http headers as a string in the environment variable. In bash shell, it could look like :
 
 ```bash
-export CUSTOM_HTTP_HEADERS='{"Content-Security-Policy": "frame-ancestors *.example.com:* https://www.example.com:*;"}'
+export MWI_CUSTOM_HTTP_HEADERS='{"Content-Security-Policy": "frame-ancestors *.example.com:* https://www.example.com:*;"}'
 ```
 
 If you add the `frame-ancestors` directive, the browser does not block the content of this integration hosted on the domain `www.example.com`

jupyter_matlab_proxy/mw_environment_variables.py

@@ -9,14 +9,19 @@ def get_env_name_network_license_manager():
     return "MLM_LICENSE_FILE"
 
 
+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_logging_level():
     """Specifies the logging level used by app's loggers"""
-    return "LOG_LEVEL"
+    return "MWI_LOG_LEVEL"
 
 
 def get_env_name_log_file():
     """Specifies a file into which logging content is directed"""
-    return "LOG_FILE"
+    return "MWI_LOG_FILE"
 
 
 def get_env_name_base_url():
@@ -26,7 +31,7 @@ def get_env_name_base_url():
     Note: The website runs on a URL of the form:
         www.<SERVER ADDRESS>:<PORT NUMBER>/<BASE_URL>/index.html
     """
-    return "BASE_URL"
+    return "MWI_BASE_URL"
 
 
 def get_env_name_app_port():
@@ -36,32 +41,27 @@ def get_env_name_app_port():
     Note: The website runs on a URL of the form:
         www.<SERVER ADDRESS>:<PORT NUMBER>/<BASE_URL>/index.html
     """
-    return "APP_PORT"
+    return "MWI_APP_PORT"
 
 
 def get_env_name_custom_http_headers():
     """Specifies HTTP headers as JSON content, to be injected into responses sent to the browser"""
-    return "CUSTOM_HTTP_HEADERS"
+    return "MWI_CUSTOM_HTTP_HEADERS"
 
 
 def get_env_name_app_host():
     """Specifies the host on which the TCP site (aiohttp server) is being run."""
-    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"
+    return "MWI_APP_HOST"
 
 
 def get_env_name_testing():
     """Set to true when we are running tests in development mode."""
-    return "TEST"
+    return "MWI_TEST"
 
 
 def get_env_name_development():
     """Set to true when we are in development mode."""
-    return "DEV"
+    return "MWI_DEV"
 
 
 def is_development_mode_enabled():

pytest.ini

@@ -1,7 +1,7 @@
 [pytest]
 env =
-    D:DEV=true
-    D:TEST=true
+    D:MWI_DEV=true
+    D:MWI_TEST=true
 testpaths =
     tests
 

tests/conftest.py

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

tests/test_jupyter_server_proxy.py

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

tests/test_non_dev_mode.py

@@ -18,7 +18,7 @@
 def matlab_port_fixture(monkeypatch):
     """A pytest fixture which monkeypatches an environment variable.
 
-    Pytest by default sets DEV to true.
+    Pytest by default sets MWI_DEV to true.
     Args:
         monkeypatch : A built-in pytest fixture
     """
@@ -127,8 +127,8 @@ def test_server_fixture(
         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 '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 'DEV' is set to False.
+        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.

tests/test_settings.py

@@ -130,9 +130,9 @@ def patch_env_variables_fixture(monkeypatch):
     Args:
         monkeypatch : Built-in pytest fixture
     """
-    monkeypatch.setenv("BASE_URL", "localhost")
-    monkeypatch.setenv("APP_PORT", "8900")
-    monkeypatch.setenv("APP_HOST", "localhost")
+    monkeypatch.setenv(mw_env.get_env_name_base_url(), "localhost")
+    monkeypatch.setenv(mw_env.get_env_name_app_port(), "8900")
+    monkeypatch.setenv(mw_env.get_env_name_app_host(), "localhost")
     monkeypatch.setenv(mw_env.get_env_name_network_license_manager(), "123@nlm")
 
 

tests/util/test_custom_headers.py

@@ -10,7 +10,10 @@
 
 def test_get_custom_header_env_var():
     """Test to check if the __get_custom_header_env_var() method returns the expected environment variable name"""
-    assert "CUSTOM_HTTP_HEADERS" == custom_http_headers.__get_custom_header_env_var()
+    assert (
+        mw_env.get_env_name_custom_http_headers()
+        == custom_http_headers.__get_custom_header_env_var()
+    )
 
 
 def test_get_exception_statement():