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.domain.test.stack_tests import StackDomainObjectTests
  21 from snaps.domain.test.vm_inst_tests import (VmInstDomainObjectTests,
  22                                              FloatingIpDomainObjectTests)
  23 from snaps.openstack.tests.conf.os_credentials_tests import (
  24     ProxySettingsUnitTests, OSCredsUnitTests)
  25 from snaps.openstack.tests.create_flavor_tests import CreateFlavorTests
  26 from snaps.openstack.tests.create_image_tests import (
  27     CreateImageSuccessTests, CreateImageNegativeTests, ImageSettingsUnitTests,
  28     CreateMultiPartImageTests)
  29 from snaps.openstack.tests.create_instance_tests import (
  30     CreateInstanceSingleNetworkTests, CreateInstancePubPrivNetTests,
  31     CreateInstanceOnComputeHost, CreateInstanceSimpleTests,
  32     FloatingIpSettingsUnitTests, InstanceSecurityGroupTests,
  33     VmInstanceSettingsUnitTests, CreateInstancePortManipulationTests,
  34     SimpleHealthCheck, CreateInstanceFromThreePartImage,
  35     CreateInstanceMockOfflineTests)
  36 from snaps.openstack.tests.create_keypairs_tests import (
  37     CreateKeypairsTests, KeypairSettingsUnitTests)
  38 from snaps.openstack.tests.create_network_tests import (
  39     CreateNetworkSuccessTests, NetworkSettingsUnitTests, PortSettingsUnitTests,
  40     SubnetSettingsUnitTests, CreateNetworkTypeTests)
  41 from snaps.openstack.tests.create_project_tests import (
  42     CreateProjectSuccessTests, ProjectSettingsUnitTests,
  43     CreateProjectUserTests)
  44 from snaps.openstack.tests.create_router_tests import (
  45     CreateRouterSuccessTests, CreateRouterNegativeTests)
  46 from snaps.openstack.tests.create_security_group_tests import (
  47     CreateSecurityGroupTests, SecurityGroupRuleSettingsUnitTests,
  48     SecurityGroupSettingsUnitTests)
  49 from snaps.openstack.tests.create_stack_tests import (
  50     StackSettingsUnitTests, CreateStackSuccessTests,  CreateStackNegativeTests)
  51 from snaps.openstack.tests.create_user_tests import (
  52     UserSettingsUnitTests, CreateUserSuccessTests)
  53 from snaps.openstack.tests.os_source_file_test import (
  54     OSComponentTestCase, OSIntegrationTestCase)
  55 from snaps.openstack.utils.tests.glance_utils_tests import (
  56     GlanceSmokeTests, GlanceUtilsTests)
  57 from snaps.openstack.utils.tests.heat_utils_tests import (
  58     HeatUtilsCreateStackTests, HeatSmokeTests)
  59 from snaps.openstack.utils.tests.keystone_utils_tests import (
  60     KeystoneSmokeTests, KeystoneUtilsTests)
  61 from snaps.openstack.utils.tests.neutron_utils_tests import (
  62     NeutronSmokeTests, NeutronUtilsNetworkTests, NeutronUtilsSubnetTests,
  63     NeutronUtilsRouterTests, NeutronUtilsSecurityGroupTests,
  64     NeutronUtilsFloatingIpTests)
  65 from snaps.openstack.utils.tests.nova_utils_tests import (
  66     NovaSmokeTests, NovaUtilsKeypairTests, NovaUtilsFlavorTests,
  67     NovaUtilsInstanceTests)
  68 from snaps.provisioning.tests.ansible_utils_tests import (
  69     AnsibleProvisioningTests)
  70 from snaps.tests.file_utils_tests import FileUtilsTests
  71
  72 __author__ = 'spisarski'
  73
  74
  75 def add_unit_tests(suite):
  76     """
  77     Adds tests that do not require external resources
  78     :param suite: the unittest.TestSuite object to which to add the tests
  79     :return: None as the tests will be adding to the 'suite' parameter object
  80     """
  81     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(FileUtilsTests))
  82     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
  83         SecurityGroupRuleSettingsUnitTests))
  84     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
  85         ProxySettingsUnitTests))
  86     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
  87         OSCredsUnitTests))
  88     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
  89         SecurityGroupSettingsUnitTests))
  90     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
  91         ImageSettingsUnitTests))
  92     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
  93         ImageDomainObjectTests))
  94     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
  95         KeypairSettingsUnitTests))
  96     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
  97         UserSettingsUnitTests))
  98     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
  99         ProjectSettingsUnitTests))
 100     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
 101         NetworkSettingsUnitTests))
 102     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
 103         SubnetSettingsUnitTests))
 104     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
 105         PortSettingsUnitTests))
 106     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
 107         FloatingIpSettingsUnitTests))
 108     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
 109         VmInstanceSettingsUnitTests))
 110     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
 111         StackDomainObjectTests))
 112     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
 113         StackSettingsUnitTests))
 114     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
 115         VmInstDomainObjectTests))
 116     suite.addTest(unittest.TestLoader().loadTestsFromTestCase(
 117         FloatingIpDomainObjectTests))
 118
 119
 120 def add_openstack_client_tests(suite, os_creds, ext_net_name,
 121                                use_keystone=True, log_level=logging.INFO):
 122     """
 123     Adds tests written to exercise OpenStack client retrieval
 124     :param suite: the unittest.TestSuite object to which to add the tests
 125     :param os_creds: and instance of OSCreds that holds the credentials
 126                      required by OpenStack
 127     :param ext_net_name: the name of an external network on the cloud under
 128                          test
 129     :param use_keystone: when True, tests requiring direct access to Keystone
 130                          are added as these need to be running on a host that
 131                          has access to the cloud's private network
 132     :param log_level: the logging level
 133     :return: None as the tests will be adding to the 'suite' parameter object
 134     """
 135     # Basic connection tests
 136     suite.addTest(
 137         OSComponentTestCase.parameterize(
 138             GlanceSmokeTests, os_creds=os_creds, ext_net_name=ext_net_name,
 139             log_level=log_level))
 140
 141     if use_keystone:
 142         suite.addTest(
 143             OSComponentTestCase.parameterize(
 144                 KeystoneSmokeTests, os_creds=os_creds,
 145                 ext_net_name=ext_net_name, log_level=log_level))
 146
 147     suite.addTest(
 148         OSComponentTestCase.parameterize(
 149             NeutronSmokeTests, os_creds=os_creds, ext_net_name=ext_net_name,
 150             log_level=log_level))
 151     suite.addTest(
 152         OSComponentTestCase.parameterize(
 153             NovaSmokeTests, os_creds=os_creds, ext_net_name=ext_net_name,
 154             log_level=log_level))
 155     suite.addTest(
 156         OSComponentTestCase.parameterize(
 157             HeatSmokeTests, os_creds=os_creds, ext_net_name=ext_net_name,
 158             log_level=log_level))
 159
 160
 161 def add_openstack_api_tests(suite, os_creds, ext_net_name, use_keystone=True,
 162                             image_metadata=None, log_level=logging.INFO):
 163     """
 164     Adds tests written to exercise all existing OpenStack APIs
 165     :param suite: the unittest.TestSuite object to which to add the tests
 166     :param os_creds: Instance of OSCreds that holds the credentials
 167                      required by OpenStack
 168     :param ext_net_name: the name of an external network on the cloud under
 169                          test
 170     :param use_keystone: when True, tests requiring direct access to Keystone
 171                          are added as these need to be running on a host that
 172                          has access to the cloud's private network
 173     :param image_metadata: dict() object containing metadata for creating an
 174                            image with custom config
 175                            (see YAML files in examples/image-metadata)
 176     :param log_level: the logging level
 177     :return: None as the tests will be adding to the 'suite' parameter object
 178     """
 179     # Tests the OpenStack API calls
 180     if use_keystone:
 181         suite.addTest(OSComponentTestCase.parameterize(
 182             KeystoneUtilsTests, os_creds=os_creds, ext_net_name=ext_net_name,
 183             log_level=log_level))
 184         suite.addTest(OSComponentTestCase.parameterize(
 185             CreateUserSuccessTests, os_creds=os_creds,
 186             ext_net_name=ext_net_name, log_level=log_level))
 187         suite.addTest(OSComponentTestCase.parameterize(
 188             CreateProjectSuccessTests, os_creds=os_creds,
 189             ext_net_name=ext_net_name, log_level=log_level))
 190         suite.addTest(OSComponentTestCase.parameterize(
 191             CreateProjectUserTests, os_creds=os_creds,
 192             ext_net_name=ext_net_name, log_level=log_level))
 193
 194     suite.addTest(OSComponentTestCase.parameterize(
 195         GlanceUtilsTests, os_creds=os_creds, ext_net_name=ext_net_name,
 196         image_metadata=image_metadata,
 197         log_level=log_level))
 198     suite.addTest(OSComponentTestCase.parameterize(
 199         NeutronUtilsNetworkTests, os_creds=os_creds, ext_net_name=ext_net_name,
 200         log_level=log_level))
 201     suite.addTest(OSComponentTestCase.parameterize(
 202         NeutronUtilsSubnetTests, os_creds=os_creds, ext_net_name=ext_net_name,
 203         log_level=log_level))
 204     suite.addTest(OSComponentTestCase.parameterize(
 205         NeutronUtilsRouterTests, os_creds=os_creds, ext_net_name=ext_net_name,
 206         log_level=log_level))
 207     suite.addTest(OSComponentTestCase.parameterize(
 208         NeutronUtilsSecurityGroupTests, os_creds=os_creds,
 209         ext_net_name=ext_net_name, log_level=log_level))
 210     suite.addTest(OSComponentTestCase.parameterize(
 211         NeutronUtilsFloatingIpTests, os_creds=os_creds,
 212         ext_net_name=ext_net_name, log_level=log_level))
 213     suite.addTest(OSComponentTestCase.parameterize(
 214         NovaUtilsKeypairTests, os_creds=os_creds, ext_net_name=ext_net_name,
 215         log_level=log_level))
 216     suite.addTest(OSComponentTestCase.parameterize(
 217         NovaUtilsFlavorTests, os_creds=os_creds, ext_net_name=ext_net_name,
 218         log_level=log_level))
 219     suite.addTest(OSComponentTestCase.parameterize(
 220         NovaUtilsInstanceTests, os_creds=os_creds, ext_net_name=ext_net_name,
 221         log_level=log_level, image_metadata=image_metadata))
 222     suite.addTest(OSComponentTestCase.parameterize(
 223         CreateFlavorTests, os_creds=os_creds, ext_net_name=ext_net_name,
 224         log_level=log_level))
 225     suite.addTest(OSComponentTestCase.parameterize(
 226         HeatUtilsCreateStackTests, os_creds=os_creds,
 227         ext_net_name=ext_net_name, log_level=log_level,
 228         image_metadata=image_metadata))
 229
 230
 231 def add_openstack_integration_tests(suite, os_creds, ext_net_name,
 232                                     use_keystone=True, flavor_metadata=None,
 233                                     image_metadata=None, use_floating_ips=True,
 234                                     log_level=logging.INFO):
 235     """
 236     Adds tests written to exercise all long-running OpenStack integration tests
 237     meaning they will be creating VM instances and potentially performing some
 238     SSH functions through floatingIPs
 239     :param suite: the unittest.TestSuite object to which to add the tests
 240     :param os_creds: and instance of OSCreds that holds the credentials
 241                      required by OpenStack
 242     :param ext_net_name: the name of an external network on the cloud under
 243                          test
 244     :param use_keystone: when True, tests requiring direct access to Keystone
 245                          are added as these need to be running on a host that
 246                          has access to the cloud's private network
 247     :param image_metadata: dict() object containing metadata for creating an
 248                            image with custom config
 249                            (see YAML files in examples/image-metadata)
 250     :param flavor_metadata: dict() object containing the metadata required by
 251                             your flavor based on your configuration:
 252                             (i.e. {'hw:mem_page_size': 'large'})
 253     :param use_floating_ips: when true, all tests requiring Floating IPs will
 254                              be added to the suite
 255     :param log_level: the logging level
 256     :return: None as the tests will be adding to the 'suite' parameter object
 257     """
 258     # Tests the OpenStack API calls via a creator. If use_keystone, objects
 259     # will be created with a custom user and project
 260
 261     # Creator Object tests
 262     suite.addTest(OSIntegrationTestCase.parameterize(
 263         CreateSecurityGroupTests, os_creds=os_creds, ext_net_name=ext_net_name,
 264         use_keystone=use_keystone,
 265         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
 266         log_level=log_level))
 267     suite.addTest(OSIntegrationTestCase.parameterize(
 268         CreateImageSuccessTests, os_creds=os_creds, ext_net_name=ext_net_name,
 269         use_keystone=use_keystone,
 270         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
 271         log_level=log_level))
 272     suite.addTest(OSIntegrationTestCase.parameterize(
 273         CreateImageNegativeTests, os_creds=os_creds, ext_net_name=ext_net_name,
 274         use_keystone=use_keystone,
 275         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
 276         log_level=log_level))
 277     suite.addTest(OSIntegrationTestCase.parameterize(
 278         CreateMultiPartImageTests, os_creds=os_creds,
 279         ext_net_name=ext_net_name, use_keystone=use_keystone,
 280         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
 281         log_level=log_level))
 282     suite.addTest(OSIntegrationTestCase.parameterize(
 283         CreateKeypairsTests, os_creds=os_creds, ext_net_name=ext_net_name,
 284         use_keystone=use_keystone,
 285         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
 286         log_level=log_level))
 287     suite.addTest(OSIntegrationTestCase.parameterize(
 288         CreateNetworkSuccessTests, os_creds=os_creds,
 289         ext_net_name=ext_net_name, use_keystone=use_keystone,
 290         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
 291         log_level=log_level))
 292     suite.addTest(OSIntegrationTestCase.parameterize(
 293         CreateRouterSuccessTests, os_creds=os_creds, ext_net_name=ext_net_name,
 294         use_keystone=use_keystone,
 295         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
 296         log_level=log_level))
 297     suite.addTest(OSIntegrationTestCase.parameterize(
 298         CreateRouterNegativeTests, os_creds=os_creds,
 299         ext_net_name=ext_net_name, use_keystone=use_keystone,
 300         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
 301         log_level=log_level))
 302
 303     # VM Instances
 304     suite.addTest(OSIntegrationTestCase.parameterize(
 305         SimpleHealthCheck, os_creds=os_creds, ext_net_name=ext_net_name,
 306         use_keystone=use_keystone,
 307         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
 308         log_level=log_level))
 309     suite.addTest(OSIntegrationTestCase.parameterize(
 310         CreateInstanceSimpleTests, os_creds=os_creds,
 311         ext_net_name=ext_net_name, use_keystone=use_keystone,
 312         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
 313         log_level=log_level))
 314     suite.addTest(OSIntegrationTestCase.parameterize(
 315         CreateInstancePortManipulationTests, os_creds=os_creds,
 316         ext_net_name=ext_net_name, use_keystone=use_keystone,
 317         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
 318         log_level=log_level))
 319     suite.addTest(OSIntegrationTestCase.parameterize(
 320         InstanceSecurityGroupTests, os_creds=os_creds,
 321         ext_net_name=ext_net_name, use_keystone=use_keystone,
 322         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
 323         log_level=log_level))
 324     suite.addTest(OSIntegrationTestCase.parameterize(
 325         CreateInstanceOnComputeHost, os_creds=os_creds,
 326         ext_net_name=ext_net_name, use_keystone=use_keystone,
 327         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
 328         log_level=log_level))
 329     suite.addTest(OSIntegrationTestCase.parameterize(
 330         CreateInstanceFromThreePartImage, os_creds=os_creds,
 331         ext_net_name=ext_net_name, use_keystone=use_keystone,
 332         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
 333         log_level=log_level))
 334     suite.addTest(OSIntegrationTestCase.parameterize(
 335         CreateStackSuccessTests, os_creds=os_creds, ext_net_name=ext_net_name,
 336         use_keystone=use_keystone,
 337         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
 338         log_level=log_level))
 339     suite.addTest(OSIntegrationTestCase.parameterize(
 340         CreateStackNegativeTests, os_creds=os_creds, ext_net_name=ext_net_name,
 341         use_keystone=use_keystone,
 342         flavor_metadata=flavor_metadata, image_metadata=image_metadata,
 343         log_level=log_level))
 344
 345     if use_floating_ips:
 346         suite.addTest(OSIntegrationTestCase.parameterize(
 347             CreateInstanceSingleNetworkTests, os_creds=os_creds,
 348             ext_net_name=ext_net_name, use_keystone=use_keystone,
 349             flavor_metadata=flavor_metadata, image_metadata=image_metadata,
 350             log_level=log_level))
 351         suite.addTest(OSIntegrationTestCase.parameterize(
 352             CreateInstancePubPrivNetTests, os_creds=os_creds,
 353             ext_net_name=ext_net_name, use_keystone=use_keystone,
 354             flavor_metadata=flavor_metadata, image_metadata=image_metadata,
 355             log_level=log_level))
 356         suite.addTest(OSIntegrationTestCase.parameterize(
 357             AnsibleProvisioningTests, os_creds=os_creds,
 358             ext_net_name=ext_net_name, use_keystone=use_keystone,
 359             flavor_metadata=flavor_metadata, image_metadata=image_metadata,
 360             log_level=log_level))
 361
 362
 363 def add_openstack_staging_tests(suite, os_creds, ext_net_name,
 364                                 log_level=logging.INFO):
 365     """
 366     Adds tests that are still in development have not been designed to run
 367     successfully against all OpenStack pods
 368     :param suite: the unittest.TestSuite object to which to add the tests
 369     :param os_creds: 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 log_level: the logging level
 374     :return: None as the tests will be adding to the 'suite' parameter object
 375     """
 376     suite.addTest(OSComponentTestCase.parameterize(
 377         CreateNetworkTypeTests, os_creds=os_creds, ext_net_name=ext_net_name,
 378         log_level=log_level))
 379     suite.addTest(OSComponentTestCase.parameterize(
 380         CreateInstanceMockOfflineTests, os_creds=os_creds,
 381         ext_net_name=ext_net_name, log_level=log_level))