Set ddux environment variables

Author: diningPhilosopher64

matlab_proxy/__init__.py

@@ -26,3 +26,34 @@ def get_executable_name():
         str: Name of the executable
     """
     return "matlab-proxy-app"
+
+
+def __get_matlab_proxy_base_ddux_value():
+    """Returns the DDUX value for MATLAB use when launched its by matlab-proxy
+
+    Returns:
+        str : DDUX value for MATLAB use.
+    """
+
+    return "MATLAB_PROXY:BASE:V1"
+
+
+def get_mwi_ddux_value(extension_name):
+    """Returns DDUX value for matlab-proxy based on the context from which
+    it is being launched from.
+
+    Args:
+        extension_name (str): The name of the extension/environment
+
+    Returns:
+        str: DDUX value for matlab-proxy based on the environment.
+    """
+    matlab_proxy_ddux_value = __get_matlab_proxy_base_ddux_value()
+
+    if extension_name == get_default_config_name():
+        return matlab_proxy_ddux_value
+    else:
+        variant = extension_name.upper().strip()
+        variant = variant.replace(" ", "_").replace("-", "_")
+        mwi_ddux_value = matlab_proxy_ddux_value.replace("BASE", variant)
+        return mwi_ddux_value

matlab_proxy/app.py

@@ -513,7 +513,7 @@ async def cleanup_background_tasks(app):
 
 
 # config is has a default initializer because it needs to be callable without inputs from ADEV servers
-def create_app(config=matlab_proxy.get_default_config_name()):
+def create_app(config_name=matlab_proxy.get_default_config_name()):
     """Creates the web server and adds the routes,settings and env_config to the server.
 
     Returns:
@@ -522,7 +522,9 @@ def create_app(config=matlab_proxy.get_default_config_name()):
     app = web.Application()
 
     # Get application settings
-    app["settings"] = settings.get(config, dev=mwi_env.is_development_mode_enabled())
+    app["settings"] = settings.get(
+        config_name, dev=mwi_env.is_development_mode_enabled()
+    )
 
     # Initialise application state
     app["state"] = AppState(app["settings"])
@@ -564,9 +566,9 @@ def main():
 
     # The integration needs to be called with --config flag.
     # Parse the passed cli arguments.
-    desired_configuration = util.parse_cli_args()["config"]
+    desired_configuration_name = util.parse_cli_args()["config"]
 
-    app = create_app(desired_configuration)
+    app = create_app(desired_configuration_name)
 
     loop = asyncio.get_event_loop()
 

matlab_proxy/app_state.py

@@ -11,6 +11,7 @@
 import socket
 import errno
 from collections import deque
+import matlab_proxy
 from matlab_proxy.util import mw, mwi_logger
 from matlab_proxy.util.mwi_exceptions import (
     LicensingError,
@@ -502,8 +503,10 @@ async def start_matlab(self, restart_matlab=False):
         matlab_env["MATLAB_LOG_DIR"] = str(self.matlab_ready_file_dir)
         # For r2020b, r2021a
         matlab_env["MW_CD_ANYWHERE_ENABLED"] = "true"
-        # For > r2021b
+        # For >= r2021b
         matlab_env["MW_CD_ANYWHERE_DISABLED"] = "false"
+        matlab_env["MW_CONTEXT_TAGS"] = self.settings.get("mw_context_tags")
+
         if self.licensing["type"] == "mhlm":
             matlab_env["MLM_WEB_LICENSE"] = "true"
             matlab_env["MLM_WEB_USER_CRED"] = access_token_data["token"]

matlab_proxy/default_configuration.py

@@ -9,6 +9,8 @@
     # Use a single word for extension_name
     # It will be used as a flag when launching the integration.
     # NOTE: This name must be used when setting the entrypoint for matlab_proxy in setup.py
+    # Use '-' or '_' seperated values if more than 1 word is used.
+    # Ex: Hello-World, Alice_Bob.
     "extension_name": matlab_proxy.get_default_config_name(),
     # This value will be used in various places on the website UI.
     # Ensure that this is not more than 3 words.

matlab_proxy/settings.py

@@ -74,10 +74,11 @@ def get_dev_settings(config):
         "ssl_context": None,
         "mwi_logs_root_dir": mwi_config_folder / "ports",
         "mwi_proxy_lock_file_name": "mwi_proxy.lock",
+        "mw_context_tags": get_mw_context_tags(matlab_proxy.get_default_config_name()),
     }
 
 
-def get(config=matlab_proxy.get_default_config_name(), dev=False):
+def get(config_name=matlab_proxy.get_default_config_name(), dev=False):
     """Returns the settings specific to the environment in which the server is running in
     If the environment variable 'TEST' is set  to true, will make some changes to the dev settings.
 
@@ -90,7 +91,7 @@ def get(config=matlab_proxy.get_default_config_name(), dev=False):
     """
 
     if dev:
-        settings = get_dev_settings(config)
+        settings = get_dev_settings(config_name)
 
         # 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.
