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
26 # ############ CREDENTIALS OPENSTACK #############
27 def check_credentials():
29 Check if the OpenStack credentials (openrc) are sourced
31 env_vars = ['OS_AUTH_URL', 'OS_USERNAME', 'OS_PASSWORD', 'OS_TENANT_NAME']
32 return all(map(lambda v: v in os.environ and os.environ[v], env_vars))
35 def get_credentials(service):
36 """Returns a creds dictionary filled with the following keys:
38 * password/api_key (depending on the service)
39 * tenant_name/project_id (depending on the service)
41 :param service: a string indicating the name of the service
42 requesting the credentials.
45 # Unfortunately, each of the OpenStack client will request slightly
46 # different entries in their credentials dict.
47 if service.lower() in ("nova", "cinder"):
52 tenant = "tenant_name"
54 # The most common way to pass these info to the script is to do it through
55 # environment variables.
57 "username": os.environ.get('OS_USERNAME', "admin"),
58 password: os.environ.get("OS_PASSWORD", 'admin'),
59 "auth_url": os.environ.get("OS_AUTH_URL",
60 "http://192.168.20.71:5000/v2.0"),
61 tenant: os.environ.get("OS_TENANT_NAME", "admin"),
67 # ################ NOVA #################
68 def get_instances(nova_client):
70 instances = nova_client.servers.list(search_opts={'all_tenants': 1})
76 def get_instance_status(nova_client, instance):
78 instance = nova_client.servers.get(instance.id)
79 return instance.status
84 def get_instance_by_name(nova_client, instance_name):
86 instance = nova_client.servers.find(name=instance_name)
91 def create_flavor(nova_client, flavor_name, ram, disk, vcpus):
93 flavor = nova_client.flavors.create(flavor_name,ram,vcpus,disk)
98 def get_flavor_id(nova_client, flavor_name):
99 flavors = nova_client.flavors.list(detailed=True)
102 if f.name == flavor_name:
108 def get_flavor_id_by_ram_range(nova_client, min_ram, max_ram):
109 flavors = nova_client.flavors.list(detailed=True)
112 if min_ram <= f.ram and f.ram <= max_ram:
118 def delete_instance(nova_client, instance_id):
120 nova_client.servers.force_delete(instance_id)
123 print "Error:", sys.exc_info()[0]
126 def create_floating_ip(neutron_client):
127 extnet_id = get_external_net_id(neutron_client)
128 props = {'floating_network_id': extnet_id}
130 ip_json = neutron_client.create_floatingip({'floatingip': props})
131 floating_ip = ip_json['floatingip']['floating_ip_address']
136 def get_floating_ips(nova_client):
138 floating_ips = nova_client.floating_ips.list()
143 def add_floating_ip(nova_client, server_id, floatingip_id):
145 nova_client.servers.add_floating_ip(server_id,floatingip_id)
148 print "Error:", sys.exc_info()[0]
151 def delete_floating_ip(nova_client, floatingip_id):
153 nova_client.floating_ips.delete(floatingip_id)
156 print "Error:", sys.exc_info()[0]
160 # ################ NEUTRON #################
161 def create_neutron_net(neutron_client, name):
162 json_body = {'network': {'name': name,
163 'admin_state_up': True}}
165 network = neutron_client.create_network(body=json_body)
166 network_dict = network['network']
167 return network_dict['id']
169 print "Error:", sys.exc_info()[0]
173 def update_neutron_net(neutron_client, network_id, shared=False):
174 json_body = {'network': {'shared': shared}}
176 neutron_client.update_network(network_id, body=json_body)
179 print "Error:", sys.exc_info()[0]
183 def delete_neutron_net(neutron_client, network_id):
185 neutron_client.delete_network(network_id)
188 print "Error:", sys.exc_info()[0]
192 def create_neutron_subnet(neutron_client, name, cidr, net_id):
193 json_body = {'subnets': [{'name': name, 'cidr': cidr,
194 'ip_version': 4, 'network_id': net_id}]}
196 subnet = neutron_client.create_subnet(body=json_body)
197 return subnet['subnets'][0]['id']
199 print "Error:", sys.exc_info()[0]
203 def delete_neutron_subnet(neutron_client, subnet_id):
205 neutron_client.delete_subnet(subnet_id)
208 print "Error:", sys.exc_info()[0]
212 def create_neutron_router(neutron_client, name):
213 json_body = {'router': {'name': name, 'admin_state_up': True}}
215 router = neutron_client.create_router(json_body)
216 return router['router']['id']
218 print "Error:", sys.exc_info()[0]
222 def delete_neutron_router(neutron_client, router_id):
223 json_body = {'router': {'id': router_id}}
225 neutron_client.delete_router(router=router_id)
228 print "Error:", sys.exc_info()[0]
232 def add_interface_router(neutron_client, router_id, subnet_id):
233 json_body = {"subnet_id": subnet_id}
235 neutron_client.add_interface_router(router=router_id, body=json_body)
238 print "Error:", sys.exc_info()[0]
242 def remove_interface_router(neutron_client, router_id, subnet_id):
243 json_body = {"subnet_id": subnet_id}
245 neutron_client.remove_interface_router(router=router_id,
249 print "Error:", sys.exc_info()[0]
252 def add_gateway_router(neutron_client, router_id):
253 ext_net_id = get_external_net_id(neutron_client)
254 router_dict = {'network_id': ext_net_id}
256 neutron_client.add_gateway_router(router_id,router_dict)
259 print "Error:", sys.exc_info()[0]
262 def remove_gateway_router(neutron_client, router_id):
264 neutron_client.remove_gateway_router(router_id)
267 print "Error:", sys.exc_info()[0]
271 def create_neutron_port(neutron_client, name, network_id, ip):
272 json_body = {'port': {
273 'admin_state_up': True,
275 'network_id': network_id,
276 'fixed_ips': [{"ip_address": ip}]
279 port = neutron_client.create_port(body=json_body)
280 return port['port']['id']
282 print "Error:", sys.exc_info()[0]
286 def update_neutron_port(neutron_client, port_id, device_owner):
287 json_body = {'port': {
288 'device_owner': device_owner,
291 port = neutron_client.update_port(port=port_id,
293 return port['port']['id']
295 print "Error:", sys.exc_info()[0]
299 def delete_neutron_port(neutron_client, port_id):
301 neutron_client.delete_port(port_id)
304 print "Error:", sys.exc_info()[0]
308 def get_network_id(neutron_client, network_name):
309 networks = neutron_client.list_networks()['networks']
312 if n['name'] == network_name:
318 def check_neutron_net(neutron_client, net_name):
319 for network in neutron_client.list_networks()['networks']:
320 if network['name'] == net_name:
321 for subnet in network['subnets']:
326 def get_network_list(neutron_client):
327 network_list = neutron_client.list_networks()['networks']
328 if len(network_list) == 0:
334 def get_router_list(neutron_client):
335 router_list = neutron_client.list_routers()['routers']
336 if len(router_list) == 0:
342 def get_port_list(neutron_client):
343 port_list = neutron_client.list_ports()['ports']
344 if len(port_list) == 0:
350 def get_external_net(neutron_client):
351 for network in neutron_client.list_networks()['networks']:
352 if network['router:external']:
353 return network['name']
357 def get_external_net_id(neutron_client):
358 for network in neutron_client.list_networks()['networks']:
359 if network['router:external']:
364 def update_sg_quota(neutron_client, tenant_id, sg_quota, sg_rule_quota):
365 json_body = {"quota": {
366 "security_group": sg_quota,
367 "security_group_rule": sg_rule_quota
371 quota = neutron_client.update_quota(tenant_id=tenant_id,
375 print "Error:", sys.exc_info()[0]
379 def update_cinder_quota(cinder_client, tenant_id, vols_quota,
380 snapshots_quota, gigabytes_quota):
381 quotas_values = {"volumes": vols_quota,
382 "snapshots": snapshots_quota,
383 "gigabytes": gigabytes_quota}
386 quotas_default = cinder_client.quotas.update(tenant_id,
390 print "Error:", sys.exc_info()[0]
394 def get_private_net(neutron_client):
395 # Checks if there is an existing shared private network
396 networks = neutron_client.list_networks()['networks']
397 if len(networks) == 0:
400 if (net['router:external'] is False) and (net['shared'] is True):
405 # ################ GLANCE #################
406 def get_images(nova_client):
408 images = nova_client.images.list()
414 def get_image_id(glance_client, image_name):
415 images = glance_client.images.list()
418 if i.name == image_name:
424 def create_glance_image(glance_client, image_name, file_path, public=True):
425 if not os.path.isfile(file_path):
426 print "Error: file " + file_path + " does not exist."
429 with open(file_path) as fimage:
430 image = glance_client.images.create(name=image_name,
433 container_format="bare",
437 print "Error:", sys.exc_info()[0]
441 def delete_glance_image(nova_client, image_id):
443 nova_client.images.delete(image_id)
446 print "Error:", sys.exc_info()[0]
450 # ################ CINDER #################
451 def get_volumes(cinder_client):
453 volumes = cinder_client.volumes.list(search_opts={'all_tenants': 1})
459 def delete_volume(cinder_client, volume_id, forced=False):
463 cinder_client.volumes.detach(volume_id)
465 print "Error:", sys.exc_info()[0]
466 cinder_client.volumes.force_delete(volume_id)
468 cinder_client.volumes.delete(volume_id)
471 print "Error:", sys.exc_info()[0]
475 # ################ CINDER #################
476 def get_security_groups(neutron_client):
478 security_groups = neutron_client.list_security_groups()[
480 return security_groups
485 def delete_security_group(neutron_client, secgroup_id):
487 neutron_client.delete_security_group(secgroup_id)
490 print "Error:", sys.exc_info()[0]
494 # ################ KEYSTONE #################
495 def get_tenants(keystone_client):
497 tenants = keystone_client.tenants.list()
503 def get_tenant_id(keystone_client, tenant_name):
504 tenants = keystone_client.tenants.list()
507 if t.name == tenant_name:
513 def get_users(keystone_client):
515 users = keystone_client.users.list()
521 def get_role_id(keystone_client, role_name):
522 roles = keystone_client.roles.list()
525 if r.name == role_name:
531 def get_user_id(keystone_client, user_name):
532 users = keystone_client.users.list()
535 if u.name == user_name:
541 def create_tenant(keystone_client, tenant_name, tenant_description):
543 tenant = keystone_client.tenants.create(tenant_name,
548 print "Error:", sys.exc_info()[0]
552 def delete_tenant(keystone_client, tenant_id):
554 tenant = keystone_client.tenants.delete(tenant_id)
557 print "Error:", sys.exc_info()[0]
561 def create_user(keystone_client, user_name, user_password,
562 user_email, tenant_id):
564 user = keystone_client.users.create(user_name, user_password,
565 user_email, tenant_id,
569 print "Error:", sys.exc_info()[0]
573 def delete_user(keystone_client, user_id):
575 tenant = keystone_client.users.delete(user_id)
578 print "Error:", sys.exc_info()[0]
582 def add_role_user(keystone_client, user_id, role_id, tenant_id):
584 keystone_client.roles.add_user_role(user_id, role_id, tenant_id)
587 print "Error:", sys.exc_info()[0]
591 # ################ UTILS #################
592 def check_internet_connectivity(url='http://www.opnfv.org/'):
594 Check if there is access to the internet
597 urllib2.urlopen(url, timeout=5)
599 except urllib2.URLError:
603 def download_url(url, dest_path):
605 Download a file to a destination path given a URL
607 name = url.rsplit('/')[-1]
608 dest = dest_path + "/" + name
610 response = urllib2.urlopen(url)
611 except (urllib2.HTTPError, urllib2.URLError):
614 with open(dest, 'wb') as f:
615 shutil.copyfileobj(response, f)
619 def execute_command(cmd, logger=None, exit_on_error=True):
621 Execute Linux command
624 logger.debug('Executing command : {}'.format(cmd))
625 output_file = "output.txt"
626 f = open(output_file, 'w+')
627 p = subprocess.call(cmd, shell=True, stdout=f, stderr=subprocess.STDOUT)
629 f = open(output_file, 'r')
631 if result != "" and logger:
637 logger.error("Error when executing command %s" % cmd)
643 def get_git_branch(repo_path):
647 repo = Repo(repo_path)
648 branch = repo.active_branch
652 def get_installer_type(logger=None):
654 Get installer type (fuel, apex, joid, compass)
657 installer = os.environ['INSTALLER_TYPE']
660 logger.error("Impossible to retrieve the installer type")
666 def get_pod_name(logger=None):
668 Get PoD Name from env variable NODE_NAME
671 return os.environ['NODE_NAME']
675 "Unable to retrieve the POD name from environment.Using pod name 'unknown-pod'")
679 def push_results_to_db(db_url, case_name, logger, pod_name,
680 git_version, payload):
681 url = db_url + "/results"
682 installer = get_installer_type(logger)
683 params = {"project_name": "functest", "case_name": case_name,
684 "pod_name": pod_name, "installer": installer,
685 "version": git_version, "details": payload}
687 headers = {'Content-Type': 'application/json'}
689 r = requests.post(url, data=json.dumps(params), headers=headers)
694 print "Error:", sys.exc_info()[0]
698 def get_resolvconf_ns():
700 rconf = open("/etc/resolv.conf", "r")
701 line = rconf.readline()
703 ip = re.search(r"\b(?:[0-9]{1,3}\.){3}[0-9]{1,3}\b", line)
704 sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
706 result = sock.connect_ex((ip.group(),53))
708 nameservers.append(ip.group())
709 line = rconf.readline()
712 def getTestEnv(test, functest_yaml):
713 # get the config of the testcase based on functest_config.yaml
715 # - test = test project e.g; ovno
716 # - test = testcase e.g. functest/odl
717 # look for the / to see if it is a test project or a testcase
719 TEST_ENV = functest_yaml.get("test-dependencies")
721 if test.find("/") < 0:
722 config_test = TEST_ENV[test]
724 test_split = test.split("/")
725 testproject = test_split[0]
726 testcase = test_split[1]
727 config_test = TEST_ENV[testproject][testcase]
729 # if not defined in dependencies => no dependencies
732 print "Error getTestEnv:", sys.exc_info()[0]
737 def get_ci_envvars():
739 Get the CI env variables
742 "installer": os.environ.get('INSTALLER_TYPE'),
743 "scenario": os.environ.get('DEPLOY_SCENARIO')}
747 def isTestRunnable(test, functest_yaml):
748 # By default we assume that all the tests are always runnable...
750 # Retrieve CI environment
751 ci_env = get_ci_envvars()
752 # Retrieve test environement from config file
753 test_env = getTestEnv(test, functest_yaml)
755 # if test_env not empty => dependencies to be checked
756 if test_env is not None and len(test_env) > 0:
757 # possible criteria = ["installer", "scenario"]
758 # consider test criteria from config file
759 # compare towards CI env through CI en variable
760 for criteria in test_env:
761 if re.search(test_env[criteria], ci_env[criteria]) is None:
762 # print "Test "+ test + " cannot be run on the environment"
767 def generateTestcaseList(functest_yaml):
770 testcase_list = functest_yaml.get("test-dependencies")
771 projects = testcase_list.keys()
773 for project in projects:
774 testcases = testcase_list[project]
775 # 1 or 2 levels for testcases project[/case]
776 # if only project name without controller or scenario
777 # => shall be runnable on any controller/scenario
778 if testcases is None:
779 test_list += project + " "
781 for testcase in testcases:
782 if testcase == "installer" or testcase == "scenario":
784 if isTestRunnable(project, functest_yaml):
785 test_list += project + " "
787 # project/testcase (2 levels)
788 thetest = project + "/" + testcase
789 if isTestRunnable(thetest, functest_yaml):
790 test_list += testcase + " "
792 # sort the list to execute the test in the right order
793 test_order_list = functest_yaml.get("test_exec_priority")
794 test_sorted_list = ""
795 for test in test_order_list:
796 if test_order_list[test] in test_list:
797 test_sorted_list += test_order_list[test] + " "
799 # create a file that could be consumed by run-test.sh
800 # this method is used only for CI
801 # so it can be run only in container
802 # reuse default conf directory to store the list of runnable tests
803 file = open("/home/opnfv/functest/conf/testcase-list.txt", 'w')
804 file.write(test_sorted_list)
807 return test_sorted_list