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 # feng.xiaowei@zte.com.cn refactor db.pod to db.pods 5-19-2016
9 # feng.xiaowei@zte.com.cn refactor test_project to project 5-19-2016
10 # feng.xiaowei@zte.com.cn refactor response body 5-19-2016
11 # feng.xiaowei@zte.com.cn refactor pod/project response info 5-19-2016
12 # feng.xiaowei@zte.com.cn refactor testcase related handler 5-20-2016
13 # feng.xiaowei@zte.com.cn refactor result related handler 5-23-2016
14 # feng.xiaowei@zte.com.cn refactor dashboard related handler 5-24-2016
15 # feng.xiaowei@zte.com.cn add methods to GenericApiHandler 5-26-2016
16 # feng.xiaowei@zte.com.cn remove PodHandler 5-26-2016
17 # feng.xiaowei@zte.com.cn remove ProjectHandler 5-26-2016
18 # feng.xiaowei@zte.com.cn remove TestcaseHandler 5-27-2016
19 # feng.xiaowei@zte.com.cn remove ResultHandler 5-29-2016
20 # feng.xiaowei@zte.com.cn remove DashboardHandler 5-30-2016
21 ##############################################################################
23 from datetime import datetime
26 from tornado import gen
27 from tornado import web
29 from opnfv_testapi.common import check
30 from opnfv_testapi.common import message
31 from opnfv_testapi.common import raises
32 from opnfv_testapi.resources import models
33 from opnfv_testapi.tornado_swagger import swagger
35 DEFAULT_REPRESENTATION = "application/json"
38 class GenericApiHandler(web.RequestHandler):
39 def __init__(self, application, request, **kwargs):
40 super(GenericApiHandler, self).__init__(application, request, **kwargs)
41 self.db = self.settings["db"]
45 self.db_projects = 'projects'
47 self.db_testcases = 'testcases'
48 self.db_results = 'results'
49 self.db_scenarios = 'scenarios'
50 self.auth = self.settings["auth"]
53 if self.request.method != "GET" and self.request.method != "DELETE":
54 if self.request.headers.get("Content-Type") is not None:
55 if self.request.headers["Content-Type"].startswith(
56 DEFAULT_REPRESENTATION):
58 self.json_args = json.loads(self.request.body)
59 except (ValueError, KeyError, TypeError) as error:
60 raises.BadRequest(message.bad_format(str(error)))
62 def finish_request(self, json_object=None):
64 self.write(json.dumps(json_object))
65 self.set_header("Content-Type", DEFAULT_REPRESENTATION)
68 def _create_response(self, resource):
69 href = self.request.full_url() + '/' + str(resource)
70 return models.CreateResponse(href=href).format()
72 def format_data(self, data):
73 cls_data = self.table_cls.from_dict(data)
74 return cls_data.format_http()
81 def _create(self, **kwargs):
83 :param miss_checks: [miss1, miss2]
84 :param db_checks: [(table, exist, query, error)]
86 data = self.table_cls.from_dict(self.json_args)
87 for k, v in kwargs.iteritems():
89 data.__setattr__(k, v)
91 if self.table != 'results':
92 data.creation_date = datetime.now()
93 _id = yield self._eval_db(self.table, 'insert', data.format(),
95 if 'name' in self.json_args:
99 self.finish_request(self._create_response(resource))
103 def _list(self, query=None, res_op=None, *args, **kwargs):
104 sort = kwargs.get('sort')
105 page = kwargs.get('page', 0)
106 last = kwargs.get('last', 0)
107 per_page = kwargs.get('per_page', 0)
113 cursor = self._eval_db(self.table, 'find', query)
114 records_count = yield cursor.count()
115 total_pages = self._calc_total_pages(records_count,
119 pipelines = self._set_pipelines(query, sort, last, page, per_page)
120 cursor = self._eval_db(self.table,
125 while (yield cursor.fetch_next):
126 data.append(self.format_data(cursor.next_object()))
128 res = {self.table: data}
130 res = res_op(data, *args)
134 'current_page': kwargs.get('page'),
135 'total_pages': total_pages
138 self.finish_request(res)
141 def _calc_total_pages(records_count, last, page, per_page):
142 records_nr = records_count
143 if (records_count > last) and (last > 0):
146 total_pages, remainder = divmod(records_nr, per_page)
149 if page > 1 and page > total_pages:
151 'Request page > total_pages [{}]'.format(total_pages))
155 def _set_pipelines(query, sort, last, page, per_page):
158 pipelines.append({'$match': query})
160 pipelines.append({'$sort': sort})
163 pipelines.append({'$skip': (page - 1) * per_page})
164 pipelines.append({'$limit': per_page})
166 pipelines.append({'$limit': last})
173 def _get_one(self, data, query=None):
174 self.finish_request(self.format_data(data))
178 def _delete(self, data, query=None):
179 yield self._eval_db(self.table, 'remove', query)
180 self.finish_request()
185 @check.updated_one_not_exist
186 def _update(self, data, query=None, **kwargs):
187 data = self.table_cls.from_dict(data)
188 update_req = self._update_requests(data)
189 yield self._eval_db(self.table, 'update', query, update_req,
191 update_req['_id'] = str(data._id)
192 self.finish_request(update_req)
194 def _update_requests(self, data):
196 for k, v in self.json_args.iteritems():
197 request = self._update_request(request, k, v,
198 data.__getattribute__(k))
200 raises.Forbidden(message.no_update())
202 edit_request = data.format()
203 edit_request.update(request)
207 def _update_request(edit_request, key, new_value, old_value):
209 This function serves to prepare the elements in the update request.
210 We try to avoid replace the exact values in the db
211 edit_request should be a dict in which we add an entry (key) after
214 if not (new_value is None):
215 if new_value != old_value:
216 edit_request[key] = new_value
220 def _update_query(self, keys, data):
224 new = self.json_args.get(key)
231 return query if not equal else dict()
233 def _eval_db(self, table, method, *args, **kwargs):
234 exec_collection = self.db.__getattr__(table)
235 return exec_collection.__getattribute__(method)(*args, **kwargs)
237 def _eval_db_find_one(self, query, table=None):
240 return self._eval_db(table, 'find_one', query)
242 def db_save(self, collection, data):
243 self._eval_db(collection, 'insert', data, check_keys=False)
245 def db_find_one(self, query, collection=None):
247 collection = self.table
248 return self._eval_db(collection, 'find_one', query)
251 class VersionHandler(GenericApiHandler):
252 @swagger.operation(nickname='listAllVersions')
255 @description: list all supported versions
258 versions = [{'version': 'v1.0', 'description': 'basics'}]
259 self.finish_request({'versions': versions})