osm_nbi/instance_topics.py

   1 # -*- coding: utf-8 -*-
   2
   3 # Licensed under the Apache License, Version 2.0 (the "License");
   4 # you may not use this file except in compliance with the License.
   5 # You may obtain a copy of the License at
   6 #
   7 #    http://www.apache.org/licenses/LICENSE-2.0
   8 #
   9 # Unless required by applicable law or agreed to in writing, software
  10 # distributed under the License is distributed on an "AS IS" BASIS,
  11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
  12 # implied.
  13 # See the License for the specific language governing permissions and
  14 # limitations under the License.
  15
  16 # import logging
  17 import json
  18 from uuid import uuid4
  19 from http import HTTPStatus
  20 from time import time
  21 from copy import copy, deepcopy
  22 from osm_nbi.validation import (
  23     validate_input,
  24     ValidationError,
  25     ns_instantiate,
  26     ns_terminate,
  27     ns_action,
  28     ns_scale,
  29     nsi_instantiate,
  30 )
  31 from osm_nbi.base_topic import (
  32     BaseTopic,
  33     EngineException,
  34     get_iterable,
  35     deep_get,
  36     increment_ip_mac,
  37 )
  38 from yaml import safe_dump
  39 from osm_common.dbbase import DbException
  40 from osm_common.msgbase import MsgException
  41 from osm_common.fsbase import FsException
  42 from osm_nbi import utils
  43 from re import (
  44     match,
  45 )  # For checking that additional parameter names are valid Jinja2 identifiers
  46
  47 __author__ = "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
  48
  49
  50 class NsrTopic(BaseTopic):
  51     topic = "nsrs"
  52     topic_msg = "ns"
  53     quota_name = "ns_instances"
  54     schema_new = ns_instantiate
  55
  56     def __init__(self, db, fs, msg, auth):
  57         BaseTopic.__init__(self, db, fs, msg, auth)
  58
  59     def _check_descriptor_dependencies(self, session, descriptor):
  60         """
  61         Check that the dependent descriptors exist on a new descriptor or edition
  62         :param session: client session information
  63         :param descriptor: descriptor to be inserted or edit
  64         :return: None or raises exception
  65         """
  66         if not descriptor.get("nsdId"):
  67             return
  68         nsd_id = descriptor["nsdId"]
  69         if not self.get_item_list(session, "nsds", {"id": nsd_id}):
  70             raise EngineException(
  71                 "Descriptor error at nsdId='{}' references a non exist nsd".format(
  72                     nsd_id
  73                 ),
  74                 http_code=HTTPStatus.CONFLICT,
  75             )
  76
  77     @staticmethod
  78     def format_on_new(content, project_id=None, make_public=False):
  79         BaseTopic.format_on_new(content, project_id=project_id, make_public=make_public)
  80         content["_admin"]["nsState"] = "NOT_INSTANTIATED"
  81         return None
  82
  83     def check_conflict_on_del(self, session, _id, db_content):
  84         """
  85         Check that NSR is not instantiated
  86         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
  87         :param _id: nsr internal id
  88         :param db_content: The database content of the nsr
  89         :return: None or raises EngineException with the conflict
  90         """
  91         if session["force"]:
  92             return
  93         nsr = db_content
  94         if nsr["_admin"].get("nsState") == "INSTANTIATED":
  95             raise EngineException(
  96                 "nsr '{}' cannot be deleted because it is in 'INSTANTIATED' state. "
  97                 "Launch 'terminate' operation first; or force deletion".format(_id),
  98                 http_code=HTTPStatus.CONFLICT,
  99             )
 100
 101     def delete_extra(self, session, _id, db_content, not_send_msg=None):
 102         """
 103         Deletes associated nslcmops and vnfrs from database. Deletes associated filesystem.
 104          Set usageState of pdu, vnfd, nsd
 105         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
 106         :param _id: server internal id
 107         :param db_content: The database content of the descriptor
 108         :param not_send_msg: To not send message (False) or store content (list) instead
 109         :return: None if ok or raises EngineException with the problem
 110         """
 111         self.fs.file_delete(_id, ignore_non_exist=True)
 112         self.db.del_list("nslcmops", {"nsInstanceId": _id})
 113         self.db.del_list("vnfrs", {"nsr-id-ref": _id})
 114
 115         # set all used pdus as free
 116         self.db.set_list(
 117             "pdus",
 118             {"_admin.usage.nsr_id": _id},
 119             {"_admin.usageState": "NOT_IN_USE", "_admin.usage": None},
 120         )
 121
 122         # Set NSD usageState
 123         nsr = db_content
 124         used_nsd_id = nsr.get("nsd-id")
 125         if used_nsd_id:
 126             # check if used by another NSR
 127             nsrs_list = self.db.get_one(
 128                 "nsrs", {"nsd-id": used_nsd_id}, fail_on_empty=False, fail_on_more=False
 129             )
 130             if not nsrs_list:
 131                 self.db.set_one(
 132                     "nsds", {"_id": used_nsd_id}, {"_admin.usageState": "NOT_IN_USE"}
 133                 )
 134
 135         # Set VNFD usageState
 136         used_vnfd_id_list = nsr.get("vnfd-id")
 137         if used_vnfd_id_list:
 138             for used_vnfd_id in used_vnfd_id_list:
 139                 # check if used by another NSR
 140                 nsrs_list = self.db.get_one(
 141                     "nsrs",
 142                     {"vnfd-id": used_vnfd_id},
 143                     fail_on_empty=False,
 144                     fail_on_more=False,
 145                 )
 146                 if not nsrs_list:
 147                     self.db.set_one(
 148                         "vnfds",
 149                         {"_id": used_vnfd_id},
 150                         {"_admin.usageState": "NOT_IN_USE"},
 151                     )
 152
 153         # delete extra ro_nsrs used for internal RO module
 154         self.db.del_one("ro_nsrs", q_filter={"_id": _id}, fail_on_empty=False)
 155
 156     @staticmethod
 157     def _format_ns_request(ns_request):
 158         formated_request = copy(ns_request)
 159         formated_request.pop("additionalParamsForNs", None)
 160         formated_request.pop("additionalParamsForVnf", None)
 161         return formated_request
 162
 163     @staticmethod
 164     def _format_additional_params(
 165         ns_request, member_vnf_index=None, vdu_id=None, kdu_name=None, descriptor=None
 166     ):
 167         """
 168         Get and format user additional params for NS or VNF
 169         :param ns_request: User instantiation additional parameters
 170         :param member_vnf_index: None for extract NS params, or member_vnf_index to extract VNF params
 171         :param descriptor: If not None it check that needed parameters of descriptor are supplied
 172         :return: tuple with a formatted copy of additional params or None if not supplied, plus other parameters
 173         """
 174         additional_params = None
 175         other_params = None
 176         if not member_vnf_index:
 177             additional_params = copy(ns_request.get("additionalParamsForNs"))
 178             where_ = "additionalParamsForNs"
 179         elif ns_request.get("additionalParamsForVnf"):
 180             where_ = "additionalParamsForVnf[member-vnf-index={}]".format(
 181                 member_vnf_index
 182             )
 183             item = next(
 184                 (
 185                     x
 186                     for x in ns_request["additionalParamsForVnf"]
 187                     if x["member-vnf-index"] == member_vnf_index
 188                 ),
 189                 None,
 190             )
 191             if item:
 192                 if not vdu_id and not kdu_name:
 193                     other_params = item
 194                 additional_params = copy(item.get("additionalParams")) or {}
 195                 if vdu_id and item.get("additionalParamsForVdu"):
 196                     item_vdu = next(
 197                         (
 198                             x
 199                             for x in item["additionalParamsForVdu"]
 200                             if x["vdu_id"] == vdu_id
 201                         ),
 202                         None,
 203                     )
 204                     other_params = item_vdu
 205                     if item_vdu and item_vdu.get("additionalParams"):
 206                         where_ += ".additionalParamsForVdu[vdu_id={}]".format(vdu_id)
 207                         additional_params = item_vdu["additionalParams"]
 208                 if kdu_name:
 209                     additional_params = {}
 210                     if item.get("additionalParamsForKdu"):
 211                         item_kdu = next(
 212                             (
 213                                 x
 214                                 for x in item["additionalParamsForKdu"]
 215                                 if x["kdu_name"] == kdu_name
 216                             ),
 217                             None,
 218                         )
 219                         other_params = item_kdu
 220                         if item_kdu and item_kdu.get("additionalParams"):
 221                             where_ += ".additionalParamsForKdu[kdu_name={}]".format(
 222                                 kdu_name
 223                             )
 224                             additional_params = item_kdu["additionalParams"]
 225
 226         if additional_params:
 227             for k, v in additional_params.items():
 228                 # BEGIN Check that additional parameter names are valid Jinja2 identifiers if target is not Kdu
 229                 if not kdu_name and not match("^[a-zA-Z_][a-zA-Z0-9_]*$", k):
 230                     raise EngineException(
 231                         "Invalid param name at {}:{}. Must contain only alphanumeric characters "
 232                         "and underscores, and cannot start with a digit".format(
 233                             where_, k
 234                         )
 235                     )
 236                 # END Check that additional parameter names are valid Jinja2 identifiers
 237                 if not isinstance(k, str):
 238                     raise EngineException(
 239                         "Invalid param at {}:{}. Only string keys are allowed".format(
 240                             where_, k
 241                         )
 242                     )
 243                 if "$" in k:
 244                     raise EngineException(
 245                         "Invalid param at {}:{}. Keys must not contain $ symbol".format(
 246                             where_, k
 247                         )
 248                     )
 249                 if isinstance(v, (dict, tuple, list)):
 250                     additional_params[k] = "!!yaml " + safe_dump(v)
 251             if kdu_name:
 252                 additional_params = json.dumps(additional_params)
 253
 254         if descriptor:
 255             for df in descriptor.get("df", []):
 256                 # check that enough parameters are supplied for the initial-config-primitive
 257                 # TODO: check for cloud-init
 258                 if member_vnf_index:
 259                     initial_primitives = []
 260                     if (
 261                         "lcm-operations-configuration" in df
 262                         and "operate-vnf-op-config"
 263                         in df["lcm-operations-configuration"]
 264                     ):
 265                         for config in df["lcm-operations-configuration"][
 266                             "operate-vnf-op-config"
 267                         ].get("day1-2", []):
 268                             for primitive in get_iterable(
 269                                 config.get("initial-config-primitive")
 270                             ):
 271                                 initial_primitives.append(primitive)
 272                 else:
 273                     initial_primitives = deep_get(
 274                         descriptor, ("ns-configuration", "initial-config-primitive")
 275                     )
 276
 277                 for initial_primitive in get_iterable(initial_primitives):
 278                     for param in get_iterable(initial_primitive.get("parameter")):
 279                         if param["value"].startswith("<") and param["value"].endswith(
 280                             ">"
 281                         ):
 282                             if param["value"] in (
 283                                 "<rw_mgmt_ip>",
 284                                 "<VDU_SCALE_INFO>",
 285                                 "<ns_config_info>",
 286                             ):
 287                                 continue
 288                             if (
 289                                 not additional_params
 290                                 or param["value"][1:-1] not in additional_params
 291                             ):
 292                                 raise EngineException(
 293                                     "Parameter '{}' needed for vnfd[id={}]:day1-2 configuration:"
 294                                     "initial-config-primitive[name={}] not supplied".format(
 295                                         param["value"],
 296                                         descriptor["id"],
 297                                         initial_primitive["name"],
 298                                     )
 299                                 )
 300
 301         return additional_params or None, other_params or None
 302
 303     def new(self, rollback, session, indata=None, kwargs=None, headers=None):
 304         """
 305         Creates a new nsr into database. It also creates needed vnfrs
 306         :param rollback: list to append the created items at database in case a rollback must be done
 307         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
 308         :param indata: params to be used for the nsr
 309         :param kwargs: used to override the indata descriptor
 310         :param headers: http request headers
 311         :return: the _id of nsr descriptor created at database. Or an exception of type
 312             EngineException, ValidationError, DbException, FsException, MsgException.
 313             Note: Exceptions are not captured on purpose. They should be captured at called
 314         """
 315         try:
 316             step = "checking quotas"
 317             self.check_quota(session)
 318
 319             step = "validating input parameters"
 320             ns_request = self._remove_envelop(indata)
 321             self._update_input_with_kwargs(ns_request, kwargs)
 322             ns_request = self._validate_input_new(ns_request, session["force"])
 323
 324             step = "getting nsd id='{}' from database".format(ns_request.get("nsdId"))
 325             nsd = self._get_nsd_from_db(ns_request["nsdId"], session)
 326             ns_k8s_namespace = self._get_ns_k8s_namespace(nsd, ns_request, session)
 327
 328             step = "checking nsdOperationalState"
 329             self._check_nsd_operational_state(nsd, ns_request)
 330
 331             step = "filling nsr from input data"
 332             nsr_id = str(uuid4())
 333             nsr_descriptor = self._create_nsr_descriptor_from_nsd(
 334                 nsd, ns_request, nsr_id, session
 335             )
 336
 337             # Create VNFRs
 338             needed_vnfds = {}
 339             # TODO: Change for multiple df support
 340             vnf_profiles = nsd.get("df", [{}])[0].get("vnf-profile", ())
 341             for vnfp in vnf_profiles:
 342                 vnfd_id = vnfp.get("vnfd-id")
 343                 vnf_index = vnfp.get("id")
 344                 step = (
 345                     "getting vnfd id='{}' constituent-vnfd='{}' from database".format(
 346                         vnfd_id, vnf_index
 347                     )
 348                 )
 349                 if vnfd_id not in needed_vnfds:
 350                     vnfd = self._get_vnfd_from_db(vnfd_id, session)
 351                     if "revision" in vnfd["_admin"]:
 352                         vnfd["revision"] = vnfd["_admin"]["revision"]
 353                     vnfd.pop("_admin")
 354                     needed_vnfds[vnfd_id] = vnfd
 355                     nsr_descriptor["vnfd-id"].append(vnfd["_id"])
 356                 else:
 357                     vnfd = needed_vnfds[vnfd_id]
 358
 359                 step = "filling vnfr  vnfd-id='{}' constituent-vnfd='{}'".format(
 360                     vnfd_id, vnf_index
 361                 )
 362                 vnfr_descriptor = self._create_vnfr_descriptor_from_vnfd(
 363                     nsd,
 364                     vnfd,
 365                     vnfd_id,
 366                     vnf_index,
 367                     nsr_descriptor,
 368                     ns_request,
 369                     ns_k8s_namespace,
 370                 )
 371
 372                 step = "creating vnfr vnfd-id='{}' constituent-vnfd='{}' at database".format(
 373                     vnfd_id, vnf_index
 374                 )
 375                 self._add_vnfr_to_db(vnfr_descriptor, rollback, session)
 376                 nsr_descriptor["constituent-vnfr-ref"].append(vnfr_descriptor["id"])
 377
 378             step = "creating nsr at database"
 379             self._add_nsr_to_db(nsr_descriptor, rollback, session)
 380
 381             step = "creating nsr temporal folder"
 382             self.fs.mkdir(nsr_id)
 383
 384             return nsr_id, None
 385         except (
 386             ValidationError,
 387             EngineException,
 388             DbException,
 389             MsgException,
 390             FsException,
 391         ) as e:
 392             raise type(e)("{} while '{}'".format(e, step), http_code=e.http_code)
 393
 394     def _get_nsd_from_db(self, nsd_id, session):
 395         _filter = self._get_project_filter(session)
 396         _filter["_id"] = nsd_id
 397         return self.db.get_one("nsds", _filter)
 398
 399     def _get_vnfd_from_db(self, vnfd_id, session):
 400         _filter = self._get_project_filter(session)
 401         _filter["id"] = vnfd_id
 402         vnfd = self.db.get_one("vnfds", _filter, fail_on_empty=True, fail_on_more=True)
 403         return vnfd
 404
 405     def _add_nsr_to_db(self, nsr_descriptor, rollback, session):
 406         self.format_on_new(
 407             nsr_descriptor, session["project_id"], make_public=session["public"]
 408         )
 409         self.db.create("nsrs", nsr_descriptor)
 410         rollback.append({"topic": "nsrs", "_id": nsr_descriptor["id"]})
 411
 412     def _add_vnfr_to_db(self, vnfr_descriptor, rollback, session):
 413         self.format_on_new(
 414             vnfr_descriptor, session["project_id"], make_public=session["public"]
 415         )
 416         self.db.create("vnfrs", vnfr_descriptor)
 417         rollback.append({"topic": "vnfrs", "_id": vnfr_descriptor["id"]})
 418
 419     def _check_nsd_operational_state(self, nsd, ns_request):
 420         if nsd["_admin"]["operationalState"] == "DISABLED":
 421             raise EngineException(
 422                 "nsd with id '{}' is DISABLED, and thus cannot be used to create "
 423                 "a network service".format(ns_request["nsdId"]),
 424                 http_code=HTTPStatus.CONFLICT,
 425             )
 426
 427     def _get_ns_k8s_namespace(self, nsd, ns_request, session):
 428         additional_params, _ = self._format_additional_params(
 429             ns_request, descriptor=nsd
 430         )
 431         # use for k8s-namespace from ns_request or additionalParamsForNs. By default, the project_id
 432         ns_k8s_namespace = session["project_id"][0] if session["project_id"] else None
 433         if ns_request and ns_request.get("k8s-namespace"):
 434             ns_k8s_namespace = ns_request["k8s-namespace"]
 435         if additional_params and additional_params.get("k8s-namespace"):
 436             ns_k8s_namespace = additional_params["k8s-namespace"]
 437
 438         return ns_k8s_namespace
 439
 440     def _create_nsr_descriptor_from_nsd(self, nsd, ns_request, nsr_id, session):
 441         now = time()
 442         additional_params, _ = self._format_additional_params(
 443             ns_request, descriptor=nsd
 444         )
 445
 446         nsr_descriptor = {
 447             "name": ns_request["nsName"],
 448             "name-ref": ns_request["nsName"],
 449             "short-name": ns_request["nsName"],
 450             "admin-status": "ENABLED",
 451             "nsState": "NOT_INSTANTIATED",
 452             "currentOperation": "IDLE",
 453             "currentOperationID": None,
 454             "errorDescription": None,
 455             "errorDetail": None,
 456             "deploymentStatus": None,
 457             "configurationStatus": None,
 458             "vcaStatus": None,
 459             "nsd": {k: v for k, v in nsd.items()},
 460             "datacenter": ns_request["vimAccountId"],
 461             "resource-orchestrator": "osmopenmano",
 462             "description": ns_request.get("nsDescription", ""),
 463             "constituent-vnfr-ref": [],
 464             "operational-status": "init",  # typedef ns-operational-
 465             "config-status": "init",  # typedef config-states
 466             "detailed-status": "scheduled",
 467             "orchestration-progress": {},
 468             "create-time": now,
 469             "nsd-name-ref": nsd["name"],
 470             "operational-events": [],  # "id", "timestamp", "description", "event",
 471             "nsd-ref": nsd["id"],
 472             "nsd-id": nsd["_id"],
 473             "vnfd-id": [],
 474             "instantiate_params": self._format_ns_request(ns_request),
 475             "additionalParamsForNs": additional_params,
 476             "ns-instance-config-ref": nsr_id,
 477             "id": nsr_id,
 478             "_id": nsr_id,
 479             "ssh-authorized-key": ns_request.get("ssh_keys"),  # TODO remove
 480             "flavor": [],
 481             "image": [],
 482             "affinity-or-anti-affinity-group": [],
 483         }
 484         ns_request["nsr_id"] = nsr_id
 485         if ns_request and ns_request.get("config-units"):
 486             nsr_descriptor["config-units"] = ns_request["config-units"]
 487         # Create vld
 488         if nsd.get("virtual-link-desc"):
 489             nsr_vld = deepcopy(nsd.get("virtual-link-desc", []))
 490             # Fill each vld with vnfd-connection-point-ref data
 491             # TODO: Change for multiple df support
 492             all_vld_connection_point_data = {vld.get("id"): [] for vld in nsr_vld}
 493             vnf_profiles = nsd.get("df", [[]])[0].get("vnf-profile", ())
 494             for vnf_profile in vnf_profiles:
 495                 for vlc in vnf_profile.get("virtual-link-connectivity", ()):
 496                     for cpd in vlc.get("constituent-cpd-id", ()):
 497                         all_vld_connection_point_data[
 498                             vlc.get("virtual-link-profile-id")
 499                         ].append(
 500                             {
 501                                 "member-vnf-index-ref": cpd.get(
 502                                     "constituent-base-element-id"
 503                                 ),
 504                                 "vnfd-connection-point-ref": cpd.get(
 505                                     "constituent-cpd-id"
 506                                 ),
 507                                 "vnfd-id-ref": vnf_profile.get("vnfd-id"),
 508                             }
 509                         )
 510
 511                 vnfd = self._get_vnfd_from_db(vnf_profile.get("vnfd-id"), session)
 512                 vnfd.pop("_admin")
 513
 514                 for vdu in vnfd.get("vdu", ()):
 515                     flavor_data = {}
 516                     guest_epa = {}
 517                     # Find this vdu compute and storage descriptors
 518                     vdu_virtual_compute = {}
 519                     vdu_virtual_storage = {}
 520                     for vcd in vnfd.get("virtual-compute-desc", ()):
 521                         if vcd.get("id") == vdu.get("virtual-compute-desc"):
 522                             vdu_virtual_compute = vcd
 523                     for vsd in vnfd.get("virtual-storage-desc", ()):
 524                         if vsd.get("id") == vdu.get("virtual-storage-desc", [[]])[0]:
 525                             vdu_virtual_storage = vsd
 526                     # Get this vdu vcpus, memory and storage info for flavor_data
 527                     if vdu_virtual_compute.get("virtual-cpu", {}).get(
 528                         "num-virtual-cpu"
 529                     ):
 530                         flavor_data["vcpu-count"] = vdu_virtual_compute["virtual-cpu"][
 531                             "num-virtual-cpu"
 532                         ]
 533                     if vdu_virtual_compute.get("virtual-memory", {}).get("size"):
 534                         flavor_data["memory-mb"] = (
 535                             float(vdu_virtual_compute["virtual-memory"]["size"])
 536                             * 1024.0
 537                         )
 538                     if vdu_virtual_storage.get("size-of-storage"):
 539                         flavor_data["storage-gb"] = vdu_virtual_storage[
 540                             "size-of-storage"
 541                         ]
 542                     # Get this vdu EPA info for guest_epa
 543                     if vdu_virtual_compute.get("virtual-cpu", {}).get("cpu-quota"):
 544                         guest_epa["cpu-quota"] = vdu_virtual_compute["virtual-cpu"][
 545                             "cpu-quota"
 546                         ]
 547                     if vdu_virtual_compute.get("virtual-cpu", {}).get("pinning"):
 548                         vcpu_pinning = vdu_virtual_compute["virtual-cpu"]["pinning"]
 549                         if vcpu_pinning.get("thread-policy"):
 550                             guest_epa["cpu-thread-pinning-policy"] = vcpu_pinning[
 551                                 "thread-policy"
 552                             ]
 553                         if vcpu_pinning.get("policy"):
 554                             cpu_policy = (
 555                                 "SHARED"
 556                                 if vcpu_pinning["policy"] == "dynamic"
 557                                 else "DEDICATED"
 558                             )
 559                             guest_epa["cpu-pinning-policy"] = cpu_policy
 560                     if vdu_virtual_compute.get("virtual-memory", {}).get("mem-quota"):
 561                         guest_epa["mem-quota"] = vdu_virtual_compute["virtual-memory"][
 562                             "mem-quota"
 563                         ]
 564                     if vdu_virtual_compute.get("virtual-memory", {}).get(
 565                         "mempage-size"
 566                     ):
 567                         guest_epa["mempage-size"] = vdu_virtual_compute[
 568                             "virtual-memory"
 569                         ]["mempage-size"]
 570                     if vdu_virtual_compute.get("virtual-memory", {}).get(
 571                         "numa-node-policy"
 572                     ):
 573                         guest_epa["numa-node-policy"] = vdu_virtual_compute[
 574                             "virtual-memory"
 575                         ]["numa-node-policy"]
 576                     if vdu_virtual_storage.get("disk-io-quota"):
 577                         guest_epa["disk-io-quota"] = vdu_virtual_storage[
 578                             "disk-io-quota"
 579                         ]
 580
 581                     if guest_epa:
 582                         flavor_data["guest-epa"] = guest_epa
 583
 584                     flavor_data["name"] = vdu["id"][:56] + "-flv"
 585                     flavor_data["id"] = str(len(nsr_descriptor["flavor"]))
 586                     nsr_descriptor["flavor"].append(flavor_data)
 587
 588                     sw_image_id = vdu.get("sw-image-desc")
 589                     if sw_image_id:
 590                         image_data = self._get_image_data_from_vnfd(vnfd, sw_image_id)
 591                         self._add_image_to_nsr(nsr_descriptor, image_data)
 592
 593                     # also add alternative images to the list of images
 594                     for alt_image in vdu.get("alternative-sw-image-desc", ()):
 595                         image_data = self._get_image_data_from_vnfd(vnfd, alt_image)
 596                         self._add_image_to_nsr(nsr_descriptor, image_data)
 597
 598                 # Add Affinity or Anti-affinity group information to NSR
 599                 vdu_profiles = vnfd.get("df", [[]])[0].get("vdu-profile", ())
 600                 affinity_group_prefix_name = "{}-{}".format(
 601                     nsr_descriptor["name"][:16], vnf_profile.get("id")[:16]
 602                 )
 603
 604                 for vdu_profile in vdu_profiles:
 605                     affinity_group_data = {}
 606                     for affinity_group in vdu_profile.get(
 607                         "affinity-or-anti-affinity-group", ()
 608                     ):
 609                         affinity_group_data = (
 610                             self._get_affinity_or_anti_affinity_group_data_from_vnfd(
 611                                 vnfd, affinity_group["id"]
 612                             )
 613                         )
 614                         affinity_group_data["member-vnf-index"] = vnf_profile.get("id")
 615                         self._add_affinity_or_anti_affinity_group_to_nsr(
 616                             nsr_descriptor,
 617                             affinity_group_data,
 618                             affinity_group_prefix_name,
 619                         )
 620
 621             for vld in nsr_vld:
 622                 vld["vnfd-connection-point-ref"] = all_vld_connection_point_data.get(
 623                     vld.get("id"), []
 624                 )
 625                 vld["name"] = vld["id"]
 626             nsr_descriptor["vld"] = nsr_vld
 627
 628         return nsr_descriptor
 629
 630     def _get_affinity_or_anti_affinity_group_data_from_vnfd(
 631         self, vnfd, affinity_group_id
 632     ):
 633         """
 634         Gets affinity-or-anti-affinity-group info from df and returns the desired affinity group
 635         """
 636         affinity_group = utils.find_in_list(
 637             vnfd.get("df", [[]])[0].get("affinity-or-anti-affinity-group", ()),
 638             lambda ag: ag["id"] == affinity_group_id,
 639         )
 640         affinity_group_data = {}
 641         if affinity_group:
 642             if affinity_group.get("id"):
 643                 affinity_group_data["ag-id"] = affinity_group["id"]
 644             if affinity_group.get("type"):
 645                 affinity_group_data["type"] = affinity_group["type"]
 646             if affinity_group.get("scope"):
 647                 affinity_group_data["scope"] = affinity_group["scope"]
 648         return affinity_group_data
 649
 650     def _add_affinity_or_anti_affinity_group_to_nsr(
 651         self, nsr_descriptor, affinity_group_data, affinity_group_prefix_name
 652     ):
 653         """
 654         Adds affinity-or-anti-affinity-group to nsr checking first it is not already added
 655         """
 656         affinity_group = next(
 657             (
 658                 f
 659                 for f in nsr_descriptor["affinity-or-anti-affinity-group"]
 660                 if all(f.get(k) == affinity_group_data[k] for k in affinity_group_data)
 661             ),
 662             None,
 663         )
 664         if not affinity_group:
 665             affinity_group_data["id"] = str(
 666                 len(nsr_descriptor["affinity-or-anti-affinity-group"])
 667             )
 668             affinity_group_data["name"] = "{}-{}".format(
 669                 affinity_group_prefix_name, affinity_group_data["ag-id"][:32]
 670             )
 671             nsr_descriptor["affinity-or-anti-affinity-group"].append(
 672                 affinity_group_data
 673             )
 674
 675     def _get_image_data_from_vnfd(self, vnfd, sw_image_id):
 676         sw_image_desc = utils.find_in_list(
 677             vnfd.get("sw-image-desc", ()), lambda sw: sw["id"] == sw_image_id
 678         )
 679         image_data = {}
 680         if sw_image_desc.get("image"):
 681             image_data["image"] = sw_image_desc["image"]
 682         if sw_image_desc.get("checksum"):
 683             image_data["image_checksum"] = sw_image_desc["checksum"]["hash"]
 684         if sw_image_desc.get("vim-type"):
 685             image_data["vim-type"] = sw_image_desc["vim-type"]
 686         return image_data
 687
 688     def _add_image_to_nsr(self, nsr_descriptor, image_data):
 689         """
 690         Adds image to nsr checking first it is not already added
 691         """
 692         img = next(
 693             (
 694                 f
 695                 for f in nsr_descriptor["image"]
 696                 if all(f.get(k) == image_data[k] for k in image_data)
 697             ),
 698             None,
 699         )
 700         if not img:
 701             image_data["id"] = str(len(nsr_descriptor["image"]))
 702             nsr_descriptor["image"].append(image_data)
 703
 704     def _create_vnfr_descriptor_from_vnfd(
 705         self,
 706         nsd,
 707         vnfd,
 708         vnfd_id,
 709         vnf_index,
 710         nsr_descriptor,
 711         ns_request,
 712         ns_k8s_namespace,
 713     ):
 714         vnfr_id = str(uuid4())
 715         nsr_id = nsr_descriptor["id"]
 716         now = time()
 717         additional_params, vnf_params = self._format_additional_params(
 718             ns_request, vnf_index, descriptor=vnfd
 719         )
 720
 721         vnfr_descriptor = {
 722             "id": vnfr_id,
 723             "_id": vnfr_id,
 724             "nsr-id-ref": nsr_id,
 725             "member-vnf-index-ref": vnf_index,
 726             "additionalParamsForVnf": additional_params,
 727             "created-time": now,
 728             # "vnfd": vnfd,        # at OSM model.but removed to avoid data duplication TODO: revise
 729             "vnfd-ref": vnfd_id,
 730             "vnfd-id": vnfd["_id"],  # not at OSM model, but useful
 731             "vim-account-id": None,
 732             "vca-id": None,
 733             "vdur": [],
 734             "connection-point": [],
 735             "ip-address": None,  # mgmt-interface filled by LCM
 736         }
 737
 738         # Revision backwards compatility.  Only specify the revision in the record if
 739         # the original VNFD has a revision.
 740         if "revision" in vnfd:
 741             vnfr_descriptor["revision"] = vnfd["revision"]
 742
 743
 744         vnf_k8s_namespace = ns_k8s_namespace
 745         if vnf_params:
 746             if vnf_params.get("k8s-namespace"):
 747                 vnf_k8s_namespace = vnf_params["k8s-namespace"]
 748             if vnf_params.get("config-units"):
 749                 vnfr_descriptor["config-units"] = vnf_params["config-units"]
 750
 751         # Create vld
 752         if vnfd.get("int-virtual-link-desc"):
 753             vnfr_descriptor["vld"] = []
 754             for vnfd_vld in vnfd.get("int-virtual-link-desc"):
 755                 vnfr_descriptor["vld"].append({key: vnfd_vld[key] for key in vnfd_vld})
 756
 757         for cp in vnfd.get("ext-cpd", ()):
 758             vnf_cp = {
 759                 "name": cp.get("id"),
 760                 "connection-point-id": cp.get("int-cpd", {}).get("cpd"),
 761                 "connection-point-vdu-id": cp.get("int-cpd", {}).get("vdu-id"),
 762                 "id": cp.get("id"),
 763                 # "ip-address", "mac-address" # filled by LCM
 764                 # vim-id  # TODO it would be nice having a vim port id
 765             }
 766             vnfr_descriptor["connection-point"].append(vnf_cp)
 767
 768         # Create k8s-cluster information
 769         # TODO: Validate if a k8s-cluster net can have more than one ext-cpd ?
 770         if vnfd.get("k8s-cluster"):
 771             vnfr_descriptor["k8s-cluster"] = vnfd["k8s-cluster"]
 772             all_k8s_cluster_nets_cpds = {}
 773             for cpd in get_iterable(vnfd.get("ext-cpd")):
 774                 if cpd.get("k8s-cluster-net"):
 775                     all_k8s_cluster_nets_cpds[cpd.get("k8s-cluster-net")] = cpd.get(
 776                         "id"
 777                     )
 778             for net in get_iterable(vnfr_descriptor["k8s-cluster"].get("nets")):
 779                 if net.get("id") in all_k8s_cluster_nets_cpds:
 780                     net["external-connection-point-ref"] = all_k8s_cluster_nets_cpds[
 781                         net.get("id")
 782                     ]
 783
 784         # update kdus
 785         for kdu in get_iterable(vnfd.get("kdu")):
 786             additional_params, kdu_params = self._format_additional_params(
 787                 ns_request, vnf_index, kdu_name=kdu["name"], descriptor=vnfd
 788             )
 789             kdu_k8s_namespace = vnf_k8s_namespace
 790             kdu_model = kdu_params.get("kdu_model") if kdu_params else None
 791             if kdu_params and kdu_params.get("k8s-namespace"):
 792                 kdu_k8s_namespace = kdu_params["k8s-namespace"]
 793
 794             kdu_deployment_name = ""
 795             if kdu_params and kdu_params.get("kdu-deployment-name"):
 796                 kdu_deployment_name = kdu_params.get("kdu-deployment-name")
 797
 798             kdur = {
 799                 "additionalParams": additional_params,
 800                 "k8s-namespace": kdu_k8s_namespace,
 801                 "kdu-deployment-name": kdu_deployment_name,
 802                 "kdu-name": kdu["name"],
 803                 # TODO      "name": ""     Name of the VDU in the VIM
 804                 "ip-address": None,  # mgmt-interface filled by LCM
 805                 "k8s-cluster": {},
 806             }
 807             if kdu_params and kdu_params.get("config-units"):
 808                 kdur["config-units"] = kdu_params["config-units"]
 809             if kdu.get("helm-version"):
 810                 kdur["helm-version"] = kdu["helm-version"]
 811             for k8s_type in ("helm-chart", "juju-bundle"):
 812                 if kdu.get(k8s_type):
 813                     kdur[k8s_type] = kdu_model or kdu[k8s_type]
 814             if not vnfr_descriptor.get("kdur"):
 815                 vnfr_descriptor["kdur"] = []
 816             vnfr_descriptor["kdur"].append(kdur)
 817
 818         vnfd_mgmt_cp = vnfd.get("mgmt-cp")
 819
 820         for vdu in vnfd.get("vdu", ()):
 821             vdu_mgmt_cp = []
 822             try:
 823                 configs = vnfd.get("df")[0]["lcm-operations-configuration"][
 824                     "operate-vnf-op-config"
 825                 ]["day1-2"]
 826                 vdu_config = utils.find_in_list(
 827                     configs, lambda config: config["id"] == vdu["id"]
 828                 )
 829             except Exception:
 830                 vdu_config = None
 831
 832             try:
 833                 vdu_instantiation_level = utils.find_in_list(
 834                     vnfd.get("df")[0]["instantiation-level"][0]["vdu-level"],
 835                     lambda a_vdu_profile: a_vdu_profile["vdu-id"] == vdu["id"],
 836                 )
 837             except Exception:
 838                 vdu_instantiation_level = None
 839
 840             if vdu_config:
 841                 external_connection_ee = utils.filter_in_list(
 842                     vdu_config.get("execution-environment-list", []),
 843                     lambda ee: "external-connection-point-ref" in ee,
 844                 )
 845                 for ee in external_connection_ee:
 846                     vdu_mgmt_cp.append(ee["external-connection-point-ref"])
 847
 848             additional_params, vdu_params = self._format_additional_params(
 849                 ns_request, vnf_index, vdu_id=vdu["id"], descriptor=vnfd
 850             )
 851
 852             try:
 853                 vdu_virtual_storage_descriptors = utils.filter_in_list(
 854                     vnfd.get("virtual-storage-desc", []),
 855                     lambda stg_desc: stg_desc["id"] in vdu["virtual-storage-desc"]
 856                 )
 857             except Exception:
 858                 vdu_virtual_storage_descriptors = []
 859             vdur = {
 860                 "vdu-id-ref": vdu["id"],
 861                 # TODO      "name": ""     Name of the VDU in the VIM
 862                 "ip-address": None,  # mgmt-interface filled by LCM
 863                 # "vim-id", "flavor-id", "image-id", "management-ip" # filled by LCM
 864                 "internal-connection-point": [],
 865                 "interfaces": [],
 866                 "additionalParams": additional_params,
 867                 "vdu-name": vdu["name"],
 868                 "virtual-storages": vdu_virtual_storage_descriptors
 869             }
 870             if vdu_params and vdu_params.get("config-units"):
 871                 vdur["config-units"] = vdu_params["config-units"]
 872             if deep_get(vdu, ("supplemental-boot-data", "boot-data-drive")):
 873                 vdur["boot-data-drive"] = vdu["supplemental-boot-data"][
 874                     "boot-data-drive"
 875                 ]
 876             if vdu.get("pdu-type"):
 877                 vdur["pdu-type"] = vdu["pdu-type"]
 878                 vdur["name"] = vdu["pdu-type"]
 879             # TODO volumes: name, volume-id
 880             for icp in vdu.get("int-cpd", ()):
 881                 vdu_icp = {
 882                     "id": icp["id"],
 883                     "connection-point-id": icp["id"],
 884                     "name": icp.get("id"),
 885                 }
 886
 887                 vdur["internal-connection-point"].append(vdu_icp)
 888
 889                 for iface in icp.get("virtual-network-interface-requirement", ()):
 890                     iface_fields = ("name", "mac-address")
 891                     vdu_iface = {
 892                         x: iface[x] for x in iface_fields if iface.get(x) is not None
 893                     }
 894
 895                     vdu_iface["internal-connection-point-ref"] = vdu_icp["id"]
 896                     if "port-security-enabled" in icp:
 897                         vdu_iface["port-security-enabled"] = icp[
 898                             "port-security-enabled"
 899                         ]
 900
 901                     if "port-security-disable-strategy" in icp:
 902                         vdu_iface["port-security-disable-strategy"] = icp[
 903                             "port-security-disable-strategy"
 904                         ]
 905
 906                     for ext_cp in vnfd.get("ext-cpd", ()):
 907                         if not ext_cp.get("int-cpd"):
 908                             continue
 909                         if ext_cp["int-cpd"].get("vdu-id") != vdu["id"]:
 910                             continue
 911                         if icp["id"] == ext_cp["int-cpd"].get("cpd"):
 912                             vdu_iface["external-connection-point-ref"] = ext_cp.get(
 913                                 "id"
 914                             )
 915
 916                             if "port-security-enabled" in ext_cp:
 917                                 vdu_iface["port-security-enabled"] = ext_cp[
 918                                     "port-security-enabled"
 919                                 ]
 920
 921                             if "port-security-disable-strategy" in ext_cp:
 922                                 vdu_iface["port-security-disable-strategy"] = ext_cp[
 923                                     "port-security-disable-strategy"
 924                                 ]
 925
 926                             break
 927
 928                     if (
 929                         vnfd_mgmt_cp
 930                         and vdu_iface.get("external-connection-point-ref")
 931                         == vnfd_mgmt_cp
 932                     ):
 933                         vdu_iface["mgmt-vnf"] = True
 934                         vdu_iface["mgmt-interface"] = True
 935
 936                     for ecp in vdu_mgmt_cp:
 937                         if vdu_iface.get("external-connection-point-ref") == ecp:
 938                             vdu_iface["mgmt-interface"] = True
 939
 940                     if iface.get("virtual-interface"):
 941                         vdu_iface.update(deepcopy(iface["virtual-interface"]))
 942
 943                     # look for network where this interface is connected
 944                     iface_ext_cp = vdu_iface.get("external-connection-point-ref")
 945                     if iface_ext_cp:
 946                         # TODO: Change for multiple df support
 947                         for df in get_iterable(nsd.get("df")):
 948                             for vnf_profile in get_iterable(df.get("vnf-profile")):
 949                                 for vlc_index, vlc in enumerate(
 950                                     get_iterable(
 951                                         vnf_profile.get("virtual-link-connectivity")
 952                                     )
 953                                 ):
 954                                     for cpd in get_iterable(
 955                                         vlc.get("constituent-cpd-id")
 956                                     ):
 957                                         if (
 958                                             cpd.get("constituent-cpd-id")
 959                                             == iface_ext_cp
 960                                         ):
 961                                             vdu_iface["ns-vld-id"] = vlc.get(
 962                                                 "virtual-link-profile-id"
 963                                             )
 964                                             # if iface type is SRIOV or PASSTHROUGH, set pci-interfaces flag to True
 965                                             if vdu_iface.get("type") in (
 966                                                 "SR-IOV",
 967                                                 "PCI-PASSTHROUGH",
 968                                             ):
 969                                                 nsr_descriptor["vld"][vlc_index][
 970                                                     "pci-interfaces"
 971                                                 ] = True
 972                                             break
 973                     elif vdu_iface.get("internal-connection-point-ref"):
 974                         vdu_iface["vnf-vld-id"] = icp.get("int-virtual-link-desc")
 975                         # TODO: store fixed IP address in the record (if it exists in the ICP)
 976                         # if iface type is SRIOV or PASSTHROUGH, set pci-interfaces flag to True
 977                         if vdu_iface.get("type") in ("SR-IOV", "PCI-PASSTHROUGH"):
 978                             ivld_index = utils.find_index_in_list(
 979                                 vnfd.get("int-virtual-link-desc", ()),
 980                                 lambda ivld: ivld["id"]
 981                                 == icp.get("int-virtual-link-desc"),
 982                             )
 983                             vnfr_descriptor["vld"][ivld_index]["pci-interfaces"] = True
 984
 985                     vdur["interfaces"].append(vdu_iface)
 986
 987             if vdu.get("sw-image-desc"):
 988                 sw_image = utils.find_in_list(
 989                     vnfd.get("sw-image-desc", ()),
 990                     lambda image: image["id"] == vdu.get("sw-image-desc"),
 991                 )
 992                 nsr_sw_image_data = utils.find_in_list(
 993                     nsr_descriptor["image"],
 994                     lambda nsr_image: (nsr_image.get("image") == sw_image.get("image")),
 995                 )
 996                 vdur["ns-image-id"] = nsr_sw_image_data["id"]
 997
 998             if vdu.get("alternative-sw-image-desc"):
 999                 alt_image_ids = []
