Files
zaferdace c18ee94da8 feat: add execute_code tool for running arbitrary C# in Unity Editor
Adds a built-in `execute_code` tool that compiles and runs C# code
inside the Unity Editor via CSharpCodeProvider. No external dependencies
(Roslyn not required), no script files created.

## Actions
- `execute` — compile and run C# method body, return result
- `get_history` — list past executions with previews
- `replay` — re-run a history entry with original settings
- `clear_history` — clear execution history

## Safety
- `safety_checks` (default: true) blocks known dangerous patterns
  (File.Delete, Process.Start, AssetDatabase.DeleteAsset, infinite loops)
- Clearly documented as pattern-based blocklist, NOT a security sandbox
- `destructiveHint=True` annotation for MCP clients

## Features
- In-memory compilation with all loaded assembly references
- User-friendly error line numbers (wrapper offset subtracted)
- Execution history (max 50 entries) with code preview truncation
- Replay preserves original safety_checks setting
- CLI commands: `code execute`, `code history`, `code replay`, `code clear-history`

## Files
- C#: `MCPForUnity/Editor/Tools/ExecuteCode.cs` (329 lines)
- Python: `Server/src/services/tools/execute_code.py` (85 lines)
- CLI: `Server/src/cli/commands/code.py` (+89 lines)
- Tests: `Server/tests/test_execute_code.py` (17 tests, all passing)
- Manifest: added `execute_code` entry

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-03-29 16:20:28 +01:00

165 lines
5.4 KiB
Python

"""Tests for execute_code tool."""
import asyncio
from types import SimpleNamespace
from unittest.mock import AsyncMock
import pytest
from services.tools.execute_code import execute_code
@pytest.fixture
def mock_unity(monkeypatch):
captured: dict[str, object] = {}
async def fake_send(send_fn, unity_instance, tool_name, params):
captured["tool_name"] = tool_name
captured["params"] = params
return {"success": True, "message": "Code executed successfully.", "data": {"result": 42}}
monkeypatch.setattr(
"services.tools.execute_code.get_unity_instance_from_context",
AsyncMock(return_value="unity-instance-1"),
)
monkeypatch.setattr(
"services.tools.execute_code.send_with_unity_instance",
fake_send,
)
return captured
@pytest.fixture
def mock_unity_error(monkeypatch):
async def fake_send(send_fn, unity_instance, tool_name, params):
return {"success": False, "error": "Compilation failed"}
monkeypatch.setattr(
"services.tools.execute_code.get_unity_instance_from_context",
AsyncMock(return_value="unity-instance-1"),
)
monkeypatch.setattr(
"services.tools.execute_code.send_with_unity_instance",
fake_send,
)
# --- execute action ---
def test_execute_forwards_code_to_unity(mock_unity):
result = asyncio.run(execute_code(SimpleNamespace(), action="execute", code="return 42;"))
assert result["success"] is True
assert mock_unity["tool_name"] == "execute_code"
assert mock_unity["params"]["code"] == "return 42;"
assert mock_unity["params"]["action"] == "execute"
def test_execute_sends_safety_checks_true_by_default(mock_unity):
asyncio.run(execute_code(SimpleNamespace(), action="execute", code="return 1;"))
assert mock_unity["params"]["safety_checks"] is True
def test_execute_sends_safety_checks_false(mock_unity):
asyncio.run(execute_code(SimpleNamespace(), action="execute", code="x();", safety_checks=False))
assert mock_unity["params"]["safety_checks"] is False
def test_execute_returns_data(mock_unity):
result = asyncio.run(execute_code(SimpleNamespace(), action="execute", code="return 42;"))
assert result["data"]["result"] == 42
def test_execute_requires_code():
result = asyncio.run(execute_code(SimpleNamespace(), action="execute", code=None))
assert result["success"] is False
assert "code" in result["message"].lower()
# --- get_history action ---
def test_get_history_forwards_to_unity(mock_unity):
asyncio.run(execute_code(SimpleNamespace(), action="get_history", limit=5))
assert mock_unity["params"]["action"] == "get_history"
assert mock_unity["params"]["limit"] == 5
def test_get_history_default_limit(mock_unity):
asyncio.run(execute_code(SimpleNamespace(), action="get_history"))
assert mock_unity["params"]["limit"] == 10
def test_get_history_clamps_limit(mock_unity):
asyncio.run(execute_code(SimpleNamespace(), action="get_history", limit=999))
assert mock_unity["params"]["limit"] == 50
def test_get_history_clamps_negative_limit(mock_unity):
asyncio.run(execute_code(SimpleNamespace(), action="get_history", limit=-5))
assert mock_unity["params"]["limit"] == 1
# --- replay action ---
def test_replay_forwards_index(mock_unity):
asyncio.run(execute_code(SimpleNamespace(), action="replay", index=3))
assert mock_unity["params"]["action"] == "replay"
assert mock_unity["params"]["index"] == 3
def test_replay_requires_index():
result = asyncio.run(execute_code(SimpleNamespace(), action="replay", index=None))
assert result["success"] is False
assert "index" in result["message"].lower()
# --- clear_history action ---
def test_clear_history_forwards(mock_unity):
asyncio.run(execute_code(SimpleNamespace(), action="clear_history"))
assert mock_unity["params"]["action"] == "clear_history"
# --- error handling ---
def test_error_response_normalized(mock_unity_error):
result = asyncio.run(execute_code(SimpleNamespace(), action="execute", code="bad"))
assert result["success"] is False
assert "Compilation failed" in result["message"]
def test_non_dict_response_handled(monkeypatch):
async def fake_send(send_fn, unity_instance, tool_name, params):
return "unexpected"
monkeypatch.setattr(
"services.tools.execute_code.get_unity_instance_from_context",
AsyncMock(return_value="unity-instance-1"),
)
monkeypatch.setattr(
"services.tools.execute_code.send_with_unity_instance",
fake_send,
)
result = asyncio.run(execute_code(SimpleNamespace(), action="execute", code="return 1;"))
assert result["success"] is False
# --- param isolation ---
def test_execute_omits_irrelevant_params(mock_unity):
asyncio.run(execute_code(SimpleNamespace(), action="execute", code="return 1;"))
assert "index" not in mock_unity["params"]
assert "limit" not in mock_unity["params"]
def test_history_omits_irrelevant_params(mock_unity):
asyncio.run(execute_code(SimpleNamespace(), action="get_history"))
assert "code" not in mock_unity["params"]
assert "index" not in mock_unity["params"]
assert "safety_checks" not in mock_unity["params"]
def test_replay_omits_irrelevant_params(mock_unity):
asyncio.run(execute_code(SimpleNamespace(), action="replay", index=0))
assert "code" not in mock_unity["params"]
assert "limit" not in mock_unity["params"]
assert "safety_checks" not in mock_unity["params"]