Merge pull request #480 from willcl-ark/remove-cli-subtree

pyproject.toml

@@ -21,7 +21,7 @@ dependencies = [
 ]
 
 [project.scripts]
-warcli = "warnet.cli.main:cli"
+warcli = "warnet.main:cli"
 
 [project.urls]
 Homepage = "https://warnet.dev"
@@ -42,4 +42,8 @@ build-backend = "setuptools.build_meta"
 include-package-data = true
 
 [tool.setuptools.packages.find]
-where = ["src", "resources"]
+where = ["src", "."]
+include = ["warnet*", "test_framework*", "resources*"]
+
+[tool.setuptools.package-data]
+"resources" = ["**/*"]

src/warnet/scenarios/ln_init.py → resources/scenarios/ln_init.py

@@ -3,7 +3,10 @@
 from time import sleep
 
 # The base class exists inside the commander container
-from commander import Commander
+try:
+    from commander import Commander
+except ImportError:
+    from resources.scenarios.commander import Commander
 
 
 def cli_help():

src/warnet/scenarios/miner_std.py → resources/scenarios/miner_std.py

@@ -3,7 +3,10 @@
 from time import sleep
 
 # The base class exists inside the commander container
-from commander import Commander
+try:
+    from commander import Commander
+except ImportError:
+    from resources.scenarios.commander import Commander
 
 
 def cli_help():

src/warnet/scenarios/sens_relay.py → resources/scenarios/sens_relay.py

@@ -1,7 +1,10 @@
 #!/usr/bin/env python3
 
 # The base class exists inside the commander container
-from commander import Commander
+try:
+    from commander import Commander
+except ImportError:
+    from resources.scenarios.commander import Commander
 
 
 def cli_help():

src/warnet/scenarios/tx_flood.py → resources/scenarios/tx_flood.py

@@ -4,7 +4,10 @@
 from time import sleep
 
 # The base class exists inside the commander container
-from commander import Commander
+try:
+    from commander import Commander
+except ImportError:
+    from resources.scenarios.commander import Commander
 
 
 def cli_help():

src/warnet/cli/image_build.py → src/warnet/image_build.py

@@ -3,7 +3,7 @@
 
 ARCHES = ["amd64", "arm64", "armhf"]
 
-dockerfile_path = files("images.bitcoin").joinpath("Dockerfile")
+dockerfile_path = files("resources.images.bitcoin").joinpath("Dockerfile")
 
 
 def run_command(command):

src/warnet/cli/k8s.py → src/warnet/k8s.py

@@ -1,6 +1,5 @@
 import json
 import tempfile
-from importlib.resources import files
 from pathlib import Path
 
 import yaml
@@ -10,7 +9,6 @@
 
 from .process import run_command, stream_command
 
-WAR_MANIFESTS = files("manifests")
 DEFAULT_NAMESPACE = "warnet"
 
 

src/warnet/cli/main.py → src/warnet/main.py

@@ -13,7 +13,7 @@
 from .network import copy_network_defaults, network
 from .scenarios import scenarios
 
-QUICK_START_PATH = files("scripts").joinpath("quick_start.sh")
+QUICK_START_PATH = files("resources.scripts").joinpath("quick_start.sh")
 
 
 @click.group()

src/warnet/cli/namespaces.py → src/warnet/namespaces.py

@@ -8,13 +8,13 @@
 
 from .process import run_command, stream_command
 
-WARNET_NAMESPACES_DIR = files("namespaces")
+WARNET_NAMESPACES_DIR = files("resources").joinpath("namespaces")
 NAMESPACES_DIR = Path("namespaces")
 DEFAULT_NAMESPACES = Path("two_namespaces_two_users")
 NAMESPACES_FILE = "namespaces.yaml"
 DEFAULTS_FILE = "namespace-defaults.yaml"
 HELM_COMMAND = "helm upgrade --install"
-BITCOIN_CHART_LOCATION = Path(str(files("charts").joinpath("namespaces")))
+BITCOIN_CHART_LOCATION = Path(str(files("resources.charts").joinpath("namespaces")))
 
 
 def copy_namespaces_defaults(directory: Path):

src/warnet/cli/network.py → src/warnet/network.py

@@ -12,14 +12,14 @@
 from .k8s import delete_namespace, get_default_namespace, get_mission, get_pods
 from .process import stream_command
 
-WAR_MANIFESTS = files("manifests")
-WARNET_NETWORK_DIR = files("networks")
-NETWORK_DIR = Path("networks")
+WAR_MANIFESTS = files("resources.manifests")
+WARNET_NETWORK_DIR = files("resources.networks")
+NETWORK_DIR = Path("resources.networks")
 DEFAULT_NETWORK = Path("6_node_bitcoin")
 NETWORK_FILE = "network.yaml"
 DEFAULTS_FILE = "node-defaults.yaml"
 HELM_COMMAND = "helm upgrade --install --create-namespace"
-BITCOIN_CHART_LOCATION = str(files("charts").joinpath("bitcoincore"))
+BITCOIN_CHART_LOCATION = str(files("resources.charts").joinpath("bitcoincore"))
 
 
 @click.group(name="network")

