fix(widgets/dock): BECDockArea close overwrites the default pyqtgraph Container close + minor improvements

tests/end-2-end/conftest.py

@@ -3,6 +3,7 @@ import pytest
 from bec_widgets.cli.rpc_register import RPCRegister
 from bec_widgets.cli.server import BECWidgetsCLIServer
 from bec_widgets.utils import BECDispatcher
+from bec_widgets.widgets import BECDockArea, BECFigure
 
 
 @pytest.fixture(autouse=True)
@@ -12,11 +13,25 @@ def rpc_register():
 
 
 @pytest.fixture
-def rpc_server(qtbot, bec_client_lib, threads_check):
+def rpc_server_figure(qtbot, bec_client_lib, threads_check):
     dispatcher = BECDispatcher(client=bec_client_lib)  # Has to init singleton with fixture client
-    server = BECWidgetsCLIServer(gui_id="figure")
-    qtbot.addWidget(server.fig)
-    qtbot.waitExposed(server.fig)
+    server = BECWidgetsCLIServer(gui_id="figure", gui_class=BECFigure)
+    qtbot.addWidget(server.gui)
+    qtbot.waitExposed(server.gui)
+    qtbot.wait(1000)  # 1s long to wait until gui is ready
+    yield server
+    dispatcher.disconnect_all()
+    server.client.shutdown()
+    server.shutdown()
+    dispatcher.reset_singleton()
+
+
+@pytest.fixture
+def rpc_server_dock(qtbot, bec_client_lib, threads_check):
+    dispatcher = BECDispatcher(client=bec_client_lib)  # Has to init singleton with fixture client
+    server = BECWidgetsCLIServer(gui_id="figure", gui_class=BECDockArea)
+    qtbot.addWidget(server.gui)
+    qtbot.waitExposed(server.gui)
     qtbot.wait(1000)  # 1s long to wait until gui is ready
     yield server
     dispatcher.disconnect_all()

tests/end-2-end/test_bec_dock_rpc_e2e.py

