diff mbox series

[meta-python,96/96] python3-pyzmq: Fix racy test_log ptests on loaded hosts

Message ID 20261115074918.2932593-96-khem.raj@oss.qualcomm.com
State New
Headers show
Series [meta-oe,01/96] crow: upgrade 1.3.4 -> 1.3.5 | expand

Commit Message

Khem Raj Nov. 15, 2026, 7:49 a.m. UTC
test_blank_root_topic publishes right after adding a subscription, so
on a loaded host the message is dropped and the test hits its 60s
timeout. It then leaves a handler with a closed socket on the shared
logger, and all following TestPubLog tests fail with ENOTSOCK.

Wait for the subscriptions with XPUB sockets instead of sleeping, and
remove leftover handlers in tearDown.

AI-Generated: Uses Claude Code
Signed-off-by: Khem Raj <khem.raj@oss.qualcomm.com>
---
 ...or-subscriptions-instead-of-sleeping.patch | 104 ++++++++++++++++++
 .../python/python3-pyzmq_27.2.0.bb            |   1 +
 2 files changed, 105 insertions(+)
 create mode 100644 meta-python/recipes-devtools/python/python3-pyzmq/0001-test_log-wait-for-subscriptions-instead-of-sleeping.patch
diff mbox series

Patch

diff --git a/meta-python/recipes-devtools/python/python3-pyzmq/0001-test_log-wait-for-subscriptions-instead-of-sleeping.patch b/meta-python/recipes-devtools/python/python3-pyzmq/0001-test_log-wait-for-subscriptions-instead-of-sleeping.patch
new file mode 100644
index 0000000000..6ee1a1b91f
--- /dev/null
+++ b/meta-python/recipes-devtools/python/python3-pyzmq/0001-test_log-wait-for-subscriptions-instead-of-sleeping.patch
@@ -0,0 +1,104 @@ 
+From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
+From: Khem Raj <khem.raj@oss.qualcomm.com>
+Date: Sat, 14 Nov 2026 08:57:25 -0800
+Subject: [PATCH] test_log: wait for subscriptions instead of sleeping
+
+The PUBHandler tests rely on short sleeps for the SUB subscriptions to
+reach the PUB socket, and test_blank_root_topic and test_root_topic
+publish right after adding a subscription without waiting at all. On a
+loaded machine the subscription arrives after the message is published,
+the message is dropped, and recv_multipart() blocks until the test
+timeout.
+
+Because handlers are removed from the shared 'zmqtest' logger only at
+the end of each test, such a failure also leaves a handler whose socket
+is closed in tearDown attached, and every following test fails with
+ENOTSOCK when it logs.
+
+Use XPUB sockets where the test creates the socket and wait for the
+subscription messages before publishing, and remove leftover handlers
+in tearDown.
+
+Upstream-Status: Submitted [Pending]
+
+Signed-off-by: Khem Raj <khem.raj@oss.qualcomm.com>
+---
+ tests/test_log.py | 29 +++++++++++++++++++++++------
+ 1 file changed, 23 insertions(+), 6 deletions(-)
+
+diff --git a/tests/test_log.py b/tests/test_log.py
+index a9cd40e..43d24d3 100644
+--- a/tests/test_log.py
++++ b/tests/test_log.py
+@@ -21,16 +21,33 @@ class TestPubLog(BaseZMQTestCase):
+         logger.setLevel(logging.DEBUG)
+         return logger
+
++    def tearDown(self):
++        # don't leave handlers with closed sockets behind if a test fails
++        logger = logging.getLogger('zmqtest')
++        for handler in logger.handlers[:]:
++            logger.removeHandler(handler)
++        super().tearDown()
++
++    def wait_for_subscriptions(self, xpub, n=1):
++        """Wait until n new subscriptions have reached the XPUB socket
++
++        Subscriptions are delivered asynchronously, so messages published
++        before they arrive are dropped.
++        """
++        for _ in range(n):
++            msg = xpub.recv()
++            assert msg[:1] == b'\x01'
++
+     def connect_handler(self, topic=None):
+         topic = self.topic if topic is None else topic
+         logger = self.logger
+-        pub, sub = self.create_bound_pair(zmq.PUB, zmq.SUB)
++        pub, sub = self.create_bound_pair(zmq.XPUB, zmq.SUB)
+         handler = handlers.PUBHandler(pub)
+         handler.setLevel(logging.DEBUG)
+         handler.root_topic = topic
+         logger.addHandler(handler)
+         sub.setsockopt(zmq.SUBSCRIBE, topic.encode())
+-        time.sleep(0.1)
++        self.wait_for_subscriptions(pub)
+         return logger, handler, sub
+
+     def test_init_iface(self):
+@@ -62,7 +79,7 @@ class TestPubLog(BaseZMQTestCase):
+         logger.removeHandler(handler)
+
+     def test_init_socket(self):
+-        pub, sub = self.create_bound_pair(zmq.PUB, zmq.SUB)
++        pub, sub = self.create_bound_pair(zmq.XPUB, zmq.SUB)
+         logger = self.logger
+         handler = handlers.PUBHandler(pub)
+         handler.setLevel(logging.DEBUG)
+@@ -73,9 +90,7 @@ class TestPubLog(BaseZMQTestCase):
+         assert handler.ctx is pub.context
+         assert handler.ctx is self.context
+         sub.setsockopt(zmq.SUBSCRIBE, self.topic.encode())
+-        import time
+-
+-        time.sleep(0.1)
++        self.wait_for_subscriptions(pub)
+         msg1 = 'message'
+         logger.info(msg1)
+
+@@ -91,6 +106,7 @@ class TestPubLog(BaseZMQTestCase):
+         self.sockets.append(sub2)
+         sub2.connect(self.iface)
+         sub2.setsockopt(zmq.SUBSCRIBE, b'')
++        self.wait_for_subscriptions(handler.socket)
+         handler.root_topic = b'twoonly'
+         msg1 = 'ignored'
+         logger.info(msg1)
+@@ -109,6 +125,7 @@ class TestPubLog(BaseZMQTestCase):
+         self.sockets.append(sub_only_info)
+         sub_only_info.connect(self.iface)
+         sub_only_info.setsockopt(zmq.SUBSCRIBE, b'INFO')
++        self.wait_for_subscriptions(handler.socket, 2)
+         handler.setRootTopic(b'')
+         msg_debug = 'debug_message'
+         logger.debug(msg_debug)
diff --git a/meta-python/recipes-devtools/python/python3-pyzmq_27.2.0.bb b/meta-python/recipes-devtools/python/python3-pyzmq_27.2.0.bb
index c2230a49b4..539d610317 100644
--- a/meta-python/recipes-devtools/python/python3-pyzmq_27.2.0.bb
+++ b/meta-python/recipes-devtools/python/python3-pyzmq_27.2.0.bb
@@ -28,6 +28,7 @@  PEP517_BUILD_OPTS = "--skip-dependency-check \
 "

 SRC_URI:append = " \
+    file://0001-test_log-wait-for-subscriptions-instead-of-sleeping.patch \
     file://run-ptest \
 "
 SRC_URI[sha256sum] = "54d4259d1bfae24ecdb5ca79f7acc2eac6c286a02d6a0ae617797cb45f0726d3"