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 import asyncio
  20 import checksumdir
  21 from collections import OrderedDict
  22 import os
  23 import shutil
  24 import traceback
  25 from time import time
  26
  27 from osm_common.fsbase import FsException
  28 from osm_lcm.data_utils.database.database import Database
  29 from osm_lcm.data_utils.filesystem.filesystem import Filesystem
  30 import yaml
  31 from zipfile import ZipFile, BadZipfile
  32
  33 # from osm_common.dbbase import DbException
  34
  35 __author__ = "Alfonso Tierno"
  36
  37
  38 class LcmException(Exception):
  39     pass
  40
  41
  42 class LcmExceptionNoMgmtIP(LcmException):
  43     pass
  44
  45
  46 class LcmExceptionExit(LcmException):
  47     pass
  48
  49
  50 def versiontuple(v):
  51     """utility for compare dot separate versions. Fills with zeros to proper number comparison
  52     package version will be something like 4.0.1.post11+gb3f024d.dirty-1. Where 4.0.1 is the git tag, postXX is the
  53     number of commits from this tag, and +XXXXXXX is the git commit short id. Total length is 16 with until 999 commits
  54     """
  55     filled = []
  56     for point in v.split("."):
  57         point, _, _ = point.partition("+")
  58         point, _, _ = point.partition("-")
  59         filled.append(point.zfill(20))
  60     return tuple(filled)
  61
  62
  63 def deep_get(target_dict, key_list, default_value=None):
  64     """
  65     Get a value from target_dict entering in the nested keys. If keys does not exist, it returns None
  66     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
  67     :param target_dict: dictionary to be read
  68     :param key_list: list of keys to read from  target_dict
  69     :param default_value: value to return if key is not present in the nested dictionary
  70     :return: The wanted value if exist, None otherwise
  71     """
  72     for key in key_list:
  73         if not isinstance(target_dict, dict) or key not in target_dict:
  74             return default_value
  75         target_dict = target_dict[key]
  76     return target_dict
  77
  78
  79 def get_iterable(in_dict, in_key):
  80     """
  81     Similar to <dict>.get(), but if value is None, False, ..., An empty tuple is returned instead
  82     :param in_dict: a dictionary
  83     :param in_key: the key to look for at in_dict
  84     :return: in_dict[in_var] or () if it is None or not present
  85     """
  86     if not in_dict.get(in_key):
  87         return ()
  88     return in_dict[in_key]
  89
  90
  91 def check_juju_bundle_existence(vnfd: dict) -> str:
  92     """Checks the existence of juju-bundle in the descriptor
  93
  94     Args:
  95         vnfd:   Descriptor as a dictionary
  96
  97     Returns:
  98         Juju bundle if dictionary has juju-bundle else None
  99
 100     """
 101     if vnfd.get("vnfd"):
 102         vnfd = vnfd["vnfd"]
 103
 104     for kdu in vnfd.get("kdu", []):
 105         return kdu.get("juju-bundle", None)
 106
 107
 108 def get_charm_artifact_path(base_folder, charm_name, charm_type, revision=str()) -> str:
 109     """Finds the charm artifact paths
 110
 111     Args:
 112         base_folder:    Main folder which will be looked up for charm
 113         charm_name:   Charm name
 114         charm_type:   Type of charm native_charm, lxc_proxy_charm or k8s_proxy_charm
 115         revision:   vnf package revision number if there is
 116
 117     Returns:
 118         artifact_path: (str)
 119
 120     """
 121     extension = ""
 122     if revision:
 123         extension = ":" + str(revision)
 124
 125     if base_folder.get("pkg-dir"):
 126         artifact_path = "{}/{}/{}/{}".format(
 127             base_folder["folder"].split(":")[0] + extension,
 128             base_folder["pkg-dir"],
 129             "charms"
 130             if charm_type in ("native_charm", "lxc_proxy_charm", "k8s_proxy_charm")
 131             else "helm-charts",
 132             charm_name,
 133         )
 134
 135     else:
 136         # For SOL004 packages
 137         artifact_path = "{}/Scripts/{}/{}".format(
 138             base_folder["folder"].split(":")[0] + extension,
 139             "charms"
 140             if charm_type in ("native_charm", "lxc_proxy_charm", "k8s_proxy_charm")
 141             else "helm-charts",
 142             charm_name,
 143         )
 144
 145     return artifact_path
 146
 147
 148 def populate_dict(target_dict, key_list, value):
 149     """
 150     Update target_dict creating nested dictionaries with the key_list. Last key_list item is asigned the value.
 151     Example target_dict={K: J}; key_list=[a,b,c];  target_dict will be {K: J, a: {b: {c: value}}}
 152     :param target_dict: dictionary to be changed
 153     :param key_list: list of keys to insert at target_dict
 154     :param value:
 155     :return: None
 156     """
 157     for key in key_list[0:-1]:
 158         if key not in target_dict:
 159             target_dict[key] = {}
 160         target_dict = target_dict[key]
 161     target_dict[key_list[-1]] = value
 162
 163
 164 class LcmBase:
 165     def __init__(self, msg, logger):
 166         """
 167
 168         :param db: database connection
 169         """
 170         self.db = Database().instance.db
 171         self.msg = msg
 172         self.fs = Filesystem().instance.fs
 173         self.logger = logger
 174
 175     def update_db_2(self, item, _id, _desc):
 176         """
 177         Updates database with _desc information. If success _desc is cleared
 178         :param item: collection
 179         :param _id: the _id to use in the query filter
 180         :param _desc: dictionary with the content to update. Keys are dot separated keys for
 181         :return: None. Exception is raised on error
 182         """
 183         if not _desc:
 184             return
 185         now = time()
 186         _desc["_admin.modified"] = now
 187         self.db.set_one(item, {"_id": _id}, _desc)
 188         _desc.clear()
 189         # except DbException as e:
 190         #     self.logger.error("Updating {} _id={} with '{}'. Error: {}".format(item, _id, _desc, e))
 191
 192     def check_charm_hash_changed(
 193         self, current_charm_path: str, target_charm_path: str
 194     ) -> bool:
 195         """Find the target charm has changed or not by checking the hash of
 196         old and new charm packages
 197
 198         Args:
 199             current_charm_path (str): Existing charm package artifact path
 200             target_charm_path  (str): Target charm package artifact path
 201
 202         Returns:
 203             True/False (bool): if charm has changed it returns True
 204
 205         """
 206         # Check if the charm artifacts are available
 207         if os.path.exists(self.fs.path + current_charm_path) and os.path.exists(
 208             self.fs.path + target_charm_path
 209         ):
 210             # Compare the hash of charm folders
 211             if checksumdir.dirhash(
 212                 self.fs.path + current_charm_path
 213             ) != checksumdir.dirhash(self.fs.path + target_charm_path):
 214
 215                 return True
 216
 217             return False
 218
 219         else:
 220             raise LcmException(
 221                 "Charm artifact {} does not exist in the VNF Package".format(
 222                     self.fs.path + target_charm_path
 223                 )
 224             )
 225
 226     @staticmethod
 227     def get_charm_name(charm_metadata_file: str) -> str:
 228         """Get the charm name from metadata file.
 229
 230         Args:
 231             charm_metadata_file    (str):  charm metadata file full path
 232
 233         Returns:
 234             charm_name    (str):  charm name
 235
 236         """
 237         # Read charm metadata.yaml to get the charm name
 238         with open(charm_metadata_file, "r") as metadata_file:
 239             content = yaml.safe_load(metadata_file)
 240             charm_name = content["name"]
 241             return str(charm_name)
 242
 243     def _get_charm_path(
 244         self, nsd_package_path: str, nsd_package_name: str, charm_folder_name: str
 245     ) -> str:
 246         """Get the full path of charm folder.
 247
 248         Args:
 249             nsd_package_path    (str):  NSD package full path
 250             nsd_package_name    (str):  NSD package name
 251             charm_folder_name   (str):  folder name
 252
 253         Returns:
 254             charm_path    (str):  charm folder full path
 255         """
 256         charm_path = (
 257             self.fs.path
 258             + nsd_package_path
 259             + "/"
 260             + nsd_package_name
 261             + "/charms/"
 262             + charm_folder_name
 263         )
 264         return charm_path
 265
 266     def _get_charm_metadata_file(
 267         self,
 268         charm_folder_name: str,
 269         nsd_package_path: str,
 270         nsd_package_name: str,
 271         charm_path: str = None,
 272     ) -> str:
 273         """Get the path of charm metadata file.
 274
 275         Args:
 276             charm_folder_name   (str):  folder name
 277             nsd_package_path    (str):  NSD package full path
 278             nsd_package_name    (str):  NSD package name
 279             charm_path  (str):  Charm full path
 280
 281         Returns:
 282             charm_metadata_file_path    (str):  charm metadata file full path
 283
 284         """
 285         # Locate the charm metadata.yaml
 286         if charm_folder_name.endswith(".charm"):
 287             extract_path = (
 288                 self.fs.path
 289                 + nsd_package_path
 290                 + "/"
 291                 + nsd_package_name
 292                 + "/charms/"
 293                 + charm_folder_name.replace(".charm", "")
 294             )
 295             # Extract .charm to extract path
 296             with ZipFile(charm_path, "r") as zipfile:
 297                 zipfile.extractall(extract_path)
 298             return extract_path + "/metadata.yaml"
 299         else:
 300             return charm_path + "/metadata.yaml"
 301
 302     def find_charm_name(self, db_nsr: dict, charm_folder_name: str) -> str:
 303         """Get the charm name from metadata.yaml of charm package.
 304
 305         Args:
 306             db_nsr  (dict): NS record as a dictionary
 307             charm_folder_name   (str): charm folder name
 308
 309         Returns:
 310              charm_name (str):  charm name
 311         """
 312         try:
 313             if not charm_folder_name:
 314                 raise LcmException("charm_folder_name should be provided.")
 315
 316             # Find nsd_package details: path, name
 317             revision = db_nsr.get("revision", "")
 318
 319             # Get the NSD package path
 320             if revision:
 321
 322                 nsd_package_path = db_nsr["nsd-id"] + ":" + str(revision)
 323                 db_nsd = self.db.get_one("nsds_revisions", {"_id": nsd_package_path})
 324
 325             else:
 326                 nsd_package_path = db_nsr["nsd-id"]
 327
 328                 db_nsd = self.db.get_one("nsds", {"_id": nsd_package_path})
 329
 330             # Get the NSD package name
 331             nsd_package_name = db_nsd["_admin"]["storage"]["pkg-dir"]
 332
 333             # Remove the existing nsd package and sync from FsMongo
 334             shutil.rmtree(self.fs.path + nsd_package_path, ignore_errors=True)
 335             self.fs.sync(from_path=nsd_package_path)
 336
 337             # Get the charm path
 338             charm_path = self._get_charm_path(
 339                 nsd_package_path, nsd_package_name, charm_folder_name
 340             )
 341
 342             # Find charm metadata file full path
 343             charm_metadata_file = self._get_charm_metadata_file(
 344                 charm_folder_name, nsd_package_path, nsd_package_name, charm_path
 345             )
 346
 347             # Return charm name
 348             return self.get_charm_name(charm_metadata_file)
 349
 350         except (
 351             yaml.YAMLError,
 352             IOError,
 353             FsException,
 354             KeyError,
 355             TypeError,
 356             FileNotFoundError,
 357             BadZipfile,
 358         ) as error:
 359             self.logger.debug(traceback.format_exc())
 360             self.logger.error(f"{error} occured while getting the charm name")
 361             raise LcmException(error)
 362
 363
 364 class TaskRegistry(LcmBase):
 365     """
 366     Implements a registry of task needed for later cancelation, look for related tasks that must be completed before
 367     etc. It stores a four level dict
 368     First level is the topic, ns, vim_account, sdn
 369     Second level is the _id
 370     Third level is the operation id
 371     Fourth level is a descriptive name, the value is the task class
 372
 373     The HA (High-Availability) methods are used when more than one LCM instance is running.
 374     To register the current task in the external DB, use LcmBase as base class, to be able
 375     to reuse LcmBase.update_db_2()
 376     The DB registry uses the following fields to distinguish a task:
 377     - op_type: operation type ("nslcmops" or "nsilcmops")
 378     - op_id:   operation ID
 379     - worker:  the worker ID for this process
 380     """
 381
 382     # NS/NSI: "services" VIM/WIM/SDN: "accounts"
 383     topic_service_list = ["ns", "nsi"]
 384     topic_account_list = ["vim", "wim", "sdn", "k8scluster", "vca", "k8srepo"]
 385
 386     # Map topic to InstanceID
 387     topic2instid_dict = {"ns": "nsInstanceId", "nsi": "netsliceInstanceId"}
 388
 389     # Map topic to DB table name
 390     topic2dbtable_dict = {
 391         "ns": "nslcmops",
 392         "nsi": "nsilcmops",
 393         "vim": "vim_accounts",
 394         "wim": "wim_accounts",
 395         "sdn": "sdns",
 396         "k8scluster": "k8sclusters",
 397         "vca": "vca",
 398         "k8srepo": "k8srepos",
 399     }
 400
 401     def __init__(self, worker_id=None, logger=None):
 402         self.task_registry = {
 403             "ns": {},
 404             "nsi": {},
 405             "vim_account": {},
 406             "wim_account": {},
 407             "sdn": {},
 408             "k8scluster": {},
 409             "vca": {},
 410             "k8srepo": {},
 411         }
 412         self.worker_id = worker_id
 413         self.db = Database().instance.db
 414         self.logger = logger
 415
 416     def register(self, topic, _id, op_id, task_name, task):
 417         """
 418         Register a new task
 419         :param topic: Can be "ns", "nsi", "vim_account", "sdn"
 420         :param _id: _id of the related item
 421         :param op_id: id of the operation of the related item
 422         :param task_name: Task descriptive name, as create, instantiate, terminate. Must be unique in this op_id
 423         :param task: Task class
 424         :return: none
 425         """
 426         if _id not in self.task_registry[topic]:
 427             self.task_registry[topic][_id] = OrderedDict()
 428         if op_id not in self.task_registry[topic][_id]:
 429             self.task_registry[topic][_id][op_id] = {task_name: task}
 430         else:
 431             self.task_registry[topic][_id][op_id][task_name] = task
 432         # print("registering task", topic, _id, op_id, task_name, task)
 433
 434     def remove(self, topic, _id, op_id, task_name=None):
 435         """
 436         When task is ended, it should be removed. It ignores missing tasks. It also removes tasks done with this _id
 437         :param topic: Can be "ns", "nsi", "vim_account", "sdn"
 438         :param _id: _id of the related item
 439         :param op_id: id of the operation of the related item
 440         :param task_name: Task descriptive name. If none it deletes all tasks with same _id and op_id
 441         :return: None
 442         """
 443         if not self.task_registry[topic].get(_id):
 444             return
 445         if not task_name:
 446             self.task_registry[topic][_id].pop(op_id, None)
 447         elif self.task_registry[topic][_id].get(op_id):
 448             self.task_registry[topic][_id][op_id].pop(task_name, None)
 449
 450         # delete done tasks
 451         for op_id_ in list(self.task_registry[topic][_id]):
 452             for name, task in self.task_registry[topic][_id][op_id_].items():
 453                 if not task.done():
 454                     break
 455             else:
 456                 del self.task_registry[topic][_id][op_id_]
 457         if not self.task_registry[topic][_id]:
 458             del self.task_registry[topic][_id]
 459
 460     def lookfor_related(self, topic, _id, my_op_id=None):
 461         task_list = []
 462         task_name_list = []
 463         if _id not in self.task_registry[topic]:
 464             return "", task_name_list
 465         for op_id in reversed(self.task_registry[topic][_id]):
 466             if my_op_id:
 467                 if my_op_id == op_id:
 468                     my_op_id = None  # so that the next task is taken
 469                 continue
 470
 471             for task_name, task in self.task_registry[topic][_id][op_id].items():
 472                 if not task.done():
 473                     task_list.append(task)
 474                     task_name_list.append(task_name)
 475             break
 476         return ", ".join(task_name_list), task_list
 477
 478     def cancel(self, topic, _id, target_op_id=None, target_task_name=None):
 479         """
 480         Cancel all active tasks of a concrete ns, nsi, vim_account, sdn identified for _id. If op_id is supplied only
 481         this is cancelled, and the same with task_name
 482         """
 483         if not self.task_registry[topic].get(_id):
 484             return
 485         for op_id in reversed(self.task_registry[topic][_id]):
 486             if target_op_id and target_op_id != op_id:
 487                 continue
 488             for task_name, task in self.task_registry[topic][_id][op_id].items():
 489                 if target_task_name and target_task_name != task_name:
 490                     continue
 491                 # result =
 492                 task.cancel()
 493                 # if result:
 494                 #     self.logger.debug("{} _id={} order_id={} task={} cancelled".format(topic, _id, op_id, task_name))
 495
 496     # Is topic NS/NSI?
 497     def _is_service_type_HA(self, topic):
 498         return topic in self.topic_service_list
 499
 500     # Is topic VIM/WIM/SDN?
 501     def _is_account_type_HA(self, topic):
 502         return topic in self.topic_account_list
 503
 504     # Input: op_id, example: 'abc123def:3' Output: account_id='abc123def', op_index=3
 505     def _get_account_and_op_HA(self, op_id):
 506         if not op_id:
 507             return None, None
 508         account_id, _, op_index = op_id.rpartition(":")
 509         if not account_id or not op_index.isdigit():
 510             return None, None
 511         return account_id, op_index
 512
 513     # Get '_id' for any topic and operation
 514     def _get_instance_id_HA(self, topic, op_type, op_id):
 515         _id = None
 516         # Special operation 'ANY', for SDN account associated to a VIM account: op_id as '_id'
 517         if op_type == "ANY":
 518             _id = op_id
 519         # NS/NSI: Use op_id as '_id'
 520         elif self._is_service_type_HA(topic):
 521             _id = op_id
 522         # VIM/SDN/WIM/K8SCLUSTER: Split op_id to get Account ID and Operation Index, use Account ID as '_id'
 523         elif self._is_account_type_HA(topic):
 524             _id, _ = self._get_account_and_op_HA(op_id)
 525         return _id
 526
 527     # Set DB _filter for querying any related process state
 528     def _get_waitfor_filter_HA(self, db_lcmop, topic, op_type, op_id):
 529         _filter = {}
 530         # Special operation 'ANY', for SDN account associated to a VIM account: op_id as '_id'
 531         # In this special case, the timestamp is ignored
 532         if op_type == "ANY":
 533             _filter = {"operationState": "PROCESSING"}
 534         # Otherwise, get 'startTime' timestamp for this operation
 535         else:
 536             # NS/NSI
 537             if self._is_service_type_HA(topic):
 538                 now = time()
 539                 starttime_this_op = db_lcmop.get("startTime")
 540                 instance_id_label = self.topic2instid_dict.get(topic)
 541                 instance_id = db_lcmop.get(instance_id_label)
 542                 _filter = {
 543                     instance_id_label: instance_id,
 544                     "operationState": "PROCESSING",
 545                     "startTime.lt": starttime_this_op,
 546                     "_admin.modified.gt": now
 547                     - 2 * 3600,  # ignore if tow hours of inactivity
 548                 }
 549             # VIM/WIM/SDN/K8scluster
 550             elif self._is_account_type_HA(topic):
 551                 _, op_index = self._get_account_and_op_HA(op_id)
 552                 _ops = db_lcmop["_admin"]["operations"]
 553                 _this_op = _ops[int(op_index)]
 554                 starttime_this_op = _this_op.get("startTime", None)
 555                 _filter = {
 556                     "operationState": "PROCESSING",
 557                     "startTime.lt": starttime_this_op,
 558                 }
 559         return _filter
 560
 561     # Get DB params for any topic and operation
 562     def _get_dbparams_for_lock_HA(self, topic, op_type, op_id):
 563         q_filter = {}
 564         update_dict = {}
 565         # NS/NSI
 566         if self._is_service_type_HA(topic):
 567             q_filter = {"_id": op_id, "_admin.worker": None}
 568             update_dict = {"_admin.worker": self.worker_id}
 569         # VIM/WIM/SDN
 570         elif self._is_account_type_HA(topic):
 571             account_id, op_index = self._get_account_and_op_HA(op_id)
 572             if not account_id:
 573                 return None, None
 574             if op_type == "create":
 575                 # Creating a VIM/WIM/SDN account implies setting '_admin.current_operation' = 0
 576                 op_index = 0
 577             q_filter = {
 578                 "_id": account_id,
 579                 "_admin.operations.{}.worker".format(op_index): None,
 580             }
 581             update_dict = {
 582                 "_admin.operations.{}.worker".format(op_index): self.worker_id,
 583                 "_admin.current_operation": op_index,
 584             }
 585         return q_filter, update_dict
 586
 587     def lock_HA(self, topic, op_type, op_id):
 588         """
 589         Lock a task, if possible, to indicate to the HA system that
 590         the task will be executed in this LCM instance.
 591         :param topic: Can be "ns", "nsi", "vim", "wim", or "sdn"
 592         :param op_type: Operation type, can be "nslcmops", "nsilcmops", "create", "edit", "delete"
 593         :param op_id: NS, NSI: Operation ID  VIM,WIM,SDN: Account ID + ':' + Operation Index
 594         :return:
 595         True=lock was successful => execute the task (not registered by any other LCM instance)
 596         False=lock failed => do NOT execute the task (already registered by another LCM instance)
 597
 598         HA tasks and backward compatibility:
 599         If topic is "account type" (VIM/WIM/SDN) and op_id is None, 'op_id' was not provided by NBI.
 600         This means that the running NBI instance does not support HA.
 601         In such a case this method should always return True, to always execute
 602         the task in this instance of LCM, without querying the DB.
 603         """
 604
 605         # Backward compatibility for VIM/WIM/SDN/k8scluster without op_id
 606         if self._is_account_type_HA(topic) and op_id is None:
 607             return True
 608
 609         # Try to lock this task
 610         db_table_name = self.topic2dbtable_dict[topic]
 611         q_filter, update_dict = self._get_dbparams_for_lock_HA(topic, op_type, op_id)
 612         db_lock_task = self.db.set_one(
 613             db_table_name,
 614             q_filter=q_filter,
 615             update_dict=update_dict,
 616             fail_on_empty=False,
 617         )
 618         if db_lock_task is None:
 619             self.logger.debug(
 620                 "Task {} operation={} already locked by another worker".format(
 621                     topic, op_id
 622                 )
 623             )
 624             return False
 625         else:
 626             # Set 'detailed-status' to 'In progress' for VIM/WIM/SDN operations
 627             if self._is_account_type_HA(topic):
 628                 detailed_status = "In progress"
 629                 account_id, op_index = self._get_account_and_op_HA(op_id)
 630                 q_filter = {"_id": account_id}
 631                 update_dict = {
 632                     "_admin.operations.{}.detailed-status".format(
 633                         op_index
 634                     ): detailed_status
 635                 }
 636                 self.db.set_one(
 637                     db_table_name,
 638                     q_filter=q_filter,
 639                     update_dict=update_dict,
 640                     fail_on_empty=False,
 641                 )
 642             return True
 643
 644     def unlock_HA(self, topic, op_type, op_id, operationState, detailed_status):
 645         """
 646         Register a task, done when finished a VIM/WIM/SDN 'create' operation.
 647         :param topic: Can be "vim", "wim", or "sdn"
 648         :param op_type: Operation type, can be "create", "edit", "delete"
 649         :param op_id: Account ID + ':' + Operation Index
 650         :return: nothing
 651         """
 652
 653         # Backward compatibility
 654         if not self._is_account_type_HA(topic) or not op_id:
 655             return
 656
 657         # Get Account ID and Operation Index
 658         account_id, op_index = self._get_account_and_op_HA(op_id)
 659         db_table_name = self.topic2dbtable_dict[topic]
 660
 661         # If this is a 'delete' operation, the account may have been deleted (SUCCESS) or may still exist (FAILED)
 662         # If the account exist, register the HA task.
 663         # Update DB for HA tasks
 664         q_filter = {"_id": account_id}
 665         update_dict = {
 666             "_admin.operations.{}.operationState".format(op_index): operationState,
 667             "_admin.operations.{}.detailed-status".format(op_index): detailed_status,
 668             "_admin.operations.{}.worker".format(op_index): None,
 669             "_admin.current_operation": None,
 670         }
 671         self.db.set_one(
 672             db_table_name,
 673             q_filter=q_filter,
 674             update_dict=update_dict,
 675             fail_on_empty=False,
 676         )
 677         return
 678
 679     async def waitfor_related_HA(self, topic, op_type, op_id=None):
 680         """
 681         Wait for any pending related HA tasks
 682         """
 683
 684         # Backward compatibility
 685         if not (
 686             self._is_service_type_HA(topic) or self._is_account_type_HA(topic)
 687         ) and (op_id is None):
 688             return
 689
 690         # Get DB table name
 691         db_table_name = self.topic2dbtable_dict.get(topic)
 692
 693         # Get instance ID
 694         _id = self._get_instance_id_HA(topic, op_type, op_id)
 695         _filter = {"_id": _id}
 696         db_lcmop = self.db.get_one(db_table_name, _filter, fail_on_empty=False)
 697         if not db_lcmop:
 698             return
 699
 700         # Set DB _filter for querying any related process state
 701         _filter = self._get_waitfor_filter_HA(db_lcmop, topic, op_type, op_id)
 702
 703         # For HA, get list of tasks from DB instead of from dictionary (in-memory) variable.
 704         timeout_wait_for_task = (
 705             3600  # Max time (seconds) to wait for a related task to finish
 706         )
 707         # interval_wait_for_task = 30    #  A too long polling interval slows things down considerably
 708         interval_wait_for_task = 10  # Interval in seconds for polling related tasks
 709         time_left = timeout_wait_for_task
 710         old_num_related_tasks = 0
 711         while True:
 712             # Get related tasks (operations within the same instance as this) which are
 713             # still running (operationState='PROCESSING') and which were started before this task.
 714             # In the case of op_type='ANY', get any related tasks with operationState='PROCESSING', ignore timestamps.
 715             db_waitfor_related_task = self.db.get_list(db_table_name, q_filter=_filter)
 716             new_num_related_tasks = len(db_waitfor_related_task)
 717             # If there are no related tasks, there is nothing to wait for, so return.
 718             if not new_num_related_tasks:
 719                 return
 720             # If number of pending related tasks have changed,
 721             # update the 'detailed-status' field and log the change.
 722             # Do NOT update the 'detailed-status' for SDNC-associated-to-VIM operations ('ANY').
 723             if (op_type != "ANY") and (new_num_related_tasks != old_num_related_tasks):
 724                 step = "Waiting for {} related tasks to be completed.".format(
 725                     new_num_related_tasks
 726                 )
 727                 update_dict = {}
 728                 q_filter = {"_id": _id}
 729                 # NS/NSI
 730                 if self._is_service_type_HA(topic):
 731                     update_dict = {
 732                         "detailed-status": step,
 733                         "queuePosition": new_num_related_tasks,
 734                     }
 735                 # VIM/WIM/SDN
 736                 elif self._is_account_type_HA(topic):
 737                     _, op_index = self._get_account_and_op_HA(op_id)
 738                     update_dict = {
 739                         "_admin.operations.{}.detailed-status".format(op_index): step
 740                     }
 741                 self.logger.debug("Task {} operation={} {}".format(topic, _id, step))
 742                 self.db.set_one(
 743                     db_table_name,
 744                     q_filter=q_filter,
 745                     update_dict=update_dict,
 746                     fail_on_empty=False,
 747                 )
 748                 old_num_related_tasks = new_num_related_tasks
 749             time_left -= interval_wait_for_task
 750             if time_left < 0:
 751                 raise LcmException(
 752                     "Timeout ({}) when waiting for related tasks to be completed".format(
 753                         timeout_wait_for_task
 754                     )
 755                 )
 756             await asyncio.sleep(interval_wait_for_task)
 757
 758         return