Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use production grid detection plan in unit tests #721

Merged
merged 12 commits into from
Jan 8, 2025
Merged

Use production grid detection plan in unit tests #721

Changes from 6 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
5e43df3
Add mock generators for test
Dec 16, 2024
d2b1093
Assert number of triggers passes
Dec 17, 2024
c574f9e
Unit tests side by side to compare fake with real plan
Dec 18, 2024
bbfc378
Amend unit test
Dec 18, 2024
121b937
Merge branch 'main' into 611_use_prod_grid_detection_in_tests
Dec 18, 2024
5d116ee
chore: Remove fake grid detection plan
Dec 18, 2024
434980c
Outline sketch of PR changes
rtuck99 Dec 20, 2024
487c2c1
Use pin tip detection fixture for tests
Jan 2, 2025
c9a0cf2
Merge branch 'main' into 611_use_prod_grid_detection_in_tests
shihab-dls Jan 2, 2025
3182ea0
Merge branch 'main' into 611_use_prod_grid_detection_in_tests
shihab-dls Jan 7, 2025
bf28fbb
Remove comment
Jan 7, 2025
e3429ce
Merge branch 'main' into 611_use_prod_grid_detection_in_tests
rtuck99 Jan 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
120 changes: 82 additions & 38 deletions tests/unit_tests/hyperion/experiment_plans/test_grid_detect_then_xray_centre_plan.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
from unittest.mock import ANY, MagicMock, patch

import bluesky.plan_stubs as bps
import numpy as np
import pytest
from bluesky.run_engine import RunEngine
from bluesky.simulators import RunEngineSimulator, assert_message_and_return_remaining
Expand All @@ -19,7 +20,6 @@
)
from mx_bluesky.hyperion.experiment_plans.grid_detect_then_xray_centre_plan import (
GridDetectThenXRayCentreComposite,
OavGridDetectionComposite,
detect_grid_and_do_gridscan,
grid_detect_then_xray_centre,
)
Expand All @@ -35,34 +35,34 @@
from .conftest import FLYSCAN_RESULT_LOW, FLYSCAN_RESULT_MED, sim_fire_event_on_open_run


def _fake_grid_detection(
devices: OavGridDetectionComposite,
parameters: OAVParameters,
snapshot_template: str,
snapshot_dir: str,
grid_width_microns: float = 0,
box_size_um: float = 0.0,
):
oav = devices.oav
set_mock_value(oav.grid_snapshot.box_width, 635)
# first grid detection: x * y
set_mock_value(oav.grid_snapshot.num_boxes_x, 10)
set_mock_value(oav.grid_snapshot.num_boxes_y, 4)
yield from bps.create(CONST.DESCRIPTORS.OAV_GRID_SNAPSHOT_TRIGGERED)
yield from bps.read(oav) # type: ignore # See: https://github.com/bluesky/bluesky/issues/1809
yield from bps.read(devices.smargon)
yield from bps.save()

# second grid detection: x * z, so num_boxes_y refers to smargon z
set_mock_value(oav.grid_snapshot.num_boxes_x, 10)
set_mock_value(oav.grid_snapshot.num_boxes_y, 1)
yield from bps.create(CONST.DESCRIPTORS.OAV_GRID_SNAPSHOT_TRIGGERED)
yield from bps.read(oav) # type: ignore # See: https://github.com/bluesky/bluesky/issues/1809
yield from bps.read(devices.smargon)
yield from bps.save()
def _fake_flyscan(*args):
yield from _fire_xray_centre_result_event([FLYSCAN_RESULT_MED, FLYSCAN_RESULT_LOW])


def _fake_generator_array(values):
return [_fake_generator(value) for value in values]


def _fake_generator(value):
yield from bps.null()
return value


def _setup_grid_detection(
mock_rd, mock_pre_centring_setup_oav, mock_wait_for_tip_to_be_found
):
mock_rd.side_effect = _fake_generator_array(
shihab-dls marked this conversation as resolved.
Show resolved Hide resolved
[0.031496, 0.05, [0], [1600], 10, [0], [400], 10]
)

mock_pre_centring_setup_oav.side_effect = _fake_generator_array(
None for _ in range(2)
)
mock_wait_for_tip_to_be_found.side_effect = _fake_generator_array(
[np.array([0, 0]) for _ in range(2)]
)


def test_full_grid_scan(
test_fgs_params: HyperionThreeDGridScan, test_config_files: dict[str, str]
):
Expand All @@ -81,11 +81,21 @@ def grid_detect_devices_with_oav_config_params(
test_config_files: dict[str, str],
) -> GridDetectThenXRayCentreComposite:
set_mock_value(grid_detect_devices.oav.zoom_controller.level, "7.5x")
grid_detect_devices.pin_tip_detection.triggered_bottom_edge = MagicMock()
grid_detect_devices.pin_tip_detection.triggered_top_edge = MagicMock()
return grid_detect_devices


@patch(
"mx_bluesky.hyperion.experiment_plans.grid_detect_then_xray_centre_plan.grid_detection_plan",
"mx_bluesky.hyperion.experiment_plans.oav_grid_detection_plan.bps.rd",
shihab-dls marked this conversation as resolved.
Show resolved Hide resolved
autospec=True,
)
@patch(
"mx_bluesky.hyperion.experiment_plans.oav_grid_detection_plan.pre_centring_setup_oav",
autospec=True,
)
@patch(
"mx_bluesky.hyperion.experiment_plans.oav_grid_detection_plan.wait_for_tip_to_be_found",
autospec=True,
)
@patch(
Expand All @@ -94,13 +104,17 @@ def grid_detect_devices_with_oav_config_params(
)
async def test_detect_grid_and_do_gridscan(
mock_flyscan: MagicMock,
mock_grid_detection_plan: MagicMock,
mock_wait_for_tip_to_be_found: MagicMock,
mock_pre_centring_setup_oav: MagicMock,
mock_rd: MagicMock,
grid_detect_devices_with_oav_config_params: GridDetectThenXRayCentreComposite,
RE: RunEngine,
test_full_grid_scan_params: GridScanWithEdgeDetect,
test_config_files: dict,
):
mock_grid_detection_plan.side_effect = _fake_grid_detection
_setup_grid_detection(
mock_rd, mock_pre_centring_setup_oav, mock_wait_for_tip_to_be_found
)

composite = grid_detect_devices_with_oav_config_params

Expand All @@ -112,8 +126,9 @@ async def test_detect_grid_and_do_gridscan(
test_full_grid_scan_params,
)
)

