from http import HTTPStatus
from time import time
from copy import deepcopy
+from validation import validate_input, ValidationError
__author__ = "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
elif item == "nsrs":
pass
+ elif item == "vims" or item == "sdns":
+ if self.db.get_one(item, {"name": indata.get("name")}, fail_on_empty=False, fail_on_more=False):
+ raise EngineException("name '{}' already exist for {}".format(indata["name"], item),
+ HTTPStatus.CONFLICT)
- def _format_new_data(self, session, item, indata, admin=None):
+ def _format_new_data(self, session, item, indata):
now = time()
if not "_admin" in indata:
indata["_admin"] = {}
indata["_admin"]["created"] = now
indata["_admin"]["modified"] = now
if item == "users":
- _id = indata["username"]
+ indata["_id"] = indata["username"]
salt = uuid4().hex
indata["_admin"]["salt"] = salt
indata["password"] = sha256(indata["password"].encode('utf-8') + salt.encode('utf-8')).hexdigest()
elif item == "projects":
- _id = indata["name"]
+ indata["_id"] = indata["name"]
else:
- _id = None
- storage = None
- if admin:
- _id = admin.get("_id")
- storage = admin.get("storage")
- if not _id:
- _id = str(uuid4())
- if item in ("vnfds", "nsds"):
+ if not indata.get("_id"):
+ indata["_id"] = str(uuid4())
+ if item in ("vnfds", "nsds", "nsrs"):
if not indata["_admin"].get("projects_read"):
indata["_admin"]["projects_read"] = [session["project_id"]]
if not indata["_admin"].get("projects_write"):
indata["_admin"]["projects_write"] = [session["project_id"]]
+ if item in ("vnfds", "nsds"):
indata["_admin"]["onboardingState"] = "CREATED"
indata["_admin"]["operationalState"] = "DISABLED"
indata["_admin"]["usageSate"] = "NOT_IN_USE"
- if storage:
- indata["_admin"]["storage"] = storage
- indata["_id"] = _id
+ if item == "nsrs":
+ indata["_admin"]["nsState"] = "NOT_INSTANTIATED"
+ if item in ("vims", "sdns"):
+ indata["_admin"]["operationalState"] = "PROCESSING"
def upload_content(self, session, item, _id, indata, kwargs, headers):
"""
HTTPStatus.REQUESTED_RANGE_NOT_SATISFIABLE)
except IOError as e:
raise EngineException("invalid upload transaction sequence: '{}'".format(e), HTTPStatus.BAD_REQUEST)
+ except tarfile.ReadError as e:
+ raise EngineException("invalid file content {}".format(e), HTTPStatus.BAD_REQUEST)
except (ValueError, yaml.YAMLError) as e:
raise EngineException(error_text + str(e))
finally:
"nsd-ref": nsd["id"],
"ns-instance-config-ref": _id,
"id": _id,
+ "_id": _id,
# "input-parameter": xpath, value,
"ssh-authorized-key": ns_request.get("key-pair-ref"),
}
ns_request["nsr_id"] = _id
- return nsr_descriptor, _id
+ return nsr_descriptor
+
+ @staticmethod
+ def _update_descriptor(desc, kwargs):
+ """
+ Update descriptor with the kwargs
+ :param kwargs:
+ :return:
+ """
+ if not kwargs:
+ return
+ try:
+ for k, v in kwargs.items():
+ update_content = content
+ kitem_old = None
+ klist = k.split(".")
+ for kitem in klist:
+ if kitem_old is not None:
+ update_content = update_content[kitem_old]
+ if isinstance(update_content, dict):
+ kitem_old = kitem
+ elif isinstance(update_content, list):
+ kitem_old = int(kitem)
+ else:
+ raise EngineException(
+ "Invalid query string '{}'. Descriptor is not a list nor dict at '{}'".format(k, kitem))
+ update_content[kitem_old] = v
+ except KeyError:
+ raise EngineException(
+ "Invalid query string '{}'. Descriptor does not contain '{}'".format(k, kitem_old))
+ except ValueError:
+ raise EngineException("Invalid query string '{}'. Expected integer index list instead of '{}'".format(
+ k, kitem))
+ except IndexError:
+ raise EngineException(
+ "Invalid query string '{}'. Index '{}' out of range".format(k, kitem_old))
def new_item(self, session, item, indata={}, kwargs=None, headers={}):
"""
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 session: contains the used login username and working project
- :param item: it can be: users, projects, nsrs, nsds, vnfds
+ :param item: it can be: users, projects, vims, sdns, nsrs, nsds, vnfds
:param indata: data to be inserted
:param kwargs: used to override the indata descriptor
:param headers: http request headers
:return: _id, transaction_id: identity of the inserted data. or transaction_id if Content-Range is used
"""
- # TODO validate input. Check not exist at database
- # TODO add admin and status
-
- transaction = None
- # if headers.get("Content-Range") or "application/gzip" in headers.get("Content-Type") or \
- # "application/x-gzip" in headers.get("Content-Type") or "application/zip" in headers.get("Content-Type") or \
- # "text/plain" in headers.get("Content-Type"):
- # if not indata:
- # raise EngineException("Empty payload")
- # transaction = self._new_item_partial(session, item, indata, headers)
- # if "desc" not in transaction:
- # return transaction["_id"], False
- # indata = transaction["desc"]
-
- item_envelop = item
- if item in ("nsds", "vnfds"):
- item_envelop = "userDefinedData"
- content = self._remove_envelop(item_envelop, indata)
- # Override descriptor with query string kwargs
- if kwargs:
- try:
- for k, v in kwargs.items():
- update_content = content
- kitem_old = None
- klist = k.split(".")
- for kitem in klist:
- if kitem_old is not None:
- update_content = update_content[kitem_old]
- if isinstance(update_content, dict):
- kitem_old = kitem
- elif isinstance(update_content, list):
- kitem_old = int(kitem)
- else:
- raise EngineException(
- "Invalid query string '{}'. Descriptor is not a list nor dict at '{}'".format(k, kitem))
- update_content[kitem_old] = v
- except KeyError:
- raise EngineException(
- "Invalid query string '{}'. Descriptor does not contain '{}'".format(k, kitem_old))
- except ValueError:
- raise EngineException("Invalid query string '{}'. Expected integer index list instead of '{}'".format(
- k, kitem))
- except IndexError:
- raise EngineException(
- "Invalid query string '{}'. Index '{}' out of range".format(k, kitem_old))
- if not indata and item not in ("nsds", "vnfds"):
- raise EngineException("Empty payload")
+ try:
+ item_envelop = item
+ if item in ("nsds", "vnfds"):
+ item_envelop = "userDefinedData"
+ content = self._remove_envelop(item_envelop, indata)
+
+ # Override descriptor with query string kwargs
+ self._update_descriptor(content, kwargs)
+ if not indata and item not in ("nsds", "vnfds"):
+ raise EngineException("Empty payload")
+
+ validate_input(content, item, new=True)
+
+ if item == "nsrs":
+ # in this case the imput descriptor is not the data to be stored
+ ns_request = content
+ content = self.new_nsr(session, ns_request)
+
+ self._validate_new_data(session, item_envelop, content)
+ if item in ("nsds", "vnfds"):
+ content = {"_admin": {"userDefinedData": content}}
+ self._format_new_data(session, item, content)
+ _id = self.db.create(item, content)
+ if item == "nsrs":
+ pass
+ # self.msg.write("ns", "created", _id) # sending just for information.
+ elif item == "vims":
+ msg_data = self.db.get_one(item, {"_id": _id})
+ msg_data.pop("_admin", None)
+ self.msg.write("vim_account", "create", msg_data)
+ elif item == "sdns":
+ msg_data = self.db.get_one(item, {"_id": _id})
+ msg_data.pop("_admin", None)
+ self.msg.write("sdn", "create", msg_data)
+ return _id
+ except ValidationError as e:
+ raise EngineException(e, HTTPStatus.UNPROCESSABLE_ENTITY)
+
+ def new_nslcmop(self, session, nsInstanceId, action, params):
+ now = time()
+ _id = str(uuid4())
+ nslcmop = {
+ "id": _id,
+ "_id": _id,
+ "operationState": "PROCESSING", # COMPLETED,PARTIALLY_COMPLETED,FAILED_TEMP,FAILED,ROLLING_BACK,ROLLED_BACK
+ "statusEnteredTime": now,
+ "nsInstanceId": nsInstanceId,
+ "lcmOperationType": action,
+ "startTime": now,
+ "isAutomaticInvocation": False,
+ "operationParams": params,
+ "isCancelPending": False,
+ "links": {
+ "self": "/osm/nslcm/v1/ns_lcm_op_occs/" + _id,
+ "nsInstance": "/osm/nslcm/v1/ns_instances/" + nsInstanceId,
+ }
+ }
+ return nslcmop
- if item == "nsrs":
- # in this case the imput descriptor is not the data to be stored
- ns_request = content
- content, _id = self.new_nsr(session, ns_request)
- transaction = {"_id": _id}
-
- self._validate_new_data(session, item_envelop, content)
- if item in ("nsds", "vnfds"):
- content = {"_admin": {"userDefinedData": content}}
- self._format_new_data(session, item, content, transaction)
- _id = self.db.create(item, content)
- if item == "nsrs":
- self.msg.write("ns", "create", _id)
- return _id
+ def ns_action(self, session, nsInstanceId, action, indata, kwargs=None):
+ """
+ Performs a new action over a ns
+ :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 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)
+ # get ns from nsr_id
+ nsr = self.get_item(session, "nsrs", nsInstanceId)
+ if nsr["_admin"]["nsState"] == "NOT_INSTANTIATED":
+ if action == "terminate" and indata.get("autoremove"):
+ # NSR must be deleted
+ return self.del_item(session, "nsrs", nsInstanceId)
+ if action != "instantiate":
+ raise EngineException("ns_instance '{}' cannot be '{}' because it is not instantiated".format(
+ nsInstanceId, action), HTTPStatus.CONFLICT)
+ else:
+ if action == "instantiate" and not indata.get("force"):
+ raise EngineException("ns_instance '{}' cannot be '{}' because it is already instantiated".format(
+ nsInstanceId, action), HTTPStatus.CONFLICT)
+ indata["nsInstanceId"] = nsInstanceId
+ # TODO
+ nslcmop = self.new_nslcmop(session, nsInstanceId, action, indata)
+ self._format_new_data(session, "nslcmops", nslcmop)
+ _id = self.db.create("nslcmops", nslcmop)
+ indata["_id"] = _id
+ self.msg.write("ns", action, nslcmop)
+ return _id
+ except ValidationError as e:
+ raise EngineException(e, HTTPStatus.UNPROCESSABLE_ENTITY)
+ # except DbException as e:
+ # raise EngineException("Cannot get ns_instance '{}': {}".format(e), HTTPStatus.NOT_FOUND)
def _add_read_filter(self, session, item, filter):
if session["project_id"] == "admin": # allows all
return filter
if item == "users":
filter["username"] = session["username"]
- elif item == "vnfds" or item == "nsds":
+ elif item in ("vnfds", "nsds", "nsrs"):
filter["_admin.projects_read.cont"] = ["ANY", session["project_id"]]
def _add_delete_filter(self, session, item, filter):
"", 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={}):
"""
Get a list of items
self._add_read_filter(session, item, filter)
return self.db.del_list(item, filter)
- def del_item(self, session, item, _id):
+ def del_item(self, session, item, _id, force=False):
"""
Get complete information on an items
: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
+ :param force: indicates if deletion must be forced in case of conflict
:return: dictionary, raise exception if not found.
"""
# TODO add admin to filter, validate rights
self._add_delete_filter(session, item, filter)
if item == "nsrs":
+ nsr = self.db.get_one(item, filter)
+ if nsr["_admin"]["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),
+ http_code=HTTPStatus.CONFLICT)
+ v = self.db.del_one(item, {"_id": _id})
+ self.db.del_list("nslcmops", {"nsInstanceId": _id})
+ self.msg.write("ns", "deleted", {"_id": _id})
+ return v
+ if item in ("vims", "sdns"):
desc = self.db.get_one(item, filter)
desc["_admin"]["to_delete"] = True
self.db.replace(item, _id, desc) # TODO change to set_one
- self.msg.write("ns", "delete", _id)
- return {"deleted": 1}
+ if item == "vims":
+ self.msg.write("vim_account", "delete", {"_id": _id})
+ elif item == "sdns":
+ self.msg.write("sdn", "delete", {"_id": _id})
+ 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 == "nsrs":
- self.msg.write("ns", "delete", _id)
return v
def prune(self):
def create_admin(self):
"""
- Creates a new user admin/admin into database. Only allowed if database is empty. Useful for initialization
- :return: _id identity of the inserted data.
+ Creates a new user admin/admin into database if database is empty. Useful for initialization
+ :return: _id identity of the inserted data, or None
"""
users = self.db.get_one("users", fail_on_empty=False, fail_on_more=False)
if users:
- raise EngineException("Unauthorized. Database users is not empty", HTTPStatus.UNAUTHORIZED)
+ return None
+ # raise EngineException("Unauthorized. Database users is not empty", HTTPStatus.UNAUTHORIZED)
indata = {"username": "admin", "password": "admin", "projects": ["admin"]}
fake_session = {"project_id": "admin", "username": "admin"}
self._format_new_data(fake_session, "users", indata)
_id = self.db.create("users", indata)
return _id
+ def init_db(self, target_version='1.0'):
+ """
+ Init database if empty. If not empty it checks that database version is ok.
+ If empty, it creates a new user admin/admin at 'users' and a new entry at 'version'
+ :return: None if ok, exception if error or if the version is different.
+ """
+ version = self.db.get_one("version", fail_on_empty=False, fail_on_more=False)
+ if not version:
+ # create user admin
+ self.create_admin()
+ # create database version
+ version_data = {
+ "_id": '1.0', # version text
+ "version": 1000, # version number
+ "date": "2018-04-12", # version date
+ "description": "initial design", # changes in this version
+ 'status': 'ENABLED' # ENABLED, DISABLED (migration in process), ERROR,
+ }
+ self.db.create("version", version_data)
+ elif version["_id"] != target_version:
+ # TODO implement migration process
+ raise EngineException("Wrong database version '{}'. Expected '{}'".format(
+ version["_id"], target_version), HTTPStatus.INTERNAL_SERVER_ERROR)
+ elif version["status"] != 'ENABLED':
+ raise EngineException("Wrong database status '{}'".format(
+ version["status"]), HTTPStatus.INTERNAL_SERVER_ERROR)
+ return
+
def _edit_item(self, session, item, id, content, indata={}, kwargs=None):
if indata:
indata = self._remove_envelop(item, indata)
except IndexError:
raise EngineException(
"Invalid query string '{}'. Index '{}' out of range".format(k, kitem_old))
+ try:
+ validate_input(content, 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._format_new_data(session, item, content)
self.db.replace(item, id, content)
+ if item in ("vims", "sdns"):
+ indata.pop("_admin", None)
+ indata["_id"] = id
+ if item == "vims":
+ self.msg.write("vim_account", "edit", indata)
+ elif item == "sdns":
+ self.msg.write("sdn", "edit", indata)
return id
def edit_item(self, session, item, _id, indata={}, kwargs=None):