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.config.image import ImageConfig
  21 from snaps.config.router import RouterConfig
  22 from snaps.openstack.create_network import NetworkSettings, SubnetSettings
  23 from snaps.openstack.os_credentials import OSCreds, ProxySettings
  24
  25 __author__ = 'spisarski'
  26
  27 logger = logging.getLogger('openstack_tests')
  28
  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'
  36
  37 CENTOS_DEFAULT_IMAGE_URL =\
  38     'http://cloud.centos.org/centos/7/images/' \
  39     'CentOS-7-x86_64-GenericCloud.qcow2'
  40 CENTOS_USER = 'centos'
  41
  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'
  46
  47 DEFAULT_IMAGE_FORMAT = 'qcow2'
  48
  49
  50 def get_credentials(os_env_file=None, proxy_settings_str=None,
  51                     ssh_proxy_cmd=None, dev_os_env_file=None, overrides=None):
  52     """
  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
  60                             and proxy settings
  61     :param overrides: dict() containing values to override the credentials
  62                       found and passed in.
  63     :return: the SNAPS credentials object
  64     """
  65     if os_env_file:
  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')
  69         if not proj_name:
  70             proj_name = config.get('OS_TENANT_NAME')
  71
  72         proxy_settings = None
  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)
  77
  78         https_cacert = None
  79         if config.get('OS_CACERT'):
  80             https_cacert = config.get('OS_CACERT')
  81         elif config.get('OS_INSECURE'):
  82             https_cacert = False
  83
  84         interface = 'public'
  85         if config.get('OS_INTERFACE'):
  86             interface = config.get('OS_INTERFACE')
  87
  88         creds_dict = {
  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             'volume_api_version': config.get('OS_VOLUME_API_VERSION'),
 103             'interface': interface,
 104             'proxy_settings': proxy_settings,
 105             'cacert': https_cacert,
 106             'region_name': config.get('OS_REGION_NAME')}
 107     else:
 108         logger.info('Reading development os_env file - ' + dev_os_env_file)
 109         config = file_utils.read_yaml(dev_os_env_file)
 110
 111         proxy_settings = None
 112         proxy_str = config.get('http_proxy')
 113         if proxy_str:
 114             tokens = re.split(':', proxy_str)
 115             proxy_settings = ProxySettings(
 116                 host=tokens[0], port=tokens[1],
 117                 ssh_proxy_cmd=config.get('ssh_proxy_cmd'))
 118
 119         creds_dict = {
 120             'username': config['username'],
 121             'password': config['password'],
 122             'auth_url': config['os_auth_url'],
 123             'project_name': config['project_name'],
 124             'identity_api_version': config.get('identity_api_version'),
 125             'image_api_version': config.get('image_api_version'),
 126             'network_api_version': config.get('network_api_version'),
 127             'compute_api_version': config.get('compute_api_version'),
 128             'heat_api_version': config.get('heat_api_version'),
 129             'user_domain_id': config.get('user_domain_id'),
 130             'user_domain_name': config.get('user_domain_name'),
 131             'project_domain_id': config.get('project_domain_id'),
 132             'project_domain_name': config.get('project_domain_name'),
 133             'volume_api_version': config.get('volume_api_version'),
 134             'interface': config.get('interface'),
 135             'proxy_settings': proxy_settings,
 136             'cacert': config.get('cacert'),
 137             'region_name': config.get('region_name')}
 138
 139     if overrides and isinstance(overrides, dict):
 140         creds_dict.update(overrides)
 141
 142     os_creds = OSCreds(**creds_dict)
 143     logger.info('OS Credentials = %s', os_creds.__str__)
 144     return os_creds
 145
 146
 147 def create_image_settings(image_name, image_user, image_format, metadata,
 148                           disk_url=None, default_url=None,
 149                           kernel_settings=None, ramdisk_settings=None,
 150                           public=False, nic_config_pb_loc=None):
 151     """
 152     Returns the image settings object
 153     :param image_name: the name of the image
 154     :param image_user: the image's sudo user
 155     :param image_format: the image's format string
 156     :param metadata: custom metadata for overriding default behavior for test
 157                      image settings
 158     :param disk_url: the disk image's URL
 159     :param default_url: the default URL for the disk image
 160     :param kernel_settings: override to the kernel settings from the
 161                             image_metadata
 162     :param ramdisk_settings: override to the ramdisk settings from the
 163                              image_metadata
 164     :param public: True denotes image can be used by other projects where False
 165                    indicates the converse (default: False)
 166     :param nic_config_pb_loc: The location of the playbook used for configuring
 167                               multiple NICs
 168     :return:
 169     """
 170
 171     logger.debug('Image metadata - ' + str(metadata))
 172
 173     if metadata and 'config' in metadata:
 174         return ImageConfig(**metadata['config'])
 175
 176     disk_file = None
 177     if metadata:
 178         disk_url = metadata.get('disk_url')
 179         disk_file = metadata.get('disk_file')
 180     elif not disk_url:
 181         disk_url = default_url
 182     else:
 183         disk_url = disk_url
 184
 185     if metadata and \
 186             ('kernel_file' in metadata or 'kernel_url' in metadata) and \
 187             kernel_settings is None:
 188         kernel_image_settings = ImageConfig(
 189             name=image_name + '-kernel', image_user=image_user,
 190             img_format=image_format, image_file=metadata.get('kernel_file'),
 191             url=metadata.get('kernel_url'), public=public)
 192     else:
 193         kernel_image_settings = kernel_settings
 194
 195     if metadata and \
 196             ('ramdisk_file' in metadata or 'ramdisk_url' in metadata) and \
 197             ramdisk_settings is None:
 198         ramdisk_image_settings = ImageConfig(
 199             name=image_name + '-ramdisk', image_user=image_user,
 200             img_format=image_format,
 201             image_file=metadata.get('ramdisk_file'),
 202             url=metadata.get('ramdisk_url'), public=public)
 203     else:
 204         ramdisk_image_settings = ramdisk_settings
 205
 206     extra_properties = None
 207     if metadata and 'extra_properties' in metadata:
 208         extra_properties = metadata['extra_properties']
 209
 210     return ImageConfig(name=image_name, image_user=image_user,
 211                        img_format=image_format, image_file=disk_file,
 212                        url=disk_url, extra_properties=extra_properties,
 213                        kernel_image_settings=kernel_image_settings,
 214                        ramdisk_image_settings=ramdisk_image_settings,
 215                        public=public,
 216                        nic_config_pb_loc=nic_config_pb_loc)
 217
 218
 219 def cirros_image_settings(name=None, url=None, image_metadata=None,
 220                           kernel_settings=None, ramdisk_settings=None,
 221                           public=False):
 222     """
 223     Returns the image settings for a Cirros QCOW2 image
 224     :param name: the name of the image
 225     :param url: the image's URL
 226     :param image_metadata: dict() values to override URLs for disk, kernel, and
 227                            ramdisk
 228     :param kernel_settings: override to the kernel settings from the
 229                             image_metadata
 230     :param ramdisk_settings: override to the ramdisk settings from the
 231                              image_metadata
 232     :param public: True denotes image can be used by other projects where False
 233                    indicates the converse
 234     :return:
 235     """
 236     if image_metadata and 'cirros' in image_metadata:
 237         metadata = image_metadata['cirros']
 238     else:
 239         metadata = image_metadata
 240
 241     return create_image_settings(
 242         image_name=name, image_user=CIRROS_USER,
 243         image_format=DEFAULT_IMAGE_FORMAT, metadata=metadata, disk_url=url,
 244         default_url=CIRROS_DEFAULT_IMAGE_URL,
 245         kernel_settings=kernel_settings, ramdisk_settings=ramdisk_settings,
 246         public=public)
 247
 248
 249 def file_image_test_settings(name, file_path, image_user=CIRROS_USER):
 250     return ImageConfig(name=name, image_user=image_user,
 251                        img_format=DEFAULT_IMAGE_FORMAT, image_file=file_path)
 252
 253
 254 def centos_image_settings(name, url=None, image_metadata=None,
 255                           kernel_settings=None, ramdisk_settings=None,
 256                           public=False):
 257     """
 258     Returns the image settings for a Centos QCOW2 image
 259     :param name: the name of the image
 260     :param url: the image's URL
 261     :param image_metadata: dict() values to override URLs for disk, kernel, and
 262                            ramdisk
 263     :param kernel_settings: override to the kernel settings from the
 264                             image_metadata
 265     :param ramdisk_settings: override to the ramdisk settings from the
 266                              image_metadata
 267     :param public: True denotes image can be used by other projects where False
 268                    indicates the converse
 269     :return:
 270     """
 271     if image_metadata and 'centos' in image_metadata:
 272         metadata = image_metadata['centos']
 273     else:
 274         metadata = image_metadata
 275
 276     pb_path = pkg_resources.resource_filename(
 277         'snaps.provisioning.ansible_pb.centos-network-setup.playbooks',
 278         'configure_host.yml')
 279     return create_image_settings(
 280         image_name=name, image_user=CENTOS_USER,
 281         image_format=DEFAULT_IMAGE_FORMAT, metadata=metadata, disk_url=url,
 282         default_url=CENTOS_DEFAULT_IMAGE_URL,
 283         kernel_settings=kernel_settings, ramdisk_settings=ramdisk_settings,
 284         public=public, nic_config_pb_loc=pb_path)
 285
 286
 287 def ubuntu_image_settings(name, url=None, image_metadata=None,
 288                           kernel_settings=None, ramdisk_settings=None,
 289                           public=False):
 290     """
 291     Returns the image settings for a Ubuntu QCOW2 image
 292     :param name: the name of the image
 293     :param url: the image's URL
 294     :param image_metadata: dict() values to override URLs for disk, kernel, and
 295                            ramdisk
 296     :param kernel_settings: override to the kernel settings from the
 297                             image_metadata
 298     :param ramdisk_settings: override to the ramdisk settings from the
 299                              image_metadata
 300     :param public: True denotes image can be used by other projects where False
 301                    indicates the converse
 302     :return:
 303     """
 304     if image_metadata and 'ubuntu' in image_metadata:
 305         metadata = image_metadata['ubuntu']
 306     else:
 307         metadata = image_metadata
 308
 309     pb_path = pkg_resources.resource_filename(
 310         'snaps.provisioning.ansible_pb.ubuntu-network-setup.playbooks',
 311         'configure_host.yml')
 312     return create_image_settings(
 313         image_name=name, image_user=UBUNTU_USER,
 314         image_format=DEFAULT_IMAGE_FORMAT, metadata=metadata, disk_url=url,
 315         default_url=UBUNTU_DEFAULT_IMAGE_URL,
 316         kernel_settings=kernel_settings, ramdisk_settings=ramdisk_settings,
 317         public=public, nic_config_pb_loc=pb_path)
 318
 319
 320 def get_priv_net_config(net_name, subnet_name, router_name=None,
 321                         cidr='10.55.0.0/24', external_net=None):
 322     return OSNetworkConfig(net_name, subnet_name, cidr, router_name,
 323                            external_gateway=external_net)
 324
 325
 326 def get_pub_net_config(net_name, subnet_name=None, router_name=None,
 327                        cidr='10.55.1.0/24', external_net=None):
 328     return OSNetworkConfig(net_name, subnet_name, cidr, router_name,
 329                            external_gateway=external_net)
 330
 331
 332 class OSNetworkConfig:
 333     """
 334     Represents the settings required for the creation of a network in OpenStack
 335     """
 336
 337     def __init__(self, net_name, subnet_name=None, subnet_cidr=None,
 338                  router_name=None, external_gateway=None):
 339
 340         if subnet_name and subnet_cidr:
 341             self.network_settings = NetworkSettings(
 342                 name=net_name, subnet_settings=[
 343                     SubnetSettings(cidr=subnet_cidr, name=subnet_name)])
 344         else:
 345             self.network_settings = NetworkSettings(name=net_name)
 346
 347         if router_name:
 348             if subnet_name:
 349                 self.router_settings = RouterConfig(
 350                     name=router_name, external_gateway=external_gateway,
 351                     internal_subnets=[subnet_name])
 352             else:
 353                 self.router_settings = RouterConfig(
 354                     name=router_name, external_gateway=external_gateway)