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