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