Spaces:
Build error
Build error
File size: 13,741 Bytes
51ff9e5 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 |
"""Bash-related tests for the DockerRuntime, which connects to the ActionExecutor running in the sandbox."""
import json
import os
import socket
import time
import docker
import pytest
from conftest import (
_load_runtime,
)
import openhands
from openhands.core.config import MCPConfig
from openhands.core.config.mcp_config import MCPSSEServerConfig, MCPStdioServerConfig
from openhands.core.logger import openhands_logger as logger
from openhands.events.action import CmdRunAction, MCPAction
from openhands.events.observation import CmdOutputObservation, MCPObservation
# ============================================================================================================================
# Bash-specific tests
# ============================================================================================================================
pytestmark = pytest.mark.skipif(
os.environ.get('TEST_RUNTIME') == 'cli',
reason='CLIRuntime does not support MCP actions',
)
@pytest.fixture
def sse_mcp_docker_server():
"""Manages the lifecycle of the SSE MCP Docker container for tests, using a random available port."""
image_name = 'supercorp/supergateway'
# Find a free port
with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:
s.bind(('', 0))
host_port = s.getsockname()[1]
container_internal_port = (
8000 # The port the MCP server listens on *inside* the container
)
container_command_args = [
'--stdio',
'npx -y @modelcontextprotocol/server-filesystem /',
'--port',
str(container_internal_port), # MCP server inside container listens on this
'--baseUrl',
f'http://localhost:{host_port}', # The URL used to access the server from the host
]
client = docker.from_env()
container = None
log_streamer = None
# Import LogStreamer here as it's specific to this fixture's needs
from openhands.runtime.utils.log_streamer import LogStreamer
try:
logger.info(
f'Starting Docker container {image_name} with command: {" ".join(container_command_args)} '
f'and mapping internal port {container_internal_port} to host port {host_port}',
extra={'msg_type': 'ACTION'},
)
container = client.containers.run(
image_name,
command=container_command_args,
ports={
f'{container_internal_port}/tcp': host_port
}, # Map container's internal port to the random host port
detach=True,
auto_remove=True,
stdin_open=True,
)
logger.info(
f'Container {container.short_id} started, listening on host port {host_port}.'
)
log_streamer = LogStreamer(
container,
lambda level, msg: getattr(logger, level.lower())(
f'[MCP server {container.short_id}] {msg}'
),
)
# Wait for the server to initialize, as in the original tests
time.sleep(10)
yield {'url': f'http://localhost:{host_port}/sse'}
finally:
if container:
logger.info(f'Stopping container {container.short_id}...')
try:
container.stop(timeout=5)
logger.info(
f'Container {container.short_id} stopped (and should be auto-removed).'
)
except docker.errors.NotFound:
logger.info(
f'Container {container.short_id} not found, likely already stopped and removed.'
)
except Exception as e:
logger.error(f'Error stopping container {container.short_id}: {e}')
if log_streamer:
log_streamer.close()
def test_default_activated_tools():
project_root = os.path.dirname(openhands.__file__)
mcp_config_path = os.path.join(project_root, 'runtime', 'mcp', 'config.json')
assert os.path.exists(mcp_config_path), (
f'MCP config file not found at {mcp_config_path}'
)
with open(mcp_config_path, 'r') as f:
mcp_config = json.load(f)
assert 'mcpServers' in mcp_config
assert 'default' in mcp_config['mcpServers']
assert 'tools' in mcp_config
# no tools are always activated yet
assert len(mcp_config['tools']) == 0
@pytest.mark.asyncio
async def test_fetch_mcp_via_stdio(temp_dir, runtime_cls, run_as_openhands):
mcp_stdio_server_config = MCPStdioServerConfig(
name='fetch', command='uvx', args=['mcp-server-fetch']
)
override_mcp_config = MCPConfig(stdio_servers=[mcp_stdio_server_config])
runtime, config = _load_runtime(
temp_dir, runtime_cls, run_as_openhands, override_mcp_config=override_mcp_config
)
# Test browser server
action_cmd = CmdRunAction(command='python3 -m http.server 8000 > server.log 2>&1 &')
logger.info(action_cmd, extra={'msg_type': 'ACTION'})
obs = runtime.run_action(action_cmd)
logger.info(obs, extra={'msg_type': 'OBSERVATION'})
assert isinstance(obs, CmdOutputObservation)
assert obs.exit_code == 0
assert '[1]' in obs.content
action_cmd = CmdRunAction(command='sleep 3 && cat server.log')
logger.info(action_cmd, extra={'msg_type': 'ACTION'})
obs = runtime.run_action(action_cmd)
logger.info(obs, extra={'msg_type': 'OBSERVATION'})
assert obs.exit_code == 0
mcp_action = MCPAction(name='fetch', arguments={'url': 'http://localhost:8000'})
obs = await runtime.call_tool_mcp(mcp_action)
logger.info(obs, extra={'msg_type': 'OBSERVATION'})
assert isinstance(obs, MCPObservation), (
'The observation should be a MCPObservation.'
)
result_json = json.loads(obs.content)
assert not result_json['isError']
assert len(result_json['content']) == 1
assert result_json['content'][0]['type'] == 'text'
assert (
result_json['content'][0]['text']
== 'Contents of http://localhost:8000/:\n---\n\n* <server.log>\n\n---'
)
runtime.close()
@pytest.mark.asyncio
async def test_filesystem_mcp_via_sse(
temp_dir, runtime_cls, run_as_openhands, sse_mcp_docker_server
):
sse_server_info = sse_mcp_docker_server
sse_url = sse_server_info['url']
runtime = None
try:
mcp_sse_server_config = MCPSSEServerConfig(url=sse_url)
override_mcp_config = MCPConfig(sse_servers=[mcp_sse_server_config])
runtime, config = _load_runtime(
temp_dir,
runtime_cls,
run_as_openhands,
override_mcp_config=override_mcp_config,
)
mcp_action = MCPAction(name='list_directory', arguments={'path': '.'})
obs = await runtime.call_tool_mcp(mcp_action)
logger.info(obs, extra={'msg_type': 'OBSERVATION'})
assert isinstance(obs, MCPObservation), (
'The observation should be a MCPObservation.'
)
assert '[FILE] .dockerenv' in obs.content
finally:
if runtime:
runtime.close()
# Container and log_streamer cleanup is handled by the sse_mcp_docker_server fixture
@pytest.mark.asyncio
async def test_both_stdio_and_sse_mcp(
temp_dir, runtime_cls, run_as_openhands, sse_mcp_docker_server
):
sse_server_info = sse_mcp_docker_server
sse_url = sse_server_info['url']
runtime = None
try:
mcp_sse_server_config = MCPSSEServerConfig(url=sse_url)
# Also add stdio server
mcp_stdio_server_config = MCPStdioServerConfig(
name='fetch', command='uvx', args=['mcp-server-fetch']
)
override_mcp_config = MCPConfig(
sse_servers=[mcp_sse_server_config], stdio_servers=[mcp_stdio_server_config]
)
runtime, config = _load_runtime(
temp_dir,
runtime_cls,
run_as_openhands,
override_mcp_config=override_mcp_config,
)
# ======= Test SSE server =======
mcp_action_sse = MCPAction(name='list_directory', arguments={'path': '.'})
obs_sse = await runtime.call_tool_mcp(mcp_action_sse)
logger.info(obs_sse, extra={'msg_type': 'OBSERVATION'})
assert isinstance(obs_sse, MCPObservation), (
'The observation should be a MCPObservation.'
)
assert '[FILE] .dockerenv' in obs_sse.content
# ======= Test stdio server =======
# Test browser server
action_cmd_http = CmdRunAction(
command='python3 -m http.server 8000 > server.log 2>&1 &'
)
logger.info(action_cmd_http, extra={'msg_type': 'ACTION'})
obs_http = runtime.run_action(action_cmd_http)
logger.info(obs_http, extra={'msg_type': 'OBSERVATION'})
assert isinstance(obs_http, CmdOutputObservation)
assert obs_http.exit_code == 0
assert '[1]' in obs_http.content
action_cmd_cat = CmdRunAction(command='sleep 3 && cat server.log')
logger.info(action_cmd_cat, extra={'msg_type': 'ACTION'})
obs_cat = runtime.run_action(action_cmd_cat)
logger.info(obs_cat, extra={'msg_type': 'OBSERVATION'})
assert obs_cat.exit_code == 0
mcp_action_fetch = MCPAction(
# NOTE: the tool name is `fetch_fetch` because the tool name is `fetch`
# And FastMCP Proxy will pre-pend the server name (in this case, `fetch`)
# to the tool name, so the full tool name becomes `fetch_fetch`
name='fetch',
arguments={'url': 'http://localhost:8000'},
)
obs_fetch = await runtime.call_tool_mcp(mcp_action_fetch)
logger.info(obs_fetch, extra={'msg_type': 'OBSERVATION'})
assert isinstance(obs_fetch, MCPObservation), (
'The observation should be a MCPObservation.'
)
result_json = json.loads(obs_fetch.content)
assert not result_json['isError']
assert len(result_json['content']) == 1
assert result_json['content'][0]['type'] == 'text'
assert (
result_json['content'][0]['text']
== 'Contents of http://localhost:8000/:\n---\n\n* <server.log>\n\n---'
)
finally:
if runtime:
runtime.close()
# SSE Docker container cleanup is handled by the sse_mcp_docker_server fixture
@pytest.mark.asyncio
async def test_microagent_and_one_stdio_mcp_in_config(
temp_dir, runtime_cls, run_as_openhands
):
runtime = None
try:
filesystem_config = MCPStdioServerConfig(
name='filesystem',
command='npx',
args=[
'@modelcontextprotocol/server-filesystem',
'/',
],
)
override_mcp_config = MCPConfig(stdio_servers=[filesystem_config])
runtime, config = _load_runtime(
temp_dir,
runtime_cls,
run_as_openhands,
override_mcp_config=override_mcp_config,
)
# NOTE: this simulate the case where the microagent adds a new stdio server to the runtime
# but that stdio server is not in the initial config
# Actual invocation of the microagent involves `add_mcp_tools_to_agent`
# which will call `get_mcp_config` with the stdio server from microagent's config
fetch_config = MCPStdioServerConfig(
name='fetch', command='uvx', args=['mcp-server-fetch']
)
updated_config = runtime.get_mcp_config([fetch_config])
logger.info(f'updated_config: {updated_config}')
# ======= Test the stdio server in the config =======
mcp_action_sse = MCPAction(
name='filesystem_list_directory', arguments={'path': '/'}
)
obs_sse = await runtime.call_tool_mcp(mcp_action_sse)
logger.info(obs_sse, extra={'msg_type': 'OBSERVATION'})
assert isinstance(obs_sse, MCPObservation), (
'The observation should be a MCPObservation.'
)
assert '[FILE] .dockerenv' in obs_sse.content
# ======= Test the stdio server added by the microagent =======
# Test browser server
action_cmd_http = CmdRunAction(
command='python3 -m http.server 8000 > server.log 2>&1 &'
)
logger.info(action_cmd_http, extra={'msg_type': 'ACTION'})
obs_http = runtime.run_action(action_cmd_http)
logger.info(obs_http, extra={'msg_type': 'OBSERVATION'})
assert isinstance(obs_http, CmdOutputObservation)
assert obs_http.exit_code == 0
assert '[1]' in obs_http.content
action_cmd_cat = CmdRunAction(command='sleep 3 && cat server.log')
logger.info(action_cmd_cat, extra={'msg_type': 'ACTION'})
obs_cat = runtime.run_action(action_cmd_cat)
logger.info(obs_cat, extra={'msg_type': 'OBSERVATION'})
assert obs_cat.exit_code == 0
mcp_action_fetch = MCPAction(
name='fetch_fetch', arguments={'url': 'http://localhost:8000'}
)
obs_fetch = await runtime.call_tool_mcp(mcp_action_fetch)
logger.info(obs_fetch, extra={'msg_type': 'OBSERVATION'})
assert isinstance(obs_fetch, MCPObservation), (
'The observation should be a MCPObservation.'
)
result_json = json.loads(obs_fetch.content)
assert not result_json['isError']
assert len(result_json['content']) == 1
assert result_json['content'][0]['type'] == 'text'
assert (
result_json['content'][0]['text']
== 'Contents of http://localhost:8000/:\n---\n\n* <server.log>\n\n---'
)
finally:
if runtime:
runtime.close()
# SSE Docker container cleanup is handled by the sse_mcp_docker_server fixture
|