import os import sys import tempfile import uuid from pathlib import Path from typing import Dict, Type, Union import pytest from conftest import MOCK_OPEN_AI_API_KEY, skip_docker, skip_openai # noqa: E402 from autogen.agentchat.conversable_agent import ConversableAgent from autogen.coding.base import CodeBlock, CodeExecutor from autogen.coding.factory import CodeExecutorFactory from autogen.oai.openai_utils import config_list_from_json try: from autogen.coding.jupyter import ( DockerJupyterServer, EmbeddedIPythonCodeExecutor, JupyterCodeExecutor, LocalJupyterServer, ) class DockerJupyterExecutor(JupyterCodeExecutor): def __init__(self, **kwargs): jupyter_server = DockerJupyterServer() super().__init__(jupyter_server=jupyter_server, **kwargs) class LocalJupyterCodeExecutor(JupyterCodeExecutor): def __init__(self, **kwargs): jupyter_server = LocalJupyterServer() super().__init__(jupyter_server=jupyter_server, **kwargs) # Skip on windows due to kernelgateway bug https://github.com/jupyter-server/kernel_gateway/issues/398 if sys.platform == "win32": classes_to_test = [EmbeddedIPythonCodeExecutor] else: classes_to_test = [EmbeddedIPythonCodeExecutor, LocalJupyterCodeExecutor] if not skip_docker: classes_to_test.append(DockerJupyterExecutor) skip = False skip_reason = "" except ImportError as e: skip = True skip_reason = "Dependencies for EmbeddedIPythonCodeExecutor or LocalJupyterCodeExecutor not installed. " + e.msg classes_to_test = [] @pytest.mark.parametrize("cls", classes_to_test) def test_is_code_executor(cls) -> None: assert isinstance(cls, CodeExecutor) @pytest.mark.skipif(skip, reason=skip_reason) def test_create_dict() -> None: config: Dict[str, Union[str, CodeExecutor]] = {"executor": "ipython-embedded"} executor = CodeExecutorFactory.create(config) assert isinstance(executor, EmbeddedIPythonCodeExecutor) @pytest.mark.skipif(skip, reason=skip_reason) @pytest.mark.parametrize("cls", classes_to_test) def test_create(cls) -> None: config = {"executor": cls()} executor = CodeExecutorFactory.create(config) assert executor is config["executor"] @pytest.mark.skipif(skip, reason=skip_reason) @pytest.mark.parametrize("cls", classes_to_test) def test_init(cls) -> None: executor = cls(timeout=10, kernel_name="python3", output_dir=".") assert executor._timeout == 10 and executor._kernel_name == "python3" and executor._output_dir == Path(".") # Try invalid output directory. with pytest.raises(ValueError, match="Output directory .* does not exist."): executor = cls(timeout=111, kernel_name="python3", output_dir="/invalid/directory") # Try invalid kernel name. with pytest.raises(ValueError, match="Kernel .* is not installed."): executor = cls(timeout=111, kernel_name="invalid_kernel_name", output_dir=".") @pytest.mark.skipif(skip, reason=skip_reason) @pytest.mark.parametrize("cls", classes_to_test) def test_execute_code_single_code_block(cls) -> None: executor = cls() code_blocks = [CodeBlock(code="import sys\nprint('hello world!')", language="python")] code_result = executor.execute_code_blocks(code_blocks) assert code_result.exit_code == 0 and "hello world!" in code_result.output @pytest.mark.skipif(skip, reason=skip_reason) @pytest.mark.parametrize("cls", classes_to_test) def test_execute_code_multiple_code_blocks(cls) -> None: executor = cls() code_blocks = [ CodeBlock(code="import sys\na = 123 + 123\n", language="python"), CodeBlock(code="print(a)", language="python"), ] code_result = executor.execute_code_blocks(code_blocks) assert code_result.exit_code == 0 and "246" in code_result.output msg = """ def test_function(a, b): return a + b """ code_blocks = [ CodeBlock(code=msg, language="python"), CodeBlock(code="test_function(431, 423)", language="python"), ] code_result = executor.execute_code_blocks(code_blocks) assert code_result.exit_code == 0 and "854" in code_result.output @pytest.mark.skipif(skip, reason=skip_reason) @pytest.mark.parametrize("cls", classes_to_test) def test_execute_code_bash_script(cls) -> None: executor = cls() # Test bash script. code_blocks = [CodeBlock(code='!echo "hello world!"', language="bash")] code_result = executor.execute_code_blocks(code_blocks) assert code_result.exit_code == 0 and "hello world!" in code_result.output @pytest.mark.skipif(skip, reason=skip_reason) @pytest.mark.parametrize("cls", classes_to_test) def test_timeout(cls) -> None: executor = cls(timeout=1) code_blocks = [CodeBlock(code="import time; time.sleep(10); print('hello world!')", language="python")] code_result = executor.execute_code_blocks(code_blocks) assert code_result.exit_code and "Timeout" in code_result.output @pytest.mark.skipif(skip, reason=skip_reason) @pytest.mark.parametrize("cls", classes_to_test) def test_silent_pip_install(cls) -> None: executor = cls(timeout=600) code_blocks = [CodeBlock(code="!pip install matplotlib numpy", language="python")] code_result = executor.execute_code_blocks(code_blocks) assert code_result.exit_code == 0 and code_result.output.strip() == "" none_existing_package = uuid.uuid4().hex code_blocks = [CodeBlock(code=f"!pip install matplotlib_{none_existing_package}", language="python")] code_result = executor.execute_code_blocks(code_blocks) assert code_result.exit_code == 0 and "ERROR: " in code_result.output @pytest.mark.skipif(skip, reason=skip_reason) @pytest.mark.parametrize("cls", classes_to_test) def test_restart(cls) -> None: executor = cls() code_blocks = [CodeBlock(code="x = 123", language="python")] code_result = executor.execute_code_blocks(code_blocks) assert code_result.exit_code == 0 and code_result.output.strip() == "" executor.restart() code_blocks = [CodeBlock(code="print(x)", language="python")] code_result = executor.execute_code_blocks(code_blocks) assert code_result.exit_code and "NameError" in code_result.output @pytest.mark.skipif(skip, reason=skip_reason) @pytest.mark.parametrize("cls", classes_to_test) def test_save_image(cls) -> None: with tempfile.TemporaryDirectory() as temp_dir: executor = cls(output_dir=temp_dir) # Install matplotlib. code_blocks = [CodeBlock(code="!pip install matplotlib", language="python")] code_result = executor.execute_code_blocks(code_blocks) assert code_result.exit_code == 0 and code_result.output.strip() == "" # Test saving image. code_blocks = [ CodeBlock(code="import matplotlib.pyplot as plt\nplt.plot([1, 2, 3, 4])\nplt.show()", language="python") ] code_result = executor.execute_code_blocks(code_blocks) assert code_result.exit_code == 0 assert os.path.exists(code_result.output_files[0]) assert f"Image data saved to {code_result.output_files[0]}" in code_result.output @pytest.mark.skipif(skip, reason=skip_reason) @pytest.mark.parametrize("cls", classes_to_test) def test_timeout_preserves_kernel_state(cls: Type[CodeExecutor]) -> None: executor = cls(timeout=1) code_blocks = [CodeBlock(code="x = 123", language="python")] code_result = executor.execute_code_blocks(code_blocks) assert code_result.exit_code == 0 and code_result.output.strip() == "" code_blocks = [CodeBlock(code="import time; time.sleep(10)", language="python")] code_result = executor.execute_code_blocks(code_blocks) assert code_result.exit_code != 0 and "Timeout" in code_result.output code_blocks = [CodeBlock(code="print(x)", language="python")] code_result = executor.execute_code_blocks(code_blocks) assert code_result.exit_code == 0 and "123" in code_result.output @pytest.mark.skipif(skip, reason=skip_reason) @pytest.mark.parametrize("cls", classes_to_test) def test_save_html(cls) -> None: with tempfile.TemporaryDirectory() as temp_dir: executor = cls(output_dir=temp_dir) # Test saving html. code_blocks = [ CodeBlock(code="from IPython.display import HTML\nHTML('