Code Coverage

Cobertura Coverage Report > osm_nbi >

instance_topics.py

Trend

Classes100%
 
Lines51%
   
Conditionals100%
 

File Coverage summary

NameClassesLinesConditionals
instance_topics.py
100%
1/1
51%
648/1279
100%
0/0

Coverage Breakdown by Class

NameLinesConditionals
instance_topics.py
51%
648/1279
N/A

Source

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