🐫 CAMEL: The first and the best multi-agent framework. Finding the Scaling Law of Agents. https://www.camel-ai.org
Python agentai-societiesartificial-intelligencecommunicative-aicooperative-aideep-learninglarge-language-modelsmulti-agent-systemsnatural-language-processing
refactor: extract _docker_exec helper in TerminalToolkit to reduce Docker API duplication (#4102)
Willow Lopez3b89409c2f2f
diff --git a/camel/toolkits/terminal_toolkit/terminal_toolkit.py b/camel/toolkits/terminal_toolkit/terminal_toolkit.pyindex c455c75b3..486fcc3d2 100644--- a/camel/toolkits/terminal_toolkit/terminal_toolkit.py+++ b/camel/toolkits/terminal_toolkit/terminal_toolkit.py@@ -236,10 +236,7 @@ class TerminalToolkit(BaseToolkit):try:quoted_dir = shlex.quote(self.docker_workdir)mkdir_cmd = f'sh -lc "mkdir -p -- {quoted_dir}"'- _init = self.docker_api_client.exec_create(- self.container.id, mkdir_cmd- )- self.docker_api_client.exec_start(_init['Id'])+ self._docker_exec(mkdir_cmd, check_exit_code=False)except Exception as e:logger.warning(f"[Docker] Failed to ensure workdir "@@ -314,32 +311,23 @@ class TerminalToolkit(BaseToolkit):install_cmd = f'sh -lc "pip install {pkg_str}"'try:- exec_id = self.docker_api_client.exec_create(- self.container.id, install_cmd- )["Id"]- log = self.docker_api_client.exec_start(exec_id)- logger.info(f"Package installation output:\n{log}")-- # Check exit code to ensure installation succeeded- exec_info = self.docker_api_client.exec_inspect(exec_id)- if exec_info['ExitCode'] != 0:- error_msg = (- f"Failed to install dependencies in Docker: "- f"{log.decode('utf-8', errors='ignore')}"- )- logger.error(error_msg)- raise RuntimeError(error_msg)-+ exit_code, output = self._docker_exec(+ install_cmd, check_exit_code=True+ )+ logger.info(+ "Package installation output:\n%s",+ output.decode("utf-8", errors="ignore"),+ )logger.info("Successfully installed all dependencies in Docker.")- except Exception as e:- if not isinstance(e, RuntimeError):- logger.error(f"Docker dependency installation error: {e}")- raise RuntimeError(- f"Docker dependency installation error: {e}"- ) from e+ except RuntimeError:raise+ except Exception as e:+ logger.error(f"Docker dependency installation error: {e}")+ raise RuntimeError(+ f"Docker dependency installation error: {e}"+ ) from eelse:pip_cmd = [@@ -486,6 +474,62 @@ class TerminalToolkit(BaseToolkit):with open(log_file, "a", encoding="utf-8") as f:f.write(_to_plain(content) + "\n")+ def _docker_exec(+ self,+ command: str,+ *,+ check_exit_code: bool = True,+ ) -> tuple[Optional[int], bytes]:+ r"""Execute a command in the Docker container and return the result.++ Consolidates the repeated ``exec_create → exec_start → exec_inspect``+ pattern into a single helper, reducing code duplication and improving+ error handling consistency.++ Args:+ command: The shell command to execute inside the container.+ check_exit_code: If True, raises RuntimeError on non-zero exit.++ Returns:+ A tuple of (exit_code, output_bytes). The exit code is ``None``+ when ``check_exit_code`` is False.++ Raises:+ RuntimeError: If the Docker API call fails or the command exits+ with a non-zero code and ``check_exit_code`` is True.+ """+ if not self.use_docker_backend:+ raise RuntimeError(+ "_docker_exec called but Docker backend is not enabled."+ )+ try:+ exec_id = self.docker_api_client.exec_create(+ self.container.id, cmd=command+ )["Id"]+ output = self.docker_api_client.exec_start(exec_id)+ exit_code = None+ if check_exit_code:+ exec_info = self.docker_api_client.exec_inspect(exec_id)+ exit_code = exec_info["ExitCode"]+ if check_exit_code and exit_code != 0:+ error_text = (+ output.decode("utf-8", errors="ignore")+ if isinstance(output, bytes)+ else str(output)+ )+ logger.error(+ "Docker command failed with exit code %s. Output:\n%s",+ exit_code,+ error_text,+ )+ raise RuntimeError(+ f"Docker command exited with code {exit_code}: "+ f"{error_text}"+ )+ return exit_code, output+ except (APIError, NotFound) as e:+ raise RuntimeError(f"Docker API error: {e}") from e+def _sanitize_command(self, command: str) -> tuple[bool, str]:r"""A comprehensive command sanitizer for both local andDocker backends."""@@ -1217,10 +1261,7 @@ class TerminalToolkit(BaseToolkit):if pid and exec_info.get('Running', False):# Kill the process inside the containerkill_cmd = f'kill -9 {pid}'- kill_exec = self.docker_api_client.exec_create(- self.container.id, kill_cmd- )- self.docker_api_client.exec_start(kill_exec['Id'])+ self._docker_exec(kill_cmd, check_exit_code=False)except Exception as kill_err:logger.warning(f"[SESSION {id}] Failed to kill Docker exec "@@ -1356,10 +1397,7 @@ class TerminalToolkit(BaseToolkit):if parent_dir:quoted_dir = shlex.quote(parent_dir)mkdir_cmd = f'sh -lc "mkdir -p {quoted_dir}"'- mkdir_exec = self.docker_api_client.exec_create(- self.container.id, mkdir_cmd- )- self.docker_api_client.exec_start(mkdir_exec['Id'])+ self._docker_exec(mkdir_cmd, check_exit_code=False)# Write content to a temporary file on the host inside log_dirtemp_file_name = f"temp_{uuid.uuid4().hex}.txt"diff --git a/test/toolkits/test_terminal_toolkit.py b/test/toolkits/test_terminal_toolkit.pyindex 2e2824586..4dca353d5 100644--- a/test/toolkits/test_terminal_toolkit.py+++ b/test/toolkits/test_terminal_toolkit.py@@ -14,11 +14,16 @@import platformimport tempfilefrom pathlib import Path+from types import SimpleNamespace+from unittest.mock import Mockimport pytestfrom camel.toolkits import TerminalToolkitfrom camel.toolkits.terminal_toolkit import DANGEROUS_COMMANDS+from camel.toolkits.terminal_toolkit import (+ terminal_toolkit as terminal_toolkit_module,+)from camel.toolkits.terminal_toolkit.utils import sanitize_command@@ -44,6 +49,54 @@ def test_file(temp_dir):return file_path+def docker_toolkit():+ toolkit = object.__new__(TerminalToolkit)+ toolkit.use_docker_backend = True+ toolkit.container = SimpleNamespace(id="container-id")+ toolkit.docker_api_client = Mock()+ return toolkit+++def test_docker_exec_skips_inspect_when_exit_code_is_not_checked(+ docker_toolkit,+):+ docker_toolkit.docker_api_client.exec_create.return_value = {+ "Id": "exec-id"+ }+ docker_toolkit.docker_api_client.exec_start.return_value = b"output"++ exit_code, output = docker_toolkit._docker_exec(+ "mkdir -p /workspace", check_exit_code=False+ )++ assert exit_code is None+ assert output == b"output"+ docker_toolkit.docker_api_client.exec_inspect.assert_not_called()+++def test_docker_exec_api_error_does_not_expose_command(+ docker_toolkit, monkeypatch+):+ class FakeAPIError(Exception):+ pass++ monkeypatch.setattr(terminal_toolkit_module, "APIError", FakeAPIError)+ monkeypatch.setattr(terminal_toolkit_module, "NotFound", FakeAPIError)+ docker_toolkit.docker_api_client.exec_create.side_effect = FakeAPIError(+ "daemon unavailable"+ )+ secret = "ghp_SUPERSECRET"++ with pytest.raises(RuntimeError) as exc_info:+ docker_toolkit._docker_exec(+ f"pip install https://user:{secret}@example.com/private.git"+ )++ assert secret not in str(exc_info.value)+ assert "daemon unavailable" in str(exc_info.value)++def test_init():toolkit = TerminalToolkit()try: