Consumers: replace Greenwave with ResultsDB and WaiverDB (fedora-infr…

…a#4224)

This replaces the consumer that listens for Greenwave 'decision
change' messages with consumers that listen for ResultsDB and
WaiverDB "new result" / "new waiver" messages and update gating
decisions if the message may cause a change.

The goal here is to make it possible to remove the "decision
change" message code from Greenwave entirely, because in order
to publish those messages, Greenwave has to duplicate a lot of
Bodhi's knowledge about what kinds of decisions to ask for. This
being in Greenwave is really against the intended design of the
system, and means whenever anything changes about what kinds of
decision Bodhi might request, we need to change both Bodhi and
the Greenwave "decision change" publishing code.

Signed-off-by: Adam Williamson <awilliam@redhat.com>

bodhi/server/consumers/__init__.py

@@ -30,8 +30,9 @@
 from bodhi.server.config import config
 from bodhi.server.consumers.automatic_updates import AutomaticUpdateHandler
 from bodhi.server.consumers.signed import SignedHandler
-from bodhi.server.consumers.greenwave import GreenwaveHandler
 from bodhi.server.consumers.ci import CIHandler
+from bodhi.server.consumers.resultsdb import ResultsdbHandler
+from bodhi.server.consumers.waiverdb import WaiverdbHandler
 
 
 log = logging.getLogger('bodhi')
@@ -53,8 +54,9 @@ def __init__(self):
         self.handler_infos = [
             HandlerInfo('.buildsys.tag', "Signed", SignedHandler()),
             HandlerInfo('.buildsys.tag', 'Automatic Update', AutomaticUpdateHandler()),
-            HandlerInfo('.greenwave.decision.update', 'Greenwave', GreenwaveHandler()),
-            HandlerInfo('.ci.koji-build.test.running', 'CI', CIHandler())
+            HandlerInfo('.ci.koji-build.test.running', 'CI', CIHandler()),
+            HandlerInfo('.waiverdb.waiver.new', 'WaiverDB', WaiverdbHandler()),
+            HandlerInfo('.resultsdb.result.new', 'ResultsDB', ResultsdbHandler()),
         ]
 
     def __call__(self, msg: fedora_messaging.api.Message):  # noqa: D401

bodhi/server/consumers/resultsdb.py

@@ -0,0 +1,78 @@
+# Copyright Red Hat and others.
+#
+# This file is part of Bodhi.
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+"""
+The "resultsdb handler".
+
+This module is responsible for listening for messages from ResultsDB.
+If a message seems like it might be a result change for an update or
+build from an update, we re-check the gating decision for that update.
+"""
+
+import logging
+
+import fedora_messaging
+
+from bodhi.server.consumers.util import update_from_db_message
+from bodhi.server.models import TestGatingStatus
+from bodhi.server.util import transactional_session_maker
+
+log = logging.getLogger(__name__)
+
+
+class ResultsdbHandler:
+    """
+    The Bodhi ResultsDB Handler.
+
+    A fedora-messaging listener waiting for messages from resultsdb that may
+    affect gating status for an update.
+    """
+
+    def __init__(self):
+        """Initialize the handler."""
+        self.db_factory = transactional_session_maker()
+
+    def __call__(self, message: fedora_messaging.api.Message):
+        """Handle messages arriving with the configured topic."""
+        msg = message.body
+        if not msg:
+            log.debug("Ignoring message without body.")
+            return
+
+        passed = msg.get("outcome") in ("PASSED", "INFO")
+
+        data = msg.get("data")
+        if not data:
+            log.error(f"Couldn't find data dict in ResultsDB message {message.id}")
+            return
+
+        with self.db_factory():
+            # find the update
+            update = update_from_db_message(message.id, msg["data"])
+            if not update:
+                # update_from_db_message will already have logged why
+                return
+            # update the gating status if there's a chance it changed
+            status = update.test_gating_status
+            if (
+                (passed and status == TestGatingStatus.passed)
+                or (not passed and status == TestGatingStatus.failed)
+            ):
+                log.debug("Not updating test_gating_status as no chance of a change")
+                return
+            log.info(f"Updating the test_gating_status for: {update.alias}")
+            update.update_test_gating_status()

bodhi/server/consumers/util.py

@@ -0,0 +1,68 @@
+# Copyright Red Hat and others.
+#
+# This file is part of Bodhi.
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+"""Utility functions for message consumers."""
+
+import logging
+
+from bodhi.server.models import Build, Update
+
+log = logging.getLogger(__name__)
+
+def update_from_db_message(msgid: str, itemdict: dict):
+    """Find and return the relevant Bodhi update for a waiverdb or
+    resultsdb fedora_messaging message. Used by the resultsdb and
+    waiverdb consumers.
+
+    Args:
+        msgid:    the message ID (for logging purposes)
+        itemdict: the relevant dict from the message. 'subject' dict
+                  for a waiverdb message, 'item' dict for resultsdb.
+    Returns:
+        bodhi.server.models.Update or None: the relevant update, if
+                                            found.
+    """
+    itemtype = itemdict.get("type")
+    if not itemtype:
+        log.error(f"Couldn't find item type in message {msgid}")
+        return None
+    if itemtype not in ("koji_build", "bodhi_update"):
+        log.debug(f"Irrelevant item type {itemtype}")
+        return None
+
+    # find the update
+    if itemtype == "bodhi_update":
+        updateid = itemdict.get("item")
+        if not updateid:
+            log.error(f"Couldn't find update ID in message {msgid}")
+            return None
+        update = Update.get(updateid)
+        if not update:
+            log.error(f"Couldn't find update {updateid} in DB")
+            return None
+    else:
+        nvr = itemdict.get("nvr", itemdict.get("item"))
+        if not nvr:
+            log.error(f"Couldn't find nvr in message {msgid}")
+            return None
+        build = Build.get(nvr)
+        if not build:
+            log.error(f"Couldn't find build {nvr} in DB")
+            return None
+        update = build.update
+
+    return update

bodhi/server/consumers/waiverdb.py

@@ -0,0 +1,67 @@
+# Copyright Red Hat and others.
+#
+# This file is part of Bodhi.
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+"""
+The "waiverdb handler".
+
+This module is responsible for listening for 'new waiver' messages from
+WaiverDB, and re-checking the gating decision for the relevant update.
+"""
+
+import logging
+
+import fedora_messaging
+
+from bodhi.server.consumers.util import update_from_db_message
+from bodhi.server.models import TestGatingStatus
+from bodhi.server.util import transactional_session_maker
+
+log = logging.getLogger(__name__)
+
+
+class WaiverdbHandler:
+    """
+    The Bodhi WaiverDB Handler.
+
+    A fedora-messaging listener waiting for messages from WaiverDB and
+    updating gating status of the relevant update.
+    """
+
+    def __init__(self):
+        """Initialize the handler."""
+        self.db_factory = transactional_session_maker()
+
+    def __call__(self, message: fedora_messaging.api.Message):
+        """Handle messages arriving with the configured topic."""
+        msg = message.body
+        if not msg:
+            log.debug("Ignoring message without body.")
+            return
+
+        subject = msg.get("subject")
+        if subject is None:
+            log.error(f"Couldn't find subject in WaiverDB message {message.id}")
+            return
+
+        with self.db_factory():
+            # find the update
+            update = update_from_db_message(message.id, subject)
+            # update the gating status unless it's already "passed", a
+            # waiver can't change it from passed to anything else
+            if update and update.test_gating_status != TestGatingStatus.passed:
+                log.info(f"Updating the test_gating_status for: {update.alias}")
+                update.update_test_gating_status()

bodhi/tests/server/consumers/test_consumers.py

@@ -97,10 +97,21 @@ def test_messaging_callback_signed_automatic_update(self,
         signed_handler.assert_called_once_with(msg)
         automatic_update_handler.assert_called_once_with(msg)
 
-    @mock.patch('bodhi.server.consumers.GreenwaveHandler')
-    def test_messaging_callback_greenwave(self, Handler):
+    @mock.patch('bodhi.server.consumers.ResultsdbHandler')
+    def test_messaging_callback_resultsdb(self, Handler):
         msg = Message(
-            topic="org.fedoraproject.prod.greenwave.decision.update",
+            topic="org.fedoraproject.prod.resultsdb.result.new",
+            body={}
+        )
+        handler = mock.Mock()
+        Handler.side_effect = lambda: handler
+        Consumer()(msg)
+        handler.assert_called_once_with(msg)
+
+    @mock.patch('bodhi.server.consumers.WaiverdbHandler')
+    def test_messaging_callback_waiverdb(self, Handler):
+        msg = Message(
+            topic="org.fedoraproject.prod.waiverdb.waiver.new",
             body={}
         )
         handler = mock.Mock()