aboutsummaryrefslogtreecommitdiffstats
path: root/functest/opnfv_tests/openstack/rally/rally.py
blob: 548e774a16b1bcd8c1eeb604435397253cd1f9fd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
#!/usr/bin/env python
#
# Copyright (c) 2015 All rights reserved
# This program and the accompanying materials
# are made available under the terms of the Apache License, Version 2.0
# which accompanies this distribution, and is available at
#
# http://www.apache.org/licenses/LICENSE-2.0
#

"""Rally testcases implementation."""

from __future__ import division
from __future__ import print_function

import fileinput
import json
import logging
import os
import re
import shutil
import subprocess
import time

import pkg_resources
import prettytable
from ruamel.yaml import YAML
import six
from six.moves import configparser
from xtesting.core import testcase
import yaml

from functest.core import singlevm
from functest.utils import config
from functest.utils import env
from functest.utils import functest_utils

LOGGER = logging.getLogger(__name__)


class RallyBase(singlevm.VmReady2):
    """Base class form Rally testcases implementation."""

    # pylint: disable=too-many-instance-attributes, too-many-public-methods
    stests = ['authenticate', 'glance', 'cinder', 'gnocchi', 'heat',
              'keystone', 'neutron', 'nova', 'quotas', 'swift', 'barbican',
              'vm']

    rally_conf_path = "/etc/rally/rally.conf"
    rally_aar4_patch_path = pkg_resources.resource_filename(
        'functest', 'ci/rally_aarch64_patch.conf')
    rally_dir = pkg_resources.resource_filename(
        'functest', 'opnfv_tests/openstack/rally')
    rally_scenario_dir = pkg_resources.resource_filename(
        'functest', 'opnfv_tests/openstack/rally/scenario')
    template_dir = pkg_resources.resource_filename(
        'functest', 'opnfv_tests/openstack/rally/scenario/templates')
    support_dir = pkg_resources.resource_filename(
        'functest', 'opnfv_tests/openstack/rally/scenario/support')
    users_amount = 2
    tenants_amount = 3
    iterations_amount = 10
    concurrency = 4
    volume_version = 3
    volume_service_type = "volumev3"
    blacklist_file = os.path.join(rally_dir, "blacklist.yaml")
    task_dir = os.path.join(getattr(config.CONF, 'dir_rally_data'), 'task')
    temp_dir = os.path.join(task_dir, 'var')

    visibility = 'public'
    shared_network = True
    task_timeout = 3600
    username = 'cirros'

    def __init__(self, **kwargs):
        """Initialize RallyBase object."""
        super(RallyBase, self).__init__(**kwargs)
        assert self.orig_cloud
        assert self.project
        if self.orig_cloud.get_role("admin"):
            role_name = "admin"
        elif self.orig_cloud.get_role("Admin"):
            role_name = "Admin"
        else:
            raise Exception("Cannot detect neither admin nor Admin")
        self.orig_cloud.grant_role(
            role_name, user=self.project.user.id,
            project=self.project.project.id,
            domain=self.project.domain.id)
        self.results_dir = os.path.join(
            getattr(config.CONF, 'dir_results'), self.case_name)
        self.task_file = ''
        self.creators = []
        self.summary = []
        self.scenario_dir = ''
        self.smoke = None
        self.start_time = None
        self.result = None
        self.compute_cnt = 0
        self.flavor_alt = None
        self.tests = []
        self.run_cmd = ''
        self.network_extensions = []
        self.services = []

    def build_task_args(self, test_name):
        """Build arguments for the Rally task."""
        task_args = {'service_list': [test_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.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
        task_args['tenants_amount'] = self.tenants_amount
        task_args['use_existing_users'] = False
        task_args['iterations'] = self.iterations_amount
        task_args['concurrency'] = self.concurrency
        task_args['smoke'] = self.smoke
        task_args['volume_version'] = self.volume_version
        task_args['volume_service_type'] = self.volume_service_type
        task_args['block_migration'] = env.get("BLOCK_MIGRATION").lower()
        task_args['username'] = self.username

        if self.ext_net:
            task_args['floating_network'] = str(self.ext_net.name)
        else:
            task_args['floating_network'] = ''

        if self.network:
            task_args['netid'] = str(self.network.id)
        else:
            LOGGER.warning(
                'No tenant network created. '
                'Trying EXTERNAL_NETWORK as a fallback')
            if env.get("EXTERNAL_NETWORK"):
                network = self.cloud.get_network(env.get("EXTERNAL_NETWORK"))
                task_args['netid'] = str(network.id) if network else ''
            else:
                task_args['netid'] = ''

        return task_args

    def _prepare_test_list(self, test_name):
        """Build the list of test cases to be executed."""
        test_yaml_file_name = 'opnfv-{}.yaml'.format(test_name)
        scenario_file_name = os.path.join(self.rally_scenario_dir,
                                          test_yaml_file_name)

        if not os.path.exists(scenario_file_name):
            scenario_file_name = os.path.join(self.scenario_dir,
                                              test_yaml_file_name)

            if not os.path.exists(scenario_file_name):
                raise Exception("The scenario '%s' does not exist."
                                % scenario_file_name)

        LOGGER.debug('Scenario fetched from : %s', scenario_file_name)
        test_file_name = os.path.join(self.temp_dir, test_yaml_file_name)

        if not os.path.exists(self.temp_dir):
            os.makedirs(self.temp_dir)

        self.apply_blacklist(scenario_file_name, test_file_name)
        return test_file_name

    @staticmethod
    def get_verifier_deployment_id():
        """
        Returns deployment id for active Rally deployment
        """
        cmd = ("rally deployment list | awk '/" +
               getattr(config.CONF, 'rally_deployment_name') +
               "/ {print $2}'")
        proc = subprocess.Popen(cmd, shell=True,
                                stdout=subprocess.PIPE,
                                stderr=subprocess.STDOUT)
        deployment_uuid = proc.stdout.readline().rstrip()
        return deployment_uuid.decode("utf-8")

    @staticmethod
    def create_rally_deployment(environ=None):
        # pylint: disable=unexpected-keyword-arg
        """Create new rally deployment"""
        # set the architecture to default
        pod_arch = env.get("POD_ARCH")
        arch_filter = ['aarch64']

        if pod_arch and pod_arch in arch_filter:
            LOGGER.info("Apply aarch64 specific to rally config...")
            with open(RallyBase.rally_aar4_patch_path, "r") as pfile:
                rally_patch_conf = pfile.read()

            for line in fileinput.input(RallyBase.rally_conf_path):
                print(line, end=' ')
                if "cirros|testvm" in line:
                    print(rally_patch_conf)

        LOGGER.info("Creating Rally environment...")
        try:
            cmd = ['rally', 'deployment', 'destroy',
                   '--deployment',
                   str(getattr(config.CONF, 'rally_deployment_name'))]
            output = subprocess.check_output(cmd)
            LOGGER.info("%s\n%s", " ".join(cmd), output.decode("utf-8"))
        except subprocess.CalledProcessError:
            pass

        cmd = ['rally', 'deployment', 'create', '--fromenv',
               '--name', str(getattr(config.CONF, 'rally_deployment_name'))]
        output = subprocess.check_output(cmd, env=environ)
        LOGGER.info("%s\n%s", " ".join(cmd), output.decode("utf-8"))

        cmd = ['rally', 'deployment', 'check']
        output = subprocess.check_output(cmd)
        LOGGER.info("%s\n%s", " ".join(cmd), output.decode("utf-8"))
        return RallyBase.get_verifier_deployment_id()

    @staticmethod
    def update_keystone_default_role(rally_conf='/etc/rally/rally.conf'):
        """Set keystone_default_role in rally.conf"""
        if env.get("NEW_USER_ROLE").lower() != "member":
            rconfig = configparser.RawConfigParser()
            rconfig.read(rally_conf)
            if not rconfig.has_section('openstack'):
                rconfig.add_section('openstack')
            rconfig.set(
                'openstack', 'keystone_default_role', env.get("NEW_USER_ROLE"))
            with open(rally_conf, 'w') as config_file:
                rconfig.write(config_file)

    @staticmethod
    def clean_rally_conf(rally_conf='/etc/rally/rally.conf'):
        """Clean Rally config"""
        if env.get("NEW_USER_ROLE").lower() != "member":
            rconfig = configparser.RawConfigParser()
            rconfig.read(rally_conf)
            if rconfig.has_option('openstack', 'keystone_default_role'):
                rconfig.remove_option('openstack', 'keystone_default_role')
            with open(rally_conf, 'w') as config_file:
                rconfig.write(config_file)

    @staticmethod
    def get_task_id(tag):
        """
        Get task id from command rally result.

        :param tag:
        :return: task_id as string
        """
        cmd = ["rally", "task", "list", "--tag", tag, "--uuids-only"]
        output = subprocess.check_output(cmd).decode("utf-8").rstrip()
        LOGGER.info("%s: %s", " ".join(cmd), output)
        return output

    @staticmethod
    def task_succeed(json_raw):
        """
        Parse JSON from rally JSON results.

        :param json_raw:
        :return: Bool
        """
        rally_report = json.loads(json_raw)
        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):
        """Determine if migration is supported."""
        if self.compute_cnt > 1:
            return True
        return False

    def _network_trunk_supported(self):
        """Determine if network trunk service is available"""
        if 'trunk' in self.network_extensions:
            return True
        return False

    @staticmethod
    def excl_scenario():
        """Exclude scenario."""
        black_tests = []
        try:
            with open(RallyBase.blacklist_file, 'r') as black_list_file:
                black_list_yaml = yaml.safe_load(black_list_file)

            deploy_scenario = env.get('DEPLOY_SCENARIO')
            if (bool(deploy_scenario) and
                    'scenario' in black_list_yaml.keys()):
                for item in black_list_yaml['scenario']:
                    scenarios = item['scenarios']
                    in_it = RallyBase.in_iterable_re
                    if in_it(deploy_scenario, scenarios):
                        tests = item['tests']
                        black_tests.extend(tests)
        except Exception:  # pylint: disable=broad-except
            LOGGER.debug("Scenario exclusion not applied.")

        return black_tests

    @staticmethod
    def in_iterable_re(needle, haystack):
        """
        Check if given needle is in the iterable haystack, using regex.

        :param needle: string to be matched
        :param haystack: iterable of strings (optionally regex patterns)
        :return: True if needle is eqial to any of the elements in haystack,
                 or if a nonempty regex pattern in haystack is found in needle.
        """
        # match without regex
        if needle in haystack:
            return True

        for pattern in haystack:
            # match if regex pattern is set and found in the needle
            if pattern and re.search(pattern, needle) is not None:
                return True

        return False

    def excl_func(self):
        """Exclude functionalities."""
        black_tests = []
        func_list = []

        try:
            with open(RallyBase.blacklist_file, 'r') as black_list_file:
                black_list_yaml = yaml.safe_load(black_list_file)

            if env.get('BLOCK_MIGRATION').lower() == 'true':
                func_list.append("block_migration")
            if not self._migration_supported():
                func_list.append("no_migration")
            if not self._network_trunk_supported():
                func_list.append("no_net_trunk_service")
            if not self.ext_net:
                func_list.append("no_floating_ip")

            if 'functionality' in black_list_yaml.keys():
                for item in black_list_yaml['functionality']:
                    functions = item['functions']
                    for func in func_list:
                        if func in functions:
                            tests = item['tests']
                            black_tests.extend(tests)
        except Exception:  # pylint: disable=broad-except
            LOGGER.debug("Functionality exclusion not applied.")

        return black_tests

    def apply_blacklist(self, case_file_name, result_file_name):
        """Apply blacklist."""
        LOGGER.debug("Applying blacklist...")
        cases_file = open(case_file_name, 'r')
        result_file = open(result_file_name, 'w')

        black_tests = list(set(self.excl_func() +
                               self.excl_scenario()))

        if black_tests:
            LOGGER.debug("Blacklisted tests: %s", str(black_tests))

        include = True
        for cases_line in cases_file:
            if include:
                for black_tests_line in black_tests:
                    if re.search(black_tests_line,
                                 cases_line.strip().rstrip(':')):
                        include = False
                        break
                else:
                    result_file.write(str(cases_line))
            else:
                if cases_line.isspace():
                    include = True

        cases_file.close()
        result_file.close()

    @staticmethod
    def file_is_empty(file_name):
        """Determine is a file is empty."""
        try:
            if os.stat(file_name).st_size > 0:
                return False
        except Exception:  # pylint: disable=broad-except
            pass

        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.decode("utf-8"))

        # save report as JSON
        report_json_name = '{}.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.decode("utf-8"))

        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)
        LOGGER.debug('running command: %s', self.run_cmd)
        if six.PY3:
            subprocess.call(
                self.run_cmd, timeout=self.task_timeout,
                stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
        else:
            with open(os.devnull, 'wb') as devnull:
                subprocess.call(self.run_cmd, stdout=devnull, stderr=devnull)
        task_id = self.get_task_id(test_name)
        LOGGER.debug('task_id : %s', task_id)
        if not task_id:
            LOGGER.error("Failed to retrieve task_id")
            raise Exception("Failed to retrieve task id")
        self._save_results(test_name, task_id)

    def _append_summary(self, json_raw, test_name):
        # pylint: disable=too-many-locals
        """Update statistics summary info."""
        nb_tests = 0
        nb_success = 0
        overall_duration = 0.0
        success = []
        failures = []

        rally_report = json.loads(json_raw)
        for task in rally_report.get('tasks'):
            for subtask in task.get('subtasks'):
                has_errors = False
                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'))

                    for result in workload.get('data'):
                        if not result.get('error'):
                            nb_success += 1
                        else:
                            has_errors = True

                if has_errors:
                    failures.append(subtask['title'])
                else:
                    success.append(subtask['title'])

        scenario_summary = {'test_name': test_name,
                            'overall_duration': overall_duration,
                            'nb_tests': nb_tests,
                            'nb_success': nb_success,
                            'success': success,
                            'failures': failures,
                            'task_status': self.task_succeed(json_raw)}
        self.summary.append(scenario_summary)

    def prepare_run(self, **kwargs):
        """Prepare resources needed by test scenarios."""
        assert self.cloud
        LOGGER.debug('Validating run tests...')
        for test in kwargs.get('tests', self.stests):
            if test in self.stests:
                self.tests.append(test)
            else:
                raise Exception("Test name '%s' is invalid" % test)

        if not os.path.exists(self.task_dir):
            os.makedirs(self.task_dir)

        task = os.path.join(self.rally_dir, 'task.yaml')
        if not os.path.exists(task):
            LOGGER.error("Task file '%s' does not exist.", task)
            raise Exception("Task file '{}' does not exist.".
                            format(task))
        self.task_file = os.path.join(self.task_dir, 'task.yaml')
        shutil.copyfile(task, self.task_file)

        task_macro = os.path.join(self.rally_dir, 'macro')
        if not os.path.exists(task_macro):
            LOGGER.error("Task macro dir '%s' does not exist.", task_macro)
            raise Exception("Task macro dir '{}' does not exist.".
                            format(task_macro))
        macro_dir = os.path.join(self.task_dir, 'macro')
        if os.path.exists(macro_dir):
            shutil.rmtree(macro_dir)
        shutil.copytree(task_macro, macro_dir)

        self.update_keystone_default_role()
        self.compute_cnt = self.count_hypervisors()
        self.network_extensions = self.cloud.get_network_extensions()
        self.flavor_alt = self.create_flavor_alt()
        self.services = [service.name for service in
                         functest_utils.list_services(self.cloud)]

        LOGGER.debug("flavor: %s", self.flavor_alt)

    def prepare_task(self, test_name):
        """Prepare resources for test run."""
        file_name = self._prepare_test_list(test_name)
        if self.file_is_empty(file_name):
            LOGGER.info('No tests for scenario "%s"', test_name)
            return False
        self.run_cmd = (["rally", "task", "start", "--tag", test_name,
                         "--abort-on-sla-failure",
                         "--task", self.task_file, "--task-args",
                         str(self.build_task_args(test_name))])
        return True

    def run_tests(self, **kwargs):
        """Execute tests."""
        optional = kwargs.get('optional', [])
        for test in self.tests:
            if test in self.services or test not in optional:
                if self.prepare_task(test):
                    self.run_task(test)

    def _generate_report(self):
        """Generate test execution summary report."""
        total_duration = 0.0
        total_nb_tests = 0
        total_nb_success = 0
        nb_modules = 0
        payload = []

        res_table = prettytable.PrettyTable(
            padding_width=2,
            field_names=['Module', 'Duration', 'nb. Test Run', 'Success'])
        res_table.align['Module'] = "l"
        res_table.align['Duration'] = "r"
        res_table.align['Success'] = "r"

        # 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']
            try:
                success_avg = 100 * item['nb_success'] / item['nb_tests']
            except ZeroDivisionError:
                success_avg = 0
            success_str = str("{:0.2f}".format(success_avg)) + '%'
            duration_str = time.strftime("%H:%M:%S",
                                         time.gmtime(item['overall_duration']))
            res_table.add_row([item['test_name'], duration_str,
                               item['nb_tests'], success_str])
            payload.append({'module': item['test_name'],
                            'details': {'duration': item['overall_duration'],
                                        'nb tests': item['nb_tests'],
                                        'success rate': success_str,
                                        'success': item['success'],
                                        'failures': item['failures']}})

        total_duration_str = time.strftime("%H:%M:%S",
                                           time.gmtime(total_duration))
        try:
            self.result = 100 * total_nb_success / total_nb_tests
        except ZeroDivisionError:
            self.result = 100
        success_rate = "{:0.2f}".format(self.result)
        success_rate_str = str(success_rate) + '%'
        res_table.add_row(["", "", "", ""])
        res_table.add_row(["TOTAL:", total_duration_str, total_nb_tests,
                           success_rate_str])

        LOGGER.info("Rally Summary Report:\n\n%s\n", res_table.get_string())
        LOGGER.info("Rally '%s' success_rate is %s%% in %s/%s modules",
                    self.case_name, success_rate, nb_modules,
                    len(self.summary))
        self.details['summary'] = {'duration': total_duration,
                                   'nb tests': total_nb_tests,
                                   'nb success': success_rate}
        self.details["modules"] = payload

    @staticmethod
    def export_task(file_name, export_type="html"):
        """Export all task results (e.g. html or xunit report)

        Raises:
            subprocess.CalledProcessError: if Rally doesn't return 0

        Returns:
            None
        """
        cmd = ["rally", "task", "export", "--type", export_type,
               "--deployment",
               str(getattr(config.CONF, 'rally_deployment_name')),
               "--to", file_name]
        LOGGER.debug('running command: %s', cmd)
        output = subprocess.check_output(cmd, stderr=subprocess.STDOUT)
        LOGGER.info("%s\n%s", " ".join(cmd), output.decode("utf-8"))

    @staticmethod
    def verify_report(file_name, uuid, export_type="html"):
        """Generate the verifier report (e.g. html or xunit report)

        Raises:
            subprocess.CalledProcessError: if Rally doesn't return 0

        Returns:
            None
        """
        cmd = ["rally", "verify", "report", "--type", export_type,
               "--uuid", uuid, "--to", file_name]
        LOGGER.debug('running command: %s', cmd)
        output = subprocess.check_output(cmd, stderr=subprocess.STDOUT)
        LOGGER.info("%s\n%s", " ".join(cmd), output.decode("utf-8"))

    def clean(self):
        """Cleanup of OpenStack resources. Should be called on completion."""
        self.clean_rally_conf()
        self.clean_rally_logs()
        if self.flavor_alt:
            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()

    @staticmethod
    def update_rally_logs(res_dir, rally_conf='/etc/rally/rally.conf'):
        """Print rally logs in res dir"""
        if not os.path.exists(res_dir):
            os.makedirs(res_dir)
        rconfig = configparser.RawConfigParser()
        rconfig.read(rally_conf)
        rconfig.set('DEFAULT', 'debug', True)
        rconfig.set('DEFAULT', 'use_stderr', False)
        rconfig.set('DEFAULT', 'log-file', 'rally.log')
        rconfig.set('DEFAULT', 'log_dir', res_dir)
        with open(rally_conf, 'w') as config_file:
            rconfig.write(config_file)

    @staticmethod
    def clean_rally_logs(rally_conf='/etc/rally/rally.conf'):
        """Clean Rally config"""
        rconfig = configparser.RawConfigParser()
        rconfig.read(rally_conf)
        if rconfig.has_option('DEFAULT', 'use_stderr'):
            rconfig.remove_option('DEFAULT', 'use_stderr')
        if rconfig.has_option('DEFAULT', 'debug'):
            rconfig.remove_option('DEFAULT', 'debug')
        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, 'w') as config_file:
            rconfig.write(config_file)

    def run(self, **kwargs):
        """Run testcase."""
        self.start_time = time.time()
        try:
            assert super(RallyBase, self).run(
                **kwargs) == testcase.TestCase.EX_OK
            self.update_rally_logs(self.res_dir)
            self.create_rally_deployment(environ=self.project.get_environ())
            self.prepare_run(**kwargs)
            self.run_tests(**kwargs)
            self._generate_report()
            self.export_task(
                "{}/{}.html".format(self.results_dir, self.case_name))
            self.export_task(
                "{}/{}.xml".format(self.results_dir, self.case_name),
                export_type="junit-xml")
            res = testcase.TestCase.EX_OK
        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 RallySanity(RallyBase):
    """Rally sanity testcase implementation."""

    def __init__(self, **kwargs):
        """Initialize RallySanity object."""
        if "case_name" not in kwargs:
            kwargs["case_name"] = "rally_sanity"
        super(RallySanity, self).__init__(**kwargs)
        self.smoke = True
        self.scenario_dir = os.path.join(self.rally_scenario_dir, 'sanity')