@@ -0,0 +1,145 @@
+import numpy as np
+import pytest
+from bec_lib import MessageEndpoints
+
+from bec_widgets.cli.client import BECDockArea, BECFigure, BECImageShow, BECMotorMap, BECWaveform
+
+
+def test_rpc_add_dock_with_figure_e2e(rpc_server_dock, qtbot):
+    dock = BECDockArea(rpc_server_dock.gui_id)
+    dock_server = rpc_server_dock.gui
+
+    # BEC client shortcuts
+    client = rpc_server_dock.client
+    dev = client.device_manager.devices
+    scans = client.scans
+    queue = client.queue
+
+    # Create 3 docks
+    d0 = dock.add_dock("dock_0")
+    d1 = dock.add_dock("dock_1")
+    d2 = dock.add_dock("dock_2")
+
+    assert len(dock_server.docks) == 3
+
+    # Add 3 figures with some widgets
+    fig0 = d0.add_widget_bec("BECFigure")
+    fig1 = d1.add_widget_bec("BECFigure")
+    fig2 = d2.add_widget_bec("BECFigure")
+
+    assert len(dock_server.docks) == 3
+    assert len(dock_server.docks["dock_0"].widgets) == 1
+    assert len(dock_server.docks["dock_1"].widgets) == 1
+    assert len(dock_server.docks["dock_2"].widgets) == 1
+
+    assert fig1.__class__.__name__ == "BECFigure"
+    assert fig1.__class__ == BECFigure
+    assert fig2.__class__.__name__ == "BECFigure"
+    assert fig2.__class__ == BECFigure
+
+    mm = fig0.motor_map("samx", "samy")
+    plt = fig1.plot("samx", "bpm4i")
+    im = fig2.image("eiger")
+
+    assert mm.__class__.__name__ == "BECMotorMap"
+    assert mm.__class__ == BECMotorMap
+    assert plt.__class__.__name__ == "BECWaveform"
+    assert plt.__class__ == BECWaveform
+    assert im.__class__.__name__ == "BECImageShow"
+    assert im.__class__ == BECImageShow
+
+    assert mm.config_dict["signals"] == {
+        "source": "device_readback",
+        "x": {
+            "name": "samx",
+            "entry": "samx",
+            "unit": None,
+            "modifier": None,
+            "limits": [-50.0, 50.0],
+        },
+        "y": {
+            "name": "samy",
+            "entry": "samy",
+            "unit": None,
+            "modifier": None,
+            "limits": [-50.0, 50.0],
+        },
+        "z": None,
+    }
+    assert plt.config_dict["curves"]["bpm4i-bpm4i"]["signals"] == {
+        "source": "scan_segment",
+        "x": {"name": "samx", "entry": "samx", "unit": None, "modifier": None, "limits": None},
+        "y": {"name": "bpm4i", "entry": "bpm4i", "unit": None, "modifier": None, "limits": None},
+        "z": None,
+    }
+    assert im.config_dict["images"]["eiger"]["monitor"] == "eiger"
+
+    # check initial position of motor map
+    initial_pos_x = dev.samx.read()["samx"]["value"]
+    initial_pos_y = dev.samy.read()["samy"]["value"]
+
+    # Try to make a scan
+    status = scans.line_scan(dev.samx, -5, 5, steps=10, exp_time=0.05, relative=False)
+
+    # wait for scan to finish
+    while not status.status == "COMPLETED":
+        qtbot.wait(200)
+
+    # plot
+    plt_last_scan_data = queue.scan_storage.storage[-1].data
+    plt_data = plt.get_all_data()
+    assert plt_data["bpm4i-bpm4i"]["x"] == plt_last_scan_data["samx"]["samx"].val
+    assert plt_data["bpm4i-bpm4i"]["y"] == plt_last_scan_data["bpm4i"]["bpm4i"].val
+
+    # image
+    last_image_device = client.connector.get_last(MessageEndpoints.device_monitor("eiger"))[
+        "data"
+    ].data
+    qtbot.wait(500)
+    last_image_plot = im.images[0].get_data()
+    np.testing.assert_equal(last_image_device, last_image_plot)
+
+    # motor map
+    final_pos_x = dev.samx.read()["samx"]["value"]
+    final_pos_y = dev.samy.read()["samy"]["value"]
+
+    # check final coordinates of motor map
+    motor_map_data = mm.get_data()
+
+    np.testing.assert_equal(
+        [motor_map_data["x"][0], motor_map_data["y"][0]], [initial_pos_x, initial_pos_y]
+    )
+    np.testing.assert_equal(
+        [motor_map_data["x"][-1], motor_map_data["y"][-1]], [final_pos_x, final_pos_y]
+    )
+
+
+def test_dock_manipulations_e2e(rpc_server_dock, qtbot):
+    dock = BECDockArea(rpc_server_dock.gui_id)
+    dock_server = rpc_server_dock.gui
+
+    d0 = dock.add_dock("dock_0")
+    d1 = dock.add_dock("dock_1")
+    d2 = dock.add_dock("dock_2")
+    assert len(dock_server.docks) == 3
+
+    d0.detach()
+    dock.detach_dock("dock_2")
+    assert len(dock_server.docks) == 3
+    assert len(dock_server.tempAreas) == 2
+
+    d0.attach()
+    assert len(dock_server.docks) == 3
+    assert len(dock_server.tempAreas) == 1
+
+    d2.remove()
+    qtbot.wait(200)
+
+    assert len(dock_server.docks) == 2
+    docks_list = list(dict(dock_server.docks).keys())
+    assert ["dock_0", "dock_1"] == docks_list
+
+    dock.clear_all()
+
+    assert len(dock_server.docks) == 0
+    assert len(dock_server.tempAreas) == 0

tests/end-2-end/test_bec_figure_rpc_e2e.py

@@ -3,27 +3,11 @@ import pytest
 from bec_lib import MessageEndpoints
 
 from bec_widgets.cli.client import BECFigure, BECImageShow, BECMotorMap, BECWaveform
-from bec_widgets.cli.server import BECWidgetsCLIServer
-from bec_widgets.utils import BECDispatcher
 
 
-@pytest.fixture
-def rpc_server(qtbot, bec_client_lib, threads_check):
-    dispatcher = BECDispatcher(client=bec_client_lib)  # Has to init singleton with fixture client
-    server = BECWidgetsCLIServer(gui_id="id_test")
-    qtbot.addWidget(server.gui)
-    qtbot.waitExposed(server.gui)
-    qtbot.wait(1000)  # 1s long to wait until gui is ready
-    yield server
-    dispatcher.disconnect_all()
-    server.client.shutdown()
-    server.shutdown()
-    dispatcher.reset_singleton()
-
-
-def test_rpc_waveform1d_custom_curve(rpc_server, qtbot):
-    fig = BECFigure(rpc_server.gui_id)
-    fig_server = rpc_server.gui
+def test_rpc_waveform1d_custom_curve(rpc_server_figure, qtbot):
+    fig = BECFigure(rpc_server_figure.gui_id)
+    fig_server = rpc_server_figure.gui
 
     ax = fig.add_plot()
     curve = ax.add_curve_custom([1, 2, 3], [1, 2, 3])
