Merge pull request #589 from pinheadmz/scenario-help

fix scenario help

Author: pinheadmz

resources/scenarios/ln_init.py

@@ -9,14 +9,14 @@
     from resources.scenarios.commander import Commander
 
 
-def cli_help():
-    return "Fund LN wallets and open channels"
-
-
 class LNInit(Commander):
     def set_test_params(self):
         self.num_nodes = None
 
+    def add_options(self, parser):
+        parser.description = "Fund LN wallets and open channels"
+        parser.usage = "warnet run /path/to/ln_init.py"
+
     def run_test(self):
         self.log.info("Lock out of IBD")
         miner = self.ensure_miner(self.nodes[0])

resources/scenarios/miner_std.py

@@ -9,10 +9,6 @@
     from resources.scenarios.commander import Commander
 
 
-def cli_help():
-    return "Generate blocks over time. Options: [--allnodes | --interval=<number> | --mature ]"
-
-
 class Miner:
     def __init__(self, node, mature):
         self.node = node
@@ -28,6 +24,8 @@ def set_test_params(self):
         self.miners = []
 
     def add_options(self, parser):
+        parser.description = "Generate blocks over time"
+        parser.usage = "warnet run /path/to/miner_std.py [options]"
         parser.add_argument(
             "--allnodes",
             dest="allnodes",

resources/scenarios/reconnaissance.py

@@ -14,11 +14,6 @@
 from test_framework.p2p import MAGIC_BYTES, P2PInterface
 
 
-# This message is provided to the user when they describe the scenario
-def cli_help():
-    return "Demonstrate network reconnaissance using a scenario and P2PInterface"
-
-
 def get_signet_network_magic_from_node(node):
     template = node.getblocktemplate({"rules": ["segwit", "signet"]})
     challenge = template["signet_challenge"]
@@ -37,6 +32,10 @@ def set_test_params(self):
         # a sub-class of BitcoinTestFramework
         self.num_nodes = 1
 
+    def add_options(self, parser):
+        parser.description = "Demonstrate network reconnaissance using a scenario and P2PInterface"
+        parser.usage = "warnet run /path/to/reconnaissance.py"
+
     # Scenario entrypoint
     def run_test(self):
         self.log.info("Getting peer info")

resources/scenarios/sens_relay.py

@@ -46,6 +46,8 @@ def set_test_params(self):
         self.num_nodes = 1
 
     def add_options(self, parser):
+        parser.description = "Generate blocks on a signet network"
+        parser.usage = "warnet run /path/to/signet_miner.py [options]"
         parser.add_argument(
             "--tank",
             dest="tank",

resources/scenarios/signet_miner.py

@@ -10,17 +10,17 @@
     from resources.scenarios.commander import Commander
 
 
-def cli_help():
-    return "Make a big transaction mess. Options: [--interval=<number>]"
-
-
 class TXFlood(Commander):
     def set_test_params(self):
         self.num_nodes = 1
         self.addrs = []
         self.threads = []
 
     def add_options(self, parser):
+        parser.description = (
+            "Sends random transactions between all nodes with available balance in their wallet"
+        )
+        parser.usage = "warnet run /path/to/tx_flood.py [options]"
         parser.add_argument(
             "--interval",
             dest="interval",

resources/scenarios/tx_flood.py

@@ -2,6 +2,7 @@
 import json
 import os
 import subprocess
+import sys
 import time
 from concurrent.futures import ThreadPoolExecutor, as_completed
 from pathlib import Path
@@ -188,7 +189,10 @@ def get_active_network(namespace):
 @click.argument("scenario_file", type=click.Path(exists=True, file_okay=True, dir_okay=False))
 @click.argument("additional_args", nargs=-1, type=click.UNPROCESSED)
 def run(scenario_file: str, additional_args: tuple[str]):
-    """Run a scenario from a file"""
+    """
+    Run a scenario from a file.
+    Pass `-- --help` to get individual scenario help
+    """
     scenario_path = Path(scenario_file).resolve()
     scenario_name = scenario_path.stem
 
@@ -233,6 +237,8 @@ def run(scenario_file: str, additional_args: tuple[str]):
         # Add additional arguments
         if additional_args:
             helm_command.extend(["--set", f"args={' '.join(additional_args)}"])
+            if "--help" in additional_args or "-h" in additional_args:
+                return subprocess.run([sys.executable, scenario_path, "--help"])
 
         helm_command.extend([name, COMMANDER_CHART])