src/warnet/cli/scenarios.py → src/warnet/scenarios.py

@@ -5,21 +5,20 @@
 import sys
 import tempfile
 import time
+from importlib.resources import files
 
 import click
 import yaml
 from rich import print
 from rich.console import Console
 from rich.table import Table
 
-from warnet import scenarios as SCENARIOS
-
 from .k8s import apply_kubernetes_yaml, get_default_namespace, get_mission
 
 
 @click.group(name="scenarios")
 def scenarios():
-    """Manage scenarios on a running network"""
+    """Manage scenarios on a network"""
 
 
 @scenarios.command()
@@ -41,24 +40,22 @@ def available():
 
 
 def _available():
-    # This ugly hack temporarily allows us to import the scenario modules
-    # in the context in which they run: as __main__ from
-    # the root directory of the commander container.
-    scenarios_path = SCENARIOS.__path__
-    sys.path.insert(0, scenarios_path[0])
-
-    scenario_list = []
-    for s in pkgutil.iter_modules(scenarios_path):
-        module_name = f"warnet.scenarios.{s.name}"
-        try:
-            m = importlib.import_module(module_name)
-            if hasattr(m, "cli_help"):
-                scenario_list.append((s.name, m.cli_help()))
-        except Exception as e:
-            print(f"Ignoring module: {module_name} because {e}")
-
-    # Clean up that ugly hack
-    sys.path.pop(0)
+    scenarios_dir = files("resources.scenarios")
+    sys.path.append(scenarios_dir)
+
+    try:
+        scenario_list = []
+        package_name = "resources.scenarios"
+        for _, name, _ in pkgutil.iter_modules([scenarios_dir]):
+            module_name = f"{package_name}.{name}"
+            try:
+                m = importlib.import_module(module_name)
+                if hasattr(m, "cli_help"):
+                    scenario_list.append((name, m.cli_help()))
+            except Exception as e:
+                print(f"Error importing module {module_name}: {e}")
+    finally:
+        sys.path.remove(scenarios_dir)
 
     return scenario_list
 
@@ -72,7 +69,7 @@ def run(scenario: str, additional_args: tuple[str]):
     """
 
     # Use importlib.resources to get the scenario path
-    scenario_package = "warnet.scenarios"
+    scenario_package = "resources.scenarios"
     scenario_filename = f"{scenario}.py"
 
     # Ensure the scenario file exists within the package
@@ -86,7 +83,7 @@ def run(scenario: str, additional_args: tuple[str]):
 @click.argument("additional_args", nargs=-1, type=click.UNPROCESSED)
 def run_file(scenario_path: str, additional_args: tuple[str]):
     """
-    Run <scenario_path> from the Warnet Test Framework with optional arguments
+    Start <scenario_path> with optional arguments
     """
     if not scenario_path.endswith(".py"):
         print("Error. Currently only python scenarios are supported")
@@ -206,3 +203,12 @@ def active():
 def _active() -> list[str]:
     commanders = get_mission("commander")
     return [{"commander": c.metadata.name, "status": c.status.phase.lower()} for c in commanders]
+
+
+@scenarios.command()
+@click.argument("pid", type=int)
+def stop(pid: int):
+    """
+    Stop scenario
+    """
+    pass

test/data/scenario_p2p_interface.py

@@ -2,7 +2,11 @@
 from collections import defaultdict
 
 # The base class exists inside the commander container
-from commander import Commander
+try:
+    from commander import Commander
+except Exception:
+    from resources.scenarios.commander import Commander
+
 
 from test_framework.messages import CInv, msg_getdata
 from test_framework.p2p import P2PInterface

test/scenarios_test.py

@@ -5,10 +5,10 @@
 
 from test_base import TestBase
 
-from warnet.cli.k8s import delete_pod
-from warnet.cli.process import run_command
-from warnet.cli.scenarios import _active as scenarios_active
-from warnet.cli.scenarios import _available as scenarios_available
+from warnet.k8s import delete_pod
+from warnet.process import run_command
+from warnet.scenarios import _active as scenarios_active
+from warnet.scenarios import _available as scenarios_available
 
 
 class ScenariosTest(TestBase):
@@ -69,7 +69,7 @@ def run_and_check_miner_scenario(self):
         self.stop_scenario()
 
     def run_and_check_miner_scenario_from_file(self):
-        scenario_file = "src/warnet/scenarios/miner_std.py"
+        scenario_file = "resources/scenarios/miner_std.py"
         self.log.info(f"Running scenario from file: {scenario_file}")
         self.warcli(f"scenarios run-file {scenario_file} --allnodes --interval=1")
         start = int(self.warcli("bitcoin rpc tank-0000 getblockcount"))

test/test_base.py

@@ -11,9 +11,9 @@
 from time import sleep
 
 from warnet import SRC_DIR
-from warnet.cli.network import _connected as network_connected
-from warnet.cli.network import _status as network_status
-from warnet.cli.scenarios import _active as scenarios_active
+from warnet.network import _connected as network_connected
+from warnet.network import _status as network_status
+from warnet.scenarios import _active as scenarios_active
 
 
 class TestBase: