Merge "Read env vars instead of using CONST in API"
[functest.git] / functest / opnfv_tests / openstack / tempest / tempest.py
index b00bc6a..01caf4f 100644 (file)
@@ -8,52 +8,99 @@
 # http://www.apache.org/licenses/LICENSE-2.0
 #
 
+"""Tempest testcases implementation."""
+
 from __future__ import division
 
 import logging
 import os
-import pkg_resources
 import re
 import shutil
 import subprocess
 import time
+import uuid
 
 import yaml
 
 from functest.core import testcase
+from functest.opnfv_tests.openstack.snaps import snaps_utils
 from functest.opnfv_tests.openstack.tempest import conf_utils
 from functest.utils.constants import CONST
 import functest.utils.functest_utils as ft_utils
 
-""" logging configuration """
-logger = logging.getLogger(__name__)
+from snaps.config.flavor import FlavorConfig
+from snaps.config.network import NetworkConfig, SubnetConfig
+from snaps.config.project import ProjectConfig
+from snaps.config.user import UserConfig
+
+from snaps.openstack import create_flavor
+from snaps.openstack.create_flavor import OpenStackFlavor
+from snaps.openstack.tests import openstack_tests
+from snaps.openstack.utils import deploy_utils
+
 
+LOGGER = logging.getLogger(__name__)
 
-class TempestCommon(testcase.OSGCTestCase):
+
+class TempestCommon(testcase.TestCase):
+    # pylint: disable=too-many-instance-attributes
+    """TempestCommon testcases implementation class."""
 
     def __init__(self, **kwargs):
         super(TempestCommon, self).__init__(**kwargs)
-        self.MODE = ""
-        self.OPTION = ""
-        self.VERIFIER_ID = conf_utils.get_verifier_id()
-        self.VERIFIER_REPO_DIR = conf_utils.get_verifier_repo_dir(
-            self.VERIFIER_ID)
-        self.DEPLOYMENT_ID = conf_utils.get_verifier_deployment_id()
-        self.DEPLOYMENT_DIR = conf_utils.get_verifier_deployment_dir(
-            self.VERIFIER_ID, self.DEPLOYMENT_ID)
-        self.VERIFICATION_ID = None
+        self.resources = TempestResourcesManager(**kwargs)
+        self.mode = ""
+        self.option = []
+        self.verifier_id = conf_utils.get_verifier_id()
+        self.verifier_repo_dir = conf_utils.get_verifier_repo_dir(
+            self.verifier_id)
+        self.deployment_id = conf_utils.get_verifier_deployment_id()
+        self.deployment_dir = conf_utils.get_verifier_deployment_dir(
+            self.verifier_id, self.deployment_id)
+        self.verification_id = None
 
     @staticmethod
     def read_file(filename):
+        """Read file and return content as a stripped list."""
         with open(filename) as src:
             return [line.strip() for line in src.readlines()]
 
+    @staticmethod
+    def get_verifier_result(verif_id):
+        """Retrieve verification results."""
+        result = {
+            'num_tests': 0,
+            'num_success': 0,
+            'num_failures': 0,
+            'num_skipped': 0
+        }
+        cmd = ["rally", "verify", "show", "--uuid", verif_id]
+        LOGGER.info("Showing result for a verification: '%s'.", cmd)
+        proc = subprocess.Popen(cmd,
+                                stdout=subprocess.PIPE,
+                                stderr=subprocess.STDOUT)
+        for line in proc.stdout:
+            new_line = line.replace(' ', '').split('|')
+            if 'Tests' in new_line:
+                break
+            LOGGER.info(line)
+            if 'Testscount' in new_line:
+                result['num_tests'] = int(new_line[2])
+            elif 'Success' in new_line:
+                result['num_success'] = int(new_line[2])
+            elif 'Skipped' in new_line:
+                result['num_skipped'] = int(new_line[2])
+            elif 'Failures' in new_line:
+                result['num_failures'] = int(new_line[2])
+        return result
+
     def generate_test_list(self, verifier_repo_dir):
-        logger.debug("Generating test case list...")
-        if self.MODE == 'defcore':
+        """Generate test list based on the test mode."""
+        LOGGER.debug("Generating test case list...")
+        if self.mode == 'defcore':
             shutil.copyfile(
                 conf_utils.TEMPEST_DEFCORE, conf_utils.TEMPEST_RAW_LIST)