class RallyFull(RallyBase):
    """Rally full testcase implementation."""

    task_timeout = 7200

    def __init__(self, **kwargs):
        """Initialize RallyFull object."""
        if "case_name" not in kwargs:
            kwargs["case_name"] = "rally_full"
        super(RallyFull, self).__init__(**kwargs)
        self.smoke = False
        self.scenario_dir = os.path.join(self.rally_scenario_dir, 'full')


class RallyJobs(RallyBase):
    """Rally OpenStack CI testcase implementation."""

    stests = ["neutron"]
    task_timeout = 7200

    def __init__(self, **kwargs):
        """Initialize RallyJobs object."""
        if "case_name" not in kwargs:
            kwargs["case_name"] = "rally_jobs"
        super(RallyJobs, self).__init__(**kwargs)
        self.task_file = os.path.join(self.rally_dir, 'rally_jobs.yaml')
        self.task_yaml = None

    def prepare_run(self, **kwargs):
        """Create resources needed by test scenarios."""
        super(RallyJobs, self).prepare_run(**kwargs)
        with open(os.path.join(self.rally_dir,
                               'rally_jobs.yaml'), 'r') as task_file:
            self.task_yaml = yaml.safe_load(task_file)

        for task in self.task_yaml:
            if task not in self.tests:
                raise Exception("Test '%s' not in '%s'" %
                                (task, self.tests))

    def apply_blacklist(self, case_file_name, result_file_name):
        # pylint: disable=too-many-branches
        """Apply blacklist."""
        LOGGER.debug("Applying blacklist...")
        black_tests = list(set(self.excl_func() +
                               self.excl_scenario()))
        if black_tests:
            LOGGER.debug("Blacklisted tests: %s", str(black_tests))

        template = YAML(typ='jinja2')
        with open(case_file_name, 'r') as fname:
            cases = template.load(fname)
        if cases.get("version", 1) == 1:
            # scenarios in dictionary
            for name in cases.keys():
                if self.in_iterable_re(name, black_tests):
                    cases.pop(name)
        else:
            # workloads in subtasks
            for sind, subtask in reversed(list(
                    enumerate(cases.get('subtasks', [])))):
                for wind, workload in reversed(list(
                        enumerate(subtask.get('workloads', [])))):
                    scenario = workload.get('scenario', {})
                    for name in scenario.keys():
                        if self.in_iterable_re(name, black_tests):
                            cases['subtasks'][sind]['workloads'].pop(wind)
                            break
                if 'workloads' in cases['subtasks'][sind]:
                    if not cases['subtasks'][sind]['workloads']:
                        cases['subtasks'].pop(sind)
            # scenarios in subtasks
            for sind, subtask in reversed(list(
                    enumerate(cases.get('subtasks', [])))):
                scenario = subtask.get('scenario', {})
                for name in scenario.keys():
                    if self.in_iterable_re(name, black_tests):
                        cases['subtasks'].pop(sind)
                        break

        with open(result_file_name, 'w') as fname:
            template.dump(cases, fname)

    def build_task_args(self, test_name):
        """Build arguments for the Rally task."""
        task_args = {}
        if self.ext_net:
            task_args['floating_network'] = str(self.ext_net.name)
        else:
            task_args['floating_network'] = ''
        task_args['image_name'] = str(self.image.name)
        task_args['flavor_name'] = str(self.flavor.name)
        return task_args

    def prepare_task(self, test_name):
        """Prepare resources for test run."""
        jobs_dir = os.path.join(
            getattr(config.CONF, 'dir_rally_data'), test_name, 'rally-jobs')
        task_name = self.task_yaml.get(test_name).get("task")
        task = os.path.join(jobs_dir, task_name)
        if not os.path.exists(task):
            raise Exception("The scenario '%s' does not exist." % task)
        LOGGER.debug('Scenario fetched from : %s', task)

        if not os.path.exists(self.temp_dir):
            os.makedirs(self.temp_dir)
        task_file_name = os.path.join(self.temp_dir, task_name)
        self.apply_blacklist(task, task_file_name)
        self.run_cmd = (["rally", "task", "start", "--tag", test_name,
                         "--task", task_file_name,
                         "--task-args", str(self.build_task_args(test_name))])
        return True