add --user-dir option for plugins

Author: mplsgrant

resources/plugins/simln/simln.py

@@ -18,7 +18,7 @@
     get_static_client,
     wait_for_pod,
 )
-from warnet.plugins import _get_plugins_directory as get_plugin_directory
+from warnet.plugins import get_plugins_directory_or as get_plugin_directory
 from warnet.process import run_command
 from warnet.status import _get_tank_status as network_status
 

src/warnet/constants.py

@@ -42,6 +42,7 @@
 DEFAULTS_NAMESPACE_FILE = "namespace-defaults.yaml"
 
 # Plugin architecture
+USER_DIR_TAG = "user_dir"
 PLUGINS_LABEL = "plugins"
 PLUGIN_YAML = "plugin.yaml"
 PLUGINS_DIR = RESOURCES_DIR.joinpath(PLUGINS_LABEL)

src/warnet/main.py

@@ -1,5 +1,9 @@
+from pathlib import Path
+
 import click
 
+from warnet.constants import USER_DIR_TAG
+
 from .admin import admin
 from .bitcoin import bitcoin
 from .control import down, logs, run, snapshot, stop
@@ -8,14 +12,25 @@
 from .graph import create, graph, import_network
 from .image import image
 from .ln import ln
-from .plugins import load_plugins, plugins
+from .plugins import load_plugins, load_user_modules, plugins
 from .project import init, new, setup
 from .status import status
 from .users import auth
 
 
 @click.group()
-def cli():
+@click.option(
+    "--user-dir",
+    type=click.Path(exists=True, file_okay=False),
+    help="Path to the user's Warnet project directory.",
+)
+@click.pass_context
+def cli(ctx, user_dir: str):
+    ctx.ensure_object(dict)  # initialize ctx object
+    if user_dir:
+        ctx.obj[USER_DIR_TAG] = Path(user_dir)
+    if load_user_modules(ctx.obj.get(USER_DIR_TAG)):
+        load_plugins()
     pass
 
 
@@ -41,10 +56,5 @@ def cli():
 cli.add_command(plugins)
 
 
-@load_plugins
-def load_early():
-    pass
-
-
 if __name__ == "__main__":
     cli()

src/warnet/plugins.py

@@ -18,6 +18,7 @@
     MISSION_TAG,
     PLUGIN_YAML,
     PLUGINS_LABEL,
+    USER_DIR_TAG,
     WARNET_USER_DIR_ENV_VAR,
 )
 
@@ -37,9 +38,10 @@ def plugins():
 
 
 @plugins.command()
-def ls():
+@click.pass_context
+def ls(ctx):
     """List all available plugins and whether they are activated"""
-    plugin_dir = _get_plugins_directory()
+    plugin_dir = get_plugins_directory_or(ctx.obj.get(USER_DIR_TAG))
     if plugin_dir is None:
         direct_user_to_plugin_directory_and_exit()
 
@@ -52,9 +54,10 @@ def ls():
 
 @plugins.command()
 @click.argument("plugin", type=str, default="")
-def toggle(plugin: str):
+@click.pass_context
+def toggle(ctx, plugin: str):
     """Toggle a plugin on or off"""
-    plugin_dir = _get_plugins_directory()
+    plugin_dir = get_plugins_directory_or(ctx.obj.get(USER_DIR_TAG))
     if plugin_dir is None:
         direct_user_to_plugin_directory_and_exit()
 
@@ -85,10 +88,10 @@ def toggle(plugin: str):
     write_yaml(updated_settings, plugin_dir / Path(plugin) / Path(PLUGIN_YAML))
 
 
-def load_user_modules() -> bool:
+def load_user_modules(path: Optional[Path] = None) -> bool:
     was_successful_load = False
 
-    plugin_dir = _get_plugins_directory()
+    plugin_dir = get_plugins_directory_or(path)
 
     if not plugin_dir or not plugin_dir.is_dir():
         return was_successful_load
@@ -125,15 +128,23 @@ def register_command(command):
     register.add_command(command)
 
 
-def load_plugins(fn):
-    load_user_modules()
+def load_plugins():
     for module in imported_modules.values():
         for name, func in inspect.getmembers(module, inspect.isfunction):
             if name == "warnet_register_plugin":
                 func(register_command)
 
 
-def _get_plugins_directory() -> Optional[Path]:
+def get_plugins_directory_or(path: Optional[Path] = None) -> Optional[Path]:
+    """Get the plugins directory
+    user-provided path > environment variable > relative path
+    """
+    if path:
+        if path.is_dir():
+            return path / PLUGINS_LABEL
+        else:
+            click.secho(f"Not a directory: {path}", fg="red")
+
     user_dir = os.getenv(WARNET_USER_DIR_ENV_VAR)
 
     plugin_dir = Path(user_dir) / PLUGINS_LABEL if user_dir else Path.cwd() / PLUGINS_LABEL
@@ -147,7 +158,7 @@ def _get_plugins_directory() -> Optional[Path]:
 def direct_user_to_plugin_directory_and_exit():
     click.secho("Could not determine the plugin directory location.")
     click.secho(
-        "Solution 1: try runing this command again, but this time from your initialized warnet directory."
+        "Solution 1: try runing this command again, but this time from your initialized Warnet directory."
     )
     click.secho(
         "Solution 2: consider setting environment variable pointing to your Warnet project directory:"
@@ -190,7 +201,7 @@ def check_if_plugin_enabled(path: Path) -> bool:
 
 def get_plugins_with_status(plugin_dir: Optional[Path] = None) -> list[tuple[Path, bool]]:
     if not plugin_dir:
-        plugin_dir = _get_plugins_directory()
+        plugin_dir = get_plugins_directory_or()
     candidates = [
         Path(os.path.join(plugin_dir, name))
         for name in os.listdir(plugin_dir)

test/simln_test.py

@@ -32,6 +32,7 @@ def run_test(self):
             self.run_plugin()
             self.copy_results()
             self.run_activity()
+            self.run_activity_with_user_dir()
         finally:
             self.cleanup()
 
@@ -75,6 +76,17 @@ def run_activity(self):
         self.wait_for_predicate(partial_func)
         self.log.info("Successfully ran activity")
 
+    def run_activity_with_user_dir(self):
+        cmd = "mkdir temp; cd temp; warnet --user-dir ../ plugins simln get-example-activity; cd ../; rm -rf temp"
+        self.log.info(f"Activity: {cmd}")
+        activity_result = run_command(cmd)
+        activity = json.loads(activity_result)
+        pod_result = run_command(f"warnet plugins simln launch-activity '{json.dumps(activity)}'")
+        partial_func = partial(self.found_results_remotely, pod_result.strip())
+        self.wait_for_predicate(partial_func)
+        run_command("cd ../")
+        self.log.info("Successfully ran activity using --user-dir")
+
     def wait_for_gossip_sync(self, expected: int):
         self.log.info(f"Waiting for sync (expecting {expected})...")
         current = 0