summaryrefslogtreecommitdiffstats
path: root/functest/api/resources/v1/testcases.py
blob: 7cc70bbc909af280042364dbc54eee08af5f3838 (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
#!/usr/bin/env python

# Copyright (c) 2017 Huawei Technologies Co.,Ltd 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

"""
Resources to handle testcase related requests
"""

import logging
import os
import re
import pkg_resources
import socket
import uuid

import ConfigParser
from flask import jsonify
from flasgger.utils import swag_from

from functest.api.base import ApiResource
from functest.api.common import api_utils, thread
from functest.cli.commands.cli_testcase import Testcase
from functest.api.database.v1.handlers import TasksHandler
from functest.utils.constants import CONST
import functest.utils.functest_utils as ft_utils

LOGGER = logging.getLogger(__name__)

ADDRESS = socket.gethostbyname(socket.gethostname())
ENDPOINT_TESTCASES = ('http://{}:5000/api/v1/functest/testcases'
                      .format(ADDRESS))


class V1Testcases(ApiResource):
    """ V1Testcases Resource class"""

    @swag_from(pkg_resources.resource_filename(
        'functest', 'api/swagger/testcases.yaml'))
    def get(self):  # pylint: disable=no-self-use
        """ GET all testcases """
        testcases_list = Testcase().list()
        result = {'testcases': re.split(' |\n ', testcases_list)[1:]}
        return jsonify(result)


class V1Testcase(ApiResource):
    """ V1Testcase Resource class"""

    @swag_from(
        pkg_resources.resource_filename('functest',
                                        'api/swagger/testcase.yaml'),
        endpoint='{0}/<testcase_name>'.format(ENDPOINT_TESTCASES))
    def get(self, testcase_name):  # pylint: disable=no-self-use
        """ GET the info of one testcase"""
        testcase = Testcase().show(testcase_name)
        if not testcase:
            return api_utils.result_handler(
                status=1,
                data="The test case '%s' does not exist or is not supported"
                % testcase_name)

        testcase_info = api_utils.change_obj_to_dict(testcase)
        dependency_dict = api_utils.change_obj_to_dict(
            testcase_info.get('dependency'))
        testcase_info.pop('name')
        testcase_info.pop('dependency')
        result = {'testcase': testcase_name}
        result.update(testcase_info)
        result.update({'dependency': dependency_dict})
        return jsonify(result)

    @swag_from(
        pkg_resources.resource_filename('functest',
                                        'api/swagger/testcase_run.yaml'),
        endpoint='{0}/action'.format(ENDPOINT_TESTCASES))
    def post(self):
        """ Used to handle post request """
        return self._dispatch_post()

    def run_test_case(self, args):
        """ Run a testcase """
        try:
            case_name = args['testcase']
        except KeyError:
            return api_utils.result_handler(
                status=1, data='testcase name must be provided')

        testcase = Testcase().show(case_name)
        if not testcase:
            return api_utils.result_handler(
                status=1,
                data="The test case '%s' does not exist or is not supported"
                % case_name)

        task_id = str(uuid.uuid4())

        task_args = {'testcase': case_name, 'task_id': task_id}

        task_args.update(args.get('opts', {}))

        task_thread = thread.TaskThread(self._run, task_args, TasksHandler())
        task_thread.start()

        result = {'testcase': case_name, 'task_id': task_id}
        return jsonify({'result': result})

    def _run(self, args):  # pylint: disable=no-self-use
        """ The built_in function to run a test case """

        case_name = args.get('testcase')
        self._update_logging_ini(args.get('task_id'))

        if not os.path.isfile(CONST.__getattribute__('env_active')):
            raise Exception("Functest environment is not ready.")
        else:
            try:
                cmd = "run_tests -t {}".format(case_name)
                runner = ft_utils.execute_command(cmd)
            except Exception:  # pylint: disable=broad-except
                result = 'FAIL'
                LOGGER.exception("Running test case %s failed!", case_name)
            if runner == os.EX_OK:
                result = 'PASS'
            else:
                result = 'FAIL'

            env_info = {
                'installer': CONST.__getattribute__('INSTALLER_TYPE'),
                'scenario': CONST.__getattribute__('DEPLOY_SCENARIO'),
                'build_tag': CONST.__getattribute__('BUILD_TAG'),
                'ci_loop': CONST.__getattribute__('CI_LOOP')
            }
            result = {
                'task_id': args.get('task_id'),
                'testcase': case_name,
                'env_info': env_info,
                'result': result
            }

            return {'result': result}

    def _update_logging_ini(self, task_id):  # pylint: disable=no-self-use
        """ Update the log file for each task"""
        config = ConfigParser.RawConfigParser()
        config.read(
            pkg_resources.resource_filename('functest', 'ci/logging.ini'))
        log_path = os.path.join(CONST.__getattribute__('dir_results'),
                                '{}.log'.format(task_id))
        config.set('handler_file', 'args', '("{}",)'.format(log_path))

        with open(
            pkg_resources.resource_filename(
                'functest', 'ci/logging.ini'), 'wb') as configfile:
            config.write(configfile)