Merge pull request #27 from miciav/feature/runner-controller-ui

Feature/runner controller UI

Author: miciav

docs/configuration.md

@@ -0,0 +1,25 @@
+## Configuration
+
+All knobs are defined in `BenchmarkConfig`:
+
+```python
+from pathlib import Path
+from lb_runner.benchmark_config import BenchmarkConfig
+from lb_runner.plugins.stress_ng.plugin import StressNGConfig
+
+config = BenchmarkConfig(
+    repetitions=5,
+    test_duration_seconds=120,
+    metrics_interval_seconds=0.5,
+    plugin_settings={
+        "stress_ng": StressNGConfig(
+            cpu_workers=4,
+            vm_workers=2,
+            vm_bytes="2G",
+        )
+    },
+)
+
+config.save(Path("my_config.json"))
+config = BenchmarkConfig.load(Path("my_config.json"))
+```

docs/contributing.md

@@ -0,0 +1,7 @@
+## Contributing
+
+1. Fork the project
+2. Create a feature branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push the branch (`git push origin feature/AmazingFeature`)
+5. Open a Pull Request

docs/css/extra.css

@@ -0,0 +1,8 @@
+.md-header__button.md-logo img {
+  height: 3.5rem; /* Adjust as needed */
+}
+
+.md-header__button.md-logo {
+  padding-top: 0.5rem; /* Adjust vertical alignment if necessary */
+  padding-bottom: 0.5rem;
+}

docs/index.md

@@ -34,45 +34,7 @@ It supports two operation modes:
 - **perf**: Linux profiling
 - **bcc/eBPF tools**: optional kernel-level metrics
 
-## Installation
 
-1. Clone the repository:
-```bash
-git clone <repository-url>
-cd linux-benchmark-lib
-```
-
-### Mode 1: Agent (Lightweight)
-Installs only the core dependencies for running benchmarks on a target node.
-
-```bash
-uv sync
-# Or install as a tool
-uv tool install .
-```
-
-### Mode 2: Controller (Full)
-Installs the core plus orchestration tools (Ansible) and reporting libraries (Matplotlib, Seaborn).
-
-```bash
-uv sync --extra controller
-# Or install as a tool
-uv tool install ".[controller]"
-```
-
-### Development
-Installs all dependencies including test and linting tools.
-
-```bash
-uv sync --all-extras --dev
-```
-
-Switch between modes quickly with the helper script:
-
-```bash
-bash tools/switch_mode.sh base        # core only
-bash tools/switch_mode.sh controller  # adds controller extra
-bash tools/switch_mode.sh dev         # dev + all extras
 ```
 
 ## CLI (lb)
@@ -111,40 +73,9 @@ See `CLI.md` for the full command reference. Highlights:
   This updates the generated apt/pip install block in `Dockerfile` and rewrites `lb_controller/ansible/roles/workload_runner/tasks/plugins.generated.yml`.
 - Commit both the manifest and generated files so remote setup and the container stay in sync with available plugins.
 - See `docs/PLUGIN_DEVELOPMENT.md` for a full plugin authoring guide (WorkloadPlugin interface, manifests, packaging, git installs).
-- HPL plugin: vedi `lb_runner/plugins/hpl/README.md` per note su packaging `.deb`, build VM/Docker e test `xhpl`.
-
-## Quick Start
-
-```python
-from lb_runner.benchmark_config import BenchmarkConfig, RemoteHostConfig, RemoteExecutionConfig
-from lb_controller.controller import BenchmarkController
-from lb_runner.local_runner import LocalRunner
-from lb_runner.plugin_system.builtin import builtin_plugins
-from lb_runner.plugin_system.registry import PluginRegistry
-
-# Create a configuration
-config = BenchmarkConfig(
-    repetitions=3,
-    test_duration_seconds=3600,
-    metrics_interval_seconds=1.0
-)
-
-# Local execution (Agent Mode)
-registry = PluginRegistry(builtin_plugins())
-runner = LocalRunner(config, registry=registry)
-runner.run_benchmark("stress_ng")
-
-# Remote execution (Controller Mode)
-# Requires 'controller' extra installed
-remote_config = BenchmarkConfig(
-    remote_hosts=[RemoteHostConfig(name="node1", address="192.168.1.10", user="ubuntu")],
-    remote_execution=RemoteExecutionConfig(enabled=True),
-)
-# Use distinct, non-empty `name` values per host; they become per-host output dirs.
-controller = BenchmarkController(remote_config)
-summary = controller.run(["stress_ng"], run_id="demo-run")
-print(summary.per_host_output)
-```
+- HPL plugin: see `lb_runner/plugins/hpl/README.md` for notes on `.deb` packaging, build VM/Docker and `xhpl` testing.
+
+
 
 ## Project Layout
 
