test: add more tests for bl state actor

Author: d-perl

bec_server/bec_server/actors/actor.py

@@ -99,6 +99,7 @@ def run(self):
             self.push_status(ProcedureWorkerStatus.IDLE)
 
     def stop(self, *_):
+        """Stop the actor and cleanup subscriptions."""
         self._stopped = True
         for endpoint in self._endpoints:
             for cb in self.default_monitor_callbacks():
@@ -108,6 +109,7 @@ def stop(self, *_):
                     logger.error(
                         f"{self.__class__} {self.__qualname__} failed to unregister {cb} from {endpoint}: {e}"
                     )
+        self.stop_event.set()
 
 
 class BlStateActor(SubscriptionActor):
@@ -163,7 +165,7 @@ def some_mismatch_action(self, client: BECClient):
         pass
 
     def run(self):
-        while not self.client.beamline_states.ready:
+        while not self.client.beamline_states.ready and not self.stop_event.set():
             logger.warning(f"{self.__class__.__name__} waiting for beamline states to become ready")
             time.sleep(0.1)
         self._update_cache()

bec_server/tests/tests_actors/test_actors.py

@@ -9,7 +9,7 @@
 from bec_lib.endpoints import MessageEndpoints
 from bec_lib.messages import ActorStartRequestMessage, ProcedureWorkerStatus, RawMessage
 from bec_lib.redis_connector import MessageObject, RedisConnector
-from bec_server.actors.actor import ActorBase
+from bec_server.actors.actor import ActorBase, BlStateActor
 from bec_server.actors.manager import ActorManager
 from bec_server.actors.worker import actor_procedure
 from bec_server.procedures.constants import BecClientType
@@ -173,3 +173,42 @@ def test_actor_procedure_logs_error_not_actor():
     with patch("bec_server.actors.worker.logger") as logger:
         actor_procedure("bec_server.test.actor_test_utils", "EndpointInfo", "test", MagicMock())
         assert "is not a valid Actor!" in logger.error.call_args.args[0]
+
+
+class BlStateTestActor(BlStateActor):
+    state_table = {"test_state": "valid", "test_state_2": "valid"}
+
+
+def test_blstateactor_init_table_and_cache():
+    mock_client = MagicMock()
+
+    def get_status_by_name(name: str):
+        if name == "test_state":
+            return "valid"
+
+    mock_client.beamline_states.get_status_by_name.side_effect = get_status_by_name
+    actor = BlStateTestActor(mock_client, "Test", "Test")
+    actor.stop_event.set()
+    actor.run()
+
+    assert actor.state_table == {"test_state": "valid"}
+    assert actor.state_cache == {"test_state": "valid"}
+
+
+def test_bl_state_actor_waits_for_states():
+    mock_client = MagicMock()
+
+    mock_client.beamline_states.ready = False
+    actor = BlStateTestActor(mock_client, "Test", "Test")
+    actor.evaluate = MagicMock()
+    with patch("bec_server.actors.actor.logger") as mock_logger:
+        t = Thread(target=actor.run)
+        t.start()
+        sleep(0.1)
+        mock_logger.warning.assert_called()
+        actor.evaluate.assert_not_called()
+        mock_client.beamline_states.ready = True
+        sleep(0.2)
+        actor.stop_event.set()
+        t.join()
+    actor.evaluate.assert_called()

bec_server/tests/tests_scan_server/test_builtin_actor_manager.py

@@ -3,6 +3,11 @@
 
 import pytest
 
+from bec_lib.messages import (
+    AvailableBeamlineStatesMessage,
+    ScanInterlockModifyStateTableMessage,
+    ScanInterlockStateTableContent,
+)
 from bec_server.actors.builtin_actor_manager import BuiltinActorManager
 
 
@@ -148,3 +153,42 @@ def test_shutdown_stops_all_and_shuts_down_client(mocked_manager):
     assert mock_stop.call_count == 2
 
     mock_client.shutdown.assert_called_once()
+
+
+def _req_msg(action, state_name, status):
+    return {
+        "data": ScanInterlockModifyStateTableMessage(
+            action=action, state_name=state_name, status=status
+        )
+    }
+
+
+INITIAL_STATES = {"initial_state_1": "valid", "initial_state_2": "valid"}
+
+
+@pytest.mark.parametrize(
+    ["modification_request", "new_watched_states"],
+    [
+        (_req_msg("add", "test_state", "valid"), {**INITIAL_STATES, "test_state": "valid"}),
+        (_req_msg("remove", "initial_state_1", None), {"initial_state_2": "valid"}),
+        (_req_msg("remove_all", None, None), {}),
+        (_req_msg("remove", "missing_state", None), INITIAL_STATES),
+    ],
+)
+def test_modify_interlock_table(mocked_manager, modification_request, new_watched_states):
+    manager, mock_client = mocked_manager
+    mock_client.connector.get.return_value = ScanInterlockStateTableContent(
+        states_watched=INITIAL_STATES
+    )
+    manager._modify_interlock_table(modification_request)
+    assert mock_client.connector.set.call_args.args[1].states_watched == new_watched_states
+
+
+def test_handle_state_update(mocked_manager):
+    manager, _ = mocked_manager
+    manager._current_watched_states = lambda: {"test_state": "valid"}
+    manager._modify_interlock_table = MagicMock()
+    manager._handle_state_update({"data": AvailableBeamlineStatesMessage(states=[])})
+    manager._modify_interlock_table.assert_called_with(
+        {"data": ScanInterlockModifyStateTableMessage(action="remove", state_name="test_state")}
+    )