Basic validation for plugin settings and pattern for extending valida…

…tors in construct

docs/development/plugins.md

@@ -6,6 +6,13 @@
 ## Parser Plugins
 With version 2.0, Joystick Diagrams has moved to a plugin system to allow further games to be supported faster.
 
+## Plugin Structure
+-  plugins/ - Directory for plugins
+   - *plugin name*
+     - \__init\__.py
+     - main.py
+     - config.py
+
 ### Example Plugin
 
 ```python

joystick_diagrams/plugin_manager.py

@@ -9,13 +9,19 @@
 import logging
 import os
 from importlib import import_module
+from json import JSONDecodeError
 from pathlib import Path
 from types import ModuleType
 
+import dynaconf
+from dynaconf import ValidationError
+
 import joystick_diagrams.exceptions as JDException
+from joystick_diagrams.plugins.plugin_interface import PluginInterface
 
 _logger = logging.getLogger(__name__)
 PLUGINS_DIRECTORY = "plugins"
+PLUGIN_REL_PATH = ".plugins."
 
 
 class ParserPluginManager:
@@ -27,20 +33,25 @@ def __init__(self):
             for plugin in self.plugins:
                 try:
                     # Try initiate the plugin
-                    self.loaded_plugins.append(self.load_plugin(plugin))
-                except JDException.PluginNotValid as e:
-                    _logger.error(e)
+                    loaded = self.load_plugin(plugin)
+                    self.validate_plugin(loaded)
+                    self.loaded_plugins.append(loaded)
+
+                except (JDException.PluginNotValid, JSONDecodeError, AttributeError, ValidationError) as e:
+                    _logger.error(f"Error with Plugin: {plugin} - {e}")
+
         else:
             raise JDException.NoPluginsExist()
 
+    def validate_plugin(self, plugin: PluginInterface) -> None | ValidationError:
+        return plugin.settings.validators.validate_all()
+
     def load_plugin(self, module_path: str) -> ModuleType:
         """Attempt to load the plugin"""
         try:
             _logger.debug(f"Loading plugin at module path: {module_path}")
-            directory = ".plugins."
-            path = os.path.join(directory, module_path)
 
-            return import_module(directory + module_path + ".main", package=__package__).ParserPlugin()
+            return import_module(PLUGIN_REL_PATH + module_path + ".main", package=__package__).ParserPlugin()
         except TypeError as e:
             _logger.error(f"{e} - {module_path}")
             raise JDException.PluginNotValid(error=e, value=module_path) from e

joystick_diagrams/plugins/examplePlugin/config.py

@@ -0,0 +1,13 @@
+from pathlib import Path
+
+from dynaconf import Dynaconf, Validator
+
+settings = Dynaconf(
+    settings_files=[f"{Path(__file__).parent.joinpath('settings.json')}"],
+)
+
+settings.validators.register(
+    Validator("PLUGIN_NAME", required=True),
+    Validator("PLUGIN_ICON", required=True),
+    Validator("VERSION", required=True),
+)

joystick_diagrams/plugins/plugin1/main.py → joystick_diagrams/plugins/examplePlugin/main.py

@@ -1,13 +1,10 @@
 import logging
 from pathlib import Path
 
-from joystick_diagrams.plugins.plugin_interface import PluginInterface
-
-from .config import settings
+from config import settings
+from dynaconf import Dynaconf, Validator
 
-PLUGIN_NAME = "Star Citizen"
-PLUGIN_ICON = "img/logo.ico"
-VERSION = "0.0.1"
+from joystick_diagrams.plugins.plugin_interface import PluginInterface
 
 _logger = logging.getLogger("__name__")
 
@@ -16,6 +13,7 @@ class ParserPlugin(PluginInterface):
     def __init__(self):
         self.path = None
         self.settings = settings
+        self.settings.validators.register()
 
     def process(self):
         return None
@@ -26,16 +24,20 @@ def set_path(self, path: Path) -> bool:
 
     @property
     def name(self) -> str:
-        return f"{PLUGIN_NAME}"
+        return f"{self.settings.PLUGIN_NAME}"
 
     @property
     def version(self) -> str:
-        return f"{VERSION}"
+        return f"{self.settings.VERSION}"
 
     @property
     def icon(self) -> str:
-        return f"{Path.joinpath(Path(__file__).parent,PLUGIN_ICON)}"
+        return f"{Path.joinpath(Path(__file__).parent,self.settings.PLUGIN_ICON)}"
 
     @property
     def get_path(self) -> bool:
         return self.path
+
+
+if __name__ == "__main__":
+    plugin = ParserPlugin()

joystick_diagrams/plugins/examplePlugin/settings.json

@@ -0,0 +1,5 @@
+{
+    "PLUGIN_NAME": "Star Citizen",
+    "PLUGIN_ICON": "./img/logo.ico",
+    "VERSION": "0.0.1"
+}

joystick_diagrams/plugins/plugin_interface.py

@@ -1,10 +1,14 @@
 from abc import ABC, abstractmethod
 from pathlib import Path
 
+import dynaconf
+
 import joystick_diagrams.exceptions as JDException
 
 
 class PluginInterface(ABC):
+    settings: dynaconf.LazySettings
+
     def file_not_valid_exception(self, exceptionMessage: str):
         return JDException.FileNotValid(value=exceptionMessage)