Added support for offline testing
[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.image_tests import ImageDomainObjectTests
20 from snaps.openstack.utils.tests.glance_utils_tests import GlanceSmokeTests, GlanceUtilsTests
21 from snaps.openstack.tests.create_flavor_tests import CreateFlavorTests
22 from snaps.tests.file_utils_tests import FileUtilsTests
23 from snaps.openstack.tests.create_security_group_tests import CreateSecurityGroupTests, \
24     SecurityGroupRuleSettingsUnitTests, SecurityGroupSettingsUnitTests
25 from snaps.openstack.tests.create_project_tests import CreateProjectSuccessTests, ProjectSettingsUnitTests, \
26     CreateProjectUserTests
27 from snaps.openstack.tests.create_user_tests import UserSettingsUnitTests, CreateUserSuccessTests
28 from snaps.openstack.utils.tests.keystone_utils_tests import KeystoneSmokeTests, KeystoneUtilsTests
29 from snaps.openstack.utils.tests.neutron_utils_tests import NeutronSmokeTests, NeutronUtilsNetworkTests, \
30     NeutronUtilsSubnetTests, NeutronUtilsRouterTests, NeutronUtilsSecurityGroupTests
31 from snaps.openstack.tests.create_image_tests import CreateImageSuccessTests, CreateImageNegativeTests, \
32     ImageSettingsUnitTests, CreateMultiPartImageTests
33 from snaps.openstack.tests.create_keypairs_tests import CreateKeypairsTests, KeypairSettingsUnitTests
34 from snaps.openstack.tests.create_network_tests import CreateNetworkSuccessTests, NetworkSettingsUnitTests, \
35     PortSettingsUnitTests, SubnetSettingsUnitTests, CreateNetworkTypeTests
36 from snaps.openstack.tests.create_router_tests import CreateRouterSuccessTests, CreateRouterNegativeTests
37 from snaps.openstack.tests.create_instance_tests import CreateInstanceSingleNetworkTests, \
38     CreateInstancePubPrivNetTests, CreateInstanceOnComputeHost, CreateInstanceSimpleTests, \
39     FloatingIpSettingsUnitTests, InstanceSecurityGroupTests, VmInstanceSettingsUnitTests, \
40     CreateInstancePortManipulationTests, SimpleHealthCheck, CreateInstanceFromThreePartImage, \
41     CreateInstanceMockOfflineTests
42 from snaps.provisioning.tests.ansible_utils_tests import AnsibleProvisioningTests
43 from snaps.openstack.tests.os_source_file_test import OSComponentTestCase, OSIntegrationTestCase
44 from snaps.openstack.utils.tests.nova_utils_tests import NovaSmokeTests, NovaUtilsKeypairTests, NovaUtilsFlavorTests
45
46 __author__ = 'spisarski'
47
48
49 def add_unit_tests(suite):
50     """
51     Adds tests that do not require external resources
52     :param suite: the unittest.TestSuite object to which to add the tests
53     :return: None as the tests will be adding to the 'suite' parameter object
54     """
55     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(FileUtilsTests))
56     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(SecurityGroupRuleSettingsUnitTests))
57     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(SecurityGroupSettingsUnitTests))
58     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(ImageSettingsUnitTests))
59     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(ImageDomainObjectTests))
60     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(KeypairSettingsUnitTests))
61     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(UserSettingsUnitTests))
62     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(ProjectSettingsUnitTests))
63     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(NetworkSettingsUnitTests))
64     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(SubnetSettingsUnitTests))
65     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(PortSettingsUnitTests))
66     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(FloatingIpSettingsUnitTests))
67     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(VmInstanceSettingsUnitTests))
68
69
70 def add_openstack_client_tests(suite, os_creds, ext_net_name, use_keystone=True, log_level=logging.INFO):
71     """
72     Adds tests written to exercise OpenStack client retrieval
73     :param suite: the unittest.TestSuite object to which to add the tests
74     :param os_creds: and instance of OSCreds that holds the credentials required by OpenStack
75     :param ext_net_name: the name of an external network on the cloud under test
76     :param use_keystone: when True, tests requiring direct access to Keystone are added as these need to be running on
77                          a host that has access to the cloud's private network
78     :param log_level: the logging level
79     :return: None as the tests will be adding to the 'suite' parameter object
80     """
81     # Basic connection tests
82     suite.addTest(OSComponentTestCase.parameterize(GlanceSmokeTests, os_creds=os_creds, ext_net_name=ext_net_name,
83                                                    log_level=log_level))
84
85     if use_keystone:
86         suite.addTest(OSComponentTestCase.parameterize(KeystoneSmokeTests, os_creds=os_creds, ext_net_name=ext_net_name,
87                                                        log_level=log_level))
88
89     suite.addTest(OSComponentTestCase.parameterize(NeutronSmokeTests, os_creds=os_creds, ext_net_name=ext_net_name,
90                                                    log_level=log_level))
91     suite.addTest(OSComponentTestCase.parameterize(NovaSmokeTests, os_creds=os_creds, ext_net_name=ext_net_name,
92                                                    log_level=log_level))
93
94
95 def add_openstack_api_tests(suite, os_creds, ext_net_name, use_keystone=True, image_metadata=None,
96                             log_level=logging.INFO):
97     """
98     Adds tests written to exercise all existing OpenStack APIs
99     :param suite: the unittest.TestSuite object to which to add the tests
100     :param os_creds: and instance of OSCreds that holds the credentials required by OpenStack
101     :param ext_net_name: the name of an external network on the cloud under test
102     :param use_keystone: when True, tests requiring direct access to Keystone are added as these need to be running on
103                          a host that has access to the cloud's private network
104     :param image_metadata: dict() object containing metadata for creating an image with custom config
105                            (see YAML files in examples/image-metadata)
106     :param log_level: the logging level
107     :return: None as the tests will be adding to the 'suite' parameter object
108     """
109     # Tests the OpenStack API calls
110     if use_keystone:
111         suite.addTest(OSComponentTestCase.parameterize(
112             KeystoneUtilsTests, os_creds=os_creds, ext_net_name=ext_net_name, log_level=log_level))
113         suite.addTest(OSComponentTestCase.parameterize(
114             CreateUserSuccessTests, os_creds=os_creds, ext_net_name=ext_net_name, log_level=log_level))
115         suite.addTest(OSComponentTestCase.parameterize(
116             CreateProjectSuccessTests, os_creds=os_creds, ext_net_name=ext_net_name, log_level=log_level))
117         suite.addTest(OSComponentTestCase.parameterize(
118             CreateProjectUserTests, os_creds=os_creds, ext_net_name=ext_net_name, log_level=log_level))
119
120     suite.addTest(OSComponentTestCase.parameterize(
121         GlanceUtilsTests, os_creds=os_creds, ext_net_name=ext_net_name, image_metadata=image_metadata,
122         log_level=log_level))
123     suite.addTest(OSComponentTestCase.parameterize(
124         NeutronUtilsNetworkTests, os_creds=os_creds, ext_net_name=ext_net_name, log_level=log_level))
125     suite.addTest(OSComponentTestCase.parameterize(
126         NeutronUtilsSubnetTests, os_creds=os_creds, ext_net_name=ext_net_name, log_level=log_level))
127     suite.addTest(OSComponentTestCase.parameterize(
128         NeutronUtilsRouterTests, os_creds=os_creds, ext_net_name=ext_net_name, log_level=log_level))
129     suite.addTest(OSComponentTestCase.parameterize(
130         NeutronUtilsSecurityGroupTests, os_creds=os_creds, ext_net_name=ext_net_name, log_level=log_level))
131     suite.addTest(OSComponentTestCase.parameterize(
132         NovaUtilsKeypairTests, os_creds=os_creds, ext_net_name=ext_net_name, log_level=log_level))
133     suite.addTest(OSComponentTestCase.parameterize(
134         NovaUtilsFlavorTests, os_creds=os_creds, ext_net_name=ext_net_name, log_level=log_level))
135     suite.addTest(OSComponentTestCase.parameterize(
136         CreateFlavorTests, os_creds=os_creds, ext_net_name=ext_net_name, log_level=log_level))
137
138
139 def add_openstack_integration_tests(suite, os_creds, ext_net_name, use_keystone=True, flavor_metadata=None,
140                                     image_metadata=None, use_floating_ips=True, log_level=logging.INFO):
141     """
142     Adds tests written to exercise all long-running OpenStack integration tests meaning they will be creating VM
143     instances and potentially performing some SSH functions through floating IPs
144     :param suite: the unittest.TestSuite object to which to add the tests
145     :param os_creds: and instance of OSCreds that holds the credentials required by OpenStack
146     :param ext_net_name: the name of an external network on the cloud under test
147     :param use_keystone: when True, tests requiring direct access to Keystone are added as these need to be running on
148                          a host that has access to the cloud's private network
149     :param image_metadata: dict() object containing metadata for creating an image with custom config
150                            (see YAML files in examples/image-metadata)
151     :param flavor_metadata: dict() object containing the metadata required by your flavor based on your configuration:
152                             (i.e. {'hw:mem_page_size': 'large'})
153     :param use_floating_ips: when true, all tests requiring Floating IPs will be added to the suite
154     :param log_level: the logging level
155     :return: None as the tests will be adding to the 'suite' parameter object
156     """
157     # Tests the OpenStack API calls via a creator. If use_keystone, objects will be created with a custom user
158     # and project
159
160     # Creator Object tests
161     suite.addTest(OSIntegrationTestCase.parameterize(
162         CreateSecurityGroupTests, os_creds=os_creds, ext_net_name=ext_net_name, use_keystone=use_keystone,
163         flavor_metadata=flavor_metadata, image_metadata=image_metadata, log_level=log_level))
164     suite.addTest(OSIntegrationTestCase.parameterize(
165         CreateImageSuccessTests, os_creds=os_creds, ext_net_name=ext_net_name, use_keystone=use_keystone,
166         flavor_metadata=flavor_metadata, image_metadata=image_metadata, log_level=log_level))
167     suite.addTest(OSIntegrationTestCase.parameterize(
168         CreateImageNegativeTests, os_creds=os_creds, ext_net_name=ext_net_name, use_keystone=use_keystone,
169         flavor_metadata=flavor_metadata, image_metadata=image_metadata, log_level=log_level))
170     suite.addTest(OSIntegrationTestCase.parameterize(
171         CreateMultiPartImageTests, os_creds=os_creds, ext_net_name=ext_net_name, use_keystone=use_keystone,
172         flavor_metadata=flavor_metadata, image_metadata=image_metadata, log_level=log_level))
173     suite.addTest(OSIntegrationTestCase.parameterize(
174         CreateKeypairsTests, os_creds=os_creds, ext_net_name=ext_net_name, use_keystone=use_keystone,
175         flavor_metadata=flavor_metadata, image_metadata=image_metadata, log_level=log_level))
176     suite.addTest(OSIntegrationTestCase.parameterize(
177         CreateNetworkSuccessTests, os_creds=os_creds, ext_net_name=ext_net_name, use_keystone=use_keystone,
178         flavor_metadata=flavor_metadata, image_metadata=image_metadata, log_level=log_level))
179     suite.addTest(OSIntegrationTestCase.parameterize(
180         CreateRouterSuccessTests, os_creds=os_creds, ext_net_name=ext_net_name, use_keystone=use_keystone,
181         flavor_metadata=flavor_metadata, image_metadata=image_metadata, log_level=log_level))
182     suite.addTest(OSIntegrationTestCase.parameterize(
183         CreateRouterNegativeTests, os_creds=os_creds, ext_net_name=ext_net_name, use_keystone=use_keystone,
184         flavor_metadata=flavor_metadata, image_metadata=image_metadata, log_level=log_level))
185
186     # VM Instances
187     suite.addTest(OSIntegrationTestCase.parameterize(
188         SimpleHealthCheck, os_creds=os_creds, ext_net_name=ext_net_name, use_keystone=use_keystone,
189         flavor_metadata=flavor_metadata, image_metadata=image_metadata, log_level=log_level))
190     suite.addTest(OSIntegrationTestCase.parameterize(
191         CreateInstanceSimpleTests, os_creds=os_creds, ext_net_name=ext_net_name, use_keystone=use_keystone,
192         flavor_metadata=flavor_metadata, image_metadata=image_metadata, log_level=log_level))
193     suite.addTest(OSIntegrationTestCase.parameterize(
194         CreateInstancePortManipulationTests, os_creds=os_creds, ext_net_name=ext_net_name, use_keystone=use_keystone,
195         flavor_metadata=flavor_metadata, image_metadata=image_metadata, log_level=log_level))
196     suite.addTest(OSIntegrationTestCase.parameterize(
197         InstanceSecurityGroupTests, os_creds=os_creds, ext_net_name=ext_net_name, use_keystone=use_keystone,
198         flavor_metadata=flavor_metadata, image_metadata=image_metadata, log_level=log_level))
199     suite.addTest(OSIntegrationTestCase.parameterize(
200         CreateInstanceOnComputeHost, os_creds=os_creds, ext_net_name=ext_net_name, use_keystone=use_keystone,
201         flavor_metadata=flavor_metadata, image_metadata=image_metadata, log_level=log_level))
202     suite.addTest(OSIntegrationTestCase.parameterize(
203         CreateInstanceFromThreePartImage, os_creds=os_creds, ext_net_name=ext_net_name, use_keystone=use_keystone,
204         flavor_metadata=flavor_metadata, image_metadata=image_metadata, log_level=log_level))
205
206     if use_floating_ips:
207         suite.addTest(OSIntegrationTestCase.parameterize(
208             CreateInstanceSingleNetworkTests, os_creds=os_creds, ext_net_name=ext_net_name, use_keystone=use_keystone,
209             flavor_metadata=flavor_metadata, image_metadata=image_metadata, log_level=log_level))
210         suite.addTest(OSIntegrationTestCase.parameterize(
211             CreateInstancePubPrivNetTests, os_creds=os_creds, ext_net_name=ext_net_name, use_keystone=use_keystone,
212             flavor_metadata=flavor_metadata, image_metadata=image_metadata, log_level=log_level))
213         suite.addTest(OSIntegrationTestCase.parameterize(
214             AnsibleProvisioningTests, os_creds=os_creds, ext_net_name=ext_net_name, use_keystone=use_keystone,
215             flavor_metadata=flavor_metadata, image_metadata=image_metadata, log_level=log_level))
216
217
218 def add_openstack_staging_tests(suite, os_creds, ext_net_name, log_level=logging.INFO):
219     """
220     Adds tests that are still in development have not been designed to run successfully against all OpenStack pods
221     :param suite: the unittest.TestSuite object to which to add the tests
222     :param os_creds: and instance of OSCreds that holds the credentials required by OpenStack
223     :param ext_net_name: the name of an external network on the cloud under test
224     :param log_level: the logging level
225     :return: None as the tests will be adding to the 'suite' parameter object
226     """
227     suite.addTest(OSComponentTestCase.parameterize(
228         CreateNetworkTypeTests, os_creds=os_creds, ext_net_name=ext_net_name, log_level=log_level))
229     suite.addTest(OSComponentTestCase.parameterize(
230         CreateInstanceMockOfflineTests, os_creds=os_creds, ext_net_name=ext_net_name, log_level=log_level))