Refactor OSCreds to leverage kwargs instead of named parameters.
[snaps.git] / snaps / openstack / tests / openstack_tests.py
index 81e49ee..59c7395 100644 (file)
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
+import logging
 import re
 
+import pkg_resources
 from snaps import file_utils
-from snaps.openstack.utils import glance_utils
+from snaps.openstack.create_image import ImageSettings
 from snaps.openstack.create_network import NetworkSettings, SubnetSettings
 from snaps.openstack.create_router import RouterSettings
 from snaps.openstack.os_credentials import OSCreds, ProxySettings
-from snaps.openstack.create_image import ImageSettings
-import logging
+from snaps.openstack.utils import glance_utils
 
 __author__ = 'spisarski'
 
-
 logger = logging.getLogger('openstack_tests')
 
+CIRROS_DEFAULT_IMAGE_URL =\
+    'http://download.cirros-cloud.net/0.3.4/cirros-0.3.4-x86_64-disk.img'
+CIRROS_DEFAULT_KERNEL_IMAGE_URL =\
+    'http://download.cirros-cloud.net/0.3.4/cirros-0.3.4-x86_64-kernel'
+CIRROS_DEFAULT_RAMDISK_IMAGE_URL =\
+    'http://download.cirros-cloud.net/0.3.4/cirros-0.3.4-x86_64-initramfs'
+CIRROS_USER = 'cirros'
+
+CENTOS_DEFAULT_IMAGE_URL =\
+    'http://cloud.centos.org/centos/7/images/' \
+    'CentOS-7-x86_64-GenericCloud.qcow2'
+CENTOS_USER = 'centos'
+
+UBUNTU_DEFAULT_IMAGE_URL = \
+    'http://uec-images.ubuntu.com/releases/trusty/14.04/' \
+    'ubuntu-14.04-server-cloudimg-amd64-disk1.img'
+UBUNTU_USER = 'ubuntu'
 
-def get_credentials(os_env_file=None, proxy_settings_str=None, ssh_proxy_cmd=None, dev_os_env_file=None):
+DEFAULT_IMAGE_FORMAT = 'qcow2'
+
+
+def get_credentials(os_env_file=None, proxy_settings_str=None,
+                    ssh_proxy_cmd=None, dev_os_env_file=None):
     """
-    Returns the OpenStack credentials object. It first attempts to retrieve them from a standard OpenStack source file.
-    If that file is None, it will attempt to retrieve them with a YAML file.
-    it will retrieve them from a
+    Returns the OpenStack credentials object. It first attempts to retrieve
+    them from a standard OpenStack source file. If that file is None, it will
+    attempt to retrieve them with a YAML file.
     :param os_env_file: the OpenStack source file
     :param proxy_settings_str: proxy settings string <host>:<port> (optional)
     :param ssh_proxy_cmd: the SSH proxy command for your environment (optional)
-    :param dev_os_env_file: the YAML file to retrieve both the OS credentials and proxy settings
+    :param dev_os_env_file: the YAML file to retrieve both the OS credentials
+                            and proxy settings
     :return: the SNAPS credentials object
     """
     if os_env_file:
