update hooks commands

Author: mplsgrant

src/warnet/constants.py

@@ -38,10 +38,12 @@
 DEFAULTS_NAMESPACE_FILE = "namespace-defaults.yaml"
 
 # Plugin architecture
-PLUGINS_DIR = RESOURCES_DIR.joinpath("plugins")
+PLUGINS_LABEL = "plugins"
+PLUGINS_DIR = RESOURCES_DIR.joinpath(PLUGINS_LABEL)
 HOOK_NAME_KEY = "hook_name"  # this lives as a key in object.__annotations__
 HOOKS_API_STEM = "hooks_api"
 HOOKS_API_FILE = HOOKS_API_STEM + ".py"
+WARNET_USER_DIR_ENV_VAR = "WARNET_USER_DIR"
 
 # Helm charts
 BITCOIN_CHART_LOCATION = str(CHARTS_DIR.joinpath("bitcoincore"))

src/warnet/hooks.py

@@ -4,14 +4,37 @@
 import sys
 from importlib.metadata import PackageNotFoundError, version
 from pathlib import Path
-from typing import Any, Callable
+from typing import Any, Callable, Optional
 
-from warnet.constants import HOOK_NAME_KEY, HOOKS_API_FILE, HOOKS_API_STEM
+import click
+
+from warnet.constants import (
+    HOOK_NAME_KEY,
+    HOOKS_API_FILE,
+    HOOKS_API_STEM,
+    PLUGINS_LABEL,
+    WARNET_USER_DIR_ENV_VAR,
+)
 
 hook_registry: set[Callable[..., Any]] = set()
 imported_modules = {}
 
 
+@click.group(name="plugin")
+def plugin():
+    pass
+
+
+@plugin.command()
+def ls():
+    plugin_dir = get_plugin_directory()
+
+    if not plugin_dir:
+        click.secho("Could not determine the plugin directory location.")
+        click.secho("Consider setting environment variable containing your project directory:")
+        click.secho(f"export {WARNET_USER_DIR_ENV_VAR}=/home/user/path/to/project/", fg="yellow")
+
+
 def api(func: Callable[..., Any]) -> Callable[..., Any]:
     """
     Functions with this decoration will have corresponding 'pre' and 'post' functions made
@@ -73,6 +96,9 @@ def create_hooks(directory: Path):
                 )
             )
 
+    click.secho("\nConsider setting environment variable containing your project directory:")
+    click.secho(f"export {WARNET_USER_DIR_ENV_VAR}={directory.parent}\n", fg="yellow")
+
 
 decorator_code = """
 
@@ -102,25 +128,27 @@ def post_{hook}(func):
 
 def load_user_modules() -> bool:
     was_successful_load = False
-    user_module_path = Path.cwd() / "plugins"
 
-    if not user_module_path.is_dir():
+    plugin_dir = get_plugin_directory()
+
+    if not plugin_dir or not plugin_dir.is_dir():
         return was_successful_load
 
-    # Temporarily add the current directory to sys.path for imports
-    sys.path.insert(0, str(Path.cwd()))
+    # Temporarily add the directory to sys.path for imports
+    sys.path.insert(0, str(plugin_dir))
+
+    hooks_path = plugin_dir / HOOKS_API_FILE
 
-    hooks_path = user_module_path / HOOKS_API_FILE
     if hooks_path.is_file():
         hooks_spec = importlib.util.spec_from_file_location(HOOKS_API_STEM, hooks_path)
         hooks_module = importlib.util.module_from_spec(hooks_spec)
         imported_modules[HOOKS_API_STEM] = hooks_module
         sys.modules[HOOKS_API_STEM] = hooks_module
         hooks_spec.loader.exec_module(hooks_module)
 
-    for file in user_module_path.glob("*.py"):
+    for file in plugin_dir.glob("*.py"):
         if file.stem not in ("__init__", HOOKS_API_STEM):
-            module_name = f"plugins.{file.stem}"
+            module_name = f"{PLUGINS_LABEL}.{file.stem}"
             spec = importlib.util.spec_from_file_location(module_name, file)
             module = importlib.util.module_from_spec(spec)
             imported_modules[module_name] = module
@@ -145,6 +173,17 @@ def find_hooks(module_name: str, func_name: str):
     return pre_hooks, post_hooks
 
 
+def get_plugin_directory() -> Optional[Path]:
+    user_dir = os.getenv(WARNET_USER_DIR_ENV_VAR)
+
+    plugin_dir = Path(user_dir) / PLUGINS_LABEL if user_dir else Path.cwd() / PLUGINS_LABEL
+
+    if plugin_dir and plugin_dir.is_dir():
+        return plugin_dir
+    else:
+        return None
+
+
 def get_version(package_name: str) -> str:
     try:
         return version(package_name)

src/warnet/main.py

@@ -6,6 +6,7 @@
 from .dashboard import dashboard
 from .deploy import deploy
 from .graph import create, graph
+from .hooks import plugin
 from .image import image
 from .project import init, new, setup
 from .status import status
@@ -34,6 +35,7 @@ def cli():
 cli.add_command(status)
 cli.add_command(stop)
 cli.add_command(create)
+cli.add_command(plugin)
 
 
 if __name__ == "__main__":