Skip to content

armgit / camel

Public Imported from GitHub
0

🐫 CAMEL: The first and the best multi-agent framework. Finding the Scaling Law of Agents. https://www.camel-ai.org

10.5 KB
Raw Blame
# ========= Copyright 2023-2026 @ CAMEL-AI.org. All Rights Reserved. =========
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# ========= Copyright 2023-2026 @ CAMEL-AI.org. All Rights Reserved. =========

import socket

import pytest

from camel.interpreters import (
    InternalPythonInterpreter,
    InterpreterError,
    SubprocessInterpreter,
)
from camel.toolkits.code_execution import CodeExecutionToolkit
from camel.utils import is_docker_running


def is_microsandbox_available(
    server_url: str = "http://192.168.122.56:5555",
) -> bool:
    """Check if microsandbox server is available with a quick timeout."""
    try:
        from urllib.parse import urlparse

        parsed_url = urlparse(server_url)
        sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
        sock.settimeout(0.5)  # Quick timeout
        result = sock.connect_ex((parsed_url.hostname, parsed_url.port))
        sock.close()
        return result == 0
    except Exception:
        return False


@pytest.fixture
def code_execution_toolkit():
    return CodeExecutionToolkit(require_confirm=False)


@pytest.fixture
def jupyter_code_execution_toolkit():
    # Try to check if jupyter kernel is available
    try:
        from jupyter_client import kernelspec

        # This will raise an exception if the kernel spec is not found
        spec = kernelspec.get_kernel_spec('python3')
        # Check if the python executable exists
        import os

        if not os.path.exists(spec.argv[0]):
            pytest.skip(f"Jupyter kernel Python not found: {spec.argv[0]}")
    except Exception as e:
        pytest.skip(f"Jupyter kernel not available: {e}")

    return CodeExecutionToolkit(
        sandbox="jupyter",
        verbose=True,
        require_confirm=False,
    )


@pytest.fixture
def docker_code_execution_toolkit():
    if not is_docker_running():
        pytest.skip("Docker is not running")
    return CodeExecutionToolkit(
        sandbox="docker",
        verbose=True,
        require_confirm=False,
    )


@pytest.fixture
def subprocess_code_execution_toolkit():
    return CodeExecutionToolkit(
        sandbox="subprocess",
        verbose=True,
        require_confirm=False,
    )


@pytest.fixture
def microsandbox_code_execution_toolkit():
    """Create CodeExecutionToolkit with microsandbox."""
    microsandbox_config = {
        "server_url": "http://192.168.122.56:5555",
        "namespace": "test-code-execution",
        "timeout": 30,
    }
    # Check if microsandbox server is running
    if not is_microsandbox_available(microsandbox_config["server_url"]):
        pytest.skip("Microsandbox server is not running")
    return CodeExecutionToolkit(
        sandbox="microsandbox",
        verbose=True,
        require_confirm=False,
        microsandbox_config=microsandbox_config,
    )


def test_execute_code(code_execution_toolkit):
    code = "x = 'a'\ny = 'b'\nx + y"
    result = code_execution_toolkit.execute_code(code)

    # ruff: noqa: E501
    expected_result = f"Executed the code below:\n```python\n{code}\n```\n> Executed Results:\n'ab'\n"
    assert expected_result == result


def test_jupyter_execute_code(jupyter_code_execution_toolkit):
    code = """
def add(a, b):
    return a + b

result = add(10, 20)
print(result)
"""
    result = jupyter_code_execution_toolkit.execute_code(code)
    assert "30" in result


def test_jupyter_execute_code_error(jupyter_code_execution_toolkit):
    code = """
def divide(a, b):
    return a / b

result = divide(10, 0)
print(result)
"""
    result = jupyter_code_execution_toolkit.execute_code(code)
    assert "ZeroDivisionError: division by zero" in result


def test_docker_execute_code(docker_code_execution_toolkit):
    code = """
def multiply(a, b):
    return a * b

result = multiply(6, 7)
print(result)
"""
    result = docker_code_execution_toolkit.execute_code(code)
    assert "42" in result


def test_docker_execute_code_error(docker_code_execution_toolkit):
    code = """
import nonexistent_module
"""
    result = docker_code_execution_toolkit.execute_code(code)
    assert (
        "ModuleNotFoundError: No module named 'nonexistent_module'" in result
    )


def test_subprocess_execute_code(subprocess_code_execution_toolkit):
    code = """
def factorial(n):
    if n <= 1:
        return 1
    return n * factorial(n - 1)

result = factorial(5)
print(result)
"""
    result = subprocess_code_execution_toolkit.execute_code(code)
    assert "120" in result


def test_subprocess_execute_code_error(subprocess_code_execution_toolkit):
    code = """
x = [1, 2, 3]
print(x[10])
"""
    result = subprocess_code_execution_toolkit.execute_code(code)
    assert "IndexError: list index out of range" in result


def test_subprocess_requires_confirmation_by_default():
    toolkit = CodeExecutionToolkit()

    assert isinstance(toolkit.interpreter, SubprocessInterpreter)
    assert toolkit.interpreter.require_confirm is True


def test_internal_python_requires_confirmation_by_default():
    toolkit = CodeExecutionToolkit(sandbox="internal_python")

    assert isinstance(toolkit.interpreter, InternalPythonInterpreter)
    assert toolkit.interpreter.require_confirm is True


def test_subprocess_default_confirmation_blocks_code(monkeypatch):
    toolkit = CodeExecutionToolkit()
    monkeypatch.setattr('builtins.input', lambda _: 'n')

    with pytest.raises(InterpreterError) as exc_info:
        toolkit.execute_code("print('blocked')")

    assert "Execution halted" in str(exc_info.value)


def test_subprocess_default_confirmation_blocks_command(monkeypatch):
    toolkit = CodeExecutionToolkit()
    monkeypatch.setattr('builtins.input', lambda _: 'n')

    with pytest.raises(InterpreterError) as exc_info:
        toolkit.execute_command("echo blocked")

    assert "Execution halted" in str(exc_info.value)


def test_internal_python_default_confirmation_blocks_command(monkeypatch):
    toolkit = CodeExecutionToolkit(sandbox="internal_python")
    monkeypatch.setattr('builtins.input', lambda _: 'n')

    with pytest.raises(InterpreterError) as exc_info:
        toolkit.execute_command("echo blocked")

    assert "Execution halted" in str(exc_info.value)


def test_subprocess_default_confirmation_blocks_empty_code(monkeypatch):
    toolkit = CodeExecutionToolkit()
    monkeypatch.setattr('builtins.input', lambda _: '')

    with pytest.raises(InterpreterError) as exc_info:
        toolkit.execute_code("print('blocked')")

    assert "Execution halted" in str(exc_info.value)


def test_subprocess_default_confirmation_blocks_empty_command(monkeypatch):
    toolkit = CodeExecutionToolkit()
    monkeypatch.setattr('builtins.input', lambda _: '')

    with pytest.raises(InterpreterError) as exc_info:
        toolkit.execute_command("echo blocked")

    assert "Execution halted" in str(exc_info.value)


def test_subprocess_confirmation_can_be_disabled():
    toolkit = CodeExecutionToolkit(sandbox="subprocess", require_confirm=False)

    assert isinstance(toolkit.interpreter, SubprocessInterpreter)
    assert toolkit.interpreter.require_confirm is False


def test_internal_python_confirmation_can_be_disabled():
    toolkit = CodeExecutionToolkit(
        sandbox="internal_python", require_confirm=False
    )

    assert isinstance(toolkit.interpreter, InternalPythonInterpreter)
    assert toolkit.interpreter.require_confirm is False


def test_invalid_sandbox_type():
    with pytest.raises(RuntimeError) as exc_info:
        CodeExecutionToolkit(sandbox="invalid")
    assert "not supported" in str(exc_info.value)


def test_get_tools(code_execution_toolkit):
    tools = code_execution_toolkit.get_tools()
    assert len(tools) == 2
    assert tools[0].get_function_name() == "execute_code"
    assert tools[1].get_function_name() == "execute_command"


def test_verbose_output(code_execution_toolkit):
    """Test that verbose output works correctly."""
    toolkit = CodeExecutionToolkit(sandbox="internal_python", verbose=True)
    code = "print('test')"
    result = toolkit.execute_code(code)
    assert "test" in result


@pytest.mark.skipif(
    not is_microsandbox_available("http://192.168.122.56:5555"),
    reason="Microsandbox server is not running",
)
def test_microsandbox_execute_code(microsandbox_code_execution_toolkit):
    """Test executing Python code with microsandbox."""
    code = "x = 10 + 5\nprint(f'Result: {x}')"
    result = microsandbox_code_execution_toolkit.execute_code(code)

    assert "Result: 15" in result
    assert "Executed the code below:" in result


@pytest.mark.skipif(
    not is_microsandbox_available("http://192.168.122.56:5555"),
    reason="Microsandbox server is not running",
)
def test_microsandbox_execute_javascript(microsandbox_code_execution_toolkit):
    """Test executing JavaScript code with microsandbox."""
    code = "console.log('Hello from JavaScript');"
    result = microsandbox_code_execution_toolkit.execute_code(
        code, code_type="javascript"
    )

    assert "Hello from JavaScript" in result
    assert "Executed the code below:" in result


@pytest.mark.skipif(
    not is_microsandbox_available("http://192.168.122.56:5555"),
    reason="Microsandbox server is not running",
)
def test_microsandbox_execute_command(microsandbox_code_execution_toolkit):
    """Test executing shell commands with microsandbox."""
    result = microsandbox_code_execution_toolkit.execute_command("echo test")

    # Should contain either output or success message
    assert "test" in result or "executed successfully" in result.lower()
    assert "Executed the command below:" in result


@pytest.mark.skipif(
    not is_microsandbox_available("http://192.168.122.56:5555"),
    reason="Microsandbox server is not running",
)
def test_microsandbox_error_handling(microsandbox_code_execution_toolkit):
    """Test error handling with microsandbox."""
    code = "x = 1 / 0"  # Division by zero - more reliable error
    result = microsandbox_code_execution_toolkit.execute_code(code)

    # Should contain error information or successfully execute (just verify it doesn't crash)
    assert result is not None
    assert len(result) > 0
    assert "Executed the code below:" in result