benchlab-pytools 3.0.0__py3-none-any.whl

benchlab/vu/vu_server_config.py

@@ -0,0 +1,40 @@
+# benchlab/vu/vu_server_config.py
+
+from pathlib import Path
+import json
+
+config_path = Path(__file__).parent / "vu_server.config"
+
+
+def update_vu_config(dial_uid, dial_name, device, sensor):
+    # Load existing config
+    if config_path.exists():
+        with open(config_path, "r") as f:
+            config = json.load(f)
+    else:
+        config = {
+            "vu_server_url": "http://localhost:5340",
+            "api_key": "",
+            "mappings": [],
+            "update_interval_sec": 1}
+
+    # Remove any mapping with the same dial_uid
+    existing = config.get("mappings", [])
+    filtered = [m for m in existing if m.get("dial_uid") != dial_uid]
+
+    # Add new mapping
+    filtered.append({
+        "dial_uid": dial_uid,
+        "dial_name": dial_name,
+        "benchlab_uid": device["uid"],
+        "benchlab_port": device["port"],
+        "sensor": sensor
+    })
+
+    # Update config
+    config["mappings"] = filtered
+
+    # Write back to file
+    with open(config_path, "w") as f:
+        json.dump(config, f, indent=2)
+    print("[INFO] vu_server.config updated.")

benchlab/vu/vu_server_manager.py

