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", "port", 'ip', 'dpid', 'type'),
120 def __init__(self
, loop
, endpoint_url
, **kwargs
):
122 self
.endpoint_url
= endpoint_url
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', 'ROClient')
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':
146 elif index
== 'endpoint_url':
147 return self
.endpoint_url
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
160 elif index
== 'endpoint_url':
161 self
.endpoint_url
= 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
288 def _get_ref(desc
): # return an identification for the network or vm. Try vim_id if exist, if not descriptor id
290 if desc
.get("vim_net_id"):
291 return "'vim-id={}'".format(desc
["vim_net_id"])
292 elif desc
.get("ns_net_osm_id"):
293 return "'nsd-vld-id={}'".format(desc
["ns_net_osm_id"])
294 elif desc
.get("vnf_net_osm_id"):
295 return "'vnfd-vld-id={}'".format(desc
["vnf_net_osm_id"])
297 elif desc
.get("vim_vm_id"):
298 return "'vim-id={}'".format(desc
["vim_vm_id"])
299 elif desc
.get("vdu_osm_id"):
300 return "'vnfd-vdu-id={}'".format(desc
["vdu_osm_id"])
304 for net
in ns_descriptor
["nets"]:
306 if net
["status"] in ("ERROR", "VIM_ERROR"):
307 return "ERROR", "VIM network ({}) on error: {}".format(_get_ref(net
), net
["error_msg"])
308 elif net
["status"] == "ACTIVE":
310 for vnf
in ns_descriptor
["vnfs"]:
311 for vm
in vnf
["vms"]:
313 if vm
["status"] in ("ERROR", "VIM_ERROR"):
314 return "ERROR", "VIM VM ({}) on error: {}".format(_get_ref(vm
), vm
["error_msg"])
315 elif vm
["status"] == "ACTIVE":
318 if net_total
== net_done
and vm_total
== vm_done
:
319 return "ACTIVE", "VMs {}, networks: {}".format(vm_total
, net_total
)
321 return "BUILD", "VMs: {}/{}, networks: {}/{}".format(vm_done
, vm_total
, net_done
, net_total
)
324 def check_action_status(action_descriptor
):
326 Inspect RO instance descriptor and indicates the status
327 :param action_descriptor: action instance descriptor obtained with self.show("ns", "action")
328 :return: status, message: status can be BUILD,ACTIVE,ERROR, message is a text message
337 for vim_action_set
in action_descriptor
["actions"]:
338 for vim_action
in vim_action_set
["vim_wim_actions"]:
339 if vim_action
["item"] == "instance_vms":
341 elif vim_action
["item"] == "instance_nets":
345 if vim_action
["status"] == "FAILED":
346 return "ERROR", vim_action
["error_msg"]
347 elif vim_action
["status"] in ("DONE", "SUPERSEDED", "FINISHED"):
348 if vim_action
["item"] == "instance_vms":
350 elif vim_action
["item"] == "instance_nets":
355 if net_total
== net_done
and vm_total
== vm_done
and other_total
== other_done
:
356 return "ACTIVE", "VMs {}, networks: {}, other: {} ".format(vm_total
, net_total
, other_total
)
358 return "BUILD", "VMs: {}/{}, networks: {}/{}, other: {}/{}".format(vm_done
, vm_total
, net_done
, net_total
,
359 other_done
, other_total
)
362 def get_ns_vnf_info(ns_descriptor
):
364 Get a dict with the VIM_id, ip_addresses, mac_addresses of every vnf and vdu
365 :param ns_descriptor: instance descriptor obtained with self.show("ns", )
379 for vnf
in ns_descriptor
["vnfs"]:
380 if not vnf
.get("ip_address") and vnf
.get("vms"):
381 raise ROClientException("ns member_vnf_index '{}' has no IP address".format(
382 vnf
["member_vnf_index"]), http_code
=409)
384 "ip_address": vnf
.get("ip_address"),
387 for vm
in vnf
["vms"]:
389 "vim_id": vm
.get("vim_vm_id"),
390 "ip_address": vm
.get("ip_address"),
393 for iface
in vm
["interfaces"]:
394 if iface
.get("type") == "mgmt" and not iface
.get("ip_address"):
395 raise ROClientException("ns member_vnf_index '{}' vm '{}' management interface '{}' has no IP "
396 "address".format(vnf
["member_vnf_index"], vm
["vdu_osm_id"],
397 iface
["external_name"]), http_code
=409)
398 vdur
["interfaces"][iface
["internal_name"]] = {"ip_address": iface
.get("ip_address"),
399 "mac_address": iface
.get("mac_address"),
400 "vim_id": iface
.get("vim_interface_id"),
402 vnfr_info
["vdur"][vm
["vdu_osm_id"]] = vdur
403 ns_info
[str(vnf
["member_vnf_index"])] = vnfr_info
406 async def _get_item_uuid(self
, session
, item
, item_id_name
, all_tenants
=False):
409 elif all_tenants
is None:
413 await self
._get
_tenant
(session
)
414 tenant_text
= "/" + self
.tenant
417 url
= "{}{}/{}".format(self
.endpoint_url
, tenant_text
, item
)
418 if self
.check_if_uuid(item_id_name
):
419 item_id
= item_id_name
420 url
+= "/" + item_id_name
421 elif item_id_name
and item_id_name
.startswith("'") and item_id_name
.endswith("'"):
422 item_id_name
= item_id_name
[1:-1]
423 self
.logger
.debug("RO GET %s", url
)
424 with aiohttp
.Timeout(self
.timeout_short
):
425 async with session
.get(url
, headers
=self
.headers_req
) as response
:
426 response_text
= await response
.read()
427 self
.logger
.debug("GET {} [{}] {}".format(url
, response
.status
, response_text
[:100]))
428 if response
.status
== 404: # NOT_FOUND
429 raise ROClientException("No {} found with id '{}'".format(item
[:-1], item_id_name
),
431 if response
.status
>= 300:
432 raise ROClientException(response_text
, http_code
=response
.status
)
433 content
= self
._parse
_yaml
(response_text
, response
=True)
438 assert isinstance(desc
, list), "_get_item_uuid get a non dict with a list inside {}".format(type(desc
))
441 if item_id_name
and i
["name"] != item_id_name
:
443 if uuid
: # found more than one
444 raise ROClientException(
445 "Found more than one {} with name '{}'. uuid must be used".format(item
, item_id_name
),
449 raise ROClientException("No {} found with name '{}'".format(item
[:-1], item_id_name
), http_code
=404)
452 async def _get_item(self
, session
, item
, item_id_name
, extra_item
=None, extra_item_id
=None, all_tenants
=False):
455 elif all_tenants
is None:
459 await self
._get
_tenant
(session
)
460 tenant_text
= "/" + self
.tenant
462 if self
.check_if_uuid(item_id_name
):
466 uuid
= await self
._get
_item
_uuid
(session
, item
, item_id_name
, all_tenants
)
468 url
= "{}{}/{}/{}".format(self
.endpoint_url
, tenant_text
, item
, uuid
)
470 url
+= "/" + extra_item
472 url
+= "/" + extra_item_id
473 self
.logger
.debug("GET %s", url
)
474 with aiohttp
.Timeout(self
.timeout_short
):
475 async with session
.get(url
, headers
=self
.headers_req
) as response
:
476 response_text
= await response
.read()
477 self
.logger
.debug("GET {} [{}] {}".format(url
, response
.status
, response_text
[:100]))
478 if response
.status
>= 300:
479 raise ROClientException(response_text
, http_code
=response
.status
)
481 return self
._parse
_yaml
(response_text
, response
=True)
483 async def _get_tenant(self
, session
):
485 self
.tenant
= await self
._get
_item
_uuid
(session
, "tenants", self
.tenant_id_name
, None)
488 async def _get_datacenter(self
, session
):
490 await self
._get
_tenant
(session
)
491 if not self
.datacenter
:
492 self
.datacenter
= await self
._get
_item
_uuid
(session
, "datacenters", self
.datacenter_id_name
, True)
493 return self
.datacenter
495 async def _create_item(self
, session
, item
, descriptor
, item_id_name
=None, action
=None, all_tenants
=False):
498 elif all_tenants
is None:
502 await self
._get
_tenant
(session
)
503 tenant_text
= "/" + self
.tenant
504 payload_req
= yaml
.safe_dump(descriptor
)
507 api_version_text
= ""
509 # assumes version v3 only
510 api_version_text
= "/v3"
512 elif item
== "scenarios":
513 # assumes version v3 only
514 api_version_text
= "/v3"
519 elif self
.check_if_uuid(item_id_name
):
520 uuid
= "/{}".format(item_id_name
)
523 uuid
= await self
._get
_item
_uuid
(session
, item
, item_id_name
, all_tenants
)
524 uuid
= "/{}".format(uuid
)
528 action
= "/{}".format(action
)
530 url
= "{}{apiver}{tenant}/{item}{id}{action}".format(self
.endpoint_url
, apiver
=api_version_text
,
531 tenant
=tenant_text
, item
=item
, id=uuid
, action
=action
)
532 self
.logger
.debug("RO POST %s %s", url
, payload_req
)
533 with aiohttp
.Timeout(self
.timeout_large
):
534 async with session
.post(url
, headers
=self
.headers_req
, data
=payload_req
) as response
:
535 response_text
= await response
.read()
536 self
.logger
.debug("POST {} [{}] {}".format(url
, response
.status
, response_text
[:100]))
537 if response
.status
>= 300:
538 raise ROClientException(response_text
, http_code
=response
.status
)
540 return self
._parse
_yaml
(response_text
, response
=True)
542 async def _del_item(self
, session
, item
, item_id_name
, all_tenants
=False):
545 elif all_tenants
is None:
549 await self
._get
_tenant
(session
)
550 tenant_text
= "/" + self
.tenant
551 if not self
.check_if_uuid(item_id_name
):
553 _all_tenants
= all_tenants
554 if item
in ("datacenters", 'wims'):
556 uuid
= await self
._get
_item
_uuid
(session
, item
, item_id_name
, all_tenants
=_all_tenants
)
560 url
= "{}{}/{}/{}".format(self
.endpoint_url
, tenant_text
, item
, uuid
)
561 self
.logger
.debug("DELETE %s", url
)
562 with aiohttp
.Timeout(self
.timeout_short
):
563 async with session
.delete(url
, headers
=self
.headers_req
) as response
:
564 response_text
= await response
.read()
565 self
.logger
.debug("DELETE {} [{}] {}".format(url
, response
.status
, response_text
[:100]))
566 if response
.status
>= 300:
567 raise ROClientException(response_text
, http_code
=response
.status
)
568 return self
._parse
_yaml
(response_text
, response
=True)
570 async def _list_item(self
, session
, item
, all_tenants
=False, filter_dict
=None):
573 elif all_tenants
is None:
577 await self
._get
_tenant
(session
)
578 tenant_text
= "/" + self
.tenant
580 url
= "{}{}/{}".format(self
.endpoint_url
, tenant_text
, item
)
583 for k
in filter_dict
:
584 url
+= separator
+ quote(str(k
)) + "=" + quote(str(filter_dict
[k
]))
586 self
.logger
.debug("RO GET %s", url
)
587 with aiohttp
.Timeout(self
.timeout_short
):
588 async with session
.get(url
, headers
=self
.headers_req
) as response
:
589 response_text
= await response
.read()
590 self
.logger
.debug("GET {} [{}] {}".format(url
, response
.status
, response_text
[:100]))
591 if response
.status
>= 300:
592 raise ROClientException(response_text
, http_code
=response
.status
)
593 return self
._parse
_yaml
(response_text
, response
=True)
595 async def _edit_item(self
, session
, item
, item_id
, descriptor
, all_tenants
=False):
598 elif all_tenants
is None:
602 await self
._get
_tenant
(session
)
603 tenant_text
= "/" + self
.tenant
605 payload_req
= yaml
.safe_dump(descriptor
)
608 url
= "{}{}/{}/{}".format(self
.endpoint_url
, tenant_text
, item
, item_id
)
609 self
.logger
.debug("RO PUT %s %s", url
, payload_req
)
610 with aiohttp
.Timeout(self
.timeout_large
):
611 async with session
.put(url
, headers
=self
.headers_req
, data
=payload_req
) as response
:
612 response_text
= await response
.read()
613 self
.logger
.debug("PUT {} [{}] {}".format(url
, response
.status
, response_text
[:100]))
614 if response
.status
>= 300:
615 raise ROClientException(response_text
, http_code
=response
.status
)
616 return self
._parse
_yaml
(response_text
, response
=True)
618 async def get_version(self
):
620 Obtain RO server version.
621 :return: a list with integers ["major", "minor", "release"]. Raises ROClientException on Error,
624 with aiohttp
.ClientSession(loop
=self
.loop
) as session
:
625 url
= "{}/version".format(self
.endpoint_url
)
626 self
.logger
.debug("RO GET %s", url
)
627 with aiohttp
.Timeout(self
.timeout_short
):
628 async with session
.get(url
, headers
=self
.headers_req
) as response
:
629 response_text
= await response
.read()
630 self
.logger
.debug("GET {} [{}] {}".format(url
, response
.status
, response_text
[:100]))
631 if response
.status
>= 300:
632 raise ROClientException(response_text
, http_code
=response
.status
)
633 for word
in str(response_text
).split(" "):
635 version_text
, _
, _
= word
.partition("-")
637 raise ROClientException("Got invalid version text: '{}'".format(response_text
), http_code
=500)
638 except aiohttp
.errors
.ClientOSError
as e
:
639 raise ROClientException(e
, http_code
=504)
640 except asyncio
.TimeoutError
:
641 raise ROClientException("Timeout", http_code
=504)
642 except Exception as e
:
643 raise ROClientException("Got invalid version text: '{}'; causing exception {}".format(response_text
, e
),
646 async def get_list(self
, item
, all_tenants
=False, filter_by
=None):
648 Obtain a list of items filtering by the specigy filter_by.
649 :param item: can be 'tenant', 'vim', 'vnfd', 'nsd', 'ns'
650 :param all_tenants: True if not filtering by tenant. Only allowed for admin
651 :param filter_by: dictionary with filtering
652 :return: a list of dict. It can be empty. Raises ROClientException on Error,
655 if item
not in self
.client_to_RO
:
656 raise ROClientException("Invalid item {}".format(item
))
659 with aiohttp
.ClientSession(loop
=self
.loop
) as session
:
660 content
= await self
._list
_item
(session
, self
.client_to_RO
[item
], all_tenants
=all_tenants
,
661 filter_dict
=filter_by
)
662 if isinstance(content
, dict):
663 if len(content
) == 1:
664 for _
, v
in content
.items():
666 return content
.values()[0]
668 raise ROClientException("Output not a list neither dict with len equal 1", http_code
=500)
670 except aiohttp
.errors
.ClientOSError
as e
:
671 raise ROClientException(e
, http_code
=504)
672 except asyncio
.TimeoutError
:
673 raise ROClientException("Timeout", http_code
=504)
675 async def show(self
, item
, item_id_name
=None, extra_item
=None, extra_item_id
=None, all_tenants
=False):
677 Obtain the information of an item from its id or name
678 :param item: can be 'tenant', 'vim', 'vnfd', 'nsd', 'ns'
679 :param item_id_name: RO id or name of the item. Raise and exception if more than one found
680 :param extra_item: if supplied, it is used to add to the URL.
681 Can be 'action' if item='ns'; 'networks' or'images' if item='vim'
682 :param extra_item_id: if supplied, it is used get details of a concrete extra_item.
683 :param all_tenants: True if not filtering by tenant. Only allowed for admin
684 :return: dictionary with the information or raises ROClientException on Error, NotFound, found several
687 if item
not in self
.client_to_RO
:
688 raise ROClientException("Invalid item {}".format(item
))
693 elif item
== 'vim_account':
696 with aiohttp
.ClientSession(loop
=self
.loop
) as session
:
697 content
= await self
._get
_item
(session
, self
.client_to_RO
[item
], item_id_name
, extra_item
=extra_item
,
698 extra_item_id
=extra_item_id
, all_tenants
=all_tenants
)
699 return remove_envelop(item
, content
)
700 except aiohttp
.errors
.ClientOSError
as e
:
701 raise ROClientException(e
, http_code
=504)
702 except asyncio
.TimeoutError
:
703 raise ROClientException("Timeout", http_code
=504)
705 async def delete(self
, item
, item_id_name
=None, all_tenants
=False):
707 Delete the information of an item from its id or name
708 :param item: can be 'tenant', 'vim', 'vnfd', 'nsd', 'ns'
709 :param item_id_name: RO id or name of the item. Raise and exception if more than one found
710 :param all_tenants: True if not filtering by tenant. Only allowed for admin
711 :return: dictionary with the information or raises ROClientException on Error, NotFound, found several
714 if item
not in self
.client_to_RO
:
715 raise ROClientException("Invalid item {}".format(item
))
716 if item
in ('tenant', 'vim', 'wim'):
719 with aiohttp
.ClientSession(loop
=self
.loop
) as session
:
720 result
= await self
._del
_item
(session
, self
.client_to_RO
[item
], item_id_name
, all_tenants
=all_tenants
)
721 # in case of ns delete, get the action_id embeded in text
722 if item
== "ns" and result
.get("result"):
723 _
, _
, action_id
= result
["result"].partition("action_id=")
724 action_id
, _
, _
= action_id
.partition(" ")
726 result
["action_id"] = action_id
728 except aiohttp
.errors
.ClientOSError
as e
:
729 raise ROClientException(e
, http_code
=504)
730 except asyncio
.TimeoutError
:
731 raise ROClientException("Timeout", http_code
=504)
733 async def edit(self
, item
, item_id_name
, descriptor
=None, descriptor_format
=None, **kwargs
):
735 :param item: can be 'tenant', 'vim', 'vnfd', 'nsd', 'ns', 'vim'
736 :param item_id_name: RO id or name of the item. Raise and exception if more than one found
737 :param descriptor: can be a dict, or a yaml/json text. Autodetect unless descriptor_format is provided
738 :param descriptor_format: Can be 'json' or 'yaml'
739 :param kwargs: Overrides descriptor with values as name, description, vim_url, vim_url_admin, vim_type
740 keys can be a dot separated list to specify elements inside dict
741 :return: dictionary with the information or raises ROClientException on Error
744 if isinstance(descriptor
, str):
745 descriptor
= self
._parse
(descriptor
, descriptor_format
)
751 if item
not in self
.client_to_RO
:
752 raise ROClientException("Invalid item {}".format(item
))
753 desc
= remove_envelop(item
, descriptor
)
755 # Override descriptor with kwargs
757 desc
= self
.update_descriptor(desc
, kwargs
)
759 if item
in ('tenant', 'vim'):
762 create_desc
= self
._create
_envelop
(item
, desc
)
764 with aiohttp
.ClientSession(loop
=self
.loop
) as session
:
765 _all_tenants
= all_tenants
768 item_id
= await self
._get
_item
_uuid
(session
, self
.client_to_RO
[item
], item_id_name
,
769 all_tenants
=_all_tenants
)
772 # await self._get_tenant(session)
773 outdata
= await self
._edit
_item
(session
, self
.client_to_RO
[item
], item_id
, create_desc
,
774 all_tenants
=_all_tenants
)
775 return remove_envelop(item
, outdata
)
776 except aiohttp
.errors
.ClientOSError
as e
:
777 raise ROClientException(e
, http_code
=504)
778 except asyncio
.TimeoutError
:
779 raise ROClientException("Timeout", http_code
=504)
781 async def create(self
, item
, descriptor
=None, descriptor_format
=None, **kwargs
):
783 Creates an item from its descriptor
784 :param item: can be 'tenant', 'vnfd', 'nsd', 'ns', 'vim', 'vim_account', 'sdn'
785 :param descriptor: can be a dict, or a yaml/json text. Autodetect unless descriptor_format is provided
786 :param descriptor_format: Can be 'json' or 'yaml'
787 :param kwargs: Overrides descriptor with values as name, description, vim_url, vim_url_admin, vim_type
788 keys can be a dot separated list to specify elements inside dict
789 :return: dictionary with the information or raises ROClientException on Error
792 if isinstance(descriptor
, str):
793 descriptor
= self
._parse
(descriptor
, descriptor_format
)
799 if item
not in self
.client_to_RO
:
800 raise ROClientException("Invalid item {}".format(item
))
801 desc
= remove_envelop(item
, descriptor
)
803 # Override descriptor with kwargs
805 desc
= self
.update_descriptor(desc
, kwargs
)
807 for mandatory
in self
.mandatory_for_create
[item
]:
808 if mandatory
not in desc
:
809 raise ROClientException("'{}' is mandatory parameter for {}".format(mandatory
, item
))
812 if item
in ('tenant', 'vim', 'wim'):
815 create_desc
= self
._create
_envelop
(item
, desc
)
817 with aiohttp
.ClientSession(loop
=self
.loop
) as session
:
818 outdata
= await self
._create
_item
(session
, self
.client_to_RO
[item
], create_desc
,
819 all_tenants
=all_tenants
)
820 return remove_envelop(item
, outdata
)
821 except aiohttp
.errors
.ClientOSError
as e
:
822 raise ROClientException(e
, http_code
=504)
823 except asyncio
.TimeoutError
:
824 raise ROClientException("Timeout", http_code
=504)
826 async def create_action(self
, item
, item_id_name
, descriptor
=None, descriptor_format
=None, **kwargs
):
828 Performs an action over an item
829 :param item: can be 'tenant', 'vnfd', 'nsd', 'ns', 'vim', 'vim_account', 'sdn'
830 :param item_id_name: RO id or name of the item. Raise and exception if more than one found
831 :param descriptor: can be a dict, or a yaml/json text. Autodetect unless descriptor_format is provided
832 :param descriptor_format: Can be 'json' or 'yaml'
833 :param kwargs: Overrides descriptor with values as name, description, vim_url, vim_url_admin, vim_type
834 keys can be a dot separated list to specify elements inside dict
835 :return: dictionary with the information or raises ROClientException on Error
838 if isinstance(descriptor
, str):
839 descriptor
= self
._parse
(descriptor
, descriptor_format
)
845 if item
not in self
.client_to_RO
:
846 raise ROClientException("Invalid item {}".format(item
))
847 desc
= remove_envelop(item
, descriptor
)
849 # Override descriptor with kwargs
851 desc
= self
.update_descriptor(desc
, kwargs
)
854 if item
in ('tenant', 'vim'):
859 action
= "sdn_mapping"
860 elif item
in ("vim_account", "ns"):
863 # create_desc = self._create_envelop(item, desc)
866 with aiohttp
.ClientSession(loop
=self
.loop
) as session
:
867 _all_tenants
= all_tenants
870 # item_id = await self._get_item_uuid(session, self.client_to_RO[item], item_id_name,
871 # all_tenants=_all_tenants)
872 outdata
= await self
._create
_item
(session
, self
.client_to_RO
[item
], create_desc
,
873 item_id_name
=item_id_name
, # item_id_name=item_id
874 action
=action
, all_tenants
=_all_tenants
)
875 return remove_envelop(item
, outdata
)
876 except aiohttp
.errors
.ClientOSError
as e
:
877 raise ROClientException(e
, http_code
=504)
878 except asyncio
.TimeoutError
:
879 raise ROClientException("Timeout", http_code
=504)
881 async def attach(self
, item
, item_id_name
=None, descriptor
=None, descriptor_format
=None, **kwargs
):
883 Attach a datacenter or wim to a tenant, creating a vim_account, wim_account
884 :param item: can be vim_account or wim_account
885 :param item_id_name: id or name of the datacenter, wim
887 :param descriptor_format:
892 if isinstance(descriptor
, str):
893 descriptor
= self
._parse
(descriptor
, descriptor_format
)
899 desc
= remove_envelop(item
, descriptor
)
902 # uuid = self._get_item_uuid(session, "datacenters", uuid_name, all_tenants=True)
903 # tenant_text = "/" + self._get_tenant()
905 desc
= self
.update_descriptor(desc
, kwargs
)
907 if item
== "vim_account":
908 if not desc
.get("vim_tenant_name") and not desc
.get("vim_tenant_id"):
909 raise ROClientException("Wrong descriptor. At least vim_tenant_name or vim_tenant_id must be "
911 elif item
!= "wim_account":
912 raise ROClientException("Attach with unknown item {}. Must be 'vim_account' or 'wim_account'".
914 create_desc
= self
._create
_envelop
(item
, desc
)
915 payload_req
= yaml
.safe_dump(create_desc
)
916 with aiohttp
.ClientSession(loop
=self
.loop
) as session
:
918 item_id
= await self
._get
_item
_uuid
(session
, self
.client_to_RO
[item
], item_id_name
, all_tenants
=True)
919 await self
._get
_tenant
(session
)
921 url
= "{}/{tenant}/{item}/{item_id}".format(self
.endpoint_url
, tenant
=self
.tenant
,
922 item
=self
.client_to_RO
[item
], item_id
=item_id
)
923 self
.logger
.debug("RO POST %s %s", url
, payload_req
)
924 with aiohttp
.Timeout(self
.timeout_large
):
925 async with session
.post(url
, headers
=self
.headers_req
, data
=payload_req
) as response
:
926 response_text
= await response
.read()
927 self
.logger
.debug("POST {} [{}] {}".format(url
, response
.status
, response_text
[:100]))
928 if response
.status
>= 300:
929 raise ROClientException(response_text
, http_code
=response
.status
)
931 response_desc
= self
._parse
_yaml
(response_text
, response
=True)
932 desc
= remove_envelop(item
, response_desc
)
934 except aiohttp
.errors
.ClientOSError
as e
:
935 raise ROClientException(e
, http_code
=504)
936 except asyncio
.TimeoutError
:
937 raise ROClientException("Timeout", http_code
=504)
939 async def detach(self
, item
, item_id_name
=None):
940 # TODO replace the code with delete_item(vim_account,...)
942 with aiohttp
.ClientSession(loop
=self
.loop
) as session
:
944 item_id
= await self
._get
_item
_uuid
(session
, self
.client_to_RO
[item
], item_id_name
, all_tenants
=False)
945 tenant
= await self
._get
_tenant
(session
)
947 url
= "{}/{tenant}/{item}/{datacenter}".format(self
.endpoint_url
, tenant
=tenant
,
948 item
=self
.client_to_RO
[item
], datacenter
=item_id
)
949 self
.logger
.debug("RO DELETE %s", url
)
950 with aiohttp
.Timeout(self
.timeout_large
):
951 async with session
.delete(url
, headers
=self
.headers_req
) as response
:
952 response_text
= await response
.read()
953 self
.logger
.debug("DELETE {} [{}] {}".format(url
, response
.status
, response_text
[:100]))
954 if response
.status
>= 300:
955 raise ROClientException(response_text
, http_code
=response
.status
)
957 response_desc
= self
._parse
_yaml
(response_text
, response
=True)
958 desc
= remove_envelop(item
, response_desc
)
960 except aiohttp
.errors
.ClientOSError
as e
:
961 raise ROClientException(e
, http_code
=504)
962 except asyncio
.TimeoutError
:
963 raise ROClientException("Timeout", http_code
=504)
965 # TODO convert to asyncio
968 def edit_datacenter(self
, uuid
=None, name
=None, descriptor
=None, descriptor_format
=None, all_tenants
=False,
970 """Edit the parameters of a datacenter
971 Params: must supply a descriptor or/and a parameter to change
972 uuid or/and name. If only name is supplied, there must be only one or an exception is raised
973 descriptor: with format {'datacenter':{params to change info}}
974 must be a dictionary or a json/yaml text.
975 parameters to change can be supplyied by the descriptor or as parameters:
976 new_name: the datacenter name
977 vim_url: the datacenter URL
978 vim_url_admin: the datacenter URL for administrative issues
979 vim_type: the datacenter type, can be openstack or openvim.
980 public: boolean, available to other tenants
981 description: datacenter description
982 Return: Raises an exception on error, not found or found several
983 Obtain a dictionary with format {'datacenter':{new_datacenter_info}}
986 if isinstance(descriptor
, str):
987 descriptor
= self
.parse(descriptor
, descriptor_format
)
991 descriptor
= {"datacenter": {}}
993 raise ROClientException("Missing descriptor")
995 if 'datacenter' not in descriptor
or len(descriptor
) != 1:
996 raise ROClientException("Descriptor must contain only one 'datacenter' field")
998 if param
== 'new_name':
999 descriptor
['datacenter']['name'] = kwargs
[param
]
1001 descriptor
['datacenter'][param
] = kwargs
[param
]
1002 return self
._edit
_item
("datacenters", descriptor
, uuid
, name
, all_tenants
=None)
1004 def edit_scenario(self
, uuid
=None, name
=None, descriptor
=None, descriptor_format
=None, all_tenants
=False, **kwargs
):
1005 """Edit the parameters of a scenario
1006 Params: must supply a descriptor or/and a parameters to change
1007 uuid or/and name. If only name is supplied, there must be only one or an exception is raised
1008 descriptor: with format {'scenario':{params to change info}}
1009 must be a dictionary or a json/yaml text.
1010 parameters to change can be supplyied by the descriptor or as parameters:
1011 new_name: the scenario name
1012 public: boolean, available to other tenants
1013 description: scenario description
1014 tenant_id. Propietary tenant
1015 Return: Raises an exception on error, not found or found several
1016 Obtain a dictionary with format {'scenario':{new_scenario_info}}
1019 if isinstance(descriptor
, str):
1020 descriptor
= self
.parse(descriptor
, descriptor_format
)
1024 descriptor
= {"scenario": {}}
1026 raise ROClientException("Missing descriptor")
1028 if 'scenario' not in descriptor
or len(descriptor
) > 2:
1029 raise ROClientException("Descriptor must contain only one 'scenario' field")
1030 for param
in kwargs
:
1031 if param
== 'new_name':
1032 descriptor
['scenario']['name'] = kwargs
[param
]
1034 descriptor
['scenario'][param
] = kwargs
[param
]
1035 return self
._edit
_item
("scenarios", descriptor
, uuid
, name
, all_tenants
=None)
1038 def vim_action(self
, action
, item
, uuid
=None, all_tenants
=False, **kwargs
):
1039 """Perform an action over a vim
1041 action: can be 'list', 'get'/'show', 'delete' or 'create'
1042 item: can be 'tenants' or 'networks'
1043 uuid: uuid of the tenant/net to show or to delete. Ignore otherwise
1045 datacenter_name, datacenter_id: datacenters to act on, if missing uses classes store datacenter
1046 descriptor, descriptor_format: descriptor needed on creation, can be a dict or a yaml/json str
1047 must be a dictionary or a json/yaml text.
1048 name: for created tenant/net Overwrite descriptor name if any
1049 description: tenant descriptor. Overwrite descriptor description if any
1051 Return: Raises an exception on error
1052 Obtain a dictionary with format {'tenant':{new_tenant_info}}
1054 session
= None # TODO remove when changed to asyncio
1055 if item
not in ("tenants", "networks", "images"):
1056 raise ROClientException("Unknown value for item '{}', must be 'tenants', 'nets' or "
1057 "images".format(str(item
)))
1059 image_actions
= ['list', 'get', 'show', 'delete']
1060 if item
== "images" and action
not in image_actions
:
1061 raise ROClientException("Only available actions for item '{}' are {}\n"
1062 "Requested action was '{}'".format(item
, ', '.join(image_actions
), action
))
1064 tenant_text
= "/any"
1066 tenant_text
= "/" + self
._get
_tenant
()
1068 if "datacenter_id" in kwargs
or "datacenter_name" in kwargs
:
1069 datacenter
= self
._get
_item
_uuid
(session
, "datacenters", kwargs
.get("datacenter"), all_tenants
=all_tenants
)
1071 datacenter
= self
.get_datacenter(session
)
1073 if action
== "list":
1074 url
= "{}{}/vim/{}/{}".format(self
.endpoint_url
, tenant_text
, datacenter
, item
)
1075 self
.logger
.debug("GET %s", url
)
1076 mano_response
= requests
.get(url
, headers
=self
.headers_req
)
1077 self
.logger
.debug("RO response: %s", mano_response
.text
)
1078 content
= self
._parse
_yaml
(mano_response
.text
, response
=True)
1079 if mano_response
.status_code
== 200:
1082 raise ROClientException(str(content
), http_code
=mano_response
.status
)
1083 elif action
== "get" or action
== "show":
1084 url
= "{}{}/vim/{}/{}/{}".format(self
.endpoint_url
, tenant_text
, datacenter
, item
, uuid
)
1085 self
.logger
.debug("GET %s", url
)
1086 mano_response
= requests
.get(url
, headers
=self
.headers_req
)
1087 self
.logger
.debug("RO response: %s", mano_response
.text
)
1088 content
= self
._parse
_yaml
(mano_response
.text
, response
=True)
1089 if mano_response
.status_code
== 200:
1092 raise ROClientException(str(content
), http_code
=mano_response
.status
)
1093 elif action
== "delete":
1094 url
= "{}{}/vim/{}/{}/{}".format(self
.endpoint_url
, tenant_text
, datacenter
, item
, uuid
)
1095 self
.logger
.debug("DELETE %s", url
)
1096 mano_response
= requests
.delete(url
, headers
=self
.headers_req
)
1097 self
.logger
.debug("RO response: %s", mano_response
.text
)
1098 content
= self
._parse
_yaml
(mano_response
.text
, response
=True)
1099 if mano_response
.status_code
== 200:
1102 raise ROClientException(str(content
), http_code
=mano_response
.status
)
1103 elif action
== "create":
1104 if "descriptor" in kwargs
:
1105 if isinstance(kwargs
["descriptor"], str):
1106 descriptor
= self
._parse
(kwargs
["descriptor"], kwargs
.get("descriptor_format"))
1108 descriptor
= kwargs
["descriptor"]
1109 elif "name" in kwargs
:
1110 descriptor
= {item
[:-1]: {"name": kwargs
["name"]}}
1112 raise ROClientException("Missing descriptor")
1114 if item
[:-1] not in descriptor
or len(descriptor
) != 1:
1115 raise ROClientException("Descriptor must contain only one 'tenant' field")
1116 if "name" in kwargs
:
1117 descriptor
[item
[:-1]]['name'] = kwargs
["name"]
1118 if "description" in kwargs
:
1119 descriptor
[item
[:-1]]['description'] = kwargs
["description"]
1120 payload_req
= yaml
.safe_dump(descriptor
)
1122 url
= "{}{}/vim/{}/{}".format(self
.endpoint_url
, tenant_text
, datacenter
, item
)
1123 self
.logger
.debug("RO POST %s %s", url
, payload_req
)
1124 mano_response
= requests
.post(url
, headers
=self
.headers_req
, data
=payload_req
)
1125 self
.logger
.debug("RO response: %s", mano_response
.text
)
1126 content
= self
._parse
_yaml
(mano_response
.text
, response
=True)
1127 if mano_response
.status_code
== 200:
1130 raise ROClientException(str(content
), http_code
=mano_response
.status
)
1132 raise ROClientException("Unknown value for action '{}".format(str(action
)))
1135 if __name__
== '__main__':
1136 RO_URL
= "http://localhost:9090/openmano"
1137 TEST_TENANT
= "myTenant"
1139 TEST_URL1
= "https://localhost:5000/v1"
1140 TEST_TYPE1
= "openstack"
1141 TEST_CONFIG1
= {"use_floating_ip": True}
1142 TEST_VIM2
= "myvim2"
1143 TEST_URL2
= "https://localhost:5000/v2"
1144 TEST_TYPE2
= "openvim"
1145 TEST_CONFIG2
= {"config2": "config2", "config3": True}
1147 streamformat
= "%(asctime)s %(name)s %(levelname)s: %(message)s"
1148 logging
.basicConfig(format
=streamformat
)
1149 logger
= logging
.getLogger("ROClient")
1153 loop
= asyncio
.get_event_loop()
1154 myClient
= ROClient(endpoint_url
=RO_URL
, loop
=loop
, loglevel
="DEBUG")
1157 content
= loop
.run_until_complete(myClient
.get_list("tenant"))
1158 print("tenants", content
)
1159 content
= loop
.run_until_complete(myClient
.create("tenant", name
=TEST_TENANT
))
1161 content
= loop
.run_until_complete(myClient
.show("tenant", TEST_TENANT
))
1162 print("tenant", TEST_TENANT
, content
)
1163 content
= loop
.run_until_complete(myClient
.edit("tenant", TEST_TENANT
, description
="another description"))
1164 content
= loop
.run_until_complete(myClient
.show("tenant", TEST_TENANT
))
1165 print("tenant edited", TEST_TENANT
, content
)
1166 myClient
["tenant"] = TEST_TENANT
1169 content
= loop
.run_until_complete(myClient
.create("vim", name
=TEST_VIM1
, type=TEST_TYPE1
, vim_url
=TEST_URL1
,
1170 config
=TEST_CONFIG1
))
1172 content
= loop
.run_until_complete(myClient
.get_list("vim"))
1173 print("vim", content
)
1174 content
= loop
.run_until_complete(myClient
.show("vim", TEST_VIM1
))
1175 print("vim", TEST_VIM1
, content
)
1176 content
= loop
.run_until_complete(myClient
.edit("vim", TEST_VIM1
, description
="another description",
1177 name
=TEST_VIM2
, type=TEST_TYPE2
, vim_url
=TEST_URL2
,
1178 config
=TEST_CONFIG2
))
1179 content
= loop
.run_until_complete(myClient
.show("vim", TEST_VIM2
))
1180 print("vim edited", TEST_VIM2
, content
)
1183 content
= loop
.run_until_complete(myClient
.attach_datacenter(TEST_VIM2
, vim_username
='user',
1184 vim_password
='pass', vim_tenant_name
='vimtenant1',
1185 config
=TEST_CONFIG1
))
1187 content
= loop
.run_until_complete(myClient
.get_list("vim_account"))
1188 print("vim_account", content
)
1189 content
= loop
.run_until_complete(myClient
.show("vim_account", TEST_VIM2
))
1190 print("vim_account", TEST_VIM2
, content
)
1191 content
= loop
.run_until_complete(myClient
.edit("vim_account", TEST_VIM2
, vim_username
='user2',
1192 vim_password
='pass2', vim_tenant_name
="vimtenant2",
1193 config
=TEST_CONFIG2
))
1194 content
= loop
.run_until_complete(myClient
.show("vim_account", TEST_VIM2
))
1195 print("vim_account edited", TEST_VIM2
, content
)
1197 myClient
["vim"] = TEST_VIM2
1199 except Exception as e
:
1200 logger
.error("Error {}".format(e
), exc_info
=True)
1202 for item
in (("vim_account", TEST_VIM1
), ("vim", TEST_VIM1
),
1203 ("vim_account", TEST_VIM2
), ("vim", TEST_VIM2
),
1204 ("tenant", TEST_TENANT
)):
1206 content
= loop
.run_until_complete(myClient
.delete(item
[0], item
[1]))
1207 print("{} {} deleted; {}".format(item
[0], item
[1], content
))
1208 except Exception as e
:
1209 if e
.http_code
== 404:
1210 print("{} {} not present or already deleted".format(item
[0], item
[1]))
1212 logger
.error("Error {}".format(e
), exc_info
=True)