Added more instantitaion parameters and check input
[osm/NBI.git] / osm_nbi / engine.py
index 4d611cc..1ffa616 100644 (file)
@@ -17,7 +17,7 @@ from osm_common.fsbase import FsException
 from osm_common.msgbase import MsgException
 from http import HTTPStatus
 from time import time
-from copy import deepcopy
+from copy import deepcopy, copy
 from validation import validate_input, ValidationError
 
 __author__ = "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
@@ -41,7 +41,7 @@ def _deep_update(dict_to_change, dict_reference):
         if dict_reference[k] is None:   # None->Anything
             if k in dict_to_change:
                 del dict_to_change[k]
-        elif not isinstance(dict_reference[k], dict):  #  NotDict->Anything
+        elif not isinstance(dict_reference[k], dict):  # NotDict->Anything
             dict_to_change[k] = dict_reference[k]
         elif k not in dict_to_change:  # Dict->Empty
             dict_to_change[k] = deepcopy(dict_reference[k])
@@ -53,6 +53,17 @@ def _deep_update(dict_to_change, dict_reference):
             _deep_update(dict_to_change[k], dict_reference[k])
 
 
+def get_iterable(input):
+    """
+    Returns an iterable, in case input is None it just returns an empty tuple
+    :param input:
+    :return: iterable
+    """
+    if input is None:
+        return ()
+    return input
+
+
 class Engine(object):
 
     def __init__(self):
@@ -310,8 +321,14 @@ class Engine(object):
             if self.db.get_one(item, filter, fail_on_empty=False):
                 raise EngineException("{} with id '{}' already exists for this tenant".format(item[:-1], indata["id"]),
                                       HTTPStatus.CONFLICT)
+            # TODO validate with pyangbind. Load and dumps to convert data types
+            if item == "nsds":
+                # transform constituent-vnfd:member-vnf-index to string
+                if indata.get("constituent-vnfd"):
+                    for constituent_vnfd in indata["constituent-vnfd"]:
+                        if "member-vnf-index" in constituent_vnfd:
+                            constituent_vnfd["member-vnf-index"] = str(constituent_vnfd["member-vnf-index"])
 
-            # TODO validate with pyangbind
             if item == "nsds" and not force:
                 self._check_descriptor_dependencies(session, "nsds", indata)
         elif item == "userDefinedData":
@@ -321,7 +338,10 @@ class Engine(object):
         elif item == "nsrs":
             pass
         elif item == "vim_accounts" or item == "sdns":
-            if self.db.get_one(item, {"name": indata.get("name")}, fail_on_empty=False, fail_on_more=False):
+            filter = {"name": indata.get("name")}
+            if id:
+                filter["_id.neq"] = id
+            if self.db.get_one(item, filter, fail_on_empty=False, fail_on_more=False):
                 raise EngineException("name '{}' already exists for {}".format(indata["name"], item),
                                       HTTPStatus.CONFLICT)
 
@@ -333,20 +353,112 @@ class Engine(object):
         :param indata: descriptor with the parameters of the operation
         :return: None
         """
+        vnfds = {}
+        vim_accounts = []
+        nsd = nsr["nsd"]
+
+        def check_valid_vnf_member_index(member_vnf_index):
+            for vnf in nsd["constituent-vnfd"]:
+                if member_vnf_index == vnf["member-vnf-index"]:
+                    vnfd_id = vnf["vnfd-id-ref"]
+                    if vnfd_id not in vnfds:
+                        vnfds[vnfd_id] = self.db.get_one("vnfds", {"id": vnfd_id})
+                    return vnfds[vnfd_id]
+            else:
+                raise EngineException("Invalid parameter member_vnf_index='{}' is not one of the "
+                                      "nsd:constituent-vnfd".format(member_vnf_index))
+
+        def check_valid_vim_account(vim_account):
+            if vim_account in vim_accounts:
+                return
+            try:
+                self.db.get_one("vim_accounts", {"_id": vim_account})
+            except Exception:
+                raise EngineException("Invalid vimAccountId='{}' not present".format(vim_account))
+            vim_accounts.append(vim_account)
+
         if operation == "action":
+            # check vnf_member_index
             if indata.get("vnf_member_index"):
                 indata["member_vnf_index"] = indata.pop("vnf_member_index")    # for backward compatibility
-            for vnf in nsr["nsd"]["constituent-vnfd"]:
-                if indata["member_vnf_index"] == vnf["member-vnf-index"]:
-                    # TODO get vnfd, check primitives
+            if not indata.get("member_vnf_index"):
+                raise EngineException("Missing 'member_vnf_index' parameter")
+            vnfd = check_valid_vnf_member_index(indata["member_vnf_index"])
+            # check primitive
+            for config_primitive in get_iterable(vnfd.get("vnf-configuration", {}).get("config-primitive")):
+                if indata["primitive"] == config_primitive["name"]:
+                    # check needed primitive_params are provided
+                    if indata.get("primitive_params"):
+                        in_primitive_params_copy = copy(indata["primitive_params"])
+                    else:
+                        in_primitive_params_copy = {}
+                    for paramd in get_iterable(config_primitive.get("parameter")):
+                        if paramd["name"] in in_primitive_params_copy:
+                            del in_primitive_params_copy[paramd["name"]]
+                        elif not paramd.get("default-value"):
+                            raise EngineException("Needed parameter {} not provided for primitive '{}'".format(
+                                paramd["name"], indata["primitive"]))
+                    # check no extra primitive params are provided
+                    if in_primitive_params_copy:
+                        raise EngineException("parameter/s '{}' not present at vnfd for primitive '{}'".format(
+                            list(in_primitive_params_copy.keys()), indata["primitive"]))
+                    break
+            else:
+                raise EngineException("Invalid primitive '{}' is not present at vnfd".format(indata["primitive"]))
+        if operation == "scale":
+            vnfd = check_valid_vnf_member_index(indata["scaleVnfData"]["scaleByStepData"]["member-vnf-index"])
+            for scaling_group in get_iterable(vnfd.get("scaling-group-descriptor")):
+                if indata["scaleVnfData"]["scaleByStepData"]["scaling-group-descriptor"] == scaling_group["name"]:
                     break
             else:
-                raise EngineException("Invalid parameter member_vnf_index='{}' is not one of the nsd "
-                                          "constituent-vnfd".format(indata["member_vnf_index"]))
+                raise EngineException("Invalid scaleVnfData:scaleByStepData:scaling-group-descriptor '{}' is not "
+                                      "present at vnfd:scaling-group-descriptor".format(
+                                          indata["scaleVnfData"]["scaleByStepData"]["scaling-group-descriptor"]))
+        if operation == "instantiate":
+            # check vim_account
+            check_valid_vim_account(indata["vimAccountId"])
+            for in_vnf in get_iterable(indata.get("vnf")):
+                vnfd = check_valid_vnf_member_index(in_vnf["member-vnf-index"])
+                if in_vnf.get("vimAccountId"):
+                    check_valid_vim_account(in_vnf["vimAccountId"])
+                for in_vdu in get_iterable(in_vnf.get("vdu")):
+                    for vdud in get_iterable(vnfd.get("vdu")):
+                        if vdud["id"] == in_vdu["id"]:
+                            for volume in get_iterable(in_vdu.get("volume")):
+                                for volumed in get_iterable(vdud.get("volumes")):
+                                    if volumed["name"] == volume["name"]:
+                                        break
+                                else:
+                                    raise EngineException("Invalid parameter vnf[member-vnf-index='{}']:vdu[id='{}']:"
+                                                          "volume:name='{}' is not present at vnfd:vdu:volumes list".
+                                                          format(in_vnf["member-vnf-index"], in_vdu["id"],
+                                                                 volume["name"]))
+                            break
+                    else:
+                        raise EngineException("Invalid parameter vnf[member-vnf-index='{}']:vdu:id='{}' is not "
+                                              "present at vnfd".format(in_vnf["member-vnf-index"], in_vdu["id"]))
+
+                for in_internal_vld in get_iterable(in_vnf.get("internal-vld")):
+                    for internal_vldd in get_iterable(vnfd.get("internal-vld")):
+                        if in_internal_vld["name"] == internal_vldd["name"] or \
+                                in_internal_vld["name"] == internal_vldd["id"]:
+                            break
+                    else:
+                        raise EngineException("Invalid parameter vnf[member-vnf-index='{}']:internal-vld:name='{}'"
+                                              " is not present at vnfd '{}'".format(in_vnf["member-vnf-index"],
+                                                                                    in_internal_vld["name"],
+                                                                                    vnfd["id"]))
+            for in_vld in get_iterable(indata.get("vld")):
+                for vldd in get_iterable(nsd.get("vld")):
+                    if in_vld["name"] == vldd["name"] or in_vld["name"] == vldd["id"]:
+                            break
+                    else:
+                        raise EngineException("Invalid parameter vld:name='{}' is not present at nsd:vld".format(
+                            in_vld["name"]))
 
     def _format_new_data(self, session, item, indata):
         now = time()
-        if not "_admin" in indata:
+        if "_admin" not in indata:
             indata["_admin"] = {}
         indata["_admin"]["created"] = now
         indata["_admin"]["modified"] = now
@@ -476,7 +588,8 @@ class Engine(object):
                         storage["pkg-dir"] = tarname_path[0]
                         if len(tarname_path) == 2:
                             if descriptor_file_name:
-                                raise EngineException("Found more than one descriptor file at package descriptor tar.gz")
+                                raise EngineException(
+                                    "Found more than one descriptor file at package descriptor tar.gz")
                             descriptor_file_name = tarname
                 if not descriptor_file_name:
                     raise EngineException("Not found any descriptor file at package descriptor tar.gz")
@@ -520,14 +633,15 @@ class Engine(object):
             if file_pkg:
                 file_pkg.close()
 
-    def new_nsr(self, session, ns_request):
+    def new_nsr(self, rollback, session, ns_request):
         """
         Creates a new nsr into database. It also creates needed vnfrs
+        :param rollback: list where this method appends created items at database in case a rollback may to be done
         :param session: contains the used login username and working project
         :param ns_request: params to be used for the nsr
         :return: the _id of nsr descriptor stored at database
         """
-        rollback = []
+        rollback_index = len(rollback)
         step = ""
         try:
             # look for nsr
@@ -547,11 +661,12 @@ class Engine(object):
                 "description": ns_request.get("nsDescription", ""),
                 "constituent-vnfr-ref": [],
 
-                "operational-status": "init",    #  typedef ns-operational-
-                "config-status": "init",         #  typedef config-states
+                "operational-status": "init",    # typedef ns-operational-
+                "config-status": "init",         # typedef config-states
                 "detailed-status": "scheduled",
 
-                "orchestration-progress": {},  # {"networks": {"active": 0, "total": 0}, "vms": {"active": 0, "total": 0}},
+                "orchestration-progress": {},
+                # {"networks": {"active": 0, "total": 0}, "vms": {"active": 0, "total": 0}},
 
                 "crete-time": now,
                 "nsd-name-ref": nsd["name"],
@@ -590,9 +705,9 @@ class Engine(object):
                     "nsr-id-ref": nsr_id,
                     "member-vnf-index-ref": member_vnf["member-vnf-index"],
                     "created-time": now,
-                    # "vnfd": vnfd,        # at OSM model. TODO can it be removed in the future to avoid data duplication?
+                    # "vnfd": vnfd,        # at OSM model.but removed to avoid data duplication TODO: revise
                     "vnfd-ref": vnfd_id,
-                    "vnfd-id": vnfr_id,    # not at OSM model, but useful
+                    "vnfd-id": vnfd["_id"],    # not at OSM model, but useful
                     "vim-account-id": None,
                     "vdur": [],
                     "connection-point": [],
@@ -612,9 +727,11 @@ class Engine(object):
                     vdur = {
                         "id": vdur_id,
                         "vdu-id-ref": vdu["id"],
+                        # TODO      "name": ""     Name of the VDU in the VIM
                         "ip-address": None,  # mgmt-interface filled by LCM
                         # "vim-id", "flavor-id", "image-id", "management-ip" # filled by LCM
                         "internal-connection-point": [],
+                        "interfaces": [],
                     }
                     # TODO volumes: name, volume-id
                     for icp in vdu.get("internal-connection-point", ()):
@@ -626,39 +743,43 @@ class Engine(object):
                             # vim-id  # TODO it would be nice having a vim port id
                         }
                         vdur["internal-connection-point"].append(vdu_icp)
+                    for iface in vdu.get("interface", ()):
+                        vdu_iface = {
+                            "name": iface.get("name"),
+                            # "ip-address", "mac-address" # filled by LCM
+                            # vim-id  # TODO it would be nice having a vim port id
+                        }
+                        vdur["interfaces"].append(vdu_iface)
                     vnfr_descriptor["vdur"].append(vdur)
 
                 step = "creating vnfr vnfd-id='{}' constituent-vnfd='{}' at database".format(
                     member_vnf["vnfd-id-ref"], member_vnf["member-vnf-index"])
                 self._format_new_data(session, "vnfrs", vnfr_descriptor)
                 self.db.create("vnfrs", vnfr_descriptor)
-                rollback.append({"session": session, "item": "vnfrs", "_id": vnfr_id, "force": True})
+                rollback.insert(0, {"item": "vnfrs", "_id": vnfr_id})
                 nsr_descriptor["constituent-vnfr-ref"].append(vnfr_id)
 
             step = "creating nsr at database"
             self._format_new_data(session, "nsrs", nsr_descriptor)
             self.db.create("nsrs", nsr_descriptor)
+            rollback.insert(rollback_index, {"item": "nsrs", "_id": nsr_id})
             return nsr_id
         except Exception as e:
             raise EngineException("Error {}: {}".format(step, e))
-            for rollback_item in rollback:
-                try:
-                    self.engine.del_item(**rollback)
-                except Exception as e2:
-                    self.logger.error("Rollback Exception {}: {}".format(rollback, e2))
 
     @staticmethod
     def _update_descriptor(desc, kwargs):
         """
