bec/bec_lib/tests/test_scan_report.py
Mathias Guijarro 8bbfd10ca7 refactor(messages)!: messages refactoring, new serialization module
To have a better separation of concern between messages and how they are conveyed in connectors.
BECMessage can be simple dataclasses, leaving the serialization to the connector which transport those.
The serialization module itself can be isolated, and in the case of msgpack it can be extended to
understand how to encode/decode BECMessage, to simplify writing code like with BundleMessage or to
be able to automatically encode numpy or BECStatus objects.
Finally, client objects (producers and consumers) can receive BECMessage objects instead of having
to dump or load themselves.
2024-02-07 12:43:52 +01:00

111 lines
4.1 KiB
Python

from unittest import mock
import pytest
from bec_lib import messages
from bec_lib.bec_errors import ScanAbortion
from bec_lib.scan_report import ScanReport
# pylint: skip-file
@pytest.fixture
def scan_report():
report = ScanReport()
report._client = mock.MagicMock()
report._queue_item = mock.MagicMock()
report.request = mock.MagicMock()
yield report
def test_scan_report_wait_mv(scan_report):
scan_report.request.request = messages.ScanQueueMessage(scan_type="mv", parameter={})
with mock.patch.object(scan_report, "_wait_move") as wait_move:
scan_report.wait()
wait_move.assert_called_once_with(None, 0.1)
def test_scan_report_wait_mv_timeout(scan_report):
scan_report.request.request = messages.ScanQueueMessage(scan_type="mv", parameter={})
with mock.patch.object(scan_report, "_wait_move") as wait_move:
scan_report.wait(10)
wait_move.assert_called_once_with(10, 0.1)
def test_scan_report_wait_scan(scan_report):
scan_report.request.request = messages.ScanQueueMessage(scan_type="line_scan", parameter={})
with mock.patch.object(scan_report, "_wait_scan") as wait_scan:
scan_report.wait()
wait_scan.assert_called_once_with(None, 0.1)
@pytest.mark.parametrize("timeout, elapsed_time", [(10, 0.1), (None, 0.1), (0.1, 10)])
def test_scan_report_check_timeout(timeout, elapsed_time):
report = ScanReport()
if timeout is None or timeout > elapsed_time:
report._check_timeout(timeout, elapsed_time)
else:
with pytest.raises(TimeoutError):
report._check_timeout(timeout, elapsed_time)
def test_scan_report_wait_move(scan_report):
scan_report.request.request = messages.ScanQueueMessage(scan_type="mv", parameter={})
with mock.patch.object(scan_report, "_get_mv_status") as get_mv_status:
get_mv_status.side_effect = [False, False, True]
scan_report._wait_move(None, 0.1)
assert get_mv_status.call_count == 3
assert scan_report._client.alarm_handler.raise_alarms.call_count == 2
def test_scan_report_wait_for_scan(scan_report):
scan_report.request.request = messages.ScanQueueMessage(scan_type="mv", parameter={})
with mock.patch.object(scan_report, "_get_mv_status") as get_mv_status:
get_mv_status.side_effect = [False, False, True]
scan_report.queue_item.status = "COMPLETED"
scan_report._wait_scan(None, 0.1)
def test_scan_report_wait_for_scan_raises(scan_report):
scan_report.request.request = messages.ScanQueueMessage(scan_type="mv", parameter={})
with mock.patch.object(scan_report, "_get_mv_status") as get_mv_status:
get_mv_status.side_effect = [False, False, True]
scan_report.queue_item.status = "STOPPED"
with pytest.raises(ScanAbortion):
scan_report._wait_scan(None, 0.1)
def test_scan_report_aborts_on_ctrl_c(scan_report):
scan_report.request.request = messages.ScanQueueMessage(scan_type="mv", parameter={})
with mock.patch.object(scan_report, "_wait_move") as mock_wait_move:
mock_wait_move.side_effect = [KeyboardInterrupt]
with pytest.raises(ScanAbortion):
scan_report.wait()
assert scan_report._client.queue.request_scan_abortion.call_count == 1
@pytest.mark.parametrize(
"lrange_return, expected",
[
([], False),
(
[messages.DeviceRPCMessage(device="samx", return_val=5, out="done", success=True)],
False,
),
(
[
messages.DeviceRPCMessage(device="samx", return_val=5, out="done", success=True),
messages.DeviceRPCMessage(device="samy", return_val=5, out="done", success=True),
],
True,
),
],
)
def test_scan_report_get_mv_status(scan_report, lrange_return, expected):
scan_report.request.request = messages.ScanQueueMessage(
scan_type="mv", parameter={"args": {"samx": [5], "samy": [5]}}
)
with mock.patch.object(scan_report._client.device_manager.producer, "lrange") as mock_lrange:
mock_lrange.return_value = lrange_return
assert scan_report._get_mv_status() == expected