0
0
mirror of https://github.com/bec-project/bec_widgets.git synced 2025-07-13 19:21:50 +02:00
Files
bec_widgets/tests/unit_tests/test_waveform_widget.py

574 lines
21 KiB
Python

from unittest.mock import MagicMock, patch
import pyqtgraph as pg
import pytest
from qtpy.QtGui import QColor
from qtpy.QtWidgets import QApplication
from bec_widgets.qt_utils.settings_dialog import SettingsDialog
from bec_widgets.utils.colors import apply_theme, get_theme_palette, set_theme
from bec_widgets.utils.linear_region_selector import LinearRegionWrapper
from bec_widgets.widgets.containers.figure.plots.axis_settings import AxisSettings
from bec_widgets.widgets.plots.waveform.waveform_popups.curve_dialog.curve_dialog import (
CurveSettings,
)
from bec_widgets.widgets.plots.waveform.waveform_popups.dap_summary_dialog.dap_summary_dialog import (
FitSummaryWidget,
)
from bec_widgets.widgets.plots.waveform.waveform_widget import BECWaveformWidget
from .client_mocks import mocked_client
from .conftest import create_widget
@pytest.fixture
def waveform_widget(qtbot, mocked_client):
models = ["GaussianModel", "LorentzModel", "SineModel"]
mocked_client.dap._available_dap_plugins.keys.return_value = models
widget = BECWaveformWidget(client=mocked_client())
qtbot.addWidget(widget)
qtbot.waitExposed(widget)
yield widget
@pytest.fixture
def mock_waveform(waveform_widget):
waveform_mock = MagicMock()
waveform_widget.waveform = waveform_mock
return waveform_mock
def test_waveform_widget_init(waveform_widget):
assert waveform_widget is not None
assert waveform_widget.client is not None
assert isinstance(waveform_widget, BECWaveformWidget)
assert waveform_widget.config.widget_class == "BECWaveformWidget"
###################################
# Wrapper methods for Waveform
###################################
def test_waveform_widget_get_curve(waveform_widget, mock_waveform):
waveform_widget.get_curve("curve_id")
waveform_widget.waveform.get_curve.assert_called_once_with("curve_id")
def test_waveform_widget_set_colormap(waveform_widget, mock_waveform):
waveform_widget.set_colormap("colormap")
waveform_widget.waveform.set_colormap.assert_called_once_with("colormap")
def test_waveform_widget_set_x(waveform_widget, mock_waveform):
waveform_widget.set_x("samx", "samx")
waveform_widget.waveform.set_x.assert_called_once_with("samx", "samx")
def test_waveform_plot_data(waveform_widget, mock_waveform):
waveform_widget.plot(x=[1, 2, 3], y=[1, 2, 3])
waveform_widget.waveform.plot.assert_called_once_with(
arg1=None,
x=[1, 2, 3],
y=[1, 2, 3],
x_name=None,
y_name=None,
z_name=None,
x_entry=None,
y_entry=None,
z_entry=None,
color=None,
color_map_z="magma",
label=None,
validate=True,
dap=None,
)
def test_waveform_plot_scan_curves(waveform_widget, mock_waveform):
waveform_widget.plot(x_name="samx", y_name="samy", dap="GaussianModel")
waveform_widget.waveform.plot.assert_called_once_with(
arg1=None,
x=None,
y=None,
x_name="samx",
y_name="samy",
z_name=None,
x_entry=None,
y_entry=None,
z_entry=None,
color=None,
color_map_z="magma",
label=None,
validate=True,
dap="GaussianModel",
)
def test_waveform_widget_add_dap(waveform_widget, mock_waveform):
waveform_widget.add_dap(x_name="samx", y_name="bpm4i", dap="GaussianModel")
waveform_widget.waveform.add_dap.assert_called_once_with(
x_name="samx",
y_name="bpm4i",
x_entry=None,
y_entry=None,
color=None,
dap="GaussianModel",
validate_bec=True,
)
def test_waveform_widget_get_dap_params(waveform_widget, mock_waveform):
waveform_widget.get_dap_params()
waveform_widget.waveform.get_dap_params.assert_called_once()
def test_waveform_widget_get_dap_summary(waveform_widget, mock_waveform):
waveform_widget.get_dap_summary()
waveform_widget.waveform.get_dap_summary.assert_called_once()
def test_waveform_widget_remove_curve(waveform_widget, mock_waveform):
waveform_widget.remove_curve("curve_id")
waveform_widget.waveform.remove_curve.assert_called_once_with("curve_id")
def test_waveform_widget_scan_history(waveform_widget, mock_waveform):
waveform_widget.scan_history(0)
waveform_widget.waveform.scan_history.assert_called_once_with(0, None)
def test_waveform_widget_get_all_data(waveform_widget, mock_waveform):
waveform_widget.get_all_data()
waveform_widget.waveform.get_all_data.assert_called_once()
def test_waveform_widget_set_title(waveform_widget, mock_waveform):
waveform_widget.set_title("Title")
waveform_widget.waveform.set_title.assert_called_once_with("Title")
def test_waveform_widget_set_base(waveform_widget, mock_waveform):
waveform_widget.set(
title="Test Title",
x_label="X Label",
y_label="Y Label",
x_scale="linear",
y_scale="log",
x_lim=(0, 10),
y_lim=(0, 10),
legend_label_size=12,
)
waveform_widget.waveform.set.assert_called_once_with(
title="Test Title",
x_label="X Label",
y_label="Y Label",
x_scale="linear",
y_scale="log",
x_lim=(0, 10),
y_lim=(0, 10),
legend_label_size=12,
)
def test_waveform_widget_set_x_label(waveform_widget, mock_waveform):
waveform_widget.set_x_label("X Label")
waveform_widget.waveform.set_x_label.assert_called_once_with("X Label")
def test_waveform_widget_set_y_label(waveform_widget, mock_waveform):
waveform_widget.set_y_label("Y Label")
waveform_widget.waveform.set_y_label.assert_called_once_with("Y Label")
def test_waveform_widget_set_x_scale(waveform_widget, mock_waveform):
waveform_widget.set_x_scale("linear")
waveform_widget.waveform.set_x_scale.assert_called_once_with("linear")
def test_waveform_widget_set_y_scale(waveform_widget, mock_waveform):
waveform_widget.set_y_scale("log")
waveform_widget.waveform.set_y_scale.assert_called_once_with("log")
def test_waveform_widget_set_x_lim(waveform_widget, mock_waveform):
waveform_widget.set_x_lim((0, 10))
waveform_widget.waveform.set_x_lim.assert_called_once_with((0, 10))
def test_waveform_widget_set_y_lim(waveform_widget, mock_waveform):
waveform_widget.set_y_lim((0, 10))
waveform_widget.waveform.set_y_lim.assert_called_once_with((0, 10))
def test_waveform_widget_set_legend_label_size(waveform_widget, mock_waveform):
waveform_widget.set_legend_label_size(12)
waveform_widget.waveform.set_legend_label_size.assert_called_once_with(12)
def test_waveform_widget_set_auto_range(waveform_widget, mock_waveform):
waveform_widget.set_auto_range(True, "xy")
waveform_widget.waveform.set_auto_range.assert_called_once_with(True, "xy")
def test_waveform_widget_set_grid(waveform_widget, mock_waveform):
waveform_widget.set_grid(True, False)
waveform_widget.waveform.set_grid.assert_called_once_with(True, False)
def test_waveform_widget_lock_aspect_ratio(waveform_widget, mock_waveform):
waveform_widget.lock_aspect_ratio(True)
waveform_widget.waveform.lock_aspect_ratio.assert_called_once_with(True)
def test_waveform_widget_export(waveform_widget, mock_waveform):
waveform_widget.export()
waveform_widget.waveform.export.assert_called_once()
###################################
# ToolBar interactions
###################################
def test_toolbar_drag_mode_action_triggered(waveform_widget, qtbot):
action_drag = waveform_widget.toolbar.widgets["drag_mode"].action
action_rectangle = waveform_widget.toolbar.widgets["rectangle_mode"].action
action_drag.trigger()
assert action_drag.isChecked() == True
assert action_rectangle.isChecked() == False
def test_toolbar_rectangle_mode_action_triggered(waveform_widget, qtbot):
action_drag = waveform_widget.toolbar.widgets["drag_mode"].action
action_rectangle = waveform_widget.toolbar.widgets["rectangle_mode"].action
action_rectangle.trigger()
assert action_drag.isChecked() == False
assert action_rectangle.isChecked() == True
def test_toolbar_auto_range_action_triggered(waveform_widget, mock_waveform, qtbot):
action = waveform_widget.toolbar.widgets["auto_range"].action
action.trigger()
qtbot.wait(200)
waveform_widget.waveform.set_auto_range.assert_called_once_with(True, "xy")
def test_enable_mouse_pan_mode(qtbot, waveform_widget):
action_drag = waveform_widget.toolbar.widgets["drag_mode"].action
action_rectangle = waveform_widget.toolbar.widgets["rectangle_mode"].action
mock_view_box = MagicMock()
waveform_widget.waveform.plot_item.getViewBox = MagicMock(return_value=mock_view_box)
waveform_widget.enable_mouse_pan_mode()
assert action_drag.isChecked() == True
assert action_rectangle.isChecked() == False
mock_view_box.setMouseMode.assert_called_once_with(pg.ViewBox.PanMode)
###################################
# Curve Dialog Tests
###################################
def show_curve_dialog(qtbot, waveform_widget):
curve_dialog = SettingsDialog(
waveform_widget,
settings_widget=CurveSettings(),
window_title="Curve Settings",
config=waveform_widget.waveform._curves_data,
)
qtbot.addWidget(curve_dialog)
qtbot.waitExposed(curve_dialog)
return curve_dialog
def test_curve_dialog_scan_curves_interactions(qtbot, waveform_widget):
waveform_widget.plot(y_name="bpm4i")
waveform_widget.plot(y_name="bpm3a")
curve_dialog = show_curve_dialog(qtbot, waveform_widget)
# Check default display of config from waveform widget
assert curve_dialog is not None
assert curve_dialog.widget.ui.scan_table.rowCount() == 2
assert curve_dialog.widget.ui.scan_table.cellWidget(0, 0).text() == "bpm4i"
assert curve_dialog.widget.ui.scan_table.cellWidget(0, 1).text() == "bpm4i"
assert curve_dialog.widget.ui.scan_table.cellWidget(1, 0).text() == "bpm3a"
assert curve_dialog.widget.ui.scan_table.cellWidget(1, 1).text() == "bpm3a"
assert curve_dialog.widget.ui.x_mode.currentText() == "best_effort"
assert curve_dialog.widget.ui.x_name.isEnabled() == False
assert curve_dialog.widget.ui.x_entry.isEnabled() == False
# Add a new curve
curve_dialog.widget.ui.add_curve.click()
qtbot.wait(200)
assert curve_dialog.widget.ui.scan_table.rowCount() == 3
# Set device to new curve
curve_dialog.widget.ui.scan_table.cellWidget(2, 0).setText("bpm3i")
# Change the x mode to device
curve_dialog.widget.ui.x_mode.setCurrentText("device")
qtbot.wait(200)
assert curve_dialog.widget.ui.x_name.isEnabled() == True
assert curve_dialog.widget.ui.x_entry.isEnabled() == True
# Set the x device
curve_dialog.widget.ui.x_name.setText("samx")
# Delete first curve ('bpm4i')
curve_dialog.widget.ui.scan_table.cellWidget(0, 6).click()
qtbot.wait(200)
assert curve_dialog.widget.ui.scan_table.rowCount() == 2
assert curve_dialog.widget.ui.scan_table.cellWidget(0, 0).text() == "bpm3a"
assert curve_dialog.widget.ui.scan_table.cellWidget(0, 1).text() == "bpm3a"
assert curve_dialog.widget.ui.scan_table.cellWidget(1, 0).text() == "bpm3i"
# Close the dialog
curve_dialog.accept()
qtbot.wait(200)
# Check the curve data in the target widget
assert list(waveform_widget.waveform._curves_data["scan_segment"].keys()) == [
"bpm3a-bpm3a",
"bpm3i-bpm3i",
]
assert len(waveform_widget.curves) == 2
def test_curve_dialog_async(qtbot, waveform_widget):
waveform_widget.plot(y_name="bpm4i")
waveform_widget.plot(y_name="async_device")
curve_dialog = show_curve_dialog(qtbot, waveform_widget)
assert curve_dialog is not None
assert curve_dialog.widget.ui.scan_table.rowCount() == 2
assert curve_dialog.widget.ui.scan_table.cellWidget(0, 0).text() == "bpm4i"
assert curve_dialog.widget.ui.scan_table.cellWidget(0, 1).text() == "bpm4i"
assert curve_dialog.widget.ui.scan_table.cellWidget(1, 0).text() == "async_device"
assert curve_dialog.widget.ui.scan_table.cellWidget(1, 1).text() == "async_device"
def test_curve_dialog_dap(qtbot, waveform_widget):
# Don't use default dap for curve_dialog dialog
waveform_widget.plot(x_name="samx", y_name="bpm4i", dap="LorentzModel")
curve_dialog = show_curve_dialog(qtbot, waveform_widget)
assert curve_dialog is not None
assert curve_dialog.widget.ui.scan_table.rowCount() == 1
assert curve_dialog.widget.ui.scan_table.cellWidget(0, 0).text() == "bpm4i"
assert curve_dialog.widget.ui.scan_table.cellWidget(0, 1).text() == "bpm4i"
assert curve_dialog.widget.ui.dap_table.isEnabled() == True
assert curve_dialog.widget.ui.dap_table.rowCount() == 1
assert curve_dialog.widget.ui.dap_table.cellWidget(0, 0).text() == "bpm4i"
assert curve_dialog.widget.ui.dap_table.cellWidget(0, 1).text() == "bpm4i"
assert curve_dialog.widget.ui.dap_table.cellWidget(0, 2).currentText() == "LorentzModel"
assert curve_dialog.widget.ui.x_mode.currentText() == "device"
assert curve_dialog.widget.ui.x_name.isEnabled() == True
assert curve_dialog.widget.ui.x_entry.isEnabled() == True
assert curve_dialog.widget.ui.x_name.text() == "samx"
assert curve_dialog.widget.ui.x_entry.text() == "samx"
curve_dialog.accept()
qtbot.wait(200)
assert list(waveform_widget.waveform._curves_data["scan_segment"].keys()) == ["bpm4i-bpm4i"]
assert len(waveform_widget.curves) == 2
def test_fit_dialog_summary(qtbot, waveform_widget):
"""Test the fit dialog summary widget"""
waveform_widget.plot(x_name="samx", y_name="bpm4i", dap="GaussianModel")
fit_dialog_summary = create_widget(qtbot, FitSummaryWidget, target_widget=waveform_widget)
assert fit_dialog_summary.dap_dialog.fit_curve_id == "bpm4i-bpm4i-GaussianModel"
assert fit_dialog_summary.dap_dialog.ui.curve_list.count() == 1
###################################
# Axis Dialog Tests
###################################
def show_axis_dialog(qtbot, waveform_widget):
axis_dialog = SettingsDialog(
waveform_widget,
settings_widget=AxisSettings(),
window_title="Axis Settings",
config=waveform_widget._config_dict["axis"],
)
qtbot.addWidget(axis_dialog)
qtbot.waitExposed(axis_dialog)
return axis_dialog
def test_axis_dialog_with_axis_limits(qtbot, waveform_widget):
waveform_widget.set(
title="Test Title",
x_label="X Label",
y_label="Y Label",
x_scale="linear",
y_scale="log",
x_lim=(0, 10),
y_lim=(0, 10),
)
axis_dialog = show_axis_dialog(qtbot, waveform_widget)
assert axis_dialog is not None
assert axis_dialog.widget.ui.plot_title.text() == "Test Title"
assert axis_dialog.widget.ui.x_label.text() == "X Label"
assert axis_dialog.widget.ui.y_label.text() == "Y Label"
assert axis_dialog.widget.ui.x_scale.currentText() == "linear"
assert axis_dialog.widget.ui.y_scale.currentText() == "log"
assert axis_dialog.widget.ui.x_min.value() == 0
assert axis_dialog.widget.ui.x_max.value() == 10
assert axis_dialog.widget.ui.y_min.value() == 0
assert axis_dialog.widget.ui.y_max.value() == 10
def test_axis_dialog_without_axis_limits(qtbot, waveform_widget):
waveform_widget.set(
title="Test Title", x_label="X Label", y_label="Y Label", x_scale="linear", y_scale="log"
)
x_range = waveform_widget.fig.widget_list[0].plot_item.viewRange()[0]
y_range = waveform_widget.fig.widget_list[0].plot_item.viewRange()[1]
axis_dialog = show_axis_dialog(qtbot, waveform_widget)
assert axis_dialog is not None
assert axis_dialog.widget.ui.plot_title.text() == "Test Title"
assert axis_dialog.widget.ui.x_label.text() == "X Label"
assert axis_dialog.widget.ui.y_label.text() == "Y Label"
assert axis_dialog.widget.ui.x_scale.currentText() == "linear"
assert axis_dialog.widget.ui.y_scale.currentText() == "log"
assert axis_dialog.widget.ui.x_min.value() == x_range[0]
assert axis_dialog.widget.ui.x_max.value() == x_range[1]
assert axis_dialog.widget.ui.y_min.value() == y_range[0]
assert axis_dialog.widget.ui.y_max.value() == y_range[1]
def test_axis_dialog_set_properties(qtbot, waveform_widget):
axis_dialog = show_axis_dialog(qtbot, waveform_widget)
axis_dialog.widget.ui.plot_title.setText("New Title")
axis_dialog.widget.ui.x_label.setText("New X Label")
axis_dialog.widget.ui.y_label.setText("New Y Label")
axis_dialog.widget.ui.x_scale.setCurrentText("log")
axis_dialog.widget.ui.y_scale.setCurrentText("linear")
axis_dialog.widget.ui.x_min.setValue(5)
axis_dialog.widget.ui.x_max.setValue(15)
axis_dialog.widget.ui.y_min.setValue(5)
axis_dialog.widget.ui.y_max.setValue(15)
axis_dialog.accept()
assert waveform_widget._config_dict["axis"]["title"] == "New Title"
assert waveform_widget._config_dict["axis"]["x_label"] == "New X Label"
assert waveform_widget._config_dict["axis"]["y_label"] == "New Y Label"
assert waveform_widget._config_dict["axis"]["x_scale"] == "log"
assert waveform_widget._config_dict["axis"]["y_scale"] == "linear"
assert waveform_widget._config_dict["axis"]["x_lim"] == (5, 15)
assert waveform_widget._config_dict["axis"]["y_lim"] == (5, 15)
def test_waveform_widget_theme_update(qtbot, waveform_widget):
"""Test theme update for waveform widget."""
qapp = QApplication.instance()
# Set the theme directly; equivalent to clicking the dark mode button
# The background color should be black and the axis color should be white
set_theme("dark")
palette = get_theme_palette()
waveform_color_dark = waveform_widget.waveform.plot_item.getAxis("left").pen().color()
bg_color = waveform_widget.fig.backgroundBrush().color()
assert bg_color == QColor("black")
assert waveform_color_dark == palette.text().color()
# Set the theme to light; equivalent to clicking the light mode button
# The background color should be white and the axis color should be black
set_theme("light")
palette = get_theme_palette()
waveform_color_light = waveform_widget.waveform.plot_item.getAxis("left").pen().color()
bg_color = waveform_widget.fig.backgroundBrush().color()
assert bg_color == QColor("white")
assert waveform_color_light == palette.text().color()
assert waveform_color_dark != waveform_color_light
# Set the theme to auto; equivalent starting the application with no theme set
set_theme("auto")
# Simulate that the OS theme changes to dark
qapp.theme_signal.theme_updated.emit("dark")
apply_theme("dark")
# The background color should be black and the axis color should be white
# As we don't have access to the listener here, we can't test the palette change. Instead,
# we compare the waveform color to the dark theme color
waveform_color = waveform_widget.waveform.plot_item.getAxis("left").pen().color()
bg_color = waveform_widget.fig.backgroundBrush().color()
assert bg_color == QColor("black")
assert waveform_color == waveform_color_dark
def test_waveform_roi_selection_creation(waveform_widget, qtbot):
"""Test ROI selection for waveform widget.
This checks that the ROI select is properly created and removed when the button is toggled.
"""
# Check if curve is create upon ROI select slot
# This also checks that the button in the toolbar works
container = []
def callback(msg):
container.append(msg)
waveform_widget.waveform.roi_active.connect(callback)
assert waveform_widget.waveform.roi_select is None
assert waveform_widget.waveform.roi_region == (None, None)
# Toggle the ROI select
waveform_widget.toogle_roi_select(True)
assert isinstance(waveform_widget.waveform.roi_select, LinearRegionWrapper)
# This is the default region for the pg.LinearRegionItem
assert waveform_widget.waveform.roi_region == (0, 1)
# Untoggle the ROI select
waveform_widget.toogle_roi_select(False)
assert waveform_widget.waveform.roi_select is None
assert container[0] is True
assert container[1] is False
def test_waveform_roi_selection_updates_fit(waveform_widget, qtbot):
"""This test checks that upon selection of a new region, the fit is updated and all signals are emitted as expected."""
container = []
def callback(msg):
container.append(msg)
waveform_widget.waveform.roi_changed.connect(callback)
# Mock refresh_dap method
with patch.object(waveform_widget.waveform, "refresh_dap") as mock_refresh_dap:
waveform_widget.toogle_roi_select(True)
waveform_widget.waveform.roi_select.linear_region_selector.setRegion([0.5, 1.5])
qtbot.wait(200)
assert waveform_widget.waveform.roi_region == (0.5, 1.5)
waveform_widget.toogle_roi_select(False)
assert waveform_widget.waveform.roi_region == (None, None)
assert len(container) == 1
assert container[0] == (0.5, 1.5)
# 3 refresh DAP calls: 1x upon hook, 1x unhook and 1x from roi_changed
assert mock_refresh_dap.call_count == 3
def test_waveform_roi_selection_change_color(waveform_widget, qtbot):
"""This test checks that the color of the ROI region can be changed."""
waveform_widget.toogle_roi_select(True)
waveform_widget.waveform.roi_select.change_roi_color((QColor("red"), QColor("blue")))
# I can only get the brush from the RegionSelectItem
assert (
waveform_widget.waveform.roi_select.linear_region_selector.currentBrush.color()
== QColor("red")
)