summaryrefslogtreecommitdiffstats
path: root/dovetail/test_runner.py
blob: 228432a50f164f6866839392c935fa1460bb7e9a (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
#!/usr/bin/env python
#
# Copyright (c) 2018 grakiss.wanglei@huawei.com and others.
# 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
#

import json
import os

import jinja2
import jinja2.meta
import yaml

from container import Container
from dovetail import constants
from utils.dovetail_config import DovetailConfig as dt_cfg
import utils.dovetail_utils as dt_utils
import utils.dovetail_logger as dt_logger


class Runner(object):

    logger = None

    def __init__(self, testcase):
        self.testcase = testcase
        self.logger.debug('Create runner: {}'.format(self.type))

    def archive_logs(self):
        result_path = os.path.join(os.environ['DOVETAIL_HOME'], 'results')
        src_files = dt_utils.get_value_from_dict(
            'report.source_archive_files', self.testcase.testcase)
        dest_files = dt_utils.get_value_from_dict(
            'report.dest_archive_files', self.testcase.testcase)
        if not src_files and not dest_files:
            return True
        if not (src_files and dest_files) or len(src_files) != len(dest_files):
            self.logger.error("Can't find corresponding 'result_dest_files' "
                              "for 'result_source_files' with testcase {}"
                              .format(self.testcase.name()))
            return False
        res = True
        for index in range(0, len(src_files)):
            src_file_path = os.path.join(result_path, src_files[index])
            dest_file_path = os.path.join(result_path, dest_files[index])
            if os.path.isfile(src_file_path):
                os.renames(src_file_path, dest_file_path)
            else:
                self.logger.error("Can't find file {}.".format(src_file_path))
                res = False
        return res


class DockerRunner(Runner):

    def __init__(self, testcase):
        super(DockerRunner, self).__init__(testcase)

    @classmethod
    def create_log(cls):
        cls.logger = dt_logger.Logger(__name__ + '.DockerRunner').getLogger()

    def run(self):
        container = Container(self.testcase)
        docker_image = container.get_docker_image()
        if dt_cfg.dovetail_config['offline']:
            exist = container.get_image_id(docker_image)
            if not exist:
                self.logger.error("{} image doesn't exist, can't run offline."
                                  .format(self.testcase.validate_type()))
                return
        else:
            if not container.pull_image(docker_image):
                self.logger.error("Failed to pull the image.")
                return

        container_id = container.create(docker_image)
        if not container_id:
            self.logger.error('Failed to create container.')
            return

        self.logger.debug('container id: {}'.format(container_id))

        self.testcase.mk_src_file()

        cmds = self.testcase.pre_condition()
        if cmds:
            for cmd in cmds:
                ret, msg = container.exec_cmd(cmd)
                if ret != 0:
                    self.logger.error('Failed to exec all pre_condition cmds.')
                    break

        if not self.testcase.prepare_cmd(self.type):
            self.logger.error(
                'Failed to prepare test case: {}'.format(self.testcase.name()))
        else:
            for cmd in self.testcase.cmds:
                ret, msg = container.exec_cmd(cmd)
                if ret != 0:
                    self.logger.error('Failed to exec {}, ret: {}, msg: {}'
                                      .format(cmd, ret, msg))
                    break

        cmds = self.testcase.post_condition()
        if cmds:
            for cmd in cmds:
                container.exec_cmd(cmd)

        if not dt_cfg.dovetail_config['noclean']:
            container.clean()

    @staticmethod
    def _render(task_template, **kwargs):
        return jinja2.Template(task_template).render(**kwargs)

    @staticmethod
    def _add_testcase_info(testcase, config_item=None):
        if not config_item:
            config_item = {}
        config_item['validate_testcase'] = testcase.validate_testcase()
        config_item['testcase'] = testcase.name()
        config_item['os_insecure'] = os.getenv('OS_INSECURE')
        if 'DEPLOY_SCENARIO' in os.environ:
            config_item['deploy_scenario'] = os.environ['DEPLOY_SCENARIO']
        config_item['dovetail_home'] = os.getenv('DOVETAIL_HOME')
        config_item['debug'] = os.getenv('DEBUG')
        config_item['build_tag'] = dt_cfg.dovetail_config['build_tag']
        config_item['cacert'] = os.getenv('OS_CACERT')
        config_item['host_url'] = os.getenv('HOST_URL')
        config_item['csar_file'] = os.getenv('CSAR_FILE')
        return config_item

    def _update_config(self, testcase, update_pod=True):
        config_item = None
        config_file = os.path.join(constants.CONF_PATH, self.config_file_name)
        task_template = dt_utils.read_plain_file(config_file, self.logger)
        if not task_template:
            return None
        if update_pod:
            pod_file = os.path.join(dt_cfg.dovetail_config['config_dir'],
                                    dt_cfg.dovetail_config['pod_file'])
            pod_info = dt_utils.read_yaml_file(pod_file, self.logger)
            if pod_info:
                try:
                    process_info = pod_info['process_info']
                except KeyError as e:
                    process_info = None
            else:
                process_info = None
            if process_info:
                for item in process_info:
                    try:
                        if item['testcase_name'] == testcase.name():
                            config_item = self._add_testcase_info(
                                testcase, item)
                        break
                    except KeyError as e:
                        self.logger.error('Need key {} in {}'.format(e, item))
        if not config_item:
            config_item = self._add_testcase_info(testcase)
        full_task = self._render(task_template, **config_item)
        full_task_yaml = yaml.safe_load(full_task)
        dt_cfg.dovetail_config.update(full_task_yaml)
        return dt_cfg.dovetail_config


class FunctestRunner(DockerRunner):

    config_file_name = 'functest_config.yml'

    def __init__(self, testcase):
        self.type = 'functest'
        super(FunctestRunner, self).__init__(testcase)
        endpoint_file = os.path.join(dt_cfg.dovetail_config['result_dir'],
                                     'endpoint_info.json')
        if not os.path.isfile(endpoint_file):
            dt_utils.get_openstack_info(self.logger)
        self._update_config(testcase)


class FunctestK8sRunner(DockerRunner):

    config_file_name = 'functest-k8s_config.yml'

    def __init__(self, testcase):
        self.type = 'functest-k8s'
        super(FunctestK8sRunner, self).__init__(testcase)
        self._update_config(testcase, update_pod=False)


class YardstickRunner(DockerRunner):

    config_file_name = 'yardstick_config.yml'

    def __init__(self, testcase):
        self.type = 'yardstick'
        super(YardstickRunner, self).__init__(testcase)
        endpoint_file = os.path.join(dt_cfg.dovetail_config['result_dir'],
                                     'endpoint_info.json')
        if not os.path.isfile(endpoint_file):
            dt_utils.get_openstack_info(self.logger)
        self._update_config(testcase)


class BottlenecksRunner(DockerRunner):

    config_file_name = 'bottlenecks_config.yml'

    def __init__(self, testcase):
        self.type = 'bottlenecks'
        super(BottlenecksRunner, self).__init__(testcase)
        endpoint_file = os.path.join(dt_cfg.dovetail_config['result_dir'],
                                     'endpoint_info.json')
        if not os.path.isfile(endpoint_file):
            dt_utils.get_openstack_info(self.logger)
        self._update_config(testcase)


class ShellRunner(Runner):

    @classmethod
    def create_log(cls):
        cls.logger = dt_logger.Logger(__name__ + '.ShellRunner').getLogger()

    def __init__(self, testcase):
        self.type = 'shell'
        super(ShellRunner, self).__init__(testcase)

    def run(self):
        testcase_passed = 'PASS'
        result = {'pass': 'PASS', 'results': []}
        cmds = self.testcase.pre_condition()
        for cmd in cmds:
            ret, msg = dt_utils.exec_cmd(cmd, self.logger)
            result['results'].append((cmd, ret, msg))
            if ret != 0:
                self.logger.error('Failed to execute all pre_condition cmds.')
                break

        if not self.testcase.prepare_cmd(self.type):
            self.logger.error(
                'Failed to prepare cmd: {}'.format(self.testcase.name()))
        else:
            for cmd in self.testcase.cmds:
                ret, msg = dt_utils.exec_cmd(cmd, self.logger)
                result['results'].append((cmd, ret, msg))
                if ret != 0:
                    testcase_passed = 'FAIL'

        result['pass'] = testcase_passed

        cmds = self.testcase.post_condition()
        for cmd in cmds:
            ret, msg = dt_utils.exec_cmd(cmd, self.logger)
            result['results'].append((cmd, ret, msg))

        result_filename = os.path.join(dt_cfg.dovetail_config['result_dir'],
                                       self.testcase.name()) + '.out'
        self.logger.debug('Save result: {}'.format(result_filename))
        try:
            with open(result_filename, 'w') as f:
                f.write(json.dumps(result))
        except Exception as e:
            self.logger.exception('Failed to write result into file: {}, '
                                  'exception: {}'.format(result_filename, e))


class VnftestRunner(DockerRunner):

    def __init__(self, testcase):
        self.type = 'vnftest'
        super(VnftestRunner, self).__init__(testcase)


class OnapVtpRunner(DockerRunner):

    config_file_name = 'onap-vtp_config.yml'

    def __init__(self, testcase):
        self.type = 'onap-vtp'
        super(OnapVtpRunner, self).__init__(testcase)
        env_file = os.path.join(dt_cfg.dovetail_config['config_dir'],
                                dt_cfg.dovetail_config['env_file'])
        if not os.path.isfile(env_file):
            self.logger.error('File {} does not exist.'.format(env_file))
            return
        dt_utils.source_env(env_file)
        self._update_config(testcase, update_pod=False)


class TestRunnerFactory(object):

    TEST_RUNNER_MAP = {
        "functest": FunctestRunner,
        "yardstick": YardstickRunner,
        "bottlenecks": BottlenecksRunner,
        "shell": ShellRunner,
        "vnftest": VnftestRunner,
        "functest-k8s": FunctestK8sRunner,
        "onap-vtp": OnapVtpRunner
    }

    @classmethod
    def create(cls, testcase):
        try:
            return cls.TEST_RUNNER_MAP[testcase.validate_type()](testcase)
        except KeyError:
            return None