3 # jose.lausuch@ericsson.com
4 # valentin.boucher@orange.com
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
25 # ############ CREDENTIALS OPENSTACK #############
26 def check_credentials():
28 Check if the OpenStack credentials (openrc) are sourced
30 env_vars = ['OS_AUTH_URL', 'OS_USERNAME', 'OS_PASSWORD', 'OS_TENANT_NAME']
31 return all(map(lambda v: v in os.environ and os.environ[v], env_vars))
34 def get_credentials(service):
35 """Returns a creds dictionary filled with the following keys:
37 * password/api_key (depending on the service)
38 * tenant_name/project_id (depending on the service)
40 :param service: a string indicating the name of the service
41 requesting the credentials.
44 # Unfortunately, each of the OpenStack client will request slightly
45 # different entries in their credentials dict.
46 if service.lower() in ("nova", "cinder"):
51 tenant = "tenant_name"
53 # The most common way to pass these info to the script is to do it through
54 # environment variables.
56 "username": os.environ.get('OS_USERNAME', "admin"),
57 password: os.environ.get("OS_PASSWORD", 'admin'),
58 "auth_url": os.environ.get("OS_AUTH_URL",
59 "http://192.168.20.71:5000/v2.0"),
60 tenant: os.environ.get("OS_TENANT_NAME", "admin"),
66 # ################ NOVA #################
67 def get_instances(nova_client):
69 instances = nova_client.servers.list(search_opts={'all_tenants': 1})
75 def get_instance_status(nova_client, instance):
77 instance = nova_client.servers.get(instance.id)
78 return instance.status
83 def get_instance_by_name(nova_client, instance_name):
85 instance = nova_client.servers.find(name=instance_name)
91 def get_flavor_id(nova_client, flavor_name):
92 flavors = nova_client.flavors.list(detailed=True)
95 if f.name == flavor_name:
101 def get_flavor_id_by_ram_range(nova_client, min_ram, max_ram):
102 flavors = nova_client.flavors.list(detailed=True)
105 if min_ram <= f.ram and f.ram <= max_ram:
111 def delete_instance(nova_client, instance_id):
113 nova_client.servers.force_delete(instance_id)
116 print "Error:", sys.exc_info()[0]
119 def create_floating_ip(neutron_client):
120 extnet_id = get_external_net_id(neutron_client)
121 props = {'floating_network_id': extnet_id}
123 ip_json = neutron_client.create_floatingip({'floatingip': props})
124 floating_ip = ip_json['floatingip']['floating_ip_address']
129 def get_floating_ips(nova_client):
131 floating_ips = nova_client.floating_ips.list()
136 def add_floating_ip(nova_client, server_id, floatingip_id):
138 nova_client.servers.add_floating_ip(server_id,floatingip_id)
141 print "Error:", sys.exc_info()[0]
144 def delete_floating_ip(nova_client, floatingip_id):
146 nova_client.floating_ips.delete(floatingip_id)
149 print "Error:", sys.exc_info()[0]
153 # ################ NEUTRON #################
154 def create_neutron_net(neutron_client, name):
155 json_body = {'network': {'name': name,
156 'admin_state_up': True}}
158 network = neutron_client.create_network(body=json_body)
159 network_dict = network['network']
160 return network_dict['id']
162 print "Error:", sys.exc_info()[0]
166 def update_neutron_net(neutron_client, network_id, shared=False):
167 json_body = {'network': {'shared': shared}}
169 neutron_client.update_network(network_id, body=json_body)
172 print "Error:", sys.exc_info()[0]
176 def delete_neutron_net(neutron_client, network_id):
178 neutron_client.delete_network(network_id)
181 print "Error:", sys.exc_info()[0]
185 def create_neutron_subnet(neutron_client, name, cidr, net_id):
186 json_body = {'subnets': [{'name': name, 'cidr': cidr,
187 'ip_version': 4, 'network_id': net_id}]}
189 subnet = neutron_client.create_subnet(body=json_body)
190 return subnet['subnets'][0]['id']
192 print "Error:", sys.exc_info()[0]
196 def delete_neutron_subnet(neutron_client, subnet_id):
198 neutron_client.delete_subnet(subnet_id)
201 print "Error:", sys.exc_info()[0]
205 def create_neutron_router(neutron_client, name):
206 json_body = {'router': {'name': name, 'admin_state_up': True}}
208 router = neutron_client.create_router(json_body)
209 return router['router']['id']
211 print "Error:", sys.exc_info()[0]
215 def delete_neutron_router(neutron_client, router_id):
216 json_body = {'router': {'id': router_id}}
218 neutron_client.delete_router(router=router_id)
221 print "Error:", sys.exc_info()[0]
225 def add_interface_router(neutron_client, router_id, subnet_id):
226 json_body = {"subnet_id": subnet_id}
228 neutron_client.add_interface_router(router=router_id, body=json_body)
231 print "Error:", sys.exc_info()[0]
235 def remove_interface_router(neutron_client, router_id, subnet_id):
236 json_body = {"subnet_id": subnet_id}
238 neutron_client.remove_interface_router(router=router_id,
242 print "Error:", sys.exc_info()[0]
245 def add_gateway_router(neutron_client, router_id):
246 ext_net_id = get_external_net_id(neutron_client)
247 router_dict = {'network_id': ext_net_id}
249 neutron_client.add_gateway_router(router_id,router_dict)
252 print "Error:", sys.exc_info()[0]
255 def remove_gateway_router(neutron_client, router_id):
257 neutron_client.remove_gateway_router(router_id)
260 print "Error:", sys.exc_info()[0]
264 def create_neutron_port(neutron_client, name, network_id, ip):
265 json_body = {'port': {
266 'admin_state_up': True,
268 'network_id': network_id,
269 'fixed_ips': [{"ip_address": ip}]
272 port = neutron_client.create_port(body=json_body)
273 return port['port']['id']
275 print "Error:", sys.exc_info()[0]
279 def update_neutron_port(neutron_client, port_id, device_owner):
280 json_body = {'port': {
281 'device_owner': device_owner,
284 port = neutron_client.update_port(port=port_id,
286 return port['port']['id']
288 print "Error:", sys.exc_info()[0]
292 def delete_neutron_port(neutron_client, port_id):
294 neutron_client.delete_port(port_id)
297 print "Error:", sys.exc_info()[0]
301 def get_network_id(neutron_client, network_name):
302 networks = neutron_client.list_networks()['networks']
305 if n['name'] == network_name:
311 def check_neutron_net(neutron_client, net_name):
312 for network in neutron_client.list_networks()['networks']:
313 if network['name'] == net_name:
314 for subnet in network['subnets']:
319 def get_network_list(neutron_client):
320 network_list = neutron_client.list_networks()['networks']
321 if len(network_list) == 0:
327 def get_router_list(neutron_client):
328 router_list = neutron_client.list_routers()['routers']
329 if len(router_list) == 0:
335 def get_port_list(neutron_client):
336 port_list = neutron_client.list_ports()['ports']
337 if len(port_list) == 0:
343 def get_external_net(neutron_client):
344 for network in neutron_client.list_networks()['networks']:
345 if network['router:external']:
346 return network['name']
350 def get_external_net_id(neutron_client):
351 for network in neutron_client.list_networks()['networks']:
352 if network['router:external']:
357 def update_sg_quota(neutron_client, tenant_id, sg_quota, sg_rule_quota):
358 json_body = {"quota": {
359 "security_group": sg_quota,
360 "security_group_rule": sg_rule_quota
364 quota = neutron_client.update_quota(tenant_id=tenant_id,
368 print "Error:", sys.exc_info()[0]
372 def update_cinder_quota(cinder_client, tenant_id, vols_quota,
373 snapshots_quota, gigabytes_quota):
374 quotas_values = {"volumes": vols_quota,
375 "snapshots": snapshots_quota,
376 "gigabytes": gigabytes_quota}
379 quotas_default = cinder_client.quotas.update(tenant_id,
383 print "Error:", sys.exc_info()[0]
387 def get_private_net(neutron_client):
388 # Checks if there is an existing shared private network
389 networks = neutron_client.list_networks()['networks']
390 if len(networks) == 0:
393 if (net['router:external'] is False) and (net['shared'] is True):
398 # ################ GLANCE #################
399 def get_images(nova_client):
401 images = nova_client.images.list()
407 def get_image_id(glance_client, image_name):
408 images = glance_client.images.list()
411 if i.name == image_name:
417 def create_glance_image(glance_client, image_name, file_path, public=True):
418 if not os.path.isfile(file_path):
419 print "Error: file " + file_path + " does not exist."
422 with open(file_path) as fimage:
423 image = glance_client.images.create(name=image_name,
426 container_format="bare",
430 print "Error:", sys.exc_info()[0]
434 def delete_glance_image(nova_client, image_id):
436 nova_client.images.delete(image_id)
439 print "Error:", sys.exc_info()[0]
443 # ################ CINDER #################
444 def get_volumes(cinder_client):
446 volumes = cinder_client.volumes.list(search_opts={'all_tenants': 1})
452 def delete_volume(cinder_client, volume_id, forced=False):
456 cinder_client.volumes.detach(volume_id)
458 print "Error:", sys.exc_info()[0]
459 cinder_client.volumes.force_delete(volume_id)
461 cinder_client.volumes.delete(volume_id)
464 print "Error:", sys.exc_info()[0]
468 # ################ CINDER #################
469 def get_security_groups(neutron_client):
471 security_groups = neutron_client.list_security_groups()[
473 return security_groups
478 def delete_security_group(neutron_client, secgroup_id):
480 neutron_client.delete_security_group(secgroup_id)
483 print "Error:", sys.exc_info()[0]
487 # ################ KEYSTONE #################
488 def get_tenants(keystone_client):
490 tenants = keystone_client.tenants.list()
496 def get_tenant_id(keystone_client, tenant_name):
497 tenants = keystone_client.tenants.list()
500 if t.name == tenant_name:
506 def get_users(keystone_client):
508 users = keystone_client.users.list()
514 def get_role_id(keystone_client, role_name):
515 roles = keystone_client.roles.list()
518 if r.name == role_name:
524 def get_user_id(keystone_client, user_name):
525 users = keystone_client.users.list()
528 if u.name == user_name:
534 def create_tenant(keystone_client, tenant_name, tenant_description):
536 tenant = keystone_client.tenants.create(tenant_name,
541 print "Error:", sys.exc_info()[0]
545 def delete_tenant(keystone_client, tenant_id):
547 tenant = keystone_client.tenants.delete(tenant_id)
550 print "Error:", sys.exc_info()[0]
554 def create_user(keystone_client, user_name, user_password,
555 user_email, tenant_id):
557 user = keystone_client.users.create(user_name, user_password,
558 user_email, tenant_id,
562 print "Error:", sys.exc_info()[0]
566 def delete_user(keystone_client, user_id):
568 tenant = keystone_client.users.delete(user_id)
571 print "Error:", sys.exc_info()[0]
575 def add_role_user(keystone_client, user_id, role_id, tenant_id):
577 keystone_client.roles.add_user_role(user_id, role_id, tenant_id)
580 print "Error:", sys.exc_info()[0]
584 # ################ UTILS #################
585 def check_internet_connectivity(url='http://www.opnfv.org/'):
587 Check if there is access to the internet
590 urllib2.urlopen(url, timeout=5)
592 except urllib2.URLError:
596 def download_url(url, dest_path):
598 Download a file to a destination path given a URL
600 name = url.rsplit('/')[-1]
601 dest = dest_path + "/" + name
603 response = urllib2.urlopen(url)
604 except (urllib2.HTTPError, urllib2.URLError):
607 with open(dest, 'wb') as f:
608 shutil.copyfileobj(response, f)
612 def execute_command(cmd, logger=None, exit_on_error=True):
614 Execute Linux command
617 logger.debug('Executing command : {}'.format(cmd))
618 output_file = "output.txt"
619 f = open(output_file, 'w+')
620 p = subprocess.call(cmd, shell=True, stdout=f, stderr=subprocess.STDOUT)
622 f = open(output_file, 'r')
624 if result != "" and logger:
630 logger.error("Error when executing command %s" % cmd)
636 def get_git_branch(repo_path):
640 repo = Repo(repo_path)
641 branch = repo.active_branch
645 def get_installer_type(logger=None):
647 Get installer type (fuel, apex, joid, compass)
650 installer = os.environ['INSTALLER_TYPE']
653 logger.error("Impossible to retrieve the installer type")
659 def get_pod_name(logger=None):
661 Get PoD Name from env variable NODE_NAME
664 return os.environ['NODE_NAME']
668 "Unable to retrieve the POD name from environment.Using pod name 'unknown-pod'")
672 def push_results_to_db(db_url, case_name, logger, pod_name,
673 git_version, payload):
674 url = db_url + "/results"
675 installer = get_installer_type(logger)
676 params = {"project_name": "functest", "case_name": case_name,
677 "pod_name": pod_name, "installer": installer,
678 "version": git_version, "details": payload}
680 headers = {'Content-Type': 'application/json'}
682 r = requests.post(url, data=json.dumps(params), headers=headers)
687 print "Error:", sys.exc_info()[0]
691 def get_resolvconf_ns():
693 rconf = open("/etc/resolv.conf", "r")
694 line = rconf.readline()
696 ip = re.search(r"\b(?:[0-9]{1,3}\.){3}[0-9]{1,3}\b", line)
698 nameservers.append(ip.group())
699 line = rconf.readline()
702 def getTestEnv(test, functest_yaml):
703 # get the config of the testcase based on functest_config.yaml
705 # - test = test project e.g; ovno
706 # - test = testcase e.g. functest/odl
707 # look for the / to see if it is a test project or a testcase
709 TEST_ENV = functest_yaml.get("test-dependencies")
711 if test.find("/") < 0:
712 config_test = TEST_ENV[test]
714 test_split = test.split("/")
715 testproject = test_split[0]
716 testcase = test_split[1]
717 config_test = TEST_ENV[testproject][testcase]
719 # if not defined in dependencies => no dependencies
722 print "Error getTestEnv:", sys.exc_info()[0]
727 def get_ci_envvars():
729 Get the CI env variables
732 "installer": os.environ.get('INSTALLER_TYPE'),
733 "scenario": os.environ.get('DEPLOY_SCENARIO')}
737 def isTestRunnable(test, functest_yaml):
738 # By default we assume that all the tests are always runnable...
740 # Retrieve CI environment
741 ci_env = get_ci_envvars()
742 # Retrieve test environement from config file
743 test_env = getTestEnv(test, functest_yaml)
745 # if test_env not empty => dependencies to be checked
746 if test_env is not None and len(test_env) > 0:
747 # possible criteria = ["installer", "scenario"]
748 # consider test criteria from config file
749 # compare towards CI env through CI en variable
750 for criteria in test_env:
751 if re.search(test_env[criteria], ci_env[criteria]) is None:
752 # print "Test "+ test + " cannot be run on the environment"
757 def generateTestcaseList(functest_yaml):
760 testcase_list = functest_yaml.get("test-dependencies")
761 projects = testcase_list.keys()
763 for project in projects:
764 testcases = testcase_list[project]
765 # 1 or 2 levels for testcases project[/case]
766 # if only project name without controller or scenario
767 # => shall be runnable on any controller/scenario
768 if testcases is None:
769 test_list += project + " "
771 for testcase in testcases:
772 if testcase == "installer" or testcase == "scenario":
774 if isTestRunnable(project, functest_yaml):
775 test_list += project + " "
777 # project/testcase (2 levels)
778 thetest = project + "/" + testcase
779 if isTestRunnable(thetest, functest_yaml):
780 test_list += testcase + " "
782 # sort the list to execute the test in the right order
783 test_order_list = functest_yaml.get("test_exec_priority")
784 test_sorted_list = ""
785 for test in test_order_list:
786 if test_order_list[test] in test_list:
787 test_sorted_list += test_order_list[test] + " "
789 # create a file that could be consumed by run-test.sh
790 # this method is used only for CI
791 # so it can be run only in container
792 # reuse default conf directory to store the list of runnable tests
793 file = open("/home/opnfv/functest/conf/testcase-list.txt", 'w')
794 file.write(test_sorted_list)
797 return test_sorted_list