osm_policy_module/common/message_bus_client.py

   1 # -*- coding: utf-8 -*-
   2
   3 # Copyright 2018 Whitestack, LLC
   4 # *************************************************************
   5
   6 # This file is part of OSM Monitoring module
   7 # All Rights Reserved to Whitestack, LLC
   8
   9 # Licensed under the Apache License, Version 2.0 (the "License"); you may
  10 # not use this file except in compliance with the License. You may obtain
  11 # a copy of the License at
  12
  13 #         http://www.apache.org/licenses/LICENSE-2.0
  14
  15 # Unless required by applicable law or agreed to in writing, software
  16 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  17 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  18 # License for the specific language governing permissions and limitations
  19 # under the License.
  20
  21 # For those usages not covered by the Apache License, Version 2.0 please
  22 # contact: bdiaz@whitestack.com or glavado@whitestack.com
  23 ##
  24 import asyncio
  25 from typing import List, Callable
  26
  27 from osm_common import msgkafka, msglocal
  28
  29 from osm_policy_module.core.config import Config
  30
  31
  32 class MessageBusClient:
  33     def __init__(self, config: Config, loop=None):
  34         if config.get("message", "driver") == "local":
  35             self.msg_bus = msglocal.MsgLocal()
  36         elif config.get("message", "driver") == "kafka":
  37             self.msg_bus = msgkafka.MsgKafka()
  38         else:
  39             raise Exception(
  40                 "Unknown message bug driver {}".format(config.get("section", "driver"))
  41             )
  42         self.msg_bus.connect(config.get("message"))
  43         if not loop:
  44             loop = asyncio.get_event_loop()
  45         self.loop = loop
  46
  47     async def aioread(self, topics: List[str], callback: Callable = None, **kwargs):
  48         """
  49         Retrieves messages continuously from bus and executes callback for each message consumed.
  50         :param topics: List of message bus topics to consume from.
  51         :param callback: Async callback function to be called for each message received.
  52         :param kwargs: Keyword arguments to be passed to callback function.
  53         :return: None
  54         """
  55         await self.msg_bus.aioread(topics, self.loop, aiocallback=callback, **kwargs)
  56
  57     async def aiowrite(self, topic: str, key: str, msg: dict):
  58         """
  59         Writes message to bus.
  60         :param topic: Topic to write to.
  61         :param key: Key to write to.
  62         :param msg: Dictionary containing message to be written.
  63         :return: None
  64         """
  65         await self.msg_bus.aiowrite(topic, key, msg, self.loop)
  66
  67     async def aioread_once(self, topic: str):
  68         """
  69         Retrieves last message from bus.
  70         :param topic: topic to retrieve message from.
  71         :return: tuple(topic, key, message)
  72         """
  73         result = await self.msg_bus.aioread(topic, self.loop)
  74         return result