@@ -158,31 +89,7 @@ linux-benchmark-lib/
 └── pyproject.toml       # Project configuration (Core + Extras)
 ```
 
-## Configuration
-
-All knobs are defined in `BenchmarkConfig`:
-
-```python
-from pathlib import Path
-from lb_runner.benchmark_config import BenchmarkConfig
-from lb_runner.plugins.stress_ng.plugin import StressNGConfig
-
-config = BenchmarkConfig(
-    repetitions=5,
-    test_duration_seconds=120,
-    metrics_interval_seconds=0.5,
-    plugin_settings={
-        "stress_ng": StressNGConfig(
-            cpu_workers=4,
-            vm_workers=2,
-            vm_bytes="2G",
-        )
-    },
-)
-
-config.save(Path("my_config.json"))
-config = BenchmarkConfig.load(Path("my_config.json"))
-```
+
 
 ## Output
 
@@ -209,14 +116,8 @@ mv classes*.puml docs/diagrams/classes.puml
 mv packages*.puml docs/diagrams/packages.puml
 ```
 
-## Contributing
 
-1. Fork the project
-2. Create a feature branch (`git checkout -b feature/AmazingFeature`)
-3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
-4. Push the branch (`git push origin feature/AmazingFeature`)
-5. Open a Pull Request
 
-## Licenza
+## License
 
-Distribuito sotto licenza MIT. Vedi `LICENSE` per maggiori informazioni.
+Distributed under the MIT License. See `LICENSE` for more information.

docs/installation.md

