-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathtest_server.py
More file actions
640 lines (525 loc) · 27 KB
/
test_server.py
File metadata and controls
640 lines (525 loc) · 27 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
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
import asyncio
from collections.abc import Awaitable
from json import dumps, loads
import pytest
from pytest_mock import MockerFixture
from socketio import AsyncClient, AsyncServer # pyright: ignore[reportMissingTypeStubs]
from vbl_aquarium.models.ephys_link import (
AngularResponse,
BooleanStateResponse,
EphysLinkOptions,
GetManipulatorsResponse,
PlatformInfo,
PositionalResponse,
SetDepthRequest,
SetDepthResponse,
SetInsideBrainRequest,
SetPositionRequest,
ShankCountResponse,
)
from vbl_aquarium.models.proxy import PinpointIdResponse
import ephys_link.back_end.server
from ephys_link.__about__ import __version__
from ephys_link.back_end.platform_handler import PlatformHandler
from ephys_link.back_end.server import Server
from ephys_link.front_end.console import Console
from ephys_link.utils.constants import (
MALFORMED_REQUEST_ERROR,
PROXY_CLIENT_NOT_INITIALIZED_ERROR,
SERVER_NOT_INITIALIZED_ERROR,
UNKNOWN_EVENT_ERROR,
cannot_connect_as_client_is_already_connected_error,
client_disconnected_without_being_connected_error,
)
from tests.conftest import DUMMY_STRING, DUMMY_STRING_LIST, DUMMY_VECTOR3, DUMMY_VECTOR4
class TestServer:
@pytest.fixture
def platform_handler(self, mocker: MockerFixture) -> PlatformHandler:
"""Fixture for mock PlatformHandler."""
return mocker.Mock(spec=PlatformHandler)
@pytest.fixture
def console(self, mocker: MockerFixture) -> Console:
"""Fixture for mock console."""
return mocker.Mock(spec=Console)
@pytest.fixture
def server(self, platform_handler: PlatformHandler, console: Console) -> Server:
"""Fixture for server."""
return Server(EphysLinkOptions(use_proxy=False), platform_handler, console)
@pytest.fixture
def proxy_client(self, platform_handler: PlatformHandler, console: Console) -> Server:
"""Fixture for server as proxy client."""
return Server(EphysLinkOptions(use_proxy=True), platform_handler, console)
def test_failed_server_init(
self, platform_handler: PlatformHandler, console: Console, mocker: MockerFixture
) -> None:
"""Server should raise error if sio is not an AsyncServer."""
# Mock out the AsyncServer init.
patched_async_server = mocker.patch.object(AsyncServer, "__new__")
# Act
with pytest.raises(TypeError) as init_error:
_ = Server(EphysLinkOptions(use_proxy=False), platform_handler, console)
# Assert
patched_async_server.assert_called_once()
assert init_error.value.args[0] == SERVER_NOT_INITIALIZED_ERROR
def test_launch_server(
self, server: Server, platform_handler: PlatformHandler, console: Console, mocker: MockerFixture
) -> None:
"""Server should print info then start."""
# Add mocks and spies.
# noinspection DuplicatedCode
spied_info_print = mocker.spy(console, "info_print")
patched_get_display_name = mocker.patch.object(platform_handler, "get_display_name", return_value=DUMMY_STRING)
# Mock out get manipulators.
patched_get_manipulators = mocker.patch.object(platform_handler, "get_manipulators", new=mocker.Mock())
asyncio_loop = mocker.Mock()
patched_run_until_complete = mocker.patch.object(
asyncio_loop, "run_until_complete", return_value=GetManipulatorsResponse(manipulators=DUMMY_STRING_LIST)
)
patched_new_event_loop = mocker.patch.object(
ephys_link.back_end.server, "new_event_loop", return_value=asyncio_loop
)
# Mock out run_app.
mocked_run_app = mocker.patch.object(ephys_link.back_end.server, "run_app")
# Act.
server.launch()
# Assert.
patched_get_display_name.assert_called_once()
patched_get_manipulators.assert_called_once()
patched_run_until_complete.assert_called_once()
patched_new_event_loop.assert_called_once()
spied_info_print.assert_any_call("PLATFORM", platform_handler.get_display_name())
spied_info_print.assert_any_call("MANIPULATORS", str(DUMMY_STRING_LIST))
mocked_run_app.assert_called_once()
def test_launch_proxy_client(
self, proxy_client: Server, platform_handler: PlatformHandler, console: Console, mocker: MockerFixture
) -> None:
"""Proxy client should print info then start."""
# Add mocks and spies.
# noinspection DuplicatedCode
spied_info_print = mocker.spy(console, "info_print")
patched_get_display_name = mocker.patch.object(platform_handler, "get_display_name", return_value=DUMMY_STRING)
# Mock out get manipulators.
patched_get_manipulators = mocker.patch.object(platform_handler, "get_manipulators", new=mocker.Mock())
asyncio_loop = mocker.Mock()
patched_run_until_complete = mocker.patch.object(
asyncio_loop, "run_until_complete", return_value=GetManipulatorsResponse(manipulators=DUMMY_STRING_LIST)
)
patched_new_event_loop = mocker.patch.object(
ephys_link.back_end.server, "new_event_loop", return_value=asyncio_loop
)
# Mock out run.
def run_coroutine(coroutine: Awaitable[None]) -> None:
"""Run the coroutine."""
asyncio.new_event_loop().run_until_complete(coroutine)
_ = mocker.patch.object(ephys_link.back_end.server, "run", new=run_coroutine)
patched_connect = mocker.patch.object(AsyncClient, "connect", new_callable=mocker.AsyncMock)
patched_wait = mocker.patch.object(AsyncClient, "wait", new_callable=mocker.AsyncMock)
# Act.
proxy_client.launch()
# Assert.
patched_get_display_name.assert_called_once()
patched_get_manipulators.assert_called_once()
patched_run_until_complete.assert_called_once()
patched_new_event_loop.assert_called_once()
spied_info_print.assert_any_call("PLATFORM", platform_handler.get_display_name())
spied_info_print.assert_any_call("MANIPULATORS", str(DUMMY_STRING_LIST))
spied_info_print.assert_any_call("PINPOINT ID", mocker.ANY)
patched_connect.assert_awaited_once() # pyright: ignore[reportUnusedCallResult]
patched_wait.assert_awaited_once() # pyright: ignore[reportUnusedCallResult]
def test_launch_proxy_client_failed_init(
self, platform_handler: PlatformHandler, console: Console, mocker: MockerFixture
) -> None:
"""Proxy client should print info then start."""
# Add mocks and spies.
# noinspection DuplicatedCode
spied_info_print = mocker.spy(console, "info_print")
patched_get_display_name = mocker.patch.object(platform_handler, "get_display_name", return_value=DUMMY_STRING)
# Mock out get manipulators.
patched_get_manipulators = mocker.patch.object(platform_handler, "get_manipulators", new=mocker.Mock())
asyncio_loop = mocker.Mock()
patched_run_until_complete = mocker.patch.object(
asyncio_loop, "run_until_complete", return_value=GetManipulatorsResponse(manipulators=DUMMY_STRING_LIST)
)
patched_new_event_loop = mocker.patch.object(
ephys_link.back_end.server, "new_event_loop", return_value=asyncio_loop
)
# Mock out run.
def run_coroutine(coroutine: Awaitable[None]) -> None:
"""Run the coroutine."""
asyncio.new_event_loop().run_until_complete(coroutine)
_ = mocker.patch.object(ephys_link.back_end.server, "run", new=run_coroutine)
patched_connect = mocker.patch.object(AsyncClient, "connect", new_callable=mocker.AsyncMock)
patched_wait = mocker.patch.object(AsyncClient, "wait", new_callable=mocker.AsyncMock)
# Mock out the AsyncServer init.
patched_async_server = mocker.patch.object(AsyncClient, "__new__")
# Act
with pytest.raises(TypeError) as init_error:
Server(EphysLinkOptions(use_proxy=True), platform_handler, console).launch()
# Assert.
patched_async_server.assert_called_once()
patched_get_display_name.assert_called_once()
patched_get_manipulators.assert_called_once()
patched_run_until_complete.assert_called_once()
patched_new_event_loop.assert_called_once()
spied_info_print.assert_any_call("PLATFORM", platform_handler.get_display_name())
spied_info_print.assert_any_call("MANIPULATORS", str(DUMMY_STRING_LIST))
spied_info_print.assert_any_call("PINPOINT ID", mocker.ANY)
assert init_error.value.args[0] == PROXY_CLIENT_NOT_INITIALIZED_ERROR
patched_connect.assert_not_awaited() # pyright: ignore[reportUnusedCallResult]
patched_wait.assert_not_awaited() # pyright: ignore[reportUnusedCallResult]
@pytest.mark.asyncio
async def test_connect_success(self, server: Server, console: Console, mocker: MockerFixture) -> None:
"""Server should allow connection if there is no existing connection."""
# Spy console.
spied_info_print = mocker.spy(console, "info_print")
# Act.
result = await server.connect(DUMMY_STRING, DUMMY_STRING)
# Assert.
spied_info_print.assert_any_call("CONNECTION REQUEST", DUMMY_STRING)
assert server._client_sid == DUMMY_STRING # noqa: SLF001 # pyright: ignore[reportPrivateUsage]
spied_info_print.assert_any_call("CONNECTION GRANTED", DUMMY_STRING)
assert result
@pytest.mark.asyncio
async def test_connect_failure(self, server: Server, console: Console, mocker: MockerFixture) -> None:
"""Server should not allow connection if there is an existing connection."""
# Spy console.
spied_info_print = mocker.spy(console, "info_print")
spied_error_print = mocker.spy(console, "error_print")
# Mock client sid.
_ = mocker.patch.object(server, "_client_sid", new=DUMMY_STRING)
# Act.
result = await server.connect(DUMMY_STRING, DUMMY_STRING)
# Assert.
spied_info_print.assert_any_call("CONNECTION REQUEST", DUMMY_STRING)
spied_error_print.assert_called_once_with(
"CONNECTION REFUSED", cannot_connect_as_client_is_already_connected_error(DUMMY_STRING, DUMMY_STRING)
)
assert not result
@pytest.mark.asyncio
async def test_disconnect_success(self, server: Server, console: Console, mocker: MockerFixture) -> None:
"""Server should allow disconnection if the SID matches the existing connection."""
# Spy console.
spied_info_print = mocker.spy(console, "info_print")
# Mock client sid.
_ = mocker.patch.object(server, "_client_sid", new=DUMMY_STRING)
# Act.
await server.disconnect(DUMMY_STRING)
# Assert.
spied_info_print.assert_any_call("DISCONNECTION REQUEST", DUMMY_STRING)
assert server._client_sid == "" # noqa: SLF001 # pyright: ignore[reportPrivateUsage]
spied_info_print.assert_any_call("DISCONNECTED", DUMMY_STRING)
@pytest.mark.asyncio
async def test_disconnect_failure(self, server: Server, console: Console, mocker: MockerFixture) -> None:
"""Server should not allow disconnection if there is no existing connection."""
# Spy console.
spied_info_print = mocker.spy(console, "info_print")
spied_error_print = mocker.spy(console, "error_print")
# Act.
await server.disconnect(DUMMY_STRING)
# Assert.
spied_info_print.assert_any_call("DISCONNECTION REQUEST", DUMMY_STRING)
spied_error_print.assert_called_once_with(
"DISCONNECTION", client_disconnected_without_being_connected_error(DUMMY_STRING)
)
@pytest.mark.asyncio
async def test_platform_event_handler_get_version(
self, server: Server, console: Console, mocker: MockerFixture
) -> None:
"""Server should return version."""
# Spy console.
spied_info_print = mocker.spy(console, "debug_print")
# Act.
event_name = "get_version"
result = await server.platform_event_handler(event_name, DUMMY_STRING, None)
# Assert.
spied_info_print.assert_called_once_with("EVENT", event_name)
assert result == __version__
@pytest.mark.asyncio
async def test_platform_event_handler_get_pinpoint_id(
self, server: Server, console: Console, mocker: MockerFixture
) -> None:
"""Server should return pinpoint ID."""
# Spy console.
spied_info_print = mocker.spy(console, "debug_print")
# Mock Pinpoint ID.
dummy_id = DUMMY_STRING[:8]
_ = mocker.patch.object(server, "_pinpoint_id", new=dummy_id)
# Act.
event_name = "get_pinpoint_id"
result = await server.platform_event_handler(event_name, DUMMY_STRING, None)
parsed_result = PinpointIdResponse(**loads(result)) # pyright: ignore[reportAny]
# Assert.
spied_info_print.assert_called_once_with("EVENT", event_name)
assert parsed_result.pinpoint_id == dummy_id
assert not parsed_result.is_requester
@pytest.mark.asyncio
async def test_platform_event_handler_get_platform_info(
self, platform_handler: PlatformHandler, server: Server, console: Console, mocker: MockerFixture
) -> None:
"""Server should return platform info."""
# Spy console.
spied_info_print = mocker.spy(console, "debug_print")
# Mock platform info.
dummy_info = PlatformInfo(name=DUMMY_STRING, cli_name=DUMMY_STRING, axes_count=4, dimensions=DUMMY_VECTOR4)
event_name = "get_platform_info"
_ = mocker.patch.object(platform_handler, event_name, return_value=dummy_info)
# Act.
result = await server.platform_event_handler(event_name, DUMMY_STRING, None)
parsed_result = PlatformInfo(**loads(result)) # pyright: ignore[reportAny]
# Assert.
spied_info_print.assert_called_once_with("EVENT", event_name)
assert parsed_result == dummy_info
@pytest.mark.asyncio
async def test_platform_event_handler_get_manipulators(
self, platform_handler: PlatformHandler, server: Server, console: Console, mocker: MockerFixture
) -> None:
"""Server should return manipulators."""
# Spy console.
spied_info_print = mocker.spy(console, "debug_print")
# Mock manipulators.
dummy_manipulators = GetManipulatorsResponse(manipulators=DUMMY_STRING_LIST)
event_name = "get_manipulators"
_ = mocker.patch.object(platform_handler, event_name, return_value=dummy_manipulators)
# Act.
result = await server.platform_event_handler(event_name, DUMMY_STRING, None)
parsed_result = GetManipulatorsResponse(**loads(result)) # pyright: ignore[reportAny]
# Assert.
spied_info_print.assert_called_once_with("EVENT", event_name)
assert parsed_result == dummy_manipulators
@pytest.mark.asyncio
async def test_run_if_data_available_malformed_request(
self, platform_handler: PlatformHandler, server: Server, console: Console, mocker: MockerFixture
) -> None:
"""Server should raise error on malformed request."""
# Spy console.
spied_info_print = mocker.spy(console, "debug_print")
spied_error_print = mocker.spy(console, "error_print")
# Mock position.
dummy_position = PositionalResponse(position=DUMMY_VECTOR4)
event_name = "get_position"
_ = mocker.patch.object(platform_handler, event_name, return_value=dummy_position)
# Act.
result = await server.platform_event_handler(event_name, DUMMY_STRING, None)
parsed_result = loads(result) # pyright: ignore[reportAny]
# Assert.
spied_info_print.assert_called_once_with("EVENT", event_name)
spied_error_print.assert_called_once_with("MALFORMED REQUEST", f"{event_name}: {None}")
assert parsed_result == MALFORMED_REQUEST_ERROR
@pytest.mark.asyncio
async def test_platform_event_handler_get_position(
self, platform_handler: PlatformHandler, server: Server, console: Console, mocker: MockerFixture
) -> None:
"""Server should return position."""
# Spy console.
spied_info_print = mocker.spy(console, "debug_print")
# Mock position.
dummy_position = PositionalResponse(position=DUMMY_VECTOR4)
event_name = "get_position"
_ = mocker.patch.object(platform_handler, event_name, return_value=dummy_position)
# Act.
result = await server.platform_event_handler(event_name, DUMMY_STRING, DUMMY_STRING)
parsed_result = PositionalResponse(**loads(result)) # pyright: ignore[reportAny]
# Assert.
spied_info_print.assert_called_once_with("EVENT", event_name)
assert parsed_result == dummy_position
@pytest.mark.asyncio
async def test_platform_event_handler_get_angles(
self, platform_handler: PlatformHandler, server: Server, console: Console, mocker: MockerFixture
) -> None:
"""Server should return angles."""
# Spy console.
spied_info_print = mocker.spy(console, "debug_print")
# Mock angles.
dummy_angles = AngularResponse(angles=DUMMY_VECTOR3)
event_name = "get_angles"
_ = mocker.patch.object(platform_handler, event_name, return_value=dummy_angles)
# Act.
result = await server.platform_event_handler(event_name, DUMMY_STRING, DUMMY_STRING)
parsed_result = AngularResponse(**loads(result)) # pyright: ignore[reportAny]
# Assert.
spied_info_print.assert_called_once_with("EVENT", event_name)
assert parsed_result == dummy_angles
@pytest.mark.asyncio
async def test_platform_event_handler_get_shank_count(
self, platform_handler: PlatformHandler, server: Server, console: Console, mocker: MockerFixture
) -> None:
"""Server should return shank count."""
# Spy console.
spied_info_print = mocker.spy(console, "debug_print")
# Mock shank count.
dummy_shank_count = ShankCountResponse(shank_count=4)
event_name = "get_shank_count"
_ = mocker.patch.object(platform_handler, event_name, return_value=dummy_shank_count)
# Act.
result = await server.platform_event_handler(event_name, DUMMY_STRING, DUMMY_STRING)
parsed_result = ShankCountResponse(**loads(result)) # pyright: ignore[reportAny]
# Assert.
spied_info_print.assert_called_once_with("EVENT", event_name)
assert parsed_result == dummy_shank_count
@pytest.mark.asyncio
async def test_platform_event_handler_set_position(
self, platform_handler: PlatformHandler, server: Server, console: Console, mocker: MockerFixture
) -> None:
"""Server should set position."""
# Spy console.
spied_info_print = mocker.spy(console, "debug_print")
# Mock set position.
dummy_request = SetPositionRequest(manipulator_id=DUMMY_STRING, position=DUMMY_VECTOR4, speed=1)
dummy_response = PositionalResponse(position=DUMMY_VECTOR4)
event_name = "set_position"
_ = mocker.patch.object(platform_handler, event_name, return_value=dummy_response)
# Act.
result = await server.platform_event_handler(event_name, DUMMY_STRING, dummy_request.to_json_string())
parsed_result = PositionalResponse(**loads(result)) # pyright: ignore[reportAny]
# Assert.
spied_info_print.assert_called_once_with("EVENT", event_name)
assert parsed_result == dummy_response
@pytest.mark.asyncio
async def test_platform_event_handler_json_decode_error(
self, platform_handler: PlatformHandler, server: Server, console: Console, mocker: MockerFixture
) -> None:
"""Server should return error on malformed data."""
# Spy console.
spied_info_print = mocker.spy(console, "debug_print")
# Mock set position.
dummy_request = SetPositionRequest(manipulator_id=DUMMY_STRING, position=DUMMY_VECTOR4, speed=1)
event_name = "set_position"
_ = mocker.patch.object(platform_handler, event_name, return_value=PositionalResponse(position=DUMMY_VECTOR4))
# Act.
result = await server.platform_event_handler(event_name, DUMMY_STRING, dummy_request)
parsed_result = loads(result) # pyright: ignore[reportAny]
# Assert.
spied_info_print.assert_called_once_with("EVENT", event_name)
assert parsed_result == MALFORMED_REQUEST_ERROR
@pytest.mark.asyncio
async def test_platform_event_handler_parse_validation_error(
self, platform_handler: PlatformHandler, server: Server, console: Console, mocker: MockerFixture
) -> None:
"""Server should log exception and return error on invalid data."""
# Spy console.
spied_info_print = mocker.spy(console, "debug_print")
spied_exception_error_print = mocker.spy(console, "exception_error_print")
# Mock set position.
event_name = "set_position"
_ = mocker.patch.object(platform_handler, event_name, return_value=PositionalResponse(position=DUMMY_VECTOR4))
# Act.
result = await server.platform_event_handler(event_name, DUMMY_STRING, dumps({DUMMY_STRING: DUMMY_STRING}))
parsed_result = loads(result) # pyright: ignore[reportAny]
# Assert.
spied_info_print.assert_called_once_with("EVENT", event_name)
spied_exception_error_print.assert_called_once()
assert parsed_result == MALFORMED_REQUEST_ERROR
@pytest.mark.asyncio
async def test_platform_event_handler_parse_no_data_error(
self, platform_handler: PlatformHandler, server: Server, console: Console, mocker: MockerFixture
) -> None:
"""Server should return error on empty data."""
# Spy console.
spied_info_print = mocker.spy(console, "debug_print")
# Mock set position.
event_name = "set_position"
_ = mocker.patch.object(platform_handler, event_name, return_value=PositionalResponse(position=DUMMY_VECTOR4))
# Act.
result = await server.platform_event_handler(event_name, DUMMY_STRING, None)
parsed_result = loads(result) # pyright: ignore[reportAny]
# Assert.
spied_info_print.assert_called_once_with("EVENT", event_name)
assert parsed_result == MALFORMED_REQUEST_ERROR
@pytest.mark.asyncio
async def test_platform_event_handler_set_depth(
self, platform_handler: PlatformHandler, server: Server, console: Console, mocker: MockerFixture
) -> None:
"""Server should set depth."""
# Spy console.
spied_info_print = mocker.spy(console, "debug_print")
# Mock set depth.
dummy_request = SetDepthRequest(manipulator_id=DUMMY_STRING, depth=1, speed=1)
dummy_response = SetDepthResponse(depth=1)
event_name = "set_depth"
_ = mocker.patch.object(platform_handler, event_name, return_value=dummy_response)
# Act.
result = await server.platform_event_handler(event_name, DUMMY_STRING, dummy_request.to_json_string())
parsed_result = SetDepthResponse(**loads(result)) # pyright: ignore[reportAny]
# Assert.
spied_info_print.assert_called_once_with("EVENT", event_name)
assert parsed_result == dummy_response
@pytest.mark.asyncio
async def test_platform_event_handler_set_inside_brain(
self, platform_handler: PlatformHandler, server: Server, console: Console, mocker: MockerFixture
) -> None:
"""Server should set inside brain state."""
# Spy console.
spied_info_print = mocker.spy(console, "debug_print")
# Mock set depth.
dummy_request = SetInsideBrainRequest(manipulator_id=DUMMY_STRING, inside=True)
dummy_response = BooleanStateResponse(state=True)
event_name = "set_inside_brain"
_ = mocker.patch.object(platform_handler, event_name, return_value=dummy_response)
# Act.
result = await server.platform_event_handler(event_name, DUMMY_STRING, dummy_request.to_json_string())
parsed_result = BooleanStateResponse(**loads(result)) # pyright: ignore[reportAny]
# Assert.
spied_info_print.assert_called_once_with("EVENT", event_name)
assert parsed_result == dummy_response
@pytest.mark.asyncio
async def test_platform_event_handler_stop(
self, platform_handler: PlatformHandler, server: Server, console: Console, mocker: MockerFixture
) -> None:
"""Server should stop all manipulators."""
# Spy console.
spied_info_print = mocker.spy(console, "debug_print")
# Mock stop.
_ = mocker.patch.object(platform_handler, "stop", return_value="")
# Act.
event_name = "stop"
result = await server.platform_event_handler(event_name, DUMMY_STRING, DUMMY_STRING)
# Assert.
spied_info_print.assert_called_once_with("EVENT", event_name)
assert result == ""
@pytest.mark.asyncio
async def test_platform_event_handler_stop_no_data(
self, platform_handler: PlatformHandler, server: Server, console: Console, mocker: MockerFixture
) -> None:
"""Server should stop all manipulators."""
# Spy console.
spied_info_print = mocker.spy(console, "debug_print")
# Mock stop.
_ = mocker.patch.object(platform_handler, "stop", return_value="")
# Act.
event_name = "stop"
result = await server.platform_event_handler(event_name, DUMMY_STRING, None)
parsed_result = loads(result) # pyright: ignore[reportAny]
# Assert.
spied_info_print.assert_called_once_with("EVENT", event_name)
assert parsed_result == MALFORMED_REQUEST_ERROR
@pytest.mark.asyncio
async def test_platform_event_handler_stop_all(
self, platform_handler: PlatformHandler, server: Server, console: Console, mocker: MockerFixture
) -> None:
"""Server should stop all manipulators."""
# Spy console.
spied_info_print = mocker.spy(console, "debug_print")
# Mock stop.
event_name = "stop_all"
_ = mocker.patch.object(platform_handler, event_name, return_value="")
# Act.
result = await server.platform_event_handler(event_name, DUMMY_STRING, DUMMY_STRING)
# Assert.
spied_info_print.assert_called_once_with("EVENT", event_name)
assert result == ""
@pytest.mark.asyncio
async def test_platform_event_handler_unknown_event(
self, server: Server, console: Console, mocker: MockerFixture
) -> None:
"""Server should stop all manipulators."""
# Spy console.
spied_info_print = mocker.spy(console, "debug_print")
spied_error_print = mocker.spy(console, "error_print")
# Act.
event_name = DUMMY_STRING
result = await server.platform_event_handler(event_name, DUMMY_STRING, DUMMY_STRING)
parsed_result = loads(result) # pyright: ignore[reportAny]
# Assert.
spied_info_print.assert_called_once_with("EVENT", event_name)
spied_error_print.assert_called_once_with("EVENT", f"Unknown event: {event_name}.")
assert parsed_result == UNKNOWN_EVENT_ERROR