bec-widgets 0.66.1__py3-none-any.whl → 0.68.0__py3-none-any.whl

docs/user/getting_started/installation.md

@@ -13,13 +13,13 @@ To install BEC Widgets using the pip package manager, execute the following comm
 
 
 ```bash
-pip install bec_widgets[pyqt6]
+pip install 'bec_widgets[pyqt6]'
 ```
 
 In case you want to use PyQt5, you can install it by using the following command:
 
 ```bash
-pip install bec_widgets[pyqt5]
+pip install 'bec_widgets[pyqt5]'
 ```
 
 **Troubleshooting**

docs/user/widgets/bec_status_box.md

@@ -0,0 +1,30 @@
+(user.widgets.bec_status_box)=
+# BEC Status Box
+**Purpose:**
+
+The [BECStatusBox]](/api_reference/_autosummary/bec_widgets.cli.client.BECStatusBox) Widget is a widget that allows you to monitor the status/health of the all running BEC processes. The widget generates the view automatically and updates the status of the processes in real-time. The top level indicates the overall state of the BEC core services (DeviceServer, ScanServer, SciHub, ScanBundler and FileWriter), but you can also see the status of each individual process by opening the collapsed view. In the collapsed view, you can double click on each process to get a popup window with live updates of the metrics for each process in real-time.
+
+**Key Features:**
+
+- monitor the state of individual BEC services.
+- automatically track BEC services, i.e. additional clients connecting.
+- live-updates of the metrics for each process.
+
+**Example of Use:**
+![BECStatus](./bec_status_box.gif)
+
+**Code example:**
+
+The following code snipped demonstrates how to create a `BECStatusBox` widget using BEC Widgets within BEC.
+```python
+bec_status_box = gui.add_dock().add_widget("BECStatusBox")
+```
+
+
+
+
+
+
+
+
+

docs/user/widgets/buttons.md

@@ -1,5 +1,4 @@
 (user.widgets.buttons)=
-
 # Buttons Widgets
 
 This section consolidates various custom buttons used within the BEC GUIs, facilitating the integration of these

docs/user/widgets/widgets.md

@@ -13,6 +13,8 @@ spiral_progress_bar/
 website/
 buttons/
 text_box/
