1 # Copyright (c) 2017 Cable Television Laboratories, Inc. ("CableLabs")
2 # and others. All rights reserved.
4 # Licensed under the Apache License, Version 2.0 (the "License");
5 # you may not use this file except in compliance with the License.
6 # You may obtain a copy of the License at:
8 # http://www.apache.org/licenses/LICENSE-2.0
10 # Unless required by applicable law or agreed to in writing, software
11 # distributed under the License is distributed on an "AS IS" BASIS,
12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 # See the License for the specific language governing permissions and
14 # limitations under the License.
19 from snaps import file_utils
20 from snaps.openstack.create_image import ImageSettings
21 from snaps.openstack.create_network import NetworkSettings, SubnetSettings
22 from snaps.openstack.create_router import RouterSettings
23 from snaps.openstack.os_credentials import OSCreds, ProxySettings
25 __author__ = 'spisarski'
27 logger = logging.getLogger('openstack_tests')
29 CIRROS_DEFAULT_IMAGE_URL =\
30 'http://download.cirros-cloud.net/0.3.4/cirros-0.3.4-x86_64-disk.img'
31 CIRROS_DEFAULT_KERNEL_IMAGE_URL =\
32 'http://download.cirros-cloud.net/0.3.4/cirros-0.3.4-x86_64-kernel'
33 CIRROS_DEFAULT_RAMDISK_IMAGE_URL =\
34 'http://download.cirros-cloud.net/0.3.4/cirros-0.3.4-x86_64-initramfs'
35 CIRROS_USER = 'cirros'
37 CENTOS_DEFAULT_IMAGE_URL =\
38 'http://cloud.centos.org/centos/7/images/' \
39 'CentOS-7-x86_64-GenericCloud.qcow2'
40 CENTOS_USER = 'centos'
42 UBUNTU_DEFAULT_IMAGE_URL = \
43 'http://uec-images.ubuntu.com/releases/trusty/14.04/' \
44 'ubuntu-14.04-server-cloudimg-amd64-disk1.img'
45 UBUNTU_USER = 'ubuntu'
47 DEFAULT_IMAGE_FORMAT = 'qcow2'
50 def get_credentials(os_env_file=None, proxy_settings_str=None,
51 ssh_proxy_cmd=None, dev_os_env_file=None):
53 Returns the OpenStack credentials object. It first attempts to retrieve
54 them from a standard OpenStack source file. If that file is None, it will
55 attempt to retrieve them with a YAML file.
56 :param os_env_file: the OpenStack source file
57 :param proxy_settings_str: proxy settings string <host>:<port> (optional)
58 :param ssh_proxy_cmd: the SSH proxy command for your environment (optional)
59 :param dev_os_env_file: the YAML file to retrieve both the OS credentials
61 :return: the SNAPS credentials object
64 logger.debug('Reading RC file - ' + os_env_file)
65 config = file_utils.read_os_env_file(os_env_file)
66 proj_name = config.get('OS_PROJECT_NAME')
68 proj_name = config.get('OS_TENANT_NAME')
71 if proxy_settings_str:
72 tokens = re.split(':', proxy_settings_str)
73 proxy_settings = ProxySettings(host=tokens[0], port=tokens[1],
74 ssh_proxy_cmd=ssh_proxy_cmd)
76 if config.get('OS_CACERT'):
77 https_cacert = config.get('OS_CACERT')
78 elif config.get('OS_INSECURE'):
84 if config.get('OS_INTERFACE'):
85 interface = config.get('OS_INTERFACE')
88 'username': config['OS_USERNAME'],
89 'password': config['OS_PASSWORD'],
90 'auth_url': config['OS_AUTH_URL'],
91 'project_name': proj_name,
92 'identity_api_version': config.get('OS_IDENTITY_API_VERSION'),
93 'image_api_version': config.get('OS_IMAGE_API_VERSION'),
94 'network_api_version': config.get('OS_NETWORK_API_VERSION'),
95 'compute_api_version': config.get('OS_COMPUTE_API_VERSION'),
96 'heat_api_version': config.get('OS_HEAT_API_VERSION'),
97 'user_domain_id': config.get('OS_USER_DOMAIN_ID'),
98 'project_domain_id': config.get('OS_PROJECT_DOMAIN_ID'),
99 'interface': interface,
100 'proxy_settings': proxy_settings,
101 'cacert': https_cacert}
103 logger.info('Reading development os_env file - ' + dev_os_env_file)
104 config = file_utils.read_yaml(dev_os_env_file)
106 proxy_settings = None
107 proxy_str = config.get('http_proxy')
109 tokens = re.split(':', proxy_str)
110 proxy_settings = ProxySettings(
111 host=tokens[0], port=tokens[1],
112 ssh_proxy_cmd=config.get('ssh_proxy_cmd'))
115 'username': config['username'],
116 'password': config['password'],
117 'auth_url': config['os_auth_url'],
118 'project_name': config['project_name'],
119 'identity_api_version': config.get('identity_api_version'),
120 'image_api_version': config.get('image_api_version'),
121 'network_api_version': config.get('network_api_version'),
122 'compute_api_version': config.get('compute_api_version'),
123 'heat_api_version': config.get('heat_api_version'),
124 'user_domain_id': config.get('user_domain_id'),
125 'project_domain_id': config.get('project_domain_id'),
126 'interface': config.get('interface'),
127 'proxy_settings': proxy_settings, 'cacert': config.get('cacert')}
129 os_creds = OSCreds(**creds_dict)
130 logger.info('OS Credentials = %s', os_creds)
134 def create_image_settings(image_name, image_user, image_format, metadata,
135 disk_url=None, default_url=None,
136 kernel_settings=None, ramdisk_settings=None,
137 public=False, nic_config_pb_loc=None):
139 Returns the image settings object
140 :param image_name: the name of the image
141 :param image_user: the image's sudo user
142 :param image_format: the image's format string
143 :param metadata: custom metadata for overriding default behavior for test
145 :param disk_url: the disk image's URL
146 :param default_url: the default URL for the disk image
147 :param kernel_settings: override to the kernel settings from the
149 :param ramdisk_settings: override to the ramdisk settings from the
151 :param public: True denotes image can be used by other projects where False
152 indicates the converse (default: False)
153 :param nic_config_pb_loc: The location of the playbook used for configuring
158 logger.debug('Image metadata - ' + str(metadata))
160 if metadata and 'config' in metadata:
161 return ImageSettings(**metadata['config'])
165 disk_url = metadata.get('disk_url')
166 disk_file = metadata.get('disk_file')
168 disk_url = default_url
173 ('kernel_file' in metadata or 'kernel_url' in metadata) and \
174 kernel_settings is None:
175 kernel_image_settings = ImageSettings(
176 name=image_name + '-kernel', image_user=image_user,
177 img_format=image_format,
178 image_file=metadata.get('kernel_file'),
179 url=metadata.get('kernel_url'), public=public)
181 kernel_image_settings = kernel_settings
184 ('ramdisk_file' in metadata or 'ramdisk_url' in metadata) and \
185 ramdisk_settings is None:
186 ramdisk_image_settings = ImageSettings(
187 name=image_name + '-ramdisk', image_user=image_user,
188 img_format=image_format,
189 image_file=metadata.get('ramdisk_file'),
190 url=metadata.get('ramdisk_url'), public=public)
192 ramdisk_image_settings = ramdisk_settings
194 extra_properties = None
195 if metadata and 'extra_properties' in metadata:
196 extra_properties = metadata['extra_properties']
198 return ImageSettings(name=image_name, image_user=image_user,
199 img_format=image_format, image_file=disk_file,
200 url=disk_url, extra_properties=extra_properties,
201 kernel_image_settings=kernel_image_settings,
202 ramdisk_image_settings=ramdisk_image_settings,
204 nic_config_pb_loc=nic_config_pb_loc)
207 def cirros_image_settings(name=None, url=None, image_metadata=None,
208 kernel_settings=None, ramdisk_settings=None,
211 Returns the image settings for a Cirros QCOW2 image
212 :param name: the name of the image
213 :param url: the image's URL
214 :param image_metadata: dict() values to override URLs for disk, kernel, and
216 :param kernel_settings: override to the kernel settings from the
218 :param ramdisk_settings: override to the ramdisk settings from the
220 :param public: True denotes image can be used by other projects where False
221 indicates the converse
224 if image_metadata and 'cirros' in image_metadata:
225 metadata = image_metadata['cirros']
227 metadata = image_metadata
229 return create_image_settings(
230 image_name=name, image_user=CIRROS_USER,
231 image_format=DEFAULT_IMAGE_FORMAT, metadata=metadata, disk_url=url,
232 default_url=CIRROS_DEFAULT_IMAGE_URL,
233 kernel_settings=kernel_settings, ramdisk_settings=ramdisk_settings,
237 def file_image_test_settings(name, file_path, image_user=CIRROS_USER):
238 return ImageSettings(name=name, image_user=image_user,
239 img_format=DEFAULT_IMAGE_FORMAT, image_file=file_path)
242 def centos_image_settings(name, url=None, image_metadata=None,
243 kernel_settings=None, ramdisk_settings=None,
246 Returns the image settings for a Centos QCOW2 image
247 :param name: the name of the image
248 :param url: the image's URL
249 :param image_metadata: dict() values to override URLs for disk, kernel, and
251 :param kernel_settings: override to the kernel settings from the
253 :param ramdisk_settings: override to the ramdisk settings from the
255 :param public: True denotes image can be used by other projects where False
256 indicates the converse
259 if image_metadata and 'centos' in image_metadata:
260 metadata = image_metadata['centos']
262 metadata = image_metadata
264 pb_path = pkg_resources.resource_filename(
265 'snaps.provisioning.ansible_pb.centos-network-setup.playbooks',
266 'configure_host.yml')
267 return create_image_settings(
268 image_name=name, image_user=CENTOS_USER,
269 image_format=DEFAULT_IMAGE_FORMAT, metadata=metadata, disk_url=url,
270 default_url=CENTOS_DEFAULT_IMAGE_URL,
271 kernel_settings=kernel_settings, ramdisk_settings=ramdisk_settings,
272 public=public, nic_config_pb_loc=pb_path)
275 def ubuntu_image_settings(name, url=None, image_metadata=None,
276 kernel_settings=None, ramdisk_settings=None,
279 Returns the image settings for a Ubuntu QCOW2 image
280 :param name: the name of the image
281 :param url: the image's URL
282 :param image_metadata: dict() values to override URLs for disk, kernel, and
284 :param kernel_settings: override to the kernel settings from the
286 :param ramdisk_settings: override to the ramdisk settings from the
288 :param public: True denotes image can be used by other projects where False
289 indicates the converse
292 if image_metadata and 'ubuntu' in image_metadata:
293 metadata = image_metadata['ubuntu']
295 metadata = image_metadata
297 pb_path = pkg_resources.resource_filename(
298 'snaps.provisioning.ansible_pb.ubuntu-network-setup.playbooks',
299 'configure_host.yml')
300 return create_image_settings(
301 image_name=name, image_user=UBUNTU_USER,
302 image_format=DEFAULT_IMAGE_FORMAT, metadata=metadata, disk_url=url,
303 default_url=UBUNTU_DEFAULT_IMAGE_URL,
304 kernel_settings=kernel_settings, ramdisk_settings=ramdisk_settings,
305 public=public, nic_config_pb_loc=pb_path)
308 def get_priv_net_config(net_name, subnet_name, router_name=None,
309 cidr='10.55.0.0/24', external_net=None):
310 return OSNetworkConfig(net_name, subnet_name, cidr, router_name,
311 external_gateway=external_net)
314 def get_pub_net_config(net_name, subnet_name=None, router_name=None,
315 cidr='10.55.1.0/24', external_net=None):
316 return OSNetworkConfig(net_name, subnet_name, cidr, router_name,
317 external_gateway=external_net)
320 class OSNetworkConfig:
322 Represents the settings required for the creation of a network in OpenStack
325 def __init__(self, net_name, subnet_name=None, subnet_cidr=None,
326 router_name=None, external_gateway=None):
328 if subnet_name and subnet_cidr:
329 self.network_settings = NetworkSettings(
330 name=net_name, subnet_settings=[
331 SubnetSettings(cidr=subnet_cidr, name=subnet_name)])
333 self.network_settings = NetworkSettings(name=net_name)
337 self.router_settings = RouterSettings(
338 name=router_name, external_gateway=external_gateway,
339 internal_subnets=[subnet_name])
341 self.router_settings = RouterSettings(
342 name=router_name, external_gateway=external_gateway)