Add create-network cli command (bitcoin-dev-project#524)

* add create-network cli command

* add test to CI

* removed create and renamaed network-create

* removed stop_server from test base

Author: m3dwards

.github/workflows/test.yml

@@ -91,3 +91,18 @@ jobs:
         run: |
           source .venv/bin/activate
           ./test/${{matrix.test}}
+  test-without-mk:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        test:
+          - graph_test.py
+    steps:
+      - uses: actions/checkout@v4
+      - uses: eifinger/setup-uv@v1
+      - name: Install project
+        run: uv sync --all-extras --dev
+      - name: Run tests
+        run: |
+          source .venv/bin/activate
+          ./test/${{matrix.test}}

pyproject.toml

@@ -19,6 +19,7 @@ dependencies = [
     "rich==13.7.1",
     "tabulate==0.9.0",
     "PyYAML==6.0.2",
+    "pexpect==4.9.0",
 ]
 
 [project.scripts]

src/warnet/graph.py

@@ -1,6 +1,13 @@
+import os
+import random
+from importlib.resources import files
 from pathlib import Path
 
 import click
+import inquirer
+import yaml
+
+from .constants import DEFAULT_TAG, SUPPORTED_TAGS
 
 
 @click.group(name="graph", hidden=True)
@@ -17,3 +24,188 @@ def import_json(infile: Path, outfile: Path, cb: str, ln_image: str):
     Returns XML file as string with or without --outfile option.
     """
     raise Exception("Not Implemented")
+
+
+def custom_graph(
+    num_nodes: int,
+    num_connections: int,
+    version: str,
+    datadir: Path,
+    fork_observer: bool,
+    fork_obs_query_interval: int,
+):
+    datadir.mkdir(parents=False, exist_ok=False)
+    # Generate network.yaml
+    nodes = []
+    connections = set()
+
+    for i in range(num_nodes):
+        node = {"name": f"tank-{i:04d}", "connect": [], "image": {"tag": version}}
+
+        # Add round-robin connection
+        next_node = (i + 1) % num_nodes
+        node["connect"].append(f"tank-{next_node:04d}")
+        connections.add((i, next_node))
+
+        # Add random connections
+        available_nodes = list(range(num_nodes))
+        available_nodes.remove(i)
+        if next_node in available_nodes:
+            available_nodes.remove(next_node)
+
+        for _ in range(min(num_connections - 1, len(available_nodes))):
+            random_node = random.choice(available_nodes)
+            # Avoid circular loops of A -> B -> A
+            if (random_node, i) not in connections:
+                node["connect"].append(f"tank-{random_node:04d}")
+                connections.add((i, random_node))
+                available_nodes.remove(random_node)
+
+        nodes.append(node)
+
+    network_yaml_data = {"nodes": nodes}
+    network_yaml_data["fork_observer"] = {
+        "enabled": fork_observer,
+        "configQueryInterval": fork_obs_query_interval,
+    }
+
+    with open(os.path.join(datadir, "network.yaml"), "w") as f:
+        yaml.dump(network_yaml_data, f, default_flow_style=False)
+
+    # Generate node-defaults.yaml
+    default_yaml_path = files("resources.networks").joinpath("node-defaults.yaml")
+    with open(str(default_yaml_path)) as f:
+        defaults_yaml_content = f.read()
+
+    with open(os.path.join(datadir, "node-defaults.yaml"), "w") as f:
+        f.write(defaults_yaml_content)
+
+    click.echo(
+        f"Project '{datadir}' has been created with 'network.yaml' and 'node-defaults.yaml'."
+    )
+
+
+def inquirer_create_network(project_path: Path):
+    # Custom network configuration
+    questions = [
+        inquirer.Text(
+            "network_name",
+            message=click.style("Enter your network name", fg="blue", bold=True),
+            validate=lambda _, x: len(x) > 0,
+        ),
+        inquirer.List(
+            "nodes",
+            message=click.style("How many nodes would you like?", fg="blue", bold=True),
+            choices=["8", "12", "20", "50", "other"],
+            default="12",
+        ),
+        inquirer.List(
+            "connections",
+            message=click.style(
+                "How many connections would you like each node to have?",
+                fg="blue",
+                bold=True,
+            ),
+            choices=["0", "1", "2", "8", "12", "other"],
+            default="8",
+        ),
+        inquirer.List(
+            "version",
+            message=click.style(
+                "Which version would you like nodes to run by default?", fg="blue", bold=True
+            ),
+            choices=SUPPORTED_TAGS,
+            default=DEFAULT_TAG,
+        ),
+    ]
+
+    net_answers = inquirer.prompt(questions)
+    if net_answers is None:
+        click.secho("Setup cancelled by user.", fg="yellow")
+        return False
+
+    if net_answers["nodes"] == "other":
+        custom_nodes = inquirer.prompt(
+            [
+                inquirer.Text(
+                    "nodes",
+                    message=click.style("Enter the number of nodes", fg="blue", bold=True),
+                    validate=lambda _, x: int(x) > 0,
+                )
+            ]
+        )
+        if custom_nodes is None:
+            click.secho("Setup cancelled by user.", fg="yellow")
+            return False
+        net_answers["nodes"] = custom_nodes["nodes"]
+
+    if net_answers["connections"] == "other":
+        custom_connections = inquirer.prompt(
+            [
+                inquirer.Text(
+                    "connections",
+                    message=click.style("Enter the number of connections", fg="blue", bold=True),
+                    validate=lambda _, x: int(x) >= 0,
+                )
+            ]
+        )
+        if custom_connections is None:
+            click.secho("Setup cancelled by user.", fg="yellow")
+            return False
+        net_answers["connections"] = custom_connections["connections"]
+    fork_observer = click.prompt(
+        click.style(
+            "\nWould you like to enable fork-observer on the network?", fg="blue", bold=True
+        ),
+        type=bool,
+        default=True,
+    )
+    fork_observer_query_interval = 20
+    if fork_observer:
+        fork_observer_query_interval = click.prompt(
+            click.style(
+                "\nHow often would you like fork-observer to query node status (seconds)?",
+                fg="blue",
+                bold=True,
+            ),
+            type=int,
+            default=20,
+        )
+    custom_network_path = project_path / "networks" / net_answers["network_name"]
+    click.secho("\nGenerating custom network...", fg="yellow", bold=True)
+    custom_graph(
+        int(net_answers["nodes"]),
+        int(net_answers["connections"]),
+        net_answers["version"],
+        custom_network_path,
+        fork_observer,
+        fork_observer_query_interval,
+    )
+    return custom_network_path
+
+
+@click.command()
+def create():
+    """Create a new warnet network"""
+    try:
+        project_path = Path(os.getcwd())
+        # Check if the project has a networks directory
+        if not (project_path / "networks").exists():
+            click.secho(
+                "The current directory does not have a 'networks' directory. Please run 'warnet init' or 'warnet create' first.",
+                fg="red",
+                bold=True,
+            )
+            return False
+        custom_network_path = inquirer_create_network(project_path)
+        click.secho("\nNew network created successfully!", fg="green", bold=True)
+        click.echo("\nRun the following command to deploy this network:")
+        click.echo(f"warnet deploy {custom_network_path}")
+    except Exception as e:
+        click.echo(f"{e}\n\n")
+        click.secho(f"An error occurred while creating a new network:\n\n{e}\n\n", fg="red")
+        click.secho(
+            "Please report the above context to https://github.com/bitcoin-dev-project/warnet/issues",
+            fg="yellow",
+        )
+        return False

src/warnet/main.py

@@ -4,7 +4,7 @@
 from .bitcoin import bitcoin
 from .control import down, logs, run, stop
 from .deploy import deploy
-from .graph import graph
+from .graph import create, graph
 from .image import image
 from .project import init, new, setup
 from .status import status
@@ -30,6 +30,7 @@ def cli():
 cli.add_command(setup)
 cli.add_command(status)
 cli.add_command(stop)
+cli.add_command(create)
 
 
 if __name__ == "__main__":