Refactor resource creation and cleanup in Tempest

Use Snaps to create resources before running a testcase and to clean up
afterwards.
Use Tempest Cleanup utility to clean other resources.

Change-Id: Ic0f69d3bafb60dfb283d18ac507e9f5992e9ae38
Signed-off-by: Martin Kulhavy <martin.kulhavy@nokia.com>

2 files changed, 238 insertions, 121 deletions

diff --git a/functest/opnfv_tests/openstack/tempest/conf_utils.py b/functest/opnfv_tests/openstack/tempest/conf_utils.py
index 8574b0de0..fccfebcef 100644
--- a/functest/opnfv_tests/openstack/tempest/conf_utils.py
+++ b/functest/opnfv_tests/openstack/tempest/conf_utils.py
@@ -52,101 +52,9 @@ CI_INSTALLER_IP = CONST.__getattribute__('INSTALLER_IP')
 logger = logging.getLogger(__name__)
 
 
-def create_tempest_resources(use_custom_images=False,
-                             use_custom_flavors=False):
-
-    logger.debug("Creating private network for Tempest suite")
-    network_dic = os_utils.create_shared_network_full(
-        CONST.__getattribute__('tempest_private_net_name'),
-        CONST.__getattribute__('tempest_private_subnet_name'),
-        CONST.__getattribute__('tempest_router_name'),
-        CONST.__getattribute__('tempest_private_subnet_cidr'))
-    if network_dic is None:
-        raise Exception('Failed to create private network')
-
-    image_id = ""
-    image_id_alt = ""
-    flavor_id = ""
-    flavor_id_alt = ""
-
-    if (CONST.__getattribute__('tempest_use_custom_images') or
-       use_custom_images):
-        # adding alternative image should be trivial should we need it
-        logger.debug("Creating image for Tempest suite")
-        _, image_id = os_utils.get_or_create_image(
-            CONST.__getattribute__('openstack_image_name'),
-            GLANCE_IMAGE_PATH,
-            CONST.__getattribute__('openstack_image_disk_format'))
-        if image_id is None:
-            raise Exception('Failed to create image')
-
-    if use_custom_images:
-        logger.debug("Creating 2nd image for Tempest suite")
-        _, image_id_alt = os_utils.get_or_create_image(
-            CONST.__getattribute__('openstack_image_name_alt'),
-            GLANCE_IMAGE_PATH,
-            CONST.__getattribute__('openstack_image_disk_format'))
-        if image_id_alt is None:
-            raise Exception('Failed to create image')
-
-    if (CONST.__getattribute__('tempest_use_custom_flavors') or
-       use_custom_flavors):
-        # adding alternative flavor should be trivial should we need it
-        logger.debug("Creating flavor for Tempest suite")
-        _, flavor_id = os_utils.get_or_create_flavor(
-            CONST.__getattribute__('openstack_flavor_name'),
-            CONST.__getattribute__('openstack_flavor_ram'),
-            CONST.__getattribute__('openstack_flavor_disk'),
-            CONST.__getattribute__('openstack_flavor_vcpus'))
-        if flavor_id is None:
-            raise Exception('Failed to create flavor')
-
-    if use_custom_flavors:
-        logger.debug("Creating 2nd flavor for tempest_defcore")
-        _, flavor_id_alt = os_utils.get_or_create_flavor(
-            CONST.__getattribute__('openstack_flavor_name_alt'),
-            CONST.__getattribute__('openstack_flavor_ram'),
-            CONST.__getattribute__('openstack_flavor_disk'),
-            CONST.__getattribute__('openstack_flavor_vcpus'))
-        if flavor_id_alt is None:
-            raise Exception('Failed to create flavor')
-
-    img_flavor_dict = {}
-    img_flavor_dict['image_id'] = image_id
-    img_flavor_dict['image_id_alt'] = image_id_alt
-    img_flavor_dict['flavor_id'] = flavor_id
-    img_flavor_dict['flavor_id_alt'] = flavor_id_alt
-
-    return img_flavor_dict
-
-
-def create_tenant_user():
-    keystone_client = os_utils.get_keystone_client()
-
-    logger.debug("Creating tenant and user for Tempest suite")
-    tenant_id = os_utils.create_tenant(
-        keystone_client,
-        CONST.__getattribute__('tempest_identity_tenant_name'),
-        CONST.__getattribute__('tempest_identity_tenant_description'))
-    if not tenant_id:
-        logger.error("Failed to create %s tenant"
-                     % CONST.__getattribute__('tempest_identity_tenant_name'))
-
-    user_id = os_utils.create_user(
-        keystone_client,
-        CONST.__getattribute__('tempest_identity_user_name'),
-        CONST.__getattribute__('tempest_identity_user_password'),
-        None, tenant_id)
-    if not user_id:
-        logger.error("Failed to create %s user" %
-                     CONST.__getattribute__('tempest_identity_user_name'))
-
-    return tenant_id
-
-
 def get_verifier_id():
     """
-    Returns verifer id for current Tempest
+    Returns verifier id for current Tempest
     """
     cmd = ("rally verify list-verifiers | awk '/" +
            CONST.__getattribute__('tempest_deployment_name') +
@@ -180,7 +88,7 @@ def get_verifier_deployment_id():
 
 def get_verifier_repo_dir(verifier_id):
     """
-    Returns installed verfier repo directory for Tempest
+    Returns installed verifier repo directory for Tempest
     """
     if not verifier_id:
         verifier_id = get_verifier_id()
@@ -229,25 +137,23 @@ def backup_tempest_config(conf_file):
                     os.path.join(TEMPEST_RESULTS_DIR, 'tempest.conf'))
 
 
