# -*- coding: utf-8 -*-
-import dbmongo
-import dbmemory
-import fslocal
-import msglocal
-import msgkafka
+from osm_common import dbmongo
+from osm_common import dbmemory
+from osm_common import fslocal
+from osm_common import msglocal
+from osm_common import msgkafka
import tarfile
import yaml
import json
from random import choice as random_choice
from uuid import uuid4
from hashlib import sha256, md5
-from dbbase import DbException
-from fsbase import FsException
-from msgbase import MsgException
+from osm_common.dbbase import DbException
+from osm_common.fsbase import FsException
+from osm_common.msgbase import MsgException
from http import HTTPStatus
from time import time
from copy import deepcopy
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])
clean_indata = clean_indata['userDefinedData']
return clean_indata
- def _validate_new_data(self, session, item, indata, id=None):
+ def _check_dependencies_on_descriptor(self, session, item, descriptor_id):
+ """
+ Check that the descriptor to be deleded is not a dependency of others
+ :param session: client session information
+ :param item: can be vnfds, nsds
+ :param descriptor_id: id of descriptor to be deleted
+ :return: None or raises exception
+ """
+ if item == "vnfds":
+ _filter = {"constituent-vnfd.ANYINDEX.vnfd-id-ref": descriptor_id}
+ if self.get_item_list(session, "nsds", _filter):
+ raise EngineException("There are nsd that depends on this VNFD", http_code=HTTPStatus.CONFLICT)
+ elif item == "nsds":
+ _filter = {"nsdId": descriptor_id}
+ if self.get_item_list(session, "nsrs", _filter):
+ raise EngineException("There are nsr that depends on this NSD", http_code=HTTPStatus.CONFLICT)
+
+ def _check_descriptor_dependencies(self, session, item, descriptor):
+ """
+ Check that the dependent descriptors exist on a new descriptor or edition
+ :param session: client session information
+ :param item: can be nsds, nsrs
+ :param descriptor: descriptor to be inserted or edit
+ :return: None or raises exception
+ """
+ if item == "nsds":
+ if not descriptor.get("constituent-vnfd"):
+ return
+ for vnf in descriptor["constituent-vnfd"]:
+ vnfd_id = vnf["vnfd-id-ref"]
+ if not self.get_item_list(session, "vnfds", {"id": vnfd_id}):
+ raise EngineException("Descriptor error at 'constituent-vnfd':'vnfd-id-ref'='{}' references a non "
+ "existing vnfd".format(vnfd_id), http_code=HTTPStatus.CONFLICT)
+ elif item == "nsrs":
+ if not descriptor.get("nsdId"):
+ return
+ nsd_id = descriptor["nsdId"]
+ if not self.get_item_list(session, "nsds", {"id": nsd_id}):
+ raise EngineException("Descriptor error at nsdId='{}' references a non exist nsd".format(nsd_id),
+ http_code=HTTPStatus.CONFLICT)
+
+ def _validate_new_data(self, session, item, indata, id=None, force=False):
if item == "users":
if not indata.get("username"):
raise EngineException("missing 'username'", HTTPStatus.UNPROCESSABLE_ENTITY)
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
+ # 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"])
+
+ if item == "nsds" and not force:
+ self._check_descriptor_dependencies(session, "nsds", indata)
elif item == "userDefinedData":
# TODO validate userDefinedData is a keypair values
pass
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)
+ def _check_ns_operation(self, session, nsr, operation, indata):
+ """
+ Check that user has enter right parameters for the operation
+ :param session:
+ :param operation: it can be: instantiate, terminate, action, TODO: update, heal
+ :param indata: descriptor with the parameters of the operation
+ :return: None
+ """
+ def check_valid_vnf_member_index(member_vnf_index):
+ for vnf in nsr["nsd"]["constituent-vnfd"]:
+ if member_vnf_index == vnf["member-vnf-index"]:
+ break
+ else:
+ raise EngineException("Invalid parameter member_vnf_index='{}' is not one of the "
+ "nsd:constituent-vnfd".format(member_vnf_index))
+
+ if operation == "action":
+ if indata.get("vnf_member_index"):
+ indata["member_vnf_index"] = indata.pop("vnf_member_index") # for backward compatibility
+ check_valid_vnf_member_index(indata["member_vnf_index"])
+ # TODO get vnfd, check primitives
+ if operation == "scale":
+ check_valid_vnf_member_index(indata["scaleVnfData"]["scaleByStepData"]["member-vnf-index"])
+ # TODO check vnf scaling primitives
+
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
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")
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
"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"],
"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": [],
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", ()):
# 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:
raise EngineException(
"Invalid query string '{}'. Index '{}' out of range".format(k, kitem_old))
- def new_item(self, session, item, indata={}, kwargs=None, headers={}):
+ 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
:param kwargs: used to override the indata descriptor
:param headers: http request headers
+ :param force: If True avoid some dependence checks
:return: _id: identity of the inserted data.
"""
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)
+ 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})
except ValidationError as e:
raise EngineException(e, HTTPStatus.UNPROCESSABLE_ENTITY)
- def new_nslcmop(self, session, nsInstanceId, action, params):
+ def new_nslcmop(self, session, nsInstanceId, operation, params):
now = time()
_id = str(uuid4())
nslcmop = {
"operationState": "PROCESSING", # COMPLETED,PARTIALLY_COMPLETED,FAILED_TEMP,FAILED,ROLLING_BACK,ROLLED_BACK
"statusEnteredTime": now,
"nsInstanceId": nsInstanceId,
- "lcmOperationType": action,
+ "lcmOperationType": operation,
"startTime": now,
"isAutomaticInvocation": False,
"operationParams": params,
}
return nslcmop
- def ns_action(self, session, nsInstanceId, action, indata, kwargs=None):
+ def ns_operation(self, rollback, session, nsInstanceId, operation, indata, kwargs=None):
"""
- Performs a new action over a ns
+ 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 action
- :param action: it can be: instantiate, terminate, action, TODO: update, heal
- :param indata: descriptor with the parameters of the action
+ :param nsInstanceId: _id of the nsr to perform the operation
+ :param operation: it can be: instantiate, terminate, action, TODO: update, heal
+ :param indata: descriptor with the parameters of the operation
:param kwargs: used to override the indata descriptor
:return: id of the nslcmops
"""
try:
# Override descriptor with query string kwargs
self._update_descriptor(indata, kwargs)
- validate_input(indata, "ns_" + action, new=True)
+ validate_input(indata, "ns_" + operation, new=True)
# get ns from nsr_id
nsr = self.get_item(session, "nsrs", nsInstanceId)
if not nsr["_admin"].get("nsState") or nsr["_admin"]["nsState"] == "NOT_INSTANTIATED":
- if action == "terminate" and indata.get("autoremove"):
+ if operation == "terminate" and indata.get("autoremove"):
# NSR must be deleted
return self.del_item(session, "nsrs", nsInstanceId)
- if action != "instantiate":
+ if operation != "instantiate":
raise EngineException("ns_instance '{}' cannot be '{}' because it is not instantiated".format(
- nsInstanceId, action), HTTPStatus.CONFLICT)
+ nsInstanceId, operation), HTTPStatus.CONFLICT)
else:
- if action == "instantiate" and not indata.get("force"):
+ if operation == "instantiate" and not indata.get("force"):
raise EngineException("ns_instance '{}' cannot be '{}' because it is already instantiated".format(
- nsInstanceId, action), HTTPStatus.CONFLICT)
+ nsInstanceId, operation), HTTPStatus.CONFLICT)
indata["nsInstanceId"] = nsInstanceId
- # TODO
- nslcmop = self.new_nslcmop(session, nsInstanceId, action, indata)
+ self._check_ns_operation(session, nsr, operation, indata)
+ 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", action, nslcmop)
+ self.msg.write("ns", operation, nslcmop)
return _id
except ValidationError as e:
raise EngineException(e, HTTPStatus.UNPROCESSABLE_ENTITY)
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
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
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={}):
: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
def del_item(self, session, item, _id, force=False):
"""
- Get complete information on an items
+ Delete item by its internal id
:param session: contains the used login username and working project
:param item: it can be: users, projects, vnfds, nsds, ...
:param _id: server id of the item
# data = self.get_item(item, _id)
filter = {"_id": _id}
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.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' action first; or force deletion".format(_id),
+ "Launch 'terminate' operation first; or force deletion".format(_id),
http_code=HTTPStatus.CONFLICT)
v = self.db.del_one(item, {"_id": _id})
self.db.del_list("nslcmops", {"nsInstanceId": _id})
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":
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):
version["status"]), HTTPStatus.INTERNAL_SERVER_ERROR)
return
- def _edit_item(self, session, item, id, content, indata={}, kwargs=None):
+ def _edit_item(self, session, item, id, content, indata={}, kwargs=None, force=False):
if indata:
indata = self._remove_envelop(item, indata)
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)
_deep_update(content, indata)
- self._validate_new_data(session, item, content, id)
+ self._validate_new_data(session, item, content, id, force)
# self._format_new_data(session, item, content)
self.db.replace(item, id, content)
if item in ("vim_accounts", "sdns"):
self.msg.write("sdn", "edit", indata)
return id
- def edit_item(self, session, item, _id, indata={}, kwargs=None):
+ def edit_item(self, session, item, _id, indata={}, kwargs=None, force=False):
"""
Update an existing entry at database
:param session: contains the used login username and working project
:param _id: identifier to be updated
:param indata: data to be inserted
:param kwargs: used to override the indata descriptor
+ :param force: If True avoid some dependence checks
:return: dictionary, raise exception if not found.
"""
content = self.get_item(session, item, _id)
- return self._edit_item(session, item, _id, content, indata, kwargs)
-
+ return self._edit_item(session, item, _id, content, indata, kwargs, force)