snaps/test_suite_builder.py

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