Merge "Publish rally logs to ease debugging."
[functest.git] / functest / opnfv_tests / openstack / rally / rally.py
index 8d1bfab..4a63629 100644 (file)
@@ -18,44 +18,27 @@ import os
 import re
 import subprocess
 import time
-import uuid
 
-import os_client_config
 import pkg_resources
 import prettytable
 from xtesting.core import testcase
 from xtesting.energy import energy
 import yaml
 
+from functest.core import singlevm
 from functest.opnfv_tests.openstack.tempest import conf_utils
 from functest.utils import config
-from functest.utils import functest_utils
 from functest.utils import env
 
 LOGGER = logging.getLogger(__name__)
 
 
-class RallyBase(testcase.TestCase):
+class RallyBase(singlevm.VmReady1):
     """Base class form Rally testcases implementation."""
 
     # pylint: disable=too-many-instance-attributes
     TESTS = ['authenticate', 'glance', 'cinder', 'gnocchi', 'heat',
              'keystone', 'neutron', 'nova', 'quotas', 'vm', 'all']
-    GLANCE_IMAGE_NAME = getattr(config.CONF, 'openstack_image_name')
-    GLANCE_IMAGE_FILENAME = getattr(config.CONF, 'openstack_image_file_name')
-    GLANCE_IMAGE_PATH = os.path.join(getattr(
-        config.CONF, 'dir_functest_images'), GLANCE_IMAGE_FILENAME)
-    GLANCE_IMAGE_FORMAT = getattr(config.CONF, 'openstack_image_disk_format')
-    GLANCE_IMAGE_EXTRA_PROPERTIES = getattr(
-        config.CONF, 'image_properties', {})
-    FLAVOR_NAME = getattr(config.CONF, 'rally_flavor_name')
-    FLAVOR_ALT_NAME = getattr(config.CONF, 'rally_flavor_alt_name')
-    FLAVOR_RAM = 512
-    FLAVOR_RAM_ALT = 1024
-    FLAVOR_EXTRA_SPECS = getattr(config.CONF, 'flavor_extra_specs', {})
-    if FLAVOR_EXTRA_SPECS:
-        FLAVOR_RAM = 1024
-        FLAVOR_RAM_ALT = 2048
 
     RALLY_DIR = pkg_resources.resource_filename(
         'functest', 'opnfv_tests/openstack/rally')
@@ -73,45 +56,32 @@ class RallyBase(testcase.TestCase):
     BLACKLIST_FILE = os.path.join(RALLY_DIR, "blacklist.txt")
     TEMP_DIR = os.path.join(RALLY_DIR, "var")
 
-    RALLY_PRIVATE_NET_NAME = getattr(config.CONF, 'rally_network_name')
-    RALLY_PRIVATE_SUBNET_NAME = str(getattr(config.CONF, 'rally_subnet_name'))
-    RALLY_PRIVATE_SUBNET_CIDR = getattr(config.CONF, 'rally_subnet_cidr')
-    RALLY_ROUTER_NAME = getattr(config.CONF, 'rally_router_name')
+    visibility = 'public'
+    shared_network = True
 
     def __init__(self, **kwargs):
         """Initialize RallyBase object."""
         super(RallyBase, self).__init__(**kwargs)
-        self.cloud = os_client_config.make_shade()
-        self.guid = '-' + str(uuid.uuid4())
         self.creators = []
         self.mode = ''
         self.summary = []
         self.scenario_dir = ''
-        self.image_name = None
-        self.ext_net = None
-        self.flavor_name = None
-        self.flavor_alt_name = None
         self.smoke = None
         self.test_name = None
         self.start_time = None
         self.result = None
         self.details = None
         self.compute_cnt = 0
-        self.image = None
-        self.flavor = None
         self.flavor_alt = None
-        self.network = None
-        self.subnet = None
-        self.router = None
 
     def _build_task_args(self, test_file_name):
         """Build arguments for the Rally task."""
         task_args = {'service_list': [test_file_name]}