-def configure_tempest(deployment_dir, IMAGE_ID=None, FLAVOR_ID=None,
-                      MODE=None):
+def configure_tempest(deployment_dir, image_id=None, flavor_id=None,
+                      mode=None):
     """
     Calls rally verify and updates the generated tempest.conf with
     given parameters
     """
     conf_file = configure_verifier(deployment_dir)
-    configure_tempest_update_params(conf_file,
-                                    IMAGE_ID, FLAVOR_ID)
+    configure_tempest_update_params(conf_file, image_id, flavor_id)
 
 
-def configure_tempest_defcore(deployment_dir, img_flavor_dict):
+def configure_tempest_defcore(deployment_dir, image_id, flavor_id,
+                              image_id_alt, flavor_id_alt, tenant_id):
     """
     Add/update needed parameters into tempest.conf file
     """
     conf_file = configure_verifier(deployment_dir)
-    configure_tempest_update_params(conf_file,
-                                    img_flavor_dict.get("image_id"),
-                                    img_flavor_dict.get("flavor_id"))
+    configure_tempest_update_params(conf_file, image_id, flavor_id)
 
     logger.debug("Updating selected tempest.conf parameters for defcore...")
     config = ConfigParser.RawConfigParser()
@@ -255,16 +161,14 @@ def configure_tempest_defcore(deployment_dir, img_flavor_dict):
     config.set('DEFAULT', 'log_file', '{}/tempest.log'.format(deployment_dir))
     config.set('oslo_concurrency', 'lock_path',
                '{}/lock_files'.format(deployment_dir))
-    generate_test_accounts_file()
+    generate_test_accounts_file(tenant_id=tenant_id)
     config.set('auth', 'test_accounts_file', TEST_ACCOUNTS_FILE)
     config.set('scenario', 'img_dir', '{}'.format(deployment_dir))
     config.set('scenario', 'img_file', 'tempest-image')
-    config.set('compute', 'image_ref', img_flavor_dict.get("image_id"))
-    config.set('compute', 'image_ref_alt',
-               img_flavor_dict['image_id_alt'])
-    config.set('compute', 'flavor_ref', img_flavor_dict.get("flavor_id"))
-    config.set('compute', 'flavor_ref_alt',
-               img_flavor_dict['flavor_id_alt'])
+    config.set('compute', 'image_ref', image_id)
+    config.set('compute', 'image_ref_alt', image_id_alt)
+    config.set('compute', 'flavor_ref', flavor_id)
+    config.set('compute', 'flavor_ref_alt', flavor_id_alt)
 
     with open(conf_file, 'wb') as config_file:
         config.write(config_file)
@@ -275,13 +179,12 @@ def configure_tempest_defcore(deployment_dir, img_flavor_dict):
     shutil.copyfile(conf_file, confpath)
 
 
