Spaces:
Sleeping
Sleeping
File size: 36,748 Bytes
3193174 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 | """Tests for the tools module."""
from collections.abc import Generator
from pathlib import Path
import pytest
from tools import (
DuckDuckGoProvider,
FunctionTool,
SearchProvider,
ShellTool,
ToolCall,
ToolRegistry,
ToolResult,
WebSearchTool,
create_tool_from_config,
)
# Check Selenium availability
_selenium_available = True
try:
from selenium import webdriver # noqa: F401
except ImportError:
_selenium_available = False
selenium_required = pytest.mark.skipif(
not _selenium_available,
reason="Selenium is not installed (pip install selenium webdriver-manager)",
)
class TestToolCall:
"""Tests for ToolCall."""
def test_parse_xml_format(self):
"""Parsing tool_call in XML format."""
response = """
Some text before.
<tool_call>
{"name": "test_tool", "arguments": {"arg1": "value1"}}
</tool_call>
Some text after.
"""
calls = ToolCall.parse_from_response(response)
assert len(calls) == 1
assert calls[0].name == "test_tool"
assert calls[0].arguments == {"arg1": "value1"}
def test_parse_code_block_format(self):
"""Parsing tool_call in code block format."""
response = """
```tool_call
{"name": "another_tool", "arguments": {"x": 42}}
```
"""
calls = ToolCall.parse_from_response(response)
assert len(calls) == 1
assert calls[0].name == "another_tool"
assert calls[0].arguments == {"x": 42}
def test_parse_multiple_calls(self):
"""Parsing multiple tool_calls."""
response = """
<tool_call>
{"name": "tool1", "arguments": {}}
</tool_call>
<tool_call>
{"name": "tool2", "arguments": {"a": 1}}
</tool_call>
"""
calls = ToolCall.parse_from_response(response)
assert len(calls) == 2
assert calls[0].name == "tool1"
assert calls[1].name == "tool2"
def test_parse_no_calls(self):
"""Response without tool_call."""
response = "Just a regular response without any tools."
calls = ToolCall.parse_from_response(response)
assert len(calls) == 0
def test_parse_invalid_json(self):
"""Invalid JSON is ignored."""
response = """
<tool_call>
{invalid json here}
</tool_call>
"""
calls = ToolCall.parse_from_response(response)
assert len(calls) == 0
def test_parse_code_block_invalid_json_skipped(self):
"""Lines 63-65: Invalid JSON in code block format is skipped silently."""
response = """
```tool_call
{not valid json!
```
"""
calls = ToolCall.parse_from_response(response)
assert len(calls) == 0
class TestToolResult:
"""Tests for ToolResult."""
def test_success_message(self):
"""Formatting a successful result."""
result = ToolResult(tool_name="test", success=True, output="Hello")
msg = result.to_message()
assert '<tool_result name="test">' in msg
assert "Hello" in msg
assert "</tool_result>" in msg
def test_error_message(self):
"""Formatting an error."""
result = ToolResult(tool_name="test", success=False, error="Something went wrong")
msg = result.to_message()
assert '<tool_error name="test">' in msg
assert "Something went wrong" in msg
assert "</tool_error>" in msg
class TestShellTool:
"""Tests for ShellTool."""
def test_name_and_description(self):
"""Checking name and description."""
tool = ShellTool()
assert tool.name == "shell"
assert "shell command" in tool.description.lower()
def test_execute_echo(self):
"""Executing a simple echo command."""
tool = ShellTool(timeout=5)
result = tool.execute(command="echo Hello")
assert result.success is True
assert "Hello" in result.output
def test_execute_no_command(self):
"""Error when no command provided."""
tool = ShellTool()
result = tool.execute()
assert result.success is False
assert result.error is not None
assert "No command" in result.error
def test_allowed_commands(self):
"""Command whitelist."""
tool = ShellTool(allowed_commands=["echo"])
# Allowed command
result = tool.execute(command="echo test")
assert result.success is True
# Forbidden command
result = tool.execute(command="rm -rf /")
assert result.success is False
assert result.error is not None
assert "not allowed" in result.error
def test_parameters_schema(self):
"""Parameters schema."""
tool = ShellTool()
schema = tool.parameters_schema
assert schema["type"] == "object"
assert "command" in schema["properties"]
class TestFunctionTool:
"""Tests for FunctionTool."""
def test_register_decorator(self):
"""Registration via decorator."""
tool = FunctionTool()
@tool.register
def my_func(x: int) -> int:
"""Double the input."""
return x * 2
assert "my_func" in tool.list_functions()
def test_register_with_custom_name(self):
"""Registration with a custom name."""
tool = FunctionTool()
@tool.register(name="custom_name")
def some_func():
pass
assert "custom_name" in tool.list_functions()
assert "some_func" not in tool.list_functions()
def test_execute_function(self):
"""Executing a registered function."""
tool = FunctionTool()
@tool.register
def add(a: int, b: int) -> int:
return a + b
result = tool.execute(function="add", a=2, b=3)
assert result.success is True
assert result.output == "5"
def test_execute_unknown_function(self):
"""Error when calling an unregistered function."""
tool = FunctionTool()
result = tool.execute(function="unknown")
assert result.success is False
assert result.error is not None
assert "not found" in result.error
def test_execute_no_function_name(self):
"""Error when no function name provided."""
tool = FunctionTool()
result = tool.execute()
assert result.success is False
assert result.error is not None
assert "No function name" in result.error
class TestToolRegistry:
"""Tests for ToolRegistry."""
def test_register_and_get(self):
"""Registering and getting a tool."""
registry = ToolRegistry()
tool = ShellTool()
registry.register(tool)
assert registry.has("shell")
assert registry.get("shell") is tool
def test_list_tools(self):
"""Listing registered tools."""
registry = ToolRegistry()
registry.register(ShellTool())
registry.register(FunctionTool())
tools = registry.list_tools()
assert "shell" in tools
assert "function_calling" in tools
def test_execute(self):
"""Executing a tool through the registry."""
registry = ToolRegistry()
registry.register(ShellTool(timeout=5))
call = ToolCall(name="shell", arguments={"command": "echo test"})
result = registry.execute(call)
assert result.success is True
assert "test" in result.output
def test_execute_unknown_tool(self):
"""Error when calling an unregistered tool."""
registry = ToolRegistry()
call = ToolCall(name="unknown", arguments={})
result = registry.execute(call)
assert result.success is False
assert result.error is not None
assert "not found" in result.error
def test_execute_all(self):
"""Executing multiple calls."""
registry = ToolRegistry()
registry.register(ShellTool(timeout=5))
calls = [
ToolCall(name="shell", arguments={"command": "echo first"}),
ToolCall(name="shell", arguments={"command": "echo second"}),
]
results = registry.execute_all(calls)
assert len(results) == 2
assert all(r.success for r in results)
def test_function_decorator(self):
"""Registering a function via registry decorator."""
registry = ToolRegistry()
@registry.function
def greet(name: str) -> str:
"""Say hello."""
return f"Hello, {name}!"
assert registry.has("greet")
result = registry.execute(ToolCall(name="greet", arguments={"name": "World"}))
assert result.success is True
assert result.output == "Hello, World!"
def test_format_tools_prompt(self):
"""Formatting tools prompt."""
registry = ToolRegistry()
registry.register(ShellTool())
prompt = registry.format_tools_prompt(["shell"])
assert "Available tools:" in prompt
assert "shell" in prompt
assert "<tool_call>" in prompt
def test_get_tools_for_agent(self):
"""Getting tools for an agent."""
registry = ToolRegistry()
registry.register(ShellTool())
registry.register(FunctionTool())
# Agent with both tools
tools = registry.get_tools_for_agent(["shell", "function_calling"])
assert len(tools) == 2
# Agent with shell only
tools = registry.get_tools_for_agent(["shell"])
assert len(tools) == 1
assert tools[0].name == "shell"
# Agent with nonexistent tool
tools = registry.get_tools_for_agent(["unknown"])
assert len(tools) == 0
def test_to_schemas(self):
"""Serialization to JSON Schema."""
registry = ToolRegistry()
registry.register(ShellTool())
schemas = registry.to_schemas(["shell"])
assert len(schemas) == 1
assert schemas[0]["name"] == "shell"
assert "description" in schemas[0]
assert "parameters" in schemas[0]
class TestToolRegistryMissingCoverage:
"""Tests for missing lines in tools/base.py."""
def test_parse_from_response_invalid_json_code_block(self):
"""ToolCall.parse_from_response with invalid JSON in code block (lines 63-65)."""
text = "```tool_call\nnot valid json\n```"
calls = ToolCall.parse_from_response(text)
assert calls == [] # Invalid JSON is skipped (lines 63-65)
def test_parameters_schema_default(self):
"""BaseTool.parameters_schema returns default when not overridden."""
# Create a minimal concrete tool that doesn't override parameters_schema
from tools.base import BaseTool
class MinimalTool(BaseTool):
@property
def name(self) -> str:
return "minimal"
@property
def description(self) -> str:
return "A minimal tool"
def execute(self, **kwargs):
from tools.base import ToolResult
return ToolResult(tool_name="minimal", success=True, output="ok")
tool = MinimalTool()
schema = tool.parameters_schema # line 108
assert schema == {"type": "object", "properties": {}}
def test_function_decorator_with_name(self):
"""ToolRegistry.function called with name returns decorator (line 196)."""
registry = ToolRegistry()
@registry.function(name="named_fn") # func=None, returns decorator
def my_fn(x: str) -> str:
return x
assert registry.has("named_fn")
def test_execute_with_exception(self):
"""ToolRegistry.execute when tool raises ValueError (lines 218-219)."""
from tools.base import BaseTool
class ErrorTool(BaseTool):
@property
def name(self) -> str:
return "error_tool"
@property
def description(self) -> str:
return "Tool that raises"
def execute(self, **kwargs):
msg = "Intentional error"
raise ValueError(msg)
registry = ToolRegistry()
registry.register(ErrorTool())
result = registry.execute(ToolCall(name="error_tool", arguments={}))
assert result.success is False
assert result.error is not None
assert "Intentional error" in result.error
def test_get_tools_all(self):
"""ToolRegistry.get_tools with None returns all tools (line 245)."""
registry = ToolRegistry()
registry.register(ShellTool())
tools = registry.get_tools(None) # line 245
assert len(tools) >= 1
assert any(t.name == "shell" for t in tools)
def test_to_openai_schemas(self):
"""ToolRegistry.to_openai_schemas (lines 259-260)."""
registry = ToolRegistry()
registry.register(ShellTool())
schemas = registry.to_openai_schemas(["shell"]) # lines 259-260
assert len(schemas) == 1
assert schemas[0]["type"] == "function"
assert schemas[0]["function"]["name"] == "shell"
def test_format_tools_prompt_no_tools(self):
"""ToolRegistry.format_tools_prompt with no tools (line 309)."""
registry = ToolRegistry()
prompt = registry.format_tools_prompt()
assert prompt == "No tools available." # line 309
def test_register_tool_global(self):
"""register_tool registers in global registry (lines 362-363)."""
from tools.base import get_registry, register_tool
tool = ShellTool()
result = register_tool(tool) # lines 362-363
assert result is tool
assert get_registry().has("shell")
def test_tool_global_decorator(self):
"""@tool decorator registers function in global registry (line 389)."""
from tools.base import get_registry
from tools.base import tool as tool_decorator
@tool_decorator # line 389
def decorated_fn(x: str) -> str:
"""Decorated function."""
return x
assert get_registry().has("decorated_fn")
class TestWebSearchTool:
"""Tests for WebSearchTool."""
def test_name_and_description(self):
"""Checking name and description."""
tool = WebSearchTool()
assert tool.name == "web_search"
assert "search" in tool.description.lower()
assert "web" in tool.description.lower()
def test_parameters_schema(self):
"""Parameters schema."""
tool = WebSearchTool()
schema = tool.parameters_schema
assert schema["type"] == "object"
assert "query" in schema["properties"]
assert "url" in schema["properties"]
assert "fetch_content" in schema["properties"]
def test_execute_no_query(self):
"""Error when no query provided."""
tool = WebSearchTool()
result = tool.execute()
assert result.success is False
assert result.error is not None
assert "No" in result.error
assert "provided" in result.error
def test_execute_empty_query(self):
"""Error when empty query provided."""
tool = WebSearchTool()
result = tool.execute(query="")
assert result.success is False
assert result.error is not None
assert "No" in result.error
assert "provided" in result.error
def test_execute_with_mock_provider(self):
"""Execution with a mock provider."""
class MockProvider(SearchProvider):
def search(self, query: str, max_results: int = 5) -> list[dict[str, str]]:
return [
{
"title": "Test Result 1",
"url": "https://example.com/1",
"snippet": f"This is a result for: {query}",
},
{
"title": "Test Result 2",
"url": "https://example.com/2",
"snippet": "Another test result snippet",
},
]
tool = WebSearchTool(provider=MockProvider())
result = tool.execute(query="test query")
assert result.success is True
assert "Test Result 1" in result.output
assert "Test Result 2" in result.output
assert "https://example.com/1" in result.output
assert "test query" in result.output
def test_execute_with_empty_results(self):
"""Handling empty results."""
class EmptyProvider(SearchProvider):
def search(self, query: str, max_results: int = 5) -> list[dict[str, str]]:
return []
tool = WebSearchTool(provider=EmptyProvider())
result = tool.execute(query="no results query")
assert result.success is True
assert "No results found" in result.output
def test_max_results_limit(self):
"""Limiting the number of results."""
class ManyResultsProvider(SearchProvider):
def search(self, query: str, max_results: int = 5) -> list[dict[str, str]]:
# Return as many results as requested
return [
{
"title": f"Result {i}",
"url": f"https://example.com/{i}",
"snippet": f"Snippet {i}",
}
for i in range(max_results)
]
tool = WebSearchTool(provider=ManyResultsProvider(), max_results=3)
result = tool.execute(query="test")
assert result.success is True
assert "Found 3 result(s)" in result.output
def test_fetch_content_with_mock(self):
"""Test fetch_content with mock content."""
class ContentProvider(SearchProvider):
def search(self, query: str, max_results: int = 5) -> list[dict[str, str]]:
return [
{
"title": "Page with Content",
"url": "https://example.com/page",
"snippet": "Short snippet",
"content": "This is the full page content that was fetched from the URL.",
}
]
tool = WebSearchTool(provider=ContentProvider(), fetch_content=True)
result = tool.execute(query="test")
assert result.success is True
assert "Page with Content" in result.output
assert "full page content" in result.output
def test_url_parameter(self):
"""Test url parameter for reading a specific page."""
tool = WebSearchTool()
# Non-existent URL, but we check that the parameter is handled
result = tool.execute(url="https://nonexistent.invalid/page")
# Should be a network error, not a validation error
assert result.success is False
assert result.error is not None
assert "Failed to fetch" in result.error or "error" in result.error.lower()
def test_to_openai_schema(self):
"""Serialization to OpenAI format."""
tool = WebSearchTool()
schema = tool.to_openai_schema()
assert schema["type"] == "function"
assert schema["function"]["name"] == "web_search"
assert "description" in schema["function"]
assert "parameters" in schema["function"]
def test_registry_integration(self):
"""Integration with ToolRegistry."""
class MockProvider(SearchProvider):
def search(self, query: str, max_results: int = 5) -> list[dict[str, str]]:
return [{"title": "Mock", "url": "https://mock.com", "snippet": "Mock result"}]
registry = ToolRegistry()
registry.register(WebSearchTool(provider=MockProvider()))
assert registry.has("web_search")
call = ToolCall(name="web_search", arguments={"query": "test"})
result = registry.execute(call)
assert result.success is True
assert "Mock" in result.output
class TestDuckDuckGoProvider:
"""Tests for DuckDuckGoProvider."""
def test_initialization(self):
"""Provider initialization."""
provider = DuckDuckGoProvider(timeout=5)
assert provider._timeout == 5
def test_search_returns_list(self):
"""The search method returns a list."""
provider = DuckDuckGoProvider(timeout=5)
# No real request in unit tests β
# just check that the method exists and returns the expected type
results = provider.search("python", max_results=3)
assert isinstance(results, list)
# ======================================================================
# Tests for dict config and tool factory
# ======================================================================
class TestToolConfig:
"""Tests for creating tools from dict config."""
def test_create_web_search_from_config_basic(self):
"""Creating WebSearchTool from minimal config."""
tool = create_tool_from_config({"name": "web_search"})
assert tool is not None
assert tool.name == "web_search"
assert isinstance(tool, WebSearchTool)
def test_create_web_search_with_selenium(self):
"""Creating WebSearchTool with use_selenium=True from config."""
tool = create_tool_from_config(
{
"name": "web_search",
"use_selenium": True,
"selenium_config": {"headless": True},
}
)
assert tool is not None
assert isinstance(tool, WebSearchTool)
assert tool._use_selenium is True
assert tool._selenium_fetcher is not None
def test_create_web_search_with_params(self):
"""Creating WebSearchTool with parameters from config."""
tool = create_tool_from_config(
{
"name": "web_search",
"max_results": 10,
"fetch_content": True,
"timeout": 30,
}
)
assert isinstance(tool, WebSearchTool)
assert tool._max_results == 10
assert tool._fetch_content is True
assert tool._timeout == 30
def test_create_unknown_tool_returns_none(self):
"""Unknown tool returns None."""
tool = create_tool_from_config({"name": "unknown_tool_xyz"})
assert tool is None
def test_create_tool_empty_config(self):
"""Empty config returns None."""
tool = create_tool_from_config({})
assert tool is None
def test_agent_profile_with_dict_tool(self):
"""AgentProfile with dict-config tool."""
from core.agent import AgentProfile
agent = AgentProfile(
agent_id="browser",
display_name="Browser Agent",
tools=[{"name": "web_search", "use_selenium": True}],
)
assert agent.get_tool_names() == ["web_search"]
tool_objects = agent.get_tool_objects()
assert len(tool_objects) == 1
assert isinstance(tool_objects[0], WebSearchTool)
assert tool_objects[0].name == "web_search"
assert tool_objects[0]._use_selenium is True
def test_agent_profile_mixed_tools(self):
"""AgentProfile with mixed tool formats."""
from core.agent import AgentProfile
from tools import get_registry
# Register shell in global registry
registry = get_registry()
registry.register(ShellTool(timeout=5))
agent = AgentProfile(
agent_id="mixed",
display_name="Mixed Agent",
tools=[
"shell",
{"name": "web_search", "max_results": 3},
],
)
names = agent.get_tool_names()
assert "shell" in names
assert "web_search" in names
objects = agent.get_tool_objects()
assert len(objects) == 2
def test_schema_includes_action_when_selenium(self):
"""Schema from dict-config with Selenium includes action."""
tool = create_tool_from_config(
{
"name": "web_search",
"use_selenium": True,
}
)
assert tool is not None
props = tool.parameters_schema["properties"]
assert "action" in props
assert "selector" in props
# ======================================================================
# Real Selenium tests (no mocks, real browser)
# ======================================================================
def _detect_browser() -> str:
"""Detect the available browser for Selenium tests."""
import shutil
# Check Chrome
if shutil.which("chrome") or shutil.which("google-chrome"):
return "chrome"
# Check Edge (Windows)
edge_path = Path(r"C:\Program Files (x86)\Microsoft\Edge\Application\msedge.exe")
if edge_path.exists() or shutil.which("msedge"):
return "edge"
# Check Firefox
if shutil.which("firefox"):
return "firefox"
return "chrome" # fallback
@selenium_required
class TestWebSearchSeleniumReal:
"""
Real tests for WebSearchTool with Selenium.
Use a real headless browser to interact with web pages.
Skipped if Selenium is not installed.
Automatically detects the available browser (Chrome, Edge, Firefox).
"""
@pytest.fixture
def tool(self) -> Generator[WebSearchTool]:
"""WebSearchTool with real Selenium (auto-detected browser)."""
browser = _detect_browser()
t = WebSearchTool(
use_selenium=True,
selenium_config={
"headless": True,
"browser": browser,
"extra_wait": 1.0,
"page_load_timeout": 30,
},
)
yield t
t.close()
@pytest.fixture
def tool_from_config(self) -> Generator[WebSearchTool]:
"""WebSearchTool from dict config."""
browser = _detect_browser()
t = create_tool_from_config(
{
"name": "web_search",
"use_selenium": True,
"selenium_config": {"headless": True, "browser": browser},
}
)
assert isinstance(t, WebSearchTool)
yield t
t.close()
# ------------------------------------------------------------------
# action="fetch" β real page load
# ------------------------------------------------------------------
def test_fetch_real_page(self, tool: WebSearchTool):
"""Loading a real page via Selenium."""
result = tool.execute(action="fetch", url="https://example.com")
assert result.success is True
assert "Example Domain" in result.output
def test_fetch_with_wait_for_selector(self, tool: WebSearchTool):
"""Loading with waiting for CSS selector."""
result = tool.execute(
action="fetch",
url="https://example.com",
wait_for_selector="h1",
)
assert result.success is True
assert "Example Domain" in result.output
def test_fetch_auto_detect_by_url(self, tool: WebSearchTool):
"""Auto-detecting action=fetch by url."""
result = tool.execute(url="https://example.com")
assert result.success is True
assert "Example Domain" in result.output
# ------------------------------------------------------------------
# action="click" β real click
# ------------------------------------------------------------------
def test_click_real_element(self, tool: WebSearchTool):
"""Clicking a real link on the page."""
# First load the page
tool.execute(action="fetch", url="https://example.com")
# Click the "More information..." link
result = tool.execute(action="click", selector="a")
assert result.success is True
assert "Clicked element" in result.output
def test_click_nonexistent_element(self, tool: WebSearchTool):
"""Clicking a nonexistent element β error."""
tool.execute(action="fetch", url="https://example.com")
result = tool.execute(action="click", selector="#nonexistent-element-xyz")
assert result.success is False
# ------------------------------------------------------------------
# action="execute_js" β real JavaScript execution
# ------------------------------------------------------------------
def test_execute_js_real(self, tool: WebSearchTool):
"""Executing real JavaScript."""
tool.execute(action="fetch", url="https://example.com")
result = tool.execute(
action="execute_js",
js_code="return document.title",
)
assert result.success is True
assert "Example Domain" in result.output
def test_execute_js_return_computed_value(self, tool: WebSearchTool):
"""JS returns a computed value."""
tool.execute(action="fetch", url="https://example.com")
result = tool.execute(
action="execute_js",
js_code="return 2 + 2",
)
assert result.success is True
assert "4" in result.output
def test_execute_js_dom_manipulation(self, tool: WebSearchTool):
"""JS manipulates the DOM and returns a result."""
tool.execute(action="fetch", url="https://example.com")
result = tool.execute(
action="execute_js",
js_code="return document.querySelectorAll('a').length",
)
assert result.success is True
# example.com has at least 1 link
assert result.output # not empty
# ------------------------------------------------------------------
# action="extract_links" β real link extraction
# ------------------------------------------------------------------
def test_extract_links_real(self, tool: WebSearchTool):
"""Extracting real links from the page."""
tool.execute(action="fetch", url="https://example.com")
result = tool.execute(action="extract_links")
assert result.success is True
assert "link(s)" in result.output
def test_extract_links_with_url(self, tool: WebSearchTool):
"""Extracting links with a specified URL (fetch + extract)."""
result = tool.execute(
action="extract_links",
url="https://example.com",
)
assert result.success is True
assert "link(s)" in result.output
# ------------------------------------------------------------------
# action="get_content" β getting current page content
# ------------------------------------------------------------------
def test_get_content_after_fetch(self, tool: WebSearchTool):
"""Getting content after loading the page."""
tool.execute(action="fetch", url="https://example.com")
result = tool.execute(action="get_content")
assert result.success is True
assert "Example Domain" in result.output
# ------------------------------------------------------------------
# action="fill" β real form filling
# ------------------------------------------------------------------
def test_fill_real_input(self, tool: WebSearchTool):
"""Filling a real input field (on httpbin.org/forms/post)."""
tool.execute(
action="fetch",
url="https://httpbin.org/forms/post",
wait_for_selector="input",
)
result = tool.execute(
action="fill",
selector="input[name='custname']",
value="Test User",
)
assert result.success is True
assert "Filled" in result.output
assert "Test User" in result.output
# ------------------------------------------------------------------
# action="search" β real search
# ------------------------------------------------------------------
def test_search_real(self, tool: WebSearchTool):
"""Real search via DuckDuckGo."""
result = tool.execute(action="search", query="Python programming")
assert result.success is True
# Should have results (or at least no error)
assert result.output
# ------------------------------------------------------------------
# action="crawl" β real crawl
# ------------------------------------------------------------------
def test_crawl_real(self, tool: WebSearchTool):
"""Real site crawl."""
result = tool.execute(
action="crawl",
url="https://example.com",
max_depth=1,
max_pages=2,
)
assert result.success is True
assert "Crawled" in result.output or "page" in result.output.lower()
# ------------------------------------------------------------------
# Created from config and working for real
# ------------------------------------------------------------------
def test_config_created_tool_works(self, tool_from_config: WebSearchTool):
"""Tool created from dict-config works for real."""
result = tool_from_config.execute(
action="fetch",
url="https://example.com",
)
assert result.success is True
assert "Example Domain" in result.output
def test_config_created_tool_click(self, tool_from_config: WebSearchTool):
"""Tool from config β real click."""
tool_from_config.execute(action="fetch", url="https://example.com")
result = tool_from_config.execute(action="click", selector="a")
assert result.success is True
def test_config_created_tool_js(self, tool_from_config: WebSearchTool):
"""Tool from config β real JS."""
tool_from_config.execute(action="fetch", url="https://example.com")
result = tool_from_config.execute(
action="execute_js",
js_code="return document.title",
)
assert result.success is True
assert "Example Domain" in result.output
# ------------------------------------------------------------------
# Registry integration with real Selenium
# ------------------------------------------------------------------
def test_registry_with_real_selenium(self, tool: WebSearchTool):
"""ToolRegistry + real Selenium."""
registry = ToolRegistry()
registry.register(tool)
call = ToolCall(
name="web_search",
arguments={"action": "fetch", "url": "https://example.com"},
)
result = registry.execute(call)
assert result.success is True
assert "Example Domain" in result.output
def test_registry_click_real(self, tool: WebSearchTool):
"""ToolRegistry + real click."""
registry = ToolRegistry()
registry.register(tool)
# First fetch
registry.execute(
ToolCall(
name="web_search",
arguments={"action": "fetch", "url": "https://example.com"},
)
)
# Then click
result = registry.execute(
ToolCall(
name="web_search",
arguments={"action": "click", "selector": "a"},
)
)
assert result.success is True
def test_registry_execute_js_real(self, tool: WebSearchTool):
"""ToolRegistry + real JS."""
registry = ToolRegistry()
registry.register(tool)
registry.execute(
ToolCall(
name="web_search",
arguments={"action": "fetch", "url": "https://example.com"},
)
)
result = registry.execute(
ToolCall(
name="web_search",
arguments={"action": "execute_js", "js_code": "return document.title"},
)
)
assert result.success is True
assert "Example Domain" in result.output
# ------------------------------------------------------------------
# Errors
# ------------------------------------------------------------------
def test_fetch_invalid_url(self, tool: WebSearchTool):
"""Loading an invalid URL β error."""
result = tool.execute(action="fetch", url="https://this-domain-does-not-exist-xyz.invalid")
assert result.success is False
def test_execute_js_error(self, tool: WebSearchTool):
"""JS with an error."""
tool.execute(action="fetch", url="https://example.com")
result = tool.execute(
action="execute_js",
js_code="return nonExistentVariable.property",
)
assert result.success is False
def test_no_action_no_args(self, tool: WebSearchTool):
"""Call without arguments β error."""
result = tool.execute()
assert result.success is False
|