Local Documentation Builds
[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.config.tests.cluster_template_tests import (
20     ClusterTemplateConfigUnitTests)
21 from snaps.config.tests.network_tests import (
22     NetworkConfigUnitTests, SubnetConfigUnitTests, PortConfigUnitTests)
23 from snaps.config.tests.security_group_tests import (
24     SecurityGroupConfigUnitTests, SecurityGroupRuleConfigUnitTests)
25 from snaps.config.tests.vm_inst_tests import (
26     VmInstanceConfigUnitTests, FloatingIpConfigUnitTests)
27 from snaps.config.tests.volume_tests import VolumeConfigUnitTests
28 from snaps.config.tests.volume_type_tests import VolumeTypeConfigUnitTests
29 from snaps.config.tests.qos_tests import QoSConfigUnitTests
30 from snaps.config.tests.stack_tests import StackConfigUnitTests
31 from snaps.config.tests.router_tests import RouterConfigUnitTests
32 from snaps.config.tests.user_tests import UserConfigUnitTests
33 from snaps.config.tests.project_tests import ProjectConfigUnitTests
34 from snaps.config.tests.keypair_tests import KeypairConfigUnitTests
35 from snaps.config.tests.flavor_tests import FlavorConfigUnitTests
36 import snaps.config.tests.image_tests as image_tests
37 import snaps.openstack.tests.create_image_tests as creator_tests
38 from snaps.domain.test.cluster_template_tests import ClusterTemplateUnitTests
39 from snaps.domain.test.flavor_tests import FlavorDomainObjectTests
40 from snaps.domain.test.image_tests import ImageDomainObjectTests
41 from snaps.domain.test.keypair_tests import KeypairDomainObjectTests
42 from snaps.domain.test.network_tests import (
43     SecurityGroupDomainObjectTests, SecurityGroupRuleDomainObjectTests,
44     PortDomainObjectTests, RouterDomainObjectTests,
45     InterfaceRouterDomainObjectTests, NetworkObjectTests, SubnetObjectTests)
46 from snaps.domain.test.project_tests import (
47     ProjectDomainObjectTests, DomainDomainObjectTests,
48     ComputeQuotasDomainObjectTests, NetworkQuotasDomainObjectTests)
49 from snaps.domain.test.role_tests import RoleDomainObjectTests
50 from snaps.domain.test.stack_tests import (
51     StackDomainObjectTests, ResourceDomainObjectTests)
52 from snaps.domain.test.user_tests import UserDomainObjectTests
53 from snaps.domain.test.vm_inst_tests import (
54     VmInstDomainObjectTests, FloatingIpDomainObjectTests)
55 from snaps.domain.test.volume_tests import (
56     QoSSpecDomainObjectTests, VolumeTypeDomainObjectTests,
57     VolumeTypeEncryptionObjectTests, VolumeDomainObjectTests)
58 from snaps.openstack.tests.cluster_template_tests import (
59     CreateClusterTemplateTests)
60 from snaps.openstack.tests.conf.os_credentials_tests import (
61     ProxySettingsUnitTests, OSCredsUnitTests)
62 from snaps.openstack.tests.create_flavor_tests import (
63     CreateFlavorTests, FlavorSettingsUnitTests)
64 from snaps.openstack.tests.create_image_tests import (
65     CreateImageSuccessTests, CreateImageNegativeTests,
66     CreateMultiPartImageTests)
67 from snaps.openstack.tests.create_instance_tests import (
68     CreateInstanceSingleNetworkTests, CreateInstanceOnComputeHost,
69     CreateInstanceSimpleTests, FloatingIpSettingsUnitTests,
70     InstanceSecurityGroupTests, VmInstanceSettingsUnitTests,
71     CreateInstancePortManipulationTests, SimpleHealthCheck,
72     CreateInstanceFromThreePartImage, CreateInstanceMockOfflineTests,
73     CreateInstanceTwoNetTests, CreateInstanceVolumeTests,
74     CreateInstanceIPv6NetworkTests, CreateInstanceExternalNetTests)
75 from snaps.openstack.tests.create_keypairs_tests import (
76     CreateKeypairsTests, KeypairSettingsUnitTests, CreateKeypairsCleanupTests)
77 from snaps.openstack.tests.create_network_tests import (
78     CreateNetworkSuccessTests, NetworkSettingsUnitTests, PortSettingsUnitTests,
79     SubnetSettingsUnitTests, CreateNetworkTypeTests, CreateNetworkIPv6Tests,
80     CreateMultipleNetworkTests, CreateNetworkGatewayTests)
81 from snaps.openstack.tests.create_project_tests import (
82     CreateProjectSuccessTests, ProjectSettingsUnitTests,
83     CreateProjectUserTests)
84 from snaps.openstack.tests.create_qos_tests import (
85     QoSSettingsUnitTests, CreateQoSTests)
86 from snaps.openstack.tests.create_router_tests import (
87     CreateRouterSuccessTests, CreateRouterNegativeTests,
88     RouterSettingsUnitTests, CreateMultipleRouterTests,
89     CreateRouterSecurityGroupTests, CreateRouterSharedNetworksTests)
90 from snaps.openstack.tests.create_security_group_tests import (
91     CreateSecurityGroupTests, SecurityGroupRuleSettingsUnitTests,
92     SecurityGroupSettingsUnitTests, CreateMultipleSecurityGroupTests)
93 from snaps.openstack.tests.create_stack_tests import (
94     StackSettingsUnitTests, CreateStackSuccessTests, CreateStackNegativeTests,
95     CreateStackFlavorTests, CreateStackFloatingIpTests,
96     CreateStackNestedResourceTests, CreateStackKeypairTests,
97     CreateStackVolumeTests, CreateStackSecurityGroupTests,
98     CreateStackUpdateTests)
99 from snaps.openstack.tests.create_user_tests import (
100     UserSettingsUnitTests, CreateUserSuccessTests)
101 from snaps.openstack.tests.create_volume_tests import (
102     VolumeSettingsUnitTests, CreateSimpleVolumeSuccessTests,
103     CreateVolumeWithTypeTests, CreateVolumeWithImageTests,
104     CreateSimpleVolumeFailureTests, CreateVolMultipleCredsTests)
105 from snaps.openstack.tests.create_volume_type_tests import (
106     VolumeTypeSettingsUnitTests, CreateSimpleVolumeTypeSuccessTests,
107     CreateVolumeTypeComplexTests)
108 from snaps.openstack.tests.os_source_file_test import (
109     OSComponentTestCase, OSIntegrationTestCase)
110 from snaps.openstack.utils.tests.cinder_utils_tests import (
111     CinderSmokeTests, CinderUtilsQoSTests, CinderUtilsSimpleVolumeTypeTests,
112     CinderUtilsAddEncryptionTests, CinderUtilsVolumeTypeCompleteTests,
113     CinderUtilsVolumeTests)
114 from snaps.openstack.utils.tests.glance_utils_tests import (
115     GlanceSmokeTests, GlanceUtilsTests)
116 from snaps.openstack.utils.tests.heat_utils_tests import (
117     HeatSmokeTests, HeatUtilsCreateSimpleStackTests,
118     HeatUtilsCreateComplexStackTests, HeatUtilsFlavorTests,
119     HeatUtilsKeypairTests, HeatUtilsVolumeTests, HeatUtilsSecurityGroupTests)
120 from snaps.openstack.utils.tests.keystone_utils_tests import (
121     KeystoneSmokeTests, KeystoneUtilsTests)
122 from snaps.openstack.utils.tests.neutron_utils_tests import (
123     NeutronSmokeTests, NeutronUtilsNetworkTests, NeutronUtilsSubnetTests,
124     NeutronUtilsRouterTests, NeutronUtilsSecurityGroupTests,
125     NeutronUtilsFloatingIpTests, NeutronUtilsIPv6Tests)
126 from snaps.openstack.utils.tests.nova_utils_tests import (
127     NovaSmokeTests, NovaUtilsKeypairTests, NovaUtilsFlavorTests,
128     NovaUtilsInstanceTests, NovaUtilsInstanceVolumeTests)
129 from snaps.openstack.utils.tests.settings_utils_tests import (
130     SettingsUtilsUnitTests)
131 from snaps.openstack.utils.tests.magnum_utils_tests import (
132     MagnumSmokeTests, MagnumUtilsClusterTypeTests)
133 from snaps.provisioning.tests.ansible_utils_tests import (
134     AnsibleProvisioningTests)
135 from snaps.tests.file_utils_tests import FileUtilsTests
136
137 __author__ = 'spisarski'
138
139
140 def add_unit_tests(suite):
141     """
142     Adds tests that do not require external resources
143     :param suite: the unittest.TestSuite object to which to add the tests
144     :return: None as the tests will be adding to the 'suite' parameter object
145     """
146     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(FileUtilsTests))
147     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
148         ProxySettingsUnitTests))
149     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
150         OSCredsUnitTests))
151     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
152         SecurityGroupConfigUnitTests))
153     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
154         SecurityGroupSettingsUnitTests))
155     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
156         SecurityGroupRuleConfigUnitTests))
157     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
158         SecurityGroupRuleSettingsUnitTests))
159     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
160         SecurityGroupDomainObjectTests))
161     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
162         SecurityGroupRuleDomainObjectTests))
163     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
164         image_tests.ImageConfigUnitTests))
165     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
166         creator_tests.ImageSettingsUnitTests))
167     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
168         ImageDomainObjectTests))
169     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
170         FlavorConfigUnitTests))
171     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
172         FlavorSettingsUnitTests))
173     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
174         FlavorDomainObjectTests))
175     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
176         KeypairConfigUnitTests))
177     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
178         KeypairSettingsUnitTests))
179     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
180         KeypairDomainObjectTests))
181     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
182         UserConfigUnitTests))
183     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
184         UserSettingsUnitTests))
185     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
186         UserDomainObjectTests))
187     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
188         ProjectConfigUnitTests))
189     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
190         ProjectSettingsUnitTests))
191     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
192         ProjectDomainObjectTests))
193     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
194         DomainDomainObjectTests))
195     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
196         ComputeQuotasDomainObjectTests))
197     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
198         NetworkQuotasDomainObjectTests))
199     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
200         RoleDomainObjectTests))
201     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
202         NetworkConfigUnitTests))
203     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
204         NetworkSettingsUnitTests))
205     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
206         NetworkObjectTests))
207     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
208         SubnetConfigUnitTests))
209     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
210         SubnetSettingsUnitTests))
211     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
212         SubnetObjectTests))
213     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
214         PortConfigUnitTests))
215     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
216         PortSettingsUnitTests))
217     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
218         PortDomainObjectTests))
219     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
220         RouterConfigUnitTests))
221     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
222         RouterSettingsUnitTests))
223     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
224         RouterDomainObjectTests))
225     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
226         InterfaceRouterDomainObjectTests))
227     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
228         FloatingIpConfigUnitTests))
229     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
230         FloatingIpSettingsUnitTests))
231     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
232         VmInstanceConfigUnitTests))
233     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
234         VmInstanceSettingsUnitTests))
235     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
236         StackDomainObjectTests))
237     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
238         ResourceDomainObjectTests))
239     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
240         StackConfigUnitTests))
241     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
242         StackSettingsUnitTests))
243     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
244         VolumeTypeDomainObjectTests))
245     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
246         VolumeTypeEncryptionObjectTests))
247     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
248         VolumeDomainObjectTests))
249     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
250         QoSSpecDomainObjectTests))
251     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
252         VmInstDomainObjectTests))
253     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
254         FloatingIpDomainObjectTests))
255     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
256         QoSConfigUnitTests))
257     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
258         QoSSettingsUnitTests))
259     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
260         VolumeTypeConfigUnitTests))
261     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
262         VolumeTypeSettingsUnitTests))
263     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
264         VolumeConfigUnitTests))
265     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
266         VolumeSettingsUnitTests))
267     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
268         ClusterTemplateConfigUnitTests))
269     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
270         ClusterTemplateUnitTests))
271     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
272         SettingsUtilsUnitTests))
273
274
275 def add_openstack_client_tests(suite, os_creds, ext_net_name,
276                                use_keystone=True, log_level=logging.INFO):
277     """
278     Adds tests written to exercise OpenStack client retrieval
279     :param suite: the unittest.TestSuite object to which to add the tests
280     :param os_creds: and instance of OSCreds that holds the credentials
281                      required by OpenStack
282     :param ext_net_name: the name of an external network on the cloud under
283                          test
284     :param use_keystone: when True, tests requiring direct access to Keystone
285                          are added as these need to be running on a host that
286                          has access to the cloud's private network
287     :param log_level: the logging level
288     :return: None as the tests will be adding to the 'suite' parameter object
289     """
290     # Basic connection tests
291     suite.addTest(
292         OSComponentTestCase.parameterize(
293             GlanceSmokeTests, os_creds=os_creds, ext_net_name=ext_net_name,
294             log_level=log_level))
295
296     if use_keystone:
297         suite.addTest(
298             OSComponentTestCase.parameterize(
299                 KeystoneSmokeTests, os_creds=os_creds,
300                 ext_net_name=ext_net_name, log_level=log_level))
301
302     suite.addTest(
303         OSComponentTestCase.parameterize(
304             NeutronSmokeTests, os_creds=os_creds, ext_net_name=ext_net_name,
305             log_level=log_level))
306     suite.addTest(
307         OSComponentTestCase.parameterize(
308             NovaSmokeTests, os_creds=os_creds, ext_net_name=ext_net_name,
309             log_level=log_level))
310     suite.addTest(
311         OSComponentTestCase.parameterize(
312             HeatSmokeTests, os_creds=os_creds, ext_net_name=ext_net_name,
313             log_level=log_level))
314     suite.addTest(
315         OSComponentTestCase.parameterize(
316             CinderSmokeTests, os_creds=os_creds, ext_net_name=ext_net_name,
317             log_level=log_level))
318
319
320 def add_openstack_api_tests(suite, os_creds, ext_net_name, use_keystone=True,
321                             flavor_metadata=None, image_metadata=None,
322                             log_level=logging.INFO):
323     """
324     Adds tests written to exercise all existing OpenStack APIs
325     :param suite: the unittest.TestSuite object to which to add the tests
326     :param os_creds: Instance of OSCreds that holds the credentials
327                      required by OpenStack
328     :param ext_net_name: the name of an external network on the cloud under
329                          test
330     :param use_keystone: when True, tests requiring direct access to Keystone
331                          are added as these need to be running on a host that
332                          has access to the cloud's private network
333     :param flavor_metadata: dict() object containing the metadata required by
334                             your flavor based on your configuration:
335                             (i.e. {'hw:mem_page_size': 'any'})
336     :param image_metadata: dict() object containing metadata for creating an
337                            image with custom config
338                            (see YAML files in examples/image-metadata)
339     :param log_level: the logging level
340     :return: None as the tests will be adding to the 'suite' parameter object
341     """
342     # Tests the OpenStack API calls
343     if use_keystone:
344         suite.addTest(OSComponentTestCase.parameterize(
345             KeystoneUtilsTests, os_creds=os_creds, ext_net_name=ext_net_name,
346             log_level=log_level))
347         suite.addTest(OSComponentTestCase.parameterize(
348             CreateUserSuccessTests, os_creds=os_creds,
349             ext_net_name=ext_net_name, log_level=log_level))
350         suite.addTest(OSComponentTestCase.parameterize(
351             CreateProjectSuccessTests, os_creds=os_creds,
352             ext_net_name=ext_net_name, log_level=log_level))
353         suite.addTest(OSComponentTestCase.parameterize(
354             CreateProjectUserTests, os_creds=os_creds,
355             ext_net_name=ext_net_name, log_level=log_level))
356
357     suite.addTest(OSComponentTestCase.parameterize(
358         GlanceUtilsTests, os_creds=os_creds, ext_net_name=ext_net_name,
359         image_metadata=image_metadata,
360         log_level=log_level))
361     suite.addTest(OSComponentTestCase.parameterize(
362         NeutronUtilsNetworkTests, os_creds=os_creds, ext_net_name=ext_net_name,
363         log_level=log_level))
364     suite.addTest(OSComponentTestCase.parameterize(
365         NeutronUtilsSubnetTests, os_creds=os_creds, ext_net_name=ext_net_name,
366         log_level=log_level))
367     suite.addTest(OSComponentTestCase.parameterize(
368         NeutronUtilsIPv6Tests, os_creds=os_creds, ext_net_name=ext_net_name,
369         log_level=log_level))
370     suite.addTest(OSComponentTestCase.parameterize(
371         NeutronUtilsRouterTests, os_creds=os_creds, ext_net_name=ext_net_name,
372         log_level=log_level))
373     suite.addTest(OSComponentTestCase.parameterize(
374         NeutronUtilsSecurityGroupTests, os_creds=os_creds,
375         ext_net_name=ext_net_name, log_level=log_level))
376     suite.addTest(OSComponentTestCase.parameterize(
377         NeutronUtilsFloatingIpTests, os_creds=os_creds,
378         ext_net_name=ext_net_name, log_level=log_level))
379     suite.addTest(OSComponentTestCase.parameterize(
380         NovaUtilsKeypairTests, os_creds=os_creds, ext_net_name=ext_net_name,
381         log_level=log_level))
382     suite.addTest(OSComponentTestCase.parameterize(
383         NovaUtilsFlavorTests, os_creds=os_creds, ext_net_name=ext_net_name,
384         log_level=log_level))
385     suite.addTest(OSComponentTestCase.parameterize(
386         NovaUtilsInstanceTests, os_creds=os_creds, ext_net_name=ext_net_name,
387         log_level=log_level, image_metadata=image_metadata))
388     suite.addTest(OSComponentTestCase.parameterize(
389         NovaUtilsInstanceVolumeTests, os_creds=os_creds,
390         ext_net_name=ext_net_name, log_level=log_level,
391         flavor_metadata=flavor_metadata, image_metadata=image_metadata))
392     suite.addTest(OSComponentTestCase.parameterize(
393         CreateFlavorTests, os_creds=os_creds, ext_net_name=ext_net_name,
394         log_level=log_level))
395     suite.addTest(OSComponentTestCase.parameterize(
396         HeatUtilsCreateSimpleStackTests, os_creds=os_creds,
397         ext_net_name=ext_net_name, log_level=log_level,
398         image_metadata=image_metadata))
399     suite.addTest(OSComponentTestCase.parameterize(
400         HeatUtilsCreateComplexStackTests, os_creds=os_creds,
401         ext_net_name=ext_net_name, log_level=log_level,
402         image_metadata=image_metadata))
403     suite.addTest(OSComponentTestCase.parameterize(
404         HeatUtilsFlavorTests, os_creds=os_creds,
405         ext_net_name=ext_net_name, log_level=log_level,
406         image_metadata=image_metadata))
407     suite.addTest(OSComponentTestCase.parameterize(
408         HeatUtilsKeypairTests, os_creds=os_creds,
409         ext_net_name=ext_net_name, log_level=log_level,
410         image_metadata=image_metadata))
411     suite.addTest(OSComponentTestCase.parameterize(
412         HeatUtilsSecurityGroupTests, os_creds=os_creds,
413         ext_net_name=ext_net_name, log_level=log_level,
414         image_metadata=image_metadata))
415     suite.addTest(OSComponentTestCase.parameterize(
416         HeatUtilsVolumeTests, os_creds=os_creds,
417         ext_net_name=ext_net_name, log_level=log_level,
418         image_metadata=image_metadata))
419     suite.addTest(OSComponentTestCase.parameterize(
420         CinderUtilsQoSTests, os_creds=os_creds,
421         ext_net_name=ext_net_name, log_level=log_level,
422         image_metadata=image_metadata))
423     suite.addTest(OSComponentTestCase.parameterize(
424         CinderUtilsVolumeTests, os_creds=os_creds,
425         ext_net_name=ext_net_name, log_level=log_level,
426         image_metadata=image_metadata))
427     suite.addTest(OSComponentTestCase.parameterize(
428         CinderUtilsSimpleVolumeTypeTests, os_creds=os_creds,
429         ext_net_name=ext_net_name, log_level=log_level,
430         image_metadata=image_metadata))
431     suite.addTest(OSComponentTestCase.parameterize(
432         CinderUtilsAddEncryptionTests, os_creds=os_creds,
433         ext_net_name=ext_net_name, log_level=log_level,
434         image_metadata=image_metadata))
435     suite.addTest(OSComponentTestCase.parameterize(
436         CinderUtilsVolumeTypeCompleteTests, os_creds=os_creds,
437         ext_net_name=ext_net_name, log_level=log_level,
438         image_metadata=image_metadata))
439
440
441 def add_openstack_integration_tests(suite, os_creds, ext_net_name,
442                                     use_keystone=True, flavor_metadata=None,
443                                     image_metadata=None, use_floating_ips=True,
444                                     log_level=logging.INFO):
445     """
446     Adds tests written to exercise all long-running OpenStack integration tests
447     meaning they will be creating VM instances and potentially performing some
448     SSH functions through floatingIPs
449     :param suite: the unittest.TestSuite object to which to add the tests
450     :param os_creds: and instance of OSCreds that holds the credentials
451                      required by OpenStack
452     :param ext_net_name: the name of an external network on the cloud under
453                          test
454     :param use_keystone: when True, tests requiring direct access to Keystone
455                          are added as these need to be running on a host that
456                          has access to the cloud's private network
457     :param image_metadata: dict() object containing metadata for creating an
458                            image with custom config
459                            (see YAML files in examples/image-metadata)
460     :param flavor_metadata: dict() object containing the metadata required by
461                             your flavor based on your configuration:
462                             (i.e. {'hw:mem_page_size': 'large'})
463     :param use_floating_ips: when true, all tests requiring Floating IPs will
464                              be added to the suite
465     :param log_level: the logging level
466     :return: None as the tests will be adding to the 'suite' parameter object
467     """
468     # Tests the OpenStack API calls via a creator. If use_keystone, objects
469     # will be created with a custom user and project
470
471     # Creator Object tests
472     suite.addTest(OSIntegrationTestCase.parameterize(
473         CreateSecurityGroupTests, os_creds=os_creds, ext_net_name=ext_net_name,
474         use_keystone=use_keystone,
475         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
476         log_level=log_level))
477     suite.addTest(OSIntegrationTestCase.parameterize(
478         CreateMultipleSecurityGroupTests, os_creds=os_creds,
479         ext_net_name=ext_net_name, use_keystone=use_keystone,
480         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
481         log_level=log_level))
482     suite.addTest(OSIntegrationTestCase.parameterize(
483         CreateImageSuccessTests, os_creds=os_creds, ext_net_name=ext_net_name,
484         use_keystone=use_keystone,
485         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
486         log_level=log_level))
487     suite.addTest(OSIntegrationTestCase.parameterize(
488         CreateImageNegativeTests, os_creds=os_creds, ext_net_name=ext_net_name,
489         use_keystone=use_keystone,
490         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
491         log_level=log_level))
492     suite.addTest(OSIntegrationTestCase.parameterize(
493         CreateMultiPartImageTests, os_creds=os_creds,
494         ext_net_name=ext_net_name, use_keystone=use_keystone,
495         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
496         log_level=log_level))
497     suite.addTest(OSIntegrationTestCase.parameterize(
498         CreateKeypairsTests, os_creds=os_creds, ext_net_name=ext_net_name,
499         use_keystone=use_keystone,
500         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
501         log_level=log_level))
502     suite.addTest(OSIntegrationTestCase.parameterize(
503         CreateKeypairsCleanupTests, os_creds=os_creds,
504         ext_net_name=ext_net_name,
505         use_keystone=use_keystone,
506         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
507         log_level=log_level))
508     suite.addTest(OSIntegrationTestCase.parameterize(
509         CreateNetworkSuccessTests, os_creds=os_creds,
510         ext_net_name=ext_net_name, use_keystone=use_keystone,
511         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
512         log_level=log_level))
513     suite.addTest(OSIntegrationTestCase.parameterize(
514         CreateNetworkGatewayTests, os_creds=os_creds,
515         ext_net_name=ext_net_name, use_keystone=use_keystone,
516         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
517         log_level=log_level))
518     suite.addTest(OSIntegrationTestCase.parameterize(
519         CreateNetworkIPv6Tests, os_creds=os_creds,
520         ext_net_name=ext_net_name, use_keystone=use_keystone,
521         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
522         log_level=log_level))
523     suite.addTest(OSIntegrationTestCase.parameterize(
524         CreateMultipleNetworkTests, os_creds=os_creds,
525         ext_net_name=ext_net_name, use_keystone=use_keystone,
526         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
527         log_level=log_level))
528     suite.addTest(OSIntegrationTestCase.parameterize(
529         CreateRouterSuccessTests, os_creds=os_creds, ext_net_name=ext_net_name,
530         use_keystone=use_keystone,
531         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
532         log_level=log_level))
533     suite.addTest(OSIntegrationTestCase.parameterize(
534         CreateRouterNegativeTests, os_creds=os_creds,
535         ext_net_name=ext_net_name, use_keystone=use_keystone,
536         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
537         log_level=log_level))
538     suite.addTest(OSIntegrationTestCase.parameterize(
539         CreateMultipleRouterTests, os_creds=os_creds,
540         ext_net_name=ext_net_name, use_keystone=use_keystone,
541         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
542         log_level=log_level))
543     suite.addTest(OSIntegrationTestCase.parameterize(
544         CreateRouterSecurityGroupTests, os_creds=os_creds,
545         ext_net_name=ext_net_name, use_keystone=use_keystone,
546         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
547         log_level=log_level))
548     suite.addTest(OSIntegrationTestCase.parameterize(
549         CreateRouterSharedNetworksTests, os_creds=os_creds,
550         ext_net_name=ext_net_name, use_keystone=use_keystone,
551         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
552         log_level=log_level))
553     suite.addTest(OSIntegrationTestCase.parameterize(
554         CreateQoSTests, os_creds=os_creds,
555         ext_net_name=ext_net_name, use_keystone=use_keystone,
556         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
557         log_level=log_level))
558     suite.addTest(OSIntegrationTestCase.parameterize(
559         CreateSimpleVolumeTypeSuccessTests, os_creds=os_creds,
560         ext_net_name=ext_net_name, use_keystone=use_keystone,
561         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
562         log_level=log_level))
563     suite.addTest(OSIntegrationTestCase.parameterize(
564         CreateVolumeTypeComplexTests, os_creds=os_creds,
565         ext_net_name=ext_net_name, use_keystone=use_keystone,
566         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
567         log_level=log_level))
568     suite.addTest(OSIntegrationTestCase.parameterize(
569         CreateSimpleVolumeSuccessTests, os_creds=os_creds,
570         ext_net_name=ext_net_name, use_keystone=use_keystone,
571         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
572         log_level=log_level))
573     suite.addTest(OSIntegrationTestCase.parameterize(
574         CreateSimpleVolumeFailureTests, os_creds=os_creds,
575         ext_net_name=ext_net_name, use_keystone=use_keystone,
576         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
577         log_level=log_level))
578     suite.addTest(OSIntegrationTestCase.parameterize(
579         CreateVolumeWithTypeTests, os_creds=os_creds,
580         ext_net_name=ext_net_name, use_keystone=use_keystone,
581         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
582         log_level=log_level))
583     suite.addTest(OSIntegrationTestCase.parameterize(
584         CreateVolumeWithImageTests, os_creds=os_creds,
585         ext_net_name=ext_net_name, use_keystone=use_keystone,
586         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
587         log_level=log_level))
588     suite.addTest(OSIntegrationTestCase.parameterize(
589         CreateVolMultipleCredsTests, os_creds=os_creds,
590         ext_net_name=ext_net_name, use_keystone=use_keystone,
591         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
592         log_level=log_level))
593
594     # VM Instances
595     suite.addTest(OSIntegrationTestCase.parameterize(
596         SimpleHealthCheck, os_creds=os_creds, ext_net_name=ext_net_name,
597         use_keystone=use_keystone,
598         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
599         log_level=log_level))
600     suite.addTest(OSIntegrationTestCase.parameterize(
601         CreateInstanceTwoNetTests, os_creds=os_creds,
602         ext_net_name=ext_net_name, use_keystone=use_keystone,
603         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
604         log_level=log_level))
605     suite.addTest(OSIntegrationTestCase.parameterize(
606         CreateInstanceSimpleTests, os_creds=os_creds,
607         ext_net_name=ext_net_name, use_keystone=use_keystone,
608         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
609         log_level=log_level))
610     suite.addTest(OSIntegrationTestCase.parameterize(
611         CreateInstanceExternalNetTests, os_creds=os_creds,
612         ext_net_name=ext_net_name, use_keystone=use_keystone,
613         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
614         log_level=log_level))
615     suite.addTest(OSIntegrationTestCase.parameterize(
616         CreateInstancePortManipulationTests, os_creds=os_creds,
617         ext_net_name=ext_net_name, use_keystone=use_keystone,
618         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
619         log_level=log_level))
620     suite.addTest(OSIntegrationTestCase.parameterize(
621         InstanceSecurityGroupTests, os_creds=os_creds,
622         ext_net_name=ext_net_name, use_keystone=use_keystone,
623         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
624         log_level=log_level))
625     suite.addTest(OSIntegrationTestCase.parameterize(
626         CreateInstanceOnComputeHost, os_creds=os_creds,
627         ext_net_name=ext_net_name, use_keystone=use_keystone,
628         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
629         log_level=log_level))
630     suite.addTest(OSIntegrationTestCase.parameterize(
631         CreateInstanceFromThreePartImage, os_creds=os_creds,
632         ext_net_name=ext_net_name, use_keystone=use_keystone,
633         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
634         log_level=log_level))
635     suite.addTest(OSIntegrationTestCase.parameterize(
636         CreateInstanceVolumeTests, os_creds=os_creds,
637         ext_net_name=ext_net_name, use_keystone=use_keystone,
638         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
639         log_level=log_level))
640     suite.addTest(OSIntegrationTestCase.parameterize(
641         CreateInstanceIPv6NetworkTests, os_creds=os_creds,
642         ext_net_name=ext_net_name, use_keystone=use_keystone,
643         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
644         log_level=log_level))
645     suite.addTest(OSIntegrationTestCase.parameterize(
646         CreateStackSuccessTests, os_creds=os_creds, ext_net_name=ext_net_name,
647         use_keystone=use_keystone,
648         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
649         log_level=log_level))
650     suite.addTest(OSIntegrationTestCase.parameterize(
651         CreateStackVolumeTests, os_creds=os_creds, ext_net_name=ext_net_name,
652         use_keystone=use_keystone,
653         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
654         log_level=log_level))
655     suite.addTest(OSIntegrationTestCase.parameterize(
656         CreateStackFlavorTests, os_creds=os_creds, ext_net_name=ext_net_name,
657         use_keystone=use_keystone,
658         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
659         log_level=log_level))
660     suite.addTest(OSIntegrationTestCase.parameterize(
661         CreateStackKeypairTests, os_creds=os_creds, ext_net_name=ext_net_name,
662         use_keystone=use_keystone,
663         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
664         log_level=log_level))
665     suite.addTest(OSIntegrationTestCase.parameterize(
666         CreateStackSecurityGroupTests, os_creds=os_creds,
667         ext_net_name=ext_net_name, use_keystone=use_keystone,
668         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
669         log_level=log_level))
670     suite.addTest(OSIntegrationTestCase.parameterize(
671         CreateStackNegativeTests, os_creds=os_creds, ext_net_name=ext_net_name,
672         use_keystone=use_keystone,
673         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
674         log_level=log_level))
675
676     if use_floating_ips:
677         suite.addTest(OSIntegrationTestCase.parameterize(
678             CreateInstanceSingleNetworkTests, os_creds=os_creds,
679             ext_net_name=ext_net_name, use_keystone=use_keystone,
680             flavor_metadata=flavor_metadata, image_metadata=image_metadata,
681             log_level=log_level))
682         suite.addTest(OSIntegrationTestCase.parameterize(
683             CreateStackFloatingIpTests, os_creds=os_creds,
684             ext_net_name=ext_net_name, use_keystone=use_keystone,
685             flavor_metadata=flavor_metadata, image_metadata=image_metadata,
686             log_level=log_level))
687         suite.addTest(OSIntegrationTestCase.parameterize(
688             CreateStackNestedResourceTests, os_creds=os_creds,
689             ext_net_name=ext_net_name, use_keystone=use_keystone,
690             flavor_metadata=flavor_metadata, image_metadata=image_metadata,
691             log_level=log_level))
692         suite.addTest(OSIntegrationTestCase.parameterize(
693             CreateStackUpdateTests, os_creds=os_creds,
694             ext_net_name=ext_net_name, use_keystone=use_keystone,
695             flavor_metadata=flavor_metadata, image_metadata=image_metadata,
696             log_level=log_level))
697
698
699 def add_ansible_integration_tests(suite, os_creds, ext_net_name,
700                                   use_keystone=True, flavor_metadata=None,
701                                   image_metadata=None, log_level=logging.INFO):
702     """
703     Adds tests written to exercise all long-running OpenStack integration tests
704     meaning they will be creating VM instances and potentially performing some
705     SSH functions through floatingIPs
706     :param suite: the unittest.TestSuite object to which to add the tests
707     :param os_creds: and instance of OSCreds that holds the credentials
708                      required by OpenStack
709     :param ext_net_name: the name of an external network on the cloud under
710                          test
711     :param use_keystone: when True, tests requiring direct access to Keystone
712                          are added as these need to be running on a host that
713                          has access to the cloud's private network
714     :param image_metadata: dict() object containing metadata for creating an
715                            image with custom config
716                            (see YAML files in examples/image-metadata)
717     :param flavor_metadata: dict() object containing the metadata required by
718                             your flavor based on your configuration:
719                             (i.e. {'hw:mem_page_size': 'large'})
720     :param log_level: the logging level
721     :return: None as the tests will be adding to the 'suite' parameter object
722     """
723     suite.addTest(OSIntegrationTestCase.parameterize(
724         AnsibleProvisioningTests, os_creds=os_creds,
725         ext_net_name=ext_net_name, use_keystone=use_keystone,
726         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
727         log_level=log_level))
728
729
730 def add_openstack_ci_tests(
731         suite, os_creds, ext_net_name, use_keystone=True, flavor_metadata=None,
732         image_metadata=None, use_floating_ips=True, log_level=logging.INFO):
733     """
734     Adds tests written for a CI server to run the tests to validate code
735     changes
736     :param suite: the unittest.TestSuite object to which to add the tests
737     :param os_creds: and instance of OSCreds that holds the credentials
738                      required by OpenStack
739     :param ext_net_name: the name of an external network on the cloud under
740                          test
741     :param use_keystone: when True, tests requiring direct access to Keystone
742                          are added as these need to be running on a host that
743                          has access to the cloud's private network
744     :param image_metadata: dict() object containing metadata for creating an
745                            image with custom config
746                            (see YAML files in examples/image-metadata)
747     :param flavor_metadata: dict() object containing the metadata required by
748                             your flavor based on your configuration:
749                             (i.e. {'hw:mem_page_size': 'large'})
750     :param use_floating_ips: when true, all tests requiring Floating IPs will
751                              be added to the suite
752     :param log_level: the logging level
753     :return: None as the tests will be adding to the 'suite' parameter object
754     """
755
756     add_unit_tests(suite)
757
758     add_openstack_client_tests(suite, os_creds, ext_net_name, use_keystone,
759                                log_level)
760
761     add_openstack_api_tests(suite, os_creds, ext_net_name, use_keystone,
762                             image_metadata, log_level)
763
764     suite.addTest(OSIntegrationTestCase.parameterize(
765         SimpleHealthCheck, os_creds=os_creds, ext_net_name=ext_net_name,
766         use_keystone=use_keystone,
767         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
768         log_level=log_level))
769
770     if use_floating_ips:
771         suite.addTest(OSIntegrationTestCase.parameterize(
772             CreateInstanceSingleNetworkTests, os_creds=os_creds,
773             ext_net_name=ext_net_name, use_keystone=use_keystone,
774             flavor_metadata=flavor_metadata, image_metadata=image_metadata,
775             log_level=log_level))
776
777     suite.addTest(OSIntegrationTestCase.parameterize(
778         CreateStackSuccessTests, os_creds=os_creds, ext_net_name=ext_net_name,
779         use_keystone=use_keystone,
780         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
781         log_level=log_level))
782     suite.addTest(OSIntegrationTestCase.parameterize(
783         CreateStackNegativeTests, os_creds=os_creds, ext_net_name=ext_net_name,
784         use_keystone=use_keystone,
785         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
786         log_level=log_level))
787
788
789 def add_openstack_staging_tests(suite, os_creds, ext_net_name,
790                                 log_level=logging.INFO):
791     """
792     Adds tests that are still in development have not been designed to run
793     successfully against all OpenStack pods
794     :param suite: the unittest.TestSuite object to which to add the tests
795     :param os_creds: Instance of OSCreds that holds the credentials
796                     required by OpenStack
797     :param ext_net_name: the name of an external network on the cloud under
798                          test
799     :param log_level: the logging level
800     :return: None as the tests will be adding to the 'suite' parameter object
801     """
802     suite.addTest(OSComponentTestCase.parameterize(
803         CreateNetworkTypeTests, os_creds=os_creds,
804         ext_net_name=ext_net_name, log_level=log_level))
805     suite.addTest(OSComponentTestCase.parameterize(
806         CreateInstanceMockOfflineTests, os_creds=os_creds,
807         ext_net_name=ext_net_name, log_level=log_level))
808     suite.addTest(OSComponentTestCase.parameterize(
809         MagnumSmokeTests, os_creds=os_creds,
810         ext_net_name=ext_net_name, log_level=log_level))
811     suite.addTest(OSComponentTestCase.parameterize(
812         MagnumUtilsClusterTypeTests, os_creds=os_creds,
813         ext_net_name=ext_net_name, log_level=log_level))
814     suite.addTest(OSComponentTestCase.parameterize(
815         CreateClusterTemplateTests, os_creds=os_creds,
816         ext_net_name=ext_net_name, log_level=log_level))