mirror of
https://pagure.io/fm-orchestrator.git
synced 2026-04-08 05:08:45 +08:00
201 lines
8.5 KiB
Python
201 lines
8.5 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Copyright (c) 2016 Red Hat, Inc.
|
|
#
|
|
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
# of this software and associated documentation files (the "Software"), to deal
|
|
# in the Software without restriction, including without limitation the rights
|
|
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
# copies of the Software, and to permit persons to whom the Software is
|
|
# furnished to do so, subject to the following conditions:
|
|
#
|
|
# The above copyright notice and this permission notice shall be included in all
|
|
# copies or substantial portions of the Software.
|
|
#
|
|
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
# SOFTWARE.
|
|
#
|
|
|
|
""" The FedmsgConsumer class that acts as a consumer entry point for fedmsg-hub.
|
|
This class reads and processes messages from the message bus it is configured
|
|
to use.
|
|
"""
|
|
|
|
import koji
|
|
import inspect
|
|
import fedmsg.consumers
|
|
import moksha.hub
|
|
|
|
from module_build_service.utils import module_build_state_from_msg
|
|
import module_build_service.messaging
|
|
import module_build_service.scheduler.handlers.repos
|
|
import module_build_service.scheduler.handlers.components
|
|
import module_build_service.scheduler.handlers.modules
|
|
from module_build_service import models, log, conf
|
|
|
|
|
|
class MBSConsumer(fedmsg.consumers.FedmsgConsumer):
|
|
""" This is triggered by running fedmsg-hub. This class is responsible for
|
|
ingesting and processing messages from the message bus.
|
|
"""
|
|
topic = '*'
|
|
config_key = 'mbsconsumer'
|
|
|
|
def __init__(self, hub):
|
|
super(MBSConsumer, self).__init__(hub)
|
|
|
|
# These two values are typically provided either by the unit tests or
|
|
# by the local build command. They are empty in the production environ
|
|
self.stop_condition = hub.config.get('mbsconsumer.stop_condition')
|
|
initial_messages = hub.config.get('mbsconsumer.initial_messages', [])
|
|
for msg in initial_messages:
|
|
self.incoming.put(msg)
|
|
|
|
# These are our main lookup tables for figuring out what to run in
|
|
# response to what messaging events.
|
|
self.NO_OP = NO_OP = lambda config, session, msg: True
|
|
self.on_build_change = {
|
|
koji.BUILD_STATES["BUILDING"]: NO_OP,
|
|
koji.BUILD_STATES[
|
|
"COMPLETE"]: module_build_service.scheduler.handlers.components.complete,
|
|
koji.BUILD_STATES[
|
|
"FAILED"]: module_build_service.scheduler.handlers.components.failed,
|
|
koji.BUILD_STATES[
|
|
"CANCELED"]: module_build_service.scheduler.handlers.components.canceled,
|
|
koji.BUILD_STATES["DELETED"]: NO_OP,
|
|
}
|
|
self.on_module_change = {
|
|
models.BUILD_STATES["init"]: NO_OP,
|
|
models.BUILD_STATES[
|
|
"wait"]: module_build_service.scheduler.handlers.modules.wait,
|
|
models.BUILD_STATES["build"]: NO_OP,
|
|
models.BUILD_STATES[
|
|
"failed"]: module_build_service.scheduler.handlers.modules.failed,
|
|
models.BUILD_STATES[
|
|
"done"]: module_build_service.scheduler.handlers.modules.done,
|
|
# XXX: DIRECT TRANSITION TO READY
|
|
models.BUILD_STATES["ready"]: NO_OP,
|
|
}
|
|
# Only one kind of repo change event, though...
|
|
self.on_repo_change = module_build_service.scheduler.handlers.repos.done
|
|
self.sanity_check()
|
|
|
|
def shutdown(self):
|
|
log.info("Shutting down..")
|
|
self.hub.stop()
|
|
from moksha.hub.reactor import reactor
|
|
reactor.callFromThread(reactor.stop)
|
|
|
|
def consume(self, message):
|
|
log.info("Received %r" % message)
|
|
|
|
if self.stop_condition and self.stop_condition(message):
|
|
return self.shutdown()
|
|
|
|
# Sometimes, the messages put into our queue are artificially put there
|
|
# by other parts of our own codebase. If they are already abstracted
|
|
# messages, then just use them as-is. If they are not already
|
|
# instances of our message abstraction base class, then first transform
|
|
# them before proceeding.
|
|
if isinstance(message, module_build_service.messaging.BaseMessage):
|
|
msg = message
|
|
else:
|
|
msg = self.get_abstracted_msg(message['body'])
|
|
|
|
# Primary work is done here.
|
|
try:
|
|
with models.make_session(conf) as session:
|
|
self.process_message(session, msg)
|
|
except Exception:
|
|
log.exception('Failed while handling {0!r}'.format(msg.msg_id))
|
|
log.info(msg)
|
|
|
|
def get_abstracted_msg(self, message):
|
|
# Convert the message to an abstracted message
|
|
if conf.messaging == 'fedmsg':
|
|
msg = module_build_service.messaging.BaseMessage.from_fedmsg(
|
|
message['topic'], message)
|
|
elif conf.messaging == 'amq':
|
|
msg = module_build_service.messaging.BaseMessage.from_amq(
|
|
message['topic'], message)
|
|
else:
|
|
raise ValueError('The messaging format "{0}" is not supported'
|
|
.format(conf.messaging))
|
|
return msg
|
|
|
|
def sanity_check(self):
|
|
""" On startup, make sure our implementation is sane. """
|
|
# Ensure we have every state covered
|
|
for state in models.BUILD_STATES:
|
|
if models.BUILD_STATES[state] not in self.on_module_change:
|
|
raise KeyError("Module build states %r not handled." % state)
|
|
for state in koji.BUILD_STATES:
|
|
if koji.BUILD_STATES[state] not in self.on_build_change:
|
|
raise KeyError("Koji build states %r not handled." % state)
|
|
|
|
all_fns = (list(self.on_build_change.items()) +
|
|
list(self.on_module_change.items()))
|
|
for key, callback in all_fns:
|
|
expected = ['config', 'session', 'msg']
|
|
argspec = inspect.getargspec(callback)[0]
|
|
if argspec != expected:
|
|
raise ValueError("Callback %r, state %r has argspec %r!=%r" % (
|
|
callback, key, argspec, expected))
|
|
|
|
def process_message(self, session, msg):
|
|
log.debug('Received a message with an ID of "{0}" and of type "{1}"'
|
|
.format(msg.msg_id, type(msg).__name__))
|
|
|
|
# Choose a handler for this message
|
|
if type(msg) == module_build_service.messaging.KojiBuildChange:
|
|
handler = self.on_build_change[msg.build_new_state]
|
|
elif type(msg) == module_build_service.messaging.KojiRepoChange:
|
|
handler = self.on_repo_change
|
|
elif type(msg) == module_build_service.messaging.RidaModule:
|
|
handler = self.on_module_change[module_build_state_from_msg(msg)]
|
|
else:
|
|
log.debug("Unhandled message...")
|
|
return
|
|
|
|
# Execute our chosen handler
|
|
idx = "%s: %s, %s" % (handler.__name__, type(msg).__name__, msg.msg_id)
|
|
if handler is self.NO_OP:
|
|
log.debug("Handler is NO_OP: %s" % idx)
|
|
else:
|
|
log.info("Calling %s" % idx)
|
|
further_work = handler(conf, session, msg) or []
|
|
log.info("Done with %s" % idx)
|
|
|
|
# Handlers can *optionally* return a list of fake messages that
|
|
# should be re-inserted back into the main work queue. We can use
|
|
# this (for instance) when we submit a new component build but (for
|
|
# some reason) it has already been built, then it can fake its own
|
|
# completion back to the scheduler so that work resumes as if it
|
|
# was submitted for real and koji announced its completion.
|
|
for event in further_work:
|
|
log.info(" Scheduling faked event %r" % event)
|
|
self.incoming.put(event)
|
|
|
|
|
|
def get_global_consumer():
|
|
""" Return a handle to the active consumer object, if it exists. """
|
|
hub = moksha.hub._hub
|
|
if not hub:
|
|
raise ValueError("No global moksha-hub obj found.")
|
|
|
|
for consumer in hub.consumers:
|
|
if isinstance(consumer, MBSConsumer):
|
|
return consumer
|
|
|
|
raise ValueError("No MBSConsumer found.")
|
|
|
|
|
|
def work_queue_put(msg):
|
|
""" Artificially put a message into the work queue of the consumer. """
|
|
consumer = get_global_consumer()
|
|
consumer.incoming.put(msg)
|