freshmaker

Clone

#8 Rename Trigger to Event.
Merged 8 years ago by jkaluza. Opened 8 years ago by jkaluza.
jkaluza/freshmaker fix-naming  into  master

file modified
+10 -10 
@@ -31,7 +31,7 @@ 
 

  import freshmaker.parsers.mbsmodule
 

  import freshmaker.parsers.gitreceive
 

  

- from freshmaker import log, conf, messaging, triggers
 

+ from freshmaker import log, conf, messaging, events
 

  

  

  class FreshmakerConsumer(fedmsg.consumers.FedmsgConsumer):
 
@@ -61,11 +61,11 @@ 
 

              self.incoming.put(msg)
 

  

      def register_parsers(self):
 

-         triggers.BaseTrigger.register_parser(freshmaker.parsers.mbsmodule.MBSModuleParser)
 

-         triggers.BaseTrigger.register_parser(freshmaker.parsers.gitreceive.GitReceiveParser)
 

-         log.debug("Parser classes: %r", triggers.BaseTrigger._parsers)
 

+         events.BaseEvent.register_parser(freshmaker.parsers.mbsmodule.MBSModuleParser)
 

+         events.BaseEvent.register_parser(freshmaker.parsers.gitreceive.GitReceiveParser)
 

+         log.debug("Parser classes: %r", events.BaseEvent._parsers)
 

  

-         self.topic = triggers.BaseTrigger.get_parsing_topics()
 

+         self.topic = events.BaseEvent.get_parsed_topics()
 

          log.debug('Setting topics: {}'.format(', '.join(self.topic)))
 

  

      def shutdown(self):
 
@@ -77,7 +77,7 @@ 
 

      def validate(self, message):
 

          if conf.messaging == 'fedmsg':
 

              # If this is a faked internal message, don't bother.
 

-             if isinstance(message, triggers.BaseTrigger):
 

+             if isinstance(message, events.BaseEvent):
 

                  log.info("Skipping crypto validation for %r" % message)
 

                  return
 

              # Otherwise, if it is a real message from the network, pass it
 
@@ -92,14 +92,14 @@ 
 

          # 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, triggers.BaseTrigger):
 

+         if isinstance(message, events.BaseEvent):
 

              msg = message
 

          else:
 

              msg = self.get_abstracted_msg(message['body'])
 

  

          # Primary work is done here.
 

          try:
 

-             self.process_trigger(msg)
 

+             self.process_event(msg)
 

          except Exception:
 

              log.exception('Failed while handling {0!r}'.format(msg))
 

  
@@ -109,14 +109,14 @@ 
 

      def get_abstracted_msg(self, message):
 

          # Convert the message to an abstracted message
 

          if conf.messaging == 'fedmsg' or conf.messaging == 'in_memory':
 