# Verify we called the grid detection plan
mock_grid_detection_plan.assert_called_once()
mock_pre_centring_setup_oav.assert_called_once()

# Check backlight was moved OUT
get_mock_put(composite.backlight.position).assert_called_once_with(
Expand Down Expand Up @@ -142,7 +157,15 @@ def _do_detect_grid_and_gridscan_then_wait_for_backlight(


@patch(
"mx_bluesky.hyperion.experiment_plans.grid_detect_then_xray_centre_plan.grid_detection_plan",
"mx_bluesky.hyperion.experiment_plans.oav_grid_detection_plan.bps.rd",
autospec=True,
)
@patch(
"mx_bluesky.hyperion.experiment_plans.oav_grid_detection_plan.pre_centring_setup_oav",
autospec=True,
)
@patch(
"mx_bluesky.hyperion.experiment_plans.oav_grid_detection_plan.wait_for_tip_to_be_found",
autospec=True,
)
@patch(
Expand All @@ -151,15 +174,22 @@ def _do_detect_grid_and_gridscan_then_wait_for_backlight(
)
def test_when_full_grid_scan_run_then_parameters_sent_to_fgs_as_expected(
mock_flyscan: MagicMock,
mock_grid_detection_plan: MagicMock,
mock_wait_for_tip_to_be_found: MagicMock,
mock_pre_centring_setup_oav: MagicMock,
mock_rd: MagicMock,
grid_detect_devices_with_oav_config_params: GridDetectThenXRayCentreComposite,
RE: RunEngine,
test_full_grid_scan_params: GridScanWithEdgeDetect,
test_config_files: dict,
):
oav_params = OAVParameters("xrayCentring", test_config_files["oav_config_json"])

mock_grid_detection_plan.side_effect = _fake_grid_detection
_setup_grid_detection(
mock_rd, mock_pre_centring_setup_oav, mock_wait_for_tip_to_be_found
)

test_full_grid_scan_params.grid_width_um = 200
shihab-dls marked this conversation as resolved.
Show resolved Hide resolved

RE(
ispyb_activation_wrapper(
detect_grid_and_do_gridscan(
Expand All @@ -174,7 +204,6 @@ def test_when_full_grid_scan_run_then_parameters_sent_to_fgs_as_expected(
params: HyperionThreeDGridScan = mock_flyscan.call_args[0][1]

assert params.detector_params.num_triggers == 50

assert params.FGS_params.x_axis.full_steps == 10
assert params.FGS_params.y_axis.end == pytest.approx(1.511, 0.001)

Expand Down Expand Up @@ -238,27 +267,41 @@ def test_detect_grid_and_do_gridscan_does_not_activate_ispyb_callback(


@patch(
"mx_bluesky.hyperion.experiment_plans.grid_detect_then_xray_centre_plan.change_aperture_then_move_to_xtal",
"mx_bluesky.hyperion.experiment_plans.oav_grid_detection_plan.bps.rd",
autospec=True,
)
@patch(
"mx_bluesky.hyperion.experiment_plans.grid_detect_then_xray_centre_plan.grid_detection_plan",
"mx_bluesky.hyperion.experiment_plans.oav_grid_detection_plan.pre_centring_setup_oav",
autospec=True,
)
@patch(
"mx_bluesky.hyperion.experiment_plans.oav_grid_detection_plan.wait_for_tip_to_be_found",
autospec=True,
)
@patch(
"mx_bluesky.hyperion.experiment_plans.grid_detect_then_xray_centre_plan.change_aperture_then_move_to_xtal",
autospec=True,
side_effect=_fake_grid_detection,
)
@patch(
"mx_bluesky.hyperion.experiment_plans.grid_detect_then_xray_centre_plan.flyscan_xray_centre_no_move",
autospec=True,
side_effect=_fake_flyscan,
)
def test_grid_detect_then_xray_centre_centres_on_the_first_flyscan_result(
mock_flyscan: MagicMock,
mock_grid_detection_plan: MagicMock,
mock_change_aperture_then_move_to_xtal: MagicMock,
mock_wait_for_tip_to_be_found: MagicMock,
mock_pre_centring_setup_oav: MagicMock,
mock_rd: MagicMock,
grid_detect_devices_with_oav_config_params: GridDetectThenXRayCentreComposite,
test_full_grid_scan_params: GridScanWithEdgeDetect,
test_config_files: dict[str, str],
RE: RunEngine,
):
_setup_grid_detection(
mock_rd, mock_pre_centring_setup_oav, mock_wait_for_tip_to_be_found
)

RE(
grid_detect_then_xray_centre(
grid_detect_devices_with_oav_config_params,
Expand All @@ -267,6 +310,7 @@ def test_grid_detect_then_xray_centre_centres_on_the_first_flyscan_result(
)
)
mock_change_aperture_then_move_to_xtal.assert_called_once()

assert (
mock_change_aperture_then_move_to_xtal.mock_calls[0].args[0]
== FLYSCAN_RESULT_MED
Expand Down
Loading