1 ##############################################################################
2 # Copyright (c) 2015 Orange
3 # guyrodrigue.koffi@orange.com / koffirodrigue@gmail.com
4 # All rights reserved. This program and the accompanying materials
5 # are made available under the terms of the Apache License, Version 2.0
6 # which accompanies this distribution, and is available at
7 # http://www.apache.org/licenses/LICENSE-2.0
8 ##############################################################################
10 from datetime import datetime
11 from datetime import timedelta
14 from bson import objectid
16 from opnfv_testapi.common.config import CONF
17 from opnfv_testapi.common import message
18 from opnfv_testapi.common import raises
19 from opnfv_testapi.resources import handlers
20 from opnfv_testapi.resources import result_models
21 from opnfv_testapi.tornado_swagger import swagger
22 from opnfv_testapi.ui.auth import constants as auth_const
25 class GenericResultHandler(handlers.GenericApiHandler):
26 def __init__(self, application, request, **kwargs):
27 super(GenericResultHandler, self).__init__(application,
30 self.table = self.db_results
31 self.table_cls = result_models.TestResult
33 def get_int(self, key, value):
37 raises.BadRequest(message.must_int(key))
44 query['public'] = {'$not': {'$eq': 'false'}}
45 for k in self.request.query_arguments.keys():
46 v = self.get_query_argument(k)
47 if k == 'project' or k == 'pod' or k == 'case':
48 query[k + '_name'] = v
50 v = self.get_int(k, v)
52 period = datetime.now() - timedelta(days=v)
53 obj = {"$gte": str(period)}
54 query['start_date'] = obj
55 elif k == 'trust_indicator':
56 query[k + '.current'] = float(v)
58 date_range.update({'$gte': str(v)})
60 date_range.update({'$lt': str(v)})
62 openid = self.get_secure_cookie(auth_const.OPENID)
63 role = self.get_secure_cookie(auth_const.ROLE)
64 logging.info('role:%s', role)
67 if role != "reviewer":
68 query['user'] = openid
69 elif k != 'last' and k != 'page':
72 query['start_date'] = date_range
74 # if $lt is not provided,
75 # empty/None/null/'' start_date will also be returned
76 if 'start_date' in query and '$lt' not in query['start_date']:
77 query['start_date'].update({'$lt': str(datetime.now())})
82 class ResultsCLHandler(GenericResultHandler):
83 @swagger.operation(nickname="queryTestResults")
86 @description: Retrieve result(s) for a test project
88 @notes: Retrieve result(s) for a test project on a specific pod.
89 Available filters for this request are :
90 - project : project name
93 - version : platform version (Arno-R1, ...)
94 - installer : fuel/apex/compass/joid/daisy
95 - build_tag : Jenkins build tag name
96 - period : x last days, incompatible with from/to
97 - from : starting time in 2016-01-01 or 2016-01-01 00:01:23
98 - to : ending time in 2016-01-01 or 2016-01-01 00:01:23
99 - scenario : the test scenario (previously version)
100 - criteria : the global criteria status passed or failed
101 - trust_indicator : evaluate the stability of the test case
102 to avoid running systematically long and stable test case
103 - signed : get logined user result
105 GET /results/project=functest&case=vPing&version=Arno-R1 \
106 &pod=pod_name&period=15&signed
107 @return 200: all test results consist with query,
108 empty list if no result is found
109 @rtype: L{TestResults}
114 @param project: project name
115 @type project: L{string}
117 @required project: False
118 @param case: case name
119 @type case: L{string}
121 @required case: False
122 @param version: i.e. Colorado
123 @type version: L{string}
125 @required version: False
126 @param installer: fuel/apex/joid/compass
127 @type installer: L{string}
129 @required installer: False
130 @param build_tag: i.e. v3.0
131 @type build_tag: L{string}
133 @required build_tag: False
134 @param scenario: i.e. odl
135 @type scenario: L{string}
137 @required scenario: False
138 @param criteria: i.e. passed
139 @type criteria: L{string}
141 @required criteria: False
142 @param period: last days
143 @type period: L{string}
145 @required period: False
146 @param from: i.e. 2016-01-01 or 2016-01-01 00:01:23
147 @type from: L{string}
149 @required from: False
150 @param to: i.e. 2016-01-01 or 2016-01-01 00:01:23
154 @param last: last records stored until now
155 @type last: L{string}
157 @required last: False
158 @param page: which page to list
161 @required page: False
162 @param trust_indicator: must be float
163 @type trust_indicator: L{float}
164 @in trust_indicator: query
165 @required trust_indicator: False
166 @param signed: user results or all results
167 @type signed: L{string}
169 @required signed: False
171 limitations = {'sort': {'_id': -1}}
172 last = self.get_query_argument('last', 0)
174 last = self.get_int('last', last)
175 limitations.update({'last': last})
177 page = self.get_query_argument('page', None)
179 page = self.get_int('page', page)
180 limitations.update({'page': page,
181 'per_page': CONF.api_results_per_page})
183 self._list(query=self.set_query(), **limitations)
185 @swagger.operation(nickname="createTestResult")
188 @description: create a test result
189 @param body: result to be created
190 @type body: L{ResultCreateRequest}
192 @rtype: L{CreateResponse}
193 @return 200: result is created.
194 @raise 404: pod/project/testcase not exist
195 @raise 400: body/pod_name/project_name/case_name not provided
201 return {'name': self.json_args.get('pod_name')}
204 return {'name': self.json_args.get('project_name')}
206 def testcase_query():
207 return {'project_name': self.json_args.get('project_name'),
208 'name': self.json_args.get('case_name')}
210 miss_fields = ['pod_name', 'project_name', 'case_name']
211 carriers = [('pods', pod_query),
212 ('projects', project_query),
213 ('testcases', testcase_query)]
215 self._create(miss_fields=miss_fields, carriers=carriers)
218 class ResultsUploadHandler(ResultsCLHandler):
219 @swagger.operation(nickname="uploadTestResult")
222 @description: upload and create a test result
223 @param body: result to be created
224 @type body: L{ResultCreateRequest}
226 @rtype: L{CreateResponse}
227 @return 200: result is created.
228 @raise 404: pod/project/testcase not exist
229 @raise 400: body/pod_name/project_name/case_name not provided
231 logging.info('file upload')
232 fileinfo = self.request.files['file'][0]
233 is_public = self.get_body_argument('public')
234 logging.warning('public:%s', is_public)
235 logging.info('results is :%s', fileinfo['filename'])
236 logging.info('results is :%s', fileinfo['body'])
237 self.json_args = json.loads(fileinfo['body']).copy()
238 self.json_args['public'] = is_public
240 openid = self.get_secure_cookie(auth_const.OPENID)
242 self.json_args['user'] = openid
244 super(ResultsUploadHandler, self)._post()
247 class ResultsGURHandler(GenericResultHandler):
248 @swagger.operation(nickname='getTestResultById')
249 def get(self, result_id):
251 @description: get a single result by result_id
252 @rtype: L{TestResult}
253 @return 200: test result exist
254 @raise 404: test result not exist
257 query["_id"] = objectid.ObjectId(result_id)
258 self._get_one(query=query)
260 @swagger.operation(nickname="updateTestResultById")
261 def put(self, result_id):
263 @description: update a single result by _id
264 @param body: fields to be updated
265 @type body: L{ResultUpdateRequest}
268 @return 200: update success
269 @raise 404: result not exist
270 @raise 403: nothing to update
272 query = {'_id': objectid.ObjectId(result_id)}
274 self._update(query=query, db_keys=db_keys)