-def generate_test_accounts_file():
+def generate_test_accounts_file(tenant_id):
     """
     Add needed tenant and user params into test_accounts.yaml
     """
 
     logger.debug("Add needed params into test_accounts.yaml...")
-    tenant_id = create_tenant_user()
     accounts_list = [
         {
             'tenant_name':
@@ -298,7 +201,7 @@ def generate_test_accounts_file():
 
 
 def configure_tempest_update_params(tempest_conf_file,
-                                    IMAGE_ID=None, FLAVOR_ID=None):
+                                    image_id=None, flavor_id=None):
     """
     Add/update needed parameters into tempest.conf file
     """
@@ -312,13 +215,13 @@ def configure_tempest_update_params(tempest_conf_file,
     config.set('compute', 'volume_device_name',
                CONST.__getattribute__('tempest_volume_device_name'))
     if CONST.__getattribute__('tempest_use_custom_images'):
-        if IMAGE_ID is not None:
-            config.set('compute', 'image_ref', IMAGE_ID)
+        if image_id is not None:
+            config.set('compute', 'image_ref', image_id)
         if IMAGE_ID_ALT is not None:
             config.set('compute', 'image_ref_alt', IMAGE_ID_ALT)
     if CONST.__getattribute__('tempest_use_custom_flavors'):
-        if FLAVOR_ID is not None:
-            config.set('compute', 'flavor_ref', FLAVOR_ID)
+        if flavor_id is not None:
+            config.set('compute', 'flavor_ref', flavor_id)
         if FLAVOR_ID_ALT is not None:
             config.set('compute', 'flavor_ref_alt', FLAVOR_ID_ALT)
     config.set('identity', 'region', 'RegionOne')
diff --git a/functest/opnfv_tests/openstack/tempest/tempest.py b/functest/opnfv_tests/openstack/tempest/tempest.py
index f783f01ff..5129a56e3 100644
--- a/functest/opnfv_tests/openstack/tempest/tempest.py
+++ b/functest/opnfv_tests/openstack/tempest/tempest.py
@@ -23,15 +23,26 @@ from functest.core import testcase
 from functest.opnfv_tests.openstack.tempest import conf_utils
 from functest.utils.constants import CONST
 import functest.utils.functest_utils as ft_utils
+import functest.utils.openstack_utils as os_utils
+
+from snaps.openstack import create_flavor
+from snaps.openstack.create_flavor import FlavorSettings, OpenStackFlavor
+from snaps.openstack.create_project import ProjectSettings
+from snaps.openstack.create_network import NetworkSettings, SubnetSettings
+from snaps.openstack.create_user import UserSettings
+from snaps.openstack.tests import openstack_tests
+from snaps.openstack.utils import deploy_utils
+
 
 """ logging configuration """
 logger = logging.getLogger(__name__)
 
 
-class TempestCommon(testcase.OSGCTestCase):
+class TempestCommon(testcase.TestCase):
 
     def __init__(self, **kwargs):
         super(TempestCommon, self).__init__(**kwargs)
+        self.resources = TempestResourcesManager(**kwargs)
         self.MODE = ""
         self.OPTION = ""
         self.VERIFIER_ID = conf_utils.get_verifier_id()
@@ -222,12 +233,12 @@ class TempestCommon(testcase.OSGCTestCase):
         try:
             if not os.path.exists(conf_utils.TEMPEST_RESULTS_DIR):
                 os.makedirs(conf_utils.TEMPEST_RESULTS_DIR)
-            image_and_flavor = conf_utils.create_tempest_resources()
+            resources = self.resources.create()
             conf_utils.configure_tempest(
                 self.DEPLOYMENT_DIR,
-                IMAGE_ID=image_and_flavor.get("image_id"),
-                FLAVOR_ID=image_and_flavor.get("flavor_id"),
-                MODE=self.MODE)
+                image_id=resources.get("image_id"),
+                flavor_id=resources.get("flavor_id"),
+                mode=self.MODE)
             self.generate_test_list(self.VERIFIER_REPO_DIR)
             self.apply_tempest_blacklist()
             self.run_verifier_tests()
@@ -236,10 +247,46 @@ class TempestCommon(testcase.OSGCTestCase):
         except Exception as e:
             logger.error('Error with run: %s' % e)
             res = testcase.TestCase.EX_RUN_ERROR
+        finally:
+            self.resources.cleanup()
 
         self.stop_time = time.time()
         return res
 
+    def create_snapshot(self):
+        """
+        Run the Tempest cleanup utility to initialize OS state.
+
+        :return: TestCase.EX_OK
+        """
+        logger.info("Initializing the saved state of the OpenStack deployment")
+
+        # Make sure that the verifier is configured
+        conf_utils.configure_verifier(self.DEPLOYMENT_DIR)
+
+        os_utils.init_tempest_cleanup(
+            self.DEPLOYMENT_DIR, 'tempest.conf',
+            os.path.join(conf_utils.TEMPEST_RESULTS_DIR,
+                         "tempest-cleanup-init.log")
+        )
+
+        return super(TempestCommon, self).create_snapshot()
+
+    def clean(self):
+        """
+        Run the Tempest cleanup utility to delete and destroy OS resources
+        created by Tempest.
+        """
+        logger.info("Initializing the saved state of the OpenStack deployment")
+
+        os_utils.init_tempest_cleanup(
+            self.DEPLOYMENT_DIR, 'tempest.conf',
+            os.path.join(conf_utils.REFSTACK_RESULTS_DIR,
+                         "tempest-cleanup.log")
+        )
+
+        return super(TempestCommon, self).clean()
+
 
 class TempestSmokeSerial(TempestCommon):
 
@@ -288,3 +335,170 @@ class TempestDefcore(TempestCommon):
         TempestCommon.__init__(self, **kwargs)
         self.MODE = "defcore"
         self.OPTION = "--concurrency 1"
+
+
+class TempestResourcesManager(object):
+
+    def __init__(self, **kwargs):
+        self.os_creds = None
+        if 'os_creds' in kwargs:
+            self.os_creds = kwargs['os_creds']
+        else:
+            self.os_creds = openstack_tests.get_credentials(
+                os_env_file=CONST.__getattribute__('openstack_creds'))
+
+        self.creators = list()
+
+        if hasattr(CONST, 'snaps_images_cirros'):
+            self.cirros_image_config = CONST.__getattribute__(
+                'snaps_images_cirros')
+        else:
+            self.cirros_image_config = None
+
+    def create(self, use_custom_images=False, use_custom_flavors=False,
+               create_project=False):
+        if create_project:
+            logger.debug("Creating project (tenant) for Tempest suite")
+            project_name = CONST.__getattribute__(
+                'tempest_identity_tenant_name')
+            project_creator = deploy_utils.create_project(
+                self.os_creds, ProjectSettings(
+                    name=project_name,
+                    description=CONST.__getattribute__(
+                        'tempest_identity_tenant_description')))
+            if (project_creator is None or
+                    project_creator.get_project() is None):
+                raise Exception("Failed to create tenant")
+            project_id = project_creator.get_project().id
+            self.creators.append(project_creator)
+
+            logger.debug("Creating user for Tempest suite")
+            user_creator = deploy_utils.create_user(
+                self.os_creds, UserSettings(
+                    name=CONST.__getattribute__('tempest_identity_user_name'),
+                    password=CONST.__getattribute__(
+                        'tempest_identity_user_password'),
+                    project_name=project_name))
+            if user_creator is None or user_creator.get_user() is None:
+                raise Exception("Failed to create user")
+            user_id = user_creator.get_user().id
+            self.creators.append(user_creator)
+        else:
+            project_name = None
+            project_id = None
+            user_id = None
+
+        logger.debug("Creating private network for Tempest suite")
+        network_creator = deploy_utils.create_network(
+            self.os_creds, NetworkSettings(
+                name=CONST.__getattribute__('tempest_private_net_name'),
+                project_name=project_name,
+                subnet_settings=[SubnetSettings(
+                    name=CONST.__getattribute__('tempest_private_subnet_name'),
+                    cidr=CONST.__getattribute__('tempest_private_subnet_cidr'))
+                ]))
+        if network_creator is None or network_creator.get_network() is None:
+            raise Exception("Failed to create private network")
+        self.creators.append(network_creator)
+
+        image_id = None
+        image_id_alt = None
+        flavor_id = None
+        flavor_id_alt = None
+
+        if (CONST.__getattribute__('tempest_use_custom_images') or
+           use_custom_images):
+            logger.debug("Creating image for Tempest suite")
+            image_base_name = CONST.__getattribute__('openstack_image_name')
+            os_image_settings = openstack_tests.cirros_image_settings(
+                image_base_name, public=True,
+                image_metadata=self.cirros_image_config)
+            logger.debug("Creating image for Tempest suite")
+            image_creator = deploy_utils.create_image(
+                self.os_creds, os_image_settings)
+            if image_creator is None:
+                raise Exception('Failed to create image')
+            self.creators.append(image_creator)
+            image_id = image_creator.get_image().id
+
+        if use_custom_images:
+            logger.debug("Creating 2nd image for Tempest suite")
+            image_base_name_alt = CONST.__getattribute__(
+                'openstack_image_name_alt')
+            os_image_settings_alt = openstack_tests.cirros_image_settings(
+                image_base_name_alt, public=True,
+                image_metadata=self.cirros_image_config)
+            logger.debug("Creating 2nd image for Tempest suite")
+            image_creator_alt = deploy_utils.create_image(
+                self.os_creds, os_image_settings_alt)
+            if image_creator_alt is None:
+                raise Exception('Failed to create image')
+            self.creators.append(image_creator_alt)
+            image_id_alt = image_creator_alt.get_image().id
+
+        if (CONST.__getattribute__('tempest_use_custom_flavors') or
+           use_custom_flavors):
+            logger.info("Creating flavor for Tempest suite")
+            scenario = ft_utils.get_scenario()
+            flavor_metadata = None
+            if 'ovs' in scenario or 'fdio' in scenario:
+                flavor_metadata = create_flavor.MEM_PAGE_SIZE_LARGE
+            flavor_creator = OpenStackFlavor(
+                self.os_creds, FlavorSettings(
+                    name=CONST.__getattribute__('openstack_flavor_name'),
+                    ram=CONST.__getattribute__('openstack_flavor_ram'),
+                    disk=CONST.__getattribute__('openstack_flavor_disk'),
+                    vcpus=CONST.__getattribute__('openstack_flavor_vcpus'),
+                    metadata=flavor_metadata))
+            flavor = flavor_creator.create()
+            if flavor is None:
+                raise Exception('Failed to create flavor')
+            self.creators.append(flavor_creator)
+            flavor_id = flavor.id
+
+        if use_custom_flavors:
+            logger.info("Creating 2nd flavor for Tempest suite")
+            scenario = ft_utils.get_scenario()
+            flavor_metadata_alt = None
+            if 'ovs' in scenario or 'fdio' in scenario:
+                flavor_metadata_alt = create_flavor.MEM_PAGE_SIZE_LARGE
+            flavor_creator_alt = OpenStackFlavor(
+                self.os_creds, FlavorSettings(
+                    name=CONST.__getattribute__('openstack_flavor_name_alt'),
+                    ram=CONST.__getattribute__('openstack_flavor_ram'),
+                    disk=CONST.__getattribute__('openstack_flavor_disk'),
+                    vcpus=CONST.__getattribute__('openstack_flavor_vcpus'),
+                    metadata=flavor_metadata_alt))
+            flavor_alt = flavor_creator_alt.create()
+            if flavor_alt is None:
+                raise Exception('Failed to create flavor')
+            self.creators.append(flavor_creator_alt)
+            flavor_id_alt = flavor_alt.id
+
+        print("RESOURCES CREATE: image_id: %s, image_id_alt: %s, "
+              "flavor_id: %s, flavor_id_alt: %s" % (
+                  image_id, image_id_alt, flavor_id, flavor_id_alt,))
+
+        result = {
+            'image_id': image_id,
+            'image_id_alt': image_id_alt,
+            'flavor_id': flavor_id,
+            'flavor_id_alt': flavor_id_alt
+        }
+
+        if create_project:
+            result['project_id'] = project_id
+            result['tenant_id'] = project_id  # for compatibility
+            result['user_id'] = user_id
+
+        return result
+
+    def cleanup(self):
+        """
+        Cleanup all OpenStack objects. Should be called on completion.
+        """
+        for creator in reversed(self.creators):
+            try:
+                creator.clean()
+            except Exception as e:
+                logger.error('Unexpected error cleaning - %s', e)