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, overrides=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 :param overrides: dict() containing values to override the credentials
63 :return: the SNAPS credentials object
66 logger.debug('Reading RC file - ' + os_env_file)
67 config = file_utils.read_os_env_file(os_env_file)
68 proj_name = config.get('OS_PROJECT_NAME')
70 proj_name = config.get('OS_TENANT_NAME')
73 if proxy_settings_str:
74 tokens = re.split(':', proxy_settings_str)
75 proxy_settings = ProxySettings(host=tokens[0], port=tokens[1],
76 ssh_proxy_cmd=ssh_proxy_cmd)
79 if config.get('OS_CACERT'):
80 https_cacert = config.get('OS_CACERT')
81 elif config.get('OS_INSECURE'):
85 if config.get('OS_INTERFACE'):
86 interface = config.get('OS_INTERFACE')
89 'username': config['OS_USERNAME'],
90 'password': config['OS_PASSWORD'],
91 'auth_url': config['OS_AUTH_URL'],
92 'project_name': proj_name,
93 'identity_api_version': config.get('OS_IDENTITY_API_VERSION'),
94 'image_api_version': config.get('OS_IMAGE_API_VERSION'),
95 'network_api_version': config.get('OS_NETWORK_API_VERSION'),
96 'compute_api_version': config.get('OS_COMPUTE_API_VERSION'),
97 'heat_api_version': config.get('OS_HEAT_API_VERSION'),
98 'user_domain_id': config.get('OS_USER_DOMAIN_ID'),
99 'user_domain_name': config.get('OS_USER_DOMAIN_NAME'),
100 'project_domain_id': config.get('OS_PROJECT_DOMAIN_ID'),
101 'project_domain_name': config.get('OS_PROJECT_DOMAIN_NAME'),
102 'interface': interface,
103 'proxy_settings': proxy_settings,
104 'cacert': https_cacert,
105 'region_name': config.get('OS_REGION_NAME')}
107 logger.info('Reading development os_env file - ' + dev_os_env_file)
108 config = file_utils.read_yaml(dev_os_env_file)
110 proxy_settings = None
111 proxy_str = config.get('http_proxy')
113 tokens = re.split(':', proxy_str)
114 proxy_settings = ProxySettings(
115 host=tokens[0], port=tokens[1],
116 ssh_proxy_cmd=config.get('ssh_proxy_cmd'))
119 'username': config['username'],
120 'password': config['password'],
121 'auth_url': config['os_auth_url'],
122 'project_name': config['project_name'],
123 'identity_api_version': config.get('identity_api_version'),
124 'image_api_version': config.get('image_api_version'),
125 'network_api_version': config.get('network_api_version'),
126 'compute_api_version': config.get('compute_api_version'),
127 'heat_api_version': config.get('heat_api_version'),
128 'user_domain_id': config.get('user_domain_id'),
129 'user_domain_name': config.get('user_domain_name'),
130 'project_domain_id': config.get('project_domain_id'),
131 'project_domain_name': config.get('project_domain_name'),
132 'interface': config.get('interface'),
133 'proxy_settings': proxy_settings,
134 'cacert': config.get('cacert'),
135 'region_name': config.get('region_name')}
137 if overrides and isinstance(overrides, dict):
138 creds_dict.update(overrides)
140 os_creds = OSCreds(**creds_dict)
141 logger.info('OS Credentials = %s', os_creds.__str__)
145 def create_image_settings(image_name, image_user, image_format, metadata,
146 disk_url=None, default_url=None,
147 kernel_settings=None, ramdisk_settings=None,
148 public=False, nic_config_pb_loc=None):
150 Returns the image settings object
151 :param image_name: the name of the image
152 :param image_user: the image's sudo user
153 :param image_format: the image's format string
154 :param metadata: custom metadata for overriding default behavior for test
156 :param disk_url: the disk image's URL
157 :param default_url: the default URL for the disk image
158 :param kernel_settings: override to the kernel settings from the
160 :param ramdisk_settings: override to the ramdisk settings from the
162 :param public: True denotes image can be used by other projects where False
163 indicates the converse (default: False)
164 :param nic_config_pb_loc: The location of the playbook used for configuring
169 logger.debug('Image metadata - ' + str(metadata))
171 if metadata and 'config' in metadata:
172 return ImageSettings(**metadata['config'])
176 disk_url = metadata.get('disk_url')
177 disk_file = metadata.get('disk_file')
179 disk_url = default_url
184 ('kernel_file' in metadata or 'kernel_url' in metadata) and \
185 kernel_settings is None:
186 kernel_image_settings = ImageSettings(
187 name=image_name + '-kernel', image_user=image_user,
188 img_format=image_format,
189 image_file=metadata.get('kernel_file'),
190 url=metadata.get('kernel_url'), public=public)
192 kernel_image_settings = kernel_settings
195 ('ramdisk_file' in metadata or 'ramdisk_url' in metadata) and \
196 ramdisk_settings is None:
197 ramdisk_image_settings = ImageSettings(
198 name=image_name + '-ramdisk', image_user=image_user,
199 img_format=image_format,
200 image_file=metadata.get('ramdisk_file'),
201 url=metadata.get('ramdisk_url'), public=public)
203 ramdisk_image_settings = ramdisk_settings
205 extra_properties = None
206 if metadata and 'extra_properties' in metadata:
207 extra_properties = metadata['extra_properties']
209 return ImageSettings(name=image_name, image_user=image_user,
210 img_format=image_format, image_file=disk_file,
211 url=disk_url, extra_properties=extra_properties,
212 kernel_image_settings=kernel_image_settings,
213 ramdisk_image_settings=ramdisk_image_settings,
215 nic_config_pb_loc=nic_config_pb_loc)
218 def cirros_image_settings(name=None, url=None, image_metadata=None,
219 kernel_settings=None, ramdisk_settings=None,
222 Returns the image settings for a Cirros QCOW2 image
223 :param name: the name of the image
224 :param url: the image's URL
225 :param image_metadata: dict() values to override URLs for disk, kernel, and
227 :param kernel_settings: override to the kernel settings from the
229 :param ramdisk_settings: override to the ramdisk settings from the
231 :param public: True denotes image can be used by other projects where False
232 indicates the converse
235 if image_metadata and 'cirros' in image_metadata:
236 metadata = image_metadata['cirros']
238 metadata = image_metadata
240 return create_image_settings(
241 image_name=name, image_user=CIRROS_USER,
242 image_format=DEFAULT_IMAGE_FORMAT, metadata=metadata, disk_url=url,
243 default_url=CIRROS_DEFAULT_IMAGE_URL,
244 kernel_settings=kernel_settings, ramdisk_settings=ramdisk_settings,
248 def file_image_test_settings(name, file_path, image_user=CIRROS_USER):
249 return ImageSettings(name=name, image_user=image_user,
250 img_format=DEFAULT_IMAGE_FORMAT, image_file=file_path)
253 def centos_image_settings(name, url=None, image_metadata=None,
254 kernel_settings=None, ramdisk_settings=None,
257 Returns the image settings for a Centos QCOW2 image
258 :param name: the name of the image
259 :param url: the image's URL
260 :param image_metadata: dict() values to override URLs for disk, kernel, and
262 :param kernel_settings: override to the kernel settings from the
264 :param ramdisk_settings: override to the ramdisk settings from the
266 :param public: True denotes image can be used by other projects where False
267 indicates the converse
270 if image_metadata and 'centos' in image_metadata:
271 metadata = image_metadata['centos']
273 metadata = image_metadata
275 pb_path = pkg_resources.resource_filename(
276 'snaps.provisioning.ansible_pb.centos-network-setup.playbooks',
277 'configure_host.yml')
278 return create_image_settings(
279 image_name=name, image_user=CENTOS_USER,
280 image_format=DEFAULT_IMAGE_FORMAT, metadata=metadata, disk_url=url,
281 default_url=CENTOS_DEFAULT_IMAGE_URL,
282 kernel_settings=kernel_settings, ramdisk_settings=ramdisk_settings,
283 public=public, nic_config_pb_loc=pb_path)
286 def ubuntu_image_settings(name, url=None, image_metadata=None,
287 kernel_settings=None, ramdisk_settings=None,
290 Returns the image settings for a Ubuntu QCOW2 image
291 :param name: the name of the image
292 :param url: the image's URL
293 :param image_metadata: dict() values to override URLs for disk, kernel, and
295 :param kernel_settings: override to the kernel settings from the
297 :param ramdisk_settings: override to the ramdisk settings from the
299 :param public: True denotes image can be used by other projects where False
300 indicates the converse
303 if image_metadata and 'ubuntu' in image_metadata:
304 metadata = image_metadata['ubuntu']
306 metadata = image_metadata
308 pb_path = pkg_resources.resource_filename(
309 'snaps.provisioning.ansible_pb.ubuntu-network-setup.playbooks',
310 'configure_host.yml')
311 return create_image_settings(
312 image_name=name, image_user=UBUNTU_USER,
313 image_format=DEFAULT_IMAGE_FORMAT, metadata=metadata, disk_url=url,
314 default_url=UBUNTU_DEFAULT_IMAGE_URL,
315 kernel_settings=kernel_settings, ramdisk_settings=ramdisk_settings,
316 public=public, nic_config_pb_loc=pb_path)
319 def get_priv_net_config(net_name, subnet_name, router_name=None,
320 cidr='10.55.0.0/24', external_net=None):
321 return OSNetworkConfig(net_name, subnet_name, cidr, router_name,
322 external_gateway=external_net)
325 def get_pub_net_config(net_name, subnet_name=None, router_name=None,
326 cidr='10.55.1.0/24', external_net=None):
327 return OSNetworkConfig(net_name, subnet_name, cidr, router_name,
328 external_gateway=external_net)
331 class OSNetworkConfig:
333 Represents the settings required for the creation of a network in OpenStack
336 def __init__(self, net_name, subnet_name=None, subnet_cidr=None,
337 router_name=None, external_gateway=None):
339 if subnet_name and subnet_cidr:
340 self.network_settings = NetworkSettings(
341 name=net_name, subnet_settings=[
342 SubnetSettings(cidr=subnet_cidr, name=subnet_name)])
344 self.network_settings = NetworkSettings(name=net_name)
348 self.router_settings = RouterSettings(
349 name=router_name, external_gateway=external_gateway,
350 internal_subnets=[subnet_name])
352 self.router_settings = RouterSettings(
353 name=router_name, external_gateway=external_gateway)