@@ -32,12 +16,12 @@ def test_rpc_waveform1d_custom_curve(rpc_server, qtbot):
     curve.set_color("blue")
 
     assert len(fig_server.widgets) == 1
-    assert len(fig_server.widgets["widget_1"].curves) == 1
+    assert len(fig_server.widgets[ax.rpc_id].curves) == 1
 
 
-def test_rpc_plotting_shortcuts_init_configs(rpc_server, qtbot):
-    fig = BECFigure(rpc_server.gui_id)
-    fig_server = rpc_server.gui
+def test_rpc_plotting_shortcuts_init_configs(rpc_server_figure, qtbot):
+    fig = BECFigure(rpc_server_figure.gui_id)
+    fig_server = rpc_server_figure.gui
 
     plt = fig.plot("samx", "bpm4i")
     im = fig.image("eiger")
@@ -91,15 +75,15 @@ def test_rpc_plotting_shortcuts_init_configs(rpc_server, qtbot):
     }
 
 
-def test_rpc_waveform_scan(rpc_server, qtbot):
-    fig = BECFigure(rpc_server.gui_id)
+def test_rpc_waveform_scan(rpc_server_figure, qtbot):
+    fig = BECFigure(rpc_server_figure.gui_id)
 
     # add 3 different curves to track
     plt = fig.plot("samx", "bpm4i")
     fig.plot("samx", "bpm3a")
     fig.plot("samx", "bpm4d")
 
-    client = rpc_server.client
+    client = rpc_server_figure.client
     dev = client.device_manager.devices
     scans = client.scans
     queue = client.queue
@@ -124,12 +108,12 @@ def test_rpc_waveform_scan(rpc_server, qtbot):
     assert plt_data["bpm4d-bpm4d"]["y"] == last_scan_data["bpm4d"]["bpm4d"].val
 
 
-def test_rpc_image(rpc_server, qtbot):
-    fig = BECFigure(rpc_server.gui_id)
+def test_rpc_image(rpc_server_figure, qtbot):
+    fig = BECFigure(rpc_server_figure.gui_id)
 
     im = fig.image("eiger")
 
-    client = rpc_server.client
+    client = rpc_server_figure.client
     dev = client.device_manager.devices
     scans = client.scans
 
@@ -149,13 +133,13 @@ def test_rpc_image(rpc_server, qtbot):
     np.testing.assert_equal(last_image_device, last_image_plot)
 
 
-def test_rpc_motor_map(rpc_server, qtbot):
-    fig = BECFigure(rpc_server.gui_id)
-    fig_server = rpc_server.gui
+def test_rpc_motor_map(rpc_server_figure, qtbot):
+    fig = BECFigure(rpc_server_figure.gui_id)
+    fig_server = rpc_server_figure.gui
 
     motor_map = fig.motor_map("samx", "samy")
 
-    client = rpc_server.client
+    client = rpc_server_figure.client
     dev = client.device_manager.devices
     scans = client.scans
 

tests/end-2-end/test_rpc_register_e2e.py

@@ -18,9 +18,9 @@ def find_deepest_value(d: dict):
     return d
 
 
-def test_rpc_register_list_connections(rpc_server, rpc_register, qtbot):
-    fig = BECFigure(rpc_server.gui_id)
-    fig_server = rpc_server.fig
+def test_rpc_register_list_connections(rpc_server_figure, rpc_register, qtbot):
+    fig = BECFigure(rpc_server_figure.gui_id)
+    fig_server = rpc_server_figure.gui
 
     plt = fig.plot("samx", "bpm4i")
     im = fig.image("eiger")

tests/unit_tests/test_bec_dock.py

