Introduces the notion of mandatory keys in the configuration of entrypoints.

Author: krisctl

matlab_proxy/default_configuration.py

@@ -1,20 +1,53 @@
 # Copyright 2020-2024 The MathWorks, Inc.
+from enum import Enum
+from typing import List
+
 import matlab_proxy
 
+
+class ConfigKeys(Enum):
+    """Enumeration for configuration keys used in the MATLAB proxy setup."""
+
+    DOC_URL = "doc_url"
+    EXT_NAME = "extension_name"
+    EXT_NAME_DESC = "extension_name_short_description"
+    SHOW_SHUTDOWN_BUTTON = "should_show_shutdown_button"
+
+
 # Configure matlab_proxy
 config = {
     # Link the documentation url here. This will show up on the website UI
     # where users can create issue's or make enhancement requests
-    "doc_url": "https://github.com/mathworks/matlab-proxy/",
+    ConfigKeys.DOC_URL.value: "https://github.com/mathworks/matlab-proxy/",
     # 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(),
+    ConfigKeys.EXT_NAME.value: 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.
-    "extension_name_short_description": "MATLAB Desktop",
+    ConfigKeys.EXT_NAME_DESC.value: "MATLAB Desktop",
     # Show the shutdown button in the UI for matlab-proxy
-    "should_show_shutdown_button": True,
+    ConfigKeys.SHOW_SHUTDOWN_BUTTON.value: True,
 }
+
+
+def get_required_config() -> List[str]:
+    """Get the list of required configuration keys.
+
+    This function returns a list of keys that are required for
+    the MATLAB proxy configuration. These keys are used to
+    ensure that the configuration dictionary contains all the
+    necessary entries.
+
+    Returns:
+        list: A list of strings representing the required
+        configuration keys.
+    """
+    required_keys: List[str] = [
+        ConfigKeys.DOC_URL,
+        ConfigKeys.EXT_NAME,
+        ConfigKeys.EXT_NAME_DESC,
+    ]
+    return [key.value for key in required_keys]

matlab_proxy/util/mwi/validators.py

@@ -179,30 +179,31 @@ def validate_env_config(config):
     Returns:
         Dict: Containing data specific to the environment in which MATLAB proxy is being used in.
     """
-    available_configs = __get_configs()
+    from matlab_proxy.default_configuration import get_required_config
+
+    available_configs: dict = __get_configs()
     config = config.lower()
 
     # Check if supplied config is present in the available configs
     if config in available_configs:
-        # Check if all keys are present in the supplied config
-        default_config_keys = available_configs[
-            matlab_proxy.get_default_config_name()
-        ].keys()
         env_config = available_configs[config]
+        required_keys = get_required_config()
 
-        for key in default_config_keys:
-            if not key in env_config:
-                error_message = f"{key} missing in the provided {config} configuration"
-                logger.error(error_message)
-                raise FatalError(error_message)
+        # Check if all required keys are present in the supplied config
+        valid = all(key in env_config for key in required_keys)
+        if not valid:
+            error_message = (
+                f"Required key/s missing in the provided {config} configuration"
+            )
+            logger.error(error_message)
+            raise FatalError(error_message)
 
-        logger.debug(f"Successfully validated provided {config} configuration")
+        logger.debug("Successfully validated provided %s configuration", config)
         return env_config
 
-    else:
-        error_message = f"{config} is not a valid config. Available configs are : {list(available_configs.keys())}"
-        logger.error(error_message)
-        raise FatalError(error_message)
+    error_message = f"{config} is not a valid config. Available configs are : {list(available_configs.keys())}"
+    logger.error(error_message)
+    raise FatalError(error_message)
 
 
 def __get_configs():

tests/unit/util/mwi/test_validators.py

@@ -1,7 +1,6 @@
-# Copyright 2020-2023 The MathWorks, Inc.
+# Copyright 2020-2024 The MathWorks, Inc.
 
-"""Tests for functions in matlab_proxy/util/mwi_validators.py
-"""
+"""Tests for functions in matlab_proxy/util/mwi_validators.py"""
 
 import os
 import random
@@ -185,8 +184,8 @@ def test_validate_env_config_true():
 def test_validate_env_config_false():
     """Passing a non existent config should raise FatalError exception"""
 
-    with pytest.raises(FatalError) as e:
-        config = validators.validate_env_config(str(random.randint(10, 100)))
+    with pytest.raises(FatalError):
+        validators.validate_env_config(str(random.randint(10, 100)))
 
 
 def test_get_configs():