-        task_args['image_name'] = str(self.image_name)
-        task_args['flavor_name'] = str(self.flavor_name)
-        task_args['flavor_alt_name'] = str(self.flavor_alt_name)
-        task_args['glance_image_location'] = str(self.GLANCE_IMAGE_PATH)
-        task_args['glance_image_format'] = str(self.GLANCE_IMAGE_FORMAT)
+        task_args['image_name'] = str(self.image.name)
+        task_args['flavor_name'] = str(self.flavor.name)
+        task_args['flavor_alt_name'] = str(self.flavor_alt.name)
+        task_args['glance_image_location'] = str(self.filename)
+        task_args['glance_image_format'] = str(self.image_format)
         task_args['tmpl_dir'] = str(self.TEMPLATE_DIR)
         task_args['sup_dir'] = str(self.SUPPORT_DIR)
         task_args['users_amount'] = self.USERS_AMOUNT
@@ -181,14 +151,14 @@ class RallyBase(testcase.TestCase):
         :return: Bool
         """
         rally_report = json.loads(json_raw)
-        for report in rally_report:
-            if report is None or report.get('result') is None:
-                return False
-
-            for result in report.get('result'):
-                if result is None or result.get('error'):
+        tasks = rally_report.get('tasks')
+        if tasks:
+            for task in tasks:
+                if task.get('status') != 'finished' or \
+                   task.get('pass_sla') is not True:
                     return False
-
+        else:
+            return False
         return True
 
     def _migration_supported(self):
@@ -198,14 +168,6 @@ class RallyBase(testcase.TestCase):
 
         return False
 
-    @staticmethod
-    def get_cmd_output(proc):
-        """Get command stdout."""
-        result = ""
-        for line in proc.stdout:
-            result += line
-        return result
-
     @staticmethod
     def excl_scenario():
         """Exclude scenario."""
@@ -286,7 +248,7 @@ class RallyBase(testcase.TestCase):
                                self.excl_scenario()))
 
         if black_tests:
-            LOGGER.debug("Blacklisted tests: " + str(black_tests))
+            LOGGER.debug("Blacklisted tests: %s", str(black_tests))
 
         include = True
         for cases_line in cases_file:
@@ -316,6 +278,47 @@ class RallyBase(testcase.TestCase):
 
         return True
 
+    def _save_results(self, test_name, task_id):
+        """ Generate and save task execution results"""
+        # check for result directory and create it otherwise
+        if not os.path.exists(self.RESULTS_DIR):
+            LOGGER.debug('%s does not exist, we create it.',
+                         self.RESULTS_DIR)
+            os.makedirs(self.RESULTS_DIR)
+
+        # put detailed result to log
+        cmd = (["rally", "task", "detailed", "--uuid", task_id])
+        LOGGER.debug('running command: %s', cmd)
+        output = subprocess.check_output(cmd, stderr=subprocess.STDOUT)
+        LOGGER.info("%s\n%s", " ".join(cmd), output)
+
+        # save report as JSON
+        report_json_name = 'opnfv-{}.json'.format(test_name)
+        report_json_dir = os.path.join(self.RESULTS_DIR, report_json_name)
+        cmd = (["rally", "task", "report", "--json", "--uuid", task_id,
+                "--out", report_json_dir])
+        LOGGER.debug('running command: %s', cmd)
+        output = subprocess.check_output(cmd, stderr=subprocess.STDOUT)
+        LOGGER.info("%s\n%s", " ".join(cmd), output)
+
+        # save report as HTML
+        report_html_name = 'opnfv-{}.html'.format(test_name)
+        report_html_dir = os.path.join(self.RESULTS_DIR, report_html_name)
+        cmd = (["rally", "task", "report", "--html", "--uuid", task_id,
+                "--out", report_html_dir])
+        LOGGER.debug('running command: %s', cmd)
+        output = subprocess.check_output(cmd, stderr=subprocess.STDOUT)
+        LOGGER.info("%s\n%s", " ".join(cmd), output)
+
+        json_results = open(report_json_dir).read()
+        self._append_summary(json_results, test_name)
+
+        # parse JSON operation result
+        if self.task_succeed(json_results):
+            LOGGER.info('Test scenario: "%s" OK.', test_name)
+        else:
+            LOGGER.info('Test scenario: "%s" Failed.', test_name)
+
     def _run_task(self, test_name):
         """Run a task."""
         LOGGER.info('Starting test scenario "%s" ...', test_name)
@@ -323,7 +326,7 @@ class RallyBase(testcase.TestCase):
         task_file = os.path.join(self.RALLY_DIR, 'task.yaml')
         if not os.path.exists(task_file):
             LOGGER.error("Task file '%s' does not exist.", task_file)
-            raise Exception("Task file '%s' does not exist.", task_file)
+            raise Exception("Task file '{}' does not exist.".format(task_file))
 
         file_name = self._prepare_test_list(test_name)
         if self.file_is_empty(file_name):
@@ -334,64 +337,18 @@ class RallyBase(testcase.TestCase):
                 task_file, "--task-args",
                 str(self._build_task_args(test_name))])
         LOGGER.debug('running command: %s', cmd)
-
         proc = subprocess.Popen(cmd, stdout=subprocess.PIPE,
                                 stderr=subprocess.STDOUT)
-        output = self.get_cmd_output(proc)
-        task_id = self.get_task_id(output)
+        output = proc.communicate()[0]
 
+        task_id = self.get_task_id(output)
         LOGGER.debug('task_id : %s', task_id)
-
         if task_id is None:
-            LOGGER.error('Failed to retrieve task_id, validating task...')
-            cmd = (["rally", "task", "validate", "--task", task_file,
-                    "--task-args", str(self._build_task_args(test_name))])
-            LOGGER.debug('running command: %s', cmd)
-            proc = subprocess.Popen(cmd, stdout=subprocess.PIPE,
-                                    stderr=subprocess.STDOUT)
-            output = self.get_cmd_output(proc)
-            LOGGER.error("Task validation result:" + "\n" + output)
-            return
-
-        # check for result directory and create it otherwise
-        if not os.path.exists(self.RESULTS_DIR):
-            LOGGER.debug('%s does not exist, we create it.',
-                         self.RESULTS_DIR)
-            os.makedirs(self.RESULTS_DIR)
+            LOGGER.error("Failed to retrieve task_id")
+            LOGGER.error("Result:\n%s", output)
+            raise Exception("Failed to retrieve task id")
 
-        # get and save rally operation JSON result
-        cmd = (["rally", "task", "detailed", task_id])
-        LOGGER.debug('running command: %s', cmd)
-        proc = subprocess.Popen(cmd, stdout=subprocess.PIPE,
-                                stderr=subprocess.STDOUT)
-        json_detailed = self.get_cmd_output(proc)
-        LOGGER.info('%s', json_detailed)
-
-        cmd = (["rally", "task", "results", task_id])
-        LOGGER.debug('running command: %s', cmd)
-        proc = subprocess.Popen(cmd, stdout=subprocess.PIPE,
-                                stderr=subprocess.STDOUT)
-        json_results = self.get_cmd_output(proc)
-        self._append_summary(json_results, test_name)
-        report_json_name = 'opnfv-{}.json'.format(test_name)
-        report_json_dir = os.path.join(self.RESULTS_DIR, report_json_name)
-        with open(report_json_dir, 'w') as r_file:
-            LOGGER.debug('saving json file')
-            r_file.write(json_results)
-
-        # write html report file
-        report_html_name = 'opnfv-{}.html'.format(test_name)
-        report_html_dir = os.path.join(self.RESULTS_DIR, report_html_name)
-        cmd = (["rally", "task", "report", task_id, "--out", report_html_dir])
-        LOGGER.debug('running command: %s', cmd)
-        subprocess.Popen(cmd, stdout=subprocess.PIPE,
-                         stderr=subprocess.STDOUT)
-
-        # parse JSON operation result
-        if self.task_succeed(json_results):
-            LOGGER.info('Test scenario: "{}" OK.'.format(test_name) + "\n")
-        else:
-            LOGGER.info('Test scenario: "{}" Failed.'.format(test_name) + "\n")
+        self._save_results(test_name, task_id)
 
     def _append_summary(self, json_raw, test_name):
         """Update statistics summary info."""
@@ -400,20 +357,24 @@ class RallyBase(testcase.TestCase):
         overall_duration = 0.0
 
         rally_report = json.loads(json_raw)
-        for report in rally_report:
-            if report.get('full_duration'):
-                overall_duration += report.get('full_duration')
+        for task in rally_report.get('tasks'):
+            for subtask in task.get('subtasks'):
+                for workload in subtask.get('workloads'):
+                    if workload.get('full_duration'):
+                        overall_duration += workload.get('full_duration')
+
+                    if workload.get('data'):
+                        nb_tests += len(workload.get('data'))
 
-            if report.get('result'):
-                for result in report.get('result'):
-                    nb_tests += 1
-                    if not result.get('error'):
-                        nb_success += 1
+                    for result in workload.get('data'):
+                        if not result.get('error'):
+                            nb_success += 1
 
         scenario_summary = {'test_name': test_name,
                             'overall_duration': overall_duration,
                             'nb_tests': nb_tests,
-                            'nb_success': nb_success}
+                            'nb_success': nb_success,
+                            'task_status': self.task_succeed(json_raw)}
         self.summary.append(scenario_summary)
 
     def _prepare_env(self):
@@ -423,75 +384,9 @@ class RallyBase(testcase.TestCase):
         if self.test_name not in self.TESTS:
             raise Exception("Test name '%s' is invalid" % self.test_name)
 
-        network_name = self.RALLY_PRIVATE_NET_NAME + self.guid
-        subnet_name = self.RALLY_PRIVATE_SUBNET_NAME + self.guid
-        router_name = self.RALLY_ROUTER_NAME + self.guid
-        self.image_name = self.GLANCE_IMAGE_NAME + self.guid
-        self.flavor_name = self.FLAVOR_NAME + self.guid
-        self.flavor_alt_name = self.FLAVOR_ALT_NAME + self.guid
         self.compute_cnt = len(self.cloud.list_hypervisors())
-        self.ext_net = functest_utils.get_external_network(self.cloud)
-        if self.ext_net is None:
-            raise Exception("No external network found")
-
-        LOGGER.debug("Creating image '%s'...", self.image_name)
-        self.image = self.cloud.create_image(
-            self.image_name,
-            filename=self.GLANCE_IMAGE_PATH,
-            disk_format=self.GLANCE_IMAGE_FORMAT,
-            meta=self.GLANCE_IMAGE_EXTRA_PROPERTIES,
-            is_public=True)
-        if self.image is None:
-            raise Exception("Failed to create image")
-
-        LOGGER.debug("Creating network '%s'...", network_name)
-        provider = {}
-        if hasattr(config.CONF, 'rally_network_type'):
-            provider["network_type"] = getattr(
-                config.CONF, 'rally_network_type')
-        if hasattr(config.CONF, 'rally_physical_network'):
-            provider["physical_network"] = getattr(
-                config.CONF, 'rally_physical_network')
-        if hasattr(config.CONF, 'rally_segmentation_id'):
-            provider["segmentation_id"] = getattr(
-                config.CONF, 'rally_segmentation_id')
-
-        self.network = self.cloud.create_network(
-            network_name, shared=True, provider=provider)
-        if self.network is None:
-            raise Exception("Failed to create private network")
-
-        self.subnet = self.cloud.create_subnet(
-            self.network.id,
-            subnet_name=subnet_name,
-            cidr=self.RALLY_PRIVATE_SUBNET_CIDR,
-            enable_dhcp=True,
-            dns_nameservers=[env.get('NAMESERVER')])
-        if self.subnet is None:
-            raise Exception("Failed to create private subnet")
-
-        LOGGER.debug("Creating router '%s'...", router_name)
-        self.router = self.cloud.create_router(
-            router_name, ext_gateway_net_id=self.ext_net.id)
-        if self.router is None:
-            raise Exception("Failed to create router")
-        self.cloud.add_router_interface(self.router, subnet_id=self.subnet.id)
-
-        LOGGER.debug("Creating flavor '%s'...", self.flavor_name)
-        self.flavor = self.cloud.create_flavor(
-            self.flavor_name, self.FLAVOR_RAM, 1, 1)
-        if self.flavor is None:
-            raise Exception("Failed to create flavor")
-        self.cloud.set_flavor_specs(
-            self.flavor.id, self.FLAVOR_EXTRA_SPECS)
-
-        LOGGER.debug("Creating flavor '%s'...", self.flavor_alt_name)
-        self.flavor_alt = self.cloud.create_flavor(
-            self.flavor_alt_name, self.FLAVOR_RAM_ALT, 1, 1)
-        if self.flavor_alt is None:
-            raise Exception("Failed to create flavor")
-        self.cloud.set_flavor_specs(
-            self.flavor_alt.id, self.FLAVOR_EXTRA_SPECS)
+        self.flavor_alt = self.create_flavor_alt()
+        LOGGER.debug("flavor: %s", self.flavor_alt)
 
     def _run_tests(self):
         """Execute tests."""
@@ -508,6 +403,7 @@ class RallyBase(testcase.TestCase):
         total_duration = 0.0
         total_nb_tests = 0
         total_nb_success = 0
+        nb_modules = 0
         payload = []
 
         res_table = prettytable.PrettyTable(
@@ -519,6 +415,8 @@ class RallyBase(testcase.TestCase):
 
         # for each scenario we draw a row for the table
         for item in self.summary:
+            if item['task_status'] is True:
+                nb_modules += 1
             total_duration += item['overall_duration']
             total_nb_tests += item['nb_tests']
             total_nb_success += item['nb_success']
@@ -549,35 +447,35 @@ class RallyBase(testcase.TestCase):
                            success_rate_str])
 
         LOGGER.info("Rally Summary Report:\n\n%s\n", res_table.get_string())
-        LOGGER.info("Rally '%s' success_rate is %s%%",
-                    self.case_name, success_rate)
+        LOGGER.info("Rally '%s' success_rate is %s%% in %s/%s modules",
+                    self.case_name, success_rate, nb_modules,
+                    len(self.summary))
         payload.append({'summary': {'duration': total_duration,
                                     'nb tests': total_nb_tests,
                                     'nb success': success_rate}})
         self.details = payload
 
-    def _clean_up(self):
+    def clean(self):
         """Cleanup of OpenStack resources. Should be called on completion."""
         if self.flavor_alt:
-            self.cloud.delete_flavor(self.flavor_alt.id)
-        if self.flavor:
-            self.cloud.delete_flavor(self.flavor.id)
-        if self.router and self.subnet:
-            self.cloud.remove_router_interface(self.router, self.subnet.id)
-        if self.router:
-            self.cloud.delete_router(self.router.id)
-        if self.subnet:
-            self.cloud.delete_subnet(self.subnet.id)
-        if self.network:
-            self.cloud.delete_network(self.network.id)
-        if self.image:
-            self.cloud.delete_image(self.image.id)
+            self.orig_cloud.delete_flavor(self.flavor_alt.id)
+        super(RallyBase, self).clean()
+
+    def is_successful(self):
+        """The overall result of the test."""
+        for item in self.summary:
+            if item['task_status'] is False:
+                return testcase.TestCase.EX_TESTCASE_FAILED
+
+        return super(RallyBase, self).is_successful()
 
     @energy.enable_recording
     def run(self, **kwargs):
         """Run testcase."""
         self.start_time = time.time()
         try:
+            assert super(RallyBase, self).run(
+                **kwargs) == testcase.TestCase.EX_OK
             conf_utils.create_rally_deployment()
             self._prepare_env()
             self._run_tests()
@@ -585,10 +483,8 @@ class RallyBase(testcase.TestCase):
             res = testcase.TestCase.EX_OK
         except Exception as exc:   # pylint: disable=broad-except
             LOGGER.error('Error with run: %s', exc)
+            self.result = 0
             res = testcase.TestCase.EX_RUN_ERROR
-        finally:
-            self._clean_up()
-
         self.stop_time = time.time()
         return res