X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;f=osm_lcm%2FROclient.py;h=cf1149002fbddec188be0b26b713bcfb0ccb88f1;hb=7ecbc3423bc9e08a662780b2eec10ee7cfe78b74;hp=1f1496c310220330235ee88f5fa40bbd2264414d;hpb=275411e13bbfb20d8045c5425b20d46a5c8638ec;p=osm%2FLCM.git diff --git a/osm_lcm/ROclient.py b/osm_lcm/ROclient.py index 1f1496c..cf11490 100644 --- a/osm_lcm/ROclient.py +++ b/osm_lcm/ROclient.py @@ -3,8 +3,6 @@ ## # Copyright 2015 Telefónica Investigación y Desarrollo, S.A.U. -# This file is part of openmano -# All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"); you may # not use this file except in compliance with the License. You may obtain @@ -18,8 +16,6 @@ # License for the specific language governing permissions and limitations # under the License. # -# For those usages not covered by the Apache License, Version 2.0 please -# contact with: nfvlabs@tid.es ## """ @@ -31,7 +27,6 @@ import aiohttp import json import yaml import logging -import sys from urllib.parse import quote from uuid import UUID from copy import deepcopy @@ -42,11 +37,12 @@ __version__ = "0.1.2" version_date = "2018-05-16" requests = None + class ROClientException(Exception): def __init__(self, message, http_code=400): + """Common Exception for all RO client exceptions""" self.http_code = http_code Exception.__init__(self, message) - """Common Exception for all openmano client exceptions""" def remove_envelop(item, indata=None): @@ -87,6 +83,12 @@ def remove_envelop(item, indata=None): elif item in ("vim", "vim_account", "datacenters"): if len(indata) == 1 and "datacenter" in indata: clean_indata = indata["datacenter"] + elif item == "wim": + if len(indata) == 1 and "wim" in indata: + clean_indata = indata["wim"] + elif item == "wim_account": + if len(indata) == 1 and "wim_account" in indata: + clean_indata = indata["wim_account"] elif item == "ns" or item == "instances": if len(indata) == 1 and "instance" in indata: clean_indata = indata["instance"] @@ -99,23 +101,25 @@ def remove_envelop(item, indata=None): class ROClient: headers_req = {'Accept': 'application/yaml', 'content-type': 'application/yaml'} client_to_RO = {'tenant': 'tenants', 'vim': 'datacenters', 'vim_account': 'datacenters', 'sdn': 'sdn_controllers', - 'vnfd': 'vnfs', 'nsd': 'scenarios', + 'vnfd': 'vnfs', 'nsd': 'scenarios', 'wim': 'wims', 'wim_account': 'wims', 'ns': 'instances'} mandatory_for_create = { 'tenant': ("name", ), - 'vnfd': ("name", "id", "connection-point", "vdu"), - 'nsd': ("name", "id", "constituent-vnfd"), + 'vnfd': ("name", "id"), + 'nsd': ("name", "id"), 'ns': ("name", "scenario", "datacenter"), 'vim': ("name", "vim_url"), + 'wim': ("name", "wim_url"), 'vim_account': (), - 'sdn': ("name", "port", 'ip', 'dpid', 'type'), + 'wim_account': (), + 'sdn': ("name", 'type'), } timeout_large = 120 timeout_short = 30 - def __init__(self, loop, endpoint_url, **kwargs): + def __init__(self, loop, uri, **kwargs): self.loop = loop - self.endpoint_url = endpoint_url + self.uri = uri self.username = kwargs.get("username") self.password = kwargs.get("password") @@ -123,7 +127,7 @@ class ROClient: self.tenant = None self.datacenter_id_name = kwargs.get("datacenter") self.datacenter = None - logger_name = kwargs.get('logger_name', 'ROClient') + logger_name = kwargs.get('logger_name', 'lcm.ro') self.logger = logging.getLogger(logger_name) if kwargs.get("loglevel"): self.logger.setLevel(kwargs["loglevel"]) @@ -139,12 +143,12 @@ class ROClient: return self.username elif index == 'password': return self.password - elif index == 'endpoint_url': - return self.endpoint_url + elif index == 'uri': + return self.uri else: - raise KeyError("Invalid key '%s'" %str(index)) - - def __setitem__(self,index, value): + raise KeyError("Invalid key '{}'".format(index)) + + def __setitem__(self, index, value): if index == 'tenant': self.tenant_id_name = value elif index == 'datacenter' or index == 'vim': @@ -153,17 +157,17 @@ class ROClient: self.username = value elif index == 'password': self.password = value - elif index == 'endpoint_url': - self.endpoint_url = value + elif index == 'uri': + self.uri = value else: raise KeyError("Invalid key '{}'".format(index)) self.tenant = None # force to reload tenant with different credentials self.datacenter = None # force to reload datacenter with different credentials - - def _parse(self, descriptor, descriptor_format, response=False): - #try yaml + + @staticmethod + def _parse(descriptor, descriptor_format, response=False): if descriptor_format and descriptor_format != "json" and descriptor_format != "yaml": - raise ROClientException("'descriptor_format' must be a 'json' or 'yaml' text") + raise ROClientException("'descriptor_format' must be a 'json' or 'yaml' text") if descriptor_format != "json": try: return yaml.load(descriptor) @@ -171,31 +175,41 @@ class ROClient: error_pos = "" if hasattr(exc, 'problem_mark'): mark = exc.problem_mark - error_pos = " at line:{} column:{}s".format(mark.line+1, mark.column+1) + error_pos = " at line:{} column:{}s".format(mark.line + 1, mark.column + 1) error_text = "yaml format error" + error_pos elif descriptor_format != "yaml": try: - return json.loads(descriptor) + return json.loads(descriptor) except Exception as e: if response: error_text = "json format error" + str(e) if response: raise ROClientException(error_text) - raise ROClientException(error_text) - - def _parse_yaml(self, descriptor, response=False): + raise ROClientException(error_text) + + @staticmethod + def _parse_error_yaml(descriptor): + json_error = None try: - return yaml.load(descriptor) + json_error = yaml.load(descriptor, Loader=yaml.Loader) + return json_error["error"]["description"] + except Exception: + return str(json_error or descriptor) + + @staticmethod + def _parse_yaml(descriptor, response=False): + try: + return yaml.load(descriptor, Loader=yaml.Loader) except yaml.YAMLError as exc: error_pos = "" if hasattr(exc, 'problem_mark'): mark = exc.problem_mark - error_pos = " at line:{} column:{}s".format(mark.line+1, mark.column+1) + error_pos = " at line:{} column:{}s".format(mark.line + 1, mark.column + 1) error_text = "yaml format error" + error_pos if response: raise ROClientException(error_text) - raise ROClientException(error_text) + raise ROClientException(error_text) @staticmethod def check_if_uuid(uuid_text): @@ -207,7 +221,7 @@ class ROClient: try: UUID(uuid_text) return True - except (ValueError, TypeError): + except Exception: return False @staticmethod @@ -226,6 +240,10 @@ class ROClient: return {'tenant': indata} elif item in ("vim", "vim_account", "datacenter"): return {'datacenter': indata} + elif item == "wim": + return {'wim': indata} + elif item == "wim_account": + return {'wim_account': indata} elif item == "ns" or item == "instances": return {'instance': indata} elif item == "sdn": @@ -273,40 +291,125 @@ class ROClient: :param ns_descriptor: instance descriptor obtained with self.show("ns", ) :return: status, message: status can be BUILD,ACTIVE,ERROR, message is a text message """ + error_list = [] + total = {"VMs": 0, "networks": 0, "SDN_networks": 0} + done = {"VMs": 0, "networks": 0, "SDN_networks": 0} + + def _get_ref(desc): + # return an identification for the network or vm. Try vim_id if exist, if not descriptor id for net + if desc.get("vim_net_id"): + return "'vim-net-id={}'".format(desc["vim_net_id"]) + elif desc.get("ns_net_osm_id"): + return "'nsd-vld-id={}'".format(desc["ns_net_osm_id"]) + elif desc.get("vnf_net_osm_id"): + return "'vnfd-vld-id={}'".format(desc["vnf_net_osm_id"]) + # for VM + elif desc.get("vim_vm_id"): + return "'vim-vm-id={}'".format(desc["vim_vm_id"]) + elif desc.get("vdu_osm_id"): + return "'vnfd-vdu-id={}'".format(desc["vdu_osm_id"]) + else: + return "" + + def _get_sdn_ref(sce_net_id): + # look for the network associated to the SDN network and obtain the identification + net = next((x for x in ns_descriptor["nets"] if x.get("sce_net_id") == sce_net_id), None) + if not sce_net_id or not net: + return "" + return _get_ref(net) + + try: + total["networks"] = len(ns_descriptor["nets"]) + for net in ns_descriptor["nets"]: + if net["status"] in ("ERROR", "VIM_ERROR"): + error_list.append("Error at VIM network {}: {}".format(_get_ref(net), net["error_msg"])) + elif net["status"] == "ACTIVE": + done["networks"] += 1 + + total["SDN_networks"] = len(ns_descriptor["sdn_nets"]) + for sdn_net in ns_descriptor["sdn_nets"]: + if sdn_net["status"] in ("ERROR", "VIM_ERROR", "WIM_ERROR"): + error_list.append("Error at SDN network {}: {}".format(_get_sdn_ref(sdn_net.get("sce_net_id")), + sdn_net["error_msg"])) + elif sdn_net["status"] == "ACTIVE": + done["SDN_networks"] += 1 + + for vnf in ns_descriptor["vnfs"]: + for vm in vnf["vms"]: + total["VMs"] += 1 + if vm["status"] in ("ERROR", "VIM_ERROR"): + error_list.append("Error at VIM VM {}: {}".format(_get_ref(vm), vm["error_msg"])) + elif vm["status"] == "ACTIVE": + done["VMs"] += 1 + if error_list: + # skip errors caused because other dependendent task is on error + return "ERROR", "; ".join([el for el in error_list if "because depends on failed ACTION" not in el]) + if all(total[x] == done[x] for x in total): # DONE == TOTAL for all items + return "ACTIVE", str({x: total[x] for x in total if total[x]}) # print only those which value is not 0 + else: + return "BUILD", str({x: "{}/{}".format(done[x], total[x]) for x in total if total[x]}) + # print done/total for each item if total is not 0 + except Exception as e: + raise ROClientException("Unexpected RO ns descriptor. Wrong version? {}".format(e)) from e + + @staticmethod + def check_action_status(action_descriptor): + """ + Inspect RO instance descriptor and indicates the status + :param action_descriptor: action instance descriptor obtained with self.show("ns", "action") + :return: status, message: status can be BUILD,ACTIVE,ERROR, message is a text message + """ net_total = 0 vm_total = 0 net_done = 0 vm_done = 0 + other_total = 0 + other_done = 0 + + for vim_action_set in action_descriptor["actions"]: + for vim_action in vim_action_set["vim_wim_actions"]: + if vim_action["item"] == "instance_vms": + vm_total += 1 + elif vim_action["item"] == "instance_nets": + net_total += 1 + else: + other_total += 1 + if vim_action["status"] == "FAILED": + return "ERROR", vim_action["error_msg"] + elif vim_action["status"] in ("DONE", "SUPERSEDED", "FINISHED"): + if vim_action["item"] == "instance_vms": + vm_done += 1 + elif vim_action["item"] == "instance_nets": + net_done += 1 + else: + other_done += 1 - for net in ns_descriptor["nets"]: - net_total += 1 - if net["status"] in ("ERROR", "VIM_ERROR"): - return "ERROR", net["error_msg"] - elif net["status"] == "ACTIVE": - net_done += 1 - for vnf in ns_descriptor["vnfs"]: - for vm in vnf["vms"]: - vm_total += 1 - if vm["status"] in ("ERROR", "VIM_ERROR"): - return "ERROR", vm["error_msg"] - elif vm["status"] == "ACTIVE": - vm_done += 1 - - if net_total == net_done and vm_total == vm_done: - return "ACTIVE", "VMs {}, networks: {}".format(vm_total, net_total) + if net_total == net_done and vm_total == vm_done and other_total == other_done: + return "ACTIVE", "VMs {}, networks: {}, other: {} ".format(vm_total, net_total, other_total) else: - return "BUILD", "VMs: {}/{}, networks: {}/{}".format(vm_done, vm_total, net_done, net_total) + return "BUILD", "VMs: {}/{}, networks: {}/{}, other: {}/{}".format(vm_done, vm_total, net_done, net_total, + other_done, other_total) @staticmethod def get_ns_vnf_info(ns_descriptor): """ Get a dict with the VIM_id, ip_addresses, mac_addresses of every vnf and vdu :param ns_descriptor: instance descriptor obtained with self.show("ns", ) - :return: dict with {: {ip_address: XXXX, vdur:{ip_address: XXX, vim_id: XXXX}}} + :return: dict with: + : + ip_address: XXXX, + vdur: + : + ip_address: XXX + vim_id: XXXX + interfaces: + : + ip_address: XXX + mac_address: XXX """ ns_info = {} for vnf in ns_descriptor["vnfs"]: - if not vnf.get("ip_address"): + if not vnf.get("ip_address") and vnf.get("vms"): raise ROClientException("ns member_vnf_index '{}' has no IP address".format( vnf["member_vnf_index"]), http_code=409) vnfr_info = { @@ -316,18 +419,22 @@ class ROClient: for vm in vnf["vms"]: vdur = { "vim_id": vm.get("vim_vm_id"), - "ip_address": vm.get("ip_address") + "ip_address": vm.get("ip_address"), + "interfaces": {} } for iface in vm["interfaces"]: if iface.get("type") == "mgmt" and not iface.get("ip_address"): raise ROClientException("ns member_vnf_index '{}' vm '{}' management interface '{}' has no IP " "address".format(vnf["member_vnf_index"], vm["vdu_osm_id"], iface["external_name"]), http_code=409) + vdur["interfaces"][iface["internal_name"]] = {"ip_address": iface.get("ip_address"), + "mac_address": iface.get("mac_address"), + "vim_id": iface.get("vim_interface_id"), + } vnfr_info["vdur"][vm["vdu_osm_id"]] = vdur ns_info[str(vnf["member_vnf_index"])] = vnfr_info return ns_info - async def _get_item_uuid(self, session, item, item_id_name, all_tenants=False): if all_tenants: tenant_text = "/any" @@ -339,23 +446,23 @@ class ROClient: tenant_text = "/" + self.tenant item_id = 0 - url = "{}{}/{}".format(self.endpoint_url, tenant_text, item) + url = "{}{}/{}".format(self.uri, tenant_text, item) if self.check_if_uuid(item_id_name): item_id = item_id_name url += "/" + item_id_name elif item_id_name and item_id_name.startswith("'") and item_id_name.endswith("'"): item_id_name = item_id_name[1:-1] - self.logger.debug("openmano GET %s", url) - with aiohttp.Timeout(self.timeout_short): - async with session.get(url, headers=self.headers_req) as response: - response_text = await response.read() - self.logger.debug("GET {} [{}] {}".format(url, response.status, response_text[:100])) - if response.status == 404: # NOT_FOUND - raise ROClientException("No {} found with id '{}'".format(item[:-1], item_id_name), - http_code=404) - if response.status >= 300: - raise ROClientException(response_text, http_code=response.status) - content = self._parse_yaml(response_text, response=True) + self.logger.debug("RO GET %s", url) + # timeout = aiohttp.ClientTimeout(total=self.timeout_short) + async with session.get(url, headers=self.headers_req) as response: + response_text = await response.read() + self.logger.debug("GET {} [{}] {}".format(url, response.status, response_text[:100])) + if response.status == 404: # NOT_FOUND + raise ROClientException("No {} found with id '{}'".format(item[:-1], item_id_name), + http_code=404) + if response.status >= 300: + raise ROClientException(self._parse_error_yaml(response_text), http_code=response.status) + content = self._parse_yaml(response_text, response=True) if item_id: return item_id @@ -374,7 +481,7 @@ class ROClient: raise ROClientException("No {} found with name '{}'".format(item[:-1], item_id_name), http_code=404) return uuid - async def _get_item(self, session, item, item_id_name, all_tenants=False): + async def _get_item(self, session, item, item_id_name, extra_item=None, extra_item_id=None, all_tenants=False): if all_tenants: tenant_text = "/any" elif all_tenants is None: @@ -389,15 +496,19 @@ class ROClient: else: # check that exist uuid = await self._get_item_uuid(session, item, item_id_name, all_tenants) - - url = "{}{}/{}/{}".format(self.endpoint_url, tenant_text, item, uuid) - self.logger.debug("GET %s", url ) - with aiohttp.Timeout(self.timeout_short): - async with session.get(url, headers=self.headers_req) as response: - response_text = await response.read() - self.logger.debug("GET {} [{}] {}".format(url, response.status, response_text[:100])) - if response.status >= 300: - raise ROClientException(response_text, http_code=response.status) + + url = "{}{}/{}/{}".format(self.uri, tenant_text, item, uuid) + if extra_item: + url += "/" + extra_item + if extra_item_id: + url += "/" + extra_item_id + self.logger.debug("GET %s", url) + # timeout = aiohttp.ClientTimeout(total=self.timeout_short) + async with session.get(url, headers=self.headers_req) as response: + response_text = await response.read() + self.logger.debug("GET {} [{}] {}".format(url, response.status, response_text[:100])) + if response.status >= 300: + raise ROClientException(self._parse_error_yaml(response_text), http_code=response.status) return self._parse_yaml(response_text, response=True) @@ -405,7 +516,7 @@ class ROClient: if not self.tenant: self.tenant = await self._get_item_uuid(session, "tenants", self.tenant_id_name, None) return self.tenant - + async def _get_datacenter(self, session): if not self.tenant: await self._get_tenant(session) @@ -423,7 +534,7 @@ class ROClient: await self._get_tenant(session) tenant_text = "/" + self.tenant payload_req = yaml.safe_dump(descriptor) - #print payload_req + # print payload_req api_version_text = "" if item == "vnfs": @@ -436,7 +547,7 @@ class ROClient: item = "nsd" if not item_id_name: - uuid="" + uuid = "" elif self.check_if_uuid(item_id_name): uuid = "/{}".format(item_id_name) else: @@ -446,17 +557,17 @@ class ROClient: if not action: action = "" else: - action = "/".format(action) - - url = "{}{apiver}{tenant}/{item}{id}{action}".format(self.endpoint_url, apiver=api_version_text, tenant=tenant_text, - item=item, id=uuid, action=action) - self.logger.debug("openmano POST %s %s", url, payload_req) - with aiohttp.Timeout(self.timeout_large): - async with session.post(url, headers=self.headers_req, data=payload_req) as response: - response_text = await response.read() - self.logger.debug("POST {} [{}] {}".format(url, response.status, response_text[:100])) - if response.status >= 300: - raise ROClientException(response_text, http_code=response.status) + action = "/{}".format(action) + + url = "{}{apiver}{tenant}/{item}{id}{action}".format(self.uri, apiver=api_version_text, + tenant=tenant_text, item=item, id=uuid, action=action) + self.logger.debug("RO POST %s %s", url, payload_req) + # timeout = aiohttp.ClientTimeout(total=self.timeout_large) + async with session.post(url, headers=self.headers_req, data=payload_req) as response: + response_text = await response.read() + self.logger.debug("POST {} [{}] {}".format(url, response.status, response_text[:100])) + if response.status >= 300: + raise ROClientException(self._parse_error_yaml(response_text), http_code=response.status) return self._parse_yaml(response_text, response=True) @@ -472,20 +583,21 @@ class ROClient: if not self.check_if_uuid(item_id_name): # check that exist _all_tenants = all_tenants - if item == "datacenters": + if item in ("datacenters", 'wims'): _all_tenants = True uuid = await self._get_item_uuid(session, item, item_id_name, all_tenants=_all_tenants) else: uuid = item_id_name - - url = "{}{}/{}/{}".format(self.endpoint_url, tenant_text, item, uuid) + + url = "{}{}/{}/{}".format(self.uri, tenant_text, item, uuid) self.logger.debug("DELETE %s", url) - with aiohttp.Timeout(self.timeout_short): - async with session.delete(url, headers=self.headers_req) as response: - response_text = await response.read() - self.logger.debug("DELETE {} [{}] {}".format(url, response.status, response_text[:100])) - if response.status >= 300: - raise ROClientException(response_text, http_code=response.status) + # timeout = aiohttp.ClientTimeout(total=self.timeout_short) + async with session.delete(url, headers=self.headers_req) as response: + response_text = await response.read() + self.logger.debug("DELETE {} [{}] {}".format(url, response.status, response_text[:100])) + if response.status >= 300: + raise ROClientException(self._parse_error_yaml(response_text), http_code=response.status) + return self._parse_yaml(response_text, response=True) async def _list_item(self, session, item, all_tenants=False, filter_dict=None): @@ -497,20 +609,21 @@ class ROClient: if not self.tenant: await self._get_tenant(session) tenant_text = "/" + self.tenant - - url = "{}{}/{}".format(self.endpoint_url, tenant_text, item) + + url = "{}{}/{}".format(self.uri, tenant_text, item) separator = "?" if filter_dict: for k in filter_dict: - url += separator + quote(str(k)) + "=" + quote(str(filter_dict[k])) + url += separator + quote(str(k)) + "=" + quote(str(filter_dict[k])) separator = "&" - self.logger.debug("openmano GET %s", url) - with aiohttp.Timeout(self.timeout_short): - async with session.get(url, headers=self.headers_req) as response: - response_text = await response.read() - self.logger.debug("GET {} [{}] {}".format(url, response.status, response_text[:100])) - if response.status >= 300: - raise ROClientException(response_text, http_code=response.status) + self.logger.debug("RO GET %s", url) + # timeout = aiohttp.ClientTimeout(total=self.timeout_short) + async with session.get(url, headers=self.headers_req) as response: + response_text = await response.read() + self.logger.debug("GET {} [{}] {}".format(url, response.status, response_text[:100])) + if response.status >= 300: + raise ROClientException(self._parse_error_yaml(response_text), http_code=response.status) + return self._parse_yaml(response_text, response=True) async def _edit_item(self, session, item, item_id, descriptor, all_tenants=False): @@ -524,19 +637,49 @@ class ROClient: tenant_text = "/" + self.tenant payload_req = yaml.safe_dump(descriptor) - - #print payload_req - - url = "{}{}/{}/{}".format(self.endpoint_url, tenant_text, item, item_id) - self.logger.debug("openmano PUT %s %s", url, payload_req) - with aiohttp.Timeout(self.timeout_large): - async with session.put(url, headers=self.headers_req, data=payload_req) as response: - response_text = await response.read() - self.logger.debug("PUT {} [{}] {}".format(url, response.status, response_text[:100])) - if response.status >= 300: - raise ROClientException(response_text, http_code=response.status) + + # print payload_req + url = "{}{}/{}/{}".format(self.uri, tenant_text, item, item_id) + self.logger.debug("RO PUT %s %s", url, payload_req) + # timeout = aiohttp.ClientTimeout(total=self.timeout_large) + async with session.put(url, headers=self.headers_req, data=payload_req) as response: + response_text = await response.read() + self.logger.debug("PUT {} [{}] {}".format(url, response.status, response_text[:100])) + if response.status >= 300: + raise ROClientException(self._parse_error_yaml(response_text), http_code=response.status) + return self._parse_yaml(response_text, response=True) + async def get_version(self): + """ + Obtain RO server version. + :return: a list with integers ["major", "minor", "release"]. Raises ROClientException on Error, + """ + try: + response_text = "" + async with aiohttp.ClientSession(loop=self.loop) as session: + url = "{}/version".format(self.uri) + self.logger.debug("RO GET %s", url) + # timeout = aiohttp.ClientTimeout(total=self.timeout_short) + async with session.get(url, headers=self.headers_req) as response: + response_text = await response.read() + self.logger.debug("GET {} [{}] {}".format(url, response.status, response_text[:100])) + if response.status >= 300: + raise ROClientException(self._parse_error_yaml(response_text), http_code=response.status) + + for word in str(response_text).split(" "): + if "." in word: + version_text, _, _ = word.partition("-") + return version_text + raise ROClientException("Got invalid version text: '{}'".format(response_text), http_code=500) + except (aiohttp.ClientOSError, aiohttp.ClientError) as e: + raise ROClientException(e, http_code=504) + except asyncio.TimeoutError: + raise ROClientException("Timeout", http_code=504) + except Exception as e: + raise ROClientException("Got invalid version text: '{}'; causing exception {}".format(response_text, e), + http_code=500) + async def get_list(self, item, all_tenants=False, filter_by=None): """ Obtain a list of items filtering by the specigy filter_by. @@ -550,7 +693,7 @@ class ROClient: raise ROClientException("Invalid item {}".format(item)) if item == 'tenant': all_tenants = None - with aiohttp.ClientSession(loop=self.loop) as session: + async with aiohttp.ClientSession(loop=self.loop) as session: content = await self._list_item(session, self.client_to_RO[item], all_tenants=all_tenants, filter_dict=filter_by) if isinstance(content, dict): @@ -561,14 +704,19 @@ class ROClient: else: raise ROClientException("Output not a list neither dict with len equal 1", http_code=500) return content - except aiohttp.errors.ClientOSError as e: + except (aiohttp.ClientOSError, aiohttp.ClientError) as e: raise ROClientException(e, http_code=504) + except asyncio.TimeoutError: + raise ROClientException("Timeout", http_code=504) - async def show(self, item, item_id_name=None, all_tenants=False): + async def show(self, item, item_id_name=None, extra_item=None, extra_item_id=None, all_tenants=False): """ Obtain the information of an item from its id or name :param item: can be 'tenant', 'vim', 'vnfd', 'nsd', 'ns' :param item_id_name: RO id or name of the item. Raise and exception if more than one found + :param extra_item: if supplied, it is used to add to the URL. + Can be 'action' if item='ns'; 'networks' or'images' if item='vim' + :param extra_item_id: if supplied, it is used get details of a concrete extra_item. :param all_tenants: True if not filtering by tenant. Only allowed for admin :return: dictionary with the information or raises ROClientException on Error, NotFound, found several """ @@ -582,11 +730,14 @@ class ROClient: elif item == 'vim_account': all_tenants = False - with aiohttp.ClientSession(loop=self.loop) as session: - content = await self._get_item(session, self.client_to_RO[item], item_id_name, all_tenants=all_tenants) + async with aiohttp.ClientSession(loop=self.loop) as session: + content = await self._get_item(session, self.client_to_RO[item], item_id_name, extra_item=extra_item, + extra_item_id=extra_item_id, all_tenants=all_tenants) return remove_envelop(item, content) - except aiohttp.errors.ClientOSError as e: + except (aiohttp.ClientOSError, aiohttp.ClientError) as e: raise ROClientException(e, http_code=504) + except asyncio.TimeoutError: + raise ROClientException("Timeout", http_code=504) async def delete(self, item, item_id_name=None, all_tenants=False): """ @@ -599,17 +750,27 @@ class ROClient: try: if item not in self.client_to_RO: raise ROClientException("Invalid item {}".format(item)) - if item == 'tenant' or item == 'vim': + if item in ('tenant', 'vim', 'wim'): all_tenants = None - with aiohttp.ClientSession(loop=self.loop) as session: - return await self._del_item(session, self.client_to_RO[item], item_id_name, all_tenants=all_tenants) - except aiohttp.errors.ClientOSError as e: + async with aiohttp.ClientSession(loop=self.loop) as session: + result = await self._del_item(session, self.client_to_RO[item], item_id_name, all_tenants=all_tenants) + # in case of ns delete, get the action_id embeded in text + if item == "ns" and result.get("result"): + _, _, action_id = result["result"].partition("action_id=") + action_id, _, _ = action_id.partition(" ") + if action_id: + result["action_id"] = action_id + return result + except (aiohttp.ClientOSError, aiohttp.ClientError) as e: raise ROClientException(e, http_code=504) + except asyncio.TimeoutError: + raise ROClientException("Timeout", http_code=504) async def edit(self, item, item_id_name, descriptor=None, descriptor_format=None, **kwargs): """ Edit an item :param item: can be 'tenant', 'vim', 'vnfd', 'nsd', 'ns', 'vim' + :param item_id_name: RO id or name of the item. Raise and exception if more than one found :param descriptor: can be a dict, or a yaml/json text. Autodetect unless descriptor_format is provided :param descriptor_format: Can be 'json' or 'yaml' :param kwargs: Overrides descriptor with values as name, description, vim_url, vim_url_admin, vim_type @@ -637,16 +798,22 @@ class ROClient: create_desc = self._create_envelop(item, desc) - with aiohttp.ClientSession(loop=self.loop) as session: + async with aiohttp.ClientSession(loop=self.loop) as session: _all_tenants = all_tenants if item == 'vim': _all_tenants = True - item_id = await self._get_item_uuid(session, self.client_to_RO[item], item_id_name, all_tenants=_all_tenants) + item_id = await self._get_item_uuid(session, self.client_to_RO[item], item_id_name, + all_tenants=_all_tenants) + if item == 'vim': + _all_tenants = None # await self._get_tenant(session) - outdata = await self._edit_item(session, self.client_to_RO[item], item_id, create_desc, all_tenants=all_tenants) + outdata = await self._edit_item(session, self.client_to_RO[item], item_id, create_desc, + all_tenants=_all_tenants) return remove_envelop(item, outdata) - except aiohttp.errors.ClientOSError as e: + except (aiohttp.ClientOSError, aiohttp.ClientError) as e: raise ROClientException(e, http_code=504) + except asyncio.TimeoutError: + raise ROClientException("Timeout", http_code=504) async def create(self, item, descriptor=None, descriptor_format=None, **kwargs): """ @@ -679,84 +846,165 @@ class ROClient: raise ROClientException("'{}' is mandatory parameter for {}".format(mandatory, item)) all_tenants = False - if item in ('tenant', 'vim'): + if item in ('tenant', 'vim', 'wim'): all_tenants = None create_desc = self._create_envelop(item, desc) - with aiohttp.ClientSession(loop=self.loop) as session: + async with aiohttp.ClientSession(loop=self.loop) as session: outdata = await self._create_item(session, self.client_to_RO[item], create_desc, all_tenants=all_tenants) return remove_envelop(item, outdata) - except aiohttp.errors.ClientOSError as e: + except (aiohttp.ClientOSError, aiohttp.ClientError) as e: raise ROClientException(e, http_code=504) + except asyncio.TimeoutError: + raise ROClientException("Timeout", http_code=504) - async def attach_datacenter(self, datacenter=None, descriptor=None, descriptor_format=None, **kwargs): + async def create_action(self, item, item_id_name, descriptor=None, descriptor_format=None, **kwargs): + """ + Performs an action over an item + :param item: can be 'tenant', 'vnfd', 'nsd', 'ns', 'vim', 'vim_account', 'sdn' + :param item_id_name: RO id or name of the item. Raise and exception if more than one found + :param descriptor: can be a dict, or a yaml/json text. Autodetect unless descriptor_format is provided + :param descriptor_format: Can be 'json' or 'yaml' + :param kwargs: Overrides descriptor with values as name, description, vim_url, vim_url_admin, vim_type + keys can be a dot separated list to specify elements inside dict + :return: dictionary with the information or raises ROClientException on Error + """ + try: + if isinstance(descriptor, str): + descriptor = self._parse(descriptor, descriptor_format) + elif descriptor: + pass + else: + descriptor = {} - if isinstance(descriptor, str): - descriptor = self._parse(descriptor, descriptor_format) - elif descriptor: - pass - else: - descriptor = {} - desc = remove_envelop("vim", descriptor) - - # # check that exist - # uuid = self._get_item_uuid(session, "datacenters", uuid_name, all_tenants=True) - # tenant_text = "/" + self._get_tenant() - if kwargs: - desc = self.update_descriptor(desc, kwargs) - - if not desc.get("vim_tenant_name") and not desc.get("vim_tenant_id"): - raise ROClientException("Wrong descriptor. At least vim_tenant_name or vim_tenant_id must be provided") - create_desc = self._create_envelop("vim", desc) - payload_req = yaml.safe_dump(create_desc) - with aiohttp.ClientSession(loop=self.loop) as session: - # check that exist - item_id = await self._get_item_uuid(session, "datacenters", datacenter, all_tenants=True) - await self._get_tenant(session) + if item not in self.client_to_RO: + raise ROClientException("Invalid item {}".format(item)) + desc = remove_envelop(item, descriptor) + + # Override descriptor with kwargs + if kwargs: + desc = self.update_descriptor(desc, kwargs) + + all_tenants = False + if item in ('tenant', 'vim'): + all_tenants = None + + action = None + if item == "vims": + action = "sdn_mapping" + elif item in ("vim_account", "ns"): + action = "action" + + # create_desc = self._create_envelop(item, desc) + create_desc = desc + + async with aiohttp.ClientSession(loop=self.loop) as session: + _all_tenants = all_tenants + if item == 'vim': + _all_tenants = True + # item_id = await self._get_item_uuid(session, self.client_to_RO[item], item_id_name, + # all_tenants=_all_tenants) + outdata = await self._create_item(session, self.client_to_RO[item], create_desc, + item_id_name=item_id_name, # item_id_name=item_id + action=action, all_tenants=_all_tenants) + return remove_envelop(item, outdata) + except (aiohttp.ClientOSError, aiohttp.ClientError) as e: + raise ROClientException(e, http_code=504) + except asyncio.TimeoutError: + raise ROClientException("Timeout", http_code=504) + + async def attach(self, item, item_id_name=None, descriptor=None, descriptor_format=None, **kwargs): + """ + Attach a datacenter or wim to a tenant, creating a vim_account, wim_account + :param item: can be vim_account or wim_account + :param item_id_name: id or name of the datacenter, wim + :param descriptor: + :param descriptor_format: + :param kwargs: + :return: + """ + try: + if isinstance(descriptor, str): + descriptor = self._parse(descriptor, descriptor_format) + elif descriptor: + pass + else: + descriptor = {} + + desc = remove_envelop(item, descriptor) + + # # check that exist + # uuid = self._get_item_uuid(session, "datacenters", uuid_name, all_tenants=True) + # tenant_text = "/" + self._get_tenant() + if kwargs: + desc = self.update_descriptor(desc, kwargs) + + if item == "vim_account": + if not desc.get("vim_tenant_name") and not desc.get("vim_tenant_id"): + raise ROClientException("Wrong descriptor. At least vim_tenant_name or vim_tenant_id must be " + "provided") + elif item != "wim_account": + raise ROClientException("Attach with unknown item {}. Must be 'vim_account' or 'wim_account'". + format(item)) + create_desc = self._create_envelop(item, desc) + payload_req = yaml.safe_dump(create_desc) + async with aiohttp.ClientSession(loop=self.loop) as session: + # check that exist + item_id = await self._get_item_uuid(session, self.client_to_RO[item], item_id_name, all_tenants=True) + await self._get_tenant(session) - url = "{}/{tenant}/datacenters/{datacenter}".format(self.endpoint_url, tenant=self.tenant, - datacenter=item_id) - self.logger.debug("openmano POST %s %s", url, payload_req) - with aiohttp.Timeout(self.timeout_large): + url = "{}/{tenant}/{item}/{item_id}".format(self.uri, tenant=self.tenant, + item=self.client_to_RO[item], item_id=item_id) + self.logger.debug("RO POST %s %s", url, payload_req) + # timeout = aiohttp.ClientTimeout(total=self.timeout_large) async with session.post(url, headers=self.headers_req, data=payload_req) as response: response_text = await response.read() self.logger.debug("POST {} [{}] {}".format(url, response.status, response_text[:100])) if response.status >= 300: - raise ROClientException(response_text, http_code=response.status) + raise ROClientException(self._parse_error_yaml(response_text), http_code=response.status) - response_desc = self._parse_yaml(response_text, response=True) - desc = remove_envelop("vim", response_desc) - return desc + response_desc = self._parse_yaml(response_text, response=True) + desc = remove_envelop(item, response_desc) + return desc + except (aiohttp.ClientOSError, aiohttp.ClientError) as e: + raise ROClientException(e, http_code=504) + except asyncio.TimeoutError: + raise ROClientException("Timeout", http_code=504) - async def detach_datacenter(self, datacenter=None): - #TODO replace the code with delete_item(vim_account,...) - with aiohttp.ClientSession(loop=self.loop) as session: - # check that exist - item_id = await self._get_item_uuid(session, "datacenters", datacenter, all_tenants=False) - tenant = await self._get_tenant(session) + async def detach(self, item, item_id_name=None): + # TODO replace the code with delete_item(vim_account,...) + try: + async with aiohttp.ClientSession(loop=self.loop) as session: + # check that exist + item_id = await self._get_item_uuid(session, self.client_to_RO[item], item_id_name, all_tenants=False) + tenant = await self._get_tenant(session) - url = "{}/{tenant}/datacenters/{datacenter}".format(self.endpoint_url, tenant=tenant, - datacenter=item_id) - self.logger.debug("openmano DELETE %s", url) - with aiohttp.Timeout(self.timeout_large): + url = "{}/{tenant}/{item}/{datacenter}".format(self.uri, tenant=tenant, + item=self.client_to_RO[item], datacenter=item_id) + self.logger.debug("RO DELETE %s", url) + + # timeout = aiohttp.ClientTimeout(total=self.timeout_large) async with session.delete(url, headers=self.headers_req) as response: response_text = await response.read() self.logger.debug("DELETE {} [{}] {}".format(url, response.status, response_text[:100])) if response.status >= 300: - raise ROClientException(response_text, http_code=response.status) - - response_desc = self._parse_yaml(response_text, response=True) - desc = remove_envelop("vim", response_desc) - return desc + raise ROClientException(self._parse_error_yaml(response_text), http_code=response.status) + response_desc = self._parse_yaml(response_text, response=True) + desc = remove_envelop(item, response_desc) + return desc + except (aiohttp.ClientOSError, aiohttp.ClientError) as e: + raise ROClientException(e, http_code=504) + except asyncio.TimeoutError: + raise ROClientException("Timeout", http_code=504) # TODO convert to asyncio + # DATACENTERS - #DATACENTERS - - def edit_datacenter(self, uuid=None, name=None, descriptor=None, descriptor_format=None, all_tenants=False, **kwargs): + def edit_datacenter(self, uuid=None, name=None, descriptor=None, descriptor_format=None, all_tenants=False, + **kwargs): """Edit the parameters of a datacenter Params: must supply a descriptor or/and a parameter to change uuid or/and name. If only name is supplied, there must be only one or an exception is raised @@ -778,19 +1026,18 @@ class ROClient: elif descriptor: pass elif kwargs: - descriptor={"datacenter": {}} + descriptor = {"datacenter": {}} else: raise ROClientException("Missing descriptor") - if 'datacenter' not in descriptor or len(descriptor)!=1: + if 'datacenter' not in descriptor or len(descriptor) != 1: raise ROClientException("Descriptor must contain only one 'datacenter' field") for param in kwargs: - if param=='new_name': + if param == 'new_name': descriptor['datacenter']['name'] = kwargs[param] else: descriptor['datacenter'][param] = kwargs[param] return self._edit_item("datacenters", descriptor, uuid, name, all_tenants=None) - def edit_scenario(self, uuid=None, name=None, descriptor=None, descriptor_format=None, all_tenants=False, **kwargs): """Edit the parameters of a scenario @@ -812,114 +1059,115 @@ class ROClient: elif descriptor: pass elif kwargs: - descriptor={"scenario": {}} + descriptor = {"scenario": {}} else: raise ROClientException("Missing descriptor") - if 'scenario' not in descriptor or len(descriptor)>2: + if 'scenario' not in descriptor or len(descriptor) > 2: raise ROClientException("Descriptor must contain only one 'scenario' field") for param in kwargs: - if param=='new_name': + if param == 'new_name': descriptor['scenario']['name'] = kwargs[param] else: descriptor['scenario'][param] = kwargs[param] return self._edit_item("scenarios", descriptor, uuid, name, all_tenants=None) - #VIM ACTIONS + # VIM ACTIONS def vim_action(self, action, item, uuid=None, all_tenants=False, **kwargs): """Perform an action over a vim - Params: + Params: action: can be 'list', 'get'/'show', 'delete' or 'create' item: can be 'tenants' or 'networks' uuid: uuid of the tenant/net to show or to delete. Ignore otherwise other parameters: - datacenter_name, datacenter_id: datacenters to act on, if missing uses classes store datacenter - descriptor, descriptor_format: descriptor needed on creation, can be a dict or a yaml/json str + datacenter_name, datacenter_id: datacenters to act on, if missing uses classes store datacenter + descriptor, descriptor_format: descriptor needed on creation, can be a dict or a yaml/json str must be a dictionary or a json/yaml text. name: for created tenant/net Overwrite descriptor name if any description: tenant descriptor. Overwrite descriptor description if any - + Return: Raises an exception on error Obtain a dictionary with format {'tenant':{new_tenant_info}} """ + session = None # TODO remove when changed to asyncio if item not in ("tenants", "networks", "images"): raise ROClientException("Unknown value for item '{}', must be 'tenants', 'nets' or " - "images".format(str(item))) + "images".format(str(item))) - image_actions = ['list','get','show','delete'] + image_actions = ['list', 'get', 'show', 'delete'] if item == "images" and action not in image_actions: raise ROClientException("Only available actions for item '{}' are {}\n" - "Requested action was '{}'".format(item, ', '.join(image_actions), action)) + "Requested action was '{}'".format(item, ', '.join(image_actions), action)) if all_tenants: tenant_text = "/any" else: - tenant_text = "/"+self._get_tenant() - + tenant_text = "/" + self._get_tenant() + if "datacenter_id" in kwargs or "datacenter_name" in kwargs: datacenter = self._get_item_uuid(session, "datacenters", kwargs.get("datacenter"), all_tenants=all_tenants) else: datacenter = self.get_datacenter(session) - if action=="list": - url = "{}{}/vim/{}/{}".format(self.endpoint_url, tenant_text, datacenter, item) - self.logger.debug("GET %s", url ) + if action == "list": + url = "{}{}/vim/{}/{}".format(self.uri, tenant_text, datacenter, item) + self.logger.debug("GET %s", url) mano_response = requests.get(url, headers=self.headers_req) - self.logger.debug("openmano response: %s", mano_response.text ) - content = self._parse_yaml(mano_response.text, response=True) - if mano_response.status_code==200: + self.logger.debug("RO response: %s", mano_response.text) + content = self._parse_yaml(mano_response.text, response=True) + if mano_response.status_code == 200: return content else: - raise ROClientException(str(content), http_code=mano_response.status) - elif action=="get" or action=="show": - url = "{}{}/vim/{}/{}/{}".format(self.endpoint_url, tenant_text, datacenter, item, uuid) - self.logger.debug("GET %s", url ) + raise ROClientException(str(content), http_code=mano_response.status) + elif action == "get" or action == "show": + url = "{}{}/vim/{}/{}/{}".format(self.uri, tenant_text, datacenter, item, uuid) + self.logger.debug("GET %s", url) mano_response = requests.get(url, headers=self.headers_req) - self.logger.debug("openmano response: %s", mano_response.text ) - content = self._parse_yaml(mano_response.text, response=True) - if mano_response.status_code==200: + self.logger.debug("RO response: %s", mano_response.text) + content = self._parse_yaml(mano_response.text, response=True) + if mano_response.status_code == 200: return content else: - raise ROClientException(str(content), http_code=mano_response.status) - elif action=="delete": - url = "{}{}/vim/{}/{}/{}".format(self.endpoint_url, tenant_text, datacenter, item, uuid) - self.logger.debug("DELETE %s", url ) + raise ROClientException(str(content), http_code=mano_response.status) + elif action == "delete": + url = "{}{}/vim/{}/{}/{}".format(self.uri, tenant_text, datacenter, item, uuid) + self.logger.debug("DELETE %s", url) mano_response = requests.delete(url, headers=self.headers_req) - self.logger.debug("openmano response: %s", mano_response.text ) - content = self._parse_yaml(mano_response.text, response=True) - if mano_response.status_code==200: + self.logger.debug("RO response: %s", mano_response.text) + content = self._parse_yaml(mano_response.text, response=True) + if mano_response.status_code == 200: return content else: - raise ROClientException(str(content), http_code=mano_response.status) - elif action=="create": + raise ROClientException(str(content), http_code=mano_response.status) + elif action == "create": if "descriptor" in kwargs: if isinstance(kwargs["descriptor"], str): - descriptor = self._parse(kwargs["descriptor"], kwargs.get("descriptor_format") ) + descriptor = self._parse(kwargs["descriptor"], kwargs.get("descriptor_format")) else: descriptor = kwargs["descriptor"] elif "name" in kwargs: - descriptor={item[:-1]: {"name": kwargs["name"]}} + descriptor = {item[:-1]: {"name": kwargs["name"]}} else: raise ROClientException("Missing descriptor") - - if item[:-1] not in descriptor or len(descriptor)!=1: + + if item[:-1] not in descriptor or len(descriptor) != 1: raise ROClientException("Descriptor must contain only one 'tenant' field") if "name" in kwargs: - descriptor[ item[:-1] ]['name'] = kwargs["name"] + descriptor[item[:-1]]['name'] = kwargs["name"] if "description" in kwargs: - descriptor[ item[:-1] ]['description'] = kwargs["description"] + descriptor[item[:-1]]['description'] = kwargs["description"] payload_req = yaml.safe_dump(descriptor) - #print payload_req - url = "{}{}/vim/{}/{}".format(self.endpoint_url, tenant_text, datacenter, item) - self.logger.debug("openmano POST %s %s", url, payload_req) - mano_response = requests.post(url, headers = self.headers_req, data=payload_req) - self.logger.debug("openmano response: %s", mano_response.text ) + # print payload_req + url = "{}{}/vim/{}/{}".format(self.uri, tenant_text, datacenter, item) + self.logger.debug("RO POST %s %s", url, payload_req) + mano_response = requests.post(url, headers=self.headers_req, data=payload_req) + self.logger.debug("RO response: %s", mano_response.text) content = self._parse_yaml(mano_response.text, response=True) - if mano_response.status_code==200: + if mano_response.status_code == 200: return content else: raise ROClientException(str(content), http_code=mano_response.status) else: - raise ROClientException("Unknown value for action '{}".format(str(action))) + raise ROClientException("Unknown value for action '{}".format(str(action))) if __name__ == '__main__': @@ -941,7 +1189,7 @@ if __name__ == '__main__': tenant_id = None vim_id = False loop = asyncio.get_event_loop() - myClient = ROClient(endpoint_url=RO_URL, loop=loop, loglevel="DEBUG") + myClient = ROClient(uri=RO_URL, loop=loop, loglevel="DEBUG") try: # test tenant content = loop.run_until_complete(myClient.get_list("tenant")) @@ -950,20 +1198,20 @@ if __name__ == '__main__': tenant_id = True content = loop.run_until_complete(myClient.show("tenant", TEST_TENANT)) print("tenant", TEST_TENANT, content) - content = loop.run_until_complete(myClient.edit("tenant", TEST_TENANT, description="another description")) + content = loop.run_until_complete(myClient.edit("tenant", TEST_TENANT, description="another description")) content = loop.run_until_complete(myClient.show("tenant", TEST_TENANT)) print("tenant edited", TEST_TENANT, content) myClient["tenant"] = TEST_TENANT - # test VIM - content = loop.run_until_complete(myClient.create("vim", name=TEST_VIM1, type=TEST_TYPE1, vim_url=TEST_URL1, config=TEST_CONFIG1)) + content = loop.run_until_complete(myClient.create("vim", name=TEST_VIM1, type=TEST_TYPE1, vim_url=TEST_URL1, + config=TEST_CONFIG1)) vim_id = True content = loop.run_until_complete(myClient.get_list("vim")) print("vim", content) content = loop.run_until_complete(myClient.show("vim", TEST_VIM1)) print("vim", TEST_VIM1, content) - content = loop.run_until_complete(myClient.edit("vim", TEST_VIM1, description="another description", + content = loop.run_until_complete(myClient.edit("vim", TEST_VIM1, description="another description", name=TEST_VIM2, type=TEST_TYPE2, vim_url=TEST_URL2, config=TEST_CONFIG2)) content = loop.run_until_complete(myClient.show("vim", TEST_VIM2)) @@ -971,14 +1219,16 @@ if __name__ == '__main__': # test VIM_ACCOUNT content = loop.run_until_complete(myClient.attach_datacenter(TEST_VIM2, vim_username='user', - vim_password='pass', vim_tenant_name='vimtenant1', config=TEST_CONFIG1)) + vim_password='pass', vim_tenant_name='vimtenant1', + config=TEST_CONFIG1)) vim_id = True content = loop.run_until_complete(myClient.get_list("vim_account")) print("vim_account", content) content = loop.run_until_complete(myClient.show("vim_account", TEST_VIM2)) print("vim_account", TEST_VIM2, content) - content = loop.run_until_complete(myClient.edit("vim_account", TEST_VIM2, vim_username='user2', vim_password='pass2', - vim_tenant_name="vimtenant2", config=TEST_CONFIG2)) + content = loop.run_until_complete(myClient.edit("vim_account", TEST_VIM2, vim_username='user2', + vim_password='pass2', vim_tenant_name="vimtenant2", + config=TEST_CONFIG2)) content = loop.run_until_complete(myClient.show("vim_account", TEST_VIM2)) print("vim_account edited", TEST_VIM2, content) @@ -1000,5 +1250,3 @@ if __name__ == '__main__': logger.error("Error {}".format(e), exc_info=True) loop.close() - -