@@ -0,0 +1,39 @@
+## Installation
+
+1. Clone the repository:
+```bash
+git clone <repository-url>
+cd linux-benchmark-lib
+```
+
+### Mode 1: Agent (Lightweight)
+Installs only the core dependencies for running benchmarks on a target node.
+
+```bash
+uv sync
+# Or install as a tool
+uv tool install .
+```
+
+### Mode 2: Controller (Full)
+Installs the core plus orchestration tools (Ansible) and reporting libraries (Matplotlib, Seaborn).
+
+```bash
+uv sync --extra controller
+# Or install as a tool
+uv tool install ".[controller]"
+```
+
+### Development
+Installs all dependencies including test and linting tools.
+
+```bash
+uv sync --all-extras --dev
+```
+
+Switch between modes quickly with the helper script:
+
+```bash
+bash tools/switch_mode.sh base        # core only
+bash tools/switch_mode.sh controller  # adds controller extra
+bash tools/switch_mode.sh dev         # dev + all extras

docs/quickstart.md

@@ -0,0 +1,32 @@
+## Quick Start
+
+```python
+from lb_runner.benchmark_config import BenchmarkConfig, RemoteHostConfig, RemoteExecutionConfig
+from lb_controller.controller import BenchmarkController
+from lb_runner.local_runner import LocalRunner
+from lb_runner.plugin_system.builtin import builtin_plugins
+from lb_runner.plugin_system.registry import PluginRegistry
+
+# Create a configuration
+config = BenchmarkConfig(
+    repetitions=3,
+    test_duration_seconds=3600,
+    metrics_interval_seconds=1.0
+)
+
+# Local execution (Agent Mode)
+registry = PluginRegistry(builtin_plugins())
+runner = LocalRunner(config, registry=registry)
+runner.run_benchmark("stress_ng")
+
+# Remote execution (Controller Mode)
+# Requires 'controller' extra installed
+remote_config = BenchmarkConfig(
+    remote_hosts=[RemoteHostConfig(name="node1", address="192.168.1.10", user="ubuntu")],
+    remote_execution=RemoteExecutionConfig(enabled=True),
+)
+# Use distinct, non-empty `name` values per host; they become per-host output dirs.
+controller = BenchmarkController(remote_config)
+summary = controller.run(["stress_ng"], run_id="demo-run")
+print(summary.per_host_output)
+```

lb_controller/ansible/roles/workload_runner/tasks/main.yml

@@ -9,8 +9,8 @@
 - name: Define workload runner workdir (use globally installed lb_workdir)
   set_fact:
     workload_runner_workdir: "{{ lb_workdir | default('/opt/lb') }}"
-    setup_prefix: "[setup:{{ inventory_hostname }}]"
-    run_prefix: "[run:{{ inventory_hostname }}]"
+    setup_prefix: "[setup]"
+    run_prefix: "[run]"
 
 - name: "{{ setup_prefix }} Ensure workload output directory exists"
   ansible.builtin.file:

lb_controller/ansible/roles/workload_runner/tasks/run_single_rep.yml

@@ -8,7 +8,7 @@
         if workload_runner_reps is defined and (workload_runner_reps | length) > 0
         else (workload_runner_repetitions_total | default(1) | int)
       }}
-    run_prefix: "[run:{{ inventory_hostname }}:{{ workload_item[0] }}]"
+    run_prefix: "[run:{{ workload_item[0] }}]"
 
 - name: "{{ run_prefix }} Emit start event for repetition"
   ansible.builtin.debug:
@@ -75,6 +75,7 @@
         chdir: "{{ workload_runner_workdir }}"
       environment:
         LB_RUN_HOST: "{{ inventory_hostname }}"
+        LB_ENABLE_EVENT_LOGGING: "1"
       register: workload_runner_rep_result
       changed_when: true
 

lb_controller/ansible_executor.py

@@ -11,6 +11,7 @@
 from typing import Any, Callable, Dict, List, Optional
 
 from lb_controller.types import ExecutionResult, InventorySpec, RemoteExecutor
+from lb_runner.stop_token import StopToken
 
 logger = logging.getLogger(__name__)
 ANSIBLE_ROOT = Path(__file__).resolve().parent / "ansible"
@@ -25,6 +26,7 @@ def __init__(
         runner_fn: Optional[Callable[..., Any]] = None,
         stream_output: bool = False,
         output_callback: Optional[Callable[[str, str], None]] = None,
+        stop_token: StopToken | None = None,
     ):
         """
         Initialize the executor.
@@ -43,6 +45,7 @@ def __init__(
         self.event_log_path = self.private_data_dir / "lb_events.jsonl"
         self._runner_fn = runner_fn
         self.stream_output = stream_output
+        self.stop_token = stop_token
         # Force Ansible temp into a writable location inside the runner dir to avoid host-level permission issues
         self.local_tmp = self.private_data_dir / "tmp"
         self.local_tmp.mkdir(parents=True, exist_ok=True)
@@ -66,6 +69,8 @@ def run_playbook(
         limit_hosts: Optional[List[str]] = None,
     ) -> ExecutionResult:
         """Execute a playbook using ansible-runner."""
+        if self.stop_token and self.stop_token.should_stop():
+            return ExecutionResult(rc=1, status="stopped", stats={})
         if not playbook_path.exists():
             raise FileNotFoundError(f"Playbook not found: {playbook_path}")
 
@@ -204,13 +209,20 @@ def _run_subprocess_playbook(
                 text=True,
             )
             assert proc.stdout is not None
+            stop_requested = False
             for line in proc.stdout:
+                if self.stop_token and self.stop_token.should_stop():
+                    stop_requested = True
+                    proc.terminate()
+                    break
                 if self.output_callback:
                     self.output_callback(line.rstrip("\n"), "\n")
                 else:
                     sys.stdout.write(line)
             proc.wait()
             rc = proc.returncode
+            if stop_requested or (self.stop_token and self.stop_token.should_stop()):
+                return ExecutionResult(rc=rc or 1, status="stopped", stats={})
         else:
             completed = subprocess.run(
                 cmd,