+bec_status_box/
+
 ```
 
 

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "bec_widgets"
-version = "0.66.1"
+version = "0.68.0"
 description = "BEC Widgets"
 requires-python = ">=3.10"
 classifiers = [

tests/end-2-end/conftest.py

@@ -29,9 +29,7 @@ def gui_id():
 @contextmanager
 def plot_server(gui_id, klass, client_lib):
     dispatcher = BECDispatcher(client=client_lib)  # Has to init singleton with fixture client
-    process, output_thread = _start_plot_process(
-        gui_id, klass, client_lib._client._service_config.redis
-    )
+    process, _ = _start_plot_process(gui_id, klass, client_lib._client._service_config.config_path)
     try:
         while client_lib._client.connector.get(MessageEndpoints.gui_heartbeat(gui_id)) is None:
             time.sleep(0.3)
@@ -39,7 +37,6 @@ def plot_server(gui_id, klass, client_lib):
     finally:
         process.terminate()
         process.wait()
-        output_thread.join()
         dispatcher.disconnect_all()
         dispatcher.reset_singleton()
 

tests/unit_tests/test_bec_status_box.py

@@ -0,0 +1,152 @@
+import re
+from unittest import mock
+
+import pytest
+from bec_lib.messages import BECStatus, ServiceMetricMessage, StatusMessage
+from qtpy.QtCore import QMetaMethod
+
+from bec_widgets.widgets.bec_status_box.bec_status_box import BECServiceInfoContainer, BECStatusBox
+
+from .client_mocks import mocked_client
+
+
+@pytest.fixture
+def status_box(qtbot, mocked_client):
+    with mock.patch(
+        "bec_widgets.widgets.bec_status_box.bec_status_box.BECServiceStatusMixin"
+    ) as mock_service_status_mixin:
+        widget = BECStatusBox(client=mocked_client)
+        qtbot.addWidget(widget)
+        qtbot.waitExposed(widget)
+        yield widget
+
+
+def test_status_box_init(qtbot, mocked_client):
+    with mock.patch(
+        "bec_widgets.widgets.bec_status_box.bec_status_box.BECServiceStatusMixin"
+    ) as mock_service_status_mixin:
+        name = "my test"
+        widget = BECStatusBox(parent=None, service_name=name, client=mocked_client)
+        qtbot.addWidget(widget)
+        qtbot.waitExposed(widget)
+        assert widget.headerItem().DontShowIndicator.value == 1
+        assert widget.children()[0].children()[0].config.service_name == name
+
+
+def test_update_top_item(qtbot, mocked_client):
+    with (
+        mock.patch(
+            "bec_widgets.widgets.bec_status_box.bec_status_box.BECServiceStatusMixin"
+        ) as mock_service_status_mixin,
+        mock.patch(
+            "bec_widgets.widgets.bec_status_box.status_item.StatusItem.update_config"
+        ) as mock_update,
+    ):
+        name = "my test"
+        widget = BECStatusBox(parent=None, service_name=name, client=mocked_client)
+        qtbot.addWidget(widget)
+        qtbot.waitExposed(widget)
+        widget.update_top_item_status(status="RUNNING")
+        assert widget.bec_service_info_container[name].status == "RUNNING"
+        assert mock_update.call_args == mock.call(widget.bec_service_info_container[name].dict())
+
+
+def test_create_status_widget(status_box):
+    name = "test_service"
+    status = BECStatus.IDLE
+    info = {"test": "test"}
+    metrics = {"metric": "test_metric"}
+    item = status_box._create_status_widget(name, status, info, metrics)
+    assert item.config.service_name == name
+    assert item.config.status == status.name
+    assert item.config.info == info
+    assert item.config.metrics == metrics
+
+
+def test_bec_service_container(status_box):
+    name = "test_service"
+    status = BECStatus.IDLE
+    info = {"test": "test"}
+    metrics = {"metric": "test_metric"}
+    expected_return = BECServiceInfoContainer(
+        service_name=name, status=status, info=info, metrics=metrics
+    )
+    assert status_box.service_name in status_box.bec_service_info_container
+    assert len(status_box.bec_service_info_container) == 1
+    status_box._update_bec_service_container(name, status, info, metrics)
+    assert len(status_box.bec_service_info_container) == 2
+    assert status_box.bec_service_info_container[name] == expected_return
+
+
+def test_add_tree_item(status_box):
+    name = "test_service"
+    status = BECStatus.IDLE
+    info = {"test": "test"}
+    metrics = {"metric": "test_metric"}
+    assert len(status_box.children()[0].children()) == 1
+    status_box.add_tree_item(name, status, info, metrics)
+    assert len(status_box.children()[0].children()) == 2
+    assert name in status_box.tree_items
+
+
+def test_update_service_status(status_box):
+    """Also checks check redundant tree items"""
+    name = "test_service"
+    status = BECStatus.IDLE
+    info = {"test": "test"}
+    metrics = {"metric": "test_metric"}
+    status_box.add_tree_item(name, status, info, {})
+    not_connected_name = "invalid_service"
+    status_box.add_tree_item(not_connected_name, status, info, metrics)
+
+    services_status = {name: StatusMessage(name=name, status=status, info=info)}
+    services_metrics = {name: ServiceMetricMessage(name=name, metrics=metrics)}
+
+    with mock.patch.object(status_box, "update_core_services", return_value=services_status):
+        assert not_connected_name in status_box.tree_items
+        status_box.update_service_status(services_status, services_metrics)
+        assert status_box.tree_items[name][1].config.metrics == metrics
+        assert not_connected_name not in status_box.tree_items
+
+
+def test_update_core_services(qtbot, mocked_client):
+    with (
+        mock.patch(
+            "bec_widgets.widgets.bec_status_box.bec_status_box.BECServiceStatusMixin"
+        ) as mock_service_status_mixin,
+        mock.patch(
+            "bec_widgets.widgets.bec_status_box.bec_status_box.BECStatusBox.update_top_item_status"
+        ) as mock_update,
+    ):
+        name = "my test"
+        status_box = BECStatusBox(parent=None, service_name=name, client=mocked_client)
+        qtbot.addWidget(status_box)
+        qtbot.waitExposed(status_box)
+        status_box.CORE_SERVICES = ["test_service"]
+        name = "test_service"
+        status = BECStatus.RUNNING
+        info = {"test": "test"}
+        metrics = {"metric": "test_metric"}
+        services_status = {name: StatusMessage(name=name, status=status, info=info)}
+        services_metrics = {name: ServiceMetricMessage(name=name, metrics=metrics)}
+
+        status_box.update_core_services(services_status, services_metrics)
+        assert mock_update.call_args == mock.call(status.name)
+
+        status = BECStatus.IDLE
+        services_status = {name: StatusMessage(name=name, status=status, info=info)}
+        services_metrics = {name: ServiceMetricMessage(name=name, metrics=metrics)}
+        status_box.update_core_services(services_status, services_metrics)
+        assert mock_update.call_args == mock.call("ERROR")
+
+
+def test_double_click_item(status_box):
+    name = "test_service"
+    status = BECStatus.IDLE
+    info = {"test": "test"}
+    metrics = {"MyData": "This should be shown nicely"}
+    status_box.add_tree_item(name, status, info, metrics)
+    item, status_item = status_box.tree_items[name]
+    with mock.patch.object(status_item, "show_popup") as mock_show_popup:
+        status_box.itemDoubleClicked.emit(item, 0)
+        assert mock_show_popup.call_count == 1