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
|
"""Tests for the connection module / Part 5 / Make Request."""
from unittest.mock import AsyncMock, MagicMock
from urllib.parse import quote
import pytest
from asusrouter.connection_config import ARConnectionConfigKey as ARCCKey
from asusrouter.const import DEFAULT_PORT_HTTP, RequestType
from asusrouter.modules.endpoint import EndpointService
from tests.helpers import AsyncPatch, ConnectionFactory
class TestConnectionMakeRequest:
"""Tests for the Connection _make_request method."""
TEST_HOSTNAME = "router"
TEST_PORT = DEFAULT_PORT_HTTP
DEFAULT_HEADERS = {"default": "header"}
CUSTOM_HEADERS = {"custom": "header"}
def _create_mock_context_manager(
self, mock_response: MagicMock
) -> AsyncMock:
"""Create a proper async context manager mock."""
mock_cm = AsyncMock()
mock_cm.__aenter__.return_value = mock_response
mock_cm.__aexit__.return_value = None
return mock_cm
def _create_mock_response(
self, status: int, headers: dict[str, str], text: str
) -> MagicMock:
"""Create a mock response."""
mock_response = MagicMock()
mock_response.status = status
mock_response.headers = headers
mock_response.text = AsyncMock(return_value=text)
return mock_response
@pytest.mark.asyncio
@pytest.mark.parametrize(
(
"request_type",
"payload",
"expected_url_suffix",
"expected_data",
"response_text",
"response_headers",
"response_status",
"expect_retry",
),
[
# Session closed, should retry after reconnect
(
RequestType.POST,
"data",
f"/{EndpointService.LOGIN.value}",
quote("data"),
"ok",
{"h": "v"},
200,
True,
),
# Session open, POST request
(
RequestType.POST,
"data",
f"/{EndpointService.LOGIN.value}",
quote("data"),
"ok",
{"h": "v"},
200,
False,
),
# Session open, GET request with payload
# (test `;` → `&` replacement)
(
RequestType.GET,
"param1=val1;param2=val2",
f"/{EndpointService.LOGIN.value}?param1=val1¶m2=val2",
None,
"ok",
{"h": "v"},
200,
False,
),
# Session open, GET request without payload
(
RequestType.GET,
None,
f"/{EndpointService.LOGIN.value}",
None,
"ok",
{"h": "v"},
200,
False,
),
],
ids=[
"session_closed_retry",
"post_request",
"get_request_with_payload",
"get_request_no_payload",
],
)
async def test_make_request(
self,
request_type: RequestType,
payload: str | None,
expected_url_suffix: str,
expected_data: str | None,
response_text: str,
response_headers: dict[str, str],
response_status: int,
expect_retry: bool,
connection_factory: ConnectionFactory,
async_connect: AsyncPatch,
new_session: AsyncPatch,
) -> None:
"""Test _make_request for basic flows and session recreation."""
connection = connection_factory()
# Set connection properties for URL building
connection._hostname = self.TEST_HOSTNAME
connection.config.set(ARCCKey.PORT, self.TEST_PORT)
connection.config.set(ARCCKey.USE_SSL, False)
connection._header = self.DEFAULT_HEADERS
# Prepare response and context manager
mock_response = self._create_mock_response(
response_status, response_headers, response_text
)
mock_cm = self._create_mock_context_manager(mock_response)
if expect_retry:
# First session is closed, second is open
mock_session_closed = MagicMock()
mock_session_closed.closed = True
mock_session_open = MagicMock()
mock_session_open.closed = False
mock_session_open.request = MagicMock(return_value=mock_cm)
connection._session = mock_session_closed
# Patch _new_session to return open session on retry
mock_new_session = new_session(
connection, return_value=mock_session_open
)
mock_async_connect = async_connect(connection)
else:
mock_session = MagicMock()
mock_session.closed = False
mock_session.request = MagicMock(return_value=mock_cm)
connection._session = mock_session
mock_new_session = new_session(connection)
mock_async_connect = async_connect(connection)
# Patch _dumpback
connection._dumpback = AsyncMock()
result = await connection._make_request(
EndpointService.LOGIN,
payload=payload,
headers=None,
request_type=request_type,
)
# Verify retry behavior
if expect_retry:
mock_new_session.assert_called_once()
mock_async_connect.assert_awaited_once()
active_session = mock_session_open
else:
mock_new_session.assert_not_called()
mock_async_connect.assert_not_awaited()
active_session = mock_session
# Verify request was called with correct parameters
expected_url = (
f"http://{self.TEST_HOSTNAME}:"
f"{self.TEST_PORT}{expected_url_suffix}"
)
active_session.request.assert_called_once_with(
request_type.value,
expected_url,
data=expected_data,
headers=self.DEFAULT_HEADERS,
ssl=connection.config.get(ARCCKey.VERIFY_SSL),
)
# Check result
assert result == (response_status, response_headers, response_text)
# Check dumpback called
connection._dumpback.assert_awaited_once_with(
EndpointService.LOGIN,
payload,
response_status,
response_headers,
response_text,
)
@pytest.mark.asyncio
async def test_make_request_no_session(
self,
connection_factory: ConnectionFactory,
async_connect: AsyncPatch,
new_session: AsyncPatch,
) -> None:
"""Test _make_request when session is None."""
connection = connection_factory()
connection._session = None # type: ignore[assignment]
mock_session_open = MagicMock()
mock_session_open.closed = False
mock_response = self._create_mock_response(200, {"h": "v"}, "ok")
mock_cm = self._create_mock_context_manager(mock_response)
mock_session_open.request = MagicMock(return_value=mock_cm)
mock_new_session = new_session(
connection, return_value=mock_session_open
)
mock_async_connect = async_connect(connection)
connection._dumpback = AsyncMock()
result = await connection._make_request(EndpointService.LOGIN)
mock_new_session.assert_called_once()
mock_async_connect.assert_awaited_once()
assert result == (200, {"h": "v"}, "ok")
@pytest.mark.asyncio
async def test_make_request_unicode_decode_error(
self,
connection_factory: ConnectionFactory,
) -> None:
"""Test _make_request handles UnicodeDecodeError."""
connection = connection_factory()
mock_session = MagicMock()
mock_session.closed = False
connection._session = mock_session
# Patch response to raise UnicodeDecodeError then succeed
mock_response = MagicMock()
mock_response.status = 200
mock_response.headers = {"h": "v"}
mock_response.text = AsyncMock(
side_effect=[
UnicodeDecodeError("utf-8", b"", 0, 1, "bad"),
"fixed",
]
)
mock_cm = self._create_mock_context_manager(mock_response)
mock_session.request = MagicMock(return_value=mock_cm)
connection._dumpback = AsyncMock()
result = await connection._make_request(
EndpointService.LOGIN,
payload="data",
headers=None,
request_type=RequestType.POST,
)
assert result == (200, {"h": "v"}, "fixed")
connection._dumpback.assert_awaited_once_with(
EndpointService.LOGIN, "data", 200, {"h": "v"}, "fixed"
)
@pytest.mark.asyncio
async def test_make_request_custom_headers(
self,
connection_factory: ConnectionFactory,
) -> None:
"""Test _make_request uses custom headers when provided."""
connection = connection_factory()
mock_session = MagicMock()
mock_session.closed = False
connection._session = mock_session
connection._header = self.DEFAULT_HEADERS
custom_headers = self.CUSTOM_HEADERS
mock_response = self._create_mock_response(200, {"h": "v"}, "ok")
mock_cm = self._create_mock_context_manager(mock_response)
mock_session.request = MagicMock(return_value=mock_cm)
connection._dumpback = AsyncMock()
await connection._make_request(
EndpointService.LOGIN,
payload=None,
headers=custom_headers,
request_type=RequestType.POST,
)
# Should use custom headers, not default
mock_session.request.assert_called_once()
call_args = mock_session.request.call_args
assert call_args.kwargs["headers"] == custom_headers
@pytest.mark.asyncio
async def test_make_request_no_dumpback(
self,
connection_factory: ConnectionFactory,
) -> None:
"""Test _make_request works when no dumpback is set."""
connection = connection_factory()
mock_session = MagicMock()
mock_session.closed = False
connection._session = mock_session
connection._dumpback = None # No dumpback
mock_response = self._create_mock_response(200, {"h": "v"}, "ok")
mock_cm = self._create_mock_context_manager(mock_response)
mock_session.request = MagicMock(return_value=mock_cm)
result = await connection._make_request(
EndpointService.LOGIN,
payload=None,
headers=None,
request_type=RequestType.POST,
)
assert result == (200, {"h": "v"}, "ok")
# Should not raise any errors when dumpback is None
|
