Added method to OpenStackHeatStack to return OpenStackKeypair objects.
[snaps.git] / snaps / test_suite_builder.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
16 import logging
17 import unittest
18
19 from snaps.domain.test.flavor_tests import FlavorDomainObjectTests
20 from snaps.domain.test.image_tests import ImageDomainObjectTests
21 from snaps.domain.test.keypair_tests import KeypairDomainObjectTests
22 from snaps.domain.test.network_tests import (
23     SecurityGroupDomainObjectTests, SecurityGroupRuleDomainObjectTests,
24     PortDomainObjectTests, RouterDomainObjectTests,
25     InterfaceRouterDomainObjectTests, NetworkObjectTests, SubnetObjectTests)
26 from snaps.domain.test.project_tests import (
27     ProjectDomainObjectTests, DomainDomainObjectTests,
28     ComputeQuotasDomainObjectTests, NetworkQuotasDomainObjectTests)
29 from snaps.domain.test.role_tests import RoleDomainObjectTests
30 from snaps.domain.test.stack_tests import (
31     StackDomainObjectTests, ResourceDomainObjectTests)
32 from snaps.domain.test.user_tests import UserDomainObjectTests
33 from snaps.domain.test.vm_inst_tests import (
34     VmInstDomainObjectTests, FloatingIpDomainObjectTests)
35 from snaps.domain.test.volume_tests import (
36     QoSSpecDomainObjectTests, VolumeTypeDomainObjectTests,
37     VolumeTypeEncryptionObjectTests, VolumeDomainObjectTests)
38 from snaps.openstack.tests.conf.os_credentials_tests import (
39     ProxySettingsUnitTests, OSCredsUnitTests)
40 from snaps.openstack.tests.create_flavor_tests import (
41     CreateFlavorTests, FlavorSettingsUnitTests)
42 from snaps.openstack.tests.create_image_tests import (
43     CreateImageSuccessTests, CreateImageNegativeTests, ImageSettingsUnitTests,
44     CreateMultiPartImageTests)
45 from snaps.openstack.tests.create_instance_tests import (
46     CreateInstanceSingleNetworkTests, CreateInstancePubPrivNetTests,
47     CreateInstanceOnComputeHost, CreateInstanceSimpleTests,
48     FloatingIpSettingsUnitTests, InstanceSecurityGroupTests,
49     VmInstanceSettingsUnitTests, CreateInstancePortManipulationTests,
50     SimpleHealthCheck, CreateInstanceFromThreePartImage,
51     CreateInstanceMockOfflineTests, CreateInstanceTwoNetTests,
52     CreateInstanceVolumeTests)
53 from snaps.openstack.tests.create_keypairs_tests import (
54     CreateKeypairsTests, KeypairSettingsUnitTests, CreateKeypairsCleanupTests)
55 from snaps.openstack.tests.create_network_tests import (
56     CreateNetworkSuccessTests, NetworkSettingsUnitTests, PortSettingsUnitTests,
57     SubnetSettingsUnitTests, CreateNetworkTypeTests)
58 from snaps.openstack.tests.create_project_tests import (
59     CreateProjectSuccessTests, ProjectSettingsUnitTests,
60     CreateProjectUserTests)
61 from snaps.openstack.tests.create_qos_tests import (
62     QoSSettingsUnitTests, CreateQoSTests)
63 from snaps.openstack.tests.create_router_tests import (
64     CreateRouterSuccessTests, CreateRouterNegativeTests,
65     RouterSettingsUnitTests)
66 from snaps.openstack.tests.create_security_group_tests import (
67     CreateSecurityGroupTests, SecurityGroupRuleSettingsUnitTests,
68     SecurityGroupSettingsUnitTests)
69 from snaps.openstack.tests.create_stack_tests import (
70     StackSettingsUnitTests, CreateStackSuccessTests, CreateStackNegativeTests,
71     CreateStackFloatingIpTests, CreateStackKeypairTests,
72     CreateStackVolumeTests)
73 from snaps.openstack.tests.create_user_tests import (
74     UserSettingsUnitTests, CreateUserSuccessTests)
75 from snaps.openstack.tests.create_volume_tests import (
76     VolumeSettingsUnitTests, CreateSimpleVolumeSuccessTests,
77     CreateVolumeWithTypeTests, CreateVolumeWithImageTests,
78     CreateSimpleVolumeFailureTests)
79 from snaps.openstack.tests.create_volume_type_tests import (
80     VolumeTypeSettingsUnitTests, CreateSimpleVolumeTypeSuccessTests,
81     CreateVolumeTypeComplexTests)
82 from snaps.openstack.tests.os_source_file_test import (
83     OSComponentTestCase, OSIntegrationTestCase)
84 from snaps.openstack.utils.tests.cinder_utils_tests import (
85     CinderSmokeTests, CinderUtilsQoSTests, CinderUtilsSimpleVolumeTypeTests,
86     CinderUtilsAddEncryptionTests, CinderUtilsVolumeTypeCompleteTests,
87     CinderUtilsVolumeTests)
88 from snaps.openstack.utils.tests.glance_utils_tests import (
89     GlanceSmokeTests, GlanceUtilsTests)
90 from snaps.openstack.utils.tests.heat_utils_tests import (
91     HeatSmokeTests, HeatUtilsCreateSimpleStackTests,
92     HeatUtilsCreateComplexStackTests, HeatUtilsVolumeTests,
93     HeatUtilsKeypairTests)
94 from snaps.openstack.utils.tests.keystone_utils_tests import (
95     KeystoneSmokeTests, KeystoneUtilsTests)
96 from snaps.openstack.utils.tests.neutron_utils_tests import (
97     NeutronSmokeTests, NeutronUtilsNetworkTests, NeutronUtilsSubnetTests,
98     NeutronUtilsRouterTests, NeutronUtilsSecurityGroupTests,
99     NeutronUtilsFloatingIpTests)
100 from snaps.openstack.utils.tests.nova_utils_tests import (
101     NovaSmokeTests, NovaUtilsKeypairTests, NovaUtilsFlavorTests,
102     NovaUtilsInstanceTests, NovaUtilsInstanceVolumeTests)
103 from snaps.openstack.utils.tests.settings_utils_tests import (
104     SettingsUtilsVolumeTests)
105 from snaps.provisioning.tests.ansible_utils_tests import (
106     AnsibleProvisioningTests)
107 from snaps.tests.file_utils_tests import FileUtilsTests
108
109 __author__ = 'spisarski'
110
111
112 def add_unit_tests(suite):
113     """
114     Adds tests that do not require external resources
115     :param suite: the unittest.TestSuite object to which to add the tests
116     :return: None as the tests will be adding to the 'suite' parameter object
117     """
118     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(FileUtilsTests))
119     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
120         SecurityGroupRuleSettingsUnitTests))
121     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
122         ProxySettingsUnitTests))
123     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
124         OSCredsUnitTests))
125     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
126         SecurityGroupSettingsUnitTests))
127     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
128         SecurityGroupDomainObjectTests))
129     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
130         SecurityGroupRuleDomainObjectTests))
131     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
132         ImageSettingsUnitTests))
133     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
134         ImageDomainObjectTests))
135     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
136         FlavorSettingsUnitTests))
137     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
138         FlavorDomainObjectTests))
139     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
140         KeypairSettingsUnitTests))
141     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
142         KeypairDomainObjectTests))
143     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
144         UserSettingsUnitTests))
145     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
146         UserDomainObjectTests))
147     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
148         ProjectSettingsUnitTests))
149     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
150         ProjectDomainObjectTests))
151     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
152         DomainDomainObjectTests))
153     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
154         ComputeQuotasDomainObjectTests))
155     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
156         NetworkQuotasDomainObjectTests))
157     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
158         RoleDomainObjectTests))
159     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
160         NetworkSettingsUnitTests))
161     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
162         NetworkObjectTests))
163     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
164         SubnetSettingsUnitTests))
165     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
166         SubnetObjectTests))
167     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
168         PortSettingsUnitTests))
169     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
170         PortDomainObjectTests))
171     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
172         RouterSettingsUnitTests))
173     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
174         RouterDomainObjectTests))
175     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
176         InterfaceRouterDomainObjectTests))
177     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
178         FloatingIpSettingsUnitTests))
179     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
180         VmInstanceSettingsUnitTests))
181     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
182         StackDomainObjectTests))
183     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
184         ResourceDomainObjectTests))
185     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
186         StackSettingsUnitTests))
187     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
188         VolumeTypeDomainObjectTests))
189     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
190         VolumeTypeEncryptionObjectTests))
191     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
192         VolumeDomainObjectTests))
193     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
194         QoSSpecDomainObjectTests))
195     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
196         VmInstDomainObjectTests))
197     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
198         FloatingIpDomainObjectTests))
199     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
200         QoSSettingsUnitTests))
201     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
202         VolumeTypeSettingsUnitTests))
203     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
204         VolumeSettingsUnitTests))
205     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
206         SettingsUtilsVolumeTests))
207
208
209 def add_openstack_client_tests(suite, os_creds, ext_net_name,
210                                use_keystone=True, log_level=logging.INFO):
211     """
212     Adds tests written to exercise OpenStack client retrieval
213     :param suite: the unittest.TestSuite object to which to add the tests
214     :param os_creds: and instance of OSCreds that holds the credentials
215                      required by OpenStack
216     :param ext_net_name: the name of an external network on the cloud under
217                          test
218     :param use_keystone: when True, tests requiring direct access to Keystone
219                          are added as these need to be running on a host that
220                          has access to the cloud's private network
221     :param log_level: the logging level
222     :return: None as the tests will be adding to the 'suite' parameter object
223     """
224     # Basic connection tests
225     suite.addTest(
226         OSComponentTestCase.parameterize(
227             GlanceSmokeTests, os_creds=os_creds, ext_net_name=ext_net_name,
228             log_level=log_level))
229
230     if use_keystone:
231         suite.addTest(
232             OSComponentTestCase.parameterize(
233                 KeystoneSmokeTests, os_creds=os_creds,
234                 ext_net_name=ext_net_name, log_level=log_level))
235
236     suite.addTest(
237         OSComponentTestCase.parameterize(
238             NeutronSmokeTests, os_creds=os_creds, ext_net_name=ext_net_name,
239             log_level=log_level))
240     suite.addTest(
241         OSComponentTestCase.parameterize(
242             NovaSmokeTests, os_creds=os_creds, ext_net_name=ext_net_name,
243             log_level=log_level))
244     suite.addTest(
245         OSComponentTestCase.parameterize(
246             HeatSmokeTests, os_creds=os_creds, ext_net_name=ext_net_name,
247             log_level=log_level))
248     suite.addTest(
249         OSComponentTestCase.parameterize(
250             CinderSmokeTests, os_creds=os_creds, ext_net_name=ext_net_name,
251             log_level=log_level))
252
253
254 def add_openstack_api_tests(suite, os_creds, ext_net_name, use_keystone=True,
255                             image_metadata=None, log_level=logging.INFO):
256     """
257     Adds tests written to exercise all existing OpenStack APIs
258     :param suite: the unittest.TestSuite object to which to add the tests
259     :param os_creds: Instance of OSCreds that holds the credentials
260                      required by OpenStack
261     :param ext_net_name: the name of an external network on the cloud under
262                          test
263     :param use_keystone: when True, tests requiring direct access to Keystone
264                          are added as these need to be running on a host that
265                          has access to the cloud's private network
266     :param image_metadata: dict() object containing metadata for creating an
267                            image with custom config
268                            (see YAML files in examples/image-metadata)
269     :param log_level: the logging level
270     :return: None as the tests will be adding to the 'suite' parameter object
271     """
272     # Tests the OpenStack API calls
273     if use_keystone:
274         suite.addTest(OSComponentTestCase.parameterize(
275             KeystoneUtilsTests, os_creds=os_creds, ext_net_name=ext_net_name,
276             log_level=log_level))
277         suite.addTest(OSComponentTestCase.parameterize(
278             CreateUserSuccessTests, os_creds=os_creds,
279             ext_net_name=ext_net_name, log_level=log_level))
280         suite.addTest(OSComponentTestCase.parameterize(
281             CreateProjectSuccessTests, os_creds=os_creds,
282             ext_net_name=ext_net_name, log_level=log_level))
283         suite.addTest(OSComponentTestCase.parameterize(
284             CreateProjectUserTests, os_creds=os_creds,
285             ext_net_name=ext_net_name, log_level=log_level))
286
287     suite.addTest(OSComponentTestCase.parameterize(
288         GlanceUtilsTests, os_creds=os_creds, ext_net_name=ext_net_name,
289         image_metadata=image_metadata,
290         log_level=log_level))
291     suite.addTest(OSComponentTestCase.parameterize(
292         NeutronUtilsNetworkTests, os_creds=os_creds, ext_net_name=ext_net_name,
293         log_level=log_level))
294     suite.addTest(OSComponentTestCase.parameterize(
295         NeutronUtilsSubnetTests, os_creds=os_creds, ext_net_name=ext_net_name,
296         log_level=log_level))
297     suite.addTest(OSComponentTestCase.parameterize(
298         NeutronUtilsRouterTests, os_creds=os_creds, ext_net_name=ext_net_name,
299         log_level=log_level))
300     suite.addTest(OSComponentTestCase.parameterize(
301         NeutronUtilsSecurityGroupTests, os_creds=os_creds,
302         ext_net_name=ext_net_name, log_level=log_level))
303     suite.addTest(OSComponentTestCase.parameterize(
304         NeutronUtilsFloatingIpTests, os_creds=os_creds,
305         ext_net_name=ext_net_name, log_level=log_level))
306     suite.addTest(OSComponentTestCase.parameterize(
307         NovaUtilsKeypairTests, os_creds=os_creds, ext_net_name=ext_net_name,
308         log_level=log_level))
309     suite.addTest(OSComponentTestCase.parameterize(
310         NovaUtilsFlavorTests, os_creds=os_creds, ext_net_name=ext_net_name,
311         log_level=log_level))
312     suite.addTest(OSComponentTestCase.parameterize(
313         NovaUtilsInstanceTests, os_creds=os_creds, ext_net_name=ext_net_name,
314         log_level=log_level, image_metadata=image_metadata))
315     suite.addTest(OSComponentTestCase.parameterize(
316         NovaUtilsInstanceVolumeTests, os_creds=os_creds,
317         ext_net_name=ext_net_name, log_level=log_level,
318         image_metadata=image_metadata))
319     suite.addTest(OSComponentTestCase.parameterize(
320         CreateFlavorTests, os_creds=os_creds, ext_net_name=ext_net_name,
321         log_level=log_level))
322     suite.addTest(OSComponentTestCase.parameterize(
323         HeatUtilsCreateSimpleStackTests, os_creds=os_creds,
324         ext_net_name=ext_net_name, log_level=log_level,
325         image_metadata=image_metadata))
326     suite.addTest(OSComponentTestCase.parameterize(
327         HeatUtilsCreateComplexStackTests, os_creds=os_creds,
328         ext_net_name=ext_net_name, log_level=log_level,
329         image_metadata=image_metadata))
330     suite.addTest(OSComponentTestCase.parameterize(
331         HeatUtilsVolumeTests, os_creds=os_creds,
332         ext_net_name=ext_net_name, log_level=log_level,
333         image_metadata=image_metadata))
334     suite.addTest(OSComponentTestCase.parameterize(
335         HeatUtilsKeypairTests, os_creds=os_creds,
336         ext_net_name=ext_net_name, log_level=log_level,
337         image_metadata=image_metadata))
338     suite.addTest(OSComponentTestCase.parameterize(
339         CinderUtilsQoSTests, os_creds=os_creds,
340         ext_net_name=ext_net_name, log_level=log_level,
341         image_metadata=image_metadata))
342     suite.addTest(OSComponentTestCase.parameterize(
343         CinderUtilsVolumeTests, os_creds=os_creds,
344         ext_net_name=ext_net_name, log_level=log_level,
345         image_metadata=image_metadata))
346     suite.addTest(OSComponentTestCase.parameterize(
347         CinderUtilsSimpleVolumeTypeTests, os_creds=os_creds,
348         ext_net_name=ext_net_name, log_level=log_level,
349         image_metadata=image_metadata))
350     suite.addTest(OSComponentTestCase.parameterize(
351         CinderUtilsAddEncryptionTests, os_creds=os_creds,
352         ext_net_name=ext_net_name, log_level=log_level,
353         image_metadata=image_metadata))
354     suite.addTest(OSComponentTestCase.parameterize(
355         CinderUtilsVolumeTypeCompleteTests, os_creds=os_creds,
356         ext_net_name=ext_net_name, log_level=log_level,
357         image_metadata=image_metadata))
358
359
360 def add_openstack_integration_tests(suite, os_creds, ext_net_name,
361                                     use_keystone=True, flavor_metadata=None,
362                                     image_metadata=None, use_floating_ips=True,
363                                     log_level=logging.INFO):
364     """
365     Adds tests written to exercise all long-running OpenStack integration tests
366     meaning they will be creating VM instances and potentially performing some
367     SSH functions through floatingIPs
368     :param suite: the unittest.TestSuite object to which to add the tests
369     :param os_creds: and instance of OSCreds that holds the credentials
370                      required by OpenStack
371     :param ext_net_name: the name of an external network on the cloud under
372                          test
373     :param use_keystone: when True, tests requiring direct access to Keystone
374                          are added as these need to be running on a host that
375                          has access to the cloud's private network
376     :param image_metadata: dict() object containing metadata for creating an
377                            image with custom config
378                            (see YAML files in examples/image-metadata)
379     :param flavor_metadata: dict() object containing the metadata required by
380                             your flavor based on your configuration:
381                             (i.e. {'hw:mem_page_size': 'large'})
382     :param use_floating_ips: when true, all tests requiring Floating IPs will
383                              be added to the suite
384     :param log_level: the logging level
385     :return: None as the tests will be adding to the 'suite' parameter object
386     """
387     # Tests the OpenStack API calls via a creator. If use_keystone, objects
388     # will be created with a custom user and project
389
390     # Creator Object tests
391     suite.addTest(OSIntegrationTestCase.parameterize(
392         CreateSecurityGroupTests, os_creds=os_creds, ext_net_name=ext_net_name,
393         use_keystone=use_keystone,
394         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
395         log_level=log_level))
396     suite.addTest(OSIntegrationTestCase.parameterize(
397         CreateImageSuccessTests, os_creds=os_creds, ext_net_name=ext_net_name,
398         use_keystone=use_keystone,
399         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
400         log_level=log_level))
401     suite.addTest(OSIntegrationTestCase.parameterize(
402         CreateImageNegativeTests, os_creds=os_creds, ext_net_name=ext_net_name,
403         use_keystone=use_keystone,
404         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
405         log_level=log_level))
406     suite.addTest(OSIntegrationTestCase.parameterize(
407         CreateMultiPartImageTests, os_creds=os_creds,
408         ext_net_name=ext_net_name, use_keystone=use_keystone,
409         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
410         log_level=log_level))
411     suite.addTest(OSIntegrationTestCase.parameterize(
412         CreateKeypairsTests, os_creds=os_creds, ext_net_name=ext_net_name,
413         use_keystone=use_keystone,
414         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
415         log_level=log_level))
416     suite.addTest(OSIntegrationTestCase.parameterize(
417         CreateKeypairsCleanupTests, os_creds=os_creds,
418         ext_net_name=ext_net_name,
419         use_keystone=use_keystone,
420         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
421         log_level=log_level))
422     suite.addTest(OSIntegrationTestCase.parameterize(
423         CreateNetworkSuccessTests, os_creds=os_creds,
424         ext_net_name=ext_net_name, use_keystone=use_keystone,
425         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
426         log_level=log_level))
427     suite.addTest(OSIntegrationTestCase.parameterize(
428         CreateRouterSuccessTests, os_creds=os_creds, ext_net_name=ext_net_name,
429         use_keystone=use_keystone,
430         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
431         log_level=log_level))
432     suite.addTest(OSIntegrationTestCase.parameterize(
433         CreateRouterNegativeTests, os_creds=os_creds,
434         ext_net_name=ext_net_name, use_keystone=use_keystone,
435         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
436         log_level=log_level))
437     suite.addTest(OSIntegrationTestCase.parameterize(
438         CreateQoSTests, os_creds=os_creds,
439         ext_net_name=ext_net_name, use_keystone=use_keystone,
440         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
441         log_level=log_level))
442     suite.addTest(OSIntegrationTestCase.parameterize(
443         CreateSimpleVolumeTypeSuccessTests, os_creds=os_creds,
444         ext_net_name=ext_net_name, use_keystone=use_keystone,
445         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
446         log_level=log_level))
447     suite.addTest(OSIntegrationTestCase.parameterize(
448         CreateVolumeTypeComplexTests, os_creds=os_creds,
449         ext_net_name=ext_net_name, use_keystone=use_keystone,
450         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
451         log_level=log_level))
452     suite.addTest(OSIntegrationTestCase.parameterize(
453         CreateSimpleVolumeSuccessTests, os_creds=os_creds,
454         ext_net_name=ext_net_name, use_keystone=use_keystone,
455         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
456         log_level=log_level))
457     suite.addTest(OSIntegrationTestCase.parameterize(
458         CreateSimpleVolumeFailureTests, os_creds=os_creds,
459         ext_net_name=ext_net_name, use_keystone=use_keystone,
460         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
461         log_level=log_level))
462     suite.addTest(OSIntegrationTestCase.parameterize(
463         CreateVolumeWithTypeTests, os_creds=os_creds,
464         ext_net_name=ext_net_name, use_keystone=use_keystone,
465         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
466         log_level=log_level))
467     suite.addTest(OSIntegrationTestCase.parameterize(
468         CreateVolumeWithImageTests, os_creds=os_creds,
469         ext_net_name=ext_net_name, use_keystone=use_keystone,
470         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
471         log_level=log_level))
472
473     # VM Instances
474     suite.addTest(OSIntegrationTestCase.parameterize(
475         SimpleHealthCheck, os_creds=os_creds, ext_net_name=ext_net_name,
476         use_keystone=use_keystone,
477         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
478         log_level=log_level))
479     suite.addTest(OSIntegrationTestCase.parameterize(
480         CreateInstanceTwoNetTests, os_creds=os_creds,
481         ext_net_name=ext_net_name, use_keystone=use_keystone,
482         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
483         log_level=log_level))
484     suite.addTest(OSIntegrationTestCase.parameterize(
485         CreateInstanceSimpleTests, os_creds=os_creds,
486         ext_net_name=ext_net_name, use_keystone=use_keystone,
487         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
488         log_level=log_level))
489     suite.addTest(OSIntegrationTestCase.parameterize(
490         CreateInstancePortManipulationTests, os_creds=os_creds,
491         ext_net_name=ext_net_name, use_keystone=use_keystone,
492         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
493         log_level=log_level))
494     suite.addTest(OSIntegrationTestCase.parameterize(
495         InstanceSecurityGroupTests, os_creds=os_creds,
496         ext_net_name=ext_net_name, use_keystone=use_keystone,
497         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
498         log_level=log_level))
499     suite.addTest(OSIntegrationTestCase.parameterize(
500         CreateInstanceOnComputeHost, os_creds=os_creds,
501         ext_net_name=ext_net_name, use_keystone=use_keystone,
502         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
503         log_level=log_level))
504     suite.addTest(OSIntegrationTestCase.parameterize(
505         CreateInstanceFromThreePartImage, os_creds=os_creds,
506         ext_net_name=ext_net_name, use_keystone=use_keystone,
507         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
508         log_level=log_level))
509     suite.addTest(OSIntegrationTestCase.parameterize(
510         CreateInstanceVolumeTests, os_creds=os_creds,
511         ext_net_name=ext_net_name, use_keystone=use_keystone,
512         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
513         log_level=log_level))
514     suite.addTest(OSIntegrationTestCase.parameterize(
515         CreateStackSuccessTests, os_creds=os_creds, ext_net_name=ext_net_name,
516         use_keystone=use_keystone,
517         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
518         log_level=log_level))
519     suite.addTest(OSIntegrationTestCase.parameterize(
520         CreateStackVolumeTests, os_creds=os_creds, ext_net_name=ext_net_name,
521         use_keystone=use_keystone,
522         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
523         log_level=log_level))
524     suite.addTest(OSIntegrationTestCase.parameterize(
525         CreateStackKeypairTests, os_creds=os_creds, ext_net_name=ext_net_name,
526         use_keystone=use_keystone,
527         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
528         log_level=log_level))
529     suite.addTest(OSIntegrationTestCase.parameterize(
530         CreateStackNegativeTests, os_creds=os_creds, ext_net_name=ext_net_name,
531         use_keystone=use_keystone,
532         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
533         log_level=log_level))
534
535     if use_floating_ips:
536         suite.addTest(OSIntegrationTestCase.parameterize(
537             CreateInstanceSingleNetworkTests, os_creds=os_creds,
538             ext_net_name=ext_net_name, use_keystone=use_keystone,
539             flavor_metadata=flavor_metadata, image_metadata=image_metadata,
540             log_level=log_level))
541         suite.addTest(OSIntegrationTestCase.parameterize(
542             CreateStackFloatingIpTests, os_creds=os_creds,
543             ext_net_name=ext_net_name, use_keystone=use_keystone,
544             flavor_metadata=flavor_metadata, image_metadata=image_metadata,
545             log_level=log_level))
546         suite.addTest(OSIntegrationTestCase.parameterize(
547             AnsibleProvisioningTests, os_creds=os_creds,
548             ext_net_name=ext_net_name, use_keystone=use_keystone,
549             flavor_metadata=flavor_metadata, image_metadata=image_metadata,
550             log_level=log_level))
551
552
553 def add_openstack_ci_tests(
554         suite, os_creds, ext_net_name, use_keystone=True, flavor_metadata=None,
555         image_metadata=None, use_floating_ips=True, log_level=logging.INFO):
556     """
557     Adds tests written for a CI server to run the tests to validate code
558     changes
559     :param suite: the unittest.TestSuite object to which to add the tests
560     :param os_creds: and instance of OSCreds that holds the credentials
561                      required by OpenStack
562     :param ext_net_name: the name of an external network on the cloud under
563                          test
564     :param use_keystone: when True, tests requiring direct access to Keystone
565                          are added as these need to be running on a host that
566                          has access to the cloud's private network
567     :param image_metadata: dict() object containing metadata for creating an
568                            image with custom config
569                            (see YAML files in examples/image-metadata)
570     :param flavor_metadata: dict() object containing the metadata required by
571                             your flavor based on your configuration:
572                             (i.e. {'hw:mem_page_size': 'large'})
573     :param use_floating_ips: when true, all tests requiring Floating IPs will
574                              be added to the suite
575     :param log_level: the logging level
576     :return: None as the tests will be adding to the 'suite' parameter object
577     """
578
579     add_unit_tests(suite)
580
581     add_openstack_client_tests(suite, os_creds, ext_net_name, use_keystone,
582                                log_level)
583
584     add_openstack_api_tests(suite, os_creds, ext_net_name, use_keystone,
585                             image_metadata, log_level)
586
587     suite.addTest(OSIntegrationTestCase.parameterize(
588         SimpleHealthCheck, os_creds=os_creds, ext_net_name=ext_net_name,
589         use_keystone=use_keystone,
590         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
591         log_level=log_level))
592
593     if use_floating_ips:
594         suite.addTest(OSIntegrationTestCase.parameterize(
595             CreateInstanceSingleNetworkTests, os_creds=os_creds,
596             ext_net_name=ext_net_name, use_keystone=use_keystone,
597             flavor_metadata=flavor_metadata, image_metadata=image_metadata,
598             log_level=log_level))
599
600     suite.addTest(OSIntegrationTestCase.parameterize(
601         CreateStackSuccessTests, os_creds=os_creds, ext_net_name=ext_net_name,
602         use_keystone=use_keystone,
603         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
604         log_level=log_level))
605     suite.addTest(OSIntegrationTestCase.parameterize(
606         CreateStackNegativeTests, os_creds=os_creds, ext_net_name=ext_net_name,
607         use_keystone=use_keystone,
608         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
609         log_level=log_level))
610
611
612 def add_openstack_staging_tests(suite, os_creds, ext_net_name,
613                                 log_level=logging.INFO):
614     """
615     Adds tests that are still in development have not been designed to run
616     successfully against all OpenStack pods
617     :param suite: the unittest.TestSuite object to which to add the tests
618     :param os_creds: Instance of OSCreds that holds the credentials
619                     required by OpenStack
620     :param ext_net_name: the name of an external network on the cloud under
621                          test
622     :param log_level: the logging level
623     :return: None as the tests will be adding to the 'suite' parameter object
624     """
625     suite.addTest(OSComponentTestCase.parameterize(
626         CreateNetworkTypeTests, os_creds=os_creds, ext_net_name=ext_net_name,
627         log_level=log_level))
628     suite.addTest(OSComponentTestCase.parameterize(
629         CreateInstanceMockOfflineTests, os_creds=os_creds,
630         ext_net_name=ext_net_name, log_level=log_level))
631     suite.addTest(OSIntegrationTestCase.parameterize(
632             CreateInstancePubPrivNetTests, os_creds=os_creds,
633             ext_net_name=ext_net_name, log_level=log_level))