mirror of
https://github.com/OpenHands/OpenHands.git
synced 2025-12-26 05:48:36 +08:00
235 lines
8.5 KiB
Python
235 lines
8.5 KiB
Python
"""Test the EventStreamRuntime, which connects to the ActionExecutor running in the sandbox."""
|
|
|
|
import pytest
|
|
from conftest import (
|
|
TEST_IN_CI,
|
|
_close_test_runtime,
|
|
_get_sandbox_folder,
|
|
_load_runtime,
|
|
)
|
|
|
|
from openhands.core.logger import openhands_logger as logger
|
|
from openhands.events.action import (
|
|
CmdRunAction,
|
|
FileReadAction,
|
|
FileWriteAction,
|
|
IPythonRunCellAction,
|
|
)
|
|
from openhands.events.observation import (
|
|
CmdOutputObservation,
|
|
ErrorObservation,
|
|
FileReadObservation,
|
|
FileWriteObservation,
|
|
IPythonRunCellObservation,
|
|
)
|
|
|
|
# ============================================================================================================================
|
|
# ipython-specific tests
|
|
# ============================================================================================================================
|
|
|
|
|
|
def test_simple_cmd_ipython_and_fileop(temp_dir, box_class, run_as_openhands):
|
|
runtime = _load_runtime(temp_dir, box_class, run_as_openhands)
|
|
|
|
sandbox_dir = _get_sandbox_folder(runtime)
|
|
|
|
# Test run command
|
|
action_cmd = CmdRunAction(command='ls -l')
|
|
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 'total 0' in obs.content
|
|
|
|
# Test run ipython
|
|
test_code = "print('Hello, `World`!\\n')"
|
|
action_ipython = IPythonRunCellAction(code=test_code)
|
|
logger.info(action_ipython, extra={'msg_type': 'ACTION'})
|
|
obs = runtime.run_action(action_ipython)
|
|
assert isinstance(obs, IPythonRunCellObservation)
|
|
|
|
logger.info(obs, extra={'msg_type': 'OBSERVATION'})
|
|
assert obs.content.strip() == (
|
|
'Hello, `World`!\n'
|
|
f'[Jupyter current working directory: {sandbox_dir}]\n'
|
|
'[Jupyter Python interpreter: /openhands/poetry/openhands-ai-5O4_aCHf-py3.12/bin/python]'
|
|
)
|
|
|
|
# Test read file (file should not exist)
|
|
action_read = FileReadAction(path='hello.sh')
|
|
logger.info(action_read, extra={'msg_type': 'ACTION'})
|
|
obs = runtime.run_action(action_read)
|
|
logger.info(obs, extra={'msg_type': 'OBSERVATION'})
|
|
assert isinstance(obs, ErrorObservation)
|
|
assert 'File not found' in obs.content
|
|
|
|
# Test write file
|
|
action_write = FileWriteAction(content='echo "Hello, World!"', path='hello.sh')
|
|
logger.info(action_write, extra={'msg_type': 'ACTION'})
|
|
obs = runtime.run_action(action_write)
|
|
assert isinstance(obs, FileWriteObservation)
|
|
logger.info(obs, extra={'msg_type': 'OBSERVATION'})
|
|
|
|
assert obs.content == ''
|
|
# event stream runtime will always use absolute path
|
|
assert obs.path == f'{sandbox_dir}/hello.sh'
|
|
|
|
# Test read file (file should exist)
|
|
action_read = FileReadAction(path='hello.sh')
|
|
logger.info(action_read, extra={'msg_type': 'ACTION'})
|
|
obs = runtime.run_action(action_read)
|
|
assert isinstance(
|
|
obs, FileReadObservation
|
|
), 'The observation should be a FileReadObservation.'
|
|
logger.info(obs, extra={'msg_type': 'OBSERVATION'})
|
|
|
|
assert obs.content == 'echo "Hello, World!"\n'
|
|
assert obs.path == f'{sandbox_dir}/hello.sh'
|
|
|
|
# clean up
|
|
action = CmdRunAction(command='rm -rf hello.sh')
|
|
logger.info(action, extra={'msg_type': 'ACTION'})
|
|
obs = runtime.run_action(action)
|
|
logger.info(obs, extra={'msg_type': 'OBSERVATION'})
|
|
assert obs.exit_code == 0
|
|
|
|
_close_test_runtime(runtime)
|
|
|
|
|
|
@pytest.mark.skipif(
|
|
TEST_IN_CI != 'True',
|
|
reason='This test is not working in WSL (file ownership)',
|
|
)
|
|
def test_ipython_multi_user(temp_dir, box_class, run_as_openhands):
|
|
runtime = _load_runtime(temp_dir, box_class, run_as_openhands)
|
|
|
|
# Test run ipython
|
|
# get username
|
|
test_code = "import os; print(os.environ['USER'])"
|
|
action_ipython = IPythonRunCellAction(code=test_code)
|
|
logger.info(action_ipython, extra={'msg_type': 'ACTION'})
|
|
obs = runtime.run_action(action_ipython)
|
|
assert isinstance(obs, IPythonRunCellObservation)
|
|
|
|
logger.info(obs, extra={'msg_type': 'OBSERVATION'})
|
|
if run_as_openhands:
|
|
assert 'openhands' in obs.content
|
|
else:
|
|
assert 'root' in obs.content
|
|
|
|
# print the current working directory
|
|
test_code = 'import os; print(os.getcwd())'
|
|
action_ipython = IPythonRunCellAction(code=test_code)
|
|
logger.info(action_ipython, extra={'msg_type': 'ACTION'})
|
|
obs = runtime.run_action(action_ipython)
|
|
assert isinstance(obs, IPythonRunCellObservation)
|
|
logger.info(obs, extra={'msg_type': 'OBSERVATION'})
|
|
assert (
|
|
obs.content.strip()
|
|
== (
|
|
'/workspace\n'
|
|
'[Jupyter current working directory: /workspace]\n'
|
|
'[Jupyter Python interpreter: /openhands/poetry/openhands-ai-5O4_aCHf-py3.12/bin/python]'
|
|
).strip()
|
|
)
|
|
|
|
# write a file
|
|
test_code = "with open('test.txt', 'w') as f: f.write('Hello, world!')"
|
|
action_ipython = IPythonRunCellAction(code=test_code)
|
|
logger.info(action_ipython, extra={'msg_type': 'ACTION'})
|
|
obs = runtime.run_action(action_ipython)
|
|
logger.info(obs, extra={'msg_type': 'OBSERVATION'})
|
|
assert isinstance(obs, IPythonRunCellObservation)
|
|
assert (
|
|
obs.content.strip()
|
|
== (
|
|
'[Code executed successfully with no output]\n'
|
|
'[Jupyter current working directory: /workspace]\n'
|
|
'[Jupyter Python interpreter: /openhands/poetry/openhands-ai-5O4_aCHf-py3.12/bin/python]'
|
|
).strip()
|
|
)
|
|
|
|
# check file owner via bash
|
|
action = CmdRunAction(command='ls -alh test.txt')
|
|
logger.info(action, extra={'msg_type': 'ACTION'})
|
|
obs = runtime.run_action(action)
|
|
logger.info(obs, extra={'msg_type': 'OBSERVATION'})
|
|
assert obs.exit_code == 0
|
|
if run_as_openhands:
|
|
# -rw-r--r-- 1 openhands root 13 Jul 28 03:53 test.txt
|
|
assert 'openhands' in obs.content.split('\r\n')[0]
|
|
else:
|
|
# -rw-r--r-- 1 root root 13 Jul 28 03:53 test.txt
|
|
assert 'root' in obs.content.split('\r\n')[0]
|
|
|
|
# clean up
|
|
action = CmdRunAction(command='rm -rf test')
|
|
logger.info(action, extra={'msg_type': 'ACTION'})
|
|
obs = runtime.run_action(action)
|
|
logger.info(obs, extra={'msg_type': 'OBSERVATION'})
|
|
assert obs.exit_code == 0
|
|
|
|
_close_test_runtime(runtime)
|
|
|
|
|
|
def test_ipython_simple(temp_dir, box_class):
|
|
runtime = _load_runtime(temp_dir, box_class)
|
|
sandbox_dir = _get_sandbox_folder(runtime)
|
|
|
|
# Test run ipython
|
|
# get username
|
|
test_code = 'print(1)'
|
|
action_ipython = IPythonRunCellAction(code=test_code)
|
|
logger.info(action_ipython, extra={'msg_type': 'ACTION'})
|
|
obs = runtime.run_action(action_ipython)
|
|
assert isinstance(obs, IPythonRunCellObservation)
|
|
logger.info(obs, extra={'msg_type': 'OBSERVATION'})
|
|
assert (
|
|
obs.content.strip()
|
|
== (
|
|
'1\n'
|
|
f'[Jupyter current working directory: {sandbox_dir}]\n'
|
|
'[Jupyter Python interpreter: /openhands/poetry/openhands-ai-5O4_aCHf-py3.12/bin/python]'
|
|
).strip()
|
|
)
|
|
|
|
_close_test_runtime(runtime)
|
|
|
|
|
|
def test_ipython_package_install(temp_dir, box_class, run_as_openhands):
|
|
"""Make sure that cd in bash also update the current working directory in ipython."""
|
|
runtime = _load_runtime(temp_dir, box_class, run_as_openhands)
|
|
sandbox_dir = _get_sandbox_folder(runtime)
|
|
|
|
# It should error out since pymsgbox is not installed
|
|
action = IPythonRunCellAction(code='import pymsgbox')
|
|
logger.info(action, extra={'msg_type': 'ACTION'})
|
|
obs = runtime.run_action(action)
|
|
logger.info(obs, extra={'msg_type': 'OBSERVATION'})
|
|
assert "ModuleNotFoundError: No module named 'pymsgbox'" in obs.content
|
|
|
|
# Install pymsgbox in Jupyter
|
|
action = IPythonRunCellAction(code='%pip install pymsgbox==1.0.9')
|
|
logger.info(action, extra={'msg_type': 'ACTION'})
|
|
obs = runtime.run_action(action)
|
|
logger.info(obs, extra={'msg_type': 'OBSERVATION'})
|
|
assert (
|
|
'Successfully installed pymsgbox-1.0.9' in obs.content
|
|
or '[Package installed successfully]' in obs.content
|
|
)
|
|
|
|
action = IPythonRunCellAction(code='import pymsgbox')
|
|
logger.info(action, extra={'msg_type': 'ACTION'})
|
|
obs = runtime.run_action(action)
|
|
logger.info(obs, extra={'msg_type': 'OBSERVATION'})
|
|
# import should not error out
|
|
assert obs.content.strip() == (
|
|
'[Code executed successfully with no output]\n'
|
|
f'[Jupyter current working directory: {sandbox_dir}]\n'
|
|
'[Jupyter Python interpreter: /openhands/poetry/openhands-ai-5O4_aCHf-py3.12/bin/python]'
|
|
)
|
|
|
|
_close_test_runtime(runtime)
|