@@ -0,0 +1,114 @@
+# pylint: disable=missing-function-docstring, missing-module-docstring, unused-import
+
+import pytest
+
+from bec_widgets.widgets import BECDock, BECDockArea
+
+from .client_mocks import mocked_client
+
+
+@pytest.fixture
+def bec_dock_area(qtbot, mocked_client):
+    widget = BECDockArea(client=mocked_client)
+    qtbot.addWidget(widget)
+    qtbot.waitExposed(widget)
+    yield widget
+    widget.close()
+
+
+def test_bec_dock_area_init(bec_dock_area):
+    assert bec_dock_area is not None
+    assert bec_dock_area.client is not None
+    assert isinstance(bec_dock_area, BECDockArea)
+    assert bec_dock_area.config.widget_class == "BECDockArea"
+
+
+def test_bec_dock_area_add_remove_dock(bec_dock_area, qtbot):
+    initial_count = len(bec_dock_area.docks)
+
+    # Adding 3 docks
+    d0 = bec_dock_area.add_dock()
+    d1 = bec_dock_area.add_dock()
+    d2 = bec_dock_area.add_dock()
+
+    # Check if the docks were added
+    assert len(bec_dock_area.docks) == initial_count + 3
+    assert d0.name() in dict(bec_dock_area.docks)
+    assert d1.name() in dict(bec_dock_area.docks)
+    assert d2.name() in dict(bec_dock_area.docks)
+    assert bec_dock_area.docks[d0.name()].config.widget_class == "BECDock"
+    assert bec_dock_area.docks[d1.name()].config.widget_class == "BECDock"
+    assert bec_dock_area.docks[d2.name()].config.widget_class == "BECDock"
+
+    # Check panels API for getting docks to CLI
+    assert bec_dock_area.panels == dict(bec_dock_area.docks)
+
+    # Remove docks
+    d0_name = d0.name()
+    bec_dock_area.remove_dock(d0_name)  # TODO fix this, works in jupyter console
+    qtbot.wait(200)
+    d1.remove()
+    qtbot.wait(200)
+
+    assert len(bec_dock_area.docks) == initial_count + 1
+    assert d0.name() not in dict(bec_dock_area.docks)
+    assert d1.name() not in dict(bec_dock_area.docks)
+    assert d2.name() in dict(bec_dock_area.docks)
+
+
+def test_add_remove_bec_figure_to_dock(bec_dock_area):
+    d0 = bec_dock_area.add_dock()
+    fig = d0.add_widget_bec("BECFigure")
+    plt = fig.plot("samx", "bpm4i")
+    im = fig.image("eiger")
+    mm = fig.motor_map("samx", "samy")
+
+    assert len(bec_dock_area.docks) == 1
+    assert len(d0.widgets) == 1
+    assert len(d0.widget_list) == 1
+    assert len(fig.widgets) == 3
+
+    assert fig.config.widget_class == "BECFigure"
+    assert plt.config.widget_class == "BECWaveform"
+    assert im.config.widget_class == "BECImageShow"
+    assert mm.config.widget_class == "BECMotorMap"
+
+
+def test_dock_area_errors(bec_dock_area):
+    d0 = bec_dock_area.add_dock(name="dock_0")
+
+    with pytest.raises(ValueError) as excinfo:
+        bec_dock_area.add_dock(name="dock_0")
+        assert "Dock with name  dock_0 already exists." in str(excinfo.value)
+
+
+def test_close_docks(bec_dock_area, qtbot):
+    d0 = bec_dock_area.add_dock(name="dock_0")
+    d1 = bec_dock_area.add_dock(name="dock_1")
+    d2 = bec_dock_area.add_dock(name="dock_2")
+
+    bec_dock_area.clear_all()
+    qtbot.wait(200)
+    assert len(bec_dock_area.docks) == 0
+
+
+def test_undock_and_dock_docks(bec_dock_area, qtbot):
+    d0 = bec_dock_area.add_dock(name="dock_0")
+    d1 = bec_dock_area.add_dock(name="dock_1")
+    d2 = bec_dock_area.add_dock(name="dock_4")
+    d3 = bec_dock_area.add_dock(name="dock_3")
+
+    d0.detach()
+    bec_dock_area.detach_dock("dock_1")
+    d2.detach()
+
+    assert len(bec_dock_area.docks) == 4
+    assert len(bec_dock_area.tempAreas) == 3
+
+    d0.attach()
+    assert len(bec_dock_area.docks) == 4
+    assert len(bec_dock_area.tempAreas) == 2
+
+    bec_dock_area.attach_all()
+    assert len(bec_dock_area.docks) == 4
+    assert len(bec_dock_area.tempAreas) == 0

tests/unit_tests/test_bec_figure.py

@@ -1,6 +1,4 @@
 # pylint: disable=missing-function-docstring, missing-module-docstring, unused-import
-import os
-from unittest.mock import MagicMock
 
 import numpy as np
 import pytest
@@ -48,12 +46,12 @@ def test_bec_figure_add_remove_plot(bec_figure):
 
     # Check if the widgets were added
     assert len(bec_figure._widgets) == initial_count + 3