-        elif self.MODE == 'custom':
+        elif self.mode == 'custom':
             if os.path.isfile(conf_utils.TEMPEST_CUSTOM):
                 shutil.copyfile(
                     conf_utils.TEMPEST_CUSTOM, conf_utils.TEMPEST_RAW_LIST)
@@ -61,14 +108,12 @@ class TempestCommon(testcase.OSGCTestCase):
                 raise Exception("Tempest test list file %s NOT found."
                                 % conf_utils.TEMPEST_CUSTOM)
         else:
-            if self.MODE == 'smoke':
+            if self.mode == 'smoke':
                 testr_mode = "smoke"
-            elif self.MODE == 'feature_multisite':
-                testr_mode = "'[Kk]ingbird'"
-            elif self.MODE == 'full':
+            elif self.mode == 'full':
                 testr_mode = ""
             else:
-                testr_mode = 'tempest.api.' + self.MODE
+                testr_mode = 'tempest.api.' + self.mode
             cmd = ("cd {0};"
                    "testr list-tests {1} > {2};"
                    "cd -;".format(verifier_repo_dir,
@@ -77,14 +122,15 @@ class TempestCommon(testcase.OSGCTestCase):
             ft_utils.execute_command(cmd)
 
     def apply_tempest_blacklist(self):
-        logger.debug("Applying tempest blacklist...")
+        """Exclude blacklisted test cases."""
+        LOGGER.debug("Applying tempest blacklist...")
         cases_file = self.read_file(conf_utils.TEMPEST_RAW_LIST)
         result_file = open(conf_utils.TEMPEST_LIST, 'w')
         black_tests = []
         try:
             installer_type = CONST.__getattribute__('INSTALLER_TYPE')
             deploy_scenario = CONST.__getattribute__('DEPLOY_SCENARIO')
-            if (bool(installer_type) * bool(deploy_scenario)):
+            if bool(installer_type) * bool(deploy_scenario):
                 # if INSTALLER_TYPE and DEPLOY_SCENARIO are set we read the
                 # file
                 black_list_file = open(conf_utils.TEMPEST_BLACKLIST)
@@ -99,9 +145,9 @@ class TempestCommon(testcase.OSGCTestCase):
                         for test in tests:
                             black_tests.append(test)
                         break
-        except Exception:
+        except Exception:  # pylint: disable=broad-except
             black_tests = []
-            logger.debug("Tempest blacklist file does not exist.")
+            LOGGER.debug("Tempest blacklist file does not exist.")
 
         for cases_line in cases_file:
             for black_tests_line in black_tests:
@@ -112,11 +158,11 @@ class TempestCommon(testcase.OSGCTestCase):
         result_file.close()
 
     def run_verifier_tests(self):
-        self.OPTION += (" --load-list {} --detailed"
-                        .format(conf_utils.TEMPEST_LIST))
-
-        cmd_line = "rally verify start " + self.OPTION
-        logger.info("Starting Tempest test suite: '%s'." % cmd_line)
+        """Execute tempest test cases."""
+        cmd = ["rally", "verify", "start", "--load-list",
+               conf_utils.TEMPEST_LIST]
+        cmd.extend(self.option)
+        LOGGER.info("Starting Tempest test suite: '%s'.", cmd)
 
         header = ("Tempest environment:\n"
                   "  SUT: %s\n  Scenario: %s\n  Node: %s\n  Date: %s\n" %
@@ -134,87 +180,71 @@ class TempestCommon(testcase.OSGCTestCase):
                                   "environment.log"), 'w+')
         f_env.write(header)
 
-        p = subprocess.Popen(
-            cmd_line, shell=True,
+        proc = subprocess.Popen(
+            cmd,
             stdout=subprocess.PIPE,
             stderr=f_stderr,
             bufsize=1)
 
-        with p.stdout:
-            for line in iter(p.stdout.readline, b''):
-                if re.search("\} tempest\.", line):
-                    logger.info(line.replace('\n', ''))
+        with proc.stdout:
+            for line in iter(proc.stdout.readline, b''):
+                if re.search(r"\} tempest\.", line):
+                    LOGGER.info(line.replace('\n', ''))
                 elif re.search('Starting verification', line):
-                    logger.info(line.replace('\n', ''))
+                    LOGGER.info(line.replace('\n', ''))
                     first_pos = line.index("UUID=") + len("UUID=")
                     last_pos = line.index(") for deployment")
-                    self.VERIFICATION_ID = line[first_pos:last_pos]
-                    logger.debug('Verification UUID: %s', self.VERIFICATION_ID)
+                    self.verification_id = line[first_pos:last_pos]
+                    LOGGER.debug('Verification UUID: %s', self.verification_id)
                 f_stdout.write(line)
-        p.wait()
+        proc.wait()
 
         f_stdout.close()
         f_stderr.close()
         f_env.close()
 
     def parse_verifier_result(self):
-        if self.VERIFICATION_ID is None:
+        """Parse and save test results."""
+        if self.verification_id is None:
             raise Exception('Verification UUID not found')
 
-        cmd_line = "rally verify show --uuid {}".format(self.VERIFICATION_ID)
-        logger.info("Showing result for a verification: '%s'." % cmd_line)
-        p = subprocess.Popen(cmd_line,
-                             shell=True,
-                             stdout=subprocess.PIPE,
-                             stderr=subprocess.STDOUT)
-        for line in p.stdout:
-            new_line = line.replace(' ', '').split('|')
-            if 'Tests' in new_line:
-                break
-
-            logger.info(line)
-            if 'Testscount' in new_line:
-                num_tests = new_line[2]
-            elif 'Success' in new_line:
-                num_success = new_line[2]
-            elif 'Skipped' in new_line:
-                num_skipped = new_line[2]
-            elif 'Failures' in new_line:
-                num_failures = new_line[2]
-
+        stat = self.get_verifier_result(self.verification_id)
         try:
-            num_executed = int(num_tests) - int(num_skipped)
+            num_executed = stat['num_tests'] - stat['num_skipped']
             try:
-                self.result = 100 * int(num_success) / int(num_executed)
+                self.result = 100 * stat['num_success'] / num_executed
             except ZeroDivisionError:
-                logger.error("No test has been executed")
                 self.result = 0
-                return
+                if stat['num_tests'] > 0:
+                    LOGGER.info("All tests have been skipped")
+                else:
+                    LOGGER.error("No test has been executed")
+                    return
 
             with open(os.path.join(conf_utils.TEMPEST_RESULTS_DIR,
                                    "tempest.log"), 'r') as logfile:
                 output = logfile.read()
 
             success_testcases = []
-            for match in re.findall('.*\{0\} (.*?)[. ]*success ', output):
+            for match in re.findall(r'.*\{0\} (.*?)[. ]*success ', output):
                 success_testcases.append(match)
             failed_testcases = []
-            for match in re.findall('.*\{0\} (.*?)[. ]*fail ', output):
+            for match in re.findall(r'.*\{0\} (.*?)[. ]*fail ', output):
                 failed_testcases.append(match)
             skipped_testcases = []
-            for match in re.findall('.*\{0\} (.*?)[. ]*skip:', output):
+            for match in re.findall(r'.*\{0\} (.*?)[. ]*skip:', output):
                 skipped_testcases.append(match)
 
-            self.details = {"tests": int(num_tests),
-                            "failures": int(num_failures),
+            self.details = {"tests": stat['num_tests'],
+                            "failures": stat['num_failures'],
                             "success": success_testcases,
-                            "errors": failed_testcases,
-                            "skipped": skipped_testcases}
-        except Exception:
+                            "skipped": skipped_testcases,
+                            "errors": failed_testcases}
+        except Exception:  # pylint: disable=broad-except
             self.result = 0
 
-        logger.info("Tempest %s success_rate is %s%%"
-                    % (self.case_name, self.result))
+        LOGGER.info("Tempest %s success_rate is %s%%",
+                    self.case_name, self.result)
 
     def run(self):
 
@@ -222,81 +252,243 @@ 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()
+            compute_cnt = snaps_utils.get_active_compute_cnt(
+                self.resources.os_creds)
             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)
-            self.generate_test_list(self.VERIFIER_REPO_DIR)
+                self.deployment_dir,
+                network_name=resources.get("network_name"),
+                image_id=resources.get("image_id"),
+                flavor_id=resources.get("flavor_id"),
+                compute_cnt=compute_cnt)
+            self.generate_test_list(self.verifier_repo_dir)
             self.apply_tempest_blacklist()
             self.run_verifier_tests()
             self.parse_verifier_result()
             res = testcase.TestCase.EX_OK
