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
24 # ############ CREDENTIALS OPENSTACK #############
25 def check_credentials():
27 Check if the OpenStack credentials (openrc) are sourced
29 env_vars = ['OS_AUTH_URL', 'OS_USERNAME', 'OS_PASSWORD', 'OS_TENANT_NAME']
30 return all(map(lambda v: v in os.environ and os.environ[v], env_vars))
33 def get_credentials(service):
34 """Returns a creds dictionary filled with the following keys:
36 * password/api_key (depending on the service)
37 * tenant_name/project_id (depending on the service)
39 :param service: a string indicating the name of the service
40 requesting the credentials.
43 # Unfortunately, each of the OpenStack client will request slightly
44 # different entries in their credentials dict.
45 if service.lower() in ("nova", "cinder"):
50 tenant = "tenant_name"
52 # The most common way to pass these info to the script is to do it through
53 # environment variables.
55 "username": os.environ.get('OS_USERNAME', "admin"),
56 password: os.environ.get("OS_PASSWORD", 'admin'),
57 "auth_url": os.environ.get("OS_AUTH_URL",
58 "http://192.168.20.71:5000/v2.0"),
59 tenant: os.environ.get("OS_TENANT_NAME", "admin"),
65 # ################ NOVA #################
66 def get_instances(nova_client):
68 instances = nova_client.servers.list(search_opts={'all_tenants': 1})
74 def get_instance_status(nova_client, instance):
76 instance = nova_client.servers.get(instance.id)
77 return instance.status
82 def get_instance_by_name(nova_client, instance_name):
84 instance = nova_client.servers.find(name=instance_name)
90 def get_flavor_id(nova_client, flavor_name):
91 flavors = nova_client.flavors.list(detailed=True)
94 if f.name == flavor_name:
100 def get_flavor_id_by_ram_range(nova_client, min_ram, max_ram):
101 flavors = nova_client.flavors.list(detailed=True)
104 if min_ram <= f.ram and f.ram <= max_ram:
110 def delete_instance(nova_client, instance_id):
112 nova_client.servers.force_delete(instance_id)
115 print "Error:", sys.exc_info()[0]
119 def get_floating_ips(nova_client):
121 floating_ips = nova_client.floating_ips.list()
127 def delete_floating_ip(nova_client, floatingip_id):
129 nova_client.floating_ips.delete(floatingip_id)
132 print "Error:", sys.exc_info()[0]
136 # ################ NEUTRON #################
137 def create_neutron_net(neutron_client, name):
138 json_body = {'network': {'name': name,
139 'admin_state_up': True}}
141 network = neutron_client.create_network(body=json_body)
142 network_dict = network['network']
143 return network_dict['id']
145 print "Error:", sys.exc_info()[0]
149 def update_neutron_net(neutron_client, network_id, shared=False):
150 json_body = {'network': {'shared': shared}}
152 neutron_client.update_network(network_id, body=json_body)
155 print "Error:", sys.exc_info()[0]
159 def delete_neutron_net(neutron_client, network_id):
161 neutron_client.delete_network(network_id)
164 print "Error:", sys.exc_info()[0]
168 def create_neutron_subnet(neutron_client, name, cidr, net_id):
169 json_body = {'subnets': [{'name': name, 'cidr': cidr,
170 'ip_version': 4, 'network_id': net_id}]}
172 subnet = neutron_client.create_subnet(body=json_body)
173 return subnet['subnets'][0]['id']
175 print "Error:", sys.exc_info()[0]
179 def delete_neutron_subnet(neutron_client, subnet_id):
181 neutron_client.delete_subnet(subnet_id)
184 print "Error:", sys.exc_info()[0]
188 def create_neutron_router(neutron_client, name):
189 json_body = {'router': {'name': name, 'admin_state_up': True}}
191 router = neutron_client.create_router(json_body)
192 return router['router']['id']
194 print "Error:", sys.exc_info()[0]
198 def delete_neutron_router(neutron_client, router_id):
199 json_body = {'router': {'id': router_id}}
201 neutron_client.delete_router(router=router_id)
204 print "Error:", sys.exc_info()[0]
208 def add_interface_router(neutron_client, router_id, subnet_id):
209 json_body = {"subnet_id": subnet_id}
211 neutron_client.add_interface_router(router=router_id, body=json_body)
214 print "Error:", sys.exc_info()[0]
218 def remove_interface_router(neutron_client, router_id, subnet_id):
219 json_body = {"subnet_id": subnet_id}
221 neutron_client.remove_interface_router(router=router_id,
225 print "Error:", sys.exc_info()[0]
229 def remove_gateway_router(neutron_client, router_id):
231 neutron_client.remove_gateway_router(router_id)
234 print "Error:", sys.exc_info()[0]
238 def create_neutron_port(neutron_client, name, network_id, ip):
239 json_body = {'port': {
240 'admin_state_up': True,
242 'network_id': network_id,
243 'fixed_ips': [{"ip_address": ip}]
246 port = neutron_client.create_port(body=json_body)
247 return port['port']['id']
249 print "Error:", sys.exc_info()[0]
253 def update_neutron_port(neutron_client, port_id, device_owner):
254 json_body = {'port': {
255 'device_owner': device_owner,
258 port = neutron_client.update_port(port=port_id,
260 return port['port']['id']
262 print "Error:", sys.exc_info()[0]
266 def delete_neutron_port(neutron_client, port_id):
268 neutron_client.delete_port(port_id)
271 print "Error:", sys.exc_info()[0]
275 def get_network_id(neutron_client, network_name):
276 networks = neutron_client.list_networks()['networks']
279 if n['name'] == network_name:
285 def check_neutron_net(neutron_client, net_name):
286 for network in neutron_client.list_networks()['networks']:
287 if network['name'] == net_name:
288 for subnet in network['subnets']:
293 def get_network_list(neutron_client):
294 network_list = neutron_client.list_networks()['networks']
295 if len(network_list) == 0:
301 def get_router_list(neutron_client):
302 router_list = neutron_client.list_routers()['routers']
303 if len(router_list) == 0:
309 def get_port_list(neutron_client):
310 port_list = neutron_client.list_ports()['ports']
311 if len(port_list) == 0:
317 def get_external_net(neutron_client):
318 for network in neutron_client.list_networks()['networks']:
319 if network['router:external']:
320 return network['name']
324 def update_sg_quota(neutron_client, tenant_id, sg_quota, sg_rule_quota):
325 json_body = {"quota": {
326 "security_group": sg_quota,
327 "security_group_rule": sg_rule_quota
331 quota = neutron_client.update_quota(tenant_id=tenant_id,
335 print "Error:", sys.exc_info()[0]
339 def update_cinder_quota(cinder_client, tenant_id, vols_quota,
340 snapshots_quota, gigabytes_quota):
341 quotas_values = {"volumes": vols_quota,
342 "snapshots": snapshots_quota,
343 "gigabytes": gigabytes_quota}
346 quotas_default = cinder_client. quotas.update(tenant_id,
350 print "Error:", sys.exc_info()[0]
354 def get_private_net(neutron_client):
355 # Checks if there is an existing shared private network
356 networks = neutron_client.list_networks()['networks']
357 if len(networks) == 0:
360 if (net['router:external'] is False) and (net['shared'] is True):
365 # ################ GLANCE #################
366 def get_images(nova_client):
368 images = nova_client.images.list()
374 def get_image_id(glance_client, image_name):
375 images = glance_client.images.list()
378 if i.name == image_name:
384 def create_glance_image(glance_client, image_name, file_path, public=True):
385 if not os.path.isfile(file_path):
386 print "Error: file " + file_path + " does not exist."
389 with open(file_path) as fimage:
390 image = glance_client.images.create(name=image_name,
393 container_format="bare",
397 print "Error:", sys.exc_info()[0]
401 def delete_glance_image(nova_client, image_id):
403 nova_client.images.delete(image_id)
406 print "Error:", sys.exc_info()[0]
410 # ################ CINDER #################
411 def get_volumes(cinder_client):
413 volumes = cinder_client.volumes.list(search_opts={'all_tenants': 1})
419 def delete_volume(cinder_client, volume_id, forced=False):
423 cinder_client.volumes.detach(volume_id)
425 print "Error:", sys.exc_info()[0]
426 cinder_client.volumes.force_delete(volume_id)
428 cinder_client.volumes.delete(volume_id)
431 print "Error:", sys.exc_info()[0]
435 # ################ CINDER #################
436 def get_security_groups(neutron_client):
438 security_groups = neutron_client.list_security_groups()[
440 return security_groups
445 def delete_security_group(neutron_client, secgroup_id):
447 neutron_client.delete_security_group(secgroup_id)
450 print "Error:", sys.exc_info()[0]
454 # ################ KEYSTONE #################
455 def get_tenants(keystone_client):
457 tenants = keystone_client.tenants.list()
463 def get_tenant_id(keystone_client, tenant_name):
464 tenants = keystone_client.tenants.list()
467 if t.name == tenant_name:
473 def get_users(keystone_client):
475 users = keystone_client.users.list()
481 def get_role_id(keystone_client, role_name):
482 roles = keystone_client.roles.list()
485 if r.name == role_name:
491 def get_user_id(keystone_client, user_name):
492 users = keystone_client.users.list()
495 if u.name == user_name:
501 def create_tenant(keystone_client, tenant_name, tenant_description):
503 tenant = keystone_client.tenants.create(tenant_name,
508 print "Error:", sys.exc_info()[0]
512 def delete_tenant(keystone_client, tenant_id):
514 tenant = keystone_client.tenants.delete(tenant_id)
517 print "Error:", sys.exc_info()[0]
521 def create_user(keystone_client, user_name, user_password,
522 user_email, tenant_id):
524 user = keystone_client.users.create(user_name, user_password,
525 user_email, tenant_id,
529 print "Error:", sys.exc_info()[0]
533 def delete_user(keystone_client, user_id):
535 tenant = keystone_client.users.delete(user_id)
538 print "Error:", sys.exc_info()[0]
542 def add_role_user(keystone_client, user_id, role_id, tenant_id):
544 keystone_client.roles.add_user_role(user_id, role_id, tenant_id)
547 print "Error:", sys.exc_info()[0]
551 # ################ UTILS #################
552 def check_internet_connectivity(url='http://www.opnfv.org/'):
554 Check if there is access to the internet
557 urllib2.urlopen(url, timeout=5)
559 except urllib2.URLError:
563 def download_url(url, dest_path):
565 Download a file to a destination path given a URL
567 name = url.rsplit('/')[-1]
568 dest = dest_path + "/" + name
570 response = urllib2.urlopen(url)
571 except (urllib2.HTTPError, urllib2.URLError):
574 with open(dest, 'wb') as f:
575 shutil.copyfileobj(response, f)
579 def execute_command(cmd, logger=None):
581 Execute Linux command
584 logger.debug('Executing command : {}'.format(cmd))
585 output_file = "output.txt"
586 f = open(output_file, 'w+')
587 p = subprocess.call(cmd, shell=True, stdout=f, stderr=subprocess.STDOUT)
589 f = open(output_file, 'r')
591 if result != "" and logger:
597 logger.error("Error when executing command %s" % cmd)
601 def get_git_branch(repo_path):
605 repo = Repo(repo_path)
606 branch = repo.active_branch
610 def get_installer_type(logger=None):
612 Get installer type (fuel, apex, joid, compass)
615 installer = os.environ['INSTALLER_TYPE']
618 logger.error("Impossible to retrieve the installer type")
624 def get_pod_name(logger=None):
626 Get PoD Name from env variable NODE_NAME
629 return os.environ['NODE_NAME']
633 "Unable to retrieve the POD name from environment.Using pod name 'unknown-pod'")
637 def push_results_to_db(db_url, case_name, logger, pod_name,
638 git_version, payload):
639 url = db_url + "/results"
640 installer = get_installer_type(logger)
641 params = {"project_name": "functest", "case_name": case_name,
642 "pod_name": pod_name, "installer": installer,
643 "version": git_version, "details": payload}
645 headers = {'Content-Type': 'application/json'}
647 r = requests.post(url, data=json.dumps(params), headers=headers)
651 print "Error:", sys.exc_info()[0]
655 def getTestEnv(test, functest_yaml):
656 # get the config of the testcase based on functest_config.yaml
658 # - test = test project e.g; ovno
659 # - test = testcase e.g. functest/odl
660 # look for the / to see if it is a test project or a testcase
662 TEST_ENV = functest_yaml.get("test-dependencies")
664 if test.find("/") < 0:
665 config_test = TEST_ENV[test]
667 test_split = test.split("/")
668 testproject = test_split[0]
669 testcase = test_split[1]
670 config_test = TEST_ENV[testproject][testcase]
672 # if not defined in dependencies => no dependencies
675 print "Error getTestEnv:", sys.exc_info()[0]
680 def get_ci_envvars():
682 Get the CI env variables
685 "installer": os.environ.get('INSTALLER_TYPE'),
686 "controller": os.environ.get('SDN_CONTROLLER'),
687 "options": os.environ.get("OPNFV_FEATURE")}
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()
703 def isTestRunnable(test, functest_yaml):
704 # check getTestEnv(test) and CI env var
705 # check installer, controller and options
706 # e.g. if test needs onos => do not run odl suite
708 # By default we assume that all the tests are always runnable...
710 # Retrieve CI environment
711 ci_env = get_ci_envvars()
713 # Retrieve test environement from config file
714 test_env = getTestEnv(test, functest_yaml)
716 # if test_env not empty => dependencies to be checked
717 if test_env is not None and len(test_env) > 0:
718 # possible criteria = ["installer", "controller", "options"]
719 # consider test criteria from config file
720 # compare towards CI env through CI en variable
721 for criteria in test_env:
722 if test_env[criteria] != ci_env[criteria]:
723 # print "Test "+ test + " cannot be run on the environment"
726 print "Error isTestRunnable:", sys.exc_info()[0]
730 def generateTestcaseList(functest_yaml):
733 # Retrieve CI environment
737 testcase_list = functest_yaml.get("test-dependencies")
738 projects = testcase_list.keys()
739 for project in projects:
740 testcases = testcase_list[project]
741 # 1 or 2 levels for testcases project[/case]
742 # if only project name without controller or scenario
743 # => shall be runnable on any controller/scenario
744 if testcases is None:
745 test_list += project + " "
747 for testcase in testcases:
748 if testcase == "controller" or testcase == "scenario":
750 if isTestRunnable(project, functest_yaml):
751 test_list += project + " "
753 # project/testcase (2 levels)
754 thetest = project + "/" + testcase
755 if isTestRunnable(thetest, functest_yaml):
756 test_list += testcase + " "
758 # create a file that could be consumed by run-test.sh
759 file = open("testcase-list.txt", 'w')
760 file.write(test_list)
765 # test for each testcase if it is runnable
766 # towards the declared configuration
767 # generate the test config file
769 print "Error generateTestcaseList:", sys.exc_info()[0]