2 # -*- coding: utf-8 -*-
5 # Copyright 2015 Telefónica Investigación y Desarrollo, S.A.U.
7 # Licensed under the Apache License, Version 2.0 (the "License"); you may
8 # not use this file except in compliance with the License. You may obtain
9 # a copy of the License at
11 # http://www.apache.org/licenses/LICENSE-2.0
13 # Unless required by applicable law or agreed to in writing, software
14 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
16 # License for the specific language governing permissions and limitations
22 asyncio RO python client to interact with RO-server
30 from urllib
.parse
import quote
32 from copy
import deepcopy
34 __author__
= "Alfonso Tierno"
35 __date__
= "$09-Jan-2018 09:09:48$"
37 version_date
= "2018-05-16"
41 class ROClientException(Exception):
42 def __init__(self
, message
, http_code
=400):
43 """Common Exception for all RO client exceptions"""
44 self
.http_code
= http_code
45 Exception.__init
__(self
, message
)
48 def remove_envelop(item
, indata
=None):
50 Obtain the useful data removing the envelop. It goes through the vnfd or nsd catalog and returns the
52 :param item: can be 'tenant', 'vim', 'vnfd', 'nsd', 'ns'
53 :param indata: Content to be inspected
54 :return: the useful part of indata (a reference, not a new dictionay)
60 if clean_indata
.get('vnfd:vnfd-catalog'):
61 clean_indata
= clean_indata
['vnfd:vnfd-catalog']
62 elif clean_indata
.get('vnfd-catalog'):
63 clean_indata
= clean_indata
['vnfd-catalog']
64 if clean_indata
.get('vnfd'):
65 if not isinstance(clean_indata
['vnfd'], list) or len(clean_indata
['vnfd']) != 1:
66 raise ROClientException("'vnfd' must be a list only one element")
67 clean_indata
= clean_indata
['vnfd'][0]
69 if clean_indata
.get('nsd:nsd-catalog'):
70 clean_indata
= clean_indata
['nsd:nsd-catalog']
71 elif clean_indata
.get('nsd-catalog'):
72 clean_indata
= clean_indata
['nsd-catalog']
73 if clean_indata
.get('nsd'):
74 if not isinstance(clean_indata
['nsd'], list) or len(clean_indata
['nsd']) != 1:
75 raise ROClientException("'nsd' must be a list only one element")
76 clean_indata
= clean_indata
['nsd'][0]
78 if len(indata
) == 1 and "sdn_controller" in indata
:
79 clean_indata
= indata
["sdn_controller"]
80 elif item
== "tenant":
81 if len(indata
) == 1 and "tenant" in indata
:
82 clean_indata
= indata
["tenant"]
83 elif item
in ("vim", "vim_account", "datacenters"):
84 if len(indata
) == 1 and "datacenter" in indata
:
85 clean_indata
= indata
["datacenter"]
87 if len(indata
) == 1 and "wim" in indata
:
88 clean_indata
= indata
["wim"]
89 elif item
== "wim_account":
90 if len(indata
) == 1 and "wim_account" in indata
:
91 clean_indata
= indata
["wim_account"]
92 elif item
== "ns" or item
== "instances":
93 if len(indata
) == 1 and "instance" in indata
:
94 clean_indata
= indata
["instance"]
96 assert False, "remove_envelop with unknown item {}".format(item
)
102 headers_req
= {'Accept': 'application/yaml', 'content-type': 'application/yaml'}
103 client_to_RO
= {'tenant': 'tenants', 'vim': 'datacenters', 'vim_account': 'datacenters', 'sdn': 'sdn_controllers',
104 'vnfd': 'vnfs', 'nsd': 'scenarios', 'wim': 'wims', 'wim_account': 'wims',
106 mandatory_for_create
= {
107 'tenant': ("name", ),
108 'vnfd': ("name", "id"),
109 'nsd': ("name", "id"),
110 'ns': ("name", "scenario", "datacenter"),
111 'vim': ("name", "vim_url"),
112 'wim': ("name", "wim_url"),
115 'sdn': ("name", 'type'),
120 def __init__(self
, loop
, uri
, **kwargs
):
124 self
.username
= kwargs
.get("username")
125 self
.password
= kwargs
.get("password")
126 self
.tenant_id_name
= kwargs
.get("tenant")
128 self
.datacenter_id_name
= kwargs
.get("datacenter")
129 self
.datacenter
= None
130 logger_name
= kwargs
.get('logger_name', 'lcm.ro')
131 self
.logger
= logging
.getLogger(logger_name
)
132 if kwargs
.get("loglevel"):
133 self
.logger
.setLevel(kwargs
["loglevel"])
135 requests
= kwargs
.get("TODO remove")
137 def __getitem__(self
, index
):
138 if index
== 'tenant':
139 return self
.tenant_id_name
140 elif index
== 'datacenter':
141 return self
.datacenter_id_name
142 elif index
== 'username':
144 elif index
== 'password':
149 raise KeyError("Invalid key '{}'".format(index
))
151 def __setitem__(self
, index
, value
):
152 if index
== 'tenant':
153 self
.tenant_id_name
= value
154 elif index
== 'datacenter' or index
== 'vim':
155 self
.datacenter_id_name
= value
156 elif index
== 'username':
157 self
.username
= value
158 elif index
== 'password':
159 self
.password
= value
163 raise KeyError("Invalid key '{}'".format(index
))
164 self
.tenant
= None # force to reload tenant with different credentials
165 self
.datacenter
= None # force to reload datacenter with different credentials
167 def _parse(self
, descriptor
, descriptor_format
, response
=False):
168 if descriptor_format
and descriptor_format
!= "json" and descriptor_format
!= "yaml":
169 raise ROClientException("'descriptor_format' must be a 'json' or 'yaml' text")
170 if descriptor_format
!= "json":
172 return yaml
.load(descriptor
)
173 except yaml
.YAMLError
as exc
:
175 if hasattr(exc
, 'problem_mark'):
176 mark
= exc
.problem_mark
177 error_pos
= " at line:{} column:{}s".format(mark
.line
+ 1, mark
.column
+ 1)
178 error_text
= "yaml format error" + error_pos
179 elif descriptor_format
!= "yaml":
181 return json
.loads(descriptor
)
182 except Exception as e
:
184 error_text
= "json format error" + str(e
)
187 raise ROClientException(error_text
)
188 raise ROClientException(error_text
)
190 def _parse_yaml(self
, descriptor
, response
=False):
192 return yaml
.load(descriptor
, Loader
=yaml
.Loader
)
193 except yaml
.YAMLError
as exc
:
195 if hasattr(exc
, 'problem_mark'):
196 mark
= exc
.problem_mark
197 error_pos
= " at line:{} column:{}s".format(mark
.line
+ 1, mark
.column
+ 1)
198 error_text
= "yaml format error" + error_pos
200 raise ROClientException(error_text
)
201 raise ROClientException(error_text
)
204 def check_if_uuid(uuid_text
):
206 Check if text correspond to an uuid foramt
208 :return: True if it is an uuid False if not
217 def _create_envelop(item
, indata
=None):
219 Returns a new dict that incledes indata with the expected envelop
220 :param item: can be 'tenant', 'vim', 'vnfd', 'nsd', 'ns'
221 :param indata: Content to be enveloped
222 :return: a new dic with {<envelop>: {indata} } where envelop can be e.g. tenant, datacenter, ...
225 return {'vnfd-catalog': {'vnfd': [indata
]}}
227 return {'nsd-catalog': {'nsd': [indata
]}}
228 elif item
== "tenant":
229 return {'tenant': indata
}
230 elif item
in ("vim", "vim_account", "datacenter"):
231 return {'datacenter': indata
}
233 return {'wim': indata
}
234 elif item
== "wim_account":
235 return {'wim_account': indata
}
236 elif item
== "ns" or item
== "instances":
237 return {'instance': indata
}
239 return {'sdn_controller': indata
}
241 assert False, "_create_envelop with unknown item {}".format(item
)
244 def update_descriptor(desc
, kwargs
):
245 desc
= deepcopy(desc
) # do not modify original descriptor
247 for k
, v
in kwargs
.items():
248 update_content
= desc
252 if kitem_old
is not None:
253 update_content
= update_content
[kitem_old
]
254 if isinstance(update_content
, dict):
256 elif isinstance(update_content
, list):
257 kitem_old
= int(kitem
)
259 raise ROClientException(
260 "Invalid query string '{}'. Descriptor is not a list nor dict at '{}'".format(k
, kitem
))
261 if v
== "__DELETE__":
262 del update_content
[kitem_old
]
264 update_content
[kitem_old
] = v
267 raise ROClientException(
268 "Invalid query string '{}'. Descriptor does not contain '{}'".format(k
, kitem_old
))
270 raise ROClientException("Invalid query string '{}'. Expected integer index list instead of '{}'".format(
273 raise ROClientException(
274 "Invalid query string '{}'. Index '{}' out of range".format(k
, kitem_old
))
277 def check_ns_status(ns_descriptor
):
279 Inspect RO instance descriptor and indicates the status
280 :param ns_descriptor: instance descriptor obtained with self.show("ns", )
281 :return: status, message: status can be BUILD,ACTIVE,ERROR, message is a text message
284 total
= {"VMs": 0, "networks": 0, "SDN_networks": 0}
285 done
= {"VMs": 0, "networks": 0, "SDN_networks": 0}
288 # return an identification for the network or vm. Try vim_id if exist, if not descriptor id for net
289 if desc
.get("vim_net_id"):
290 return "'vim-id={}'".format(desc
["vim_net_id"])
291 elif desc
.get("ns_net_osm_id"):
292 return "'nsd-vld-id={}'".format(desc
["ns_net_osm_id"])
293 elif desc
.get("vnf_net_osm_id"):
294 return "'vnfd-vld-id={}'".format(desc
["vnf_net_osm_id"])
296 elif desc
.get("vim_vm_id"):
297 return "'vim-id={}'".format(desc
["vim_vm_id"])
298 elif desc
.get("vdu_osm_id"):
299 return "'vnfd-vdu-id={}'".format(desc
["vdu_osm_id"])
303 def _get_sdn_ref(sce_net_id
):
304 # look for the network associated to the SDN network and obtain the identification
305 net
= next((x
for x
in ns_descriptor
["nets"] if x
.get("sce_net_id") == sce_net_id
), None)
306 if not sce_net_id
or not net
:
311 total
["networks"] = len(ns_descriptor
["nets"])
312 for net
in ns_descriptor
["nets"]:
313 if net
["status"] in ("ERROR", "VIM_ERROR"):
314 error_list
.append("VIM network ({}) on error: {}".format(_get_ref(net
), net
["error_msg"]))
315 elif net
["status"] == "ACTIVE":
316 done
["networks"] += 1
318 total
["SDN_networks"] = len(ns_descriptor
["sdn_nets"])
319 for sdn_net
in ns_descriptor
["sdn_nets"]:
320 if sdn_net
["status"] in ("ERROR", "VIM_ERROR", "WIM_ERROR"):
321 error_list
.append("SDN network ({}) on error: {}".format(_get_sdn_ref(sdn_net
.get("sce_net_id")),
322 sdn_net
["error_msg"]))
323 elif sdn_net
["status"] == "ACTIVE":
324 done
["SDN_networks"] += 1
326 for vnf
in ns_descriptor
["vnfs"]:
327 for vm
in vnf
["vms"]:
329 if vm
["status"] in ("ERROR", "VIM_ERROR"):
330 error_list
.append("VIM VM ({}) on error: {}".format(_get_ref(vm
), vm
["error_msg"]))
331 elif vm
["status"] == "ACTIVE":
334 return "ERROR", "; ".join(error_list
)
335 if all(total
[x
] == done
[x
] for x
in total
): # DONE == TOTAL for all items
336 return "ACTIVE", str({x
: total
[x
] for x
in total
if total
[x
]}) # print only those which value is not 0
338 return "BUILD", str({x
: "{}/{}".format(done
[x
], total
[x
]) for x
in total
if total
[x
]})
339 # print done/total for each item if total is not 0
340 except Exception as e
:
341 raise ROClientException("Unexpected RO ns descriptor. Wrong version? {}".format(e
)) from e
344 def check_action_status(action_descriptor
):
346 Inspect RO instance descriptor and indicates the status
347 :param action_descriptor: action instance descriptor obtained with self.show("ns", "action")
348 :return: status, message: status can be BUILD,ACTIVE,ERROR, message is a text message
357 for vim_action_set
in action_descriptor
["actions"]:
358 for vim_action
in vim_action_set
["vim_wim_actions"]:
359 if vim_action
["item"] == "instance_vms":
361 elif vim_action
["item"] == "instance_nets":
365 if vim_action
["status"] == "FAILED":
366 return "ERROR", vim_action
["error_msg"]
367 elif vim_action
["status"] in ("DONE", "SUPERSEDED", "FINISHED"):
368 if vim_action
["item"] == "instance_vms":
370 elif vim_action
["item"] == "instance_nets":
375 if net_total
== net_done
and vm_total
== vm_done
and other_total
== other_done
:
376 return "ACTIVE", "VMs {}, networks: {}, other: {} ".format(vm_total
, net_total
, other_total
)
378 return "BUILD", "VMs: {}/{}, networks: {}/{}, other: {}/{}".format(vm_done
, vm_total
, net_done
, net_total
,
379 other_done
, other_total
)
382 def get_ns_vnf_info(ns_descriptor
):
384 Get a dict with the VIM_id, ip_addresses, mac_addresses of every vnf and vdu
385 :param ns_descriptor: instance descriptor obtained with self.show("ns", )
399 for vnf
in ns_descriptor
["vnfs"]:
400 if not vnf
.get("ip_address") and vnf
.get("vms"):
401 raise ROClientException("ns member_vnf_index '{}' has no IP address".format(
402 vnf
["member_vnf_index"]), http_code
=409)
404 "ip_address": vnf
.get("ip_address"),
407 for vm
in vnf
["vms"]:
409 "vim_id": vm
.get("vim_vm_id"),
410 "ip_address": vm
.get("ip_address"),
413 for iface
in vm
["interfaces"]:
414 if iface
.get("type") == "mgmt" and not iface
.get("ip_address"):
415 raise ROClientException("ns member_vnf_index '{}' vm '{}' management interface '{}' has no IP "
416 "address".format(vnf
["member_vnf_index"], vm
["vdu_osm_id"],
417 iface
["external_name"]), http_code
=409)
418 vdur
["interfaces"][iface
["internal_name"]] = {"ip_address": iface
.get("ip_address"),
419 "mac_address": iface
.get("mac_address"),
420 "vim_id": iface
.get("vim_interface_id"),
422 vnfr_info
["vdur"][vm
["vdu_osm_id"]] = vdur
423 ns_info
[str(vnf
["member_vnf_index"])] = vnfr_info
426 async def _get_item_uuid(self
, session
, item
, item_id_name
, all_tenants
=False):
429 elif all_tenants
is None:
433 await self
._get
_tenant
(session
)
434 tenant_text
= "/" + self
.tenant
437 url
= "{}{}/{}".format(self
.uri
, tenant_text
, item
)
438 if self
.check_if_uuid(item_id_name
):
439 item_id
= item_id_name
440 url
+= "/" + item_id_name
441 elif item_id_name
and item_id_name
.startswith("'") and item_id_name
.endswith("'"):
442 item_id_name
= item_id_name
[1:-1]
443 self
.logger
.debug("RO GET %s", url
)
444 # timeout = aiohttp.ClientTimeout(total=self.timeout_short)
445 async with session
.get(url
, headers
=self
.headers_req
) as response
:
446 response_text
= await response
.read()
447 self
.logger
.debug("GET {} [{}] {}".format(url
, response
.status
, response_text
[:100]))
448 if response
.status
== 404: # NOT_FOUND
449 raise ROClientException("No {} found with id '{}'".format(item
[:-1], item_id_name
),
451 if response
.status
>= 300:
452 raise ROClientException(response_text
, http_code
=response
.status
)
453 content
= self
._parse
_yaml
(response_text
, response
=True)
458 assert isinstance(desc
, list), "_get_item_uuid get a non dict with a list inside {}".format(type(desc
))
461 if item_id_name
and i
["name"] != item_id_name
:
463 if uuid
: # found more than one
464 raise ROClientException(
465 "Found more than one {} with name '{}'. uuid must be used".format(item
, item_id_name
),
469 raise ROClientException("No {} found with name '{}'".format(item
[:-1], item_id_name
), http_code
=404)
472 async def _get_item(self
, session
, item
, item_id_name
, extra_item
=None, extra_item_id
=None, all_tenants
=False):
475 elif all_tenants
is None:
479 await self
._get
_tenant
(session
)
480 tenant_text
= "/" + self
.tenant
482 if self
.check_if_uuid(item_id_name
):
486 uuid
= await self
._get
_item
_uuid
(session
, item
, item_id_name
, all_tenants
)
488 url
= "{}{}/{}/{}".format(self
.uri
, tenant_text
, item
, uuid
)
490 url
+= "/" + extra_item
492 url
+= "/" + extra_item_id
493 self
.logger
.debug("GET %s", url
)
494 # timeout = aiohttp.ClientTimeout(total=self.timeout_short)
495 async with session
.get(url
, headers
=self
.headers_req
) as response
:
496 response_text
= await response
.read()
497 self
.logger
.debug("GET {} [{}] {}".format(url
, response
.status
, response_text
[:100]))
498 if response
.status
>= 300:
499 raise ROClientException(response_text
, http_code
=response
.status
)
501 return self
._parse
_yaml
(response_text
, response
=True)
503 async def _get_tenant(self
, session
):
505 self
.tenant
= await self
._get
_item
_uuid
(session
, "tenants", self
.tenant_id_name
, None)
508 async def _get_datacenter(self
, session
):
510 await self
._get
_tenant
(session
)
511 if not self
.datacenter
:
512 self
.datacenter
= await self
._get
_item
_uuid
(session
, "datacenters", self
.datacenter_id_name
, True)
513 return self
.datacenter
515 async def _create_item(self
, session
, item
, descriptor
, item_id_name
=None, action
=None, all_tenants
=False):
518 elif all_tenants
is None:
522 await self
._get
_tenant
(session
)
523 tenant_text
= "/" + self
.tenant
524 payload_req
= yaml
.safe_dump(descriptor
)
527 api_version_text
= ""
529 # assumes version v3 only
530 api_version_text
= "/v3"
532 elif item
== "scenarios":
533 # assumes version v3 only
534 api_version_text
= "/v3"
539 elif self
.check_if_uuid(item_id_name
):
540 uuid
= "/{}".format(item_id_name
)
543 uuid
= await self
._get
_item
_uuid
(session
, item
, item_id_name
, all_tenants
)
544 uuid
= "/{}".format(uuid
)
548 action
= "/{}".format(action
)
550 url
= "{}{apiver}{tenant}/{item}{id}{action}".format(self
.uri
, apiver
=api_version_text
,
551 tenant
=tenant_text
, item
=item
, id=uuid
, action
=action
)
552 self
.logger
.debug("RO POST %s %s", url
, payload_req
)
553 # timeout = aiohttp.ClientTimeout(total=self.timeout_large)
554 async with session
.post(url
, headers
=self
.headers_req
, data
=payload_req
) as response
:
555 response_text
= await response
.read()
556 self
.logger
.debug("POST {} [{}] {}".format(url
, response
.status
, response_text
[:100]))
557 if response
.status
>= 300:
558 raise ROClientException(response_text
, http_code
=response
.status
)
560 return self
._parse
_yaml
(response_text
, response
=True)
562 async def _del_item(self
, session
, item
, item_id_name
, all_tenants
=False):
565 elif all_tenants
is None:
569 await self
._get
_tenant
(session
)
570 tenant_text
= "/" + self
.tenant
571 if not self
.check_if_uuid(item_id_name
):
573 _all_tenants
= all_tenants
574 if item
in ("datacenters", 'wims'):
576 uuid
= await self
._get
_item
_uuid
(session
, item
, item_id_name
, all_tenants
=_all_tenants
)
580 url
= "{}{}/{}/{}".format(self
.uri
, tenant_text
, item
, uuid
)
581 self
.logger
.debug("DELETE %s", url
)
582 # timeout = aiohttp.ClientTimeout(total=self.timeout_short)
583 async with session
.delete(url
, headers
=self
.headers_req
) as response
:
584 response_text
= await response
.read()
585 self
.logger
.debug("DELETE {} [{}] {}".format(url
, response
.status
, response_text
[:100]))
586 if response
.status
>= 300:
587 raise ROClientException(response_text
, http_code
=response
.status
)
589 return self
._parse
_yaml
(response_text
, response
=True)
591 async def _list_item(self
, session
, item
, all_tenants
=False, filter_dict
=None):
594 elif all_tenants
is None:
598 await self
._get
_tenant
(session
)
599 tenant_text
= "/" + self
.tenant
601 url
= "{}{}/{}".format(self
.uri
, tenant_text
, item
)
604 for k
in filter_dict
:
605 url
+= separator
+ quote(str(k
)) + "=" + quote(str(filter_dict
[k
]))
607 self
.logger
.debug("RO GET %s", url
)
608 # timeout = aiohttp.ClientTimeout(total=self.timeout_short)
609 async with session
.get(url
, headers
=self
.headers_req
) as response
:
610 response_text
= await response
.read()
611 self
.logger
.debug("GET {} [{}] {}".format(url
, response
.status
, response_text
[:100]))
612 if response
.status
>= 300:
613 raise ROClientException(response_text
, http_code
=response
.status
)
615 return self
._parse
_yaml
(response_text
, response
=True)
617 async def _edit_item(self
, session
, item
, item_id
, descriptor
, all_tenants
=False):
620 elif all_tenants
is None:
624 await self
._get
_tenant
(session
)
625 tenant_text
= "/" + self
.tenant
627 payload_req
= yaml
.safe_dump(descriptor
)
630 url
= "{}{}/{}/{}".format(self
.uri
, tenant_text
, item
, item_id
)
631 self
.logger
.debug("RO PUT %s %s", url
, payload_req
)
632 # timeout = aiohttp.ClientTimeout(total=self.timeout_large)
633 async with session
.put(url
, headers
=self
.headers_req
, data
=payload_req
) as response
:
634 response_text
= await response
.read()
635 self
.logger
.debug("PUT {} [{}] {}".format(url
, response
.status
, response_text
[:100]))
636 if response
.status
>= 300:
637 raise ROClientException(response_text
, http_code
=response
.status
)
639 return self
._parse
_yaml
(response_text
, response
=True)
641 async def get_version(self
):
643 Obtain RO server version.
644 :return: a list with integers ["major", "minor", "release"]. Raises ROClientException on Error,
648 async with aiohttp
.ClientSession(loop
=self
.loop
) as session
:
649 url
= "{}/version".format(self
.uri
)
650 self
.logger
.debug("RO GET %s", url
)
651 # timeout = aiohttp.ClientTimeout(total=self.timeout_short)
652 async with session
.get(url
, headers
=self
.headers_req
) as response
:
653 response_text
= await response
.read()
654 self
.logger
.debug("GET {} [{}] {}".format(url
, response
.status
, response_text
[:100]))
655 if response
.status
>= 300:
656 raise ROClientException(response_text
, http_code
=response
.status
)
658 for word
in str(response_text
).split(" "):
660 version_text
, _
, _
= word
.partition("-")
662 raise ROClientException("Got invalid version text: '{}'".format(response_text
), http_code
=500)
663 except (aiohttp
.ClientOSError
, aiohttp
.ClientError
) as e
:
664 raise ROClientException(e
, http_code
=504)
665 except asyncio
.TimeoutError
:
666 raise ROClientException("Timeout", http_code
=504)
667 except Exception as e
:
668 raise ROClientException("Got invalid version text: '{}'; causing exception {}".format(response_text
, e
),
671 async def get_list(self
, item
, all_tenants
=False, filter_by
=None):
673 Obtain a list of items filtering by the specigy filter_by.
674 :param item: can be 'tenant', 'vim', 'vnfd', 'nsd', 'ns'
675 :param all_tenants: True if not filtering by tenant. Only allowed for admin
676 :param filter_by: dictionary with filtering
677 :return: a list of dict. It can be empty. Raises ROClientException on Error,
680 if item
not in self
.client_to_RO
:
681 raise ROClientException("Invalid item {}".format(item
))
684 async with aiohttp
.ClientSession(loop
=self
.loop
) as session
:
685 content
= await self
._list
_item
(session
, self
.client_to_RO
[item
], all_tenants
=all_tenants
,
686 filter_dict
=filter_by
)
687 if isinstance(content
, dict):
688 if len(content
) == 1:
689 for _
, v
in content
.items():
691 return content
.values()[0]
693 raise ROClientException("Output not a list neither dict with len equal 1", http_code
=500)
695 except (aiohttp
.ClientOSError
, aiohttp
.ClientError
) as e
:
696 raise ROClientException(e
, http_code
=504)
697 except asyncio
.TimeoutError
:
698 raise ROClientException("Timeout", http_code
=504)
700 async def show(self
, item
, item_id_name
=None, extra_item
=None, extra_item_id
=None, all_tenants
=False):
702 Obtain the information of an item from its id or name
703 :param item: can be 'tenant', 'vim', 'vnfd', 'nsd', 'ns'
704 :param item_id_name: RO id or name of the item. Raise and exception if more than one found
705 :param extra_item: if supplied, it is used to add to the URL.
706 Can be 'action' if item='ns'; 'networks' or'images' if item='vim'
707 :param extra_item_id: if supplied, it is used get details of a concrete extra_item.
708 :param all_tenants: True if not filtering by tenant. Only allowed for admin
709 :return: dictionary with the information or raises ROClientException on Error, NotFound, found several
712 if item
not in self
.client_to_RO
:
713 raise ROClientException("Invalid item {}".format(item
))
718 elif item
== 'vim_account':
721 async with aiohttp
.ClientSession(loop
=self
.loop
) as session
:
722 content
= await self
._get
_item
(session
, self
.client_to_RO
[item
], item_id_name
, extra_item
=extra_item
,
723 extra_item_id
=extra_item_id
, all_tenants
=all_tenants
)
724 return remove_envelop(item
, content
)
725 except (aiohttp
.ClientOSError
, aiohttp
.ClientError
) as e
:
726 raise ROClientException(e
, http_code
=504)
727 except asyncio
.TimeoutError
:
728 raise ROClientException("Timeout", http_code
=504)
730 async def delete(self
, item
, item_id_name
=None, all_tenants
=False):
732 Delete the information of an item from its id or name
733 :param item: can be 'tenant', 'vim', 'vnfd', 'nsd', 'ns'
734 :param item_id_name: RO id or name of the item. Raise and exception if more than one found
735 :param all_tenants: True if not filtering by tenant. Only allowed for admin
736 :return: dictionary with the information or raises ROClientException on Error, NotFound, found several
739 if item
not in self
.client_to_RO
:
740 raise ROClientException("Invalid item {}".format(item
))
741 if item
in ('tenant', 'vim', 'wim'):
744 async with aiohttp
.ClientSession(loop
=self
.loop
) as session
:
745 result
= await self
._del
_item
(session
, self
.client_to_RO
[item
], item_id_name
, all_tenants
=all_tenants
)
746 # in case of ns delete, get the action_id embeded in text
747 if item
== "ns" and result
.get("result"):
748 _
, _
, action_id
= result
["result"].partition("action_id=")
749 action_id
, _
, _
= action_id
.partition(" ")
751 result
["action_id"] = action_id
753 except (aiohttp
.ClientOSError
, aiohttp
.ClientError
) as e
:
754 raise ROClientException(e
, http_code
=504)
755 except asyncio
.TimeoutError
:
756 raise ROClientException("Timeout", http_code
=504)
758 async def edit(self
, item
, item_id_name
, descriptor
=None, descriptor_format
=None, **kwargs
):
760 :param item: can be 'tenant', 'vim', 'vnfd', 'nsd', 'ns', 'vim'
761 :param item_id_name: RO id or name of the item. Raise and exception if more than one found
762 :param descriptor: can be a dict, or a yaml/json text. Autodetect unless descriptor_format is provided
763 :param descriptor_format: Can be 'json' or 'yaml'
764 :param kwargs: Overrides descriptor with values as name, description, vim_url, vim_url_admin, vim_type
765 keys can be a dot separated list to specify elements inside dict
766 :return: dictionary with the information or raises ROClientException on Error
769 if isinstance(descriptor
, str):
770 descriptor
= self
._parse
(descriptor
, descriptor_format
)
776 if item
not in self
.client_to_RO
:
777 raise ROClientException("Invalid item {}".format(item
))
778 desc
= remove_envelop(item
, descriptor
)
780 # Override descriptor with kwargs
782 desc
= self
.update_descriptor(desc
, kwargs
)
784 if item
in ('tenant', 'vim'):
787 create_desc
= self
._create
_envelop
(item
, desc
)
789 async with aiohttp
.ClientSession(loop
=self
.loop
) as session
:
790 _all_tenants
= all_tenants
793 item_id
= await self
._get
_item
_uuid
(session
, self
.client_to_RO
[item
], item_id_name
,
794 all_tenants
=_all_tenants
)
797 # await self._get_tenant(session)
798 outdata
= await self
._edit
_item
(session
, self
.client_to_RO
[item
], item_id
, create_desc
,
799 all_tenants
=_all_tenants
)
800 return remove_envelop(item
, outdata
)
801 except (aiohttp
.ClientOSError
, aiohttp
.ClientError
) as e
:
802 raise ROClientException(e
, http_code
=504)
803 except asyncio
.TimeoutError
:
804 raise ROClientException("Timeout", http_code
=504)
806 async def create(self
, item
, descriptor
=None, descriptor_format
=None, **kwargs
):
808 Creates an item from its descriptor
809 :param item: can be 'tenant', 'vnfd', 'nsd', 'ns', 'vim', 'vim_account', 'sdn'
810 :param descriptor: can be a dict, or a yaml/json text. Autodetect unless descriptor_format is provided
811 :param descriptor_format: Can be 'json' or 'yaml'
812 :param kwargs: Overrides descriptor with values as name, description, vim_url, vim_url_admin, vim_type
813 keys can be a dot separated list to specify elements inside dict
814 :return: dictionary with the information or raises ROClientException on Error
817 if isinstance(descriptor
, str):
818 descriptor
= self
._parse
(descriptor
, descriptor_format
)
824 if item
not in self
.client_to_RO
:
825 raise ROClientException("Invalid item {}".format(item
))
826 desc
= remove_envelop(item
, descriptor
)
828 # Override descriptor with kwargs
830 desc
= self
.update_descriptor(desc
, kwargs
)
832 for mandatory
in self
.mandatory_for_create
[item
]:
833 if mandatory
not in desc
:
834 raise ROClientException("'{}' is mandatory parameter for {}".format(mandatory
, item
))
837 if item
in ('tenant', 'vim', 'wim'):
840 create_desc
= self
._create
_envelop
(item
, desc
)
842 async with aiohttp
.ClientSession(loop
=self
.loop
) as session
:
843 outdata
= await self
._create
_item
(session
, self
.client_to_RO
[item
], create_desc
,
844 all_tenants
=all_tenants
)
845 return remove_envelop(item
, outdata
)
846 except (aiohttp
.ClientOSError
, aiohttp
.ClientError
) as e
:
847 raise ROClientException(e
, http_code
=504)
848 except asyncio
.TimeoutError
:
849 raise ROClientException("Timeout", http_code
=504)
851 async def create_action(self
, item
, item_id_name
, descriptor
=None, descriptor_format
=None, **kwargs
):
853 Performs an action over an item
854 :param item: can be 'tenant', 'vnfd', 'nsd', 'ns', 'vim', 'vim_account', 'sdn'
855 :param item_id_name: RO id or name of the item. Raise and exception if more than one found
856 :param descriptor: can be a dict, or a yaml/json text. Autodetect unless descriptor_format is provided
857 :param descriptor_format: Can be 'json' or 'yaml'
858 :param kwargs: Overrides descriptor with values as name, description, vim_url, vim_url_admin, vim_type
859 keys can be a dot separated list to specify elements inside dict
860 :return: dictionary with the information or raises ROClientException on Error
863 if isinstance(descriptor
, str):
864 descriptor
= self
._parse
(descriptor
, descriptor_format
)
870 if item
not in self
.client_to_RO
:
871 raise ROClientException("Invalid item {}".format(item
))
872 desc
= remove_envelop(item
, descriptor
)
874 # Override descriptor with kwargs
876 desc
= self
.update_descriptor(desc
, kwargs
)
879 if item
in ('tenant', 'vim'):
884 action
= "sdn_mapping"
885 elif item
in ("vim_account", "ns"):
888 # create_desc = self._create_envelop(item, desc)
891 async with aiohttp
.ClientSession(loop
=self
.loop
) as session
:
892 _all_tenants
= all_tenants
895 # item_id = await self._get_item_uuid(session, self.client_to_RO[item], item_id_name,
896 # all_tenants=_all_tenants)
897 outdata
= await self
._create
_item
(session
, self
.client_to_RO
[item
], create_desc
,
898 item_id_name
=item_id_name
, # item_id_name=item_id
899 action
=action
, all_tenants
=_all_tenants
)
900 return remove_envelop(item
, outdata
)
901 except (aiohttp
.ClientOSError
, aiohttp
.ClientError
) as e
:
902 raise ROClientException(e
, http_code
=504)
903 except asyncio
.TimeoutError
:
904 raise ROClientException("Timeout", http_code
=504)
906 async def attach(self
, item
, item_id_name
=None, descriptor
=None, descriptor_format
=None, **kwargs
):
908 Attach a datacenter or wim to a tenant, creating a vim_account, wim_account
909 :param item: can be vim_account or wim_account
910 :param item_id_name: id or name of the datacenter, wim
912 :param descriptor_format:
917 if isinstance(descriptor
, str):
918 descriptor
= self
._parse
(descriptor
, descriptor_format
)
924 desc
= remove_envelop(item
, descriptor
)
927 # uuid = self._get_item_uuid(session, "datacenters", uuid_name, all_tenants=True)
928 # tenant_text = "/" + self._get_tenant()
930 desc
= self
.update_descriptor(desc
, kwargs
)
932 if item
== "vim_account":
933 if not desc
.get("vim_tenant_name") and not desc
.get("vim_tenant_id"):
934 raise ROClientException("Wrong descriptor. At least vim_tenant_name or vim_tenant_id must be "
936 elif item
!= "wim_account":
937 raise ROClientException("Attach with unknown item {}. Must be 'vim_account' or 'wim_account'".
939 create_desc
= self
._create
_envelop
(item
, desc
)
940 payload_req
= yaml
.safe_dump(create_desc
)
941 async with aiohttp
.ClientSession(loop
=self
.loop
) as session
:
943 item_id
= await self
._get
_item
_uuid
(session
, self
.client_to_RO
[item
], item_id_name
, all_tenants
=True)
944 await self
._get
_tenant
(session
)
946 url
= "{}/{tenant}/{item}/{item_id}".format(self
.uri
, tenant
=self
.tenant
,
947 item
=self
.client_to_RO
[item
], item_id
=item_id
)
948 self
.logger
.debug("RO POST %s %s", url
, payload_req
)
949 # timeout = aiohttp.ClientTimeout(total=self.timeout_large)
950 async with session
.post(url
, headers
=self
.headers_req
, data
=payload_req
) as response
:
951 response_text
= await response
.read()
952 self
.logger
.debug("POST {} [{}] {}".format(url
, response
.status
, response_text
[:100]))
953 if response
.status
>= 300:
954 raise ROClientException(response_text
, http_code
=response
.status
)
956 response_desc
= self
._parse
_yaml
(response_text
, response
=True)
957 desc
= remove_envelop(item
, response_desc
)
959 except (aiohttp
.ClientOSError
, aiohttp
.ClientError
) as e
:
960 raise ROClientException(e
, http_code
=504)
961 except asyncio
.TimeoutError
:
962 raise ROClientException("Timeout", http_code
=504)
964 async def detach(self
, item
, item_id_name
=None):
965 # TODO replace the code with delete_item(vim_account,...)
967 async with aiohttp
.ClientSession(loop
=self
.loop
) as session
:
969 item_id
= await self
._get
_item
_uuid
(session
, self
.client_to_RO
[item
], item_id_name
, all_tenants
=False)
970 tenant
= await self
._get
_tenant
(session
)
972 url
= "{}/{tenant}/{item}/{datacenter}".format(self
.uri
, tenant
=tenant
,
973 item
=self
.client_to_RO
[item
], datacenter
=item_id
)
974 self
.logger
.debug("RO DELETE %s", url
)
976 # timeout = aiohttp.ClientTimeout(total=self.timeout_large)
977 async with session
.delete(url
, headers
=self
.headers_req
) as response
:
978 response_text
= await response
.read()
979 self
.logger
.debug("DELETE {} [{}] {}".format(url
, response
.status
, response_text
[:100]))
980 if response
.status
>= 300:
981 raise ROClientException(response_text
, http_code
=response
.status
)
983 response_desc
= self
._parse
_yaml
(response_text
, response
=True)
984 desc
= remove_envelop(item
, response_desc
)
986 except (aiohttp
.ClientOSError
, aiohttp
.ClientError
) as e
:
987 raise ROClientException(e
, http_code
=504)
988 except asyncio
.TimeoutError
:
989 raise ROClientException("Timeout", http_code
=504)
991 # TODO convert to asyncio
994 def edit_datacenter(self
, uuid
=None, name
=None, descriptor
=None, descriptor_format
=None, all_tenants
=False,
996 """Edit the parameters of a datacenter
997 Params: must supply a descriptor or/and a parameter to change
998 uuid or/and name. If only name is supplied, there must be only one or an exception is raised
999 descriptor: with format {'datacenter':{params to change info}}
1000 must be a dictionary or a json/yaml text.
1001 parameters to change can be supplyied by the descriptor or as parameters:
1002 new_name: the datacenter name
1003 vim_url: the datacenter URL
1004 vim_url_admin: the datacenter URL for administrative issues
1005 vim_type: the datacenter type, can be openstack or openvim.
1006 public: boolean, available to other tenants
1007 description: datacenter description
1008 Return: Raises an exception on error, not found or found several
1009 Obtain a dictionary with format {'datacenter':{new_datacenter_info}}
1012 if isinstance(descriptor
, str):
1013 descriptor
= self
.parse(descriptor
, descriptor_format
)
1017 descriptor
= {"datacenter": {}}
1019 raise ROClientException("Missing descriptor")
1021 if 'datacenter' not in descriptor
or len(descriptor
) != 1:
1022 raise ROClientException("Descriptor must contain only one 'datacenter' field")
1023 for param
in kwargs
:
1024 if param
== 'new_name':
1025 descriptor
['datacenter']['name'] = kwargs
[param
]
1027 descriptor
['datacenter'][param
] = kwargs
[param
]
1028 return self
._edit
_item
("datacenters", descriptor
, uuid
, name
, all_tenants
=None)
1030 def edit_scenario(self
, uuid
=None, name
=None, descriptor
=None, descriptor_format
=None, all_tenants
=False, **kwargs
):
1031 """Edit the parameters of a scenario
1032 Params: must supply a descriptor or/and a parameters to change
1033 uuid or/and name. If only name is supplied, there must be only one or an exception is raised
1034 descriptor: with format {'scenario':{params to change info}}
1035 must be a dictionary or a json/yaml text.
1036 parameters to change can be supplyied by the descriptor or as parameters:
1037 new_name: the scenario name
1038 public: boolean, available to other tenants
1039 description: scenario description
1040 tenant_id. Propietary tenant
1041 Return: Raises an exception on error, not found or found several
1042 Obtain a dictionary with format {'scenario':{new_scenario_info}}
1045 if isinstance(descriptor
, str):
1046 descriptor
= self
.parse(descriptor
, descriptor_format
)
1050 descriptor
= {"scenario": {}}
1052 raise ROClientException("Missing descriptor")
1054 if 'scenario' not in descriptor
or len(descriptor
) > 2:
1055 raise ROClientException("Descriptor must contain only one 'scenario' field")
1056 for param
in kwargs
:
1057 if param
== 'new_name':
1058 descriptor
['scenario']['name'] = kwargs
[param
]
1060 descriptor
['scenario'][param
] = kwargs
[param
]
1061 return self
._edit
_item
("scenarios", descriptor
, uuid
, name
, all_tenants
=None)
1064 def vim_action(self
, action
, item
, uuid
=None, all_tenants
=False, **kwargs
):
1065 """Perform an action over a vim
1067 action: can be 'list', 'get'/'show', 'delete' or 'create'
1068 item: can be 'tenants' or 'networks'
1069 uuid: uuid of the tenant/net to show or to delete. Ignore otherwise
1071 datacenter_name, datacenter_id: datacenters to act on, if missing uses classes store datacenter
1072 descriptor, descriptor_format: descriptor needed on creation, can be a dict or a yaml/json str
1073 must be a dictionary or a json/yaml text.
1074 name: for created tenant/net Overwrite descriptor name if any
1075 description: tenant descriptor. Overwrite descriptor description if any
1077 Return: Raises an exception on error
1078 Obtain a dictionary with format {'tenant':{new_tenant_info}}
1080 session
= None # TODO remove when changed to asyncio
1081 if item
not in ("tenants", "networks", "images"):
1082 raise ROClientException("Unknown value for item '{}', must be 'tenants', 'nets' or "
1083 "images".format(str(item
)))
1085 image_actions
= ['list', 'get', 'show', 'delete']
1086 if item
== "images" and action
not in image_actions
:
1087 raise ROClientException("Only available actions for item '{}' are {}\n"
1088 "Requested action was '{}'".format(item
, ', '.join(image_actions
), action
))
1090 tenant_text
= "/any"
1092 tenant_text
= "/" + self
._get
_tenant
()
1094 if "datacenter_id" in kwargs
or "datacenter_name" in kwargs
:
1095 datacenter
= self
._get
_item
_uuid
(session
, "datacenters", kwargs
.get("datacenter"), all_tenants
=all_tenants
)
1097 datacenter
= self
.get_datacenter(session
)
1099 if action
== "list":
1100 url
= "{}{}/vim/{}/{}".format(self
.uri
, tenant_text
, datacenter
, item
)
1101 self
.logger
.debug("GET %s", url
)
1102 mano_response
= requests
.get(url
, headers
=self
.headers_req
)
1103 self
.logger
.debug("RO response: %s", mano_response
.text
)
1104 content
= self
._parse
_yaml
(mano_response
.text
, response
=True)
1105 if mano_response
.status_code
== 200:
1108 raise ROClientException(str(content
), http_code
=mano_response
.status
)
1109 elif action
== "get" or action
== "show":
1110 url
= "{}{}/vim/{}/{}/{}".format(self
.uri
, tenant_text
, datacenter
, item
, uuid
)
1111 self
.logger
.debug("GET %s", url
)
1112 mano_response
= requests
.get(url
, headers
=self
.headers_req
)
1113 self
.logger
.debug("RO response: %s", mano_response
.text
)
1114 content
= self
._parse
_yaml
(mano_response
.text
, response
=True)
1115 if mano_response
.status_code
== 200:
1118 raise ROClientException(str(content
), http_code
=mano_response
.status
)
1119 elif action
== "delete":
1120 url
= "{}{}/vim/{}/{}/{}".format(self
.uri
, tenant_text
, datacenter
, item
, uuid
)
1121 self
.logger
.debug("DELETE %s", url
)
1122 mano_response
= requests
.delete(url
, headers
=self
.headers_req
)
1123 self
.logger
.debug("RO response: %s", mano_response
.text
)
1124 content
= self
._parse
_yaml
(mano_response
.text
, response
=True)
1125 if mano_response
.status_code
== 200:
1128 raise ROClientException(str(content
), http_code
=mano_response
.status
)
1129 elif action
== "create":
1130 if "descriptor" in kwargs
:
1131 if isinstance(kwargs
["descriptor"], str):
1132 descriptor
= self
._parse
(kwargs
["descriptor"], kwargs
.get("descriptor_format"))
1134 descriptor
= kwargs
["descriptor"]
1135 elif "name" in kwargs
:
1136 descriptor
= {item
[:-1]: {"name": kwargs
["name"]}}
1138 raise ROClientException("Missing descriptor")
1140 if item
[:-1] not in descriptor
or len(descriptor
) != 1:
1141 raise ROClientException("Descriptor must contain only one 'tenant' field")
1142 if "name" in kwargs
:
1143 descriptor
[item
[:-1]]['name'] = kwargs
["name"]
1144 if "description" in kwargs
:
1145 descriptor
[item
[:-1]]['description'] = kwargs
["description"]
1146 payload_req
= yaml
.safe_dump(descriptor
)
1148 url
= "{}{}/vim/{}/{}".format(self
.uri
, tenant_text
, datacenter
, item
)
1149 self
.logger
.debug("RO POST %s %s", url
, payload_req
)
1150 mano_response
= requests
.post(url
, headers
=self
.headers_req
, data
=payload_req
)
1151 self
.logger
.debug("RO response: %s", mano_response
.text
)
1152 content
= self
._parse
_yaml
(mano_response
.text
, response
=True)
1153 if mano_response
.status_code
== 200:
1156 raise ROClientException(str(content
), http_code
=mano_response
.status
)
1158 raise ROClientException("Unknown value for action '{}".format(str(action
)))
1161 if __name__
== '__main__':
1162 RO_URL
= "http://localhost:9090/openmano"
1163 TEST_TENANT
= "myTenant"
1165 TEST_URL1
= "https://localhost:5000/v1"
1166 TEST_TYPE1
= "openstack"
1167 TEST_CONFIG1
= {"use_floating_ip": True}
1168 TEST_VIM2
= "myvim2"
1169 TEST_URL2
= "https://localhost:5000/v2"
1170 TEST_TYPE2
= "openvim"
1171 TEST_CONFIG2
= {"config2": "config2", "config3": True}
1173 streamformat
= "%(asctime)s %(name)s %(levelname)s: %(message)s"
1174 logging
.basicConfig(format
=streamformat
)
1175 logger
= logging
.getLogger("ROClient")
1179 loop
= asyncio
.get_event_loop()
1180 myClient
= ROClient(uri
=RO_URL
, loop
=loop
, loglevel
="DEBUG")
1183 content
= loop
.run_until_complete(myClient
.get_list("tenant"))
1184 print("tenants", content
)
1185 content
= loop
.run_until_complete(myClient
.create("tenant", name
=TEST_TENANT
))
1187 content
= loop
.run_until_complete(myClient
.show("tenant", TEST_TENANT
))
1188 print("tenant", TEST_TENANT
, content
)
1189 content
= loop
.run_until_complete(myClient
.edit("tenant", TEST_TENANT
, description
="another description"))
1190 content
= loop
.run_until_complete(myClient
.show("tenant", TEST_TENANT
))
1191 print("tenant edited", TEST_TENANT
, content
)
1192 myClient
["tenant"] = TEST_TENANT
1195 content
= loop
.run_until_complete(myClient
.create("vim", name
=TEST_VIM1
, type=TEST_TYPE1
, vim_url
=TEST_URL1
,
1196 config
=TEST_CONFIG1
))
1198 content
= loop
.run_until_complete(myClient
.get_list("vim"))
1199 print("vim", content
)
1200 content
= loop
.run_until_complete(myClient
.show("vim", TEST_VIM1
))
1201 print("vim", TEST_VIM1
, content
)
1202 content
= loop
.run_until_complete(myClient
.edit("vim", TEST_VIM1
, description
="another description",
1203 name
=TEST_VIM2
, type=TEST_TYPE2
, vim_url
=TEST_URL2
,
1204 config
=TEST_CONFIG2
))
1205 content
= loop
.run_until_complete(myClient
.show("vim", TEST_VIM2
))
1206 print("vim edited", TEST_VIM2
, content
)
1209 content
= loop
.run_until_complete(myClient
.attach_datacenter(TEST_VIM2
, vim_username
='user',
1210 vim_password
='pass', vim_tenant_name
='vimtenant1',
1211 config
=TEST_CONFIG1
))
1213 content
= loop
.run_until_complete(myClient
.get_list("vim_account"))
1214 print("vim_account", content
)
1215 content
= loop
.run_until_complete(myClient
.show("vim_account", TEST_VIM2
))
1216 print("vim_account", TEST_VIM2
, content
)
1217 content
= loop
.run_until_complete(myClient
.edit("vim_account", TEST_VIM2
, vim_username
='user2',
1218 vim_password
='pass2', vim_tenant_name
="vimtenant2",
1219 config
=TEST_CONFIG2
))
1220 content
= loop
.run_until_complete(myClient
.show("vim_account", TEST_VIM2
))
1221 print("vim_account edited", TEST_VIM2
, content
)
1223 myClient
["vim"] = TEST_VIM2
1225 except Exception as e
:
1226 logger
.error("Error {}".format(e
), exc_info
=True)
1228 for item
in (("vim_account", TEST_VIM1
), ("vim", TEST_VIM1
),
1229 ("vim_account", TEST_VIM2
), ("vim", TEST_VIM2
),
1230 ("tenant", TEST_TENANT
)):
1232 content
= loop
.run_until_complete(myClient
.delete(item
[0], item
[1]))
1233 print("{} {} deleted; {}".format(item
[0], item
[1], content
))
1234 except Exception as e
:
1235 if e
.http_code
== 404:
1236 print("{} {} not present or already deleted".format(item
[0], item
[1]))
1238 logger
.error("Error {}".format(e
), exc_info
=True)