From e11ef280e1c787299ced26cc2abf588de36b743c Mon Sep 17 00:00:00 2001
From: "James E. Blair" <jim@acmegating.com>
Date: Tue, 11 Oct 2022 14:13:34 -0700
Subject: Add debugging to waitUntilSettled

Some tests are failing to settle because the ZK queues are not
empty, but it is not clear which queue, and that makes the trouble
hard to track down.  Add debugging around this to try to understand
the problem more.

Change-Id: I5012dec9f80e5413c5303698325d510554d22d3a
---
 tests/base.py | 25 +++++++++++++++++++++++--
 1 file changed, 23 insertions(+), 2 deletions(-)

diff --git a/tests/base.py b/tests/base.py
index b85bce504..742041503 100644
--- a/tests/base.py
+++ b/tests/base.py
@@ -5491,28 +5491,49 @@ class ZuulTestCase(BaseTestCase):
         for event_queue in self.additional_event_queues:
             event_queue.join()
 
-    def __areZooKeeperEventQueuesEmpty(self, matcher=None) -> bool:
+    def __areZooKeeperEventQueuesEmpty(self, matcher=None, debug=False):
         for sched in map(lambda app: app.sched, self.scheds.filter(matcher)):
             for connection_name in sched.connections.connections:
                 if self.connection_event_queues[connection_name].hasEvents():
+                    if debug:
+                        self.log.debug(
+                            f"Connection queue {connection_name} not empty")
                     return False
             for tenant in sched.abide.tenants.values():
                 if sched.management_events[tenant.name].hasEvents():
+                    if debug:
+                        self.log.debug(
+                            f"Tenant management queue {tenant.name} not empty")
                     return False
                 if sched.trigger_events[tenant.name].hasEvents():
+                    if debug:
+                        self.log.debug(
+                            f"Tenant trigger queue {tenant.name} not empty")
                     return False
                 for pipeline_name in tenant.layout.pipelines:
                     if sched.pipeline_management_events[tenant.name][
                         pipeline_name
                     ].hasEvents():
+                        if debug:
+                            self.log.debug(
+                                "Pipeline management queue "
+                                f"{tenant.name} {pipeline_name} not empty")
                         return False
                     if sched.pipeline_trigger_events[tenant.name][
                         pipeline_name
                     ].hasEvents():
+                        if debug:
+                            self.log.debug(
+                                "Pipeline trigger queue "
+                                f"{tenant.name} {pipeline_name} not empty")
                         return False
                     if sched.pipeline_result_events[tenant.name][
                         pipeline_name
                     ].hasEvents():
+                        if debug:
+                            self.log.debug(
+                                "Pipeline result queue "
+                                f"{tenant.name} {pipeline_name} not empty")
                         return False
         return True
 
@@ -5534,7 +5555,7 @@ class ZuulTestCase(BaseTestCase):
                                self.__areAllSchedulersPrimed(matcher))
                 self._logQueueStatus(
                     self.log.error, matcher,
-                    self.__areZooKeeperEventQueuesEmpty(),
+                    self.__areZooKeeperEventQueuesEmpty(debug=True),
                     self.__areAllMergeJobsWaiting(),
                     self.__haveAllBuildsReported(),
                     self.__areAllBuildsWaiting(),
-- 
cgit v1.2.1