add pre/post deploy options

Author: mplsgrant

resources/plugins/simln/README.md

@@ -90,12 +90,26 @@ nodes:
       lnd: true
 
 plugins:
-  # 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.
-  - "../../../resources/plugins/simln/plugin.py launch-activity '[{\"source\": \"tank-0003-ln\", \"destination\": \"tank-0005-ln\", \"interval_secs\": 1, \"amount_msat\": 2000}]'"
+  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.
+    - "../../../resources/plugins/simln/plugin.py launch-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

@@ -45,7 +45,7 @@ class SimLNError(Exception):
 
 
 # Warnet uses a python package called "click" to manage terminal interactions with the user.
-# Each plugin must declare a click "group" by decorating a function named after the plugin.
+# To use click, we must declare a click "group" by decorating a function named after the plugin.
 # Using click makes it easy for users to interact with your plugin.
 @click.group()
 @click.pass_context

src/warnet/constants.py

@@ -1,4 +1,5 @@
 import os
+from enum import Enum
 from importlib.resources import files
 from pathlib import Path
 
@@ -25,6 +26,12 @@
 BITCOINCORE_CONTAINER = "bitcoincore"
 COMMANDER_CONTAINER = "commander"
 
+
+class HookValue(Enum):
+    PRE_DEPLOY = "preDeploy"
+    POST_DEPLOY = "postDeploy"
+
+
 # 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

@@ -24,6 +24,7 @@
     NETWORK_FILE,
     SCENARIOS_DIR,
     WARGAMES_NAMESPACE_PREFIX,
+    HookValue,
 )
 from .control import _run
 from .k8s import (
@@ -72,6 +73,8 @@ def _deploy(directory, debug, namespace, to_all_users):
     """Deploy a warnet with topology loaded from <directory>"""
     directory = Path(directory)
 
+    run_plugins(directory, HookValue.PRE_DEPLOY)
+
     if to_all_users:
         namespaces = get_namespaces_by_type(WARGAMES_NAMESPACE_PREFIX)
         processes = []
@@ -115,7 +118,7 @@ def _deploy(directory, debug, namespace, to_all_users):
         for p in processes:
             p.join()
 
-        run_plugins(directory)
+        run_plugins(directory, HookValue.POST_DEPLOY)
 
     elif (directory / NAMESPACES_FILE).exists():
         deploy_namespaces(directory)
@@ -125,17 +128,20 @@ def _deploy(directory, debug, namespace, to_all_users):
         )
 
 
-def run_plugins(directory):
+def run_plugins(directory, hook_value: HookValue):
     network_file_path = directory / NETWORK_FILE
 
     with network_file_path.open() as f:
-        network_file = yaml.safe_load(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 = network_file.get("plugins") or []
+    plugins_section = network_file.get("plugins", {})
+    plugins = plugins_section.get(hook_value.value) or []
     for plugin_cmd in plugins:
-        fully_qualified_cmd = f"{network_file_path.parent}/{plugin_cmd}"  # relative to network.yaml
-        print(fully_qualified_cmd)
-        print(run_command(fully_qualified_cmd))
+        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)))
 
 
 def check_logging_required(directory: Path):

test/data/ln/network.yaml

@@ -54,4 +54,7 @@ nodes:
       lnd: true
 
 plugins:
-  - "../../../resources/plugins/simln/plugin.py launch-activity '[{\"source\": \"tank-0003-ln\", \"destination\": \"tank-0005-ln\", \"interval_secs\": 1, \"amount_msat\": 2000}]'"
+  preDeploy:
+    - "../../../resources/plugins/simln/plugin.py"
+  postDeploy:
+    - "../../../resources/plugins/simln/plugin.py launch-activity '[{\"source\": \"tank-0003-ln\", \"destination\": \"tank-0005-ln\", \"interval_secs\": 1, \"amount_msat\": 2000}]'"