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: "../../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}]'
-````
+      capacity_multiplier: 2.5 # Optional: Capacity multiplier for random activity
+```
 
 </details>
 
-
 ## 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 = "capacity_multiplier"
 
 
 @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,24 +133,30 @@ 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 with capacity multiplier if provided
     command = f"helm upgrade --install {timestamp} {plugin_dir}/charts/simln"
+    if capacity_multiplier is not None:
+        command += f" --set capacityMultiplier={capacity_multiplier}"
 
     run_command(command)
     activity_json = _generate_activity_json(activity)
@@ -156,6 +172,17 @@ def _launch_activity(activity: Optional[list[dict]], plugin_dir: str) -> str:
         namespace=get_default_namespace(),
         quiet=True,
     ):
+        # Execute sim-cli with capacity multiplier if provided
+        if capacity_multiplier is not None:
+            # Wait for the main container to be ready
+            time.sleep(5)  # Give the container time to start
+            # Execute the command with capacity multiplier
+            _sh(
+                name,
+                "sh",
+                ("-c", f"cd /working && sim-cli --capacity-multiplier {capacity_multiplier}"),
+            )
+
         return name
     else:
         raise PluginError(f"Could not write sim.json to the init container: {name}")

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_option()
         finally:
             self.cleanup()
 
@@ -94,6 +95,36 @@ 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_option(self):
+        """Test that the capacity multiplier option is available and works correctly."""
+        self.log.info("Testing capacity multiplier option...")
+
+        # Test 1: Check that the option is available in help
+        help_output = run_command(f"{self.simln_exec} launch-activity --help")
+        if "--capacity-multiplier" not in help_output:
+            self.fail("--capacity-multiplier option not found in help output")
+        self.log.info("✓ --capacity-multiplier option is available in help")
+
+        # Test 2: Check that the option accepts a float value
+        test_activity = '[{"source": "test-node-1", "destination": "test-node-2", "interval_secs": 1, "amount_msat": 1000}]'
+
+        # This should fail gracefully since we're not in a real warnet environment,
+        # but it should fail for the right reason (not because of option parsing)
+        try:
+            run_command(
+                f"{self.simln_exec} launch-activity '{test_activity}' --capacity-multiplier 2.5"
+            )
+            self.log.info("✓ --capacity-multiplier option is accepted")
+        except Exception as e:
+            # Expected to fail in test environment, but should not fail due to option parsing
+            if "capacity-multiplier" in str(e).lower():
+                self.fail(f"Capacity multiplier option parsing failed: {e}")
+            self.log.info(
+                "✓ --capacity-multiplier option is accepted (command failed as expected in test environment)"
+            )
+
+        self.log.info("Capacity multiplier test completed successfully")
+
 
 if __name__ == "__main__":
     test = PluginTest()