move test scenarios to subdirectory and add optional --source_dir

Author: Matthew Zipkin

resources/scenarios/ln_init.py

@@ -183,3 +183,6 @@ def funded_lnnodes():
 
 def main():
     LNInit().main()
+
+if __name__ == "__main__":
+    main()

resources/scenarios/miner_std.py

@@ -70,3 +70,6 @@ def run_test(self):
 
 def main():
     MinerStd().main()
+
+if __name__ == "__main__":
+    main()

resources/scenarios/reconnaissance.py

@@ -82,3 +82,6 @@ def run_test(self):
 
 def main():
     Reconnaissance().main()
+
+if __name__ == "__main__":
+    main()

resources/scenarios/signet_miner.py

@@ -564,3 +564,6 @@ def get_args(parser):
 
 def main():
     SignetMinerScenario().main()
+
+if __name__ == "__main__":
+    main()

resources/scenarios/test_scenarios/__init__.py

@@ -22,3 +22,6 @@ def run_test(self):
 
 def main():
     Failure().main()
+
+if __name__ == "__main__":
+    main()

…/scenarios/testscenario_buggy_failure.py …cenarios/test_scenarios/buggy_failure.pyresources/scenarios/testscenario_buggy_failure.py renamed to resources/scenarios/test_scenarios/buggy_failure.py resources/scenarios/testscenario_buggy_failure.py renamed to resources/scenarios/test_scenarios/buggy_failure.py

@@ -119,3 +119,6 @@ def assert_connection(self, connector, connectee_index, connection_type: Connect
 
 def main():
     ConnectDag().main()
+
+if __name__ == "__main__":
+    main()

…es/scenarios/testscenario_connect_dag.py …/scenarios/test_scenarios/connect_dag.pyresources/scenarios/testscenario_connect_dag.py renamed to resources/scenarios/test_scenarios/connect_dag.py resources/scenarios/testscenario_connect_dag.py renamed to resources/scenarios/test_scenarios/connect_dag.py

@@ -54,3 +54,6 @@ def run_test(self):
 
 def main():
     GetdataTest().main()
+
+if __name__ == "__main__":
+    main()

…/scenarios/testscenario_p2p_interface.py …cenarios/test_scenarios/p2p_interface.pyresources/scenarios/testscenario_p2p_interface.py renamed to resources/scenarios/test_scenarios/p2p_interface.py resources/scenarios/testscenario_p2p_interface.py renamed to resources/scenarios/test_scenarios/p2p_interface.py

@@ -69,3 +69,7 @@ def run_test(self):
 
 def main():
     TXFlood().main()
+
+
+if __name__ == "__main__":
+    main()

resources/scenarios/tx_flood.py

@@ -172,14 +172,15 @@ def get_active_network(namespace):
     default=False,
     help="Stream scenario output and delete container when stopped",
 )
+@click.option("--source_dir", type=click.Path(exists=True, file_okay=False, dir_okay=True), required=False)
 @click.argument("additional_args", nargs=-1, type=click.UNPROCESSED)
-def run(scenario_file: str, debug: bool, additional_args: tuple[str]):
+def run(scenario_file: str, source_dir, additional_args: tuple[str]):
     """
     Run a scenario from a file.
     Pass `-- --help` to get individual scenario help
     """
     scenario_path = Path(scenario_file).resolve()
-    scenario_dir = scenario_path.parent
+    scenario_dir = scenario_path.parent if not source_dir else Path(source_dir).resolve()
     scenario_name = scenario_path.stem
 
     if additional_args and ("--help" in additional_args or "-h" in additional_args):
@@ -212,15 +213,24 @@ def run(scenario_file: str, debug: bool, additional_args: tuple[str]):
     def filter(path):
         if any(needle in str(path) for needle in [".pyc", ".csv", ".DS_Store"]):
             return False
-        return any(
-            needle in str(path) for needle in ["commander.py", "test_framework", scenario_name]
-        )
-
+        if any(needle in str(path) for needle in ["__init__.py", "commander.py", "test_framework", scenario_path.name]):
+            print(f"Including: {path}")
+            return True
+        return False
+
+    # In case the scenario file is not in the root of the archive directory,
+    # we need to specify its relative path as a submodule
+    # First get the path of the file relative to the source directory
+    relative_path = scenario_path.relative_to(scenario_dir)
+    # Remove the '.py' extension
+    relative_name = relative_path.with_suffix("")
+    # Replace path separators with dots and pray the user included __init__.py
+    module_name = ".".join(relative_name.parts)
     # Compile python archive
     zipapp.create_archive(
         source=scenario_dir,
         target=archive_buffer,
-        main=f"{scenario_name}:main",
+        main=f"{module_name}:main",
         compressed=True,
         filter=filter,
     )