add preNode/postNode; add exec/waitFor

Author: mplsgrant

docs/plugins.md

@@ -11,7 +11,18 @@ nodes:
   <<snip>>
 
 plugins:
-  - path/to/plugin/file/relative/to/the/network/dot/yaml/file/plugin.py
+  preNode:  # Run commands before each node launches
+    - "echo This is preNode"  # This command is a simple string
+  postNode:  # Run commands after each node launches
+    - exec: "echo This is also postNode, but we waited for 'warnet status'"  # This command is also a simple string ...
+      waitFor: "warnet status"  # ... but it will execute after this command completes successfully
+    - exec: "echo This is postNode"  # Simply using 'exec' also just works
+  preDeploy:  # Run commands before Warnet runs the bulk of its `deploy` code
+    - "echo This is preDeploy"
+  postDeploy:  # Run these commands after Warnet has finished the bulk of its `deploy` code
+    - "../../plugins/simln/plugin.py launch-activity '[{\"source\": \"tank-0003-ln\", \"destination\": \"tank-0005-ln\", \"interval_secs\": 1, \"amount_msat\": 2000}]'"
+    - exec: "../../plugins/simln/plugin.py list-pod-names"
+      waitFor: "../../plugins/simln/plugin.py get-example-activity"
 ````
 
 Warnet will execute these plugin commands after each invocation of `warnet deploy`.

src/warnet/constants.py

@@ -30,6 +30,13 @@
 class HookValue(Enum):
     PRE_DEPLOY = "preDeploy"
     POST_DEPLOY = "postDeploy"
+    PRE_NODE = "preNode"
+    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/warnet/deploy.py

@@ -1,3 +1,4 @@
+import os
 import subprocess
 import sys
 import tempfile
@@ -24,6 +25,7 @@
     NETWORK_FILE,
     SCENARIOS_DIR,
     WARGAMES_NAMESPACE_PREFIX,
+    HookOptions,
     HookValue,
 )
 from .control import _run
@@ -35,7 +37,7 @@
     wait_for_ingress_controller,
     wait_for_pod_ready,
 )
-from .process import run_command, stream_command
+from .process import run_command, stream_command, wait_for_run
 
 HINT = "\nAre you trying to run a scenario? See `warnet run --help`"
 
@@ -129,6 +131,12 @@ def _deploy(directory, debug, namespace, to_all_users):
 
 
 def run_plugins(directory, hook_value: HookValue):
+    """ " Run the plugin commands within a given hook value"""
+
+    def is_relative(path: str) -> bool:
+        """Determine if the path is a command or a path to a command"""
+        return os.path.dirname(path) != ""
+
     network_file_path = directory / NETWORK_FILE
 
     with network_file_path.open() as f:
@@ -139,9 +147,39 @@ def run_plugins(directory, hook_value: HookValue):
     plugins_section = network_file.get("plugins", {})
     plugins = plugins_section.get(hook_value.value) or []
     for plugin_cmd in plugins:
-        fully_qualified_cmd = network_file_path.parent / plugin_cmd  # relative to network.yaml
-        print(f"Plugin command: {fully_qualified_cmd}")
-        print(run_command(str(fully_qualified_cmd)))
+        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 _:
+                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)
 
 
 def check_logging_required(directory: Path):
@@ -358,9 +396,14 @@ def deploy_single_node(node, directory: Path, debug: bool, namespace: str):
                 temp_override_file_path = Path(temp_file.name)
             cmd = f"{cmd} -f {temp_override_file_path}"
 
+        run_plugins(directory, HookValue.PRE_NODE)
+
         if not stream_command(cmd):
             click.echo(f"Failed to run Helm command: {cmd}")
             return
+
+        run_plugins(directory, HookValue.POST_NODE)
+
     except Exception as e:
         click.echo(f"Error: {e}")
         return

src/warnet/process.py

@@ -1,4 +1,5 @@
 import subprocess
+from time import sleep
 
 
 def run_command(command: str) -> str:
@@ -29,3 +30,21 @@ def stream_command(command: str) -> bool:
     if return_code != 0:
         raise Exception(message)
     return True
+
+
+def wait_for_run(predicate, timeout=5 * 60, interval=5):
+    print(f"Waiting for predicate with timeout {timeout}s and interval {interval}s")
+    print(predicate)
+    while timeout > 0:
+        try:
+            if run_command(predicate):
+                return
+        except Exception:
+            pass
+        sleep(interval)
+        timeout -= interval
+    import inspect
+
+    raise Exception(
+        f"Timed out waiting for Truth from predicate: {inspect.getsource(predicate).strip()}"
+    )

test/data/ln/network.yaml

@@ -54,7 +54,15 @@ 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:
-    - "../../../resources/plugins/simln/plugin.py"
+    - "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"