Add Controller.disconnect

Author: GDYendell

src/fastcs/control_system.py

@@ -144,6 +144,7 @@ async def block_forever():
         finally:
             logger.info("Shutting down FastCS")
             self._stop_scan_tasks()
+            await self._controller.disconnect()
 
     async def _interactive_shell(self, context: dict[str, Any]):
         """Spawn interactive shell in another thread and wait for it to complete."""

src/fastcs/controller.py

@@ -195,3 +195,6 @@ def __init__(
 
     async def connect(self) -> None:
         pass
+
+    async def disconnect(self) -> None:
+        pass

tests/assertable_controller.py

@@ -61,6 +61,9 @@ async def initialise(self) -> None:
     async def connect(self) -> None:
         self.connected = True
 
+    async def disconnect(self) -> None:
+        self.connected = False
+
     @command()
     async def go(self):
         pass

tests/test_control_system.py

@@ -162,3 +162,35 @@ async def raise_exception(self):
         # The task exception comes from scan method raise_exception
         assert isinstance(internal_exception, ValueError)
         assert "Scan Exception" == str(internal_exception)
+
+
+@pytest.mark.asyncio
+async def test_controller_connect_disconnect():
+    class MyTestController(Controller):
+        def __init__(self):
+            super().__init__()
+
+            self.connected = False
+
+        async def connect(self):
+            self.connected = True
+
+        async def disconnect(self):
+            self.connected = False
+
+    controller = MyTestController()
+
+    loop = asyncio.get_event_loop()
+    fastcs = FastCS(controller, [], loop)
+
+    task = asyncio.create_task(fastcs.serve(interactive=False))
+
+    # connect is called at the start of serve
+    await asyncio.sleep(0.1)
+    assert controller.connected
+
+    task.cancel()
+
+    # disconnect is called at the end of serve
+    await asyncio.sleep(0.1)
+    assert not controller.connected