| # -*- coding: utf-8 -*- |
| |
| # Licensed under the Apache License, Version 2.0 (the "License"); |
| # you may not use this file except in compliance with the License. |
| # You may obtain a copy of the License at |
| # |
| # http://www.apache.org/licenses/LICENSE-2.0 |
| # |
| # Unless required by applicable law or agreed to in writing, software |
| # distributed under the License is distributed on an "AS IS" BASIS, |
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or |
| # implied. |
| # See the License for the specific language governing permissions and |
| # limitations under the License. |
| |
| """ |
| This module implements a thread that reads from kafka bus implementing all the subscriptions. |
| It is based on asyncio. |
| To avoid race conditions it uses same engine class as the main module for database changes |
| For the moment this module only deletes NS instances when they are terminated with the autoremove flag |
| """ |
| |
| import logging |
| import threading |
| import asyncio |
| from http import HTTPStatus |
| |
| from osm_common import dbmongo, dbmemory, msglocal, msgkafka |
| from osm_common.dbbase import DbException |
| from osm_common.msgbase import MsgException |
| from osm_nbi.engine import EngineException |
| from osm_nbi.notifications import NsLcmNotification, VnfLcmNotification |
| |
| __author__ = "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>" |
| |
| |
| class SubscriptionException(Exception): |
| def __init__(self, message, http_code=HTTPStatus.BAD_REQUEST): |
| self.http_code = http_code |
| Exception.__init__(self, message) |
| |
| |
| class SubscriptionThread(threading.Thread): |
| def __init__(self, config, engine): |
| """ |
| Constructor of class |
| :param config: configuration parameters of database and messaging |
| :param engine: an instance of Engine class, used for deleting instances |
| """ |
| threading.Thread.__init__(self) |
| self.to_terminate = False |
| self.config = config |
| self.db = None |
| self.msg = None |
| self.engine = engine |
| self.loop = None |
| self.logger = logging.getLogger("nbi.subscriptions") |
| self.aiomain_task_admin = ( |
| None # asyncio task for receiving admin actions from kafka bus |
| ) |
| self.aiomain_task = ( |
| None # asyncio task for receiving normal actions from kafka bus |
| ) |
| self.internal_session = { # used for a session to the engine methods |
| "project_id": (), |
| "set_project": (), |
| "admin": True, |
| "force": False, |
| "public": None, |
| "method": "delete", |
| } |
| self.nslcm = None |
| self.vnflcm = None |
| |
| async def start_kafka(self): |
| # timeout_wait_for_kafka = 3*60 |
| kafka_working = True |
| while not self.to_terminate: |
| try: |
| # bug 710 635. The library aiokafka does not recieve anything when the topci at kafka has not been |
| # created. |
| # Before subscribe, send dummy messages |
| await self.msg.aiowrite( |
| "admin", "echo", "dummy message", loop=self.loop |
| ) |
| await self.msg.aiowrite("ns", "echo", "dummy message", loop=self.loop) |
| await self.msg.aiowrite("nsi", "echo", "dummy message", loop=self.loop) |
| await self.msg.aiowrite("vnf", "echo", "dummy message", loop=self.loop) |
| if not kafka_working: |
| self.logger.critical("kafka is working again") |
| kafka_working = True |
| if not self.aiomain_task_admin: |
| await asyncio.sleep(10, loop=self.loop) |
| self.logger.debug("Starting admin subscription task") |
| self.aiomain_task_admin = asyncio.ensure_future( |
| self.msg.aioread( |
| ("admin",), |
| loop=self.loop, |
| group_id=False, |
| aiocallback=self._msg_callback, |
| ), |
| loop=self.loop, |
| ) |
| if not self.aiomain_task: |
| await asyncio.sleep(10, loop=self.loop) |
| self.logger.debug("Starting non-admin subscription task") |
| self.aiomain_task = asyncio.ensure_future( |
| self.msg.aioread( |
| ("ns", "nsi", "vnf"), |
| loop=self.loop, |
| aiocallback=self._msg_callback, |
| ), |
| loop=self.loop, |
| ) |
| done, _ = await asyncio.wait( |
| [self.aiomain_task, self.aiomain_task_admin], |
| timeout=None, |
| loop=self.loop, |
| return_when=asyncio.FIRST_COMPLETED, |
| ) |
| try: |
| if self.aiomain_task_admin in done: |
| exc = self.aiomain_task_admin.exception() |
| self.logger.error( |
| "admin subscription task exception: {}".format(exc) |
| ) |
| self.aiomain_task_admin = None |
| if self.aiomain_task in done: |
| exc = self.aiomain_task.exception() |
| self.logger.error( |
| "non-admin subscription task exception: {}".format(exc) |
| ) |
| self.aiomain_task = None |
| except asyncio.CancelledError: |
| pass |
| except Exception as e: |
| if self.to_terminate: |
| return |
| if kafka_working: |
| # logging only first time |
| self.logger.critical( |
| "Error accessing kafka '{}'. Retrying ...".format(e) |
| ) |
| kafka_working = False |
| await asyncio.sleep(10, loop=self.loop) |
| |
| def run(self): |
| """ |
| Start of the thread |
| :return: None |
| """ |
| self.loop = asyncio.new_event_loop() |
| try: |
| if not self.db: |
| if self.config["database"]["driver"] == "mongo": |
| self.db = dbmongo.DbMongo() |
| self.db.db_connect(self.config["database"]) |
| elif self.config["database"]["driver"] == "memory": |
| self.db = dbmemory.DbMemory() |
| self.db.db_connect(self.config["database"]) |
| else: |
| raise SubscriptionException( |
| "Invalid configuration param '{}' at '[database]':'driver'".format( |
| self.config["database"]["driver"] |
| ) |
| ) |
| if not self.msg: |
| config_msg = self.config["message"].copy() |
| config_msg["loop"] = self.loop |
| if config_msg["driver"] == "local": |
| self.msg = msglocal.MsgLocal() |
| self.msg.connect(config_msg) |
| elif config_msg["driver"] == "kafka": |
| self.msg = msgkafka.MsgKafka() |
| self.msg.connect(config_msg) |
| else: |
| raise SubscriptionException( |
| "Invalid configuration param '{}' at '[message]':'driver'".format( |
| config_msg["driver"] |
| ) |
| ) |
| self.nslcm = NsLcmNotification(self.db) |
| self.vnflcm = VnfLcmNotification(self.db) |
| except (DbException, MsgException) as e: |
| raise SubscriptionException(str(e), http_code=e.http_code) |
| |
| self.logger.debug("Starting") |
| while not self.to_terminate: |
| try: |
| |
| self.loop.run_until_complete( |
| asyncio.ensure_future(self.start_kafka(), loop=self.loop) |
| ) |
| # except asyncio.CancelledError: |
| # break # if cancelled it should end, breaking loop |
| except Exception as e: |
| if not self.to_terminate: |
| self.logger.exception( |
| "Exception '{}' at messaging read loop".format(e), exc_info=True |
| ) |
| |
| self.logger.debug("Finishing") |
| self._stop() |
| self.loop.close() |
| |
| async def _msg_callback(self, topic, command, params): |
| """ |
| Callback to process a received message from kafka |
| :param topic: topic received |
| :param command: command received |
| :param params: rest of parameters |
| :return: None |
| """ |
| msg_to_send = [] |
| try: |
| if topic == "ns": |
| if command == "terminated" and params["operationState"] in ( |
| "COMPLETED", |
| "PARTIALLY_COMPLETED", |
| ): |
| self.logger.debug("received ns terminated {}".format(params)) |
| if params.get("autoremove"): |
| self.engine.del_item( |
| self.internal_session, |
| "nsrs", |
| _id=params["nsr_id"], |
| not_send_msg=msg_to_send, |
| ) |
| self.logger.debug( |
| "ns={} deleted from database".format(params["nsr_id"]) |
| ) |
| # Check for nslcm notification |
| if isinstance(params, dict): |
| # Check availability of operationState and command |
| if ( |
| (not params.get("operationState")) |
| or (not command) |
| or (not params.get("operationParams")) |
| ): |
| self.logger.debug( |
| "Message can not be used for notification of nslcm" |
| ) |
| else: |
| nsd_id = params["operationParams"].get("nsdId") |
| ns_instance_id = params["operationParams"].get("nsInstanceId") |
| # Any one among nsd_id, ns_instance_id should be present. |
| if not (nsd_id or ns_instance_id): |
| self.logger.debug( |
| "Message can not be used for notification of nslcm" |
| ) |
| else: |
| op_state = params["operationState"] |
| event_details = { |
| "topic": topic, |
| "command": command.upper(), |
| "params": params, |
| } |
| subscribers = self.nslcm.get_subscribers( |
| nsd_id, |
| ns_instance_id, |
| command.upper(), |
| op_state, |
| event_details, |
| ) |
| # self.logger.debug("subscribers list: ") |
| # self.logger.debug(subscribers) |
| if subscribers: |
| asyncio.ensure_future( |
| self.nslcm.send_notifications( |
| subscribers, loop=self.loop |
| ), |
| loop=self.loop, |
| ) |
| else: |
| self.logger.debug( |
| "Message can not be used for notification of nslcm" |
| ) |
| elif topic == "vnf": |
| if isinstance(params, dict): |
| vnfd_id = params["vnfdId"] |
| vnf_instance_id = params["vnfInstanceId"] |
| if command == "create" or command == "delete": |
| op_state = command |
| else: |
| op_state = params["operationState"] |
| event_details = { |
| "topic": topic, |
| "command": command.upper(), |
| "params": params, |
| } |
| subscribers = self.vnflcm.get_subscribers( |
| vnfd_id, |
| vnf_instance_id, |
| command.upper(), |
| op_state, |
| event_details |
| ) |
| if subscribers: |
| asyncio.ensure_future( |
| self.vnflcm.send_notifications( |
| subscribers, loop=self.loop |
| ), |
| loop=self.loop |
| ) |
| elif topic == "nsi": |
| if command == "terminated" and params["operationState"] in ( |
| "COMPLETED", |
| "PARTIALLY_COMPLETED", |
| ): |
| self.logger.debug("received nsi terminated {}".format(params)) |
| if params.get("autoremove"): |
| self.engine.del_item( |
| self.internal_session, |
| "nsis", |
| _id=params["nsir_id"], |
| not_send_msg=msg_to_send, |
| ) |
| self.logger.debug( |
| "nsis={} deleted from database".format(params["nsir_id"]) |
| ) |
| elif topic == "admin": |
| self.logger.debug("received {} {} {}".format(topic, command, params)) |
| if command in ["echo", "ping"]: # ignored commands |
| pass |
| elif command == "revoke_token": |
| if params: |
| if isinstance(params, dict) and "_id" in params: |
| tid = params.get("_id") |
| self.engine.authenticator.tokens_cache.pop(tid, None) |
| self.logger.debug( |
| "token '{}' removed from token_cache".format(tid) |
| ) |
| else: |
| self.logger.debug( |
| "unrecognized params in command '{} {}': {}".format( |
| topic, command, params |
| ) |
| ) |
| else: |
| self.engine.authenticator.tokens_cache.clear() |
| self.logger.debug("token_cache cleared") |
| else: |
| self.logger.debug( |
| "unrecognized command '{} {}'".format(topic, command) |
| ) |
| # writing to kafka must be done with our own loop. For this reason it is not allowed Engine to do that, |
| # but content to be written is stored at msg_to_send |
| for msg in msg_to_send: |
| await self.msg.aiowrite(*msg, loop=self.loop) |
| except (EngineException, DbException, MsgException) as e: |
| self.logger.error( |
| "Error while processing topic={} command={}: {}".format( |
| topic, command, e |
| ) |
| ) |
| except Exception as e: |
| self.logger.exception( |
| "Exception while processing topic={} command={}: {}".format( |
| topic, command, e |
| ), |
| exc_info=True, |
| ) |
| |
| def _stop(self): |
| """ |
| Close all connections |
| :return: None |
| """ |
| try: |
| if self.db: |
| self.db.db_disconnect() |
| if self.msg: |
| self.msg.disconnect() |
| except (DbException, MsgException) as e: |
| raise SubscriptionException(str(e), http_code=e.http_code) |
| |
| def terminate(self): |
| """ |
| This is a threading safe method to terminate this thread. Termination is done asynchronous afterwards, |
| but not immediately. |
| :return: None |
| """ |
| self.to_terminate = True |
| if self.aiomain_task: |
| self.loop.call_soon_threadsafe(self.aiomain_task.cancel) |
| if self.aiomain_task_admin: |
| self.loop.call_soon_threadsafe(self.aiomain_task_admin.cancel) |