feat: add --capacity-multiplier option to simln plugin

Author: b-l-u-e

resources/plugins/simln/README.md

@@ -1,49 +1,59 @@
 # SimLN Plugin
 
 ## SimLN
+
 SimLN helps you generate lightning payment activity.
 
-* Website: https://simln.dev/
-* Github: https://github.com/bitcoin-dev-project/sim-ln
+- Website: https://simln.dev/
+- Github: https://github.com/bitcoin-dev-project/sim-ln
 
 ## Usage
+
 SimLN uses "activity" definitions to create payment activity between lightning nodes. These definitions are in JSON format.
 
 SimLN also requires access details for each node; however, the SimLN plugin will automatically generate these access details for each LND node. The access details look like this:
 
-```` JSON
+```JSON
 {
   "id": <node_id>,
   "address": https://<ip:port or domain:port>,
   "macaroon": <path_to_selected_macaroon>,
   "cert": <path_to_tls_cert>
 }
-````
-SimLN plugin also supports Core Lightning (CLN).  CLN nodes connection details are transfered from the CLN node to SimLN node during launch-activity processing.
-```` JSON
+```
+
+SimLN plugin also supports Core Lightning (CLN). CLN nodes connection details are transfered from the CLN node to SimLN node during launch-activity processing.
+
+```JSON
 {
   "id": <node_id>,
   "address": https://<domain:port>,
   "ca_cert": /working/<node_id>-ca.pem,
   "client_cert": /working/<node_id>-client.pem,
   "client_key": /working/<node_id>-client-key.pem
 }
-````
+```
 
 Since SimLN already has access to those LND and CLN connection details, it means you can focus on the "activity" definitions.
 
 ### Launch activity definitions from the command line
+
 The SimLN plugin takes "activity" definitions like so:
 
 `./simln/plugin.py launch-activity '[{\"source\": \"tank-0003-ln\", \"destination\": \"tank-0005-ln\", \"interval_secs\": 1, \"amount_msat\": 2000}]'"''`
 
+You can also specify a capacity multiplier for random activity:
+
+`./simln/plugin.py launch-activity '[{\"source\": \"tank-0003-ln\", \"destination\": \"tank-0005-ln\", \"interval_secs\": 1, \"amount_msat\": 2000}]' --capacity-multiplier 2.5`
+
 ### Launch activity definitions from within `network.yaml`
-When you initialize a new Warnet network, Warnet will create a new `network.yaml` file.  If your `network.yaml` file includes lightning nodes, then you can use SimLN to produce activity between those nodes like this:
+
+When you initialize a new Warnet network, Warnet will create a new `network.yaml` file. If your `network.yaml` file includes lightning nodes, then you can use SimLN to produce activity between those nodes like this:
 
 <details>
 <summary>network.yaml</summary>
 
-````yaml
+```yaml
 nodes:
   - name: tank-0000
     addnode:
@@ -102,21 +112,23 @@ nodes:
 plugins:
   postDeploy:
     simln:
-      entrypoint: "../../plugins/simln"  # This is the path to the simln plugin folder (relative to the network.yaml file).
+      entrypoint: "/path/to/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}]'
-````
+      capacityMultiplier: 2.5 # Optional: Capacity multiplier for random activity
+```
 
 </details>
 
+## Generating your own SimLN image
 
-## 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:
 
 1. Clone SimLN: `git clone [email protected]:bitcoin-dev-project/sim-ln.git`
 2. Follow the instructions to build a docker image as detailed in the SimLN repository.
 3. Tag the resulting docker image: `docker tag IMAGEID YOURUSERNAME/sim-ln:VERSION`
 4. Push the tagged image to your dockerhub account.
 5. Modify the `values.yaml` file in the plugin's chart to reflect your username and version number:
