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