Consolidate information into ScanData, remove ad-hoc differences for specific error in _run_scan
This commit is contained in:
Julian Stirling
parent
82691a6b78
commit
4e9b07c78f
4 changed files with 56 additions and 100 deletions
|
|
@ -35,6 +35,7 @@ def _fake_scan_data(**kwargs) -> ScanData:
|
|||
"""
|
||||
data_dict = {
|
||||
"scan_name": "fake_scan_0001",
|
||||
"starting_position": {"x": 123, "y": 456, "z": 789},
|
||||
"overlap": 0.1,
|
||||
"max_dist": 100000,
|
||||
"dx": 100,
|
||||
|
|
@ -56,17 +57,19 @@ def test_set_final_data():
|
|||
"""Check that adding final data to a ScanData object works as expected."""
|
||||
scan_data = _fake_scan_data()
|
||||
|
||||
assert scan_data.final_image_count is None
|
||||
assert scan_data.image_count == 0
|
||||
assert scan_data.duration is None
|
||||
assert scan_data.scan_result is None
|
||||
|
||||
# Quickly take 123 images!
|
||||
scan_data.image_count += 123
|
||||
# Should set duration based of finishing at datetime.now()
|
||||
scan_data.set_final_data(result="Success", final_image_count=123)
|
||||
scan_data.set_final_data(result="Success")
|
||||
expected_duration = datetime.now() - MOCK_START_TIME
|
||||
expected_duration_s = expected_duration.total_seconds()
|
||||
scan_duration_s = scan_data.duration.total_seconds()
|
||||
|
||||
assert scan_data.final_image_count == 123
|
||||
assert scan_data.image_count == 123
|
||||
assert expected_duration_s - 1 < scan_duration_s < expected_duration_s + 1
|
||||
assert scan_data.scan_result == "Success"
|
||||
|
||||
|
|
@ -77,15 +80,16 @@ def test_custom_serialisation():
|
|||
# Serialise to string then load directly as json
|
||||
scan_data_dict = json.loads(scan_data.model_dump_json())
|
||||
assert scan_data_dict["start_time"] == "11_00_00-25_12_2024"
|
||||
assert scan_data_dict["final_image_count"] == "Unknown"
|
||||
assert scan_data_dict["image_count"] == 0
|
||||
assert scan_data_dict["duration"] == "Unknown"
|
||||
assert scan_data_dict["scan_result"] == "Unknown"
|
||||
|
||||
scan_data.set_final_data(result="Success", final_image_count=123)
|
||||
scan_data.image_count += 123
|
||||
scan_data.set_final_data(result="Success")
|
||||
# Can't mock datetime.now as datetime is immutable. So just replace duraction
|
||||
scan_data.duration = MOCK_END_TIME - scan_data.start_time
|
||||
scan_data_dict = json.loads(scan_data.model_dump_json())
|
||||
assert scan_data_dict["final_image_count"] == 123
|
||||
assert scan_data_dict["image_count"] == 123
|
||||
assert scan_data_dict["duration"] == "1:29:03"
|
||||
assert scan_data_dict["scan_result"] == "Success"
|
||||
|
||||
|
|
@ -106,7 +110,8 @@ def test_round_trip_finalised():
|
|||
"""Check that finalised ScanData can be serialised and deserialised."""
|
||||
scan_data = _fake_scan_data()
|
||||
# Finalise the data.
|
||||
scan_data.set_final_data(result="Success", final_image_count=123)
|
||||
scan_data.image_count += 123
|
||||
scan_data.set_final_data(result="Success")
|
||||
|
||||
scan_data_dict = json.loads(scan_data.model_dump_json())
|
||||
scan_data_reloaded = ScanData(**scan_data_dict)
|
||||
|
|
|
|||
|
|
@ -177,7 +177,6 @@ def _run_only_outer_scan(adjust_initial_state: Optional[Callable] = None):
|
|||
af_mock = MockAutoFocusThing()
|
||||
stage_mock = MockStageThing()
|
||||
cam_mock = MockCameraThing()
|
||||
meta_mock = 5 # not called
|
||||
csm_mock = MockCSMThing()
|
||||
|
||||
class MockedSmartScanThing(SmartScanThing):
|
||||
|
|
@ -196,9 +195,7 @@ def _run_only_outer_scan(adjust_initial_state: Optional[Callable] = None):
|
|||
assert self._autofocus is af_mock
|
||||
assert self._stage is stage_mock
|
||||
assert self._cam is cam_mock
|
||||
assert self._metadata_getter is meta_mock
|
||||
assert self._csm is csm_mock
|
||||
assert self._scan_images_taken == 0
|
||||
|
||||
# mock smart scan thing
|
||||
mock_ss_thing = MockedSmartScanThing(SCAN_DIR)
|
||||
|
|
@ -214,7 +211,6 @@ def _run_only_outer_scan(adjust_initial_state: Optional[Callable] = None):
|
|||
autofocus=af_mock,
|
||||
stage=stage_mock,
|
||||
cam=cam_mock,
|
||||
metadata_getter=meta_mock,
|
||||
csm=csm_mock,
|
||||
scan_name="FooBar",
|
||||
)
|
||||
|
|
@ -228,9 +224,7 @@ def _run_only_outer_scan(adjust_initial_state: Optional[Callable] = None):
|
|||
assert mock_ss_thing._autofocus is None
|
||||
assert mock_ss_thing._stage is None
|
||||
assert mock_ss_thing._cam is None
|
||||
assert mock_ss_thing._metadata_getter is None
|
||||
assert mock_ss_thing._csm is None
|
||||
assert mock_ss_thing._scan_images_taken is None
|
||||
|
||||
# Return the mock thing for further state testing, and the
|
||||
# exec_info of any uncaught exceptions that were raised
|
||||
|
|
@ -260,10 +254,16 @@ def test_outer_scan_wo_sample_skip():
|
|||
assert mock_ss_thing.mock_call_count["_run_scan"] == 1
|
||||
|
||||
|
||||
MOCK_SCAN_NAME = "test_name_0001"
|
||||
MOCK_SCAN_DIR = "scans/test_name_0001/images/"
|
||||
MOCK_START_POS = {"x": 123, "y": 456, "z": 789}
|
||||
|
||||
|
||||
def _expected_scan_data():
|
||||
"""Return the expected ScanData object for a SmartScan with default properties."""
|
||||
expected_dict = {
|
||||
"scan_name": "test_name_0001",
|
||||
"scan_name": MOCK_SCAN_NAME,
|
||||
"starting_position": MOCK_START_POS,
|
||||
"overlap": 0.45,
|
||||
"max_dist": 45000,
|
||||
"dx": 100,
|
||||
|
|
@ -287,11 +287,13 @@ def scan_thing_mocked_for_scan_data(smart_scan_thing, mocker):
|
|||
smart_scan_thing, "_calc_displacement_from_test_image", return_value=[100, 100]
|
||||
)
|
||||
mock_ongoing_scan = mocker.Mock()
|
||||
type(mock_ongoing_scan).name = mocker.PropertyMock(return_value="test_name_0001")
|
||||
type(mock_ongoing_scan).images_dir = mocker.PropertyMock(
|
||||
return_value="scans/test_name_0001/images/"
|
||||
)
|
||||
type(mock_ongoing_scan).name = mocker.PropertyMock(return_value=MOCK_SCAN_NAME)
|
||||
type(mock_ongoing_scan).images_dir = mocker.PropertyMock(return_value=MOCK_SCAN_DIR)
|
||||
mock_stage = mocker.Mock()
|
||||
type(mock_stage).position = mocker.PropertyMock(return_value=MOCK_START_POS)
|
||||
|
||||
smart_scan_thing._ongoing_scan = mock_ongoing_scan
|
||||
smart_scan_thing._stage = mock_stage
|
||||
return smart_scan_thing
|
||||
|
||||
|
||||
|
|
@ -313,7 +315,7 @@ def test_save_final_scan_data(scan_thing_mocked_for_scan_data):
|
|||
scan_thing = scan_thing_mocked_for_scan_data
|
||||
|
||||
scan_thing._scan_data = scan_thing._collect_scan_data()
|
||||
scan_thing._scan_images_taken = 44
|
||||
scan_thing._scan_data.image_count = 44
|
||||
scan_thing._save_final_scan_data("Mocked!")
|
||||
# _ongoing_scan is a mock so we can check that save_scan data was called and get
|
||||
# the value
|
||||
|
|
@ -321,7 +323,7 @@ def test_save_final_scan_data(scan_thing_mocked_for_scan_data):
|
|||
final_data = scan_thing._ongoing_scan.save_scan_data.call_args[0][0]
|
||||
assert isinstance(final_data, ScanData)
|
||||
assert final_data.scan_result == "Mocked!"
|
||||
assert final_data.final_image_count == 44
|
||||
assert final_data.image_count == 44
|
||||
assert final_data.duration.total_seconds() < 1
|
||||
|
||||
|
||||
|
|
@ -335,7 +337,6 @@ def scan_thing_mocked_for_run_scan(scan_thing_mocked_for_scan_data, mocker):
|
|||
"""
|
||||
scan_thing = scan_thing_mocked_for_scan_data
|
||||
scan_thing._cam = MockCameraThing()
|
||||
scan_thing._scan_images_taken = 0
|
||||
mocker.patch.object(scan_thing, "_cancel")
|
||||
mocker.patch.object(scan_thing, "_main_scan_loop")
|
||||
mocker.patch.object(scan_thing, "_return_to_starting_position")
|
||||
|
|
@ -364,7 +365,7 @@ def check_run_scan(scan_thing, caplog, expected_exception=None):
|
|||
with pytest.raises(expected_exception), caplog.at_level(logging.WARNING):
|
||||
scan_thing._scan_data = scan_thing._run_scan()
|
||||
# The preview stitcher object should still exist. And images dir should be set.
|
||||
assert scan_thing._preview_stitcher.images_dir == "scans/test_name_0001/images/"
|
||||
assert scan_thing._preview_stitcher.images_dir == MOCK_SCAN_DIR
|
||||
|
||||
final_scan_data = scan_thing._ongoing_scan.save_scan_data.call_args[0][0]
|
||||
calls = {
|
||||
|
|
@ -396,34 +397,6 @@ def test_run_scan(scan_thing_mocked_for_run_scan, caplog):
|
|||
assert calls == expected_calls_numbers
|
||||
|
||||
|
||||
def test_run_scan_wrong_image_value(scan_thing_mocked_for_run_scan, caplog):
|
||||
"""Check correct methods called if _scan_images_taken doesn't start at 0.
|
||||
|
||||
This should never happen but shows a good clear path for an error before
|
||||
_main_scan_loop starts.
|
||||
"""
|
||||
scan_thing = scan_thing_mocked_for_run_scan
|
||||
scan_thing._scan_images_taken = 2
|
||||
|
||||
result, logs, calls = check_run_scan(scan_thing, caplog, RuntimeError)
|
||||
|
||||
assert result.startswith("RuntimeError:")
|
||||
assert len(logs) == 1
|
||||
assert logs[0].levelno == logging.ERROR
|
||||
|
||||
# Main loop not run, nor are return to start, final stitch, or purging of empty
|
||||
# scans. Save scan data is still called twice
|
||||
expected_calls_numbers = {
|
||||
"cam_start_streaming_calls": 2,
|
||||
"main_scan_loop_calls": 0,
|
||||
"return_to_start_calls": 0,
|
||||
"perform_final_stitch_calls": 0,
|
||||
"purge_empty_scans_calls": 0,
|
||||
"save_scan_data_calls": 2,
|
||||
}
|
||||
assert calls == expected_calls_numbers
|
||||
|
||||
|
||||
def test_run_scan_err_in_main_loop(scan_thing_mocked_for_run_scan, caplog, mocker):
|
||||
"""Check correct methods called if main_loop errors."""
|
||||
scan_thing = scan_thing_mocked_for_run_scan
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue