snaps/openstack/tests/openstack_tests.py

   1 # Copyright (c) 2017 Cable Television Laboratories, Inc. ("CableLabs")
   2 #                    and others.  All rights reserved.
   3 #
   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:
   7 #
   8 #     http://www.apache.org/licenses/LICENSE-2.0
   9 #
  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.
  15 import logging
  16 import re
  17
  18 import pkg_resources
  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
  24 from snaps.openstack.utils import glance_utils
  25
  26 __author__ = 'spisarski'
  27
  28 logger = logging.getLogger('openstack_tests')
  29
  30 CIRROS_DEFAULT_IMAGE_URL =\
  31     'http://download.cirros-cloud.net/0.3.4/cirros-0.3.4-x86_64-disk.img'
  32 CIRROS_DEFAULT_KERNEL_IMAGE_URL =\
  33     'http://download.cirros-cloud.net/0.3.4/cirros-0.3.4-x86_64-kernel'
  34 CIRROS_DEFAULT_RAMDISK_IMAGE_URL =\
  35     'http://download.cirros-cloud.net/0.3.4/cirros-0.3.4-x86_64-initramfs'
  36 CIRROS_USER = 'cirros'
  37
  38 CENTOS_DEFAULT_IMAGE_URL =\
  39     'http://cloud.centos.org/centos/7/images/' \
  40     'CentOS-7-x86_64-GenericCloud.qcow2'
  41 CENTOS_USER = 'centos'
  42
  43 UBUNTU_DEFAULT_IMAGE_URL = \
  44     'http://uec-images.ubuntu.com/releases/trusty/14.04/' \
  45     'ubuntu-14.04-server-cloudimg-amd64-disk1.img'
  46 UBUNTU_USER = 'ubuntu'
  47
  48 DEFAULT_IMAGE_FORMAT = 'qcow2'
  49
  50
  51 def get_credentials(os_env_file=None, proxy_settings_str=None,
  52                     ssh_proxy_cmd=None, dev_os_env_file=None):
  53     """
  54     Returns the OpenStack credentials object. It first attempts to retrieve
  55     them from a standard OpenStack source file. If that file is None, it will
  56     attempt to retrieve them with a YAML file.
  57     :param os_env_file: the OpenStack source file
  58     :param proxy_settings_str: proxy settings string <host>:<port> (optional)
  59     :param ssh_proxy_cmd: the SSH proxy command for your environment (optional)
  60     :param dev_os_env_file: the YAML file to retrieve both the OS credentials
  61                             and proxy settings
  62     :return: the SNAPS credentials object
  63     """
  64     if os_env_file:
  65         logger.debug('Reading RC file - ' + os_env_file)
  66         config = file_utils.read_os_env_file(os_env_file)
  67         proj_name = config.get('OS_PROJECT_NAME')
  68         if not proj_name:
  69             proj_name = config.get('OS_TENANT_NAME')
  70
  71         proj_domain_id = 'default'
  72         user_domain_id = 'default'
  73
  74         if config.get('OS_PROJECT_DOMAIN_ID'):
  75             proj_domain_id = config['OS_PROJECT_DOMAIN_ID']
  76         if config.get('OS_USER_DOMAIN_ID'):
  77             user_domain_id = config['OS_USER_DOMAIN_ID']
  78         if config.get('OS_IDENTITY_API_VERSION'):
  79             version = int(config['OS_IDENTITY_API_VERSION'])
  80         else:
  81             version = 2
  82
  83         proxy_settings = None
  84         if proxy_settings_str:
  85             tokens = re.split(':', proxy_settings_str)
  86             proxy_settings = ProxySettings(tokens[0], tokens[1], ssh_proxy_cmd)
  87
  88         if config.get('OS_CACERT'):
  89             https_cacert = config.get('OS_CACERT')
  90         elif config.get('OS_INSECURE'):
  91             https_cacert = False
  92         else:
  93             https_cacert = True
  94
  95         os_creds = OSCreds(username=config['OS_USERNAME'],
  96                            password=config['OS_PASSWORD'],
  97                            auth_url=config['OS_AUTH_URL'],
  98                            project_name=proj_name,
  99                            identity_api_version=version,
 100                            user_domain_id=user_domain_id,
 101                            project_domain_id=proj_domain_id,
 102                            proxy_settings=proxy_settings,
 103                            cacert=https_cacert)
 104     else:
 105         logger.info('Reading development os_env file - ' + dev_os_env_file)
 106         config = file_utils.read_yaml(dev_os_env_file)
 107         identity_api_version = config.get('identity_api_version')
 108         if not identity_api_version:
 109             identity_api_version = 2
 110
 111         image_api_version = config.get('image_api_version')
 112         if not image_api_version:
 113             image_api_version = glance_utils.VERSION_2
 114
 115         proxy_settings = None
 116         proxy_str = config.get('http_proxy')
 117         if proxy_str:
 118             tokens = re.split(':', proxy_str)
 119             proxy_settings = ProxySettings(tokens[0], tokens[1],
 120                                            config.get('ssh_proxy_cmd'))
 121
 122         os_creds = OSCreds(username=config['username'],
 123                            password=config['password'],
 124                            auth_url=config['os_auth_url'],
 125                            project_name=config['project_name'],
 126                            identity_api_version=identity_api_version,
 127                            image_api_version=image_api_version,
 128                            proxy_settings=proxy_settings)
 129
 130     logger.info('OS Credentials = ' + str(os_creds))
 131     return os_creds
 132
 133
 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):
 138     """
 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
 144                      image settings
 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
 148                             image_metadata
 149     :param ramdisk_settings: override to the ramdisk settings from the
 150                              image_metadata
 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
 154                               multiple NICs
 155     :return:
 156     """
 157
 158     logger.debug('Image metadata - ' + str(metadata))
 159
 160     if metadata and 'config' in metadata:
 161         return ImageSettings(config=metadata['config'])
 162
 163     disk_file = None
 164     if metadata:
 165         disk_url = metadata.get('disk_url')
 166         disk_file = metadata.get('disk_file')
 167     elif not disk_url:
 168         disk_url = default_url
 169     else:
 170         disk_url = disk_url
 171
 172     if metadata and \
 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)
 180     else:
 181         kernel_image_settings = kernel_settings
 182
 183     if metadata and \
 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)
 191     else:
 192         ramdisk_image_settings = ramdisk_settings
 193
 194     extra_properties = None
 195     if metadata and 'extra_properties' in metadata:
 196         extra_properties = metadata['extra_properties']
 197
 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,
 203                          public=public,
 204                          nic_config_pb_loc=nic_config_pb_loc)
 205
 206
 207 def cirros_image_settings(name=None, url=None, image_metadata=None,
 208                           kernel_settings=None, ramdisk_settings=None,
 209                           public=False):
 210     """
 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
 215                            ramdisk
 216     :param kernel_settings: override to the kernel settings from the
 217                             image_metadata
 218     :param ramdisk_settings: override to the ramdisk settings from the
 219                              image_metadata
 220     :param public: True denotes image can be used by other projects where False
 221                    indicates the converse
 222     :return:
 223     """
 224     if image_metadata and 'cirros' in image_metadata:
 225         metadata = image_metadata['cirros']
 226     else:
 227         metadata = image_metadata
 228
 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,
 234         public=public)
 235
 236
 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)
 240
 241
 242 def centos_image_settings(name, url=None, image_metadata=None,
 243                           kernel_settings=None, ramdisk_settings=None,
 244                           public=False):
 245     """
 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
 250                            ramdisk
 251     :param kernel_settings: override to the kernel settings from the
 252                             image_metadata
 253     :param ramdisk_settings: override to the ramdisk settings from the
 254                              image_metadata
 255     :param public: True denotes image can be used by other projects where False
 256                    indicates the converse
 257     :return:
 258     """
 259     if image_metadata and 'centos' in image_metadata:
 260         metadata = image_metadata['centos']
 261     else:
 262         metadata = image_metadata
 263
 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)
 273
 274
 275 def ubuntu_image_settings(name, url=None, image_metadata=None,
 276                           kernel_settings=None, ramdisk_settings=None,
 277                           public=False):
 278     """
 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
 283                            ramdisk
 284     :param kernel_settings: override to the kernel settings from the
 285                             image_metadata
 286     :param ramdisk_settings: override to the ramdisk settings from the
 287                              image_metadata
 288     :param public: True denotes image can be used by other projects where False
 289                    indicates the converse
 290     :return:
 291     """
 292     if image_metadata and 'ubuntu' in image_metadata:
 293         metadata = image_metadata['ubuntu']
 294     else:
 295         metadata = image_metadata
 296
 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)
 306
 307
 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)
 312
 313
 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)
 318
 319
 320 class OSNetworkConfig:
 321     """
 322     Represents the settings required for the creation of a network in OpenStack
 323     """
 324
 325     def __init__(self, net_name, subnet_name=None, subnet_cidr=None,
 326                  router_name=None, external_gateway=None):
 327
 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)])
 332         else:
 333             self.network_settings = NetworkSettings(name=net_name)
 334
 335         if router_name:
 336             if subnet_name:
 337                 self.router_settings = RouterSettings(
 338                     name=router_name, external_gateway=external_gateway,
 339                     internal_subnets=[subnet_name])
 340             else:
 341                 self.router_settings = RouterSettings(
 342                     name=router_name, external_gateway=external_gateway)