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