Add CLI tool with run command (#67)

Author: networmix

ngraph/__init__.py

@@ -1 +1,4 @@
-import ngraph.transform
+from __future__ import annotations
+from . import cli, transform
+
+__all__ = ["cli", "transform"]

ngraph/__main__.py

@@ -0,0 +1,6 @@
+from __future__ import annotations
+
+from .cli import main
+
+if __name__ == "__main__":
+    main()

ngraph/cli.py

@@ -0,0 +1,47 @@
+from __future__ import annotations
+
+import argparse
+import json
+from pathlib import Path
+from typing import Any, Dict, List, Optional
+
+from ngraph.scenario import Scenario
+
+
+def _run_scenario(path: Path, output: Optional[Path]) -> None:
+    """Run a scenario file and store results as JSON."""
+    yaml_text = path.read_text()
+    scenario = Scenario.from_yaml(yaml_text)
+    scenario.run()
+
+    results_dict: Dict[str, Dict[str, Any]] = scenario.results.to_dict()
+    json_str = json.dumps(results_dict, indent=2, default=str)
+    if output:
+        output.write_text(json_str)
+    else:
+        print(json_str)
+
+
+def main(argv: Optional[List[str]] = None) -> None:
+    """Entry point for the ``ngraph`` command."""
+    parser = argparse.ArgumentParser(prog="ngraph")
+    subparsers = parser.add_subparsers(dest="command", required=True)
+
+    run_parser = subparsers.add_parser("run", help="Run a scenario")
+    run_parser.add_argument("scenario", type=Path, help="Path to scenario YAML")
+    run_parser.add_argument(
+        "--results",
+        "-r",
+        type=Path,
+        default=None,
+        help="Write JSON results to this file instead of stdout",
+    )
+
+    args = parser.parse_args(argv)
+
+    if args.command == "run":
+        _run_scenario(args.scenario, args.results)
+
+
+if __name__ == "__main__":
+    main()

ngraph/results.py

@@ -54,3 +54,7 @@ def get_all(self, key: str) -> Dict[str, Any]:
             if key in data:
                 result[step_name] = data[key]
         return result
+
+    def to_dict(self) -> Dict[str, Dict[str, Any]]:
+        """Return a dictionary representation of all stored results."""
+        return {step: data.copy() for step, data in self._store.items()}

notebooks/bb_fabric.ipynb

@@ -2,7 +2,7 @@
  "cells": [
   {
    "cell_type": "code",
-   "execution_count": 6,
+   "execution_count": 11,
    "id": "a92a8d34",
    "metadata": {},
    "outputs": [],
@@ -19,7 +19,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 12,
    "id": "ad94e880",
    "metadata": {},
    "outputs": [
@@ -101,7 +101,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 8,
+   "execution_count": 13,
    "id": "6c491ddc",
    "metadata": {},
    "outputs": [
@@ -111,7 +111,7 @@
        "Node(name='bb_fabric/t1/t1-4', disabled=True, risk_groups=set(), attrs={'type': 'node'})"
       ]
      },
-     "execution_count": 8,
+     "execution_count": 13,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -122,7 +122,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 9,
+   "execution_count": 14,
    "id": "df3eb867",
    "metadata": {},
    "outputs": [],
@@ -132,19 +132,19 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 10,
+   "execution_count": 15,
    "id": "35a81770",
    "metadata": {},
    "outputs": [
     {
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "- root | Nodes=21, Links=130, Cost=0.0, Power=0.0\n",
-      "  - bb_fabric | Nodes=20, Links=130, Cost=0.0, Power=0.0\n",
+      "- root | Nodes=21, Links=132, Cost=0.0, Power=0.0\n",
+      "  - bb_fabric | Nodes=20, Links=132, Cost=0.0, Power=0.0\n",
       "    - t2 | Nodes=4, Links=128, Cost=0.0, Power=0.0\n",
-      "    - t1 | Nodes=16, Links=130, Cost=0.0, Power=0.0\n",
-      "  - remote | Nodes=1, Links=2, Cost=0.0, Power=0.0\n"
+      "    - t1 | Nodes=16, Links=132, Cost=0.0, Power=0.0\n",
+      "  - remote | Nodes=1, Links=4, Cost=0.0, Power=0.0\n"
      ]
     }
    ],

pyproject.toml

@@ -33,6 +33,9 @@ dev = [
     "black",
     "isort",
 ]
+[project.scripts]
+ngraph = "ngraph.cli:main"
+
 
 # ---------------------------------------------------------------------
 # Pytest flags

tests/test_cli.py

@@ -0,0 +1,22 @@
+import json
+from pathlib import Path
+
+from ngraph import cli
+
+
+def test_cli_run_file(tmp_path: Path) -> None:
+    scenario = Path("tests/scenarios/scenario_1.yaml")
+    out_file = tmp_path / "res.json"
+    cli.main(["run", str(scenario), "--results", str(out_file)])
+    assert out_file.is_file()
+    data = json.loads(out_file.read_text())
+    assert "build_graph" in data
+    assert "graph" in data["build_graph"]
+
+
+def test_cli_run_stdout(capsys) -> None:
+    scenario = Path("tests/scenarios/scenario_1.yaml")
+    cli.main(["run", str(scenario)])
+    captured = capsys.readouterr()
+    data = json.loads(captured.out)
+    assert "build_graph" in data