snaps/openstack/tests/os_source_file_test.py

   1 # Copyright (c) 2016 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 pkg_resources
  17 import uuid
  18 import unittest
  19
  20 from snaps import file_utils
  21 from snaps.config.project import ProjectConfig
  22 from snaps.config.user import UserConfig
  23 from snaps.openstack.tests import openstack_tests
  24 from snaps.openstack.utils import deploy_utils, keystone_utils
  25
  26
  27 dev_os_env_file = pkg_resources.resource_filename(
  28     'snaps.openstack.tests.conf', 'os_env.yaml')
  29
  30
  31 class OSComponentTestCase(unittest.TestCase):
  32
  33     def __init__(self, method_name='runTest', os_creds=None, ext_net_name=None,
  34                  image_metadata=None, log_level=logging.DEBUG):
  35         """
  36         Super for test classes requiring a connection to OpenStack
  37         :param method_name: default 'runTest'
  38         :param os_creds: the OSCreds object, when null it searches for the file
  39                          in the package snaps.openstack.tests.conf.os_env.yaml
  40         :param ext_net_name: the name of the external network that is used for
  41                              creating routers for floating IPs
  42         :param image_metadata: ability to override images being used in the
  43                                tests (see examples/image-metadata)
  44         :param log_level: the logging level of your test run (default DEBUG)
  45         """
  46         super(OSComponentTestCase, self).__init__(method_name)
  47
  48         logging.basicConfig(level=log_level)
  49
  50         if os_creds:
  51             self.os_creds = os_creds
  52         else:
  53             self.os_creds = openstack_tests.get_credentials(
  54                 dev_os_env_file=dev_os_env_file)
  55
  56         self.os_session = keystone_utils.keystone_session(self.os_creds)
  57         self.ext_net_name = ext_net_name
  58
  59         if not self.ext_net_name and file_utils.file_exists(dev_os_env_file):
  60             test_conf = file_utils.read_yaml(dev_os_env_file)
  61             self.ext_net_name = test_conf.get('ext_net')
  62
  63         self.image_metadata = image_metadata
  64
  65     @staticmethod
  66     def parameterize(testcase_klass, os_creds, ext_net_name,
  67                      image_metadata=None, log_level=logging.DEBUG):
  68         """ Create a suite containing all tests taken from the given
  69             subclass, passing them the parameter 'param'.
  70         """
  71         test_loader = unittest.TestLoader()
  72         test_names = test_loader.getTestCaseNames(testcase_klass)
  73         suite = unittest.TestSuite()
  74         for name in test_names:
  75             suite.addTest(testcase_klass(name, os_creds, ext_net_name,
  76                                          image_metadata, log_level))
  77         return suite
  78
  79
  80     def __clean__(self):
  81         """
  82         Cleans up keystone session.
  83         """
  84         if self.os_session:
  85             keystone_utils.close_session(self.os_session)
  86
  87
  88 class OSIntegrationTestCase(OSComponentTestCase):
  89
  90     def __init__(self, method_name='runTest', os_creds=None, ext_net_name=None,
  91                  use_keystone=True, flavor_metadata=None, image_metadata=None,
  92                  netconf_override=None, log_level=logging.DEBUG):
  93         """
  94         Super for integration tests requiring a connection to OpenStack
  95         :param method_name: default 'runTest'
  96         :param os_creds: the OSCreds object, when null it searches for the file
  97                          in the package snaps.openstack.tests.conf.os_env.yaml
  98         :param ext_net_name: the name of the external network that is used for
  99                              creating routers for floating IPs
 100         :param use_keystone: when true, these tests will create a new
 101                              user/project under which to run the test
 102         :param image_metadata: dict() containing the URLs for the disk, kernel,
 103                                and ramdisk images when multi-part images are
 104                                required. See below for a simple example
 105         image_metadata={'disk_url': '{URI}/cirros-0.3.4-x86_64-disk.img',
 106                         'kernel_url': '{URI}/cirros-0.3.4-x86_64-kernel',
 107                         'ramdisk_url': '{URI}/cirros-0.3.4-x86_64-initramfs'})
 108         :param flavor_metadata: dict() to be sent directly into the Nova client
 109                                 generally used for page sizes
 110         :param netconf_override: dict() containing the configured network_type,
 111                                physical_network and segmentation_id
 112         :param log_level: the logging level of your test run (default DEBUG)
 113         """
 114         super(OSIntegrationTestCase, self).__init__(
 115             method_name=method_name, os_creds=os_creds,
 116             ext_net_name=ext_net_name, image_metadata=image_metadata,
 117             log_level=log_level)
 118         self.netconf_override = netconf_override
 119         self.use_keystone = use_keystone
 120         self.keystone = None
 121         self.flavor_metadata = flavor_metadata
 122         self.user_roles = None
 123
 124     @staticmethod
 125     def parameterize(testcase_klass, os_creds, ext_net_name,
 126                      use_keystone=False, flavor_metadata=None,
 127                      image_metadata=None, netconf_override=None,
 128                      log_level=logging.DEBUG):
 129         """
 130         Create a suite containing all tests taken from the given
 131         subclass, passing them the parameter 'param'.
 132         """
 133         test_loader = unittest.TestLoader()
 134         test_names = test_loader.getTestCaseNames(testcase_klass)
 135         suite = unittest.TestSuite()
 136         for name in test_names:
 137             suite.addTest(testcase_klass(name, os_creds, ext_net_name,
 138                                          use_keystone, flavor_metadata,
 139                                          image_metadata, netconf_override,
 140                                          log_level))
 141         return suite
 142
 143     """
 144     Super for test classes that should be run within their own project/tenant
 145     as they can run for quite some time
 146     """
 147     def __start__(self):
 148         """
 149         Creates a project and user to be leveraged by subclass test methods. If
 150         implementing class uses this method, it must call __clean__() else you
 151         will be left with unwanted users and tenants
 152         """
 153         self.project_creator = None
 154         self.user_creator = None
 155         self.admin_os_creds = self.os_creds
 156         self.admin_os_session = self.os_session
 157         keystone_utils.keystone_session(
 158             self.admin_os_creds)
 159
 160         if self.use_keystone:
 161             self.keystone = keystone_utils.keystone_client(
 162                 self.admin_os_creds, self.admin_os_session)
 163             guid = self.__class__.__name__ + '-' + str(uuid.uuid4())[:-19]
 164             project_name = guid + '-proj'
 165             self.project_creator = deploy_utils.create_project(
 166                 self.admin_os_creds, ProjectConfig(
 167                     name=project_name,
 168                     domain=self.admin_os_creds.project_domain_name))
 169
 170             # Set by implementing class for setting the user's roles
 171             roles = dict()
 172             if self.user_roles:
 173                 for user_role in self.user_roles:
 174                     roles[user_role] = project_name
 175
 176             self.user_creator = deploy_utils.create_user(
 177                 self.admin_os_creds, UserConfig(
 178                     name=guid + '-user', password=guid,
 179                     project_name=project_name, roles=roles,
 180                     domain_name=self.admin_os_creds.user_domain_name))
 181
 182             self.os_creds = self.user_creator.get_os_creds(
 183                 self.project_creator.project_settings.name)
 184             self.os_session = keystone_utils.keystone_session(self.os_creds)
 185
 186             # add user to project
 187             self.project_creator.assoc_user(self.user_creator.get_user())
 188
 189     def __clean__(self):
 190         """
 191         Cleans up test user and project.
 192         Must be called at the end of child classes tearDown() if __start__() is
 193         called during setUp() else these objects will persist after the test is
 194         run
 195         """
 196         if self.project_creator:
 197             self.project_creator.clean()
 198
 199         if self.user_creator:
 200             self.user_creator.clean()
 201
 202         if self.admin_os_session:
 203             keystone_utils.close_session(self.admin_os_session)
 204
 205         super(OSIntegrationTestCase, self).__clean__()
 206