aboutsummaryrefslogtreecommitdiffstats
path: root/restful_server/qtip_server.py
blob: 537b2c05dc633489c51d4f816831ce2d64fb9ce8 (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
##############################################################################
# Copyright (c) 2016 ZTE Corp 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
##############################################################################
from flask import Flask, abort
from flask_restful import Api, Resource, fields, reqparse
from flask_restful_swagger import swagger
import threading
from copy import copy
import db
import utils.args_handler as args_handler
import restful_server.result_handler as result_handler


app = Flask(__name__)
api = swagger.docs(Api(app), apiVersion='0.1')


@swagger.model
class JobModel:
    resource_fields = {
        'installer_type': fields.String,
        'installer_ip': fields.String,
        'max_minutes': fields.Integer,
        'pod_name': fields.String,
        'suite_name': fields.String,
        'type': fields.String,
        'benchmark_name': fields.String,
        'testdb_url': fields.String,
        'node_name': fields.String
    }
    required = ['installer_type', 'installer_ip']


@swagger.model
class JobResponseModel:
    resource_fields = {
        'job_id': fields.String
    }


class Job(Resource):
    @swagger.operation(
        notes='get a job by ID',
        nickname='get',
        parameters=[],
        responseMessages=[
            {
                "code": 200,
                "message": "Job detail info."
            },
            {
                "code": 404,
                "message": "Can't not find the job id XXXXXXX"
            }
        ]
    )
    def get(self, id):
        ret = db.get_job_info(id)
        return ret if ret else abort(404, " Can't not find the job id %s" % id)

    @swagger.operation(
        notes='delete a job by ID',
        nickname='delete',
        parameters=[],
        responseMessages=[
            {
                "code": 200,
                "message": "Delete successfully"
            },
            {
                "code": 404,
                "message": "Can not find job_id XXXXXXXXX"
            }
        ]
    )
    def delete(self, id):
        ret = db.delete_job(id)
        return {'result': "Delete successfully"} if ret else abort(404, "Can not find job_id %s" % id)


class JobList(Resource):
    @swagger.operation(
        note='create a job with parameters',
        nickname='create',
        parameters=[
            {
                "name": "body",
                "description": """
"installer_type": The installer type, for example fuel, compass..,

"installer_ip": The installer ip of the pod,

"max_minutes": If specified, the maximum duration in minutes
for any single test iteration, default is '60',

"pod_name": If specified, the Pod name, default is 'default',

"suite_name": If specified, Test suite name, for example 'compute', 'network', 'storage',
default is 'compute',

"type": BM or VM,default is 'BM',

"benchmark_name": If specified, benchmark name in suite, for example 'dhrystone_bm.yaml',
default is all benchmarks in suite with specified type,

"testdb_url": test db http url, for example 'http://testresults.opnfv.org/test/api/v1',

"node_name": node name reported to test db
                """,
                "required": True,
                "type": "JobModel",
                "paramType": "body"
            }
        ],
        type=JobResponseModel.__name__,
        responseMessages=[
            {
                "code": 200,
                "message": "Job submitted"
            },
            {
                "code": 400,
                "message": "Missing configuration data"
            },
            {
                "code": 409,
                "message": "It already has one job running now!"
            }
        ]
    )
    def post(self):
        parser = reqparse.RequestParser()
        parser.add_argument('installer_type', type=str, required=True, help='installer_type is required')
        parser.add_argument('installer_ip', type=str, required=True, help='installer_ip is required')
        parser.add_argument('max_minutes', type=int, required=False, default=60, help='max_minutes should be integer')
        parser.add_argument('pod_name', type=str, required=False, default='default', help='pod_name should be string')
        parser.add_argument('suite_name', type=str, required=False, default='compute', help='suite_name should be string')
        parser.add_argument('type', type=str, required=False, default='BM', help='type should be BM, VM and ALL')
        parser.add_argument('benchmark_name', type=str, required=False, default='all', help='benchmark_name should be string')
        parser.add_argument('testdb_url', type=str, required=False, default=None,
                            help='testdb_url should be test db http url,for example http://testresults.opnfv.org/test/api/v1')
        parser.add_argument('node_name', type=str, required=False, default=None, help='node_name should be string')
        args = parser.parse_args()
        if not args_handler.check_suite(args["suite_name"]):
            return abort(404, 'message:Test suite {0} does not exist under benchmarks/suite'.format(args["suite_name"]))
        if not args_handler.check_lab_name(args["pod_name"]):
            return abort(404, 'message: You have specified a lab {0}\
                               that is not present in test_cases'.format(args['pod_name']))

        job_id = db.create_job(args)
        if not job_id:
            return abort(409, 'message:It already has one job running now!')

        benchmarks = args_handler.get_files_in_suite(args["suite_name"],
                                                     args["type"].lower())
        test_cases = args_handler.get_files_in_test_case(args["pod_name"],
                                                         args["suite_name"],
                                                         args["type"].lower())
        benchmarks_list = filter(lambda x: x in test_cases, benchmarks)
        if args["benchmark_name"] in benchmarks_list:
            benchmarks_list = [args["benchmark_name"]]
        if (args["benchmark_name"] is not 'all') and args["benchmark_name"] not in benchmarks_list:
            return abort(404, 'message: Benchmark name {0} does not exist in suit {1}'.format(args["benchmark_name"],
                                                                                              args["suite_name"]))
        state_detail = map(lambda x: {'benchmark': x, 'state': 'idle'}, benchmarks_list)
        db.update_job_state_detail(job_id, copy(state_detail))
        thread_stop = threading.Event()
        post_thread = threading.Thread(target=self.thread_post, args=(args["installer_type"],
                                                                      benchmarks_list,
                                                                      args["pod_name"],
                                                                      args["suite_name"],
                                                                      job_id,
                                                                      args["testdb_url"],
                                                                      args["node_name"],
                                                                      thread_stop))
        db.start_thread(job_id, post_thread, thread_stop)
        return {'job_id': str(job_id)}

    def thread_post(self, installer_type, benchmarks_list, pod_name, suite_name,
                    job_id, testdb_url, node_name, stop_event):
        for benchmark in benchmarks_list:
            if db.is_job_timeout(job_id) or stop_event.is_set():
                break
            db.update_benchmark_state(job_id, benchmark, 'processing')
            result = args_handler.prepare_and_run_benchmark(installer_type,
                                                            '/home',
                                                            args_handler.get_benchmark_path(pod_name,
                                                                                            suite_name,
                                                                                            benchmark))
            db.update_job_result_detail(job_id, benchmark, copy(result))
            db.update_benchmark_state(job_id, benchmark, 'finished')
        if (result_handler.dump_suite_result(suite_name) and testdb_url):
            result_handler.push_suite_result_to_db(suite_name, testdb_url, installer_type, node_name)
        db.finish_job(job_id)


api.add_resource(JobList, '/api/v1.0/jobs')
api.add_resource(Job, '/api/v1.0/jobs/<string:id>')

if __name__ == "__main__":
    app.run(host='0.0.0.0')