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
10 # pylint: disable=missing-docstring
12 from __future__ import print_function
19 from shade import _utils
22 LOGGER = logging.getLogger(__name__)
25 def execute_command_raise(cmd, info=False, error_msg="",
26 verbose=True, output_file=None):
27 ret = execute_command(cmd, info, error_msg, verbose, output_file)
29 raise Exception(error_msg)
32 def execute_command(cmd, info=False, error_msg="",
33 verbose=True, output_file=None):
35 error_msg = ("The command '%s' failed." % cmd)
36 msg_exec = ("Executing command: '%s'" % cmd)
41 LOGGER.debug(msg_exec)
42 popen = subprocess.Popen(
43 cmd, shell=True, stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
45 ofd = open(output_file, "w")
46 for line in iter(popen.stdout.readline, b''):
48 ofd.write(line.decode("utf-8"))
50 line = line.decode("utf-8").replace('\n', '')
56 returncode = popen.wait()
59 LOGGER.error(error_msg)
64 def get_parameter_from_yaml(parameter, yfile):
66 Returns the value of a given parameter in file.yaml
67 parameter must be given in string format with dots
68 Example: general.openstack.image_name
70 with open(yfile) as yfd:
71 file_yaml = yaml.safe_load(yfd)
73 for element in parameter.split("."):
74 value = value.get(element)
76 raise ValueError("The parameter %s is not defined in"
77 " %s" % (parameter, yfile))
81 def get_nova_version(cloud):
82 """ Get Nova API microversion
86 - Nova API microversion
87 - None on operation error
89 # pylint: disable=protected-access
91 request = cloud._compute_client.request("/", "GET")
92 LOGGER.debug('cloud._compute_client.request: %s', request)
93 version = request["version"]["version"]
94 major, minor = version.split('.')
95 LOGGER.debug('nova version: %s', (int(major), int(minor)))
96 return (int(major), int(minor))
97 except Exception: # pylint: disable=broad-except
98 LOGGER.exception("Cannot detect Nova version")
102 def get_openstack_version(cloud):
103 """ Detect OpenStack version via Nova API microversion
105 It follows `MicroversionHistory
106 <https://docs.openstack.org/nova/latest/reference/api-microversion-history.html>`_.
111 - Unknown on operation error
113 # pylint: disable=too-many-branches
114 version = get_nova_version(cloud)
117 if version > (2, 79):
119 elif version > (2, 72):
121 elif version > (2, 65):
123 elif version > (2, 60):
125 elif version > (2, 53):
127 elif version > (2, 42):
129 elif version > (2, 38):
131 elif version > (2, 25):
133 elif version > (2, 12):
135 elif version > (2, 3):
136 osversion = "Liberty"
137 elif version >= (2, 1):
140 osversion = "Unknown"
141 LOGGER.info('Detect OpenStack version: %s', osversion)
143 except AssertionError:
144 LOGGER.exception("Cannot detect OpenStack version")
148 def list_services(cloud):
149 # pylint: disable=protected-access
150 """Search Keystone services via $OS_INTERFACE.
152 It mainly conforms with `Shade
153 <https://docs.openstack.org/shade/latest>`_ but allows testing vs
154 public endpoints. It's worth mentioning that it doesn't support keystone
157 :returns: a list of ``munch.Munch`` containing the services description
159 :raises: ``OpenStackCloudException`` if something goes wrong during the
162 url, key = '/services', 'services'
163 data = cloud._identity_client.get(
164 url, endpoint_filter={
165 'interface': os.environ.get('OS_INTERFACE', 'public')},
166 error_message="Failed to list services")
167 services = cloud._get_and_munchify(key, data)
168 return _utils.normalize_keystone_services(services)
171 def search_services(cloud, name_or_id=None, filters=None):
172 # pylint: disable=protected-access
173 """Search Keystone services ia $OS_INTERFACE.
175 It mainly conforms with `Shade
176 <https://docs.openstack.org/shade/latest>`_ but allows testing vs
177 public endpoints. It's worth mentioning that it doesn't support keystone
180 :param name_or_id: Name or id of the desired service.
181 :param filters: a dict containing additional filters to use. e.g.
184 :returns: a list of ``munch.Munch`` containing the services description
186 :raises: ``OpenStackCloudException`` if something goes wrong during the
189 services = list_services(cloud)
190 return _utils._filter_list(services, name_or_id, filters)
193 def convert_dict_to_ini(value):
194 "Convert dict to oslo.conf input"
195 assert isinstance(value, dict)
196 return ",".join("{}:{}".format(
197 key, val) for (key, val) in six.iteritems(value))
200 def convert_list_to_ini(value):
201 "Convert list to oslo.conf input"
202 assert isinstance(value, list)
203 return ",".join("{}".format(val) for val in value)
206 def convert_ini_to_dict(value):
207 "Convert oslo.conf input to dict"
208 assert isinstance(value, str)
210 return dict((x.rsplit(':', 1) for x in value.split(',')))
215 def convert_ini_to_list(value):
216 "Convert list to oslo.conf input"
217 assert isinstance(value, str)
220 return list(value.split(','))