Skip to content

feat: add simulation support for uipath debug command #1117

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mjnovice merged 9 commits into from
Jan 22, 2026
Merged

feat: add simulation support for uipath debug command #1117

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
b7d0408
feat: add simulation support for uipath debug command
mjnovice Jan 15, 2026
04e427f
fix: patch Path.cwd() in simulation test to fix Windows failure
mjnovice Jan 22, 2026
c864624
fix: mock load_simulation_config instead of patching filesystem
mjnovice Jan 22, 2026
a6bf452
fix: resolve mypy type errors in simulation tests
mjnovice Jan 22, 2026
1da9d94
fix: restore type ignore comment for uipath.dev import
mjnovice Jan 22, 2026
5f78432
fix: move type ignore comment to import line
mjnovice Jan 22, 2026
158faa6
fix: remove unused result variables in simulation tests
mjnovice Jan 22, 2026
649249c
style: apply ruff formatting to simulation tests
mjnovice Jan 22, 2026
fa82f11
chore: bump version to 2.5.30
mjnovice Jan 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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"
Expand Down
80 changes: 80 additions & 0 deletions src/uipath/_cli/cli_debug.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
import asyncio
import json
import uuid
from pathlib import Path

import click
from uipath.core.tracing import UiPathTraceManager
Expand All @@ -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
Expand All @@ -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)
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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:
Expand Down
Loading