1000                 for alt_image_id in vdu.get("alternative-sw-image-desc", ()):
1001                     sw_image = utils.find_in_list(
1002                         vnfd.get("sw-image-desc", ()),
1003                         lambda image: image["id"] == alt_image_id,
1004                     )
1005                     nsr_sw_image_data = utils.find_in_list(
1006                         nsr_descriptor["image"],
1007                         lambda nsr_image: (
1008                             nsr_image.get("image") == sw_image.get("image")
1009                         ),
1010                     )
1011                     alt_image_ids.append(nsr_sw_image_data["id"])
1012                 vdur["alt-image-ids"] = alt_image_ids
1013
1014             flavor_data_name = vdu["id"][:56] + "-flv"
1015             nsr_flavor_desc = utils.find_in_list(
1016                 nsr_descriptor["flavor"],
1017                 lambda flavor: flavor["name"] == flavor_data_name,
1018             )
1019
1020             if nsr_flavor_desc:
1021                 vdur["ns-flavor-id"] = nsr_flavor_desc["id"]
1022
1023             # Adding Affinity groups information to vdur
1024             try:
1025                 vdu_profile_affinity_group = utils.find_in_list(
1026                     vnfd.get("df")[0]["vdu-profile"],
1027                     lambda a_vdu: a_vdu["id"] == vdu["id"],
1028                 )
1029             except Exception:
1030                 vdu_profile_affinity_group = None
1031
1032             if vdu_profile_affinity_group:
1033                 affinity_group_ids = []
1034                 for affinity_group in vdu_profile_affinity_group.get(
1035                     "affinity-or-anti-affinity-group", ()
1036                 ):
1037                     vdu_affinity_group = utils.find_in_list(
1038                         vdu_profile_affinity_group.get(
1039                             "affinity-or-anti-affinity-group", ()
1040                         ),
1041                         lambda ag_fp: ag_fp["id"] == affinity_group["id"],
1042                     )
1043                     nsr_affinity_group = utils.find_in_list(
1044                         nsr_descriptor["affinity-or-anti-affinity-group"],
1045                         lambda nsr_ag: (
1046                             nsr_ag.get("ag-id") == vdu_affinity_group.get("id")
1047                             and nsr_ag.get("member-vnf-index")
1048                             == vnfr_descriptor.get("member-vnf-index-ref")
1049                         ),
1050                     )
1051                     # Update Affinity Group VIM name if VDU instantiation parameter is present
1052                     if vnf_params and vnf_params.get("affinity-or-anti-affinity-group"):
1053                         vnf_params_affinity_group = utils.find_in_list(
1054                             vnf_params["affinity-or-anti-affinity-group"],
1055                             lambda vnfp_ag: (
1056                                 vnfp_ag.get("id") == vdu_affinity_group.get("id")
1057                             ),
1058                         )
1059                         if vnf_params_affinity_group.get("vim-affinity-group-id"):
1060                             nsr_affinity_group[
1061                                 "vim-affinity-group-id"
1062                             ] = vnf_params_affinity_group["vim-affinity-group-id"]
1063                     affinity_group_ids.append(nsr_affinity_group["id"])
1064                 vdur["affinity-or-anti-affinity-group-id"] = affinity_group_ids
1065
1066             if vdu_instantiation_level:
1067                 count = vdu_instantiation_level.get("number-of-instances")
1068             else:
1069                 count = 1
1070
1071             for index in range(0, count):
1072                 vdur = deepcopy(vdur)
1073                 for iface in vdur["interfaces"]:
1074                     if iface.get("ip-address") and index != 0:
1075                         iface["ip-address"] = increment_ip_mac(iface["ip-address"])
1076                     if iface.get("mac-address") and index != 0:
1077                         iface["mac-address"] = increment_ip_mac(iface["mac-address"])
1078
1079                 vdur["_id"] = str(uuid4())
1080                 vdur["id"] = vdur["_id"]
1081                 vdur["count-index"] = index
1082                 vnfr_descriptor["vdur"].append(vdur)
1083
1084         return vnfr_descriptor
1085
1086     def vca_status_refresh(self, session, ns_instance_content, filter_q):
1087         """
1088         vcaStatus in ns_instance_content maybe stale, check if it is stale and create lcm op
1089         to refresh vca status by sending message to LCM when it is stale. Ignore otherwise.
1090         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1091         :param ns_instance_content:  ns instance content
1092         :param filter_q: dict: query parameter containing vcaStatus-refresh as true or false
1093         :return: None
1094         """
1095         time_now, time_delta = time(), time() - ns_instance_content["_admin"]["modified"]
1096         force_refresh = isinstance(filter_q, dict) and filter_q.get('vcaStatusRefresh') == 'true'
1097         threshold_reached = time_delta > 120
1098         if force_refresh or threshold_reached:
1099             operation, _id = "vca_status_refresh", ns_instance_content["_id"]
1100             ns_instance_content["_admin"]["modified"] = time_now
1101             self.db.set_one(self.topic, {"_id": _id}, ns_instance_content)
1102             nslcmop_desc = NsLcmOpTopic._create_nslcmop(_id, operation, None)
1103             self.format_on_new(nslcmop_desc, session["project_id"], make_public=session["public"])
1104             nslcmop_desc["_admin"].pop("nsState")
1105             self.msg.write("ns", operation, nslcmop_desc)
1106         return
1107
1108     def show(self, session, _id, filter_q=None, api_req=False):
1109         """
1110         Get complete information on an ns instance.
1111         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1112         :param _id: string, ns instance id
1113         :param filter_q: dict: query parameter containing vcaStatusRefresh as true or false
1114         :param api_req: True if this call is serving an external API request. False if serving internal request.
1115         :return: dictionary, raise exception if not found.
1116         """
1117         ns_instance_content = super().show(session, _id, api_req)
1118         self.vca_status_refresh(session, ns_instance_content, filter_q)
1119         return ns_instance_content
1120
1121     def edit(self, session, _id, indata=None, kwargs=None, content=None):
1122         raise EngineException(
1123             "Method edit called directly", HTTPStatus.INTERNAL_SERVER_ERROR
1124         )
1125
1126
1127 class VnfrTopic(BaseTopic):
1128     topic = "vnfrs"
1129     topic_msg = None
1130
1131     def __init__(self, db, fs, msg, auth):
1132         BaseTopic.__init__(self, db, fs, msg, auth)
1133
1134     def delete(self, session, _id, dry_run=False, not_send_msg=None):
1135         raise EngineException(
1136             "Method delete called directly", HTTPStatus.INTERNAL_SERVER_ERROR
1137         )
1138
1139     def edit(self, session, _id, indata=None, kwargs=None, content=None):
1140         raise EngineException(
1141             "Method edit called directly", HTTPStatus.INTERNAL_SERVER_ERROR
1142         )
1143
1144     def new(self, rollback, session, indata=None, kwargs=None, headers=None):
1145         # Not used because vnfrs are created and deleted by NsrTopic class directly
1146         raise EngineException(
1147             "Method new called directly", HTTPStatus.INTERNAL_SERVER_ERROR
1148         )
1149
1150
1151 class NsLcmOpTopic(BaseTopic):
1152     topic = "nslcmops"
1153     topic_msg = "ns"
1154     operation_schema = {  # mapping between operation and jsonschema to validate
1155         "instantiate": ns_instantiate,
1156         "action": ns_action,
1157         "scale": ns_scale,
1158         "terminate": ns_terminate,
1159     }
1160
1161     def __init__(self, db, fs, msg, auth):
1162         BaseTopic.__init__(self, db, fs, msg, auth)
1163
1164     def _check_ns_operation(self, session, nsr, operation, indata):
1165         """
1166         Check that user has enter right parameters for the operation
1167         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1168         :param operation: it can be: instantiate, terminate, action, TODO: update, heal
1169         :param indata: descriptor with the parameters of the operation
1170         :return: None
1171         """
1172         if operation == "action":
1173             self._check_action_ns_operation(indata, nsr)
1174         elif operation == "scale":
1175             self._check_scale_ns_operation(indata, nsr)
1176         elif operation == "instantiate":
1177             self._check_instantiate_ns_operation(indata, nsr, session)
1178
1179     def _check_action_ns_operation(self, indata, nsr):
1180         nsd = nsr["nsd"]
1181         # check vnf_member_index
1182         if indata.get("vnf_member_index"):
1183             indata["member_vnf_index"] = indata.pop(
1184                 "vnf_member_index"
1185             )  # for backward compatibility
1186         if indata.get("member_vnf_index"):
1187             vnfd = self._get_vnfd_from_vnf_member_index(
1188                 indata["member_vnf_index"], nsr["_id"]
1189             )
1190             try:
1191                 configs = vnfd.get("df")[0]["lcm-operations-configuration"][
1192                     "operate-vnf-op-config"
1193                 ]["day1-2"]
1194             except Exception:
1195                 configs = []
1196
1197             if indata.get("vdu_id"):
1198                 self._check_valid_vdu(vnfd, indata["vdu_id"])
1199                 descriptor_configuration = utils.find_in_list(
1200                     configs, lambda config: config["id"] == indata["vdu_id"]
1201                 )
1202             elif indata.get("kdu_name"):
1203                 self._check_valid_kdu(vnfd, indata["kdu_name"])
1204                 descriptor_configuration = utils.find_in_list(
1205                     configs, lambda config: config["id"] == indata.get("kdu_name")
1206                 )
1207             else:
1208                 descriptor_configuration = utils.find_in_list(
1209                     configs, lambda config: config["id"] == vnfd["id"]
1210                 )
1211             if descriptor_configuration is not None:
1212                 descriptor_configuration = descriptor_configuration.get(
1213                     "config-primitive"
1214                 )
1215         else:  # use a NSD
1216             descriptor_configuration = nsd.get("ns-configuration", {}).get(
1217                 "config-primitive"
1218             )
1219
1220         # For k8s allows default primitives without validating the parameters
1221         if indata.get("kdu_name") and indata["primitive"] in (
1222             "upgrade",
1223             "rollback",
1224             "status",
1225             "inspect",
1226             "readme",
1227         ):
1228             # TODO should be checked that rollback only can contains revsision_numbe????
1229             if not indata.get("member_vnf_index"):
1230                 raise EngineException(
1231                     "Missing action parameter 'member_vnf_index' for default KDU primitive '{}'".format(
1232                         indata["primitive"]
1233                     )
1234                 )
1235             return
1236         # if not, check primitive
1237         for config_primitive in get_iterable(descriptor_configuration):
1238             if indata["primitive"] == config_primitive["name"]:
1239                 # check needed primitive_params are provided
1240                 if indata.get("primitive_params"):
1241                     in_primitive_params_copy = copy(indata["primitive_params"])
1242                 else:
1243                     in_primitive_params_copy = {}
1244                 for paramd in get_iterable(config_primitive.get("parameter")):
1245                     if paramd["name"] in in_primitive_params_copy:
1246                         del in_primitive_params_copy[paramd["name"]]
1247                     elif not paramd.get("default-value"):
1248                         raise EngineException(
1249                             "Needed parameter {} not provided for primitive '{}'".format(
1250                                 paramd["name"], indata["primitive"]
1251                             )
1252                         )
1253                 # check no extra primitive params are provided
1254                 if in_primitive_params_copy:
1255                     raise EngineException(
1256                         "parameter/s '{}' not present at vnfd /nsd for primitive '{}'".format(
1257                             list(in_primitive_params_copy.keys()), indata["primitive"]
1258                         )
1259                     )
1260                 break
1261         else:
1262             raise EngineException(
1263                 "Invalid primitive '{}' is not present at vnfd/nsd".format(
1264                     indata["primitive"]
1265                 )
1266             )
1267
1268     def _check_scale_ns_operation(self, indata, nsr):
1269         vnfd = self._get_vnfd_from_vnf_member_index(
1270             indata["scaleVnfData"]["scaleByStepData"]["member-vnf-index"], nsr["_id"]
1271         )
1272         for scaling_aspect in get_iterable(vnfd.get("df", ())[0]["scaling-aspect"]):
1273             if (
1274                 indata["scaleVnfData"]["scaleByStepData"]["scaling-group-descriptor"]
1275                 == scaling_aspect["id"]
1276             ):
1277                 break
1278         else:
1279             raise EngineException(
1280                 "Invalid scaleVnfData:scaleByStepData:scaling-group-descriptor '{}' is not "
1281                 "present at vnfd:scaling-aspect".format(
1282                     indata["scaleVnfData"]["scaleByStepData"][
1283                         "scaling-group-descriptor"
1284                     ]
1285                 )
1286             )
1287
1288     def _check_instantiate_ns_operation(self, indata, nsr, session):
1289         vnf_member_index_to_vnfd = {}  # map between vnf_member_index to vnf descriptor.
1290         vim_accounts = []
1291         wim_accounts = []
1292         nsd = nsr["nsd"]
1293         self._check_valid_vim_account(indata["vimAccountId"], vim_accounts, session)
1294         self._check_valid_wim_account(indata.get("wimAccountId"), wim_accounts, session)
1295         for in_vnf in get_iterable(indata.get("vnf")):
1296             member_vnf_index = in_vnf["member-vnf-index"]
1297             if vnf_member_index_to_vnfd.get(member_vnf_index):
1298                 vnfd = vnf_member_index_to_vnfd[member_vnf_index]
1299             else:
1300                 vnfd = self._get_vnfd_from_vnf_member_index(
1301                     member_vnf_index, nsr["_id"]
1302                 )
1303                 vnf_member_index_to_vnfd[
1304                     member_vnf_index
1305                 ] = vnfd  # add to cache, avoiding a later look for
1306             self._check_vnf_instantiation_params(in_vnf, vnfd)
1307             if in_vnf.get("vimAccountId"):
1308                 self._check_valid_vim_account(
1309                     in_vnf["vimAccountId"], vim_accounts, session
1310                 )
1311
1312         for in_vld in get_iterable(indata.get("vld")):
1313             self._check_valid_wim_account(
1314                 in_vld.get("wimAccountId"), wim_accounts, session
1315             )
1316             for vldd in get_iterable(nsd.get("virtual-link-desc")):
1317                 if in_vld["name"] == vldd["id"]:
1318                     break
1319             else:
1320                 raise EngineException(
1321                     "Invalid parameter vld:name='{}' is not present at nsd:vld".format(
1322                         in_vld["name"]
1323                     )
1324                 )
1325
1326     def _get_vnfd_from_vnf_member_index(self, member_vnf_index, nsr_id):
1327         # Obtain vnf descriptor. The vnfr is used to get the vnfd._id used for this member_vnf_index
1328         vnfr = self.db.get_one(
1329             "vnfrs",
1330             {"nsr-id-ref": nsr_id, "member-vnf-index-ref": member_vnf_index},
1331             fail_on_empty=False,
1332         )
1333         if not vnfr:
1334             raise EngineException(
1335                 "Invalid parameter member_vnf_index='{}' is not one of the "
1336                 "nsd:constituent-vnfd".format(member_vnf_index)
1337             )
1338
1339         ## Backwards compatibility: if there is no revision, get it from the one and only VNFD entry
1340         if "revision" in vnfr:
1341             vnfd_revision = vnfr["vnfd-id"] + ":" + str(vnfr["revision"])
1342             vnfd = self.db.get_one("vnfds_revisions", {"_id": vnfd_revision}, fail_on_empty=False)
1343         else:
1344             vnfd = self.db.get_one("vnfds", {"_id": vnfr["vnfd-id"]}, fail_on_empty=False)
1345
1346         if not vnfd:
1347             raise EngineException(
1348                 "vnfd id={} has been deleted!. Operation cannot be performed".format(
1349                     vnfr["vnfd-id"]
1350                 )
1351             )
1352         return vnfd
1353
1354     def _check_valid_vdu(self, vnfd, vdu_id):
1355         for vdud in get_iterable(vnfd.get("vdu")):
1356             if vdud["id"] == vdu_id:
1357                 return vdud
1358         else:
1359             raise EngineException(
1360                 "Invalid parameter vdu_id='{}' not present at vnfd:vdu:id".format(
1361                     vdu_id
1362                 )
1363             )
1364
1365     def _check_valid_kdu(self, vnfd, kdu_name):
1366         for kdud in get_iterable(vnfd.get("kdu")):
1367             if kdud["name"] == kdu_name:
1368                 return kdud
1369         else:
1370             raise EngineException(
1371                 "Invalid parameter kdu_name='{}' not present at vnfd:kdu:name".format(
1372                     kdu_name
1373                 )
1374             )
1375
1376     def _check_vnf_instantiation_params(self, in_vnf, vnfd):
1377         for in_vdu in get_iterable(in_vnf.get("vdu")):
1378             for vdu in get_iterable(vnfd.get("vdu")):
1379                 if in_vdu["id"] == vdu["id"]:
1380                     for volume in get_iterable(in_vdu.get("volume")):
1381                         for volumed in get_iterable(vdu.get("virtual-storage-desc")):
1382                             if volumed["id"] == volume["name"]:
1383                                 break
1384                         else:
1385                             raise EngineException(
1386                                 "Invalid parameter vnf[member-vnf-index='{}']:vdu[id='{}']:"
1387                                 "volume:name='{}' is not present at "
1388                                 "vnfd:vdu:virtual-storage-desc list".format(
1389                                     in_vnf["member-vnf-index"],
1390                                     in_vdu["id"],
1391                                     volume["id"],
1392                                 )
1393                             )
1394
1395                     vdu_if_names = set()
1396                     for cpd in get_iterable(vdu.get("int-cpd")):
1397                         for iface in get_iterable(
1398                             cpd.get("virtual-network-interface-requirement")
1399                         ):
1400                             vdu_if_names.add(iface.get("name"))
1401
1402                     for in_iface in get_iterable(in_vdu["interface"]):
1403                         if in_iface["name"] in vdu_if_names:
1404                             break
1405                         else:
1406                             raise EngineException(
1407                                 "Invalid parameter vnf[member-vnf-index='{}']:vdu[id='{}']:"
1408                                 "int-cpd[id='{}'] is not present at vnfd:vdu:int-cpd".format(
1409                                     in_vnf["member-vnf-index"],
1410                                     in_vdu["id"],
1411                                     in_iface["name"],
1412                                 )
1413                             )
1414                     break
1415
1416             else:
1417                 raise EngineException(
1418                     "Invalid parameter vnf[member-vnf-index='{}']:vdu[id='{}'] is not present "
1419                     "at vnfd:vdu".format(in_vnf["member-vnf-index"], in_vdu["id"])
1420                 )
1421
1422         vnfd_ivlds_cpds = {
1423             ivld.get("id"): set()
1424             for ivld in get_iterable(vnfd.get("int-virtual-link-desc"))
1425         }
1426         for vdu in get_iterable(vnfd.get("vdu")):
1427             for cpd in get_iterable(vnfd.get("int-cpd")):
1428                 if cpd.get("int-virtual-link-desc"):
1429                     vnfd_ivlds_cpds[cpd.get("int-virtual-link-desc")] = cpd.get("id")
1430
1431         for in_ivld in get_iterable(in_vnf.get("internal-vld")):
1432             if in_ivld.get("name") in vnfd_ivlds_cpds:
1433                 for in_icp in get_iterable(in_ivld.get("internal-connection-point")):
1434                     if in_icp["id-ref"] in vnfd_ivlds_cpds[in_ivld.get("name")]:
1435                         break
1436                     else:
1437                         raise EngineException(
1438                             "Invalid parameter vnf[member-vnf-index='{}']:internal-vld[name"
1439                             "='{}']:internal-connection-point[id-ref:'{}'] is not present at "
1440                             "vnfd:internal-vld:name/id:internal-connection-point".format(
1441                                 in_vnf["member-vnf-index"],
1442                                 in_ivld["name"],
1443                                 in_icp["id-ref"],
1444                             )
1445                         )
1446             else:
1447                 raise EngineException(
1448                     "Invalid parameter vnf[member-vnf-index='{}']:internal-vld:name='{}'"
1449                     " is not present at vnfd '{}'".format(
1450                         in_vnf["member-vnf-index"], in_ivld["name"], vnfd["id"]
1451                     )
1452                 )
1453
1454     def _check_valid_vim_account(self, vim_account, vim_accounts, session):
1455         if vim_account in vim_accounts:
1456             return
1457         try:
1458             db_filter = self._get_project_filter(session)
1459             db_filter["_id"] = vim_account
1460             self.db.get_one("vim_accounts", db_filter)
1461         except Exception:
1462             raise EngineException(
1463                 "Invalid vimAccountId='{}' not present for the project".format(
1464                     vim_account
1465                 )
1466             )
1467         vim_accounts.append(vim_account)
1468
1469     def _get_vim_account(self, vim_id: str, session):
1470         try:
1471             db_filter = self._get_project_filter(session)
1472             db_filter["_id"] = vim_id
1473             return self.db.get_one("vim_accounts", db_filter)
1474         except Exception:
1475             raise EngineException(
1476                 "Invalid vimAccountId='{}' not present for the project".format(
1477                     vim_id
1478                 )
1479             )
1480
1481     def _check_valid_wim_account(self, wim_account, wim_accounts, session):
1482         if not isinstance(wim_account, str):
1483             return
1484         if wim_account in wim_accounts:
1485             return
1486         try:
1487             db_filter = self._get_project_filter(session, write=False, show_all=True)
1488             db_filter["_id"] = wim_account
1489             self.db.get_one("wim_accounts", db_filter)
1490         except Exception:
1491             raise EngineException(
1492                 "Invalid wimAccountId='{}' not present for the project".format(
1493                     wim_account
1494                 )
1495             )
1496         wim_accounts.append(wim_account)
1497
1498     def _look_for_pdu(
1499         self, session, rollback, vnfr, vim_account, vnfr_update, vnfr_update_rollback
1500     ):
1501         """
1502         Look for a free PDU in the catalog matching vdur type and interfaces. Fills vnfr.vdur with the interface
1503         (ip_address, ...) information.
1504         Modifies PDU _admin.usageState to 'IN_USE'
1505         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1506         :param rollback: list with the database modifications to rollback if needed
1507         :param vnfr: vnfr to be updated. It is modified with pdu interface info if pdu is found
1508         :param vim_account: vim_account where this vnfr should be deployed
1509         :param vnfr_update: dictionary filled by this method with changes to be done at database vnfr
1510         :param vnfr_update_rollback: dictionary filled by this method with original content of vnfr in case a rollback
1511                                      of the changed vnfr is needed
1512
1513         :return: List of PDU interfaces that are connected to an existing VIM network. Each item contains:
1514                  "vim-network-name": used at VIM
1515                   "name": interface name
1516                   "vnf-vld-id": internal VNFD vld where this interface is connected, or
1517                   "ns-vld-id": NSD vld where this interface is connected.
1518                   NOTE: One, and only one between 'vnf-vld-id' and 'ns-vld-id' contains a value. The other will be None
1519         """
1520
1521         ifaces_forcing_vim_network = []
1522         for vdur_index, vdur in enumerate(get_iterable(vnfr.get("vdur"))):
1523             if not vdur.get("pdu-type"):
1524                 continue
1525             pdu_type = vdur.get("pdu-type")
1526             pdu_filter = self._get_project_filter(session)
1527             pdu_filter["vim_accounts"] = vim_account
1528             pdu_filter["type"] = pdu_type
1529             pdu_filter["_admin.operationalState"] = "ENABLED"
1530             pdu_filter["_admin.usageState"] = "NOT_IN_USE"
1531             # TODO feature 1417: "shared": True,
1532
1533             available_pdus = self.db.get_list("pdus", pdu_filter)
1534             for pdu in available_pdus:
1535                 # step 1 check if this pdu contains needed interfaces:
1536                 match_interfaces = True
1537                 for vdur_interface in vdur["interfaces"]:
1538                     for pdu_interface in pdu["interfaces"]:
1539                         if pdu_interface["name"] == vdur_interface["name"]:
1540                             # TODO feature 1417: match per mgmt type
1541                             break
1542                     else:  # no interface found for name
1543                         match_interfaces = False
1544                         break
1545                 if match_interfaces:
1546                     break
1547             else:
1548                 raise EngineException(
1549                     "No PDU of type={} at vim_account={} found for member_vnf_index={}, vdu={} matching interface "
1550                     "names".format(
1551                         pdu_type,
1552                         vim_account,
1553                         vnfr["member-vnf-index-ref"],
1554                         vdur["vdu-id-ref"],
1555                     )
1556                 )
1557
1558             # step 2. Update pdu
1559             rollback_pdu = {
1560                 "_admin.usageState": pdu["_admin"]["usageState"],
1561                 "_admin.usage.vnfr_id": None,
1562                 "_admin.usage.nsr_id": None,
1563                 "_admin.usage.vdur": None,
1564             }
1565             self.db.set_one(
1566                 "pdus",
1567                 {"_id": pdu["_id"]},
1568                 {
1569                     "_admin.usageState": "IN_USE",
1570                     "_admin.usage": {
1571                         "vnfr_id": vnfr["_id"],
1572                         "nsr_id": vnfr["nsr-id-ref"],
1573                         "vdur": vdur["vdu-id-ref"],
1574                     },
1575                 },
1576             )
1577             rollback.append(
1578                 {
1579                     "topic": "pdus",
1580                     "_id": pdu["_id"],
1581                     "operation": "set",
1582                     "content": rollback_pdu,
1583                 }
1584             )
1585
1586             # step 3. Fill vnfr info by filling vdur
1587             vdu_text = "vdur.{}".format(vdur_index)
1588             vnfr_update_rollback[vdu_text + ".pdu-id"] = None
1589             vnfr_update[vdu_text + ".pdu-id"] = pdu["_id"]
1590             for iface_index, vdur_interface in enumerate(vdur["interfaces"]):
1591                 for pdu_interface in pdu["interfaces"]:
1592                     if pdu_interface["name"] == vdur_interface["name"]:
1593                         iface_text = vdu_text + ".interfaces.{}".format(iface_index)
1594                         for k, v in pdu_interface.items():
1595                             if k in (
1596                                 "ip-address",
1597                                 "mac-address",
1598                             ):  # TODO: switch-xxxxx must be inserted
1599                                 vnfr_update[iface_text + ".{}".format(k)] = v
1600                                 vnfr_update_rollback[
1601                                     iface_text + ".{}".format(k)
1602                                 ] = vdur_interface.get(v)
1603                         if pdu_interface.get("ip-address"):
1604                             if vdur_interface.get(
1605                                 "mgmt-interface"
1606                             ) or vdur_interface.get("mgmt-vnf"):
1607                                 vnfr_update_rollback[
1608                                     vdu_text + ".ip-address"
1609                                 ] = vdur.get("ip-address")
1610                                 vnfr_update[vdu_text + ".ip-address"] = pdu_interface[
1611                                     "ip-address"
1612                                 ]
1613                             if vdur_interface.get("mgmt-vnf"):
1614                                 vnfr_update_rollback["ip-address"] = vnfr.get(
1615                                     "ip-address"
1616                                 )
1617                                 vnfr_update["ip-address"] = pdu_interface["ip-address"]
1618                                 vnfr_update[vdu_text + ".ip-address"] = pdu_interface[
1619                                     "ip-address"
1620                                 ]
1621                         if pdu_interface.get("vim-network-name") or pdu_interface.get(
1622                             "vim-network-id"
1623                         ):
1624                             ifaces_forcing_vim_network.append(
1625                                 {
1626                                     "name": vdur_interface.get("vnf-vld-id")
1627                                     or vdur_interface.get("ns-vld-id"),
1628                                     "vnf-vld-id": vdur_interface.get("vnf-vld-id"),
1629                                     "ns-vld-id": vdur_interface.get("ns-vld-id"),
1630                                 }
1631                             )
1632                             if pdu_interface.get("vim-network-id"):
1633                                 ifaces_forcing_vim_network[-1][
1634                                     "vim-network-id"
1635                                 ] = pdu_interface["vim-network-id"]
1636                             if pdu_interface.get("vim-network-name"):
1637                                 ifaces_forcing_vim_network[-1][
1638                                     "vim-network-name"
1639                                 ] = pdu_interface["vim-network-name"]
1640                         break
1641
1642         return ifaces_forcing_vim_network
1643
1644     def _look_for_k8scluster(
1645         self, session, rollback, vnfr, vim_account, vnfr_update, vnfr_update_rollback
1646     ):
1647         """
1648         Look for an available k8scluster for all the kuds in the vnfd matching version and cni requirements.
1649         Fills vnfr.kdur with the selected k8scluster
1650
1651         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1652         :param rollback: list with the database modifications to rollback if needed
1653         :param vnfr: vnfr to be updated. It is modified with pdu interface info if pdu is found
1654         :param vim_account: vim_account where this vnfr should be deployed
1655         :param vnfr_update: dictionary filled by this method with changes to be done at database vnfr
1656         :param vnfr_update_rollback: dictionary filled by this method with original content of vnfr in case a rollback
1657                                      of the changed vnfr is needed
1658
1659         :return: List of KDU interfaces that are connected to an existing VIM network. Each item contains:
1660                  "vim-network-name": used at VIM
1661                   "name": interface name
1662                   "vnf-vld-id": internal VNFD vld where this interface is connected, or
1663                   "ns-vld-id": NSD vld where this interface is connected.
1664                   NOTE: One, and only one between 'vnf-vld-id' and 'ns-vld-id' contains a value. The other will be None
1665         """
1666
1667         ifaces_forcing_vim_network = []
1668         if not vnfr.get("kdur"):
1669             return ifaces_forcing_vim_network
1670
1671         kdu_filter = self._get_project_filter(session)
1672         kdu_filter["vim_account"] = vim_account
1673         # TODO kdu_filter["_admin.operationalState"] = "ENABLED"
1674         available_k8sclusters = self.db.get_list("k8sclusters", kdu_filter)
1675
1676         k8s_requirements = {}  # just for logging
1677         for k8scluster in available_k8sclusters:
1678             if not vnfr.get("k8s-cluster"):
1679                 break
1680             # restrict by cni
1681             if vnfr["k8s-cluster"].get("cni"):
1682                 k8s_requirements["cni"] = vnfr["k8s-cluster"]["cni"]
1683                 if not set(vnfr["k8s-cluster"]["cni"]).intersection(
1684                     k8scluster.get("cni", ())
1685                 ):
1686                     continue
1687             # restrict by version
1688             if vnfr["k8s-cluster"].get("version"):
1689                 k8s_requirements["version"] = vnfr["k8s-cluster"]["version"]
1690                 if k8scluster.get("k8s_version") not in vnfr["k8s-cluster"]["version"]:
1691                     continue
1692             # restrict by number of networks
1693             if vnfr["k8s-cluster"].get("nets"):
1694                 k8s_requirements["networks"] = len(vnfr["k8s-cluster"]["nets"])
1695                 if not k8scluster.get("nets") or len(k8scluster["nets"]) < len(
1696                     vnfr["k8s-cluster"]["nets"]
1697                 ):
1698                     continue
1699             break
1700         else:
1701             raise EngineException(
1702                 "No k8scluster with requirements='{}' at vim_account={} found for member_vnf_index={}".format(
1703                     k8s_requirements, vim_account, vnfr["member-vnf-index-ref"]
1704                 )
1705             )
1706
1707         for kdur_index, kdur in enumerate(get_iterable(vnfr.get("kdur"))):
1708             # step 3. Fill vnfr info by filling kdur
1709             kdu_text = "kdur.{}.".format(kdur_index)
1710             vnfr_update_rollback[kdu_text + "k8s-cluster.id"] = None
1711             vnfr_update[kdu_text + "k8s-cluster.id"] = k8scluster["_id"]
1712
1713         # step 4. Check VIM networks that forces the selected k8s_cluster
1714         if vnfr.get("k8s-cluster") and vnfr["k8s-cluster"].get("nets"):
1715             k8scluster_net_list = list(k8scluster.get("nets").keys())
1716             for net_index, kdur_net in enumerate(vnfr["k8s-cluster"]["nets"]):
1717                 # get a network from k8s_cluster nets. If name matches use this, if not use other
1718                 if kdur_net["id"] in k8scluster_net_list:  # name matches
1719                     vim_net = k8scluster["nets"][kdur_net["id"]]
1720                     k8scluster_net_list.remove(kdur_net["id"])
1721                 else:
1722                     vim_net = k8scluster["nets"][k8scluster_net_list[0]]
1723                     k8scluster_net_list.pop(0)
1724                 vnfr_update_rollback[
1725                     "k8s-cluster.nets.{}.vim_net".format(net_index)
1726                 ] = None
1727                 vnfr_update["k8s-cluster.nets.{}.vim_net".format(net_index)] = vim_net
1728                 if vim_net and (
1729                     kdur_net.get("vnf-vld-id") or kdur_net.get("ns-vld-id")
1730                 ):
1731                     ifaces_forcing_vim_network.append(
1732                         {
1733                             "name": kdur_net.get("vnf-vld-id")
1734                             or kdur_net.get("ns-vld-id"),
1735                             "vnf-vld-id": kdur_net.get("vnf-vld-id"),
1736                             "ns-vld-id": kdur_net.get("ns-vld-id"),
1737                             "vim-network-name": vim_net,  # TODO can it be vim-network-id ???
1738                         }
1739                     )
1740             # TODO check that this forcing is not incompatible with other forcing
1741         return ifaces_forcing_vim_network
1742
1743     def _update_vnfrs_from_nsd(self, nsr):
1744         try:
1745             nsr_id = nsr["_id"]
1746             nsd = nsr["nsd"]
1747
1748             step = "Getting vnf_profiles from nsd"
1749             vnf_profiles = nsd.get("df", [{}])[0].get("vnf-profile", ())
1750             vld_fixed_ip_connection_point_data = {}
1751
1752             step = "Getting ip-address info from vnf_profile if it exists"
1753             for vnfp in vnf_profiles:
1754                 # Checking ip-address info from nsd.vnf_profile and storing
1755                 for vlc in vnfp.get("virtual-link-connectivity", ()):
1756                     for cpd in vlc.get("constituent-cpd-id", ()):
1757                         if cpd.get("ip-address"):
1758                             step = "Storing ip-address info"
1759                             vld_fixed_ip_connection_point_data.update({vlc.get("virtual-link-profile-id") + '.' + cpd.get("constituent-base-element-id"): {
1760                                 "vnfd-connection-point-ref": cpd.get(
1761                                     "constituent-cpd-id"),
1762                                     "ip-address": cpd.get(
1763                                     "ip-address")}})
1764
1765             # Inserting ip address to vnfr
1766             if len(vld_fixed_ip_connection_point_data) > 0:
1767                 step = "Getting vnfrs"
1768                 vnfrs = self.db.get_list("vnfrs", {"nsr-id-ref": nsr_id})
1769                 for item in vld_fixed_ip_connection_point_data.keys():
1770                     step = "Filtering vnfrs"
1771                     vnfr = next(filter(lambda vnfr: vnfr["member-vnf-index-ref"] == item.split('.')[1], vnfrs), None)
1772                     if vnfr:
1773                         vnfr_update = {}
1774                         for vdur_index, vdur in enumerate(vnfr["vdur"]):
1775                             for iface_index, iface in enumerate(vdur["interfaces"]):
1776                                 step = "Looking for matched interface"
1777                                 if (
1778                                         iface.get("external-connection-point-ref")
1779                                         == vld_fixed_ip_connection_point_data[item].get("vnfd-connection-point-ref") and
1780                                         iface.get("ns-vld-id") == item.split('.')[0]
1781
1782                                 ):
1783                                     vnfr_update_text = "vdur.{}.interfaces.{}".format(
1784                                         vdur_index, iface_index
1785                                     )
1786                                     step = "Storing info in order to update vnfr"
1787                                     vnfr_update[
1788                                         vnfr_update_text + ".ip-address"
1789                                         ] = increment_ip_mac(
1790                                         vld_fixed_ip_connection_point_data[item].get("ip-address"),
1791                                         vdur.get("count-index", 0), )
1792                                     vnfr_update[vnfr_update_text + ".fixed-ip"] = True
1793
1794                         step = "updating vnfr at database"
1795                         self.db.set_one("vnfrs", {"_id": vnfr["_id"]}, vnfr_update)
1796         except (
1797                 ValidationError,
1798                 EngineException,
1799                 DbException,
1800                 MsgException,
1801                 FsException,
1802         ) as e:
1803             raise type(e)("{} while '{}'".format(e, step), http_code=e.http_code)
1804
1805     def _update_vnfrs(self, session, rollback, nsr, indata):
1806         # get vnfr
1807         nsr_id = nsr["_id"]
1808         vnfrs = self.db.get_list("vnfrs", {"nsr-id-ref": nsr_id})
1809
1810         for vnfr in vnfrs:
1811             vnfr_update = {}
1812             vnfr_update_rollback = {}
1813             member_vnf_index = vnfr["member-vnf-index-ref"]
1814             # update vim-account-id
1815
1816             vim_account = indata["vimAccountId"]
1817             vca_id = self._get_vim_account(vim_account, session).get("vca")
1818             # check instantiate parameters
1819             for vnf_inst_params in get_iterable(indata.get("vnf")):
1820                 if vnf_inst_params["member-vnf-index"] != member_vnf_index:
1821                     continue
1822                 if vnf_inst_params.get("vimAccountId"):
1823                     vim_account = vnf_inst_params.get("vimAccountId")
1824                     vca_id = self._get_vim_account(vim_account, session).get("vca")
1825
1826                 # get vnf.vdu.interface instantiation params to update vnfr.vdur.interfaces ip, mac
1827                 for vdu_inst_param in get_iterable(vnf_inst_params.get("vdu")):
1828                     for vdur_index, vdur in enumerate(vnfr["vdur"]):
1829                         if vdu_inst_param["id"] != vdur["vdu-id-ref"]:
1830                             continue
1831                         for iface_inst_param in get_iterable(
1832                             vdu_inst_param.get("interface")
1833                         ):
1834                             iface_index, _ = next(
1835                                 i
1836                                 for i in enumerate(vdur["interfaces"])
1837                                 if i[1]["name"] == iface_inst_param["name"]
1838                             )
1839                             vnfr_update_text = "vdur.{}.interfaces.{}".format(
1840                                 vdur_index, iface_index
1841                             )
1842                             if iface_inst_param.get("ip-address"):
1843                                 vnfr_update[
1844                                     vnfr_update_text + ".ip-address"
1845                                 ] = increment_ip_mac(
1846                                     iface_inst_param.get("ip-address"),
1847                                     vdur.get("count-index", 0),
1848                                 )
1849                                 vnfr_update[vnfr_update_text + ".fixed-ip"] = True
1850                             if iface_inst_param.get("mac-address"):
1851                                 vnfr_update[
1852                                     vnfr_update_text + ".mac-address"
1853                                 ] = increment_ip_mac(
1854                                     iface_inst_param.get("mac-address"),
1855                                     vdur.get("count-index", 0),
1856                                 )
1857                                 vnfr_update[vnfr_update_text + ".fixed-mac"] = True
1858                             if iface_inst_param.get("floating-ip-required"):
1859                                 vnfr_update[
1860                                     vnfr_update_text + ".floating-ip-required"
1861                                 ] = True
1862                 # get vnf.internal-vld.internal-conection-point instantiation params to update vnfr.vdur.interfaces
1863                 # TODO update vld with the ip-profile
1864                 for ivld_inst_param in get_iterable(
1865                     vnf_inst_params.get("internal-vld")
1866                 ):
1867                     for icp_inst_param in get_iterable(
1868                         ivld_inst_param.get("internal-connection-point")
1869                     ):
1870                         # look for iface
1871                         for vdur_index, vdur in enumerate(vnfr["vdur"]):
1872                             for iface_index, iface in enumerate(vdur["interfaces"]):
1873                                 if (
1874                                     iface.get("internal-connection-point-ref")
1875                                     == icp_inst_param["id-ref"]
1876                                 ):
1877                                     vnfr_update_text = "vdur.{}.interfaces.{}".format(
1878                                         vdur_index, iface_index
1879                                     )
1880                                     if icp_inst_param.get("ip-address"):
1881                                         vnfr_update[
1882                                             vnfr_update_text + ".ip-address"
1883                                         ] = increment_ip_mac(
1884                                             icp_inst_param.get("ip-address"),
1885                                             vdur.get("count-index", 0),
1886                                         )
1887                                         vnfr_update[
1888                                             vnfr_update_text + ".fixed-ip"
1889                                         ] = True
1890                                     if icp_inst_param.get("mac-address"):
1891                                         vnfr_update[
1892                                             vnfr_update_text + ".mac-address"
1893                                         ] = increment_ip_mac(
1894                                             icp_inst_param.get("mac-address"),
1895                                             vdur.get("count-index", 0),
1896                                         )
1897                                         vnfr_update[
1898                                             vnfr_update_text + ".fixed-mac"
1899                                         ] = True
1900                                     break
1901             # get ip address from instantiation parameters.vld.vnfd-connection-point-ref
1902             for vld_inst_param in get_iterable(indata.get("vld")):
1903                 for vnfcp_inst_param in get_iterable(
1904                     vld_inst_param.get("vnfd-connection-point-ref")
1905                 ):
1906                     if vnfcp_inst_param["member-vnf-index-ref"] != member_vnf_index:
1907                         continue
1908                     # look for iface
1909                     for vdur_index, vdur in enumerate(vnfr["vdur"]):
1910                         for iface_index, iface in enumerate(vdur["interfaces"]):
1911                             if (
1912                                 iface.get("external-connection-point-ref")
1913                                 == vnfcp_inst_param["vnfd-connection-point-ref"]
1914                             ):
1915                                 vnfr_update_text = "vdur.{}.interfaces.{}".format(
1916                                     vdur_index, iface_index
1917                                 )
1918                                 if vnfcp_inst_param.get("ip-address"):
1919                                     vnfr_update[
1920                                         vnfr_update_text + ".ip-address"
1921                                     ] = increment_ip_mac(
1922                                         vnfcp_inst_param.get("ip-address"),
1923                                         vdur.get("count-index", 0),
1924                                     )
1925                                     vnfr_update[vnfr_update_text + ".fixed-ip"] = True
1926                                 if vnfcp_inst_param.get("mac-address"):
1927                                     vnfr_update[
1928                                         vnfr_update_text + ".mac-address"
1929                                     ] = increment_ip_mac(
1930                                         vnfcp_inst_param.get("mac-address"),
1931                                         vdur.get("count-index", 0),
1932                                     )
1933                                     vnfr_update[vnfr_update_text + ".fixed-mac"] = True
1934                                 break
1935
1936             vnfr_update["vim-account-id"] = vim_account
1937             vnfr_update_rollback["vim-account-id"] = vnfr.get("vim-account-id")
1938
1939             if vca_id:
1940                 vnfr_update["vca-id"] = vca_id
1941                 vnfr_update_rollback["vca-id"] = vnfr.get("vca-id")
1942
1943             # get pdu
1944             ifaces_forcing_vim_network = self._look_for_pdu(
1945                 session, rollback, vnfr, vim_account, vnfr_update, vnfr_update_rollback
1946             )
1947
1948             # get kdus
1949             ifaces_forcing_vim_network += self._look_for_k8scluster(
1950                 session, rollback, vnfr, vim_account, vnfr_update, vnfr_update_rollback
1951             )
1952             # update database vnfr
1953             self.db.set_one("vnfrs", {"_id": vnfr["_id"]}, vnfr_update)
1954             rollback.append(
1955                 {
1956                     "topic": "vnfrs",
1957                     "_id": vnfr["_id"],
1958                     "operation": "set",
1959                     "content": vnfr_update_rollback,
1960                 }
1961             )
1962
1963             # Update indada in case pdu forces to use a concrete vim-network-name
1964             # TODO check if user has already insert a vim-network-name and raises an error
1965             if not ifaces_forcing_vim_network:
1966                 continue
1967             for iface_info in ifaces_forcing_vim_network:
1968                 if iface_info.get("ns-vld-id"):
1969                     if "vld" not in indata:
1970                         indata["vld"] = []
1971                     indata["vld"].append(
1972                         {
1973                             key: iface_info[key]
1974                             for key in ("name", "vim-network-name", "vim-network-id")
1975                             if iface_info.get(key)
1976                         }
1977                     )
1978
1979                 elif iface_info.get("vnf-vld-id"):
1980                     if "vnf" not in indata:
1981                         indata["vnf"] = []
1982                     indata["vnf"].append(
1983                         {
1984                             "member-vnf-index": member_vnf_index,
1985                             "internal-vld": [
1986                                 {
1987                                     key: iface_info[key]
1988                                     for key in (
1989                                         "name",
1990                                         "vim-network-name",
1991                                         "vim-network-id",
1992                                     )
1993                                     if iface_info.get(key)
1994                                 }
1995                             ],
1996                         }
1997                     )
1998
1999     @staticmethod
2000     def _create_nslcmop(nsr_id, operation, params):
2001         """
2002         Creates a ns-lcm-opp content to be stored at database.
2003         :param nsr_id: internal id of the instance
2004         :param operation: instantiate, terminate, scale, action, ...
2005         :param params: user parameters for the operation
2006         :return: dictionary following SOL005 format
2007         """
2008         now = time()
2009         _id = str(uuid4())
2010         nslcmop = {
2011             "id": _id,
2012             "_id": _id,
2013             "operationState": "PROCESSING",  # COMPLETED,PARTIALLY_COMPLETED,FAILED_TEMP,FAILED,ROLLING_BACK,ROLLED_BACK
2014             "queuePosition": None,
2015             "stage": None,
2016             "errorMessage": None,
2017             "detailedStatus": None,
2018             "statusEnteredTime": now,
2019             "nsInstanceId": nsr_id,
2020             "lcmOperationType": operation,
2021             "startTime": now,
2022             "isAutomaticInvocation": False,
2023             "operationParams": params,
2024             "isCancelPending": False,
2025             "links": {
2026                 "self": "/osm/nslcm/v1/ns_lcm_op_occs/" + _id,
2027                 "nsInstance": "/osm/nslcm/v1/ns_instances/" + nsr_id,
2028             },
2029         }
2030         return nslcmop
2031
2032     def _get_enabled_vims(self, session):
2033         """
2034         Retrieve and return VIM accounts that are accessible by current user and has state ENABLE
2035         :param session: current session with user information
2036         """
2037         db_filter = self._get_project_filter(session)
2038         db_filter["_admin.operationalState"] = "ENABLED"
2039         vims = self.db.get_list("vim_accounts", db_filter)
2040         vimAccounts = []
2041         for vim in vims:
2042             vimAccounts.append(vim["_id"])
2043         return vimAccounts
2044
2045     def new(
2046         self,
2047         rollback,
2048         session,
2049         indata=None,
2050         kwargs=None,
2051         headers=None,
2052         slice_object=False,
2053     ):
2054         """
2055         Performs a new operation over a ns
2056         :param rollback: list to append created items at database in case a rollback must to be done
2057         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
2058         :param indata: descriptor with the parameters of the operation. It must contains among others
2059             nsInstanceId: _id of the nsr to perform the operation
2060             operation: it can be: instantiate, terminate, action, TODO: update, heal
2061         :param kwargs: used to override the indata descriptor
2062         :param headers: http request headers
2063         :return: id of the nslcmops
2064         """
2065
2066         def check_if_nsr_is_not_slice_member(session, nsr_id):
2067             nsis = None
2068             db_filter = self._get_project_filter(session)
2069             db_filter["_admin.nsrs-detailed-list.ANYINDEX.nsrId"] = nsr_id
2070             nsis = self.db.get_one(
2071                 "nsis", db_filter, fail_on_empty=False, fail_on_more=False
2072             )
2073             if nsis:
2074                 raise EngineException(
2075                     "The NS instance {} cannot be terminated because is used by the slice {}".format(
2076                         nsr_id, nsis["_id"]
2077                     ),
2078                     http_code=HTTPStatus.CONFLICT,
2079                 )
2080
2081         try:
2082             # Override descriptor with query string kwargs
2083             self._update_input_with_kwargs(indata, kwargs, yaml_format=True)
2084             operation = indata["lcmOperationType"]
2085             nsInstanceId = indata["nsInstanceId"]
2086
2087             validate_input(indata, self.operation_schema[operation])
2088             # get ns from nsr_id
2089             _filter = BaseTopic._get_project_filter(session)
2090             _filter["_id"] = nsInstanceId
2091             nsr = self.db.get_one("nsrs", _filter)
2092
2093             # initial checking
2094             if operation == "terminate" and slice_object is False:
2095                 check_if_nsr_is_not_slice_member(session, nsr["_id"])
2096             if (
2097                 not nsr["_admin"].get("nsState")
2098                 or nsr["_admin"]["nsState"] == "NOT_INSTANTIATED"
2099             ):
2100                 if operation == "terminate" and indata.get("autoremove"):
2101                     # NSR must be deleted
2102                     return (
2103                         None,
2104                         None,
2105                     )  # a none in this case is used to indicate not instantiated. It can be removed
2106                 if operation != "instantiate":
2107                     raise EngineException(
2108                         "ns_instance '{}' cannot be '{}' because it is not instantiated".format(
2109                             nsInstanceId, operation
2110                         ),
2111                         HTTPStatus.CONFLICT,
2112                     )
2113             else:
2114                 if operation == "instantiate" and not session["force"]:
2115                     raise EngineException(
2116                         "ns_instance '{}' cannot be '{}' because it is already instantiated".format(
2117                             nsInstanceId, operation
2118                         ),
2119                         HTTPStatus.CONFLICT,
2120                     )
2121             self._check_ns_operation(session, nsr, operation, indata)
2122             if (indata.get("primitive_params")):
2123                 indata["primitive_params"] = json.dumps(indata["primitive_params"])
2124             elif (indata.get("additionalParamsForVnf")):
2125                 indata["additionalParamsForVnf"] = json.dumps(indata["additionalParamsForVnf"])
2126
2127             if operation == "instantiate":
2128                 self._update_vnfrs_from_nsd(nsr)
2129                 self._update_vnfrs(session, rollback, nsr, indata)
2130
2131             nslcmop_desc = self._create_nslcmop(nsInstanceId, operation, indata)
2132             _id = nslcmop_desc["_id"]
2133             self.format_on_new(
2134                 nslcmop_desc, session["project_id"], make_public=session["public"]
2135             )
2136             if indata.get("placement-engine"):
2137                 # Save valid vim accounts in lcm operation descriptor
2138                 nslcmop_desc["operationParams"][
2139                     "validVimAccounts"
2140                 ] = self._get_enabled_vims(session)
2141             self.db.create("nslcmops", nslcmop_desc)
2142             rollback.append({"topic": "nslcmops", "_id": _id})
2143             if not slice_object:
2144                 self.msg.write("ns", operation, nslcmop_desc)
2145             return _id, None
2146         except ValidationError as e:  # TODO remove try Except, it is captured at nbi.py
2147             raise EngineException(e, HTTPStatus.UNPROCESSABLE_ENTITY)
2148         # except DbException as e:
2149         #     raise EngineException("Cannot get ns_instance '{}': {}".format(e), HTTPStatus.NOT_FOUND)
2150
2151     def delete(self, session, _id, dry_run=False, not_send_msg=None):
2152         raise EngineException(
2153             "Method delete called directly", HTTPStatus.INTERNAL_SERVER_ERROR
2154         )
2155
2156     def edit(self, session, _id, indata=None, kwargs=None, content=None):
2157         raise EngineException(
2158             "Method edit called directly", HTTPStatus.INTERNAL_SERVER_ERROR
2159         )
2160
2161
2162 class NsiTopic(BaseTopic):
2163     topic = "nsis"
2164     topic_msg = "nsi"
2165     quota_name = "slice_instances"
2166
2167     def __init__(self, db, fs, msg, auth):
2168         BaseTopic.__init__(self, db, fs, msg, auth)
2169         self.nsrTopic = NsrTopic(db, fs, msg, auth)
2170
2171     @staticmethod
2172     def _format_ns_request(ns_request):
2173         formated_request = copy(ns_request)
2174         # TODO: Add request params
2175         return formated_request
2176
2177     @staticmethod
2178     def _format_addional_params(slice_request):
2179         """
2180         Get and format user additional params for NS or VNF
2181         :param slice_request: User instantiation additional parameters
2182         :return: a formatted copy of additional params or None if not supplied
2183         """
2184         additional_params = copy(slice_request.get("additionalParamsForNsi"))
2185         if additional_params:
2186             for k, v in additional_params.items():
2187                 if not isinstance(k, str):
2188                     raise EngineException(
2189                         "Invalid param at additionalParamsForNsi:{}. Only string keys are allowed".format(
2190                             k
2191                         )
2192                     )
2193                 if "." in k or "$" in k:
2194                     raise EngineException(
2195                         "Invalid param at additionalParamsForNsi:{}. Keys must not contain dots or $".format(
2196                             k
2197                         )
2198                     )
2199                 if isinstance(v, (dict, tuple, list)):
2200                     additional_params[k] = "!!yaml " + safe_dump(v)
2201         return additional_params
2202
2203     def _check_descriptor_dependencies(self, session, descriptor):
2204         """
2205         Check that the dependent descriptors exist on a new descriptor or edition
2206         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
2207         :param descriptor: descriptor to be inserted or edit
2208         :return: None or raises exception
2209         """
2210         if not descriptor.get("nst-ref"):
2211             return
2212         nstd_id = descriptor["nst-ref"]
2213         if not self.get_item_list(session, "nsts", {"id": nstd_id}):
2214             raise EngineException(
2215                 "Descriptor error at nst-ref='{}' references a non exist nstd".format(
2216                     nstd_id
2217                 ),
2218                 http_code=HTTPStatus.CONFLICT,
2219             )
2220
2221     def check_conflict_on_del(self, session, _id, db_content):
2222         """
2223         Check that NSI is not instantiated
2224         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
2225         :param _id: nsi internal id
2226         :param db_content: The database content of the _id
2227         :return: None or raises EngineException with the conflict
2228         """
2229         if session["force"]:
2230             return
2231         nsi = db_content
2232         if nsi["_admin"].get("nsiState") == "INSTANTIATED":
2233             raise EngineException(
2234                 "nsi '{}' cannot be deleted because it is in 'INSTANTIATED' state. "
2235                 "Launch 'terminate' operation first; or force deletion".format(_id),
2236                 http_code=HTTPStatus.CONFLICT,
2237             )
2238
2239     def delete_extra(self, session, _id, db_content, not_send_msg=None):
2240         """
2241         Deletes associated nsilcmops from database. Deletes associated filesystem.
2242          Set usageState of nst
2243         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
2244         :param _id: server internal id
2245         :param db_content: The database content of the descriptor
2246         :param not_send_msg: To not send message (False) or store content (list) instead
2247         :return: None if ok or raises EngineException with the problem
2248         """
2249
2250         # Deleting the nsrs belonging to nsir
2251         nsir = db_content
2252         for nsrs_detailed_item in nsir["_admin"]["nsrs-detailed-list"]:
2253             nsr_id = nsrs_detailed_item["nsrId"]
2254             if nsrs_detailed_item.get("shared"):
2255                 _filter = {
2256                     "_admin.nsrs-detailed-list.ANYINDEX.shared": True,
2257                     "_admin.nsrs-detailed-list.ANYINDEX.nsrId": nsr_id,
2258                     "_id.ne": nsir["_id"],
2259                 }
2260                 nsi = self.db.get_one(
2261                     "nsis", _filter, fail_on_empty=False, fail_on_more=False
2262                 )
2263                 if nsi:  # last one using nsr
2264                     continue
2265             try:
2266                 self.nsrTopic.delete(
2267                     session, nsr_id, dry_run=False, not_send_msg=not_send_msg
2268                 )
2269             except (DbException, EngineException) as e:
2270                 if e.http_code == HTTPStatus.NOT_FOUND:
2271                     pass
2272                 else:
2273                     raise
2274
2275         # delete related nsilcmops database entries
2276         self.db.del_list("nsilcmops", {"netsliceInstanceId": _id})
2277
2278         # Check and set used NST usage state
2279         nsir_admin = nsir.get("_admin")
2280         if nsir_admin and nsir_admin.get("nst-id"):
2281             # check if used by another NSI
2282             nsis_list = self.db.get_one(
2283                 "nsis",
2284                 {"nst-id": nsir_admin["nst-id"]},
2285                 fail_on_empty=False,
2286                 fail_on_more=False,
2287             )
2288             if not nsis_list:
2289                 self.db.set_one(
2290                     "nsts",
2291                     {"_id": nsir_admin["nst-id"]},
2292                     {"_admin.usageState": "NOT_IN_USE"},
2293                 )
2294
2295     def new(self, rollback, session, indata=None, kwargs=None, headers=None):
2296         """
2297         Creates a new netslice instance record into database. It also creates needed nsrs and vnfrs
2298         :param rollback: list to append the created items at database in case a rollback must be done
2299         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
2300         :param indata: params to be used for the nsir
2301         :param kwargs: used to override the indata descriptor
2302         :param headers: http request headers
2303         :return: the _id of nsi descriptor created at database
2304         """
2305
2306         try:
2307             step = "checking quotas"
2308             self.check_quota(session)
2309
2310             step = ""
2311             slice_request = self._remove_envelop(indata)
2312             # Override descriptor with query string kwargs
2313             self._update_input_with_kwargs(slice_request, kwargs)
2314             slice_request = self._validate_input_new(slice_request, session["force"])
2315
2316             # look for nstd
2317             step = "getting nstd id='{}' from database".format(
2318                 slice_request.get("nstId")
2319             )
2320             _filter = self._get_project_filter(session)
2321             _filter["_id"] = slice_request["nstId"]
2322             nstd = self.db.get_one("nsts", _filter)
2323             # check NST is not disabled
2324             step = "checking NST operationalState"
2325             if nstd["_admin"]["operationalState"] == "DISABLED":
2326                 raise EngineException(
2327                     "nst with id '{}' is DISABLED, and thus cannot be used to create a netslice "
2328                     "instance".format(slice_request["nstId"]),
2329                     http_code=HTTPStatus.CONFLICT,
2330                 )
2331             del _filter["_id"]
2332
2333             # check NSD is not disabled
2334             step = "checking operationalState"
2335             if nstd["_admin"]["operationalState"] == "DISABLED":
2336                 raise EngineException(
2337                     "nst with id '{}' is DISABLED, and thus cannot be used to create "
2338                     "a network slice".format(slice_request["nstId"]),
2339                     http_code=HTTPStatus.CONFLICT,
2340                 )
2341
2342             nstd.pop("_admin", None)
2343             nstd_id = nstd.pop("_id", None)
2344             nsi_id = str(uuid4())
2345             step = "filling nsi_descriptor with input data"
2346
2347             # Creating the NSIR
2348             nsi_descriptor = {
2349                 "id": nsi_id,
2350                 "name": slice_request["nsiName"],
2351                 "description": slice_request.get("nsiDescription", ""),
2352                 "datacenter": slice_request["vimAccountId"],
2353                 "nst-ref": nstd["id"],
2354                 "instantiation_parameters": slice_request,
2355                 "network-slice-template": nstd,
2356                 "nsr-ref-list": [],
2357                 "vlr-list": [],
2358                 "_id": nsi_id,
2359                 "additionalParamsForNsi": self._format_addional_params(slice_request),
2360             }
2361
2362             step = "creating nsi at database"
2363             self.format_on_new(
2364                 nsi_descriptor, session["project_id"], make_public=session["public"]
2365             )
2366             nsi_descriptor["_admin"]["nsiState"] = "NOT_INSTANTIATED"
2367             nsi_descriptor["_admin"]["netslice-subnet"] = None
2368             nsi_descriptor["_admin"]["deployed"] = {}
2369             nsi_descriptor["_admin"]["deployed"]["RO"] = []
2370             nsi_descriptor["_admin"]["nst-id"] = nstd_id
2371
2372             # Creating netslice-vld for the RO.
2373             step = "creating netslice-vld at database"
2374
2375             # Building the vlds list to be deployed
2376             # From netslice descriptors, creating the initial list
2377             nsi_vlds = []
2378
2379             for netslice_vlds in get_iterable(nstd.get("netslice-vld")):
2380                 # Getting template Instantiation parameters from NST
2381                 nsi_vld = deepcopy(netslice_vlds)
2382                 nsi_vld["shared-nsrs-list"] = []
2383                 nsi_vld["vimAccountId"] = slice_request["vimAccountId"]
2384                 nsi_vlds.append(nsi_vld)
2385
2386             nsi_descriptor["_admin"]["netslice-vld"] = nsi_vlds
2387             # Creating netslice-subnet_record.
2388             needed_nsds = {}
2389             services = []
2390
2391             # Updating the nstd with the nsd["_id"] associated to the nss -> services list
2392             for member_ns in nstd["netslice-subnet"]:
2393                 nsd_id = member_ns["nsd-ref"]
2394                 step = "getting nstd id='{}' constituent-nsd='{}' from database".format(
2395                     member_ns["nsd-ref"], member_ns["id"]
2396                 )
2397                 if nsd_id not in needed_nsds:
2398                     # Obtain nsd
2399                     _filter["id"] = nsd_id
2400                     nsd = self.db.get_one(
2401                         "nsds", _filter, fail_on_empty=True, fail_on_more=True
2402                     )
2403                     del _filter["id"]
2404                     nsd.pop("_admin")
2405                     needed_nsds[nsd_id] = nsd
2406                 else:
2407                     nsd = needed_nsds[nsd_id]
2408                 member_ns["_id"] = needed_nsds[nsd_id].get("_id")
2409                 services.append(member_ns)
2410
2411                 step = "filling nsir nsd-id='{}' constituent-nsd='{}' from database".format(
2412                     member_ns["nsd-ref"], member_ns["id"]
2413                 )
2414
2415             # creates Network Services records (NSRs)
2416             step = "creating nsrs at database using NsrTopic.new()"
2417             ns_params = slice_request.get("netslice-subnet")
2418             nsrs_list = []
2419             nsi_netslice_subnet = []
2420             for service in services:
2421                 # Check if the netslice-subnet is shared and if it is share if the nss exists
2422                 _id_nsr = None
2423                 indata_ns = {}
2424                 # Is the nss shared and instantiated?
2425                 _filter["_admin.nsrs-detailed-list.ANYINDEX.shared"] = True
2426                 _filter["_admin.nsrs-detailed-list.ANYINDEX.nsd-id"] = service[
2427                     "nsd-ref"
2428                 ]
2429                 _filter["_admin.nsrs-detailed-list.ANYINDEX.nss-id"] = service["id"]
2430                 nsi = self.db.get_one(
2431                     "nsis", _filter, fail_on_empty=False, fail_on_more=False
2432                 )
2433                 if nsi and service.get("is-shared-nss"):
2434                     nsrs_detailed_list = nsi["_admin"]["nsrs-detailed-list"]
2435                     for nsrs_detailed_item in nsrs_detailed_list:
2436                         if nsrs_detailed_item["nsd-id"] == service["nsd-ref"]:
2437                             if nsrs_detailed_item["nss-id"] == service["id"]:
2438                                 _id_nsr = nsrs_detailed_item["nsrId"]
2439                                 break
2440                     for netslice_subnet in nsi["_admin"]["netslice-subnet"]:
2441                         if netslice_subnet["nss-id"] == service["id"]:
2442                             indata_ns = netslice_subnet
2443                             break
2444                 else:
2445                     indata_ns = {}
2446                     if service.get("instantiation-parameters"):
2447                         indata_ns = deepcopy(service["instantiation-parameters"])
2448                         # del service["instantiation-parameters"]
2449
2450                     indata_ns["nsdId"] = service["_id"]
2451                     indata_ns["nsName"] = (
2452                         slice_request.get("nsiName") + "." + service["id"]
2453                     )
2454                     indata_ns["vimAccountId"] = slice_request.get("vimAccountId")
2455                     indata_ns["nsDescription"] = service["description"]
2456                     if slice_request.get("ssh_keys"):
2457                         indata_ns["ssh_keys"] = slice_request.get("ssh_keys")
2458
2459                     if ns_params:
2460                         for ns_param in ns_params:
2461                             if ns_param.get("id") == service["id"]:
2462                                 copy_ns_param = deepcopy(ns_param)
2463                                 del copy_ns_param["id"]
2464                                 indata_ns.update(copy_ns_param)
2465                                 break
2466
2467                     # Creates Nsr objects
2468                     _id_nsr, _ = self.nsrTopic.new(
2469                         rollback, session, indata_ns, kwargs, headers
2470                     )
2471                 nsrs_item = {
2472                     "nsrId": _id_nsr,
2473                     "shared": service.get("is-shared-nss"),
2474                     "nsd-id": service["nsd-ref"],
2475                     "nss-id": service["id"],
2476                     "nslcmop_instantiate": None,
2477                 }
2478                 indata_ns["nss-id"] = service["id"]
2479                 nsrs_list.append(nsrs_item)
2480                 nsi_netslice_subnet.append(indata_ns)
2481                 nsr_ref = {"nsr-ref": _id_nsr}
2482                 nsi_descriptor["nsr-ref-list"].append(nsr_ref)
2483
2484             # Adding the nsrs list to the nsi
2485             nsi_descriptor["_admin"]["nsrs-detailed-list"] = nsrs_list
2486             nsi_descriptor["_admin"]["netslice-subnet"] = nsi_netslice_subnet
2487             self.db.set_one(
2488                 "nsts", {"_id": slice_request["nstId"]}, {"_admin.usageState": "IN_USE"}
2489             )
2490
2491             # Creating the entry in the database
2492             self.db.create("nsis", nsi_descriptor)
2493             rollback.append({"topic": "nsis", "_id": nsi_id})
2494             return nsi_id, None
2495         except Exception as e:  # TODO remove try Except, it is captured at nbi.py
2496             self.logger.exception(
2497                 "Exception {} at NsiTopic.new()".format(e), exc_info=True
2498             )
2499             raise EngineException("Error {}: {}".format(step, e))
2500         except ValidationError as e:
2501             raise EngineException(e, HTTPStatus.UNPROCESSABLE_ENTITY)
2502
2503     def edit(self, session, _id, indata=None, kwargs=None, content=None):
2504         raise EngineException(
2505             "Method edit called directly", HTTPStatus.INTERNAL_SERVER_ERROR
2506         )
2507
2508
2509 class NsiLcmOpTopic(BaseTopic):
2510     topic = "nsilcmops"
2511     topic_msg = "nsi"
2512     operation_schema = {  # mapping between operation and jsonschema to validate
2513         "instantiate": nsi_instantiate,
2514         "terminate": None,
2515     }
2516
2517     def __init__(self, db, fs, msg, auth):
2518         BaseTopic.__init__(self, db, fs, msg, auth)
2519         self.nsi_NsLcmOpTopic = NsLcmOpTopic(self.db, self.fs, self.msg, self.auth)
2520
2521     def _check_nsi_operation(self, session, nsir, operation, indata):
2522         """
2523         Check that user has enter right parameters for the operation
2524         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
2525         :param operation: it can be: instantiate, terminate, action, TODO: update, heal
2526         :param indata: descriptor with the parameters of the operation
2527         :return: None
2528         """
2529         nsds = {}
2530         nstd = nsir["network-slice-template"]
2531
2532         def check_valid_netslice_subnet_id(nstId):
2533             # TODO change to vnfR (??)
2534             for netslice_subnet in nstd["netslice-subnet"]:
2535                 if nstId == netslice_subnet["id"]:
2536                     nsd_id = netslice_subnet["nsd-ref"]
2537                     if nsd_id not in nsds:
2538                         _filter = self._get_project_filter(session)
2539                         _filter["id"] = nsd_id
2540                         nsds[nsd_id] = self.db.get_one("nsds", _filter)
2541                     return nsds[nsd_id]
2542             else:
2543                 raise EngineException(
2544                     "Invalid parameter nstId='{}' is not one of the "
2545                     "nst:netslice-subnet".format(nstId)
2546                 )
2547
2548         if operation == "instantiate":
2549             # check the existance of netslice-subnet items
2550             for in_nst in get_iterable(indata.get("netslice-subnet")):
2551                 check_valid_netslice_subnet_id(in_nst["id"])
2552
2553     def _create_nsilcmop(self, session, netsliceInstanceId, operation, params):
2554         now = time()
2555         _id = str(uuid4())
2556         nsilcmop = {
2557             "id": _id,
2558             "_id": _id,
2559             "operationState": "PROCESSING",  # COMPLETED,PARTIALLY_COMPLETED,FAILED_TEMP,FAILED,ROLLING_BACK,ROLLED_BACK
2560             "statusEnteredTime": now,
2561             "netsliceInstanceId": netsliceInstanceId,
2562             "lcmOperationType": operation,
2563             "startTime": now,
2564             "isAutomaticInvocation": False,
2565             "operationParams": params,
2566             "isCancelPending": False,
2567             "links": {
2568                 "self": "/osm/nsilcm/v1/nsi_lcm_op_occs/" + _id,
2569                 "netsliceInstanceId": "/osm/nsilcm/v1/netslice_instances/"
2570                 + netsliceInstanceId,
2571             },
2572         }
2573         return nsilcmop
2574
2575     def add_shared_nsr_2vld(self, nsir, nsr_item):
2576         for nst_sb_item in nsir["network-slice-template"].get("netslice-subnet"):
2577             if nst_sb_item.get("is-shared-nss"):
2578                 for admin_subnet_item in nsir["_admin"].get("netslice-subnet"):
2579                     if admin_subnet_item["nss-id"] == nst_sb_item["id"]:
2580                         for admin_vld_item in nsir["_admin"].get("netslice-vld"):
2581                             for admin_vld_nss_cp_ref_item in admin_vld_item[
2582                                 "nss-connection-point-ref"
2583                             ]:
2584                                 if (
2585                                     admin_subnet_item["nss-id"]
2586                                     == admin_vld_nss_cp_ref_item["nss-ref"]
2587                                 ):
2588                                     if (
2589                                         not nsr_item["nsrId"]
2590                                         in admin_vld_item["shared-nsrs-list"]
2591                                     ):
2592                                         admin_vld_item["shared-nsrs-list"].append(
2593                                             nsr_item["nsrId"]
2594                                         )
2595                                     break
2596         # self.db.set_one("nsis", {"_id": nsir["_id"]}, nsir)
2597         self.db.set_one(
2598             "nsis",
2599             {"_id": nsir["_id"]},
2600             {"_admin.netslice-vld": nsir["_admin"].get("netslice-vld")},
2601         )
2602
2603     def new(self, rollback, session, indata=None, kwargs=None, headers=None):
2604         """
2605         Performs a new operation over a ns
2606         :param rollback: list to append created items at database in case a rollback must to be done
2607         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
2608         :param indata: descriptor with the parameters of the operation. It must contains among others
2609             netsliceInstanceId: _id of the nsir to perform the operation
2610             operation: it can be: instantiate, terminate, action, TODO: update, heal
2611         :param kwargs: used to override the indata descriptor
2612         :param headers: http request headers
2613         :return: id of the nslcmops
2614         """
2615         try:
2616             # Override descriptor with query string kwargs
2617             self._update_input_with_kwargs(indata, kwargs)
2618             operation = indata["lcmOperationType"]
2619             netsliceInstanceId = indata["netsliceInstanceId"]
2620             validate_input(indata, self.operation_schema[operation])
2621
2622             # get nsi from netsliceInstanceId
2623             _filter = self._get_project_filter(session)
2624             _filter["_id"] = netsliceInstanceId
2625             nsir = self.db.get_one("nsis", _filter)
2626             logging_prefix = "nsi={} {} ".format(netsliceInstanceId, operation)
2627             del _filter["_id"]
2628
2629             # initial checking
2630             if (
2631                 not nsir["_admin"].get("nsiState")
2632                 or nsir["_admin"]["nsiState"] == "NOT_INSTANTIATED"
2633             ):
2634                 if operation == "terminate" and indata.get("autoremove"):
2635                     # NSIR must be deleted
2636                     return (
2637                         None,
2638                         None,
2639                     )  # a none in this case is used to indicate not instantiated. It can be removed
2640                 if operation != "instantiate":
2641                     raise EngineException(
2642                         "netslice_instance '{}' cannot be '{}' because it is not instantiated".format(
2643                             netsliceInstanceId, operation
2644                         ),
2645                         HTTPStatus.CONFLICT,
2646                     )
2647             else:
2648                 if operation == "instantiate" and not session["force"]:
2649                     raise EngineException(
2650                         "netslice_instance '{}' cannot be '{}' because it is already instantiated".format(
2651                             netsliceInstanceId, operation
2652                         ),
2653                         HTTPStatus.CONFLICT,
2654                     )
2655
2656             # Creating all the NS_operation (nslcmop)
2657             # Get service list from db
2658             nsrs_list = nsir["_admin"]["nsrs-detailed-list"]
2659             nslcmops = []
2660             # nslcmops_item = None
2661             for index, nsr_item in enumerate(nsrs_list):
2662                 nsr_id = nsr_item["nsrId"]
2663                 if nsr_item.get("shared"):
2664                     _filter["_admin.nsrs-detailed-list.ANYINDEX.shared"] = True
2665                     _filter["_admin.nsrs-detailed-list.ANYINDEX.nsrId"] = nsr_id
2666                     _filter[
2667                         "_admin.nsrs-detailed-list.ANYINDEX.nslcmop_instantiate.ne"
2668                     ] = None
2669                     _filter["_id.ne"] = netsliceInstanceId
2670                     nsi = self.db.get_one(
2671                         "nsis", _filter, fail_on_empty=False, fail_on_more=False
2672                     )
2673                     if operation == "terminate":
2674                         _update = {
2675                             "_admin.nsrs-detailed-list.{}.nslcmop_instantiate".format(
2676                                 index
2677                             ): None
2678                         }
2679                         self.db.set_one("nsis", {"_id": nsir["_id"]}, _update)
2680                         if (
2681                             nsi
2682                         ):  # other nsi is using this nsr and it needs this nsr instantiated
2683                             continue  # do not create nsilcmop
2684                     else:  # instantiate
2685                         # looks the first nsi fulfilling the conditions but not being the current NSIR
2686                         if nsi:
2687                             nsi_nsr_item = next(
2688                                 n
2689                                 for n in nsi["_admin"]["nsrs-detailed-list"]
2690                                 if n["nsrId"] == nsr_id
2691                                 and n["shared"]
2692                                 and n["nslcmop_instantiate"]
2693                             )
2694                             self.add_shared_nsr_2vld(nsir, nsr_item)
2695                             nslcmops.append(nsi_nsr_item["nslcmop_instantiate"])
2696                             _update = {
2697                                 "_admin.nsrs-detailed-list.{}".format(
2698                                     index
2699                                 ): nsi_nsr_item
2700                             }
2701                             self.db.set_one("nsis", {"_id": nsir["_id"]}, _update)
2702                             # continue to not create nslcmop since nsrs is shared and nsrs was created
2703                             continue
2704                         else:
2705                             self.add_shared_nsr_2vld(nsir, nsr_item)
2706
2707                 # create operation
2708                 try:
2709                     indata_ns = {
2710                         "lcmOperationType": operation,
2711                         "nsInstanceId": nsr_id,
2712                         # Including netslice_id in the ns instantiate Operation
2713                         "netsliceInstanceId": netsliceInstanceId,
2714                     }
2715                     if operation == "instantiate":
2716                         service = self.db.get_one("nsrs", {"_id": nsr_id})
2717                         indata_ns.update(service["instantiate_params"])
2718
2719                     # Creating NS_LCM_OP with the flag slice_object=True to not trigger the service instantiation
2720                     # message via kafka bus
2721                     nslcmop, _ = self.nsi_NsLcmOpTopic.new(
2722                         rollback, session, indata_ns, None, headers, slice_object=True
2723                     )
2724                     nslcmops.append(nslcmop)
2725                     if operation == "instantiate":
2726                         _update = {
2727                             "_admin.nsrs-detailed-list.{}.nslcmop_instantiate".format(
2728                                 index
2729                             ): nslcmop
2730                         }
2731                         self.db.set_one("nsis", {"_id": nsir["_id"]}, _update)
2732                 except (DbException, EngineException) as e:
2733                     if e.http_code == HTTPStatus.NOT_FOUND:
2734                         self.logger.info(
2735                             logging_prefix
2736                             + "skipping NS={} because not found".format(nsr_id)
2737                         )
2738                         pass
2739                     else:
2740                         raise
2741
2742             # Creates nsilcmop
2743             indata["nslcmops_ids"] = nslcmops
2744             self._check_nsi_operation(session, nsir, operation, indata)
2745
2746             nsilcmop_desc = self._create_nsilcmop(
2747                 session, netsliceInstanceId, operation, indata
2748             )
2749             self.format_on_new(
2750                 nsilcmop_desc, session["project_id"], make_public=session["public"]
2751             )
2752             _id = self.db.create("nsilcmops", nsilcmop_desc)
2753             rollback.append({"topic": "nsilcmops", "_id": _id})
2754             self.msg.write("nsi", operation, nsilcmop_desc)
2755             return _id, None
2756         except ValidationError as e:
2757             raise EngineException(e, HTTPStatus.UNPROCESSABLE_ENTITY)
2758
2759     def delete(self, session, _id, dry_run=False, not_send_msg=None):
2760         raise EngineException(
2761             "Method delete called directly", HTTPStatus.INTERNAL_SERVER_ERROR
2762         )
2763
2764     def edit(self, session, _id, indata=None, kwargs=None, content=None):
2765         raise EngineException(
2766             "Method edit called directly", HTTPStatus.INTERNAL_SERVER_ERROR
2767         )