3 # Copyright (c) 2017 Ericsson 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
11 OpenStack deployment checker
14 - Credentials file is given and contains the right information
15 - OpenStack endpoints are reachable
22 from six.moves import urllib
25 from functest.opnfv_tests.openstack.snaps import snaps_utils
27 from snaps.openstack.tests import openstack_tests
28 from snaps.openstack.utils import glance_utils
29 from snaps.openstack.utils import keystone_utils
30 from snaps.openstack.utils import neutron_utils
31 from snaps.openstack.utils import nova_utils
33 __author__ = "Jose Lausuch <jose.lausuch@ericsson.com>"
35 LOGGER = logging.getLogger(__name__)
38 def verify_connectivity(endpoint):
39 """ Returns true if an hostname/port is reachable"""
40 connection = socket.socket()
41 connection.settimeout(10)
42 hostname = urllib.parse.urlparse(endpoint).hostname
43 port = urllib.parse.urlparse(endpoint).port
45 port = 443 if urllib.parse.urlparse(endpoint).scheme == "https" else 80
47 connection.connect((hostname, port))
48 LOGGER.debug('%s:%s is reachable!', hostname, port)
51 LOGGER.exception('%s:%s is not reachable.', hostname, port)
55 def get_auth_token(os_creds):
56 """ Get auth token """
57 sess = keystone_utils.keystone_session(os_creds)
59 return sess.get_token()
60 except Exception as error:
61 LOGGER.error("Got token ...FAILED")
65 class CheckDeployment(object):
66 """ Check deployment class."""
68 def __init__(self, rc_file='/home/opnfv/functest/conf/openstack.creds'):
69 self.rc_file = rc_file
70 self.services = ('compute', 'network', 'image')
74 """ Check if RC file exists and contains OS_AUTH_URL """
75 if not os.path.isfile(self.rc_file):
76 raise IOError('RC file {} does not exist!'.format(self.rc_file))
77 if 'OS_AUTH_URL' not in open(self.rc_file).read():
78 raise SyntaxError('OS_AUTH_URL not defined in {}.'.
81 def check_auth_endpoint(self):
82 """ Verifies connectivity to the OS_AUTH_URL given in the RC file
84 rc_endpoint = self.os_creds.auth_url
85 if not verify_connectivity(rc_endpoint):
86 raise Exception("OS_AUTH_URL {} is not reachable.".
88 LOGGER.info("Connectivity to OS_AUTH_URL %s ...OK", rc_endpoint)
89 if get_auth_token(self.os_creds):
90 LOGGER.info("Got token ...OK")
92 def check_public_endpoint(self):
93 """ Gets the public endpoint and verifies connectivity to it """
94 public_endpoint = keystone_utils.get_endpoint(self.os_creds,
97 if not verify_connectivity(public_endpoint):
98 raise Exception("Public endpoint {} is not reachable.".
99 format(public_endpoint))
100 LOGGER.info("Connectivity to the public endpoint %s ...OK",
103 def check_service_endpoint(self, service):
104 """ Verifies connectivity to a given openstack service """
105 endpoint = keystone_utils.get_endpoint(self.os_creds,
108 if not verify_connectivity(endpoint):
109 raise Exception("{} endpoint {} is not reachable.".
110 format(service, endpoint))
111 LOGGER.info("Connectivity to endpoint '%s' %s ...OK",
114 def check_nova(self):
115 """ checks that a simple nova operation works """
117 client = nova_utils.nova_client(self.os_creds)
118 client.servers.list()
119 LOGGER.info("Nova service ...OK")
120 except Exception as error:
121 LOGGER.error("Nova service ...FAILED")
124 def check_neutron(self):
125 """ checks that a simple neutron operation works """
127 client = neutron_utils.neutron_client(self.os_creds)
128 client.list_networks()
129 LOGGER.info("Neutron service ...OK")
130 except Exception as error:
131 LOGGER.error("Neutron service ...FAILED")
134 def check_glance(self):
135 """ checks that a simple glance operation works """
137 client = glance_utils.glance_client(self.os_creds)
139 LOGGER.info("Glance service ...OK")
140 except Exception as error:
141 LOGGER.error("Glance service ...FAILED")
144 def check_ext_net(self):
145 """ checks if external network exists """
146 ext_net = snaps_utils.get_ext_net_name(self.os_creds)
148 LOGGER.info("External network found: %s", ext_net)
150 raise Exception("ERROR: No external networks in the deployment.")
154 Calls all the class functions and returns 0 if all of them succeed.
155 This is the method called by CLI
159 self.os_creds = openstack_tests.get_credentials(
160 os_env_file=self.rc_file,
161 proxy_settings_str=None,
164 raise Exception("Problem while getting credentials object.")
165 if self.os_creds is None:
166 raise Exception("Credentials is None.")
167 self.check_auth_endpoint()
168 self.check_public_endpoint()
169 for service in self.services:
170 self.check_service_endpoint(service)
180 logging.config.fileConfig(pkg_resources.resource_filename(
181 'functest', 'ci/logging.ini'))
182 logging.captureWarnings(True)
183 deployment = CheckDeployment()
184 return deployment.check_all()