Temporarily disable shelve
[functest.git] / functest / opnfv_tests / openstack / tempest / tempest.py
index cb8e9b4..216709f 100644 (file)
@@ -8,6 +8,8 @@
 # http://www.apache.org/licenses/LICENSE-2.0
 #
 
+"""Tempest testcases implementation."""
+
 from __future__ import division
 
 import logging
@@ -17,73 +19,157 @@ import shutil
 import subprocess
 import time
 
+from six.moves import configparser
+from xtesting.core import testcase
 import yaml
 
-from functest.core import testcase
+from functest.core import singlevm
 from functest.opnfv_tests.openstack.tempest import conf_utils
-from functest.utils.constants import CONST
-import functest.utils.functest_utils as ft_utils
+from functest.utils import config
+from functest.utils import env
+
+LOGGER = logging.getLogger(__name__)
 
-""" logging configuration """
-logger = logging.getLogger(__name__)
 
+class TempestCommon(singlevm.VmReady1):
+    # pylint: disable=too-many-instance-attributes
+    """TempestCommon testcases implementation class."""
 
-class TempestCommon(testcase.OSGCTestCase):
+    visibility = 'public'
+    shared_network = True
+    filename_alt = '/home/opnfv/functest/images/cirros-0.4.0-x86_64-disk.img'
 
     def __init__(self, **kwargs):
+        if "case_name" not in kwargs:
+            kwargs["case_name"] = 'tempest'
         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.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.res_dir = os.path.join(
+            getattr(config.CONF, 'dir_results'), self.case_name)
+        self.raw_list = os.path.join(self.res_dir, 'test_raw_list.txt')
+        self.list = os.path.join(self.res_dir, 'test_list.txt')
+        self.conf_file = None
+        self.image_alt = None
+        self.flavor_alt = None
+        self.services = []
+        try:
+            self.services = kwargs['run']['args']['services']
+        except Exception:  # pylint: disable=broad-except
+            pass
+        self.neutron_extensions = []
+        try:
+            self.neutron_extensions = kwargs['run']['args'][
+                'neutron_extensions']
+        except Exception:  # pylint: disable=broad-except
+            pass
+
+    def check_services(self):
+        """Check the mandatory services."""
+        for service in self.services:
+            try:
+                self.cloud.search_services(service)[0]
+            except Exception:  # pylint: disable=broad-except
+                self.is_skipped = True
+                break
+
+    def check_extensions(self):
+        """Check the mandatory network extensions."""
+        extensions = self.cloud.get_network_extensions()
+        for network_extension in self.neutron_extensions:
+            if network_extension not in extensions:
+                LOGGER.warning(
+                    "Cannot find Neutron extension: %s", network_extension)
+                self.is_skipped = True
+                break
+
+    def check_requirements(self):
+        self.check_services()
+        self.check_extensions()
 
     @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()]
 
-    def generate_test_list(self, verifier_repo_dir):
-        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':
+    @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:
+            LOGGER.info(line.rstrip())
+            new_line = line.replace(' ', '').split('|')
+            if 'Tests' in new_line:
+                break
+            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
+
+    @staticmethod
+    def backup_tempest_config(conf_file, res_dir):
+        """
+        Copy config file to tempest results directory
+        """
+        if not os.path.exists(res_dir):
+            os.makedirs(res_dir)
+        shutil.copyfile(conf_file,
+                        os.path.join(res_dir, 'tempest.conf'))
+
+    def generate_test_list(self, **kwargs):
+        """Generate test list based on the test mode."""
+        LOGGER.debug("Generating test case list...")
+        self.backup_tempest_config(self.conf_file, '/etc')
+        if kwargs.get('mode') == 'custom':
             if os.path.isfile(conf_utils.TEMPEST_CUSTOM):
                 shutil.copyfile(
-                    conf_utils.TEMPEST_CUSTOM, conf_utils.TEMPEST_RAW_LIST)
+                    conf_utils.TEMPEST_CUSTOM, self.list)
             else:
                 raise Exception("Tempest test list file %s NOT found."
                                 % conf_utils.TEMPEST_CUSTOM)
         else:
-            if self.MODE == 'smoke':
-                testr_mode = "smoke"
-            elif self.MODE == 'feature_multisite':
-                testr_mode = "'[Kk]ingbird'"
-            elif self.MODE == 'full':
-                testr_mode = ""
-            else:
-                testr_mode = 'tempest.api.' + self.MODE
-            cmd = ("cd {0};"
-                   "testr list-tests {1} > {2};"
-                   "cd -;".format(verifier_repo_dir,
-                                  testr_mode,
-                                  conf_utils.TEMPEST_RAW_LIST))
-            ft_utils.execute_command(cmd)
+            testr_mode = kwargs.get(
+                'mode', r'^tempest\.(api|scenario).*\[.*\bsmoke\b.*\]$')
+            cmd = "(cd {0}; stestr list '{1}' >{2} 2>/dev/null)".format(
+                self.verifier_repo_dir, testr_mode, self.list)
+            output = subprocess.check_output(cmd, shell=True)
+            LOGGER.info("%s\n%s", cmd, output)
+        os.remove('/etc/tempest.conf')
 
     def apply_tempest_blacklist(self):
-        logger.debug("Applying tempest blacklist...")
-        cases_file = self.read_file(conf_utils.TEMPEST_RAW_LIST)
-        result_file = open(conf_utils.TEMPEST_LIST, 'w')
+        """Exclude blacklisted test cases."""
+        LOGGER.debug("Applying tempest blacklist...")
+        if os.path.exists(self.raw_list):
+            os.remove(self.raw_list)
+        os.rename(self.list, self.raw_list)
+        cases_file = self.read_file(self.raw_list)
+        result_file = open(self.list, 'w')
         black_tests = []
         try:
-            installer_type = CONST.__getattribute__('INSTALLER_TYPE')
-            deploy_scenario = CONST.__getattribute__('DEPLOY_SCENARIO')
-            if (bool(installer_type) * bool(deploy_scenario)):
+            installer_type = env.get('INSTALLER_TYPE')
+            deploy_scenario = env.get('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)
@@ -98,9 +184,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:
@@ -110,188 +196,199 @@ class TempestCommon(testcase.OSGCTestCase):
                 result_file.write(str(cases_line) + '\n')
         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)
-
-        header = ("Tempest environment:\n"
-                  "  SUT: %s\n  Scenario: %s\n  Node: %s\n  Date: %s\n" %
-                  (CONST.__getattribute__('INSTALLER_TYPE'),
-                   CONST.__getattribute__('DEPLOY_SCENARIO'),
-                   CONST.__getattribute__('NODE_NAME'),
-                   time.strftime("%a %b %d %H:%M:%S %Z %Y")))
+    def run_verifier_tests(self, **kwargs):
+        """Execute tempest test cases."""
+        cmd = ["rally", "verify", "start", "--load-list",
+               self.list]
+        cmd.extend(kwargs.get('option', []))
+        LOGGER.info("Starting Tempest test suite: '%s'.", cmd)
 
         f_stdout = open(
-            os.path.join(conf_utils.TEMPEST_RESULTS_DIR, "tempest.log"), 'w+')
-        f_stderr = open(
-            os.path.join(conf_utils.TEMPEST_RESULTS_DIR,
-                         "tempest-error.log"), 'w+')
-        f_env = open(os.path.join(conf_utils.TEMPEST_RESULTS_DIR,
-                                  "environment.log"), 'w+')
-        f_env.write(header)
-
-        p = subprocess.Popen(
-            cmd_line, shell=True,
+            os.path.join(self.res_dir, "tempest.log"), 'w+')
+
+        proc = subprocess.Popen(
+            cmd,
             stdout=subprocess.PIPE,
-            stderr=f_stderr,
+            stderr=subprocess.STDOUT,
             bufsize=1)
 
