The agent engineering platform.
Python agentsaiai-agentsanthropicchatgptdeepagentsenterpriseframeworkgeminigenerative-ailangchainlanggraphllmmultiagentopen-sourceopenaipydanticpythonragtypescript
chore(langchain): fix types in `test_shell_tool` (#34502)
Christophe Bornete73b027686b7
diff --git a/libs/langchain_v1/tests/unit_tests/agents/middleware/implementations/test_shell_tool.py b/libs/langchain_v1/tests/unit_tests/agents/middleware/implementations/test_shell_tool.pyindex b2d86677cf..776b01a6e7 100644--- a/libs/langchain_v1/tests/unit_tests/agents/middleware/implementations/test_shell_tool.py+++ b/libs/langchain_v1/tests/unit_tests/agents/middleware/implementations/test_shell_tool.py@@ -1,41 +1,40 @@from __future__ import annotations-import asyncioimport gcimport tempfileimport timefrom pathlib import Path-from typing import TYPE_CHECKING+from typing import castimport pytestfrom langchain_core.messages import ToolMessagefrom langchain_core.tools.base import ToolException+from langgraph.runtime import Runtimefrom langchain.agents.middleware.shell_tool import (HostExecutionPolicy,RedactionRule,ShellToolMiddleware,+ ShellToolState,_SessionResources,_ShellToolInput,)-if TYPE_CHECKING:- from langchain.agents.middleware.types import AgentState--def _empty_state() -> AgentState:- return {"messages": []} # type: ignore[return-value]+def _empty_state() -> ShellToolState:+ return {"messages": []}def test_executes_command_and_persists_state(tmp_path: Path) -> None:workspace = tmp_path / "workspace"middleware = ShellToolMiddleware(workspace_root=workspace)+ runtime = Runtime()+ state = _empty_state()try:- state: AgentState = _empty_state()- updates = middleware.before_agent(state, None)+ updates = middleware.before_agent(state, runtime)if updates:- state.update(updates)- resources = middleware._get_or_create_resources(state) # type: ignore[attr-defined]+ state.update(cast("ShellToolState", updates))+ resources = middleware._get_or_create_resources(state)middleware._run_shell_tool(resources, {"command": "cd /"}, tool_call_id=None)result = middleware._run_shell_tool(resources, {"command": "pwd"}, tool_call_id=None)@@ -46,19 +45,18 @@ def test_executes_command_and_persists_state(tmp_path: Path) -> None:)assert "ready" in echo_resultfinally:- updates = middleware.after_agent(state, None)- if updates:- state.update(updates)+ middleware.after_agent(state, runtime)def test_restart_resets_session_environment(tmp_path: Path) -> None:middleware = ShellToolMiddleware(workspace_root=tmp_path / "workspace")+ runtime = Runtime()+ state = _empty_state()try:- state: AgentState = _empty_state()- updates = middleware.before_agent(state, None)+ updates = middleware.before_agent(state, runtime)if updates:- state.update(updates)- resources = middleware._get_or_create_resources(state) # type: ignore[attr-defined]+ state.update(cast("ShellToolState", updates))+ resources = middleware._get_or_create_resources(state)middleware._run_shell_tool(resources, {"command": "export FOO=bar"}, tool_call_id=None)restart_message = middleware._run_shell_tool(@@ -71,46 +69,42 @@ def test_restart_resets_session_environment(tmp_path: Path) -> None:)assert "unset" in resultfinally:- updates = middleware.after_agent(state, None)- if updates:- state.update(updates)+ middleware.after_agent(state, runtime)def test_truncation_indicator_present(tmp_path: Path) -> None:policy = HostExecutionPolicy(max_output_lines=5, command_timeout=5.0)middleware = ShellToolMiddleware(workspace_root=tmp_path / "workspace", execution_policy=policy)+ runtime = Runtime()+ state = _empty_state()try:- state: AgentState = _empty_state()- updates = middleware.before_agent(state, None)+ updates = middleware.before_agent(state, runtime)if updates:- state.update(updates)- resources = middleware._get_or_create_resources(state) # type: ignore[attr-defined]+ state.update(cast("ShellToolState", updates))+ resources = middleware._get_or_create_resources(state)result = middleware._run_shell_tool(resources, {"command": "seq 1 20"}, tool_call_id=None)assert "Output truncated" in resultfinally:- updates = middleware.after_agent(state, None)- if updates:- state.update(updates)+ middleware.after_agent(state, runtime)def test_timeout_returns_error(tmp_path: Path) -> None:policy = HostExecutionPolicy(command_timeout=0.5)middleware = ShellToolMiddleware(workspace_root=tmp_path / "workspace", execution_policy=policy)+ runtime = Runtime()+ state = _empty_state()try:- state: AgentState = _empty_state()- updates = middleware.before_agent(state, None)+ updates = middleware.before_agent(state, runtime)if updates:- state.update(updates)- resources = middleware._get_or_create_resources(state) # type: ignore[attr-defined]+ state.update(cast("ShellToolState", updates))+ resources = middleware._get_or_create_resources(state)start = time.monotonic()result = middleware._run_shell_tool(resources, {"command": "sleep 2"}, tool_call_id=None)elapsed = time.monotonic() - startassert elapsed < policy.command_timeout + 2.0assert "timed out" in result.lower()finally:- updates = middleware.after_agent(state, None)- if updates:- state.update(updates)+ middleware.after_agent(state, runtime)def test_redaction_policy_applies(tmp_path: Path) -> None:@@ -118,12 +112,13 @@ def test_redaction_policy_applies(tmp_path: Path) -> None:workspace_root=tmp_path / "workspace",redaction_rules=(RedactionRule(pii_type="email", strategy="redact"),),)+ runtime = Runtime()+ state = _empty_state()try:- state: AgentState = _empty_state()- updates = middleware.before_agent(state, None)+ updates = middleware.before_agent(state, runtime)if updates:- state.update(updates)- resources = middleware._get_or_create_resources(state) # type: ignore[attr-defined]+ state.update(cast("ShellToolState", updates))+ resources = middleware._get_or_create_resources(state)message = middleware._run_shell_tool(resources,{"command": "printf 'Contact: [email protected]\\n'"},@@ -132,9 +127,7 @@ def test_redaction_policy_applies(tmp_path: Path) -> None:assert "[REDACTED_EMAIL]" in messageassert "[email protected]" not in messagefinally:- updates = middleware.after_agent(state, None)- if updates:- state.update(updates)+ middleware.after_agent(state, runtime)def test_startup_and_shutdown_commands(tmp_path: Path) -> None:@@ -144,16 +137,15 @@ def test_startup_and_shutdown_commands(tmp_path: Path) -> None:startup_commands=("touch startup.txt",),shutdown_commands=("touch shutdown.txt",),)+ runtime = Runtime()+ state = _empty_state()try:- state: AgentState = _empty_state()- updates = middleware.before_agent(state, None)+ updates = middleware.before_agent(state, runtime)if updates:- state.update(updates)+ state.update(cast("ShellToolState", updates))assert (workspace / "startup.txt").exists()finally:- updates = middleware.after_agent(state, None)- if updates:- state.update(updates)+ middleware.after_agent(state, runtime)assert (workspace / "shutdown.txt").exists()@@ -220,32 +212,32 @@ def test_normalize_env_coercion(tmp_path: Path) -> None:middleware = ShellToolMiddleware(workspace_root=tmp_path / "workspace", env={"NUM": 42, "BOOL": True})+ runtime = Runtime()+ state = _empty_state()try:- state: AgentState = _empty_state()- updates = middleware.before_agent(state, None)+ updates = middleware.before_agent(state, runtime)if updates:- state.update(updates)- resources = middleware._get_or_create_resources(state) # type: ignore[attr-defined]+ state.update(cast("ShellToolState", updates))+ resources = middleware._get_or_create_resources(state)result = middleware._run_shell_tool(resources, {"command": "echo $NUM $BOOL"}, tool_call_id=None)assert "42" in resultassert "True" in resultfinally:- updates = middleware.after_agent(state, None)- if updates:- state.update(updates)+ middleware.after_agent(state, runtime)def test_shell_tool_missing_command_string(tmp_path: Path) -> None:"""Test that shell tool raises an error when command is not a string."""middleware = ShellToolMiddleware(workspace_root=tmp_path / "workspace")+ runtime = Runtime()+ state = _empty_state()try:- state: AgentState = _empty_state()- updates = middleware.before_agent(state, None)+ updates = middleware.before_agent(state, runtime)if updates:- state.update(updates)- resources = middleware._get_or_create_resources(state) # type: ignore[attr-defined]+ state.update(cast("ShellToolState", updates))+ resources = middleware._get_or_create_resources(state)with pytest.raises(ToolException, match="expects a 'command' string"):middleware._run_shell_tool(resources, {"command": None}, tool_call_id=None)@@ -253,24 +245,23 @@ def test_shell_tool_missing_command_string(tmp_path: Path) -> None:with pytest.raises(ToolException, match="expects a 'command' string"):middleware._run_shell_tool(resources,- {"command": 123}, # type: ignore[dict-item]+ {"command": 123},tool_call_id=None,)finally:- updates = middleware.after_agent(state, None)- if updates:- state.update(updates)+ middleware.after_agent(state, runtime)def test_tool_message_formatting_with_id(tmp_path: Path) -> None:"""Test that tool messages are properly formatted with tool_call_id."""middleware = ShellToolMiddleware(workspace_root=tmp_path / "workspace")+ runtime = Runtime()+ state = _empty_state()try:- state: AgentState = _empty_state()- updates = middleware.before_agent(state, None)+ updates = middleware.before_agent(state, runtime)if updates:- state.update(updates)- resources = middleware._get_or_create_resources(state) # type: ignore[attr-defined]+ state.update(cast("ShellToolState", updates))+ resources = middleware._get_or_create_resources(state)result = middleware._run_shell_tool(resources, {"command": "echo test"}, tool_call_id="test-id-123"@@ -282,20 +273,19 @@ def test_tool_message_formatting_with_id(tmp_path: Path) -> None:assert result.status == "success"assert "test" in result.contentfinally:- updates = middleware.after_agent(state, None)- if updates:- state.update(updates)+ middleware.after_agent(state, runtime)def test_nonzero_exit_code_returns_error(tmp_path: Path) -> None:"""Test that non-zero exit codes are marked as errors."""middleware = ShellToolMiddleware(workspace_root=tmp_path / "workspace")+ runtime = Runtime()+ state = _empty_state()try:- state: AgentState = _empty_state()- updates = middleware.before_agent(state, None)+ updates = middleware.before_agent(state, runtime)if updates:- state.update(updates)- resources = middleware._get_or_create_resources(state) # type: ignore[attr-defined]+ state.update(cast("ShellToolState", updates))+ resources = middleware._get_or_create_resources(state)result = middleware._run_shell_tool(resources,@@ -306,23 +296,22 @@ def test_nonzero_exit_code_returns_error(tmp_path: Path) -> None:assert isinstance(result, ToolMessage)assert result.status == "error"assert "Exit code: 1" in result.content- assert result.artifact["exit_code"] == 1 # type: ignore[index]+ assert result.artifact["exit_code"] == 1finally:- updates = middleware.after_agent(state, None)- if updates:- state.update(updates)+ middleware.after_agent(state, runtime)def test_truncation_by_bytes(tmp_path: Path) -> None:"""Test that output is truncated by bytes when max_output_bytes is exceeded."""policy = HostExecutionPolicy(max_output_bytes=50, command_timeout=5.0)middleware = ShellToolMiddleware(workspace_root=tmp_path / "workspace", execution_policy=policy)+ runtime = Runtime()+ state = _empty_state()try:- state: AgentState = _empty_state()- updates = middleware.before_agent(state, None)+ updates = middleware.before_agent(state, runtime)if updates:- state.update(updates)- resources = middleware._get_or_create_resources(state) # type: ignore[attr-defined]+ state.update(cast("ShellToolState", updates))+ resources = middleware._get_or_create_resources(state)result = middleware._run_shell_tool(resources, {"command": "python3 -c 'print(\"x\" * 100)'"}, tool_call_id=None@@ -330,9 +319,7 @@ def test_truncation_by_bytes(tmp_path: Path) -> None:assert "truncated at 50 bytes" in result.lower()finally:- updates = middleware.after_agent(state, None)- if updates:- state.update(updates)+ middleware.after_agent(state, runtime)def test_startup_command_failure(tmp_path: Path) -> None:@@ -341,9 +328,10 @@ def test_startup_command_failure(tmp_path: Path) -> None:middleware = ShellToolMiddleware(workspace_root=tmp_path / "workspace", startup_commands=("exit 1",), execution_policy=policy)- state: AgentState = _empty_state()+ runtime = Runtime()+ state = _empty_state()with pytest.raises(RuntimeError, match=r"Startup command.*failed"):- middleware.before_agent(state, None)+ middleware.before_agent(state, runtime)def test_shutdown_command_failure_logged(tmp_path: Path) -> None:@@ -354,14 +342,15 @@ def test_shutdown_command_failure_logged(tmp_path: Path) -> None:shutdown_commands=("exit 1",),execution_policy=policy,)+ runtime = Runtime()+ state = _empty_state()try:- state: AgentState = _empty_state()- updates = middleware.before_agent(state, None)+ updates = middleware.before_agent(state, runtime)if updates:- state.update(updates)+ state.update(cast("ShellToolState", updates))finally:# Should not raise despite shutdown command failing- middleware.after_agent(state, None)+ middleware.after_agent(state, runtime)def test_shutdown_command_timeout_logged(tmp_path: Path) -> None:@@ -372,25 +361,27 @@ def test_shutdown_command_timeout_logged(tmp_path: Path) -> None:execution_policy=policy,shutdown_commands=("sleep 2",),)+ runtime = Runtime()+ state = _empty_state()try:- state: AgentState = _empty_state()- updates = middleware.before_agent(state, None)+ updates = middleware.before_agent(state, runtime)if updates:- state.update(updates)+ state.update(cast("ShellToolState", updates))finally:# Should not raise despite shutdown command timing out- middleware.after_agent(state, None)+ middleware.after_agent(state, runtime)def test_empty_output_replaced_with_no_output(tmp_path: Path) -> None:"""Test that empty command output is replaced with '<no output>'."""middleware = ShellToolMiddleware(workspace_root=tmp_path / "workspace")+ runtime = Runtime()+ state = _empty_state()try:- state: AgentState = _empty_state()- updates = middleware.before_agent(state, None)+ updates = middleware.before_agent(state, runtime)if updates:- state.update(updates)- resources = middleware._get_or_create_resources(state) # type: ignore[attr-defined]+ state.update(cast("ShellToolState", updates))+ resources = middleware._get_or_create_resources(state)result = middleware._run_shell_tool(resources,@@ -400,20 +391,19 @@ def test_empty_output_replaced_with_no_output(tmp_path: Path) -> None:assert "<no output>" in resultfinally:- updates = middleware.after_agent(state, None)- if updates:- state.update(updates)+ middleware.after_agent(state, runtime)def test_stderr_output_labeling(tmp_path: Path) -> None:"""Test that stderr output is properly labeled."""middleware = ShellToolMiddleware(workspace_root=tmp_path / "workspace")+ runtime = Runtime()+ state = _empty_state()try:- state: AgentState = _empty_state()- updates = middleware.before_agent(state, None)+ updates = middleware.before_agent(state, runtime)if updates:- state.update(updates)- resources = middleware._get_or_create_resources(state) # type: ignore[attr-defined]+ state.update(cast("ShellToolState", updates))+ resources = middleware._get_or_create_resources(state)result = middleware._run_shell_tool(resources, {"command": "echo error >&2"}, tool_call_id=None@@ -421,9 +411,7 @@ def test_stderr_output_labeling(tmp_path: Path) -> None:assert "[stderr] error" in resultfinally:- updates = middleware.after_agent(state, None)- if updates:- state.update(updates)+ middleware.after_agent(state, runtime)@pytest.mark.parametrize(@@ -444,22 +432,22 @@ def test_normalize_commands_string_tuple_list(middleware = ShellToolMiddleware(workspace_root=tmp_path / "workspace", startup_commands=startup_commands)- assert middleware._startup_commands == expected # type: ignore[attr-defined]+ assert middleware._startup_commands == expected-def test_async_methods_delegate_to_sync(tmp_path: Path) -> None:+async def test_async_methods_delegate_to_sync(tmp_path: Path) -> None:"""Test that async methods properly delegate to sync methods."""middleware = ShellToolMiddleware(workspace_root=tmp_path / "workspace")try:- state: AgentState = _empty_state()+ state = _empty_state()# Test abefore_agent- updates = asyncio.run(middleware.abefore_agent(state, None))+ updates = await middleware.abefore_agent(state, Runtime())if updates:- state.update(updates)+ state.update(cast("ShellToolState", updates))# Test aafter_agent- asyncio.run(middleware.aafter_agent(state, None))+ await middleware.aafter_agent(state, Runtime())finally:pass@@ -478,13 +466,14 @@ def test_shell_middleware_resumable_after_interrupt(tmp_path: Path) -> None:middleware = ShellToolMiddleware(workspace_root=workspace)# Simulate first execution (before interrupt)- state: AgentState = _empty_state()- updates = middleware.before_agent(state, None)+ runtime = Runtime()+ state = _empty_state()+ updates = middleware.before_agent(state, runtime)if updates:- state.update(updates)+ state.update(cast("ShellToolState", updates))# Get the resources and verify they exist- resources = middleware._get_or_create_resources(state) # type: ignore[attr-defined]+ resources = middleware._get_or_create_resources(state)initial_session = resources.sessioninitial_tempdir = resources.tempdir@@ -496,12 +485,12 @@ def test_shell_middleware_resumable_after_interrupt(tmp_path: Path) -> None:# Simulate resumption - call before_agent again with same state# This should reuse existing resources, not create new ones- updates = middleware.before_agent(state, None)+ updates = middleware.before_agent(state, runtime)if updates:- state.update(updates)+ state.update(cast("ShellToolState", updates))# Get resources again - should be the same session- resumed_resources = middleware._get_or_create_resources(state) # type: ignore[attr-defined]+ resumed_resources = middleware._get_or_create_resources(state)# Verify the session was reused (same object reference)assert resumed_resources.session is initial_session@@ -515,7 +504,7 @@ def test_shell_middleware_resumable_after_interrupt(tmp_path: Path) -> None:assert "unset" not in result# Clean up- middleware.after_agent(state, None)+ middleware.after_agent(state, runtime)def test_get_or_create_resources_creates_when_missing(tmp_path: Path) -> None:@@ -523,13 +512,13 @@ def test_get_or_create_resources_creates_when_missing(tmp_path: Path) -> None:workspace = tmp_path / "workspace"middleware = ShellToolMiddleware(workspace_root=workspace)- state: AgentState = _empty_state()+ state = _empty_state()# State has no resources initiallyassert "shell_session_resources" not in state# Call _get_or_create_resources - should create new resources- resources = middleware._get_or_create_resources(state) # type: ignore[attr-defined]+ resources = middleware._get_or_create_resources(state)assert isinstance(resources, _SessionResources)assert resources.session is not None@@ -544,13 +533,13 @@ def test_get_or_create_resources_reuses_existing(tmp_path: Path) -> None:workspace = tmp_path / "workspace"middleware = ShellToolMiddleware(workspace_root=workspace)- state: AgentState = _empty_state()+ state = _empty_state()# Create resources first time- resources1 = middleware._get_or_create_resources(state) # type: ignore[attr-defined]+ resources1 = middleware._get_or_create_resources(state)# Call again - should return the same resources- resources2 = middleware._get_or_create_resources(state) # type: ignore[attr-defined]+ resources2 = middleware._get_or_create_resources(state)assert resources1 is resources2assert resources1.session is resources2.session