use entrypoint for plugins

Author: mplsgrant

resources/plugins/simln/README.md

@@ -91,24 +91,13 @@ nodes:
 
 plugins:
   postDeploy:
-    # Take note: the path to the plugin file is relative to the `network.yaml` file. The location of your `plugin.py` file and `network.yaml` file may differ than what is shown below.
-    - "../../plugins/simln/plugin.py launch-activity '[{\"source\": \"tank-0003-ln\", \"destination\": \"tank-0005-ln\", \"interval_secs\": 1, \"amount_msat\": 2000}]'"
+    simln:
+      entrypoint: "../../plugins/simln"  # This is the path to the simln plugin folder (relative to the network.yaml file).
+      activity: '[{"source": "tank-0003-ln", "destination": "tank-0005-ln", "interval_secs": 1, "amount_msat": 2000}]'
 ````
 
 </details>
 
-### preDeploy and postDeploy
-When using `warnet deploy <network folder>`, Warnet will look for a `network.yaml` in the network folder, and it will deploy the nodes listed in the `nodes` section of the file. We can choose to execute our plugin functions before Warnet deploys the nodes by including those functions in the `preDeploy` section of the `network.yaml` file. We can also choose to run plugin commands after Warnet deploys the nodes by including the function in the `postDeploy` section.
-
-````yaml
-plugins:
-  preDeploy:
-    - path/to/plugin.py setup_function
-  postDeploy:
-    - path/to/plugin.py run
-    - path/to/other/plugin.py run
-````
-
 
 ## Generating your own SimLn image
 The SimLN plugin fetches a SimLN docker image from dockerhub. You can generate your own docker image if you choose:

resources/plugins/simln/plugin.py

@@ -1,11 +1,11 @@
 #!/usr/bin/env python3
-
 import json
 import logging
 import time
 from pathlib import Path
 
 import click
+import yaml
 from kubernetes.stream import stream
 
 # When we want to select pods based on their role in Warnet, we use "mission" tags. The "mission"
@@ -31,7 +31,7 @@
 PLUGIN_DIR_TAG = "plugin_dir"
 
 
-class SimLNError(Exception):
+class PluginError(Exception):
     pass
 
 
@@ -56,6 +56,38 @@ def simln(ctx):
     ctx.obj[PLUGIN_DIR_TAG] = Path(plugin_dir)
 
 
+@simln.command()
+@click.argument("network_file_path", type=str)
+@click.argument("hook_value", type=str)
+@click.pass_context
+def entrypoint(ctx, network_file_path: str, hook_value: str):
+    """Plugin entrypoint"""
+    network_file_path = Path(network_file_path)
+    with network_file_path.open() as f:
+        network_file = yaml.safe_load(f) or {}
+        if not isinstance(network_file, dict):
+            raise ValueError(f"Invalid network file structure: {network_file_path}")
+
+    plugins_section = network_file.get("plugins", {})
+    hook_section = plugins_section.get(hook_value, {})
+
+    plugin_name = Path(__file__).resolve().parent.stem
+    plugin_data = hook_section.get(plugin_name)
+    if not plugin_data:
+        raise PluginError(f"Could not find {plugin_name} in {network_file_path}")
+
+    _entrypoint(ctx, plugin_data)
+
+
+def _entrypoint(ctx, plugin_data: dict):
+    """ "Called by entrypoint"""
+    # write your plugin startup commands here
+    activity = plugin_data.get("activity")
+    activity = json.loads(activity)
+    print(activity)
+    _launch_activity(activity, ctx.obj.get(PLUGIN_DIR_TAG))
+
+
 # The group name is then used in decorators to create commands. These commands are
 # available to users when they access your plugin from the command line.
 @simln.command()
@@ -82,7 +114,7 @@ def _get_example_activity() -> list[dict]:
         pod_a = pods[1].metadata.name
         pod_b = pods[2].metadata.name
     except Exception as err:
-        raise SimLNError(
+        raise PluginError(
             "Could not access the lightning nodes needed for the example.\n Try deploying some."
         ) from err
     return [{"source": pod_a, "destination": pod_b, "interval_secs": 1, "amount_msat": 2000}]
@@ -116,10 +148,11 @@ def _launch_activity(activity: list[dict], plugin_dir: str) -> str:
     name = f"simln-{timestamp}"
 
     command = f"helm upgrade --install {timestamp} {plugin_dir}/charts/simln"
-    run_command(command)
 
+    run_command(command)
     activity_json = _generate_activity_json(activity)
     wait_for_init(name, namespace=get_default_namespace(), quiet=True)
+
     if write_file_to_container(
         name,
         "init",
@@ -130,7 +163,7 @@ def _launch_activity(activity: list[dict], plugin_dir: str) -> str:
     ):
         return name
     else:
-        raise SimLNError(f"Could not write sim.json to the init container: {name}")
+        raise PluginError(f"Could not write sim.json to the init container: {name}")
 
 
 def _generate_activity_json(activity: list[dict]) -> str:

src/warnet/constants.py

@@ -34,11 +34,6 @@ class HookValue(Enum):
     POST_NODE = "postNode"
 
 
-class HookOptions(Enum):
-    EXEC = "exec"
-    WAIT_FOR = "waitFor"
-
-
 # Directories and files for non-python assets, e.g., helm charts, example scenarios, default configs
 SRC_DIR = files("warnet")
 RESOURCES_DIR = files("resources")

src/warnet/deploy.py

@@ -25,7 +25,6 @@
     NETWORK_FILE,
     SCENARIOS_DIR,
     WARGAMES_NAMESPACE_PREFIX,
-    HookOptions,
     HookValue,
 )
 from .control import _run
@@ -37,7 +36,7 @@
     wait_for_ingress_controller,
     wait_for_pod_ready,
 )
-from .process import run_command, stream_command, wait_for_run
+from .process import run_command, stream_command
 
 HINT = "\nAre you trying to run a scenario? See `warnet run --help`"
 
@@ -145,40 +144,22 @@ def is_relative(path: str) -> bool:
             raise ValueError(f"Invalid network file structure: {network_file_path}")
 
     plugins_section = network_file.get("plugins", {})
-    plugins = plugins_section.get(hook_value.value) or []
-    for plugin_cmd in plugins:
+    hook_section = plugins_section.get(hook_value.value, {})
+    for plugin_cmd in hook_section.items():
         match plugin_cmd:
-            case {HookOptions.EXEC.value: cmd, HookOptions.WAIT_FOR.value: predicate}:
-                if is_relative(cmd):
-                    cmd = network_file_path.parent / cmd
-                print(f"{HookOptions.EXEC.value}: {cmd}")
-
-                if is_relative(predicate):
-                    predicate = network_file_path.parent / predicate
-                print(f"{HookOptions.WAIT_FOR.value}: {predicate}")
-
-                wait_for_run(str(predicate))
-                print(run_command(str(cmd)))
-
-            case {HookOptions.EXEC.value: cmd}:
-                if is_relative(cmd):
-                    cmd = network_file_path.parent / cmd
-                print(f"{HookOptions.EXEC.value}: {cmd}")
-                print(run_command(str(cmd)))
-
-            case str():
-                cmd = plugin_cmd
-                if is_relative(cmd):
-                    cmd = network_file_path.parent / plugin_cmd
-                print(f"{cmd}")
-                print(run_command(str(cmd)))
+            case (str(), dict()):
+                try:
+                    entrypoint_path = Path(plugin_cmd[1].get("entrypoint"))
+                except Exception as err:
+                    raise SyntaxError("Each plugin must have an 'entrypoint'") from err
+                cmd = f"{network_file_path.parent / entrypoint_path / Path('plugin.py')} entrypoint {network_file_path} {hook_value.value}"
+                print(f"Command: {cmd}")
+                print(run_command(cmd))
 
             case _:
                 print(
                     f"The following plugin command does not match known plugin command structures: {plugin_cmd}"
                 )
-                print(f"Known hook values: {[v.value for v in HookValue]}")
-                print(f"Known hook options: {[v.value for v in HookOptions]}")
                 sys.exit(1)
 
 

test/data/ln/network.yaml

@@ -54,15 +54,8 @@ nodes:
       lnd: true
 
 plugins:
-  preNode:
-    - "echo This is preNode"
-  postNode:
-    - exec: "echo This is postNode"
-    - exec: "echo This is also postNode, but we waited for 'warnet status'"
-      waitFor: "warnet status"
-  preDeploy:
-    - "echo This is preDeploy"
   postDeploy:
-    - "../../../resources/plugins/simln/plugin.py launch-activity '[{\"source\": \"tank-0003-ln\", \"destination\": \"tank-0005-ln\", \"interval_secs\": 1, \"amount_msat\": 2000}]'"
-    - exec: "../../../resources/plugins/simln/plugin.py list-pod-names"
-      waitFor: "../../../resources/plugins/simln/plugin.py get-example-activity"
+    simln:
+      entrypoint: "../../../resources/plugins/simln"
+      activity: '[{"source": "tank-0003-ln", "destination": "tank-0005-ln", "interval_secs": 1, "amount_msat": 2000}]'
+