@@ -61,7 +83,19 @@ def get_credentials(os_env_file=None, proxy_settings_str=None, ssh_proxy_cmd=Non
         proxy_settings = None
         if proxy_settings_str:
             tokens = re.split(':', proxy_settings_str)
-            proxy_settings = ProxySettings(tokens[0], tokens[1], ssh_proxy_cmd)
+            proxy_settings = ProxySettings(host=tokens[0], port=tokens[1],
+                                           ssh_proxy_cmd=ssh_proxy_cmd)
+
+        if config.get('OS_CACERT'):
+            https_cacert = config.get('OS_CACERT')
+        elif config.get('OS_INSECURE'):
+            https_cacert = False
+        else:
+            https_cacert = True
+
+        interface = 'admin'
+        if config.get('OS_INTERFACE'):
+            interface = config.get('OS_INTERFACE')
 
         os_creds = OSCreds(username=config['OS_USERNAME'],
                            password=config['OS_PASSWORD'],
@@ -70,7 +104,9 @@ def get_credentials(os_env_file=None, proxy_settings_str=None, ssh_proxy_cmd=Non
                            identity_api_version=version,
                            user_domain_id=user_domain_id,
                            project_domain_id=proj_domain_id,
-                           proxy_settings=proxy_settings)
+                           interface=interface,
+                           proxy_settings=proxy_settings,
+                           cacert=https_cacert)
     else:
         logger.info('Reading development os_env file - ' + dev_os_env_file)
         config = file_utils.read_yaml(dev_os_env_file)
@@ -86,120 +122,206 @@ def get_credentials(os_env_file=None, proxy_settings_str=None, ssh_proxy_cmd=Non
         proxy_str = config.get('http_proxy')
         if proxy_str:
             tokens = re.split(':', proxy_str)
-            proxy_settings = ProxySettings(tokens[0], tokens[1], config.get('ssh_proxy_cmd'))
-
-        os_creds = OSCreds(username=config['username'], password=config['password'],
-                           auth_url=config['os_auth_url'], project_name=config['project_name'],
-                           identity_api_version=identity_api_version, image_api_version=image_api_version,
+            proxy_settings = ProxySettings(
+                host=tokens[0], port=tokens[1],
+                ssh_proxy_cmd=config.get('ssh_proxy_cmd'))
+
+        os_creds = OSCreds(username=config['username'],
+                           password=config['password'],
+                           auth_url=config['os_auth_url'],
+                           project_name=config['project_name'],
+                           identity_api_version=identity_api_version,
+                           image_api_version=image_api_version,
                            proxy_settings=proxy_settings)
 
-    logger.info('OS Credentials = ' + str(os_creds))
+    logger.info('OS Credentials = %s', os_creds)
     return os_creds
 
 
-def cirros_url_image(name, url=None, image_metadata=None, kernel_settings=None, ramdisk_settings=None):
-    if image_metadata and 'disk_url' in image_metadata:
-        url = image_metadata['disk_url']
-    if not url:
-        url = 'http://download.cirros-cloud.net/0.3.4/cirros-0.3.4-x86_64-disk.img'
+def create_image_settings(image_name, image_user, image_format, metadata,
+                          disk_url=None, default_url=None,
+                          kernel_settings=None, ramdisk_settings=None,
+                          public=False, nic_config_pb_loc=None):
+    """
+    Returns the image settings object
+    :param image_name: the name of the image
+    :param image_user: the image's sudo user
+    :param image_format: the image's format string
+    :param metadata: custom metadata for overriding default behavior for test
+                     image settings
+    :param disk_url: the disk image's URL
+    :param default_url: the default URL for the disk image
+    :param kernel_settings: override to the kernel settings from the
+                            image_metadata
+    :param ramdisk_settings: override to the ramdisk settings from the
+                             image_metadata
+    :param public: True denotes image can be used by other projects where False
+                   indicates the converse (default: False)
+    :param nic_config_pb_loc: The location of the playbook used for configuring
+                              multiple NICs
+    :return:
+    """
+
+    logger.debug('Image metadata - ' + str(metadata))
+
+    if metadata and 'config' in metadata:
+        return ImageSettings(**metadata['config'])
 
-    if image_metadata and 'kernel_url' in image_metadata and kernel_settings is None:
-        kernel_image_settings = ImageSettings(name=name + '-kernel', image_user='cirros', img_format='qcow2',
-                                              url=image_metadata['kernel_url'])
+    disk_file = None
+    if metadata:
+        disk_url = metadata.get('disk_url')
+        disk_file = metadata.get('disk_file')
+    elif not disk_url:
+        disk_url = default_url
+    else:
+        disk_url = disk_url
+
+    if metadata and \
+            ('kernel_file' in metadata or 'kernel_url' in metadata) and \
+            kernel_settings is None:
+        kernel_image_settings = ImageSettings(
+            name=image_name + '-kernel', image_user=image_user,
+            img_format=image_format,
+            image_file=metadata.get('kernel_file'),
+            url=metadata.get('kernel_url'), public=public)
     else:
         kernel_image_settings = kernel_settings
 
-    if image_metadata and 'ramdisk_url' in image_metadata and ramdisk_settings is None:
-        ramdisk_image_settings = ImageSettings(name=name + '-ramdisk', image_user='cirros', img_format='qcow2',
-                                               url=image_metadata['ramdisk_url'])
+    if metadata and \
+            ('ramdisk_file' in metadata or 'ramdisk_url' in metadata) and \
+            ramdisk_settings is None:
+        ramdisk_image_settings = ImageSettings(
+            name=image_name + '-ramdisk', image_user=image_user,
+            img_format=image_format,
+            image_file=metadata.get('ramdisk_file'),
+            url=metadata.get('ramdisk_url'), public=public)
     else:
         ramdisk_image_settings = ramdisk_settings
 
     extra_properties = None
-    if image_metadata and 'extra_properties' in image_metadata:
-        extra_properties = image_metadata['extra_properties']
+    if metadata and 'extra_properties' in metadata:
+        extra_properties = metadata['extra_properties']
 
-    return ImageSettings(name=name, image_user='cirros', img_format='qcow2', url=url,
-                         extra_properties=extra_properties,
+    return ImageSettings(name=image_name, image_user=image_user,
+                         img_format=image_format, image_file=disk_file,
+                         url=disk_url, extra_properties=extra_properties,
                          kernel_image_settings=kernel_image_settings,
-                         ramdisk_image_settings=ramdisk_image_settings)
+                         ramdisk_image_settings=ramdisk_image_settings,
+                         public=public,
+                         nic_config_pb_loc=nic_config_pb_loc)
 
 
-def file_image_test_settings(name, file_path, image_user='cirros', image_metadata=None):
-    kernel_image_settings = None
-    if image_metadata and 'kernel_url' in image_metadata:
-        kernel_image_settings = ImageSettings(name=name + '-kernel', url=image_metadata['kernel_url'])
-    ramdisk_image_settings = None
-    if image_metadata and 'ramdisk_url' in image_metadata:
-        ramdisk_image_settings = ImageSettings(name=name + '-ramdisk', url=image_metadata['ramdisk_url'])
-
-    extra_properties = None
-    if image_metadata and 'extra_properties' in image_metadata:
-        extra_properties = image_metadata['extra_properties']
-
-    return ImageSettings(name=name, image_user=image_user, img_format='qcow2',
-                         extra_properties=extra_properties,
-                         image_file=file_path,
-                         kernel_image_settings=kernel_image_settings,
-                         ramdisk_image_settings=ramdisk_image_settings)
+def cirros_image_settings(name=None, url=None, image_metadata=None,
+                          kernel_settings=None, ramdisk_settings=None,
+                          public=False):
+    """
+    Returns the image settings for a Cirros QCOW2 image
+    :param name: the name of the image
+    :param url: the image's URL
+    :param image_metadata: dict() values to override URLs for disk, kernel, and
+                           ramdisk
+    :param kernel_settings: override to the kernel settings from the
+                            image_metadata
+    :param ramdisk_settings: override to the ramdisk settings from the
+                             image_metadata
+    :param public: True denotes image can be used by other projects where False
+                   indicates the converse
+    :return:
+    """
+    if image_metadata and 'cirros' in image_metadata:
+        metadata = image_metadata['cirros']
+    else:
+        metadata = image_metadata
 
+    return create_image_settings(
+        image_name=name, image_user=CIRROS_USER,
+        image_format=DEFAULT_IMAGE_FORMAT, metadata=metadata, disk_url=url,
+        default_url=CIRROS_DEFAULT_IMAGE_URL,
+        kernel_settings=kernel_settings, ramdisk_settings=ramdisk_settings,
+        public=public)
 
-def centos_url_image(name, url=None, image_metadata=None):
-    if image_metadata and 'disk_url' in image_metadata:
-        url = image_metadata['disk_url']
-    if not url:
-        url = 'http://cloud.centos.org/centos/7/images/CentOS-7-x86_64-GenericCloud.qcow2'
 
-    kernel_image_settings = None
-    if image_metadata and 'kernel_url' in image_metadata:
-        kernel_image_settings = ImageSettings(name=name + '-kernel', url=image_metadata['kernel_url'])
-    ramdisk_image_settings = None
-    if image_metadata and 'ramdisk_url' in image_metadata:
-        ramdisk_image_settings = ImageSettings(name=name + '-ramdisk', url=image_metadata['ramdisk_url'])
+def file_image_test_settings(name, file_path, image_user=CIRROS_USER):
+    return ImageSettings(name=name, image_user=image_user,
+                         img_format=DEFAULT_IMAGE_FORMAT, image_file=file_path)
 
-    extra_properties = None
-    if image_metadata and 'extra_properties' in image_metadata:
-        extra_properties = image_metadata['extra_properties']
-
-    return ImageSettings(
-        name=name, image_user='centos', img_format='qcow2',
-        extra_properties=extra_properties, url=url,
-        nic_config_pb_loc='./provisioning/ansible/centos-network-setup/playbooks/configure_host.yml',
-        kernel_image_settings=kernel_image_settings,
-        ramdisk_image_settings=ramdisk_image_settings)
-
-
-def ubuntu_url_image(name, url=None, image_metadata=None):
-    if image_metadata and 'disk_url' in image_metadata:
-        url = image_metadata['disk_url']
-    if not url:
-        url = 'http://uec-images.ubuntu.com/releases/trusty/14.04/ubuntu-14.04-server-cloudimg-amd64-disk1.img'
-
-    kernel_image_settings = None
-    if image_metadata and 'kernel_url' in image_metadata:
-        kernel_image_settings = ImageSettings(name=name + '-kernel', url=image_metadata['kernel_url'])
-    ramdisk_image_settings = None
-    if image_metadata and 'ramdisk_url' in image_metadata:
-        ramdisk_image_settings = ImageSettings(name=name + '-ramdisk', url=image_metadata['ramdisk_url'])
 
-    extra_properties = None
-    if image_metadata and 'extra_properties' in image_metadata:
-        extra_properties = image_metadata['extra_properties']
+def centos_image_settings(name, url=None, image_metadata=None,
+                          kernel_settings=None, ramdisk_settings=None,
+                          public=False):
+    """
+    Returns the image settings for a Centos QCOW2 image
+    :param name: the name of the image
+    :param url: the image's URL
+    :param image_metadata: dict() values to override URLs for disk, kernel, and
+                           ramdisk
+    :param kernel_settings: override to the kernel settings from the
+                            image_metadata
+    :param ramdisk_settings: override to the ramdisk settings from the
+                             image_metadata
+    :param public: True denotes image can be used by other projects where False
+                   indicates the converse
+    :return:
+    """
+    if image_metadata and 'centos' in image_metadata:
+        metadata = image_metadata['centos']
+    else:
+        metadata = image_metadata
+
+    pb_path = pkg_resources.resource_filename(
+        'snaps.provisioning.ansible_pb.centos-network-setup.playbooks',
+        'configure_host.yml')
+    return create_image_settings(
+        image_name=name, image_user=CENTOS_USER,
+        image_format=DEFAULT_IMAGE_FORMAT, metadata=metadata, disk_url=url,
+        default_url=CENTOS_DEFAULT_IMAGE_URL,
+        kernel_settings=kernel_settings, ramdisk_settings=ramdisk_settings,
+        public=public, nic_config_pb_loc=pb_path)
+
+
+def ubuntu_image_settings(name, url=None, image_metadata=None,
+                          kernel_settings=None, ramdisk_settings=None,
+                          public=False):
+    """
+    Returns the image settings for a Ubuntu QCOW2 image
+    :param name: the name of the image
+    :param url: the image's URL
+    :param image_metadata: dict() values to override URLs for disk, kernel, and
+                           ramdisk
+    :param kernel_settings: override to the kernel settings from the
+                            image_metadata
+    :param ramdisk_settings: override to the ramdisk settings from the
+                             image_metadata
+    :param public: True denotes image can be used by other projects where False
+                   indicates the converse
+    :return:
+    """
+    if image_metadata and 'ubuntu' in image_metadata:
+        metadata = image_metadata['ubuntu']
+    else:
+        metadata = image_metadata
 
-    return ImageSettings(
-        name=name, image_user='ubuntu', img_format='qcow2',
-        extra_properties=extra_properties, url=url,
-        nic_config_pb_loc='./provisioning/ansible/ubuntu-network-setup/playbooks/configure_host.yml',
-        kernel_image_settings=kernel_image_settings,
-        ramdisk_image_settings=ramdisk_image_settings)
+    pb_path = pkg_resources.resource_filename(
+        'snaps.provisioning.ansible_pb.ubuntu-network-setup.playbooks',
+        'configure_host.yml')
+    return create_image_settings(
+        image_name=name, image_user=UBUNTU_USER,
+        image_format=DEFAULT_IMAGE_FORMAT, metadata=metadata, disk_url=url,
+        default_url=UBUNTU_DEFAULT_IMAGE_URL,
+        kernel_settings=kernel_settings, ramdisk_settings=ramdisk_settings,
+        public=public, nic_config_pb_loc=pb_path)
 
 
-def get_priv_net_config(net_name, subnet_name, router_name=None, cidr='10.55.0.0/24', external_net=None):
-    return OSNetworkConfig(net_name, subnet_name, cidr, router_name, external_gateway=external_net)
+def get_priv_net_config(net_name, subnet_name, router_name=None,
+                        cidr='10.55.0.0/24', external_net=None):
+    return OSNetworkConfig(net_name, subnet_name, cidr, router_name,
+                           external_gateway=external_net)
 
 
-def get_pub_net_config(net_name, subnet_name=None, router_name=None, cidr='10.55.1.0/24', external_net=None):
-    return OSNetworkConfig(net_name, subnet_name, cidr, router_name, external_gateway=external_net)
+def get_pub_net_config(net_name, subnet_name=None, router_name=None,
+                       cidr='10.55.1.0/24', external_net=None):
+    return OSNetworkConfig(net_name, subnet_name, cidr, router_name,
+                           external_gateway=external_net)
 
 
 class OSNetworkConfig:
@@ -207,17 +329,21 @@ class OSNetworkConfig:
     Represents the settings required for the creation of a network in OpenStack
     """
 
-    def __init__(self, net_name, subnet_name=None, subnet_cidr=None, router_name=None, external_gateway=None):
+    def __init__(self, net_name, subnet_name=None, subnet_cidr=None,
+                 router_name=None, external_gateway=None):
 
         if subnet_name and subnet_cidr:
             self.network_settings = NetworkSettings(
-                name=net_name, subnet_settings=[SubnetSettings(cidr=subnet_cidr, name=subnet_name)])
+                name=net_name, subnet_settings=[
+                    SubnetSettings(cidr=subnet_cidr, name=subnet_name)])
         else:
             self.network_settings = NetworkSettings(name=net_name)
 
         if router_name:
             if subnet_name:
-                self.router_settings = RouterSettings(name=router_name, external_gateway=external_gateway,
-                                                      internal_subnets=[subnet_name])
+                self.router_settings = RouterSettings(
+                    name=router_name, external_gateway=external_gateway,
+                    internal_subnets=[subnet_name])
             else:
-                self.router_settings = RouterSettings(name=router_name, external_gateway=external_gateway)
+                self.router_settings = RouterSettings(
+                    name=router_name, external_gateway=external_gateway)