feat: add simulation support for uipath debug command (#1117)

Co-authored-by: Claude Sonnet 4.5 <[email protected]>

Author: mjnovice

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "uipath"
-version = "2.5.29"
+version = "2.5.30"
 description = "Python SDK and CLI for UiPath Platform, enabling programmatic interaction with automation services, process management, and deployment tools."
 readme = { file = "README.md", content-type = "text/markdown" }
 requires-python = ">=3.11"

src/uipath/_cli/cli_debug.py

@@ -1,4 +1,7 @@
 import asyncio
+import json
+import uuid
+from pathlib import Path
 
 import click
 from uipath.core.tracing import UiPathTraceManager
@@ -14,6 +17,17 @@
 
 from uipath._cli._chat._bridge import get_chat_bridge
 from uipath._cli._debug._bridge import get_debug_bridge
+from uipath._cli._evals._span_collection import ExecutionSpanCollector
+from uipath._cli._evals.mocks.mocks import (
+    clear_execution_context,
+    set_execution_context,
+)
+from uipath._cli._evals.mocks.types import (
+    LLMMockingStrategy,
+    MockingContext,
+    MockingStrategyType,
+    ToolSimulation,
+)
 from uipath._cli._utils._debug import setup_debugging
 from uipath._cli._utils._studio_project import StudioClient
 from uipath._utils._bindings import ResourceOverwritesContext
@@ -26,6 +40,57 @@
 console = ConsoleLogger()
 
 
+def load_simulation_config() -> MockingContext | None:
+    """Load simulation.json from current directory and convert to MockingContext.
+
+    Returns:
+        MockingContext with LLM mocking strategy if simulation.json exists and is valid,
+        None otherwise.
+    """
+    simulation_path = Path.cwd() / "simulation.json"
+
+    if not simulation_path.exists():
+        return None
+
+    try:
+        with open(simulation_path, "r", encoding="utf-8") as f:
+            simulation_data = json.load(f)
+
+        # Check if simulation is enabled
+        if not simulation_data.get("enabled", True):
+            return None
+
+        # Extract tools to simulate
+        tools_to_simulate = [
+            ToolSimulation(name=tool["name"])
+            for tool in simulation_data.get("toolsToSimulate", [])
+        ]
+
+        if not tools_to_simulate:
+            return None
+
+        # Create LLM mocking strategy
+        mocking_strategy = LLMMockingStrategy(
+            type=MockingStrategyType.LLM,
+            prompt=simulation_data.get("instructions", ""),
+            tools_to_simulate=tools_to_simulate,
+        )
+
+        # Create MockingContext for debugging
+        mocking_context = MockingContext(
+            strategy=mocking_strategy,
+            name="debug-simulation",
+            inputs={},
+        )
+
+        console.info(f"Loaded simulation config for {len(tools_to_simulate)} tool(s)")
+        return mocking_context
+
+    except Exception as e:
+        console.warning(f"Failed to load simulation.json: {e}")
+        return None
+
+
 @click.command()
 @click.argument("entrypoint", required=False)
 @click.argument("input", required=False, default=None)
@@ -114,6 +179,17 @@ async def execute_debug_runtime():
                     debug_runtime: UiPathRuntimeProtocol | None = None
                     factory: UiPathRuntimeFactoryProtocol | None = None
 
+                    # Load simulation config and set up execution context for tool mocking
+                    mocking_ctx = load_simulation_config()
+                    span_collector: ExecutionSpanCollector | None = None
+                    execution_id = str(uuid.uuid4())
+
+                    if mocking_ctx:
+                        # Create span collector for trace access during mocking
+                        span_collector = ExecutionSpanCollector()
+                        # Set execution context to enable tool simulation
+                        set_execution_context(mocking_ctx, span_collector, execution_id)
+
                     try:
                         trigger_poll_interval: float = 5.0
 
@@ -163,6 +239,10 @@ async def execute_debug_runtime():
                             )
 
                     finally:
+                        # Clear execution context after debugging completes
+                        if mocking_ctx:
+                            clear_execution_context()
+
                         if debug_runtime:
                             await debug_runtime.dispose()
                         if chat_runtime: