3 # Copyright (c) 2016 Orange and others.
5 # All rights reserved. This program and the accompanying materials
6 # are made available under the terms of the Apache License, Version 2.0
7 # which accompanies this distribution, and is available at
8 # http://www.apache.org/licenses/LICENSE-2.0
10 """Orchestra Clearwater IMS testcase implementation."""
20 from snaps.openstack.create_image import OpenStackImage, ImageSettings
21 from snaps.openstack.create_flavor import OpenStackFlavor, FlavorSettings
22 from snaps.openstack.create_security_group import (
23 OpenStackSecurityGroup,
24 SecurityGroupSettings,
25 SecurityGroupRuleSettings,
28 from snaps.openstack.create_network import (
33 from snaps.openstack.create_router import OpenStackRouter, RouterSettings
34 from snaps.openstack.os_credentials import OSCreds
35 from snaps.openstack.create_instance import (
38 from functest.opnfv_tests.openstack.snaps import snaps_utils
40 import functest.core.vnf as vnf
41 import functest.utils.openstack_utils as os_utils
42 from functest.utils.constants import CONST
44 from org.openbaton.cli.errors.errors import NfvoException
45 from org.openbaton.cli.agents.agents import MainAgent
48 __author__ = "Pauls, Michael <michael.pauls@fokus.fraunhofer.de>"
49 # ----------------------------------------------------------
53 # -----------------------------------------------------------
56 def get_config(parameter, file_path):
60 Returns the value of a given parameter in file.yaml
61 parameter must be given in string format with dots
62 Example: general.openstack.image_name
64 with open(file_path) as config_file:
65 file_yaml = yaml.safe_load(config_file)
68 for element in parameter.split("."):
69 value = value.get(element)
71 raise ValueError("The parameter %s is not defined in"
72 " reporting.yaml", parameter)
76 def servertest(host, port):
77 """Method to test that a server is reachable at IP:port"""
78 args = socket.getaddrinfo(host, port, socket.AF_INET, socket.SOCK_STREAM)
79 for family, socktype, proto, canonname, sockaddr in args:
80 sock = socket.socket(family, socktype, proto)
82 sock.connect(sockaddr)
90 def get_userdata(orchestrator=dict):
91 """Build userdata for Open Baton machine"""
92 userdata = "#!/bin/bash\n"
93 userdata += "echo \"Executing userdata...\"\n"
94 userdata += "set -x\n"
95 userdata += "set -e\n"
96 userdata += "echo \"Set nameserver to '8.8.8.8'...\"\n"
97 userdata += "echo \"nameserver 8.8.8.8\" >> /etc/resolv.conf\n"
98 userdata += "echo \"Install curl...\"\n"
99 userdata += "apt-get install curl\n"
100 userdata += "echo \"Inject public key...\"\n"
101 userdata += ("echo \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCuPXrV3"
102 "geeHc6QUdyUr/1Z+yQiqLcOskiEGBiXr4z76MK4abiFmDZ18OMQlc"
103 "fl0p3kS0WynVgyaOHwZkgy/DIoIplONVr2CKBKHtPK+Qcme2PVnCtv"
104 "EqItl/FcD+1h5XSQGoa+A1TSGgCod/DPo+pes0piLVXP8Ph6QS1k7S"
105 "ic7JDeRQ4oT1bXYpJ2eWBDMfxIWKZqcZRiGPgMIbJ1iEkxbpeaAd9O"
106 "4MiM9nGCPESmed+p54uYFjwEDlAJZShcAZziiZYAvMZhvAhe6USljc"
107 "7YAdalAnyD/jwCHuwIrUw/lxo7UdNCmaUxeobEYyyFA1YVXzpNFZya"
108 "XPGAAYIJwEq/ openbaton@opnfv\" >> /home/ubuntu/.ssh/aut"
110 userdata += "echo \"Download bootstrap...\"\n"
111 userdata += ("curl -s %s "
112 "> ./bootstrap\n" % orchestrator['bootstrap']['url'])
113 userdata += ("curl -s %s" "> ./config_file\n" %
114 orchestrator['bootstrap']['config']['url'])
115 userdata += ("echo \"Disable usage of mysql...\"\n")
116 userdata += "sed -i s/mysql=.*/mysql=no/g /config_file\n"
117 userdata += ("echo \"Setting 'rabbitmq_broker_ip' to '%s'\"\n"
118 % orchestrator['details']['fip'].ip)
119 userdata += ("sed -i s/rabbitmq_broker_ip=localhost/rabbitmq_broker_ip"
120 "=%s/g /config_file\n" % orchestrator['details']['fip'].ip)
121 userdata += "echo \"Set autostart of components to 'false'\"\n"
122 userdata += "export OPENBATON_COMPONENT_AUTOSTART=false\n"
123 userdata += "echo \"Execute bootstrap...\"\n"
124 bootstrap = "sh ./bootstrap release -configFile=./config_file"
125 userdata += bootstrap + "\n"
126 userdata += "echo \"Setting 'nfvo.plugin.timeout' to '300000'\"\n"
127 userdata += ("echo \"nfvo.plugin.timeout=600000\" >> "
128 "/etc/openbaton/openbaton-nfvo.properties\n")
130 "wget %s -O /etc/openbaton/openbaton-vnfm-generic-user-data.sh\n" %
131 orchestrator['gvnfm']['userdata']['url'])
132 userdata += "sed -i '113i"'\ \ \ \ '"sleep 60' " \
133 "/etc/openbaton/openbaton-vnfm-generic-user-data.sh\n"
134 userdata += "echo \"Starting NFVO\"\n"
135 userdata += "service openbaton-nfvo restart\n"
136 userdata += "echo \"Starting Generic VNFM\"\n"
137 userdata += "service openbaton-vnfm-generic restart\n"
138 userdata += "echo \"...end of userdata...\"\n"
142 class ClearwaterImsVnf(vnf.VnfOnBoarding):
143 """Clearwater IMS VNF deployed with openBaton orchestrator"""
145 logger = logging.getLogger(__name__)
147 def __init__(self, **kwargs):
148 if "case_name" not in kwargs:
149 kwargs["case_name"] = "orchestra_clearwaterims"
150 super(ClearwaterImsVnf, self).__init__(**kwargs)
151 # self.logger = logging.getLogger("functest.ci.run_tests.orchestra")
152 self.logger.info("kwargs %s", (kwargs))
154 self.case_dir = pkg_resources.resource_filename(
155 'functest', 'opnfv_tests/vnf/ims/')
156 self.data_dir = CONST.__getattribute__('dir_ims_data')
157 self.test_dir = CONST.__getattribute__('dir_repo_vims_test')
158 self.created_resources = []
159 self.logger.info("%s VNF onboarding test starting", self.case_name)
162 self.config = CONST.__getattribute__(
163 'vnf_{}_config'.format(self.case_name))
164 except BaseException:
165 raise Exception("Orchestra VNF config file not found")
166 config_file = self.case_dir + self.config
169 get_config("mano", config_file),
172 self.logger.debug("Orchestrator configuration %s", self.mano)
174 self.details['orchestrator'] = dict(
175 name=self.mano['name'],
176 version=self.mano['version'],
182 get_config(self.case_name, config_file),
184 self.logger.debug("VNF configuration: %s", self.vnf)
186 self.details['vnf'] = dict(
187 name=self.vnf['name'],
190 self.details['test_vnf'] = dict(
194 # Orchestra base Data directory creation
195 if not os.path.exists(self.data_dir):
196 os.makedirs(self.data_dir)
198 self.images = get_config("tenant_images.orchestrator", config_file)
204 self.snaps_creds = None
207 """Prepare testscase (Additional pre-configuration steps)."""
208 super(ClearwaterImsVnf, self).prepare()
210 self.logger.info("Additional pre-configuration steps")
211 self.logger.info("creds %s", (self.creds))
213 self.snaps_creds = OSCreds(
214 username=self.creds['username'],
215 password=self.creds['password'],
216 auth_url=self.creds['auth_url'],
217 project_name=self.creds['tenant'],
218 identity_api_version=int(os_utils.get_keystone_client_version()))
220 self.prepare_images()
221 self.prepare_flavor()
222 self.prepare_security_groups()
223 self.prepare_network()
224 self.prepare_floating_ip()
226 def prepare_images(self):
227 """Upload images if they doen't exist yet"""
228 self.logger.info("Upload images if they doen't exist yet")
229 for image_name, image_file in self.images.iteritems():
230 self.logger.info("image: %s, file: %s", image_name, image_file)
231 if image_file and image_name:
232 image = OpenStackImage(
234 ImageSettings(name=image_name,
237 image_file=image_file,
240 # self.created_resources.append(image);
242 def prepare_security_groups(self):
243 """Create Open Baton security group if it doesn't exist yet"""
245 "Creating security group for Open Baton if not yet existing...")
248 SecurityGroupRuleSettings(
249 sec_grp_name="orchestra-sec-group-allowall",
250 direction=Direction.ingress,
251 protocol=Protocol.tcp,
253 port_range_max=65535))
255 SecurityGroupRuleSettings(
256 sec_grp_name="orchestra-sec-group-allowall",
257 direction=Direction.egress,
258 protocol=Protocol.tcp,
260 port_range_max=65535))
262 SecurityGroupRuleSettings(
263 sec_grp_name="orchestra-sec-group-allowall",
264 direction=Direction.ingress,
265 protocol=Protocol.udp,
267 port_range_max=65535))
269 SecurityGroupRuleSettings(
270 sec_grp_name="orchestra-sec-group-allowall",
271 direction=Direction.egress,
272 protocol=Protocol.udp,
274 port_range_max=65535))
276 SecurityGroupRuleSettings(
277 sec_grp_name="orchestra-sec-group-allowall",
278 direction=Direction.ingress,
279 protocol=Protocol.icmp))
281 SecurityGroupRuleSettings(
282 sec_grp_name="orchestra-sec-group-allowall",
283 direction=Direction.egress,
284 protocol=Protocol.icmp))
286 # SecurityGroupRuleSettings(
287 # sec_grp_name="orchestra-sec-group-allowall",
288 # direction=Direction.ingress,
289 # protocol=Protocol.icmp,
291 # port_range_max=-1))
293 # SecurityGroupRuleSettings(
294 # sec_grp_name="orchestra-sec-group-allowall",
295 # direction=Direction.egress,
296 # protocol=Protocol.icmp,
298 # port_range_max=-1))
300 security_group = OpenStackSecurityGroup(
302 SecurityGroupSettings(
303 name="orchestra-sec-group-allowall",
304 rule_settings=sg_rules))
306 security_group_info = security_group.create()
307 self.created_resources.append(security_group)
308 self.mano['details']['sec_group'] = security_group_info.name
310 "Security group orchestra-sec-group-allowall prepared")
312 def prepare_flavor(self):
313 """Create Open Baton flavor if it doesn't exist yet"""
315 "Create Flavor for Open Baton NFVO if not yet existing")
317 flavor_settings = FlavorSettings(
318 name=self.mano['requirements']['flavor']['name'],
319 ram=self.mano['requirements']['flavor']['ram_min'],
320 disk=self.mano['requirements']['flavor']['disk'],
321 vcpus=self.mano['requirements']['flavor']['vcpus'])
322 flavor = OpenStackFlavor(self.snaps_creds, flavor_settings)
323 flavor_info = flavor.create()
324 self.created_resources.append(flavor)
325 self.mano['details']['flavor'] = {}
326 self.mano['details']['flavor']['name'] = flavor_settings.name
327 self.mano['details']['flavor']['id'] = flavor_info.id
329 def prepare_network(self):
330 """Create network/subnet/router if they doen't exist yet"""
332 "Creating network/subnet/router if they doen't exist yet...")
333 subnet_settings = SubnetSettings(
336 cidr="192.168.100.0/24")
337 network_settings = NetworkSettings(
340 subnet_settings=[subnet_settings])
341 orchestra_network = OpenStackNetwork(
342 self.snaps_creds, network_settings)
343 orchestra_network_info = orchestra_network.create()
344 self.mano['details']['network'] = {}
345 self.mano['details']['network']['id'] = orchestra_network_info.id
346 self.mano['details']['network']['name'] = orchestra_network_info.name
347 self.mano['details']['external_net_name'] = snaps_utils.\
348 get_ext_net_name(self.snaps_creds)
349 self.created_resources.append(orchestra_network)
350 orchestra_router = OpenStackRouter(
355 external_gateway=self.mano['details']['external_net_name'],
357 subnet_settings.name]))
358 orchestra_router.create()
359 self.created_resources.append(orchestra_router)
360 self.logger.info("Created network and router for Open Baton NFVO...")
362 def prepare_floating_ip(self):
363 """Select/Create Floating IP if it doesn't exist yet"""
364 self.logger.info("Retrieving floating IP for Open Baton NFVO")
365 neutron_client = snaps_utils.neutron_utils.neutron_client(
367 # Finding Tenant ID to check to which tenant the Floating IP belongs
368 tenant_id = os_utils.get_tenant_id(
369 os_utils.get_keystone_client(self.creds),
371 # Use os_utils to retrieve complete information of Floating IPs
372 floating_ips = os_utils.get_floating_ips(neutron_client)
374 # Filter Floating IPs with tenant id
375 for floating_ip in floating_ips:
376 # self.logger.info("Floating IP: %s", floating_ip)
377 if floating_ip.get('tenant_id') == tenant_id:
378 my_floating_ips.append(floating_ip.get('floating_ip_address'))
379 # Select if Floating IP exist else create new one
380 if len(my_floating_ips) >= 1:
381 # Get Floating IP object from snaps for clean up
382 snaps_floating_ips = snaps_utils.neutron_utils.get_floating_ips(
384 for my_floating_ip in my_floating_ips:
385 for snaps_floating_ip in snaps_floating_ips:
386 if snaps_floating_ip.ip == my_floating_ip:
387 self.mano['details']['fip'] = snaps_floating_ip
389 "Selected floating IP for Open Baton NFVO %s",
390 (self.mano['details']['fip'].ip))
392 if self.mano['details']['fip'] is not None:
395 self.logger.info("Creating floating IP for Open Baton NFVO")
396 self.mano['details']['fip'] = snaps_utils.neutron_utils.\
399 self.mano['details']['external_net_name'])
401 "Created floating IP for Open Baton NFVO %s",
402 (self.mano['details']['fip'].ip))
404 def get_vim_descriptor(self):
405 """"Create VIM descriptor to be used for onboarding"""
407 "Building VIM descriptor with PoP creds: %s",
409 # Depending on API version either tenant ID or project name must be
411 if os_utils.is_keystone_v3():
413 "Using v3 API of OpenStack... -> Using OS_PROJECT_ID")
414 project_id = os_utils.get_tenant_id(
415 os_utils.get_keystone_client(),
416 self.creds.get("project_name"))
419 "Using v2 API of OpenStack... -> Using OS_TENANT_NAME")
420 project_id = self.creds.get("tenant_name")
421 self.logger.debug("VIM project/tenant id: %s", project_id)
423 "name": "vim-instance",
424 "authUrl": self.creds.get("auth_url"),
425 "tenant": project_id,
426 "username": self.creds.get("username"),
427 "password": self.creds.get("password"),
429 self.mano['details']['sec_group']
434 "latitude": "52.525876",
435 "longitude": "13.314400"
438 self.logger.info("Built VIM descriptor: %s", vim_json)
441 def deploy_orchestrator(self):
442 self.logger.info("Deploying Open Baton...")
443 self.logger.info("Details: %s", self.mano['details'])
444 start_time = time.time()
446 self.logger.info("Creating orchestra instance...")
447 userdata = get_userdata(self.mano)
448 self.logger.info("flavor: %s\n"
451 self.mano['details']['flavor']['name'],
452 self.mano['requirements']['image'],
453 self.mano['details']['network']['id'])
454 self.logger.debug("userdata: %s\n", userdata)
456 image_settings = ImageSettings(
457 name=self.mano['requirements']['image'],
461 port_settings = PortSettings(
462 name='%s_port' % self.case_name,
463 network_name=self.mano['details']['network']['name'])
464 # build configuration of vm
465 orchestra_settings = VmInstanceSettings(
467 flavor=self.mano['details']['flavor']['name'],
468 port_settings=[port_settings],
469 security_group_names=[self.mano['details']['sec_group']],
471 orchestra_vm = OpenStackVmInstance(self.snaps_creds,
475 orchestra_vm.create()
476 self.created_resources.append(orchestra_vm)
477 self.mano['details']['id'] = orchestra_vm.get_vm_info()['id']
479 "Created orchestra instance: %s",
480 self.mano['details']['id'])
482 self.logger.info("Associating floating ip: '%s' to VM '%s' ",
483 self.mano['details']['fip'].ip,
485 nova_client = os_utils.get_nova_client()
486 if not os_utils.add_floating_ip(
488 self.mano['details']['id'],
489 self.mano['details']['fip'].ip):
490 duration = time.time() - start_time
491 self.details["orchestrator"].update(
492 status='FAIL', duration=duration)
493 self.logger.error("Cannot associate floating IP to VM.")
496 self.logger.info("Waiting for Open Baton NFVO to be up and running...")
500 self.mano['details']['fip'].ip,
505 "Open Baton NFVO is not started yet (%ss)",
511 duration = time.time() - start_time
512 self.details["orchestrator"].update(
513 status='FAIL', duration=duration)
514 self.logger.error("Open Baton is not started correctly")
517 self.logger.info("Waiting for all components to be up and running...")
519 duration = time.time() - start_time
520 self.details["orchestrator"].update(status='PASS', duration=duration)
521 self.logger.info("Deploy Open Baton NFVO: OK")
524 def deploy_vnf(self):
525 start_time = time.time()
526 self.logger.info("Deploying %s...", self.vnf['name'])
528 main_agent = MainAgent(
529 nfvo_ip=self.mano['details']['fip'].ip,
533 username=self.mano['credentials']['username'],
534 password=self.mano['credentials']['password'])
537 "Create %s Flavor if not existing", self.vnf['name'])
538 flavor_settings = FlavorSettings(
539 name=self.vnf['requirements']['flavor']['name'],
540 ram=self.vnf['requirements']['flavor']['ram_min'],
541 disk=self.vnf['requirements']['flavor']['disk'],
542 vcpus=self.vnf['requirements']['flavor']['vcpus'])
543 flavor = OpenStackFlavor(self.snaps_creds, flavor_settings)
544 flavor_info = flavor.create()
545 self.logger.debug("Flavor id: %s", flavor_info.id)
547 self.logger.info("Getting project 'default'...")
548 project_agent = main_agent.get_agent("project", "")
549 for project in json.loads(project_agent.find()):
550 if project.get("name") == "default":
551 self.mano['details']['project_id'] = project.get("id")
552 self.logger.info("Found project 'default': %s", project)
555 vim_json = self.get_vim_descriptor()
556 self.logger.info("Registering VIM: %s", vim_json)
558 main_agent.get_agent(
559 "vim", project_id=self.mano['details']['project_id']).create(
560 entity=json.dumps(vim_json))
562 market_agent = main_agent.get_agent(
563 "market", project_id=self.mano['details']['project_id'])
566 self.logger.info("sending: %s", self.vnf['descriptor']['url'])
567 nsd = market_agent.create(entity=self.vnf['descriptor']['url'])
568 if nsd.get('id') is None:
569 self.logger.error("NSD not onboarded correctly")
570 duration = time.time() - start_time
571 self.details["vnf"].update(status='FAIL', duration=duration)
573 self.mano['details']['nsd_id'] = nsd.get('id')
574 self.logger.info("Onboarded NSD: " + nsd.get("name"))
576 nsr_agent = main_agent.get_agent(
577 "nsr", project_id=self.mano['details']['project_id'])
579 self.mano['details']['nsr'] = nsr_agent.create(
580 self.mano['details']['nsd_id'])
581 except NfvoException as exc:
582 self.logger.error(exc.message)
583 duration = time.time() - start_time
584 self.details["vnf"].update(status='FAIL', duration=duration)
587 if self.mano['details']['nsr'].get('code') is not None:
589 "%s cannot be deployed: %s -> %s",
591 self.mano['details']['nsr'].get('code'),
592 self.mano['details']['nsr'].get('message'))
593 self.logger.error("%s cannot be deployed", self.vnf['name'])
594 duration = time.time() - start_time
595 self.details["vnf"].update(status='FAIL', duration=duration)
599 self.logger.info("Waiting for NSR to go to ACTIVE...")
600 while self.mano['details']['nsr'].get("status") != 'ACTIVE' \
601 and self.mano['details']['nsr'].get("status") != 'ERROR':
603 self.logger.info("NSR is not yet ACTIVE... (%ss)", 5 * timeout)
605 self.logger.error("INACTIVE NSR after %s sec..", 5 * timeout)
606 duration = time.time() - start_time
607 self.details["vnf"].update(status='FAIL', duration=duration)
610 self.mano['details']['nsr'] = json.loads(
611 nsr_agent.find(self.mano['details']['nsr'].get('id')))
613 duration = time.time() - start_time
614 if self.mano['details']['nsr'].get("status") == 'ACTIVE':
615 self.details["vnf"].update(status='PASS', duration=duration)
616 self.logger.info("Sleep for 60s to ensure that all "
617 "services are up and running...")
621 self.details["vnf"].update(status='FAIL', duration=duration)
622 self.logger.error("NSR: %s", self.mano['details'].get('nsr'))
628 "Testing VNF Clearwater IMS is not yet implemented...")
629 start_time = time.time()
631 duration = time.time() - start_time
632 self.details["test_vnf"].update(status='PASS', duration=duration)
633 self.logger.info("Test VNF: OK")
637 self.logger.info("Cleaning %s...", self.case_name)
639 main_agent = MainAgent(
640 nfvo_ip=self.mano['details']['fip'].ip,
644 username=self.mano['credentials']['username'],
645 password=self.mano['credentials']['password'])
646 self.logger.info("Terminating %s...", self.vnf['name'])
647 if (self.mano['details'].get('nsr')):
648 main_agent.get_agent(
650 project_id=self.mano['details']['project_id']).delete(
651 self.mano['details']['nsr'].get('id'))
652 self.logger.info("Sleeping 60 seconds...")
655 self.logger.info("No need to terminate the VNF...")
656 # os_utils.delete_instance(nova_client=os_utils.get_nova_client(),
657 # instance_id=self.mano_instance_id)
658 except (NfvoException, KeyError) as exc:
659 self.logger.error('Unexpected error cleaning - %s', exc)
662 neutron_client = os_utils.get_neutron_client(self.creds)
663 self.logger.info("Deleting Open Baton Port...")
664 port = snaps_utils.neutron_utils.get_port(
666 port_name='%s_port' % self.case_name)
667 snaps_utils.neutron_utils.delete_port(neutron_client, port)
669 except Exception as exc:
670 self.logger.error('Unexpected error cleaning - %s', exc)
672 self.logger.info("Deleting Open Baton Floating IP...")
673 snaps_utils.neutron_utils.delete_floating_ip(
674 neutron_client, self.mano['details']['fip'])
675 except Exception as exc:
676 self.logger.error('Unexpected error cleaning - %s', exc)
678 for resource in reversed(self.created_resources):
680 self.logger.info("Cleaning %s", str(resource))
682 except Exception as exc:
683 self.logger.error('Unexpected error cleaning - %s', exc)
684 super(ClearwaterImsVnf, self).clean()