Changed tests which use the command_queue

to use waits, changed the
mocked_panda_standard_responses to wait
until the MockedAsyncioClient is set up
before proceeding with the test.

Author: evvaaaa

Diff for: tests/fixtures/mocked_panda.py

@@ -162,10 +162,15 @@ def __eq__(self, o):
 
 class MockedAsyncioClient:
     def __init__(
-        self, response_handler: ResponseHandler, command_queue: Optional[Queue] = None
+        self,
+        response_handler: ResponseHandler,
+        child_conn: Optional[Connection] = None,
+        command_queue: Optional[Queue] = None,
     ) -> None:
         self.response_handler = response_handler
         self.command_queue = command_queue
+        self.child_conn = child_conn
+        self.introspect_ran_already = False
 
     async def connect(self):
         """Connect does nothing"""
@@ -175,6 +180,17 @@ async def send(self, command: Command[T], *args: float) -> T:
         """Returns the response, args may include timeout"""
         if self.command_queue:
             self.command_queue.put(command_to_key(command))
+
+        if (
+            self.child_conn
+            and not self.introspect_ran_already
+            and isinstance(command, GetChanges)
+        ):
+            self.introspect_ran_already = True
+
+            # Now the panda has set up, tell the test to start
+            self.child_conn.send("R")
+
         response = self.response_handler(command)
         return response
 
