osm_lcm/lcm_utils.py

   1 # -*- coding: utf-8 -*-
   2
   3 ##
   4 # Copyright 2018 Telefonica S.A.
   5 #
   6 # Licensed under the Apache License, Version 2.0 (the "License"); you may
   7 # not use this file except in compliance with the License. You may obtain
   8 # a copy of the License at
   9 #
  10 #         http://www.apache.org/licenses/LICENSE-2.0
  11 #
  12 # Unless required by applicable law or agreed to in writing, software
  13 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  14 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  15 # License for the specific language governing permissions and limitations
  16 # under the License.
  17 ##
  18
  19 from collections import OrderedDict
  20 from osm_common.dbbase import DbException
  21
  22 __author__ = "Alfonso Tierno"
  23
  24
  25 class LcmException(Exception):
  26     pass
  27
  28
  29 class LcmExceptionNoMgmtIP(LcmException):
  30     pass
  31
  32
  33 def versiontuple(v):
  34     """utility for compare dot separate versions. Fills with zeros to proper number comparison
  35     package version will be something like 4.0.1.post11+gb3f024d.dirty-1. Where 4.0.1 is the git tag, postXX is the
  36     number of commits from this tag, and +XXXXXXX is the git commit short id. Total length is 16 with until 999 commits
  37     """
  38     filled = []
  39     for point in v.split("."):
  40         filled.append(point.zfill(16))
  41     return tuple(filled)
  42
  43
  44 class TaskRegistry:
  45     """
  46     Implements a registry of task needed for later cancelation, look for related tasks that must be completed before
  47     etc. It stores a four level dict
  48     First level is the topic, ns, vim_account, sdn
  49     Second level is the _id
  50     Third level is the operation id
  51     Fourth level is a descriptive name, the value is the task class
  52     """
  53
  54     def __init__(self):
  55         self.task_registry = {
  56             "ns": {},
  57             "nsi": {},
  58             "vim_account": {},
  59             "wim_account": {},
  60             "sdn": {},
  61         }
  62
  63     def register(self, topic, _id, op_id, task_name, task):
  64         """
  65         Register a new task
  66         :param topic: Can be "ns", "nsi", "vim_account", "sdn"
  67         :param _id: _id of the related item
  68         :param op_id: id of the operation of the related item
  69         :param task_name: Task descriptive name, as create, instantiate, terminate. Must be unique in this op_id
  70         :param task: Task class
  71         :return: none
  72         """
  73         if _id not in self.task_registry[topic]:
  74             self.task_registry[topic][_id] = OrderedDict()
  75         if op_id not in self.task_registry[topic][_id]:
  76             self.task_registry[topic][_id][op_id] = {task_name: task}
  77         else:
  78             self.task_registry[topic][_id][op_id][task_name] = task
  79         # print("registering task", topic, _id, op_id, task_name, task)
  80
  81     def remove(self, topic, _id, op_id, task_name=None):
  82         """
  83         When task is ended, it should removed. It ignores missing tasks
  84         :param topic: Can be "ns", "nsi", "vim_account", "sdn"
  85         :param _id: _id of the related item
  86         :param op_id: id of the operation of the related item
  87         :param task_name: Task descriptive name. If note it deletes all
  88         :return:
  89         """
  90         if not self.task_registry[topic].get(_id) or not self.task_registry[topic][_id].get(op_id):
  91             return
  92         if not task_name:
  93             # print("deleting tasks", topic, _id, op_id, self.task_registry[topic][_id][op_id])
  94             del self.task_registry[topic][_id][op_id]
  95         elif task_name in self.task_registry[topic][_id][op_id]:
  96             # print("deleting tasks", topic, _id, op_id, task_name, self.task_registry[topic][_id][op_id][task_name])
  97             del self.task_registry[topic][_id][op_id][task_name]
  98             if not self.task_registry[topic][_id][op_id]:
  99                 del self.task_registry[topic][_id][op_id]
 100         if not self.task_registry[topic][_id]:
 101             del self.task_registry[topic][_id]
 102
 103     def lookfor_related(self, topic, _id, my_op_id=None):
 104         task_list = []
 105         task_name_list = []
 106         if _id not in self.task_registry[topic]:
 107             return "", task_name_list
 108         for op_id in reversed(self.task_registry[topic][_id]):
 109             if my_op_id:
 110                 if my_op_id == op_id:
 111                     my_op_id = None  # so that the next task is taken
 112                 continue
 113
 114             for task_name, task in self.task_registry[topic][_id][op_id].items():
 115                 task_list.append(task)
 116                 task_name_list.append(task_name)
 117             break
 118         return ", ".join(task_name_list), task_list
 119
 120     def cancel(self, topic, _id, target_op_id=None, target_task_name=None):
 121         """
 122         Cancel all active tasks of a concrete ns, nsi, vim_account, sdn identified for _id. If op_id is supplied only
 123         this is cancelled, and the same with task_name
 124         """
 125         if not self.task_registry[topic].get(_id):
 126             return
 127         for op_id in reversed(self.task_registry[topic][_id]):
 128             if target_op_id and target_op_id != op_id:
 129                 continue
 130             for task_name, task in self.task_registry[topic][_id][op_id].items():
 131                 if target_task_name and target_task_name != task_name:
 132                     continue
 133                 # result =
 134                 task.cancel()
 135                 # if result:
 136                 #     self.logger.debug("{} _id={} order_id={} task={} cancelled".format(topic, _id, op_id, task_name))
 137
 138
 139 class LcmBase:
 140
 141     def __init__(self, db, msg, fs, logger):
 142         """
 143
 144         :param db: database connection
 145         """
 146         self.db = db
 147         self.msg = msg
 148         self.fs = fs
 149         self.logger = logger
 150
 151     def update_db_2(self, item, _id, _desc):
 152         """
 153         Updates database with _desc information. Upon success _desc is cleared
 154         :param item:
 155         :param _id:
 156         :param _desc:
 157         :return:
 158         """
 159         if not _desc:
 160             return
 161         try:
 162             self.db.set_one(item, {"_id": _id}, _desc)
 163             _desc.clear()
 164         except DbException as e:
 165             self.logger.error("Updating {} _id={} with '{}'. Error: {}".format(item, _id, _desc, e))