feat(help-inspector): add help inspector widget

tests/unit_tests/test_help_inspector.py

@@ -0,0 +1,81 @@
+# pylint: disable=missing-function-docstring, missing-module-docstring, unused-import
+
+import pytest
+from qtpy import QtCore, QtWidgets
+
+from bec_widgets.utils.help_inspector.help_inspector import HelpInspector
+from bec_widgets.widgets.control.buttons.button_abort.button_abort import AbortButton
+
+from .client_mocks import mocked_client
+
+
+@pytest.fixture
+def help_inspector(qtbot, mocked_client):
+    widget = HelpInspector(client=mocked_client)
+    qtbot.addWidget(widget)
+    qtbot.waitExposed(widget)
+    yield widget
+
+
+@pytest.fixture
+def abort_button(qtbot):
+    widget = AbortButton()
+    widget.setToolTip("This is an abort button.")
+
+    def get_help_md():
+        return "This is **markdown** help text for the abort button."
+
+    widget.get_help_md = get_help_md  # type: ignore
+
+    qtbot.addWidget(widget)
+    qtbot.waitExposed(widget)
+
+    yield widget
+
+
+def test_help_inspector_button(help_inspector):
+    """Test the HelpInspector widget."""
+    assert not help_inspector._active
+    help_inspector._button.click()
+    assert help_inspector._active
+    assert help_inspector._button.isChecked()
+    cursor = QtWidgets.QApplication.overrideCursor()
+    assert cursor is not None
+    assert cursor.shape() == QtCore.Qt.CursorShape.WhatsThisCursor
+    help_inspector._button.click()
+    assert not help_inspector._active
+    assert not help_inspector._button.isChecked()
+    assert QtWidgets.QApplication.overrideCursor() is None
+
+
+def test_help_inspector_register_callback(help_inspector):
+    """Test registering a callback in the HelpInspector widget."""
+
+    assert len(help_inspector._callbacks) == 3  # default callbacks
+
+    def my_callback(widget):
+        pass
+
+    cb_id = help_inspector.register_callback(my_callback)
+    assert len(help_inspector._callbacks) == 4
+    assert help_inspector._callbacks[cb_id] == my_callback
+
+    cb_id2 = help_inspector.register_callback(my_callback)
+    assert len(help_inspector._callbacks) == 5
+    assert help_inspector._callbacks[cb_id2] == my_callback
+
+    help_inspector.unregister_callback(cb_id)
+    assert len(help_inspector._callbacks) == 4
+
+    help_inspector.unregister_callback(cb_id2)
+    assert len(help_inspector._callbacks) == 3
+
+
+def test_help_inspector_escape_key(qtbot, help_inspector):
+    """Test that pressing the Escape key deactivates the HelpInspector."""
+    help_inspector._button.click()
+    assert help_inspector._active
+    qtbot.keyClick(help_inspector, QtCore.Qt.Key.Key_Escape)
+    assert not help_inspector._active
+    assert not help_inspector._button.isChecked()
+    assert QtWidgets.QApplication.overrideCursor() is None