-        Update descriptor with the kwargs
-        :param kwargs:
+        Update descriptor with the kwargs. It contains dot separated keys
+        :param desc: dictionary to be updated
+        :param kwargs: plain dictionary to be used for updating.
         :return:
         """
         if not kwargs:
             return
         try:
             for k, v in kwargs.items():
-                update_content = content
+                update_content = desc
                 kitem_old = None
                 klist = k.split(".")
                 for kitem in klist:
@@ -682,10 +803,11 @@ class Engine(object):
             raise EngineException(
                 "Invalid query string '{}'. Index '{}' out of  range".format(k, kitem_old))
 
-    def new_item(self, session, item, indata={}, kwargs=None, headers={}, force=False):
+    def new_item(self, rollback, session, item, indata={}, kwargs=None, headers={}, force=False):
         """
         Creates a new entry into database. For nsds and vnfds it creates an almost empty DISABLED  entry,
         that must be completed with a call to method upload_content
+        :param rollback: list where this method appends created items at database in case a rollback may to be done
         :param session: contains the used login username and working project
         :param item: it can be: users, projects, vim_accounts, sdns, nsrs, nsds, vnfds
         :param indata: data to be inserted
@@ -710,13 +832,14 @@ class Engine(object):
 
             if item == "nsrs":
                 # in this case the input descriptor is not the data to be stored
-                return self.new_nsr(session, ns_request=content)
+                return self.new_nsr(rollback, session, ns_request=content)
 
             self._validate_new_data(session, item_envelop, content, force)
             if item in ("nsds", "vnfds"):
                 content = {"_admin": {"userDefinedData": content}}
             self._format_new_data(session, item, content)
             _id = self.db.create(item, content)
+            rollback.insert(0, {"item": item, "_id": _id})
 
             if item == "vim_accounts":
                 msg_data = self.db.get_one(item, {"_id": _id})
@@ -751,9 +874,10 @@ class Engine(object):
         }
         return nslcmop
 
-    def ns_operation(self, session, nsInstanceId, operation, indata, kwargs=None):
+    def ns_operation(self, rollback, session, nsInstanceId, operation, indata, kwargs=None):
         """
         Performs a new operation over a ns
+        :param rollback: list where this method appends created items at database in case a rollback may to be done
         :param session: contains the used login username and working project
         :param nsInstanceId: _id of the nsr to perform the operation
         :param operation: it can be: instantiate, terminate, action, TODO: update, heal
@@ -783,6 +907,7 @@ class Engine(object):
             nslcmop = self.new_nslcmop(session, nsInstanceId, operation, indata)
             self._format_new_data(session, "nslcmops", nslcmop)
             _id = self.db.create("nslcmops", nslcmop)
+            rollback.insert(0, {"item": "nslcmops", "_id": _id})
             indata["_id"] = _id
             self.msg.write("ns", operation, nslcmop)
             return _id
@@ -834,7 +959,7 @@ class Engine(object):
         content = self.get_item(session, item, _id)
         if content["_admin"]["onboardingState"] != "ONBOARDED":
             raise EngineException("Cannot get content because this resource is not at 'ONBOARDED' state. "
-                "onboardingState is {}".format(content["_admin"]["onboardingState"]),
+                                  "onboardingState is {}".format(content["_admin"]["onboardingState"]),
                                   http_code=HTTPStatus.CONFLICT)
         storage = content["_admin"]["storage"]
         if path is not None and path != "$DESCRIPTOR":   # artifacts
@@ -845,8 +970,8 @@ class Engine(object):
                 return folder_content, "text/plain"
                 # TODO manage folders in http
             else:
-                return self.fs.file_open((storage['folder'], storage['pkg-dir'], *path), "rb"), \
-                       "application/octet-stream"
+                return self.fs.file_open((storage['folder'], storage['pkg-dir'], *path), "rb"),\
+                    "application/octet-stream"
 
         # pkgtype   accept  ZIP  TEXT    -> result
         # manyfiles         yes  X       -> zip
@@ -858,12 +983,12 @@ class Engine(object):
             return self.fs.file_open((storage['folder'], storage['descriptor']), "r"), "text/plain"
         elif storage.get('pkg-dir') and not accept_zip:
             raise EngineException("Packages that contains several files need to be retrieved with 'application/zip'"
-                                      "Accept header", http_code=HTTPStatus.NOT_ACCEPTABLE)
+                                  "Accept header", http_code=HTTPStatus.NOT_ACCEPTABLE)
         else:
             if not storage.get('zipfile'):
                 # TODO generate zipfile if not present
-                raise EngineException("Only allowed 'text/plain' Accept header for this descriptor. To be solved in future versions"
-                                      "", http_code=HTTPStatus.NOT_ACCEPTABLE)
+                raise EngineException("Only allowed 'text/plain' Accept header for this descriptor. To be solved in "
+                                      "future versions", http_code=HTTPStatus.NOT_ACCEPTABLE)
             return self.fs.file_open((storage['folder'], storage['zipfile']), "rb"), "application/zip"
 
     def get_item_list(self, session, item, filter={}):
@@ -889,7 +1014,6 @@ class Engine(object):
         :param _id: server id of the item
         :return: dictionary, raise exception if not found.
         """
-        database_item = item
         filter = {"_id": _id}
         # TODO add admin to filter, validate rights
         # TODO transform data for SOL005 URL requests
@@ -923,12 +1047,13 @@ class Engine(object):
         self._add_delete_filter(session, item, filter)
         if item in ("vnfds", "nsds") and not force:
             descriptor = self.get_item(session, item, _id)
-            descriptor_id = descriptor["id"]
-            self._check_dependencies_on_descriptor(session, item, descriptor_id)
+            descriptor_id = descriptor.get("id")
+            if descriptor_id:
+                self._check_dependencies_on_descriptor(session, item, descriptor_id)
 
         if item == "nsrs":
             nsr = self.db.get_one(item, filter)
-            if nsr["_admin"]["nsState"] == "INSTANTIATED" and not force:
+            if nsr["_admin"].get("nsState") == "INSTANTIATED" and not force:
                 raise EngineException("nsr '{}' cannot be deleted because it is in 'INSTANTIATED' state. "
                                       "Launch 'terminate' operation first; or force deletion".format(_id),
                                       http_code=HTTPStatus.CONFLICT)
@@ -937,10 +1062,8 @@ class Engine(object):
             self.db.del_list("vnfrs", {"nsr-id-ref": _id})
             self.msg.write("ns", "deleted", {"_id": _id})
             return v
-        if item in ("vim_accounts", "sdns"):
-            desc = self.db.get_one(item, filter)
-            desc["_admin"]["to_delete"] = True
-            self.db.replace(item, _id, desc)   # TODO change to set_one
+        if item in ("vim_accounts", "sdns") and not force:
+            self.db.set_one(item, {"_id": _id}, {"_admin.to_delete": True})   # TODO change status
             if item == "vim_accounts":
                 self.msg.write("vim_account", "delete", {"_id": _id})
             elif item == "sdns":
@@ -948,7 +1071,10 @@ class Engine(object):
             return {"deleted": 1}  # TODO indicate an offline operation to return 202 ACCEPTED
 
         v = self.db.del_one(item, filter)
-        self.fs.file_delete(_id, ignore_non_exist=True)
+        if item in ("vnfds", "nsds"):
+            self.fs.file_delete(_id, ignore_non_exist=True)
+        if item in ("vim_accounts", "sdns", "vnfds", "nsds"):
+            self.msg.write(item[:-1], "deleted", {"_id": _id})
         return v
 
     def prune(self):
@@ -1033,7 +1159,7 @@ class Engine(object):
                 raise EngineException(
                     "Invalid query string '{}'. Index '{}' out of  range".format(k, kitem_old))
         try:
-            validate_input(content, item, new=False)
+            validate_input(indata, item, new=False)
         except ValidationError as e:
             raise EngineException(e, HTTPStatus.UNPROCESSABLE_ENTITY)
 
@@ -1064,4 +1190,3 @@ class Engine(object):
 
         content = self.get_item(session, item, _id)
         return self._edit_item(session, item, _id, content, indata, kwargs, force)
-