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
|
from __future__ import annotations
import asyncio
from datetime import datetime, timedelta
from typing import List, Optional
from unittest.async_case import IsolatedAsyncioTestCase
from unittest.mock import patch
from siobrultech_protocols.gem.api import (
GET_SERIAL_NUMBER,
SET_DATE_AND_TIME,
SET_PACKET_FORMAT,
SET_PACKET_SEND_INTERVAL,
SET_SECONDARY_PACKET_FORMAT,
ApiCall,
R,
T,
call_api,
get_serial_number,
set_date_and_time,
set_packet_format,
set_packet_send_interval,
set_secondary_packet_format,
synchronize_time,
)
from siobrultech_protocols.gem.packets import PacketFormatType
from siobrultech_protocols.gem.protocol import (
ApiType,
BidirectionalProtocol,
PacketProtocolMessage,
)
from tests.gem.mock_transport import MockRespondingTransport, MockTransport
class TestApi(IsolatedAsyncioTestCase):
def setUp(self):
self._queue: asyncio.Queue[PacketProtocolMessage] = asyncio.Queue()
self._transport = MockTransport()
self._protocol = BidirectionalProtocol(
self._queue,
packet_delay_clear_time=timedelta(seconds=0),
api_type=ApiType.GEM,
)
self._protocol.connection_made(self._transport)
async def testApiCallWithoutResponse(self):
await self.assertCall(
ApiCall(lambda _: "REQUEST", None, None, None),
"REQUEST",
None,
None,
None,
None,
)
async def testApiCall(self):
await self.assertCall(
ApiCall(lambda _: "REQUEST", lambda response: response, None, None),
"REQUEST",
None,
None,
"RESPONSE".encode(),
"RESPONSE",
)
async def testApiCallWithSerialNumber(self):
await self.assertCall(
ApiCall(lambda _: "^^^REQUEST", lambda response: response, None, None),
"^^^NMB02345REQUEST",
None,
1002345,
"RESPONSE".encode(),
"RESPONSE",
)
async def testApiCallIgnored(self):
call = ApiCall(lambda _: "REQUEST", lambda response: response, None, None)
async with call_api(call, self._protocol, timeout=timedelta(seconds=0)) as f:
with self.assertRaises(asyncio.exceptions.TimeoutError):
await f(None)
async def testGEMGetSerialNumber(self):
await self.assertCall(
GET_SERIAL_NUMBER,
"^^^RQSSRN",
None,
None,
"1234567\r\n".encode(),
1234567,
)
async def testECMGetSerialNumber(self):
await self.assertECMCall(
GET_SERIAL_NUMBER,
[b"\xfc", b"SET", b"RCV"],
None,
None,
b"\xa7\x04\xa7\x04\xf4\x03\x01\x0c\x04\x0b\x05\x01\xb2\x90\x00\x00\x00\x00\x8d\x8b\x8c\x8b\xce\x00\xff\xff\xff\xff\x05\x80>\x00m",
500434,
)
async def testSetDateTime(self):
await self.assertCall(
SET_DATE_AND_TIME,
"^^^SYSDTM12,08,23,13,30,28\r",
datetime.fromisoformat("2012-08-23 13:30:28"),
None,
"DTM\r\n".encode(),
True,
)
async def testSetPacketFormat(self):
await self.assertCall(
SET_PACKET_FORMAT,
"^^^SYSPKT02",
2,
None,
"PKT\r\n".encode(),
True,
)
async def testGEMSetPacketSendInterval(self):
await self.assertCall(
SET_PACKET_SEND_INTERVAL,
"^^^SYSIVL042",
42,
None,
"IVL\r\n".encode(),
True,
)
async def testECMSetPacketSendInterval(self):
await self.assertECMCall(
SET_PACKET_SEND_INTERVAL,
[b"\xfc", b"SET", b"IV2", bytes([42])],
42,
None,
None,
None,
)
async def testSetSecondaryPacketFormat(self):
await self.assertCall(
SET_SECONDARY_PACKET_FORMAT,
"^^^SYSPKF00",
0,
None,
"PKF\r\n".encode(),
True,
)
async def assertCall(
self,
call: ApiCall[T, R],
request: str,
arg: T,
serial_number: Optional[int],
encoded_response: bytes | None,
parsed_response: R | None,
):
self._protocol.begin_api_request()
self._transport.writes.clear() # Ignore the packet delay
result = asyncio.get_event_loop().create_future()
self._protocol.invoke_api(call, arg, result, serial_number)
self.assertEqual(
self._transport.writes,
[request.encode()],
f"{request.encode()} should be written to the transport",
)
if encoded_response is not None:
self._protocol.data_received(encoded_response)
result = await asyncio.wait_for(result, 0)
self.assertEqual(
result,
parsed_response,
f"{parsed_response} should be the parsed value returned",
)
async def assertECMCall(
self,
call: ApiCall[T, R],
request: List[bytes],
arg: T,
serial_number: Optional[int],
encoded_response: bytes | None,
parsed_response: R | None,
):
self._protocol.api_type = ApiType.ECM
self._transport.writes.clear()
self._protocol.begin_api_request()
result = asyncio.get_event_loop().create_future()
self._protocol.invoke_api(call, arg, result, serial_number)
for _ in range(0, len(request)):
self._protocol.data_received(b"\xfc")
self.assertEqual(
self._transport.writes,
request,
f"{request} should be written to the transport",
)
if encoded_response is not None:
self._transport.writes.clear()
self._protocol.data_received(encoded_response)
result = await asyncio.wait_for(result, 0)
self.assertEqual(
result,
parsed_response,
f"{parsed_response} should be the parsed value returned",
)
self._protocol.end_api_request()
if encoded_response is not None:
self.assertEqual(
self._transport.writes,
[b"\xfc"],
"ECM API calls with a response should be acked by the caller",
)
class TestContextManager(IsolatedAsyncioTestCase):
def setUp(self):
self._queue: asyncio.Queue[PacketProtocolMessage] = asyncio.Queue()
self._transport = MockTransport()
self._protocol = BidirectionalProtocol(
self._queue,
packet_delay_clear_time=timedelta(seconds=0),
api_type=ApiType.GEM,
)
self._protocol.connection_made(self._transport)
@patch(
"siobrultech_protocols.gem.protocol.API_RESPONSE_WAIT_TIME",
timedelta(seconds=0),
)
async def testApiCall(self):
call = ApiCall(lambda _: "REQUEST", lambda response: response, None, None)
async with call_api(call, self._protocol) as f:
self.setApiResponse("RESPONSE".encode())
response = await f(None)
self.assertEqual(response, "RESPONSE")
async def testApiCallWithSerialNumber(self):
call = ApiCall(lambda _: "^^^REQUEST", lambda response: response, None, None)
async with call_api(call, self._protocol, serial_number=1234567) as f:
self.setApiResponse("RESPONSE".encode())
response = await f(None)
self.assertEqual(response, "RESPONSE")
self.assertEqual(self._transport.writes, [b"^^^SYSPDL", b"^^^NMB34567REQUEST"])
async def testTaskCanceled(self):
call = ApiCall(lambda _: "REQUEST", lambda response: response, None, None)
with self.assertRaises(asyncio.CancelledError):
with patch("asyncio.sleep") as mock_sleep:
mock_sleep.side_effect = asyncio.CancelledError
async with call_api(call, self._protocol):
raise AssertionError("this should not be reached")
def setApiResponse(self, ecnoded_response: bytes) -> asyncio.Task[None]:
async def notify_data_received() -> None:
self._protocol.data_received(ecnoded_response)
return asyncio.create_task(
notify_data_received(), name=f"{__name__}:send_api_resonse"
)
class TestApiHelpers(IsolatedAsyncioTestCase):
def setUp(self):
self._protocol = BidirectionalProtocol(
asyncio.Queue(),
packet_delay_clear_time=timedelta(seconds=0),
api_type=ApiType.GEM,
)
patcher_API_RESPONSE_WAIT_TIME = patch(
"siobrultech_protocols.gem.protocol.API_RESPONSE_WAIT_TIME",
timedelta(seconds=0),
)
patcher_API_RESPONSE_WAIT_TIME.start()
self.addCleanup(lambda: patcher_API_RESPONSE_WAIT_TIME.stop())
async def test_get_serial_number(self):
transport = MockRespondingTransport(self._protocol, "1234567\r\n".encode())
self._protocol.connection_made(transport)
serial = await get_serial_number(self._protocol)
self.assertEqual(serial, 1234567)
async def test_set_date_and_time(self):
transport = MockRespondingTransport(self._protocol, "DTM\r\n".encode())
self._protocol.connection_made(transport)
success = await set_date_and_time(self._protocol, datetime(2020, 3, 11))
self.assertTrue(success)
async def test_set_packet_format(self):
transport = MockRespondingTransport(self._protocol, "PKT\r\n".encode())
self._protocol.connection_made(transport)
success = await set_packet_format(self._protocol, PacketFormatType.BIN32_ABS)
self.assertTrue(success)
async def test_set_packet_send_interval(self):
with self.assertRaises(ValueError):
await set_packet_send_interval(self._protocol, -1)
with self.assertRaises(ValueError):
await set_packet_send_interval(self._protocol, 257)
transport = MockRespondingTransport(self._protocol, "IVL\r\n".encode())
self._protocol.connection_made(transport)
success = await set_packet_send_interval(self._protocol, 42)
self.assertTrue(success)
async def test_set_secondary_packet_format(self):
transport = MockRespondingTransport(self._protocol, "PKF\r\n".encode())
self._protocol.connection_made(transport)
success = await set_secondary_packet_format(
self._protocol, PacketFormatType.BIN32_ABS
)
self.assertTrue(success)
async def test_synchronize_time(self):
transport = MockRespondingTransport(self._protocol, "DTM\r\n".encode())
self._protocol.connection_made(transport)
success = await synchronize_time(self._protocol)
self.assertTrue(success)
|