-        except Exception as e:
-            logger.error('Error with run: %s' % e)
+        except Exception as err:  # pylint: disable=broad-except
+            LOGGER.error('Error with run: %s', err)
             res = testcase.TestCase.EX_RUN_ERROR
+        finally:
+            self.resources.cleanup()
 
         self.stop_time = time.time()
         return res
 
 
 class TempestSmokeSerial(TempestCommon):
-
+    """Tempest smoke serial testcase implementation."""
     def __init__(self, **kwargs):
         if "case_name" not in kwargs:
             kwargs["case_name"] = 'tempest_smoke_serial'
         TempestCommon.__init__(self, **kwargs)
-        self.MODE = "smoke"
-        self.OPTION = "--concurrency 1"
+        self.mode = "smoke"
+        self.option = ["--concurrency", "1"]
 
 
 class TempestSmokeParallel(TempestCommon):
-
+    """Tempest smoke parallel testcase implementation."""
     def __init__(self, **kwargs):
         if "case_name" not in kwargs:
             kwargs["case_name"] = 'tempest_smoke_parallel'
         TempestCommon.__init__(self, **kwargs)
-        self.MODE = "smoke"
-        self.OPTION = ""
+        self.mode = "smoke"
 
 
 class TempestFullParallel(TempestCommon):