-        with p.stdout:
-            for line in iter(p.stdout.readline, b''):
-                if re.search("\} tempest\.", line):
-                    logger.info(line.replace('\n', ''))
-                elif re.search('Starting verification', line):
-                    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)
+        with proc.stdout:
+            for line in iter(proc.stdout.readline, b''):
+                if re.search(r"\} tempest\.", line):
+                    LOGGER.info(line.rstrip())
+                elif re.search(r'(?=\(UUID=(.*)\))', line):
+                    self.verification_id = re.search(
+                        r'(?=\(UUID=(.*)\))', line).group(1)
                 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:
+        if self.verification_id is None:
             raise Exception('Verification UUID not found')
+        LOGGER.info('Verification UUID: %s', self.verification_id)
 
-        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]
+        shutil.copy(
+            "{}/tempest.log".format(self.deployment_dir),
+            "{}/tempest.debug.log".format(self.res_dir))
 
+    def parse_verifier_result(self):
+        """Parse and save test results."""
+        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,
+            with open(os.path.join(self.res_dir,
                                    "tempest.log"), 'r') as logfile:
                 output = logfile.read()
 
-            error_logs = ""
-            for match in re.findall('(.*?)[. ]*fail ', output):
-                error_logs += match
-            skipped_testcase = ""
-            for match in re.findall('(.*?)[. ]*skip:', output):
-                skipped_testcase += match
-
-            self.details = {"tests": int(num_tests),
-                            "failures": int(num_failures),
-                            "errors": error_logs,
-                            "skipped": skipped_testcase}
-        except Exception:
+            success_testcases = []
+            for match in re.findall(r'.*\{\d{1,2}\} (.*?) \.{3} success ',
+                                    output):
+                success_testcases.append(match)
+            failed_testcases = []
+            for match in re.findall(r'.*\{\d{1,2}\} (.*?) \.{3} fail',
+                                    output):
+                failed_testcases.append(match)
+            skipped_testcases = []
+            for match in re.findall(r'.*\{\d{1,2}\} (.*?) \.{3} skip:',
+                                    output):
+                skipped_testcases.append(match)
+
+            self.details = {"tests_number": stat['num_tests'],
+                            "success_number": stat['num_success'],
+                            "skipped_number": stat['num_skipped'],
+                            "failures_number": stat['num_failures'],
+                            "success": success_testcases,
+                            "skipped": skipped_testcases,
+                            "failures": failed_testcases}
+        except Exception:  # pylint: disable=broad-except
             self.result = 0
 
-        logger.info("Tempest %s success_rate is %s%%"
-                    % (self.case_name, self.result))
-
-    def run(self):
+        LOGGER.info("Tempest %s success_rate is %s%%",
+                    self.case_name, self.result)
+
+    def generate_report(self):
+        """Generate verification report."""
+        html_file = os.path.join(self.res_dir,
+                                 "tempest-report.html")
+        cmd = ["rally", "verify", "report", "--type", "html", "--uuid",
+               self.verification_id, "--to", html_file]
+        subprocess.Popen(cmd, stdout=subprocess.PIPE,
+                         stderr=subprocess.STDOUT)
+
+    def update_rally_regex(self, rally_conf='/etc/rally/rally.conf'):
+        """Set image name as tempest img_name_regex"""
+        rconfig = configparser.RawConfigParser()
+        rconfig.read(rally_conf)
+        if not rconfig.has_section('tempest'):
+            rconfig.add_section('tempest')
+        rconfig.set('tempest', 'img_name_regex', '^{}$'.format(
+            self.image.name))
+        with open(rally_conf, 'wb') as config_file:
+            rconfig.write(config_file)
+
+    def update_default_role(self, rally_conf='/etc/rally/rally.conf'):
+        """Detect and update the default role if required"""
+        role = self.get_default_role(self.cloud)
+        if not role:
+            return
+        rconfig = configparser.RawConfigParser()
+        rconfig.read(rally_conf)
+        if not rconfig.has_section('tempest'):
+            rconfig.add_section('tempest')
+        rconfig.set('tempest', 'swift_operator_role', role.name)
+        with open(rally_conf, 'wb') as config_file:
+            rconfig.write(config_file)
+
+    def update_rally_logs(self, rally_conf='/etc/rally/rally.conf'):
+        """Print rally logs in res dir"""
+        if not os.path.exists(self.res_dir):
+            os.makedirs(self.res_dir)
+        rconfig = configparser.RawConfigParser()
+        rconfig.read(rally_conf)
+        rconfig.set('DEFAULT', 'log-file', 'rally.log')
+        rconfig.set('DEFAULT', 'log_dir', self.res_dir)
+        with open(rally_conf, 'wb') as config_file:
+            rconfig.write(config_file)
 