-    assert "widget_1" in bec_figure._widgets
-    assert "widget_2" in bec_figure._widgets
-    assert "widget_3" in bec_figure._widgets
-    assert bec_figure._widgets["widget_1"].config.widget_class == "BECWaveform"
-    assert bec_figure._widgets["widget_2"].config.widget_class == "BECWaveform"
-    assert bec_figure._widgets["widget_3"].config.widget_class == "BECPlotBase"
+    assert w0.gui_id in bec_figure._widgets
+    assert w1.gui_id in bec_figure._widgets
+    assert w2.gui_id in bec_figure._widgets
+    assert bec_figure._widgets[w0.gui_id].config.widget_class == "BECWaveform"
+    assert bec_figure._widgets[w1.gui_id].config.widget_class == "BECWaveform"
+    assert bec_figure._widgets[w2.gui_id].config.widget_class == "BECPlotBase"
 
     # Check accessing positions by the grid in figure
     assert bec_figure[0, 0] == w0
@@ -61,11 +59,11 @@ def test_bec_figure_add_remove_plot(bec_figure):
     assert bec_figure[2, 0] == w2
 
     # Removing 1 widget
-    bec_figure.remove(widget_id="widget_1")
+    bec_figure.remove(widget_id=w0.gui_id)
     assert len(bec_figure._widgets) == initial_count + 2
-    assert "widget_1" not in bec_figure._widgets
-    assert "widget_3" in bec_figure._widgets
-    assert bec_figure._widgets["widget_2"].config.widget_class == "BECWaveform"
+    assert w0.gui_id not in bec_figure._widgets
+    assert w2.gui_id in bec_figure._widgets
+    assert bec_figure._widgets[w1.gui_id].config.widget_class == "BECWaveform"
 
 
 def test_add_different_types_of_widgets(bec_figure):
@@ -121,20 +119,20 @@ def test_remove_plots(bec_figure):
 
     # remove by coordinates
     bec_figure[0, 0].remove()
-    assert "widget_1" not in bec_figure._widgets
+    assert w1.gui_id not in bec_figure._widgets
 
     # remove by widget_id
-    bec_figure.remove(widget_id="widget_2")
-    assert "widget_2" not in bec_figure._widgets
+    bec_figure.remove(widget_id=w2.gui_id)
+    assert w2.gui_id not in bec_figure._widgets
 
     # remove by widget object
     w3.remove()
-    assert "widget_3" not in bec_figure._widgets
+    assert w3.gui_id not in bec_figure._widgets
 
     # check the remaining widget 4
     assert bec_figure[0, 0] == w4
-    assert bec_figure["widget_4"] == w4
-    assert "widget_4" in bec_figure._widgets
+    assert bec_figure[w4.gui_id] == w4
+    assert w4.gui_id in bec_figure._widgets
     assert len(bec_figure._widgets) == 1
 
 
@@ -143,8 +141,8 @@ def test_remove_plots_by_coordinates_ints(bec_figure):
     w2 = bec_figure.add_plot(row=0, col=1)
 
     bec_figure.remove(0, 0)
-    assert "widget_1" not in bec_figure._widgets
-    assert "widget_2" in bec_figure._widgets
+    assert w1.gui_id not in bec_figure._widgets
+    assert w2.gui_id in bec_figure._widgets
     assert bec_figure[0, 0] == w2
     assert len(bec_figure._widgets) == 1
 
@@ -154,8 +152,8 @@ def test_remove_plots_by_coordinates_tuple(bec_figure):
     w2 = bec_figure.add_plot(row=0, col=1)
 
     bec_figure.remove(coordinates=(0, 0))
-    assert "widget_1" not in bec_figure._widgets
-    assert "widget_2" in bec_figure._widgets
+    assert w1.gui_id not in bec_figure._widgets
+    assert w2.gui_id in bec_figure._widgets
     assert bec_figure[0, 0] == w2
     assert len(bec_figure._widgets) == 1
 

tests/unit_tests/test_generate_cli_client.py

@@ -40,7 +40,7 @@ def test_client_generator_with_black_formatting():
         '''\
         # This file was automatically generated by generate_cli.py
 
-        from bec_widgets.cli.client_utils import rpc_call, RPCBase, BECFigureClientMixin
+        from bec_widgets.cli.client_utils import rpc_call, RPCBase, BECGuiClientMixin
         from typing import Literal, Optional, overload
 
         class MockBECWaveform1D(RPCBase):

tests/unit_tests/test_waveform1d.py

@@ -141,7 +141,7 @@ def test_getting_curve(bec_figure):
     c1_expected_config = CurveConfig(
         widget_class="BECCurve",
         gui_id="test_curve",
-        parent_id="widget_1",
+        parent_id=w1.gui_id,
         label="bpm4i-bpm4i",
         color="#cc4778",
         symbol="o",