From 023ab1a454ecf8bcc54c7316f88d3e9c5a6cbaa7 Mon Sep 17 00:00:00 2001 From: "Antonio Melo Jr." Date: Thu, 2 Jul 2026 20:02:24 +0000 Subject: [PATCH 1/4] Adding Execution Tree to the Realtime log with step jump feature --- th_cli/test_run/log_stream_handler.py | 197 +++- th_cli/test_run/log_viewer.html | 1471 ++++++++++++++----------- th_cli/test_run/logging.py | 9 +- th_cli/test_run/logs_http_server.py | 173 +-- th_cli/test_run/websocket.py | 32 + 5 files changed, 1142 insertions(+), 740 deletions(-) diff --git a/th_cli/test_run/log_stream_handler.py b/th_cli/test_run/log_stream_handler.py index 0c56aca..35b58aa 100644 --- a/th_cli/test_run/log_stream_handler.py +++ b/th_cli/test_run/log_stream_handler.py @@ -16,7 +16,7 @@ import datetime import queue import socket -from typing import Optional +from typing import Any, Optional from loguru import logger @@ -35,9 +35,11 @@ def __init__(self, port: int = 8998): self.port = port self.http_server = LogsHTTPServer(port=port) self.log_queue: queue.Queue = queue.Queue(maxsize=1000) + # Mutable dict kept in-place so the server's reference always reflects current state. + self.tree_state: dict = {} self.is_running = False self.log_file_path: Optional[str] = None - + def start(self, test_run_title: str = "Test Execution", log_file_path: Optional[str] = None) -> str: """Start the log streaming HTTP server. @@ -51,7 +53,7 @@ def start(self, test_run_title: str = "Test Execution", log_file_path: Optional[ if self.is_running: logger.warning("Log stream handler already running") return self._get_log_viewer_url() - + try: # Store log file path for download functionality self.log_file_path = log_file_path @@ -62,69 +64,55 @@ def start(self, test_run_title: str = "Test Execution", log_file_path: Optional[ # Start HTTP server self.http_server.start( log_queue=self.log_queue, + tree_state=self.tree_state, test_run_title=test_run_title, local_ip=local_ip, log_file_path=log_file_path, ) - + self.is_running = True - + viewer_url = f"http://{local_ip}:{self.port}" logger.info(f"Log stream viewer started: {viewer_url}") - + return viewer_url - + except Exception as e: logger.error(f"Failed to start log stream handler: {e}") raise - + def stop(self): """Stop the log streaming HTTP server.""" if not self.is_running: return - + try: - # Signal end of stream - if not self.log_queue.full(): - try: - self.log_queue.put_nowait(None) - except queue.Full: - pass - - # Stop HTTP server + try: + self.log_queue.put_nowait(None) + except queue.Full: + pass + self.http_server.stop() - self.is_running = False logger.info("Log stream handler stopped") - + except Exception as e: logger.error(f"Error stopping log stream handler: {e}") - - def add_log_entry( - self, - message: str, - level: str = "INFO", - timestamp: Optional[str] = None - ): - """Add a log entry to the stream. - - Args: - message: Log message text - level: Log level (INFO, WARNING, ERROR, DEBUG, etc.) - timestamp: ISO format timestamp (auto-generated if not provided) - """ + + def add_log_entry(self, message: str, level: str = "INFO", timestamp: Optional[str] = None): + """Add a log entry to the stream.""" if not self.is_running: return - + if timestamp is None: timestamp = datetime.datetime.now().isoformat() - + log_entry = { "message": message, "level": level.upper(), "timestamp": timestamp, } - + try: # Try to add to queue without blocking self.log_queue.put_nowait(log_entry) @@ -132,7 +120,140 @@ def add_log_entry( # Queue is full, skip this entry silently to avoid blocking # This is acceptable for real-time streaming when no browser is connected pass - + + # ------------------------------------------------------------------ + # Tree management + # ------------------------------------------------------------------ + + def init_tree(self, run: Any) -> None: + """Build the tree from a TestRunExecutionWithChildren and broadcast it. + + Keeps tree_state mutated in-place so the server's reference stays valid + for clients that connect (or reconnect) after this point. + """ + if not self.is_running: + return + + try: + tree = self._build_tree(run) + self.tree_state.clear() + self.tree_state.update(tree) + + # Queue a tree_init event for the client that is already connected. + # Reconnecting clients receive the snapshot directly from tree_state. + self.log_queue.put_nowait({"type": "tree_init", "data": dict(tree)}) + except queue.Full: + pass + except Exception as e: + logger.debug(f"Error initialising tree: {e}") + + def update_tree_node( + self, + state: str, + suite_idx: Optional[int] = None, + case_idx: Optional[int] = None, + step_idx: Optional[int] = None, + ) -> None: + """Update a single node's state and queue a tree_update event. + + Pass only the indices that identify the target level: + - suite_idx=None → run-level update + - suite_idx=N, case_idx=None → suite-level update + - suite_idx=N, case_idx=M, step_idx=None → case-level update + - suite_idx=N, case_idx=M, step_idx=K → step-level update + """ + if not self.is_running: + return + + if suite_idx is None: + node_type = "run" + elif case_idx is None: + node_type = "suite" + elif step_idx is None: + node_type = "case" + else: + node_type = "step" + + # Mutate tree_state in-place (kept consistent for reconnecting clients). + try: + if node_type == "run": + self.tree_state["state"] = state + elif node_type == "suite": + self.tree_state["suites"][suite_idx]["state"] = state + elif node_type == "case": + self.tree_state["suites"][suite_idx]["cases"][case_idx]["state"] = state + else: + self.tree_state["suites"][suite_idx]["cases"][case_idx]["steps"][step_idx]["state"] = state + except (IndexError, KeyError, TypeError): + pass + + event = { + "type": "tree_update", + "node_type": node_type, + "suite_idx": suite_idx, + "case_idx": case_idx, + "step_idx": step_idx, + "state": state, + } + + try: + self.log_queue.put_nowait(event) + except queue.Full: + pass + + # ------------------------------------------------------------------ + # Internals + # ------------------------------------------------------------------ + + def _build_tree(self, run: Any) -> dict: + """Construct a plain-dict tree from a TestRunExecutionWithChildren.""" + tree: dict = { + "title": getattr(run, "title", "Test Run"), + "state": self._get_state(run), + "suites": [], + } + + for suite_idx, suite in enumerate(getattr(run, "test_suite_executions", []) or []): + smeta = getattr(suite, "test_suite_metadata", None) + suite_node: dict = { + "index": suite_idx, + "title": getattr(smeta, "title", f"Suite {suite_idx}") if smeta else f"Suite {suite_idx}", + "state": self._get_state(suite), + "cases": [], + } + + for case_idx, case in enumerate(getattr(suite, "test_case_executions", []) or []): + cmeta = getattr(case, "test_case_metadata", None) + case_node: dict = { + "index": case_idx, + "title": getattr(cmeta, "title", f"Case {case_idx}") if cmeta else f"Case {case_idx}", + "public_id": getattr(cmeta, "public_id", "") if cmeta else "", + "state": self._get_state(case), + "steps": [], + } + + for step_idx, step in enumerate(getattr(case, "test_step_executions", []) or []): + case_node["steps"].append({ + "index": step_idx, + "title": getattr(step, "title", f"Step {step_idx}"), + "state": self._get_state(step), + }) + + suite_node["cases"].append(case_node) + + tree["suites"].append(suite_node) + + return tree + + def _get_state(self, obj: Any) -> str: + try: + state = getattr(obj, "state", None) + if state is None: + return "pending" + return state.value if hasattr(state, "value") else str(state) + except Exception: + return "pending" + def _get_local_ip(self) -> str: """Get the local IP address of the machine. @@ -149,7 +270,7 @@ def _get_local_ip(self) -> str: return local_ip except Exception: return "localhost" - + def _get_log_viewer_url(self) -> str: """Get the URL for the log viewer. diff --git a/th_cli/test_run/log_viewer.html b/th_cli/test_run/log_viewer.html index 4e38ca6..e24cabb 100644 --- a/th_cli/test_run/log_viewer.html +++ b/th_cli/test_run/log_viewer.html @@ -4,6 +4,8 @@ Real-Time Log Viewer -
-
-
Matter Certification Tool
+ + +
+
+
Matter Certification Tool
+
+
+
+ + Connecting...
-
-
- - Connecting... -
-
CLI
-
-
Log Viewer
-
Real-Time Stream
+
CLI
+
+
Log Viewer
+
Real-Time Stream
+
+
+
+ + + + + +
+ + +
+
🗎 Execution Tree
+
+
+
⏳
+
Waiting for
execution to start…
+
-
-