-
+    """Tempest full parallel testcase implementation."""
     def __init__(self, **kwargs):
         if "case_name" not in kwargs:
             kwargs["case_name"] = 'tempest_full_parallel'
         TempestCommon.__init__(self, **kwargs)
-        self.MODE = "full"
-
-
-class TempestMultisite(TempestCommon):
-
-    def __init__(self, **kwargs):
-        if "case_name" not in kwargs:
-            kwargs["case_name"] = 'multisite'
-        TempestCommon.__init__(self, **kwargs)
-        self.MODE = "feature_multisite"
-        self.OPTION = "--concurrency 1"
-        conf_utils.install_verifier_ext(
-            pkg_resources.resource_filename('kingbird', '..'))
+        self.mode = "full"
 
 
 class TempestCustom(TempestCommon):
-
+    """Tempest custom testcase implementation."""
     def __init__(self, **kwargs):
         if "case_name" not in kwargs:
             kwargs["case_name"] = 'tempest_custom'
         TempestCommon.__init__(self, **kwargs)
-        self.MODE = "custom"
-        self.OPTION = "--concurrency 1"
+        self.mode = "custom"
+        self.option = ["--concurrency", "1"]
 
 
 class TempestDefcore(TempestCommon):
-
+    """Tempest Defcore testcase implementation."""
     def __init__(self, **kwargs):
         if "case_name" not in kwargs:
             kwargs["case_name"] = 'tempest_defcore'
         TempestCommon.__init__(self, **kwargs)
