[3af7d7]: / aiagents4pharma / talk2scholars / tests / test_s2_search.py

Download this file

287 lines (239 with data), 9.9 kB

  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
"""
Unit tests for S2 tools functionality.
"""
from types import SimpleNamespace
import pytest
import hydra
import requests
from langgraph.types import Command
from langchain_core.messages import ToolMessage
from aiagents4pharma.talk2scholars.tools.s2.search import search_tool
from aiagents4pharma.talk2scholars.tools.s2.utils import search_helper
# --- Dummy Hydra Config Setup ---
class DummyHydraContext:
"""hydra.initialize context manager that does nothing."""
def __enter__(self):
return None
def __exit__(self, exc_type, exc_val, traceback):
return None
# Create a dummy configuration that mimics the expected hydra config
dummy_config = SimpleNamespace(
tools=SimpleNamespace(
search=SimpleNamespace(
api_endpoint="http://dummy.endpoint",
api_fields=["paperId", "title", "authors"],
)
)
)
# --- Dummy Response Classes and Functions for requests.get ---
class DummyResponse:
"""A dummy response class for mocking HTTP responses."""
def __init__(self, json_data, status_code=200):
"""initialize a DummyResponse with the given JSON data and status code."""
self._json_data = json_data
self.status_code = status_code
def json(self):
"""access the JSON data from the response."""
return self._json_data
def raise_for_status(self):
"""Raise an HTTP error for status codes >= 400."""
if self.status_code >= 400:
raise requests.HTTPError("HTTP Error")
def test_dummy_response_no_error():
"""Test that raise_for_status does not raise an exception for a successful response."""
# Create a DummyResponse with a successful status code.
response = DummyResponse({"data": "success"}, status_code=200)
# Calling raise_for_status should not raise an exception and should return None.
assert response.raise_for_status() is None
def test_dummy_response_raise_error():
"""Test that raise_for_status raises an exception for a failing response."""
# Create a DummyResponse with a failing status code.
response = DummyResponse({"error": "fail"}, status_code=400)
# Calling raise_for_status should raise an HTTPError.
with pytest.raises(requests.HTTPError):
response.raise_for_status()
def dummy_requests_get_success(url, params, timeout):
"""A dummy requests.get function that returns a successful response."""
# Record call parameters for assertions
dummy_requests_get_success.called_url = url
dummy_requests_get_success.called_params = params
dummy_requests_get_success.called_timeout = timeout
# Simulate a valid API response with three papers;
# one paper missing authors should be filtered out.
dummy_data = {
"data": [
{
"paperId": "1",
"title": "Paper 1",
"authors": [{"name": "Author A", "authorId": "A1"}],
"year": 2020,
"citationCount": 10,
"url": "http://paper1",
"externalIds": {"ArXiv": "arxiv1"},
},
{
"paperId": "2",
"title": "Paper 2",
"authors": [{"name": "Author B", "authorId": "B1"}],
"year": 2021,
"citationCount": 20,
"url": "http://paper2",
"externalIds": {},
},
{
"paperId": "3",
"title": "Paper 3",
"authors": None, # This paper should be filtered out.
"year": 2022,
"citationCount": 30,
"url": "http://paper3",
"externalIds": {"ArXiv": "arxiv3"},
},
]
}
return DummyResponse(dummy_data)
def dummy_requests_get_no_data(url, params, timeout):
"""A dummy requests.get function that returns a response without the expected 'data' key."""
dummy_requests_get_no_data.called_url = url
dummy_requests_get_no_data.called_params = params
dummy_requests_get_no_data.called_timeout = timeout
# Simulate a response with an unexpected format (missing "data" key)
return DummyResponse({"error": "Invalid format"})
def dummy_requests_get_no_papers(url, params, timeout):
"""A dummy requests.get function that returns a response with an empty papers list."""
dummy_requests_get_no_papers.called_url = url
dummy_requests_get_no_papers.called_params = params
dummy_requests_get_no_papers.called_timeout = timeout
# Simulate a response with an empty papers list.
return DummyResponse({"data": []})
def dummy_requests_get_exception(url, params, timeout):
"""A dummy requests.get function that raises an exception."""
dummy_requests_get_exception.called_url = url
dummy_requests_get_exception.called_params = params
dummy_requests_get_exception.called_timeout = timeout
# Simulate a network/connection exception.
raise requests.exceptions.RequestException("Connection error")
# --- Pytest Fixture to Patch Hydra ---
@pytest.fixture(autouse=True)
def patch_hydra(monkeypatch):
"""hydra patch to mock initialize and compose functions."""
# Patch hydra.initialize to return our dummy context manager.
monkeypatch.setattr(
hydra, "initialize", lambda version_base, config_path: DummyHydraContext()
)
# Patch hydra.compose to return our dummy config.
monkeypatch.setattr(hydra, "compose", lambda config_name, overrides: dummy_config)
# --- Test Cases ---
def test_search_tool_success(monkeypatch):
"""
Test that search_tool returns a valid Command object when the API response is successful.
Also checks that papers without required fields are filtered out.
"""
monkeypatch.setattr(requests, "get", dummy_requests_get_success)
tool_call_id = "test_tool_call_id"
# Invoke using .run() with a dictionary input.
result = search_tool.run(
{
"query": "machine learning",
"tool_call_id": tool_call_id,
"limit": 3,
"year": "2020",
}
)
# Check that a Command is returned with the expected update structure.
assert isinstance(result, Command)
update = result.update
assert "papers" in update
papers = update["papers"]
# Papers with valid 'title' and 'authors' should be included.
assert "1" in papers
assert "2" in papers
# Paper "3" is missing authors and should be filtered out.
assert "3" not in papers
# Check that a ToolMessage is included in the messages.
messages = update.get("messages", [])
assert len(messages) == 1
msg = messages[0]
assert isinstance(msg, ToolMessage)
assert "Number of papers found:" in msg.content
# Verify that the correct parameters were sent to requests.get.
called_params = dummy_requests_get_success.called_params
assert called_params["query"] == "machine learning"
# The "year" parameter should have been added.
assert called_params["year"] == "2020"
# The limit is set to min(limit, 100) so it should be 3.
assert called_params["limit"] == 3
# The fields should be a comma-separated string from the dummy config.
assert called_params["fields"] == "paperId,title,authors"
def test_search_tool_unexpected_format(monkeypatch):
"""
Test that search_tool raises a RuntimeError when the API response
does not include the expected 'data' key.
"""
monkeypatch.setattr(requests, "get", dummy_requests_get_no_data)
tool_call_id = "test_tool_call_id"
with pytest.raises(
RuntimeError,
match=(
"Unexpected response from Semantic Scholar API. The results could not be "
"retrieved due to an unexpected format. "
"Please modify your search query and try again."
),
):
search_tool.run(
{
"query": "test",
"tool_call_id": tool_call_id,
}
)
def test_search_tool_no_papers(monkeypatch):
"""
Test that search_tool raises a RuntimeError when the API returns no papers.
"""
monkeypatch.setattr(requests, "get", dummy_requests_get_no_papers)
tool_call_id = "test_tool_call_id"
with pytest.raises(
RuntimeError,
match=(
"No papers were found for your query. Consider refining your search "
"by using more specific keywords or different terms."
),
):
search_tool.run(
{
"query": "test",
"tool_call_id": tool_call_id,
}
)
def test_search_tool_requests_exception(monkeypatch):
"""
Test that search_tool raises a RuntimeError when requests.get throws an exception.
"""
monkeypatch.setattr(requests, "get", dummy_requests_get_exception)
tool_call_id = "test_tool_call_id"
with pytest.raises(
RuntimeError,
match="Failed to connect to Semantic Scholar API after 10 attempts."
"Please retry the same query.",
):
search_tool.run(
{
"query": "test",
"tool_call_id": tool_call_id,
}
)
def test_search_tool_no_response(monkeypatch):
"""
Test that search_tool raises a RuntimeError when no response
is obtained. This is simulated by patching 'range' in the
module namespace of search_helper to return an empty iterator,
so that the for-loop in _fetch_papers never iterates and self.response
remains None.
"""
# Patch 'range' in the module globals of search_helper.
monkeypatch.setitem(search_helper.__dict__, "range", lambda x: iter([]))
tool_call_id = "test_tool_call_id"
with pytest.raises(
RuntimeError, match="Failed to obtain a response from the Semantic Scholar API."
):
search_tool.run({"query": "test", "tool_call_id": tool_call_id})