+
 ```YAML
   repository: "YOURUSERNAME/sim-ln"
   tag: "VERSION"

resources/plugins/simln/charts/simln/values.yaml

@@ -4,6 +4,9 @@ image:
   tag: "0.2.3"
   pullPolicy: IfNotPresent
 
+# Capacity multiplier for random activity
+capacityMultiplier: null
+
 workingVolume:
   name: working-volume
   mountPath: /working

resources/plugins/simln/plugin.py

@@ -42,6 +42,7 @@ class PluginError(Exception):
 
 class PluginContent(Enum):
     ACTIVITY = "activity"
+    CAPACITY_MULTIPLIER = "capacityMultiplier"
 
 
 @click.group()
@@ -86,7 +87,16 @@ def _entrypoint(ctx, plugin_content: dict, warnet_content: dict):
     if activity:
         activity = json.loads(activity)
         print(activity)
-    _launch_activity(activity, ctx.obj.get(PLUGIN_DIR_TAG))
+
+    capacity_multiplier = plugin_content.get(PluginContent.CAPACITY_MULTIPLIER.value)
+    if capacity_multiplier:
+        try:
+            capacity_multiplier = float(capacity_multiplier)
+        except (ValueError, TypeError):
+            log.warning(f"Invalid capacity_multiplier value: {capacity_multiplier}, ignoring")
+            capacity_multiplier = None
+
+    _launch_activity(activity, ctx.obj.get(PLUGIN_DIR_TAG), capacity_multiplier)
 
 
 @simln.command()
@@ -123,27 +133,31 @@ def get_example_activity():
 
 @simln.command()
 @click.argument(PluginContent.ACTIVITY.value, type=str)
+@click.option("--capacity-multiplier", type=float, help="Capacity multiplier for random activity")
 @click.pass_context
-def launch_activity(ctx, activity: str):
+def launch_activity(ctx, activity: str, capacity_multiplier: Optional[float]):
     """Deploys a SimLN Activity which is a JSON list of objects"""
     try:
         parsed_activity = json.loads(activity)
     except json.JSONDecodeError:
         log.error("Invalid JSON input for activity.")
         raise click.BadArgumentUsage("Activity must be a valid JSON string.") from None
     plugin_dir = ctx.obj.get(PLUGIN_DIR_TAG)
-    print(_launch_activity(parsed_activity, plugin_dir))
+    print(_launch_activity(parsed_activity, plugin_dir, capacity_multiplier))
 
 
-def _launch_activity(activity: Optional[list[dict]], plugin_dir: str) -> str:
+def _launch_activity(
+    activity: Optional[list[dict]], plugin_dir: str, capacity_multiplier: Optional[float] = None
+) -> str:
     """Launch a SimLN chart which optionally includes the `activity`"""
     timestamp = int(time.time())
     name = f"simln-{timestamp}"
 
+    # Build helm command
     command = f"helm upgrade --install {timestamp} {plugin_dir}/charts/simln"
 
     run_command(command)
-    activity_json = _generate_activity_json(activity)
+    activity_json = _generate_activity_json(activity, capacity_multiplier)
     wait_for_init(name, namespace=get_default_namespace(), quiet=True)
 
     # write cert files to container
@@ -161,7 +175,7 @@ def _launch_activity(activity: Optional[list[dict]], plugin_dir: str) -> str:
         raise PluginError(f"Could not write sim.json to the init container: {name}")
 
 
-def _generate_activity_json(activity: Optional[list[dict]]) -> str:
+def _generate_activity_json(activity: Optional[list[dict]], capacity_multiplier: Optional[float] = None) -> str:
     nodes = []
 
     for i in get_mission(LIGHTNING_MISSION):
@@ -179,10 +193,13 @@ def _generate_activity_json(activity: Optional[list[dict]]) -> str:
         node["address"] = f"https://{ln_name}:{port}"
         nodes.append(node)
 
+    data = {"nodes": nodes}
+    
     if activity:
-        data = {"nodes": nodes, PluginContent.ACTIVITY.value: activity}
-    else:
-        data = {"nodes": nodes}
+        data[PluginContent.ACTIVITY.value] = activity
+    
+    if capacity_multiplier is not None:
+        data[PluginContent.CAPACITY_MULTIPLIER.value] = capacity_multiplier
 
     return json.dumps(data, indent=2)
 

test/data/network_with_plugins/network.yaml

@@ -69,7 +69,7 @@ plugins:  # Each plugin section has a number of hooks available (preDeploy, post
       helloTo: "postDeploy!"
     simln:  # You can have multiple plugins per hook
       entrypoint: "../../../resources/plugins/simln"
-      activity: '[{"source": "tank-0003-ln", "destination": "tank-0005-ln", "interval_secs": 1, "amount_msat": 2000}]'
+      capacityMultiplier: 5
   preNode:  # preNode plugins run before each node is deployed
     hello:
       entrypoint: "../plugins/hello"

test/plugin_test.py

@@ -24,6 +24,7 @@ def run_test(self):
             self.deploy_with_plugin()
             self.copy_results()
             self.assert_hello_plugin()
+            self.test_capacity_multiplier_from_network_yaml()
         finally:
             self.cleanup()
 
@@ -94,6 +95,68 @@ def assert_hello_plugin(self):
         wait_for_pod("tank-0005-post-hello-pod")
         wait_for_pod("tank-0005-pre-hello-pod")
 
+    def test_capacity_multiplier_from_network_yaml(self):
+        """Test that the capacity multiplier from network.yaml is properly applied."""
+        self.log.info("Testing capacity multiplier from network.yaml configuration...")
+
+        # Get the first simln pod
+        pod = self.get_first_simln_pod()
+        
+        # Wait a bit for simln to start and generate activity
+        import time
+        time.sleep(10)
+        
+        # Check the sim.json file to verify the configuration is correct
+        sim_json_content = run_command(f"{self.simln_exec} sh {pod} cat /working/sim.json")
+        
+        # Parse the JSON to check for capacityMultiplier
+        import json
+        try:
+            sim_config = json.loads(sim_json_content)
+            if "capacityMultiplier" not in sim_config:
+                self.fail("capacityMultiplier not found in sim.json configuration")
+            
+            expected_multiplier = 5  # As configured in network.yaml
+            if sim_config["capacityMultiplier"] != expected_multiplier:
+                self.fail(f"Expected capacityMultiplier {expected_multiplier}, got {sim_config['capacityMultiplier']}")
+            
+            self.log.info(f"✓ Found capacityMultiplier {sim_config['capacityMultiplier']} in sim.json")
+            
+        except json.JSONDecodeError as e:
+            self.fail(f"Invalid JSON in sim.json: {e}")
+        
+        # Try to get logs from the simln container (but don't fail if it hangs)
+        logs = ""
+        try:
+            # Use kubectl logs (more reliable)
+            logs = run_command(f"kubectl logs {pod} --tail=50")
+        except Exception as e:
+            self.log.warning(f"Could not get logs from simln container: {e}")
+            self.log.info("✓ Simln container is running with correct capacityMultiplier configuration")
+            self.log.info("✓ Skipping log analysis due to log access issues, but configuration is correct")
+            return
+        
+        # Look for multiplier information in the logs
+        if "multiplier" not in logs:
+            self.log.warning("No multiplier information found in simln logs, but this might be due to timing")
+            self.log.info("✓ Simln container is running with correct capacityMultiplier configuration")
+            return
+        
+        # Check that we see the expected multiplier value (5 as configured in network.yaml)
+        if "with multiplier 5" not in logs:
+            self.log.warning("Expected multiplier value 5 not found in simln logs, but this might be due to timing")
+            self.log.info("✓ Simln container is running with correct capacityMultiplier configuration")
+            return
+        
+        # Verify that activity is being generated (should see "payments per month" or "payments per hour")
+        if "payments per month" not in logs and "payments per hour" not in logs:
+            self.log.warning("No payment activity generation found in simln logs, but this might be due to timing")
+            self.log.info("✓ Simln container is running with correct capacityMultiplier configuration")
+            return
+        
+        self.log.info("✓ Capacity multiplier from network.yaml is being applied correctly")
+        self.log.info("Capacity multiplier from network.yaml test completed successfully")
+
 
 if __name__ == "__main__":
     test = PluginTest()