@@ -159,7 +160,7 @@ def get(config=matlab_proxy.get_default_config_name(), dev=False):
             "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",
             "mwi_custom_http_headers": mwi_custom_http_headers.get(),
-            "env_config": mwi_validators.validate_env_config(config),
+            "env_config": mwi_validators.validate_env_config(config_name),
             "ssl_context": get_ssl_context(
                 ssl_cert_file=ssl_cert_file, ssl_key_file=ssl_key_file
             ),
@@ -168,9 +169,34 @@ def get(config=matlab_proxy.get_default_config_name(), dev=False):
             "mwi_logs_root_dir": mwi_config_folder / "ports",
             # Name of the lock file which will be created by this instance of matlab-proxy process.
             "mwi_proxy_lock_file_name": "mwi_proxy.lock",
+            "mw_context_tags": get_mw_context_tags(config_name),
         }
 
 
+def get_mw_context_tags(extension_name):
+    """Returns a string which combines existing MW_CONTEXT_TAGS value and context tags
+    specific to where matlab-proxy is being launched from.
+
+    Returns:
+        str: Which combines existing MW_CONTEXT_TAGS with one from matlab-proxy.
+    """
+    existing_mw_context_tags = os.getenv("MW_CONTEXT_TAGS", "")
+
+    if existing_mw_context_tags:
+        logger.debug(f'Existing MW_CONTEXT_TAGS:"{existing_mw_context_tags}"')
+        existing_mw_context_tags += ","
+
+    mwi_context_tags = matlab_proxy.get_mwi_ddux_value(extension_name)
+    logger.debug(f'DDUX value for matlab-proxy "{mwi_context_tags}"')
+
+    combined_context_tags = existing_mw_context_tags + mwi_context_tags
+    logger.debug(
+        f'Combined DDUX value to be used for MATLAB process: "{combined_context_tags}"'
+    )
+
+    return combined_context_tags
+
+
 def create_xvfb_cmd():
     """Creates the Xvfb command with a write descriptor.
 

matlab_proxy/util/mwi_validators.py

@@ -143,7 +143,7 @@ def validate_base_url(base_url):
 
 def validate_env_config(config):
     """Validates config passed with available "matlab_proxy_configs" entry point in the same
-    python environment.
+    python environment. Computes DDUX value for MATLAB use.
 
     Args:
         config (str): Name of the configuration to use.
@@ -169,6 +169,7 @@ def validate_env_config(config):
 
         logger.debug(f"Successfully validated provided {config} configuration")
         return env_config
+
     else:
         logger.error(
             f"{config} is not a valid config. Available configs are : {list(available_configs.keys())}"

tests/__init__.py

@@ -1 +1,20 @@
 # Copyright 2020 The MathWorks, Inc.
+import matlab_proxy
+
+
+def test_get_mwi_ddux_value():
+    """Tests ddux value for matlab-proxy with different extension names"""
+    expected_result = matlab_proxy.__get_matlab_proxy_base_ddux_value()
+    actual_result = matlab_proxy.get_mwi_ddux_value(
+        matlab_proxy.get_default_config_name()
+    )
+
+    assert expected_result == actual_result
+
+    expected_result = "MATLAB_PROXY:HELLO_WORLD:V1"
+    actual_result = matlab_proxy.get_mwi_ddux_value("hello world")
+
+    assert expected_result == actual_result
+
+    actual_result = matlab_proxy.get_mwi_ddux_value(" \n \t hello-world  \n")
+    assert expected_result == actual_result

tests/test_settings.py

@@ -1,5 +1,6 @@
 # Copyright 2021 The MathWorks, Inc.
 
+import matlab_proxy
 import matlab_proxy.settings as settings
 from matlab_proxy import mwi_environment_variables as mwi_env
 import pytest
@@ -148,3 +149,20 @@ def test_get_dev_false(patch_env_variables, mock_shutil_which):
     assert _settings["matlab_cmd"][0] == "matlab"
     assert os.path.isdir(_settings["matlab_path"])
     assert _settings["matlab_protocol"] == "https"
+
+
+def test_get_mw_context_tags(monkeypatch):
+    """Tests get_mw_context_tags() function to return appropriate MW_CONTEXT_TAGS"""
+
+    # Monkeypatch env var MW_CONTEXT_TAGS to check for if condition
+    dockerhub_mw_context_tags = "MATLAB:DOCKERHUB:V1"
+    monkeypatch.setenv("MW_CONTEXT_TAGS", dockerhub_mw_context_tags)
+
+    extension_name = matlab_proxy.get_default_config_name()
+
+    matlab_proxy_base_context_tags = matlab_proxy.get_mwi_ddux_value(extension_name)
+    expected_result = f"{dockerhub_mw_context_tags},{matlab_proxy_base_context_tags}"
+
+    actual_result = settings.get_mw_context_tags(extension_name)
+
+    assert expected_result == actual_result