-        self.MODE = "defcore"
-        self.OPTION = "--concurrency 1"
+        self.mode = "defcore"
+        self.option = ["--concurrency", "1"]
+
+
+class TempestResourcesManager(object):
+    """Tempest resource manager."""
+    def __init__(self, **kwargs):
+        self.os_creds = kwargs.get('os_creds') or snaps_utils.get_credentials()
+        self.guid = '-' + str(uuid.uuid4())
+        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_project(self):
+        """Create project for tests."""
+        project_creator = deploy_utils.create_project(
+            self.os_creds, ProjectConfig(
+                name=CONST.__getattribute__(
+                    'tempest_identity_tenant_name') + self.guid,
+                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")
+        self.creators.append(project_creator)
+        return project_creator.get_project().id
+
+    def _create_user(self):
+        """Create user for tests."""
+        user_creator = deploy_utils.create_user(
+            self.os_creds, UserConfig(
+                name=CONST.__getattribute__(
+                    'tempest_identity_user_name') + self.guid,
+                password=CONST.__getattribute__(
+                    'tempest_identity_user_password'),
+                project_name=CONST.__getattribute__(
+                    'tempest_identity_tenant_name') + self.guid))
+        if user_creator is None or user_creator.get_user() is None:
+            raise Exception("Failed to create user")
+        self.creators.append(user_creator)
+        return user_creator.get_user().id
+
+    def _create_network(self, project_name):
+        """Create network for tests."""
+        tempest_network_type = None
+        tempest_physical_network = None
+        tempest_segmentation_id = None
+
+        if hasattr(CONST, 'tempest_network_type'):
+            tempest_network_type = CONST.__getattribute__(
+                'tempest_network_type')
+        if hasattr(CONST, 'tempest_physical_network'):
+            tempest_physical_network = CONST.__getattribute__(
+                'tempest_physical_network')
+        if hasattr(CONST, 'tempest_segmentation_id'):
+            tempest_segmentation_id = CONST.__getattribute__(
+                'tempest_segmentation_id')
+
+        tempest_net_name = CONST.__getattribute__(
+            'tempest_private_net_name') + self.guid
+
+        network_creator = deploy_utils.create_network(
+            self.os_creds, NetworkConfig(
+                name=tempest_net_name,
+                project_name=project_name,
+                network_type=tempest_network_type,
+                physical_network=tempest_physical_network,
+                segmentation_id=tempest_segmentation_id,
+                subnet_settings=[SubnetConfig(
+                    name=CONST.__getattribute__(
+                        'tempest_private_subnet_name') + self.guid,
+                    project_name=project_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)
+        return tempest_net_name
+
+    def _create_image(self, name):
+        """Create image for tests"""
+        os_image_settings = openstack_tests.cirros_image_settings(
+            name, public=True,
+            image_metadata=self.cirros_image_config)
+        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)
+        return image_creator.get_image().id
+
+    def _create_flavor(self, name):
+        """Create flavor for tests."""
+        scenario = CONST.__getattribute__('DEPLOY_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, FlavorConfig(
+                name=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)
+        return flavor.id
+
+    def create(self, use_custom_images=False, use_custom_flavors=False,
+               create_project=False):
+        """Create resources for Tempest test suite."""
+        result = {
+            'tempest_net_name': None,
+            'image_id': None,
+            'image_id_alt': None,
+            'flavor_id': None,
+            'flavor_id_alt': None
+        }
+        project_name = None
+
+        if create_project:
+            LOGGER.debug("Creating project and user for Tempest suite")
+            project_name = CONST.__getattribute__(
+                'tempest_identity_tenant_name') + self.guid
+            result['project_id'] = self._create_project()
+            result['user_id'] = self._create_user()
+            result['tenant_id'] = result['project_id']  # for compatibility
+
+        LOGGER.debug("Creating private network for Tempest suite")
+        result['tempest_net_name'] = self._create_network(project_name)
+
+        LOGGER.debug("Creating image for Tempest suite")
+        image_name = CONST.__getattribute__('openstack_image_name') + self.guid
+        result['image_id'] = self._create_image(image_name)
+
+        if use_custom_images:
+            LOGGER.debug("Creating 2nd image for Tempest suite")
+            image_name = CONST.__getattribute__(
+                'openstack_image_name_alt') + self.guid
+            result['image_id_alt'] = self._create_image(image_name)
+
+        if (CONST.__getattribute__('tempest_use_custom_flavors') == 'True' or
+                use_custom_flavors):
+            LOGGER.info("Creating flavor for Tempest suite")
+            name = CONST.__getattribute__('openstack_flavor_name') + self.guid
+            result['flavor_id'] = self._create_flavor(name)
+
+        if use_custom_flavors:
+            LOGGER.info("Creating 2nd flavor for Tempest suite")
+            scenario = CONST.__getattribute__('DEPLOY_SCENARIO')
+            if 'ovs' in scenario or 'fdio' in scenario:
+                CONST.__setattr__('openstack_flavor_ram', 1024)
+            name = CONST.__getattribute__(
+                'openstack_flavor_name_alt') + self.guid
+            result['flavor_id_alt'] = self._create_flavor(name)
+
+        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 err:  # pylint: disable=broad-except
+                LOGGER.error('Unexpected error cleaning - %s', err)