Reformat LCM to standardized format
[osm/LCM.git] / osm_lcm / lcm_utils.py
index bb53d7c..16d5b33 100644 (file)
 
 import asyncio
 from collections import OrderedDict
+from time import time
+from osm_lcm.data_utils.database.database import Database
+from osm_lcm.data_utils.filesystem.filesystem import Filesystem
+
 # from osm_common.dbbase import DbException
 
 __author__ = "Alfonso Tierno"
@@ -42,21 +46,65 @@ def versiontuple(v):
     """
     filled = []
     for point in v.split("."):
-        filled.append(point.zfill(16))
+        point, _, _ = point.partition("+")
+        point, _, _ = point.partition("-")
+        filled.append(point.zfill(20))
     return tuple(filled)
 
 
-# LcmBase must be listed before TaskRegistry, as it is a dependency.
-class LcmBase:
+def deep_get(target_dict, key_list, default_value=None):
+    """
+    Get a value from target_dict entering in the nested keys. If keys does not exist, it returns None
+    Example target_dict={a: {b: 5}}; key_list=[a,b] returns 5; both key_list=[a,b,c] and key_list=[f,h] return None
+    :param target_dict: dictionary to be read
+    :param key_list: list of keys to read from  target_dict
+    :param default_value: value to return if key is not present in the nested dictionary
+    :return: The wanted value if exist, None otherwise
+    """
+    for key in key_list:
+        if not isinstance(target_dict, dict) or key not in target_dict:
+            return default_value
+        target_dict = target_dict[key]
+    return target_dict
+
+
+def get_iterable(in_dict, in_key):
+    """
+    Similar to <dict>.get(), but if value is None, False, ..., An empty tuple is returned instead
+    :param in_dict: a dictionary
+    :param in_key: the key to look for at in_dict
+    :return: in_dict[in_var] or () if it is None or not present
+    """
+    if not in_dict.get(in_key):
+        return ()
+    return in_dict[in_key]
+
 
-    def __init__(self, db, msg, fs, logger):
+def populate_dict(target_dict, key_list, value):
+    """
+    Update target_dict creating nested dictionaries with the key_list. Last key_list item is asigned the value.
+    Example target_dict={K: J}; key_list=[a,b,c];  target_dict will be {K: J, a: {b: {c: value}}}
+    :param target_dict: dictionary to be changed
+    :param key_list: list of keys to insert at target_dict
+    :param value:
+    :return: None
+    """
+    for key in key_list[0:-1]:
+        if key not in target_dict:
+            target_dict[key] = {}
+        target_dict = target_dict[key]
+    target_dict[key_list[-1]] = value
+
+
+class LcmBase:
+    def __init__(self, msg, logger):
         """
 
         :param db: database connection
         """
-        self.db = db
+        self.db = Database().instance.db
         self.msg = msg
-        self.fs = fs
+        self.fs = Filesystem().instance.fs
         self.logger = logger
 
     def update_db_2(self, item, _id, _desc):
@@ -69,6 +117,8 @@ class LcmBase:
         """
         if not _desc:
             return
+        now = time()
+        _desc["_admin.modified"] = now
         self.db.set_one(item, {"_id": _id}, _desc)
         _desc.clear()
         # except DbException as e:
@@ -94,32 +144,37 @@ class TaskRegistry(LcmBase):
     """
 
     # NS/NSI: "services" VIM/WIM/SDN: "accounts"
-    topic_service_list = ['ns', 'nsi']
-    topic_account_list = ['vim', 'wim', 'sdn']
+    topic_service_list = ["ns", "nsi"]
+    topic_account_list = ["vim", "wim", "sdn", "k8scluster", "vca", "k8srepo"]
 
     # Map topic to InstanceID
-    topic2instid_dict = {
-        'ns': 'nsInstanceId',
-        'nsi': 'netsliceInstanceId'}
+    topic2instid_dict = {"ns": "nsInstanceId", "nsi": "netsliceInstanceId"}
 
     # Map topic to DB table name
     topic2dbtable_dict = {
-        'ns': 'nslcmops',
-        'nsi': 'nsilcmops',
-        'vim': 'vim_accounts',
-        'wim': 'wim_accounts',
-        'sdn': 'sdns'}
-
-    def __init__(self, worker_id=None, db=None, logger=None):
+        "ns": "nslcmops",
+        "nsi": "nsilcmops",
+        "vim": "vim_accounts",
+        "wim": "wim_accounts",
+        "sdn": "sdns",
+        "k8scluster": "k8sclusters",
+        "vca": "vca",
+        "k8srepo": "k8srepos",
+    }
+
+    def __init__(self, worker_id=None, logger=None):
         self.task_registry = {
             "ns": {},
             "nsi": {},
             "vim_account": {},
             "wim_account": {},
             "sdn": {},
+            "k8scluster": {},
+            "vca": {},
+            "k8srepo": {},
         }
         self.worker_id = worker_id
-        self.db = db
+        self.db = Database().instance.db
         self.logger = logger
 
     def register(self, topic, _id, op_id, task_name, task):
@@ -213,24 +268,22 @@ class TaskRegistry(LcmBase):
     # Input: op_id, example: 'abc123def:3' Output: account_id='abc123def', op_index=3
     def _get_account_and_op_HA(self, op_id):
         if not op_id:
-            return (None, None)
-        account_id, _, op_index = op_id.rpartition(':')
-        if not account_id:
-            return (None, None)
-        if not op_index.isdigit():
-            return (None, None)
+            return None, None
+        account_id, _, op_index = op_id.rpartition(":")
+        if not account_id or not op_index.isdigit():
+            return None, None
         return account_id, op_index
 
     # Get '_id' for any topic and operation
     def _get_instance_id_HA(self, topic, op_type, op_id):
         _id = None
         # Special operation 'ANY', for SDN account associated to a VIM account: op_id as '_id'
-        if op_type == 'ANY':
+        if op_type == "ANY":
             _id = op_id
         # NS/NSI: Use op_id as '_id'
         elif self._is_service_type_HA(topic):
             _id = op_id
-        # VIM/SDN/WIM: Split op_id to get Account ID and Operation Index, use Account ID as '_id'
+        # VIM/SDN/WIM/K8SCLUSTER: Split op_id to get Account ID and Operation Index, use Account ID as '_id'
         elif self._is_account_type_HA(topic):
             _id, _ = self._get_account_and_op_HA(op_id)
         return _id
@@ -240,26 +293,33 @@ class TaskRegistry(LcmBase):
         _filter = {}
         # Special operation 'ANY', for SDN account associated to a VIM account: op_id as '_id'
         # In this special case, the timestamp is ignored
-        if op_type == 'ANY':
-            _filter = {'operationState': 'PROCESSING'}
+        if op_type == "ANY":
+            _filter = {"operationState": "PROCESSING"}
         # Otherwise, get 'startTime' timestamp for this operation
         else:
             # NS/NSI
             if self._is_service_type_HA(topic):
+                now = time()
                 starttime_this_op = db_lcmop.get("startTime")
                 instance_id_label = self.topic2instid_dict.get(topic)
                 instance_id = db_lcmop.get(instance_id_label)
-                _filter = {instance_id_label: instance_id,
-                           'operationState': 'PROCESSING',
-                           'startTime.lt': starttime_this_op}
-            # VIM/WIM/SDN
+                _filter = {
+                    instance_id_label: instance_id,
+                    "operationState": "PROCESSING",
+                    "startTime.lt": starttime_this_op,
+                    "_admin.modified.gt": now
+                    - 2 * 3600,  # ignore if tow hours of inactivity
+                }
+            # VIM/WIM/SDN/K8scluster
             elif self._is_account_type_HA(topic):
                 _, op_index = self._get_account_and_op_HA(op_id)
-                _ops = db_lcmop['_admin']['operations']
+                _ops = db_lcmop["_admin"]["operations"]
                 _this_op = _ops[int(op_index)]
-                starttime_this_op = _this_op.get('startTime', None)
-                _filter = {'operationState': 'PROCESSING',
-                           'startTime.lt': starttime_this_op}
+                starttime_this_op = _this_op.get("startTime", None)
+                _filter = {
+                    "operationState": "PROCESSING",
+                    "startTime.lt": starttime_this_op,
+                }
         return _filter
 
     # Get DB params for any topic and operation
@@ -268,19 +328,24 @@ class TaskRegistry(LcmBase):
         update_dict = {}
         # NS/NSI
         if self._is_service_type_HA(topic):
-            q_filter = {'_id': op_id, '_admin.worker': None}
-            update_dict = {'_admin.worker': self.worker_id}
+            q_filter = {"_id": op_id, "_admin.worker": None}
+            update_dict = {"_admin.worker": self.worker_id}
         # VIM/WIM/SDN
         elif self._is_account_type_HA(topic):
             account_id, op_index = self._get_account_and_op_HA(op_id)
             if not account_id:
                 return None, None
-            if op_type == 'create':
+            if op_type == "create":
                 # Creating a VIM/WIM/SDN account implies setting '_admin.current_operation' = 0
                 op_index = 0
-            q_filter = {'_id': account_id, "_admin.operations.{}.worker".format(op_index): None}
-            update_dict = {'_admin.operations.{}.worker'.format(op_index): self.worker_id,
-                           '_admin.current_operation': op_index}
+            q_filter = {
+                "_id": account_id,
+                "_admin.operations.{}.worker".format(op_index): None,
+            }
+            update_dict = {
+                "_admin.operations.{}.worker".format(op_index): self.worker_id,
+                "_admin.current_operation": op_index,
+            }
         return q_filter, update_dict
 
     def lock_HA(self, topic, op_type, op_id):
@@ -301,34 +366,46 @@ class TaskRegistry(LcmBase):
         the task in this instance of LCM, without querying the DB.
         """
 
-        # Backward compatibility for VIM/WIM/SDN without op_id
+        # Backward compatibility for VIM/WIM/SDN/k8scluster without op_id
         if self._is_account_type_HA(topic) and op_id is None:
             return True
 
         # Try to lock this task
-        db_table_name = self.topic2dbtable_dict.get(topic)
+        db_table_name = self.topic2dbtable_dict[topic]
         q_filter, update_dict = self._get_dbparams_for_lock_HA(topic, op_type, op_id)
-        db_lock_task = self.db.set_one(db_table_name,
-                                       q_filter=q_filter,
-                                       update_dict=update_dict,
-                                       fail_on_empty=False)
+        db_lock_task = self.db.set_one(
+            db_table_name,
+            q_filter=q_filter,
+            update_dict=update_dict,
+            fail_on_empty=False,
+        )
         if db_lock_task is None:
-            self.logger.debug("Task {} operation={} already locked by another worker".format(topic, op_id))
+            self.logger.debug(
+                "Task {} operation={} already locked by another worker".format(
+                    topic, op_id
+                )
+            )
             return False
         else:
             # Set 'detailed-status' to 'In progress' for VIM/WIM/SDN operations
             if self._is_account_type_HA(topic):
-                detailed_status = 'In progress'
+                detailed_status = "In progress"
                 account_id, op_index = self._get_account_and_op_HA(op_id)
-                q_filter = {'_id': account_id}
-                update_dict = {'_admin.operations.{}.detailed-status'.format(op_index): detailed_status}
-                self.db.set_one(db_table_name,
-                                q_filter=q_filter,
-                                update_dict=update_dict,
-                                fail_on_empty=False)
+                q_filter = {"_id": account_id}
+                update_dict = {
+                    "_admin.operations.{}.detailed-status".format(
+                        op_index
+                    ): detailed_status
+                }
+                self.db.set_one(
+                    db_table_name,
+                    q_filter=q_filter,
+                    update_dict=update_dict,
+                    fail_on_empty=False,
+                )
             return True
 
-    def register_HA(self, topic, op_type, op_id, operationState, detailed_status):
+    def unlock_HA(self, topic, op_type, op_id, operationState, detailed_status):
         """
         Register a task, done when finished a VIM/WIM/SDN 'create' operation.
         :param topic: Can be "vim", "wim", or "sdn"
@@ -338,23 +415,29 @@ class TaskRegistry(LcmBase):
         """
 
         # Backward compatibility
-        if not self._is_account_type_HA(topic) or (self._is_account_type_HA(topic) and op_id is None):
+        if not self._is_account_type_HA(topic) or not op_id:
             return
 
         # Get Account ID and Operation Index
         account_id, op_index = self._get_account_and_op_HA(op_id)
-        db_table_name = self.topic2dbtable_dict.get(topic)
+        db_table_name = self.topic2dbtable_dict[topic]
 
         # If this is a 'delete' operation, the account may have been deleted (SUCCESS) or may still exist (FAILED)
         # If the account exist, register the HA task.
         # Update DB for HA tasks
-        q_filter = {'_id': account_id}
-        update_dict = {'_admin.operations.{}.operationState'.format(op_index): operationState,
-                       '_admin.operations.{}.detailed-status'.format(op_index): detailed_status}
-        self.db.set_one(db_table_name,
-                        q_filter=q_filter,
-                        update_dict=update_dict,
-                        fail_on_empty=False)
+        q_filter = {"_id": account_id}
+        update_dict = {
+            "_admin.operations.{}.operationState".format(op_index): operationState,
+            "_admin.operations.{}.detailed-status".format(op_index): detailed_status,
+            "_admin.operations.{}.worker".format(op_index): None,
+            "_admin.current_operation": None,
+        }
+        self.db.set_one(
+            db_table_name,
+            q_filter=q_filter,
+            update_dict=update_dict,
+            fail_on_empty=False,
+        )
         return
 
     async def waitfor_related_HA(self, topic, op_type, op_id=None):
