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
|
##############################################################################
# Copyright (c) 2015 Orange
# guyrodrigue.koffi@orange.com / koffirodrigue@gmail.com
# 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
# feng.xiaowei@zte.com.cn refactor db.pod to db.pods 5-19-2016
# feng.xiaowei@zte.com.cn refactor test_project to project 5-19-2016
# feng.xiaowei@zte.com.cn refactor response body 5-19-2016
# feng.xiaowei@zte.com.cn refactor pod/project response info 5-19-2016
# feng.xiaowei@zte.com.cn refactor testcase related handler 5-20-2016
# feng.xiaowei@zte.com.cn refactor result related handler 5-23-2016
# feng.xiaowei@zte.com.cn refactor dashboard related handler 5-24-2016
# feng.xiaowei@zte.com.cn add methods to GenericApiHandler 5-26-2016
# feng.xiaowei@zte.com.cn remove PodHandler 5-26-2016
##############################################################################
import json
from datetime import datetime, timedelta
from tornado.web import RequestHandler, asynchronous, HTTPError
from tornado import gen
from models import CreateResponse
from resources.result_models import TestResult
from common.constants import DEFAULT_REPRESENTATION, HTTP_BAD_REQUEST, \
HTTP_NOT_FOUND, HTTP_FORBIDDEN
from common.config import prepare_put_request
from dashboard.dashboard_utils import check_dashboard_ready_project, \
check_dashboard_ready_case, get_dashboard_result
def format_data(data, cls):
cls_data = cls.from_dict(data)
return cls_data.format_http()
class GenericApiHandler(RequestHandler):
def __init__(self, application, request, **kwargs):
super(GenericApiHandler, self).__init__(application, request, **kwargs)
self.db = self.settings["db"]
self.json_args = None
self.table = None
self.table_cls = None
self.db_projects = 'projects'
self.db_pods = 'pods'
self.db_testcases = 'testcases'
self.db_results = 'results'
def prepare(self):
if self.request.method != "GET" and self.request.method != "DELETE":
if self.request.headers.get("Content-Type") is not None:
if self.request.headers["Content-Type"].startswith(
DEFAULT_REPRESENTATION):
try:
self.json_args = json.loads(self.request.body)
except (ValueError, KeyError, TypeError) as error:
raise HTTPError(HTTP_BAD_REQUEST,
"Bad Json format [{}]".
format(error))
def finish_request(self, json_object=None):
if json_object:
self.write(json.dumps(json_object))
self.set_header("Content-Type", DEFAULT_REPRESENTATION)
self.finish()
def _create_response(self, resource):
href = self.request.full_url() + '/' + str(resource)
return CreateResponse(href=href).format()
@asynchronous
@gen.coroutine
def _create(self, miss_checks, db_checks, **kwargs):
"""
:param miss_checks: [miss1, miss2]
:param db_checks: [(table, exist, query, (error, message))]
:param db_op: (insert/remove)
:param res_op: (_create_response/None)
:return:
"""
if self.json_args is None:
raise HTTPError(HTTP_BAD_REQUEST, "no body")
data = self.table_cls.from_dict(self.json_args)
for miss in miss_checks:
miss_data = data.__getattribute__(miss)
if miss_data is None or miss_data == '':
raise HTTPError(HTTP_BAD_REQUEST,
'{} missing'.format(miss))
for k, v in kwargs.iteritems():
data.__setattr__(k, v)
for table, exist, query, error in db_checks:
check = yield self._eval_db(table, 'find_one', query(data))
if (exist and not check) or (not exist and check):
code, message = error(data)
raise HTTPError(code, message)
data.creation_date = datetime.now()
_id = yield self._eval_db(self.table, 'insert', data.format())
if 'name' in self.json_args:
resource = data.name
else:
resource = _id
self.finish_request(self._create_response(resource))
@asynchronous
@gen.coroutine
def _list(self, query=None):
if query is None:
query = {}
res = []
cursor = self._eval_db(self.table, 'find', query)
while (yield cursor.fetch_next):
res.append(format_data(cursor.next_object(), self.table_cls))
self.finish_request({self.table: res})
@asynchronous
@gen.coroutine
def _get_one(self, query):
data = yield self._eval_db(self.table, 'find_one', query)
if data is None:
raise HTTPError(HTTP_NOT_FOUND,
"[{}] not exist in table [{}]"
.format(query, self.table))
self.finish_request(format_data(data, self.table_cls))
@asynchronous
@gen.coroutine
def _delete(self, query):
data = yield self._eval_db(self.table, 'find_one', query)
if data is None:
raise HTTPError(HTTP_NOT_FOUND,
"[{}] not exit in table [{}]"
.format(query, self.table))
yield self._eval_db(self.table, 'remove', query)
self.finish_request()
@asynchronous
@gen.coroutine
def _update(self, query, db_keys):
if self.json_args is None:
raise HTTPError(HTTP_BAD_REQUEST, "No payload")
# check old data exist
from_data = yield self._eval_db(self.table, 'find_one', query)
if from_data is None:
raise HTTPError(HTTP_NOT_FOUND,
"{} could not be found in table [{}]"
.format(query, self.table))
data = self.table_cls.from_dict(from_data)
# check new data exist
equal, new_query = self._update_query(db_keys, data)
if not equal:
to_data = yield self._eval_db(self.table, 'find_one', new_query)
if to_data is not None:
raise HTTPError(HTTP_FORBIDDEN,
"{} already exists in table [{}]"
.format(new_query, self.table))
# we merge the whole document """
edit_request = data.format()
edit_request.update(self._update_request(data))
""" Updating the DB """
yield self._eval_db(self.table, 'update', query, edit_request)
edit_request['_id'] = str(data._id)
self.finish_request(edit_request)
def _update_request(self, data):
request = dict()
for k, v in self.json_args.iteritems():
request = prepare_put_request(request, k, v,
data.__getattribute__(k))
if not request:
raise HTTPError(HTTP_FORBIDDEN, "Nothing to update")
return request
def _update_query(self, keys, data):
query = dict()
equal = True
for key in keys:
new = self.json_args.get(key)
old = data.__getattribute__(key)
if new is None:
new = old
elif new != old:
equal = False
query[key] = new
return equal, query
def _eval_db(self, table, method, *args):
return eval('self.db.%s.%s(*args)' % (table, method))
class VersionHandler(GenericApiHandler):
""" Display a message for the API version """
def get(self):
self.finish_request([{'v1': 'basics'}])
class DashboardHandler(GenericApiHandler):
"""
DashboardHandler Class
Handle the requests about the Test project's results
in a dahboard ready format
HTTP Methdods :
- GET : Get all test results and details about a specific one
"""
def initialize(self):
""" Prepares the database for the entire class """
super(DashboardHandler, self).initialize()
self.name = "dashboard"
@asynchronous
@gen.coroutine
def get(self):
"""
Retrieve dashboard ready result(s) for a test project
Available filters for this request are :
- project : project name
- case : case name
- pod : pod name
- version : platform version (Arno-R1, ...)
- installer (fuel, ...)
- period : x (x last days)
:param result_id: Get a result by ID
:raise HTTPError
GET /dashboard?project=functest&case=vPing&version=Arno-R1 \
&pod=pod_name&period=15
=> get results with optional filters
"""
project_arg = self.get_query_argument("project", None)
case_arg = self.get_query_argument("case", None)
pod_arg = self.get_query_argument("pod", None)
version_arg = self.get_query_argument("version", None)
installer_arg = self.get_query_argument("installer", None)
period_arg = self.get_query_argument("period", None)
# prepare request
query = dict()
if project_arg is not None:
query["project_name"] = project_arg
if case_arg is not None:
query["case_name"] = case_arg
if pod_arg is not None:
query["pod_name"] = pod_arg
if version_arg is not None:
query["version"] = version_arg
if installer_arg is not None:
query["installer"] = installer_arg
if period_arg is not None:
try:
period_arg = int(period_arg)
except:
raise HTTPError(HTTP_BAD_REQUEST)
if period_arg > 0:
period = datetime.now() - timedelta(days=period_arg)
obj = {"$gte": str(period)}
query["creation_date"] = obj
# on /dashboard retrieve the list of projects and testcases
# ready for dashboard
if project_arg is None:
raise HTTPError(HTTP_NOT_FOUND, "Project name missing")
if not check_dashboard_ready_project(project_arg):
raise HTTPError(HTTP_NOT_FOUND,
'Project [{}] not dashboard ready'
.format(project_arg))
if case_arg is None:
raise HTTPError(
HTTP_NOT_FOUND,
'Test case missing for project [{}]'.format(project_arg))
if not check_dashboard_ready_case(project_arg, case_arg):
raise HTTPError(
HTTP_NOT_FOUND,
'Test case [{}] not dashboard ready for project [{}]'
.format(case_arg, project_arg))
# special case of status for project
res = []
if case_arg != "status":
cursor = self.db.results.find(query)
while (yield cursor.fetch_next):
result = TestResult.from_dict(cursor.next_object())
res.append(result.format_http())
# final response object
self.finish_request(get_dashboard_result(project_arg, case_arg, res))
|