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 re
  16
  17 from snaps import file_utils
  18 from snaps.openstack.utils import glance_utils
  19 from snaps.openstack.create_network import NetworkSettings, SubnetSettings
  20 from snaps.openstack.create_router import RouterSettings
  21 from snaps.openstack.os_credentials import OSCreds, ProxySettings
  22 from snaps.openstack.create_image import ImageSettings
  23 import logging
  24
  25 __author__ = 'spisarski'
  26
  27
  28 logger = logging.getLogger('openstack_tests')
  29
  30
  31 def get_credentials(os_env_file=None, proxy_settings_str=None, ssh_proxy_cmd=None, dev_os_env_file=None):
  32     """
  33     Returns the OpenStack credentials object. It first attempts to retrieve them from a standard OpenStack source file.
  34     If that file is None, it will attempt to retrieve them with a YAML file.
  35     it will retrieve them from a
  36     :param os_env_file: the OpenStack source file
  37     :param proxy_settings_str: proxy settings string <host>:<port> (optional)
  38     :param ssh_proxy_cmd: the SSH proxy command for your environment (optional)
  39     :param dev_os_env_file: the YAML file to retrieve both the OS credentials and proxy settings
  40     :return: the SNAPS credentials object
  41     """
  42     if os_env_file:
  43         logger.debug('Reading RC file - ' + os_env_file)
  44         config = file_utils.read_os_env_file(os_env_file)
  45         proj_name = config.get('OS_PROJECT_NAME')
  46         if not proj_name:
  47             proj_name = config.get('OS_TENANT_NAME')
  48
  49         proj_domain_id = 'default'
  50         user_domain_id = 'default'
  51
  52         if config.get('OS_PROJECT_DOMAIN_ID'):
  53             proj_domain_id = config['OS_PROJECT_DOMAIN_ID']
  54         if config.get('OS_USER_DOMAIN_ID'):
  55             user_domain_id = config['OS_USER_DOMAIN_ID']
  56         if config.get('OS_IDENTITY_API_VERSION'):
  57             version = int(config['OS_IDENTITY_API_VERSION'])
  58         else:
  59             version = 2
  60
  61         proxy_settings = None
  62         if proxy_settings_str:
  63             tokens = re.split(':', proxy_settings_str)
  64             proxy_settings = ProxySettings(tokens[0], tokens[1], ssh_proxy_cmd)
  65
  66         os_creds = OSCreds(username=config['OS_USERNAME'],
  67                            password=config['OS_PASSWORD'],
  68                            auth_url=config['OS_AUTH_URL'],
  69                            project_name=proj_name,
  70                            identity_api_version=version,
  71                            user_domain_id=user_domain_id,
  72                            project_domain_id=proj_domain_id,
  73                            proxy_settings=proxy_settings)
  74     else:
  75         logger.info('Reading development os_env file - ' + dev_os_env_file)
  76         config = file_utils.read_yaml(dev_os_env_file)
  77         identity_api_version = config.get('identity_api_version')
  78         if not identity_api_version:
  79             identity_api_version = 2
  80
  81         image_api_version = config.get('image_api_version')
  82         if not image_api_version:
  83             image_api_version = glance_utils.VERSION_2
  84
  85         proxy_settings = None
  86         proxy_str = config.get('http_proxy')
  87         if proxy_str:
  88             tokens = re.split(':', proxy_str)
  89             proxy_settings = ProxySettings(tokens[0], tokens[1], config.get('ssh_proxy_cmd'))
  90
  91         os_creds = OSCreds(username=config['username'], password=config['password'],
  92                            auth_url=config['os_auth_url'], project_name=config['project_name'],
  93                            identity_api_version=identity_api_version, image_api_version=image_api_version,
  94                            proxy_settings=proxy_settings)
  95
  96     logger.info('OS Credentials = ' + str(os_creds))
  97     return os_creds
  98
  99
 100 def cirros_image_settings(name, url=None, image_metadata=None, kernel_settings=None, ramdisk_settings=None):
 101     """
 102     Returns the image settings for a Cirros QCOW2 image
 103     :param name: the name of the image
 104     :param url: the image's URL
 105     :param image_metadata: dict() values to override URLs for disk, kernel, and ramdisk
 106     :param kernel_settings: override to the kernel settings from the image_metadata
 107     :param ramdisk_settings: override to the ramdisk settings from the image_metadata
 108     :return:
 109     """
 110     if image_metadata and 'cirros' in image_metadata:
 111         metadata = image_metadata['cirros']
 112     else:
 113         metadata = image_metadata
 114
 115     if metadata and 'disk_url' in metadata:
 116         url = metadata['disk_url']
 117     if not url:
 118         url = 'http://download.cirros-cloud.net/0.3.4/cirros-0.3.4-x86_64-disk.img'
 119
 120     if metadata and 'kernel_url' in metadata and kernel_settings is None:
 121         kernel_image_settings = ImageSettings(name=name + '-kernel', image_user='cirros', img_format='qcow2',
 122                                               url=metadata['kernel_url'])
 123     else:
 124         kernel_image_settings = kernel_settings
 125
 126     if metadata and 'ramdisk_url' in metadata and ramdisk_settings is None:
 127         ramdisk_image_settings = ImageSettings(name=name + '-ramdisk', image_user='cirros', img_format='qcow2',
 128                                                url=metadata['ramdisk_url'])
 129     else:
 130         ramdisk_image_settings = ramdisk_settings
 131
 132     extra_properties = None
 133     if metadata and 'extra_properties' in metadata:
 134         extra_properties = metadata['extra_properties']
 135
 136     return ImageSettings(name=name, image_user='cirros', img_format='qcow2', url=url,
 137                          extra_properties=extra_properties,
 138                          kernel_image_settings=kernel_image_settings,
 139                          ramdisk_image_settings=ramdisk_image_settings)
 140
 141
 142 def file_image_test_settings(name, file_path, image_user='cirros'):
 143     return ImageSettings(name=name, image_user=image_user, img_format='qcow2', image_file=file_path)
 144
 145
 146 def centos_image_settings(name, url=None, image_metadata=None):
 147     """
 148     Returns the image settings for a Centos QCOW2 image
 149     :param name: the name of the image
 150     :param url: the image's URL
 151     :param image_metadata: dict() values to override URLs for disk, kernel, and ramdisk
 152     :return:
 153     """
 154     if image_metadata and 'centos' in image_metadata:
 155         metadata = image_metadata['centos']
 156     else:
 157         metadata = image_metadata
 158
 159     if metadata and 'disk_url' in metadata:
 160         url = metadata['disk_url']
 161     if not url:
 162         url = 'http://cloud.centos.org/centos/7/images/CentOS-7-x86_64-GenericCloud.qcow2'
 163
 164     kernel_image_settings = None
 165     if metadata and 'kernel_url' in metadata:
 166         kernel_image_settings = ImageSettings(name=name + '-kernel', image_user='centos', img_format='qcow2',
 167                                               url=metadata['kernel_url'])
 168     ramdisk_image_settings = None
 169     if metadata and 'ramdisk_url' in metadata:
 170         ramdisk_image_settings = ImageSettings(name=name + '-ramdisk', image_user='centos', img_format='qcow2',
 171                                                url=metadata['ramdisk_url'])
 172
 173     extra_properties = None
 174     if metadata and 'extra_properties' in metadata:
 175         extra_properties = metadata['extra_properties']
 176
 177     return ImageSettings(
 178         name=name, image_user='centos', img_format='qcow2',
 179         extra_properties=extra_properties, url=url,
 180         nic_config_pb_loc='./provisioning/ansible/centos-network-setup/playbooks/configure_host.yml',
 181         kernel_image_settings=kernel_image_settings,
 182         ramdisk_image_settings=ramdisk_image_settings)
 183
 184
 185 def ubuntu_image_settings(name, url=None, image_metadata=None):
 186     """
 187     Returns the image settings for a Ubuntu QCOW2 image
 188     :param name: the name of the image
 189     :param url: the image's URL
 190     :param image_metadata: dict() values to override URLs for disk, kernel, and ramdisk
 191     :return:
 192     """
 193     if image_metadata and 'ubuntu' in image_metadata:
 194         metadata = image_metadata['ubuntu']
 195     else:
 196         metadata = image_metadata
 197
 198     if metadata and 'disk_url' in metadata:
 199         url = metadata['disk_url']
 200     if not url:
 201         url = 'http://uec-images.ubuntu.com/releases/trusty/14.04/ubuntu-14.04-server-cloudimg-amd64-disk1.img'
 202
 203     kernel_image_settings = None
 204     if metadata and 'kernel_url' in metadata:
 205         kernel_image_settings = ImageSettings(name=name + '-kernel', url=metadata['kernel_url'])
 206     ramdisk_image_settings = None
 207     if metadata and 'ramdisk_url' in metadata:
 208         ramdisk_image_settings = ImageSettings(name=name + '-ramdisk', url=metadata['ramdisk_url'])
 209
 210     extra_properties = None
 211     if metadata and 'extra_properties' in metadata:
 212         extra_properties = metadata['extra_properties']
 213
 214     return ImageSettings(
 215         name=name, image_user='ubuntu', img_format='qcow2',
 216         extra_properties=extra_properties, url=url,
 217         nic_config_pb_loc='./provisioning/ansible/ubuntu-network-setup/playbooks/configure_host.yml',
 218         kernel_image_settings=kernel_image_settings,
 219         ramdisk_image_settings=ramdisk_image_settings)
 220
 221
 222 def get_priv_net_config(net_name, subnet_name, router_name=None, cidr='10.55.0.0/24', external_net=None):
 223     return OSNetworkConfig(net_name, subnet_name, cidr, router_name, external_gateway=external_net)
 224
 225
 226 def get_pub_net_config(net_name, subnet_name=None, router_name=None, cidr='10.55.1.0/24', external_net=None):
 227     return OSNetworkConfig(net_name, subnet_name, cidr, router_name, external_gateway=external_net)
 228
 229
 230 class OSNetworkConfig:
 231     """
 232     Represents the settings required for the creation of a network in OpenStack
 233     """
 234
 235     def __init__(self, net_name, subnet_name=None, subnet_cidr=None, router_name=None, external_gateway=None):
 236
 237         if subnet_name and subnet_cidr:
 238             self.network_settings = NetworkSettings(
 239                 name=net_name, subnet_settings=[SubnetSettings(cidr=subnet_cidr, name=subnet_name)])
 240         else:
 241             self.network_settings = NetworkSettings(name=net_name)
 242
 243         if router_name:
 244             if subnet_name:
 245                 self.router_settings = RouterSettings(name=router_name, external_gateway=external_gateway,
 246                                                       internal_subnets=[subnet_name])
 247             else:
 248                 self.router_settings = RouterSettings(name=router_name, external_gateway=external_gateway)