-             msg = triggers.BaseTrigger.from_fedmsg(
 

+             msg = events.BaseEvent.from_fedmsg(
 

                  message['topic'], message)
 

          else:
 

              raise ValueError('The messaging format "{0}" is not supported'
 

                               .format(conf.messaging))
 

          return msg
 

  

-     def process_trigger(self, msg):
 

+     def process_event(self, msg):
 

          log.debug('Received a message with an ID of "{0}" and of type "{1}"'
 

                    .format(getattr(msg, 'msg_id', None), type(msg).__name__))

freshmaker/events.py freshmaker/triggers.py
file renamed
+16 -16 
@@ -31,13 +31,13 @@ 
 

      from funcsigs import signature
 

  

  

- class BaseTrigger(object):
 

+ class BaseEvent(object):
 

  

      _parsers = {}
 

  

      def __init__(self, msg_id):
 

          """
 

-         A base class to abstract triggers from different fedmsg messages.
 

+         A base class to abstract events from different fedmsg messages.
 

          :param msg_id: the id of the msg (e.g. 2016-SomeGUID)
 

          """
 

          self.msg_id = msg_id
 
@@ -57,19 +57,19 @@ 
 

      @classmethod
 

      def register_parser(cls, parser_class):
 

          """
 

-         Registers a parser for BaseTrigger which is used to parse
 

+         Registers a parser for BaseEvent which is used to parse
 

          fedmsg in `from_fedmsg(...)` method.
 

          """
 

-         BaseTrigger._parsers[parser_class.name] = parser_class()
 

+         BaseEvent._parsers[parser_class.name] = parser_class()
 

  

      @classmethod
 

-     def get_parsing_topics(cls):
 

+     def get_parsed_topics(cls):
 

          """
 

          Returns the list of topics this class is parsing using the
 

          registered parsers.
 

          """
 

          topic_suffixes = []
 

-         for parser in BaseTrigger._parsers.values():
 

+         for parser in BaseEvent._parsers.values():
 

              topic_suffixes.extend(parser.topic_suffixes)
 

          return ['{}.{}.'.format(pref.rstrip('.'), cat)
 

                  for pref, cat
 
@@ -106,14 +106,14 @@ 
 

      @staticmethod
 

      def from_fedmsg(topic, msg):
 

          """
 

-         Takes a fedmsg topic and message and converts it to a BaseTrigger
 

+         Takes a fedmsg topic and message and converts it to a BaseEvent
 

          object.
 

          :param topic: the topic of the fedmsg message
 

          :param msg: the message contents from the fedmsg message
 

-         :return: an object of BaseTrigger descent if the message is a type
 

+         :return: an object of BaseEvent descent if the message is a type
 

          that the app looks for, otherwise None is returned
 

          """
 

-         for parser in BaseTrigger._parsers.values():
 

+         for parser in BaseEvent._parsers.values():
 

              if not parser.can_parse(topic, msg):
 

                  continue
 

  
@@ -122,8 +122,8 @@ 
 

          return None
 

  

  

- class ModuleBuilt(BaseTrigger):
 

-     """ A class that inherits from BaseTrigger to provide a trigger
 

+ class ModuleBuilt(BaseEvent):
 

+     """ A class that inherits from BaseEvent to provide an event
 

      object for a module event generated by module-build-service
 

      :param msg_id: the id of the msg (e.g. 2016-SomeGUID)
 

      :param module_build_id: the id of the module build
 
@@ -135,9 +135,9 @@ 
 

          self.module_build_state = module_build_state
 

  

  

- class ModuleMetadataUpdated(BaseTrigger):
 

+ class ModuleMetadataUpdated(BaseEvent):
 

      """
 

-     Provides a trigger object for "Module metadata in dist-git updated".
 

+     Provides an event object for "Module metadata in dist-git updated".
 

      :param scm_url: SCM URL of a updated module.
 

      :param branch: Branch of updated module.
 

      """
 
@@ -147,9 +147,9 @@ 
 

          self.branch = branch
 

  

  

- class TestingTrigger(BaseTrigger):
 

+ class TestingEvent(BaseEvent):
 

      """
 

-     Trigger useds in unit-tests.
 

+     Event useds in unit-tests.
 

      """
 

      def __init__(self, msg_id):
 

-         super(TestingTrigger, self).__init__(msg_id)
 

+         super(TestingEvent, self).__init__(msg_id)

file modified
+6 -6 
@@ -37,21 +37,21 @@ 
 

  

  class BaseHandler(object):
 

      """
 

-     Abstract base class for trigger handlers.
 

+     Abstract base class for event handlers.
 

      """
 

      __metaclass__ = abc.ABCMeta
 

  

      @abc.abstractmethod
 

-     def can_handle(self, trigger):
 

+     def can_handle(self, event):
 

          """
 

-         Returns true if this class can handle this type of trigger.
 

+         Returns true if this class can handle this type of event.
 

          """
 

          raise NotImplementedError()
 

  

      @abc.abstractmethod
 

-     def handle(self, trigger):
 

+     def handle(self, event):
 

          """
 

-         Handles the trigger. Can return another BaseTrigger instances to
 

-         generate another triggers to be used by other local handlers.
 

+         Handles the event. Can return another BaseEvent instances to
 

+         generate another events to be used by other local handlers.
 

          """
 

          raise NotImplementedError()

file modified
+16 -16 
@@ -25,21 +25,21 @@ 
 

  

  from freshmaker import log, conf
 

  from freshmaker.handlers import BaseHandler
 

- from freshmaker.triggers import ModuleBuilt, TestingTrigger, ModuleMetadataUpdated
 

+ from freshmaker.events import ModuleBuilt, TestingEvent, ModuleMetadataUpdated
 

  

  

  class MBS(BaseHandler):
 

      name = "MBS"
 

  

-     def can_handle(self, trigger):
 

+     def can_handle(self, event):
 

          # Handle only "ready" state of ModuleBuilt.
 

          # TODO: Handle only when something depends on
 

          # this module.
 

-         if (isinstance(trigger, ModuleBuilt) and
 

-                 trigger.module_build_state == 5):
 

+         if (isinstance(event, ModuleBuilt) and
 

+                 event.module_build_state == 5):
 

              return True
 

  

-         if isinstance(trigger, ModuleMetadataUpdated):
 

+         if isinstance(event, ModuleMetadataUpdated):
 

              return True
 

  

          return False
 
@@ -64,23 +64,23 @@ 
 

              log.error("Error when triggering rebuild of %s: %s", scm_url, data)
 

              return None
 

  

-     def handle_metadata_update(self, trigger):
 

-         log.info("Triggering rebuild of %s, metadata updated", trigger.scm_url)
 

-         self.rebuild_module(trigger.scm_url, trigger.branch)
 

+     def handle_metadata_update(self, event):
 

+         log.info("Triggering rebuild of %s, metadata updated", event.scm_url)
 

+         self.rebuild_module(event.scm_url, event.branch)
 

  

          return []
 

  

-     def handle_module_built(self, trigger):
 

+     def handle_module_built(self, event):
 

          log.info("Triggering rebuild of modules depending on %r "
 

-                  "in MBS" % trigger)
 

+                  "in MBS" % event)
 

  

          # TODO: Just for initial testing of consumer
 

-         return [TestingTrigger("ModuleBuilt handled")]
 

+         return [TestingEvent("ModuleBuilt handled")]
 

  

-     def handle(self, trigger):
 

-         if isinstance(trigger, ModuleMetadataUpdated):
 

-             return self.handle_metadata_update(trigger)
 

-         elif isinstance(trigger, ModuleBuilt):
 

-             return self.handle_module_built(trigger)
 

+     def handle(self, event):
 

+         if isinstance(event, ModuleMetadataUpdated):
 

+             return self.handle_metadata_update(event)
 

+         elif isinstance(event, ModuleBuilt):
 

+             return self.handle_module_built(event)
 

  

          return []

file modified
+3 -3 
@@ -26,7 +26,7 @@ 
 

  """Generic messaging functions."""
 

  

  from freshmaker import log
 

- from freshmaker.triggers import BaseTrigger
 

+ from freshmaker.events import BaseEvent
 

  

  

  def publish(topic, msg, conf, service):
 
@@ -63,9 +63,9 @@ 
 

      _in_memory_msg_id += 1
 

  

      # Create fake fedmsg from the message so we can reuse
 

-     # the BaseTrigger.from_fedmsg code to get the particular BaseTrigger
 

+     # the BaseEvent.from_fedmsg code to get the particular BaseEvent
 

      # class instance.
 

-     wrapped_msg = BaseTrigger.from_fedmsg(
 

+     wrapped_msg = BaseEvent.from_fedmsg(
 

          service + "." + topic,
 

          {"msg_id": str(_in_memory_msg_id), "msg": msg},
 

      )

file modified
+2 -2 
@@ -26,7 +26,7 @@ 
 

  

  class BaseParser(object):
 

      """
 

-     Abstract parser class parsing fedmsg messages and generating triggers.
 

+     Abstract parser class parsing fedmsg messages and generating events.
 

      """
 

      __metaclass__ = abc.ABCMeta
 

      name = "abstract_parser"
 
@@ -42,6 +42,6 @@ 
 

      @abc.abstractmethod
 

      def parse(self, topic, msg):
 

          """
 

-         Parses the message and returns BaseTrigger object.
 

+         Parses the message and returns BaseEvent object.
 

          """
 

          raise NotImplementedError()

file modified
+1 -1 
@@ -23,7 +23,7 @@ 
 

  

  from freshmaker import log, conf
 

  from freshmaker.parsers import BaseParser
 

- from freshmaker.triggers import ModuleMetadataUpdated
 

+ from freshmaker.events import ModuleMetadataUpdated
 

  

  

  class GitReceiveParser(BaseParser):

file modified
+2 -2 
@@ -23,13 +23,13 @@ 
 

  

  from freshmaker import log
 

  from freshmaker.parsers import BaseParser
 

- from freshmaker.triggers import ModuleBuilt
 

+ from freshmaker.events import ModuleBuilt
 

  

  

  class MBSModuleParser(BaseParser):
 

      """
 

      Parser parsing message from module-build-service, generating
 

-     ModuleBuilt trigger.
 

+     ModuleBuilt event.
 

      """
 

      name = "MBSModuleParser"
 

      topic_suffixes = ["mbs.module.state.change"]

file modified
+3 -3 
@@ -37,7 +37,7 @@ 
 

  

      def test_consumer_processing_message(self, global_consumer):
 

          """
 

-         Tests that consumer parses the message, forwards the trigger
 

+         Tests that consumer parses the message, forwards the event
 

          to proper handler and is able to get the further work from
 

          the handler.
 

          """
 
@@ -59,5 +59,5 @@ 
 

  

          consumer.consume(msg)
 

  

-         trigger = consumer.incoming.get()
 

-         self.assertEqual(trigger.msg_id, "ModuleBuilt handled")
 

+         event = consumer.incoming.get()
 

+         self.assertEqual(event.msg_id, "ModuleBuilt handled")

Powered by Pagure 5.14.1
Documentation • File an Issue • About • SSH Hostkey/Fingerprint
© Red Hat, Inc. and others.