@@ -0,0 +1,192 @@
+import subprocess
+import threading
+import time
+import requests
+import yaml
+import json
+import signal
+import logging
+from pathlib import Path
+import sys
+import platform
+import os
+
+# -----------------------------------------------------------------------------
+# Platform setup
+# -----------------------------------------------------------------------------
+IS_WINDOWS = platform.system() == "Windows"
+PYTHON_CMD = sys.executable
+CREATIONFLAGS = subprocess.CREATE_NEW_PROCESS_GROUP if IS_WINDOWS else 0
+
+# -----------------------------------------------------------------------------
+# Paths
+# -----------------------------------------------------------------------------
+BASE_DIR = Path(__file__).parent
+VU_SERVER_DIR = BASE_DIR / "VU-Server"
+VU_SERVER_CONFIG = BASE_DIR / "vu_server.config"
+SERVER_YAML_CONFIG = VU_SERVER_DIR / "config.yaml"
+
+# -----------------------------------------------------------------------------
+# Logging
+# -----------------------------------------------------------------------------
+logger = logging.getLogger("vu_server_manager")
+
+# -----------------------------------------------------------------------------
+# Helpers
+# -----------------------------------------------------------------------------
+
+
+def check_vu_server(server_url: str, api_key: str = "") -> bool:
+    """Return True if the VU server responds successfully.
+
+    The server reads the API key as a `key` query parameter (see
+    server.py's BaseHandler.is_valid_api_key), not an HTTP header — match
+    that here so a correct api_key is actually validated by the server
+    instead of always being rejected and falling through to the 403
+    "still running" case below.
+    """
+    try:
+        # "localhost" resolves to both an IPv4 and IPv6 address on Windows,
+        # and requests/urllib3 tries each in turn, each getting its own
+        # full timeout budget — a "nothing listening" check with
+        # timeout=1 can silently take ~2s instead of 1s. Force IPv4
+        # loopback for the common "localhost" case so the timeout below
+        # is actually honored; leave any other configured hostname alone.
+        probe_url = server_url.replace("://localhost", "://127.0.0.1", 1)
+        params = {"key": api_key} if api_key else {}
+        r = requests.get(
+            f"{probe_url}/api/v0/dial/list",
+            params=params,
+            timeout=1)
+        # 403 (missing/invalid key) still means a real VU server answered —
+        # that's enough to know we shouldn't auto-start a second one.
+        return r.status_code in (200, 403)
+    except requests.RequestException:
+        return False
+
+
+def forward_logs(proc: subprocess.Popen):
+    """Forward VU server stdout to the main logger."""
+    if not proc.stdout:
+        logger.warning("No stdout to forward from VU server.")
+        return
+    for line in proc.stdout:
+        if line := line.rstrip():
+            logger.info(f"[VU SERVER] {line}")
+
+# -----------------------------------------------------------------------------
+# Server startup
+# -----------------------------------------------------------------------------
+
+
+def start_vu_server() -> subprocess.Popen | None:
+    """
+    Ensure a VU server is running.
+    Returns a subprocess.Popen handle if a new server was started, or
+    None if already running.
+    """
+    logger.info("Checking for existing VU server...")
+
+    # Load previous JSON config
+    server_cfg = {}
+    if VU_SERVER_CONFIG.exists():
+        try:
+            server_cfg = json.loads(VU_SERVER_CONFIG.read_text())
+        except Exception as e:
+            logger.warning(f"Failed to read {VU_SERVER_CONFIG}: {e}")
+
+    url = server_cfg.get("vu_server_url", "http://localhost:5340")
+    api_key = server_cfg.get("api_key", "")
+
+    if check_vu_server(url, api_key):
+        logger.info(f"VU server already running at {url}")
+        return None
+
+    logger.info("No VU server found — starting one...")
+
+    # Load YAML config
+    try:
+        cfg = yaml.safe_load(SERVER_YAML_CONFIG.read_text())
+    except Exception as e:
+        logger.error(f"Failed to read {SERVER_YAML_CONFIG}: {e}")
+        raise
+
+    host = cfg.get("server", {}).get("hostname", "localhost")
+    port = cfg.get("server", {}).get("port", 5340)
+    master_key = cfg.get("server", {}).get("master_key", "")
+
+    new_cfg = {
+        "vu_server_url": f"http://{host}:{port}",
+        "api_key": master_key,
+        "logo_file": str(
+            server_cfg.get(
+                "logo_file",
+                "assets/bl_logo_144x200.png"))}
+
+    # Ensure VU-Server directory exists
+    if not VU_SERVER_DIR.exists():
+        logger.error(f"Missing server directory: {VU_SERVER_DIR}")
+        raise FileNotFoundError(VU_SERVER_DIR)
+
+    # Launch server
+    proc = subprocess.Popen(
+        [PYTHON_CMD, "-u", str(VU_SERVER_DIR / "server.py")],
+        cwd=str(VU_SERVER_DIR),
+        stdout=subprocess.PIPE,
+        stderr=subprocess.STDOUT,
+        bufsize=1,
+        text=True,
+        creationflags=CREATIONFLAGS,
+        preexec_fn=os.setsid if not IS_WINDOWS else None,
+    )
+
+    threading.Thread(target=forward_logs, args=(proc,), daemon=True).start()
+
+    # Wait for server to become ready
+    for _ in range(10):
+        time.sleep(1)
+        if check_vu_server(new_cfg["vu_server_url"], new_cfg["api_key"]):
+            logger.info(
+                f"VU server is now running at {
+                    new_cfg['vu_server_url']}")
+            break
+    else:
+        logger.error("Failed to verify VU server after startup.")
+        return None
+
+    # Only persist the new config once the server is confirmed up, so a
+    # failed launch doesn't leave vu_server.config pointing at nothing.
+    try:
+        VU_SERVER_CONFIG.write_text(json.dumps(new_cfg, indent=2))
+        logger.info(
+            f"Updated {VU_SERVER_CONFIG} with {
+                new_cfg['vu_server_url']}")
+    except Exception as e:
+        logger.warning(f"Failed to write {VU_SERVER_CONFIG}: {e}")
+
+    return proc
+
+# -----------------------------------------------------------------------------
+# Shutdown
+# -----------------------------------------------------------------------------
+
+
+def terminate_vu_server(proc: subprocess.Popen | None):
+    if not proc or proc.poll() is not None:
+        return
+    logger.info("Terminating auto-started VU server...")
+    try:
+        if IS_WINDOWS:
+            proc.send_signal(signal.CTRL_BREAK_EVENT)
+        else:
+            os.killpg(os.getpgid(proc.pid), signal.SIGINT)
+        proc.wait(timeout=5)
+    except subprocess.TimeoutExpired:
+        logger.warning("VU server did not exit gracefully — force killing.")
+        try:
+            proc.kill()
+            proc.wait(timeout=5)
+        except Exception as e:
+            logger.warning(f"Failed to force-kill VU server: {e}")
+    except Exception as e:
+        logger.warning(f"Failed to terminate VU server cleanly: {e}")