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