@@ -363,7 +446,9 @@ class TaskRegistry(LcmBase):
         """
 
         # Backward compatibility
-        if not (self._is_service_type_HA(topic) or self._is_account_type_HA(topic)) and (op_id is None):
+        if not (
+            self._is_service_type_HA(topic) or self._is_account_type_HA(topic)
+        ) and (op_id is None):
             return
 
         # Get DB table name
@@ -372,9 +457,7 @@ class TaskRegistry(LcmBase):
         # Get instance ID
         _id = self._get_instance_id_HA(topic, op_type, op_id)
         _filter = {"_id": _id}
-        db_lcmop = self.db.get_one(db_table_name,
-                                   _filter,
-                                   fail_on_empty=False)
+        db_lcmop = self.db.get_one(db_table_name, _filter, fail_on_empty=False)
         if not db_lcmop:
             return
 
@@ -382,17 +465,18 @@ class TaskRegistry(LcmBase):
         _filter = self._get_waitfor_filter_HA(db_lcmop, topic, op_type, op_id)
 
         # For HA, get list of tasks from DB instead of from dictionary (in-memory) variable.
-        timeout_wait_for_task = 3600   # Max time (seconds) to wait for a related task to finish
+        timeout_wait_for_task = (
+            3600  # Max time (seconds) to wait for a related task to finish
+        )
         # interval_wait_for_task = 30    #  A too long polling interval slows things down considerably
-        interval_wait_for_task = 10       # Interval in seconds for polling related tasks
+        interval_wait_for_task = 10  # Interval in seconds for polling related tasks
         time_left = timeout_wait_for_task
         old_num_related_tasks = 0
         while True:
             # Get related tasks (operations within the same instance as this) which are
             # still running (operationState='PROCESSING') and which were started before this task.
             # In the case of op_type='ANY', get any related tasks with operationState='PROCESSING', ignore timestamps.
-            db_waitfor_related_task = self.db.get_list(db_table_name,
-                                                       q_filter=_filter)
+            db_waitfor_related_task = self.db.get_list(db_table_name, q_filter=_filter)
             new_num_related_tasks = len(db_waitfor_related_task)
             # If there are no related tasks, there is nothing to wait for, so return.
             if not new_num_related_tasks:
@@ -400,28 +484,39 @@ class TaskRegistry(LcmBase):
             # If number of pending related tasks have changed,
             # update the 'detailed-status' field and log the change.
             # Do NOT update the 'detailed-status' for SDNC-associated-to-VIM operations ('ANY').
-            if (op_type != 'ANY') and (new_num_related_tasks != old_num_related_tasks):
-                step = "Waiting for {} related tasks to be completed.".format(new_num_related_tasks)
+            if (op_type != "ANY") and (new_num_related_tasks != old_num_related_tasks):
+                step = "Waiting for {} related tasks to be completed.".format(
+                    new_num_related_tasks
+                )
                 update_dict = {}
-                q_filter = {'_id': _id}
+                q_filter = {"_id": _id}
                 # NS/NSI
                 if self._is_service_type_HA(topic):
-                    update_dict = {'detailed-status': step}
+                    update_dict = {
+                        "detailed-status": step,
+                        "queuePosition": new_num_related_tasks,
+                    }
                 # VIM/WIM/SDN
                 elif self._is_account_type_HA(topic):
                     _, op_index = self._get_account_and_op_HA(op_id)
-                    update_dict = {'_admin.operations.{}.detailed-status'.format(op_index): step}
+                    update_dict = {
+                        "_admin.operations.{}.detailed-status".format(op_index): step
+                    }
                 self.logger.debug("Task {} operation={} {}".format(topic, _id, step))
-                self.db.set_one(db_table_name,
-                                q_filter=q_filter,
-                                update_dict=update_dict,
-                                fail_on_empty=False)
+                self.db.set_one(
+                    db_table_name,
+                    q_filter=q_filter,
+                    update_dict=update_dict,
+                    fail_on_empty=False,
+                )
                 old_num_related_tasks = new_num_related_tasks
             time_left -= interval_wait_for_task
             if time_left < 0:
                 raise LcmException(
                     "Timeout ({}) when waiting for related tasks to be completed".format(
-                        timeout_wait_for_task))
+                        timeout_wait_for_task
+                    )
+                )
             await asyncio.sleep(interval_wait_for_task)
 
         return