@@ -259,15 +275,13 @@ def ioc_wrapper(
 
     async def inner_wrapper():
         create_softioc(
-            MockedAsyncioClient(response_handler, command_queue=command_queue),
+            MockedAsyncioClient(
+                response_handler, child_conn=child_conn, command_queue=command_queue
+            ),
             test_prefix,
             bobfile_dir,
         )
 
-        # mocked_interactive_ioc.assert_called_once()
-
-        child_conn.send("R")  # "Ready"
-
         # Leave this process running until its torn down by pytest
         await asyncio.Event().wait()
 
@@ -320,7 +334,7 @@ def create_subprocess_ioc_and_responses(
     with caplog.at_level(logging.WARNING):
         with caplog_workaround():
             ctx = get_multiprocessing_context()
-            command_queue: Queue = ctx.Queue(1000)
+            command_queue: Queue = ctx.Queue()
             parent_conn, child_conn = ctx.Pipe()
             p = ctx.Process(
                 target=ioc_wrapper,

Diff for: tests/test_hdf_ioc.py

@@ -2,8 +2,8 @@
 
 import asyncio
 import logging
-import time
 from asyncio import CancelledError
+from multiprocessing.connection import Connection
 from pathlib import Path
 from typing import AsyncGenerator, Generator
 from uuid import uuid4
@@ -19,6 +19,7 @@
     Rows,
     custom_logger,
     get_multiprocessing_context,
+    select_and_recv,
 )
 from mock.mock import AsyncMock, MagicMock, patch
 from pandablocks.asyncio import AsyncioClient
@@ -215,7 +216,9 @@ async def hdf5_controller(clear_records: None, standard_responses) -> AsyncGener
     await asyncio.sleep(0)
 
 
-def subprocess_func(namespace_prefix: str, standard_responses) -> None:
+def subprocess_func(
+    namespace_prefix: str, standard_responses, child_conn: Connection
+) -> None:
     """Function to start the HDF5 IOC"""
 
     async def wrapper():
@@ -225,6 +228,7 @@ async def wrapper():
         dispatcher = asyncio_dispatcher.AsyncioDispatcher()
         builder.LoadDatabase()
         softioc.iocInit(dispatcher)
+        child_conn.send("R")
 
         # Leave this coroutine running until it's torn down by pytest
         await asyncio.Event().wait()
@@ -240,12 +244,17 @@ def hdf5_subprocess_ioc_no_logging_check(
     """Create an instance of HDF5 class in its own subprocess, then start the IOC.
     Note you probably want to use `hdf5_subprocess_ioc` instead."""
     ctx = get_multiprocessing_context()
-    p = ctx.Process(target=subprocess_func, args=(NAMESPACE_PREFIX, standard_responses))
+    parent_conn, child_conn = ctx.Pipe()
+    p = ctx.Process(
+        target=subprocess_func, args=(NAMESPACE_PREFIX, standard_responses, child_conn)
+    )
     try:
         p.start()
-        time.sleep(3)  # Give IOC some time to start up
+        select_and_recv(parent_conn)  # Wait for IOC to start up
         yield
     finally:
+        child_conn.close()
+        parent_conn.close()
         p.terminate()
         p.join(10)
         # Should never take anywhere near 10 seconds to terminate, it's just there
@@ -261,16 +270,23 @@ def hdf5_subprocess_ioc(
     with caplog.at_level(logging.WARNING):
         with caplog_workaround():
             ctx = get_multiprocessing_context()
+            parent_conn, child_conn = ctx.Pipe()
             p = ctx.Process(
-                target=subprocess_func, args=(NAMESPACE_PREFIX, standard_responses)
+                target=subprocess_func,
+                args=(NAMESPACE_PREFIX, standard_responses, child_conn),
             )
-            p.start()
-            time.sleep(3)  # Give IOC some time to start up
-            yield
-            p.terminate()
-            p.join(10)
-            # Should never take anywhere near 10 seconds to terminate, it's just there
-            # to ensure the test doesn't hang indefinitely during cleanup
+            try:
+                p.start()
+                select_and_recv(parent_conn)  # Wait for IOC to start up
+                yield
+            finally:
+                child_conn.close()
+                parent_conn.close()
+                p.terminate()
+                p.join(10)
+                # Should never take anywhere near 10 seconds to terminate,
+                # it's just there to ensure the test doesn't hang indefinitely
+                # during cleanup
 
     # We expect all tests to pass without warnings (or worse) logged.
     assert (

Diff for: tests/test_ioc_system.py

@@ -1,5 +1,6 @@
 import asyncio
 import os
+from multiprocessing import Queue
 from pathlib import Path
 from typing import List, OrderedDict
 
@@ -211,6 +212,9 @@ async def test_create_softioc_time_panda_changes(mocked_panda_standard_responses
             TEST_PREFIX + ":PULSE1:DELAY.DRVL",
             drvl_queue.put,
         )
+        # The units value changes from ms to s in the test Client, which causes
+        # the DRVL value to change from 8e-06 to 8e-09, consistent to ms to s.
+
         assert await asyncio.wait_for(drvl_queue.get(), TIMEOUT) == 8e-06
         assert await asyncio.wait_for(egu_queue.get(), TIMEOUT) == "s"
         assert await asyncio.wait_for(units_queue.get(), TIMEOUT) == "s"
@@ -307,6 +311,11 @@ async def test_bobfiles_created(mocked_panda_standard_responses):
     assert len(old_files) == len(new_files)
 
 
+def multiprocessing_queue_to_list(queue: Queue):
+    queue.put(None)
+    return list(iter(queue.get, None))
+
+
 @pytest.mark.asyncio
 async def test_create_softioc_record_update_send_to_panda(
     mocked_panda_standard_responses,
@@ -318,12 +327,27 @@ async def test_create_softioc_record_update_send_to_panda(
         response_handler,
         command_queue,
     ) = mocked_panda_standard_responses
+    try:
+        trig_queue = asyncio.Queue()
+        m1 = camonitor(TEST_PREFIX + ":PCAP1:TRIG_EDGE", trig_queue.put, datatype=str)
+
+        # Wait for all the dummy changes to finish
+        assert await asyncio.wait_for(trig_queue.get(), TIMEOUT) == "Falling"
+        assert await asyncio.wait_for(trig_queue.get(), TIMEOUT) == "Either"
 
-    await asyncio.sleep(1.5)
-    await caput(TEST_PREFIX + ":PCAP1:TRIG_EDGE", "Falling", wait=True, timeout=TIMEOUT)
-    await asyncio.sleep(1.5)
-    command_queue.put(None)
-    commands_recieved_by_panda = list(iter(command_queue.get, None))
+        # Verify the pv has been put to
+        await caput(
+            TEST_PREFIX + ":PCAP1:TRIG_EDGE", "Falling", wait=True, timeout=TIMEOUT
+        )
+        assert await asyncio.wait_for(trig_queue.get(), TIMEOUT) == "Falling"
+    finally:
+        m1.close()
+
+    # Check the panda recieved the translated command
+    commands_recieved_by_panda = multiprocessing_queue_to_list(command_queue)
+    from pprint import pprint
+
+    pprint(commands_recieved_by_panda)
     assert (
         command_to_key(Put(field="PCAP1.TRIG_EDGE", value="Falling"))
         in commands_recieved_by_panda
@@ -343,11 +367,21 @@ async def test_create_softioc_arm_disarm(
         command_queue,
     ) = mocked_panda_standard_responses
 
-    await asyncio.sleep(1)
-    await caput(TEST_PREFIX + ":PCAP:ARM", 1, wait=True, timeout=TIMEOUT)
-    await caput(TEST_PREFIX + ":PCAP:ARM", 0, wait=True, timeout=TIMEOUT)
-    await asyncio.sleep(1)
-    command_queue.put(None)
-    commands_recieved_by_panda = list(iter(command_queue.get, None))
+    try:
+        arm_queue = asyncio.Queue()
+        m1 = camonitor(TEST_PREFIX + ":PCAP:ARM", arm_queue.put, datatype=str)
+        assert await asyncio.wait_for(arm_queue.get(), TIMEOUT) == "0"
+
+        # Put PVs and check the ioc sets the values
+        await caput(TEST_PREFIX + ":PCAP:ARM", "1", wait=True, timeout=TIMEOUT)
+        assert await asyncio.wait_for(arm_queue.get(), TIMEOUT) == "1"
+        await caput(TEST_PREFIX + ":PCAP:ARM", "0", wait=True, timeout=TIMEOUT)
+        assert await asyncio.wait_for(arm_queue.get(), TIMEOUT) == "0"
+
+    finally:
+        m1.close()
+
+    # Check the panda recieved the translated commands
+    commands_recieved_by_panda = multiprocessing_queue_to_list(command_queue)
     assert command_to_key(Arm()) in commands_recieved_by_panda
     assert command_to_key(Disarm()) in commands_recieved_by_panda

Diff for: tests/test_tables.py

@@ -195,7 +195,6 @@ async def test_create_softioc_table_update_send_to_panda(
         command_queue,
     ) = mocked_panda_standard_responses
 
-    await asyncio.sleep(1)
     await caput(TEST_PREFIX + ":SEQ1:TABLE:MODE", "EDIT", wait=True, timeout=TIMEOUT)
 
     await caput(
@@ -204,7 +203,6 @@ async def test_create_softioc_table_update_send_to_panda(
 
     await caput(TEST_PREFIX + ":SEQ1:TABLE:MODE", "SUBMIT", wait=True, timeout=TIMEOUT)
 
-    await asyncio.sleep(1)
     command_queue.put(None)
     commands_recieved_by_panda = list(iter(command_queue.get, None))
     assert (