+    @staticmethod
+    def clean_rally_conf(rally_conf='/etc/rally/rally.conf'):
+        """Clean Rally config"""
+        rconfig = configparser.RawConfigParser()
+        rconfig.read(rally_conf)
+        if rconfig.has_option('tempest', 'img_name_regex'):
+            rconfig.remove_option('tempest', 'img_name_regex')
+        if rconfig.has_option('tempest', 'swift_operator_role'):
+            rconfig.remove_option('tempest', 'swift_operator_role')
+        if rconfig.has_option('DEFAULT', 'log-file'):
+            rconfig.remove_option('DEFAULT', 'log-file')
+        if rconfig.has_option('DEFAULT', 'log_dir'):
+            rconfig.remove_option('DEFAULT', 'log_dir')
+        with open(rally_conf, 'wb') as config_file:
+            rconfig.write(config_file)
+
+    def configure(self, **kwargs):  # pylint: disable=unused-argument
+        """
+        Create all openstack resources for tempest-based testcases and write
+        tempest.conf.
+        """
+        if not os.path.exists(self.res_dir):
+            os.makedirs(self.res_dir)
+        compute_cnt = len(self.cloud.list_hypervisors())
+
+        self.image_alt = self.publish_image_alt()
+        self.flavor_alt = self.create_flavor_alt()
+        LOGGER.debug("flavor: %s", self.flavor_alt)
+
+        self.conf_file = conf_utils.configure_verifier(self.deployment_dir)
+        conf_utils.configure_tempest_update_params(
+            self.conf_file, network_name=self.network.name,
+            image_id=self.image.id,
+            flavor_id=self.flavor.id,
+            compute_cnt=compute_cnt,
+            image_alt_id=self.image_alt.id,
+            flavor_alt_id=self.flavor_alt.id)
+        self.backup_tempest_config(self.conf_file, self.res_dir)
+
+    def run(self, **kwargs):
         self.start_time = time.time()
         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()
-            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)
+            assert super(TempestCommon, self).run(
+                **kwargs) == testcase.TestCase.EX_OK
+            self.update_rally_regex()
+            self.update_default_role()
+            self.update_rally_logs()
+            shutil.copy("/etc/rally/rally.conf", self.res_dir)
+            self.configure(**kwargs)
+            self.generate_test_list(**kwargs)
             self.apply_tempest_blacklist()
-            self.run_verifier_tests()
+            self.run_verifier_tests(**kwargs)
             self.parse_verifier_result()
+            self.generate_report()
             res = testcase.TestCase.EX_OK
-        except Exception as e:
-            logger.error('Error with run: %s' % e)
+        except Exception:  # pylint: disable=broad-except
+            LOGGER.exception('Error with run')
+            self.result = 0
             res = testcase.TestCase.EX_RUN_ERROR
-
         self.stop_time = time.time()
         return res
 
-
-class TempestSmokeSerial(TempestCommon):
-
-    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"
-
-
-class TempestSmokeParallel(TempestCommon):
-
-    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 = ""
-
-
-class TempestFullParallel(TempestCommon):
-
-    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(
-            CONST.__getattribute__('dir_repo_kingbird'))
-
-
-class TempestCustom(TempestCommon):
-
-    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"
-
-
-class TempestDefcore(TempestCommon):
-
-    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"
+    def clean(self):
+        """
+        Cleanup all OpenStack objects. Should be called on completion.
+        """
+        self.clean_rally_conf()
+        if self.image_alt:
+            self.cloud.delete_image(self.image_alt)
+        if self.flavor_alt:
+            self.orig_cloud.delete_flavor(self.flavor_alt.id)
+        super(TempestCommon, self).clean()