Files
deer-flow/backend/tests/test_searxng_client.py
T
zengxi 330a2ff8c5 feat(community): add SearXNG and Browserless web search/fetch tools (#3451)
* feat(community): add SearXNG and Browserless web search/fetch tools

- SearXNG web_search: privacy-focused meta search engine integration
  with configurable base_url via config.yaml tool settings
- Browserless web_fetch: headless browser page fetching with
  readability article extraction
- Both tools are fully configurable through tool config section
- No external API keys required for basic operation

* fix: address PR review feedback and add unit tests

- Guard config.model_extra against None values (review #1, #2)
- Coerce max_results to int when reading from config (review #2)
- Fix web_fetch_tool to use direct HTTP fetch instead of reusing
  the web_search client config (review #3)
- Fix misleading docstring for SearxngClient.fetch (review #4)
- Remove unused target_url variable to pass Ruff lint (review #5)
- Normalize bool config values with _normalize_bool helper to
  handle env-resolved string values correctly (review #6)
- Add unit tests for both SearXNG and Browserless client classes
  and their tool functions with mocked httpx (review #7, #8)

* fix: convert to async httpx to avoid blocking I/O on event loop

- Replace httpx.Client with httpx.AsyncClient in both client classes
- Convert tool functions to async def
- Wrap readability_extractor calls in asyncio.to_thread()
- Update all tests to use pytest.mark.asyncio and async mocks
- Fix import sorting to pass Ruff lint

* fix(browserless): replace deprecated waitUntil with waitForEvent

The Browserless API has deprecated the waitUntil parameter.
Replace with waitForEvent which accepts values like 'networkidle'.
Default is empty (no wait), configurable via config.yaml.

* fix(browserless): remove deprecated gotoTimeout and bestAttempt params

The Browserless /content API does not accept gotoTimeout or bestAttempt
as top-level payload keys. These were being sent unconditionally,
causing 400 Bad Request errors on current Browserless versions.

Changes:
- Remove goto_timeout_ms parameter and 'gotoTimeout' from payload
- Remove best_attempt parameter and 'bestAttempt' from payload
- Remove _normalize_bool helper (no longer needed)
- Remove goto_timeout_ms and best_attempt config reading in tools.py
- Add tests for waitForSelector and reject params
- Verify no deprecated params are sent in test_fetch_html_success

* refactor(searxng): remove web_fetch_tool, decouple from web_search config

SearXNG is a search engine — it should only provide web_search_tool.
The web_fetch responsibility belongs to Browserless (headless Chrome)
or Jina AI, not SearXNG.

Changes:
- Remove web_fetch_tool from SearXNG tools.py and __init__.py
- Remove SearxngClient.fetch() method (no longer needed)
- Remove unused asyncio/readability imports from SearXNG tools.py
- Add test for max_results string-to-int coercion from config
- Add test for search with categories parameter
- Add test for httpx.RequestError handling
- Apply ruff format fixes to browserless_client.py and test files
2026-06-12 09:45:26 +08:00

164 lines
6.6 KiB
Python

"""Tests for SearXNG community tools."""
import json
from unittest.mock import MagicMock, patch
import pytest
from deerflow.community.searxng import tools
from deerflow.community.searxng.searxng_client import SearxngClient
class AsyncMock(MagicMock):
"""Mock that supports async call."""
async def __call__(self, *args, **kwargs):
return super().__call__(*args, **kwargs)
@pytest.mark.asyncio
class TestSearxngClient:
"""Tests for the SearxngClient class."""
async def test_search_success(self):
"""Search returns normalized results."""
results_data = {
"results": [
{"title": "Page 1", "url": "https://example.com/1", "content": "Snippet 1"},
{"title": "Page 2", "url": "https://example.com/2", "content": "Snippet 2"},
]
}
with patch("deerflow.community.searxng.searxng_client.httpx.AsyncClient") as mock_cls:
mock_ctx = MagicMock()
mock_cls.return_value.__aenter__.return_value = mock_ctx
mock_resp = MagicMock()
mock_resp.status_code = 200
mock_resp.json.return_value = results_data
mock_resp.raise_for_status.return_value = None
mock_ctx.get = AsyncMock(return_value=mock_resp)
client = SearxngClient(base_url="http://searxng:8080")
result = await client.search("test query", max_results=5)
assert len(result) == 2
assert result[0]["title"] == "Page 1"
assert result[1]["url"] == "https://example.com/2"
async def test_search_empty_results(self):
"""Search returns empty list when no results."""
with patch("deerflow.community.searxng.searxng_client.httpx.AsyncClient") as mock_cls:
mock_ctx = MagicMock()
mock_cls.return_value.__aenter__.return_value = mock_ctx
mock_resp = MagicMock()
mock_resp.status_code = 200
mock_resp.json.return_value = {"results": []}
mock_resp.raise_for_status.return_value = None
mock_ctx.get = AsyncMock(return_value=mock_resp)
client = SearxngClient(base_url="http://searxng:8080")
result = await client.search("empty query")
assert result == []
async def test_search_http_error(self):
"""Search raises on HTTP error."""
with patch("deerflow.community.searxng.searxng_client.httpx.AsyncClient") as mock_cls:
mock_ctx = MagicMock()
mock_cls.return_value.__aenter__.return_value = mock_ctx
import httpx
mock_resp = MagicMock()
mock_resp.raise_for_status.side_effect = httpx.HTTPStatusError("403 Forbidden", request=MagicMock(), response=MagicMock())
mock_ctx.get = AsyncMock(return_value=mock_resp)
client = SearxngClient(base_url="http://searxng:8080")
with pytest.raises(httpx.HTTPStatusError):
await client.search("blocked query")
async def test_search_request_error(self):
"""Search raises on request error."""
with patch("deerflow.community.searxng.searxng_client.httpx.AsyncClient") as mock_cls:
mock_ctx = MagicMock()
mock_cls.return_value.__aenter__.return_value = mock_ctx
import httpx
mock_ctx.get = AsyncMock(side_effect=httpx.RequestError("Connection refused"))
client = SearxngClient(base_url="http://searxng:8080")
with pytest.raises(httpx.RequestError):
await client.search("unreachable query")
async def test_search_with_categories(self):
"""Search passes categories parameter."""
with patch("deerflow.community.searxng.searxng_client.httpx.AsyncClient") as mock_cls:
mock_ctx = MagicMock()
mock_cls.return_value.__aenter__.return_value = mock_ctx
mock_resp = MagicMock()
mock_resp.status_code = 200
mock_resp.json.return_value = {"results": []}
mock_resp.raise_for_status.return_value = None
mock_ctx.get = AsyncMock(return_value=mock_resp)
client = SearxngClient(base_url="http://searxng:8080")
await client.search("test", categories=["news", "science"])
call_kwargs = mock_ctx.get.call_args.kwargs
assert call_kwargs["params"]["categories"] == "news,science"
@pytest.mark.asyncio
class TestSearxngTools:
"""Tests for the SearXNG tool functions."""
@patch("deerflow.community.searxng.tools._get_searxng_client")
async def test_web_search_tool_success(self, mock_get_client):
"""web_search_tool returns JSON results."""
mock_client = MagicMock()
mock_client.search = AsyncMock(
return_value=[
{"title": "Result 1", "url": "https://example.com/1", "content": "Desc 1"},
]
)
mock_get_client.return_value = mock_client
with patch("deerflow.community.searxng.tools._get_tool_config", return_value=None):
result = await tools.web_search_tool.ainvoke("test query")
data = json.loads(result)
assert len(data) == 1
assert data[0]["title"] == "Result 1"
@patch("deerflow.community.searxng.tools._get_searxng_client")
async def test_web_search_tool_error(self, mock_get_client):
"""web_search_tool handles errors gracefully."""
mock_client = MagicMock()
mock_client.search = AsyncMock(side_effect=Exception("API error"))
mock_get_client.return_value = mock_client
with patch("deerflow.community.searxng.tools._get_tool_config", return_value=None):
result = await tools.web_search_tool.ainvoke("test query")
data = json.loads(result)
assert "error" in data
@patch("deerflow.community.searxng.tools._get_searxng_client")
async def test_web_search_tool_with_max_results(self, mock_get_client):
"""web_search_tool respects max_results config."""
mock_client = MagicMock()
# Return 10 results; the tool should slice to max_results=3
mock_client.search = AsyncMock(return_value=[{"title": f"Result {i}", "url": f"https://example.com/{i}", "content": f"Desc {i}"} for i in range(10)])
mock_get_client.return_value = mock_client
with patch("deerflow.community.searxng.tools._get_tool_config", return_value={"max_results": "3"}):
await tools.web_search_tool.ainvoke("test query")
# Verify that search was called with max_results=3 (coerced from string)
mock_client.search.assert_called_once()
call_kwargs = mock_client.search.call_args.kwargs
assert call_kwargs["max_results"] == 3