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
27 from tornado import gen
28 from tornado import web
31 from opnfv_testapi.common import raises
32 from opnfv_testapi.tornado_swagger import swagger
34 DEFAULT_REPRESENTATION = "application/json"
37 class GenericApiHandler(web.RequestHandler):
38 def __init__(self, application, request, **kwargs):
39 super(GenericApiHandler, self).__init__(application, request, **kwargs)
40 self.db = self.settings["db"]
44 self.db_projects = 'projects'
46 self.db_testcases = 'testcases'
47 self.db_results = 'results'
48 self.db_scenarios = 'scenarios'
49 self.auth = self.settings["auth"]
52 if self.request.method != "GET" and self.request.method != "DELETE":
53 if self.request.headers.get("Content-Type") is not None:
54 if self.request.headers["Content-Type"].startswith(
55 DEFAULT_REPRESENTATION):
57 self.json_args = json.loads(self.request.body)
58 except (ValueError, KeyError, TypeError) as error:
59 raises.BadRequest("Bad Json format [{}]".format(error))
61 def finish_request(self, json_object=None):
63 self.write(json.dumps(json_object))
64 self.set_header("Content-Type", DEFAULT_REPRESENTATION)
67 def _create_response(self, resource):
68 href = self.request.full_url() + '/' + str(resource)
69 return models.CreateResponse(href=href).format()
71 def format_data(self, data):
72 cls_data = self.table_cls.from_dict(data)
73 return cls_data.format_http()
75 def authenticate(method):
78 @functools.wraps(method)
79 def wrapper(self, *args, **kwargs):
82 token = self.request.headers['X-Auth-Token']
84 raises.Unauthorized("No Authentication Header.")
85 query = {'access_token': token}
86 check = yield self._eval_db_find_one(query, 'tokens')
88 raises.Forbidden("Invalid Token.")
89 ret = yield gen.coroutine(method)(self, *args, **kwargs)
94 def _create(self, miss_checks, db_checks, **kwargs):
96 :param miss_checks: [miss1, miss2]
97 :param db_checks: [(table, exist, query, error)]
99 if self.json_args is None:
100 raises.BadRequest('no body')
102 data = self.table_cls.from_dict(self.json_args)
103 for miss in miss_checks:
104 miss_data = data.__getattribute__(miss)
105 if miss_data is None or miss_data == '':
106 raises.BadRequest('{} missing'.format(miss))
108 for k, v in kwargs.iteritems():
109 data.__setattr__(k, v)
111 for table, exist, query, error in db_checks:
112 check = yield self._eval_db_find_one(query(data), table)
113 if (exist and not check) or (not exist and check):
114 code, message = error(data)
115 raises.CodeTBD(code, message)
117 if self.table != 'results':
118 data.creation_date = datetime.now()
119 _id = yield self._eval_db(self.table, 'insert', data.format(),
121 if 'name' in self.json_args:
125 self.finish_request(self._create_response(resource))
129 def _list(self, query=None, res_op=None, *args, **kwargs):
133 cursor = self._eval_db(self.table, 'find', query)
135 cursor = cursor.sort(kwargs.get('sort'))
137 cursor = cursor.limit(kwargs.get('last'))
138 while (yield cursor.fetch_next):
139 data.append(self.format_data(cursor.next_object()))
141 res = {self.table: data}
143 res = res_op(data, *args)
144 self.finish_request(res)
148 def _get_one(self, query):
149 data = yield self._eval_db_find_one(query)
151 raises.NotFound("[{}] not exist in table [{}]"
152 .format(query, self.table))
153 self.finish_request(self.format_data(data))
156 def _delete(self, query):
157 data = yield self._eval_db_find_one(query)
159 raises.NotFound("[{}] not exit in table [{}]"
160 .format(query, self.table))
162 yield self._eval_db(self.table, 'remove', query)
163 self.finish_request()
166 def _update(self, query, db_keys):
167 if self.json_args is None:
168 raises.BadRequest("No payload")
170 # check old data exist
171 from_data = yield self._eval_db_find_one(query)
172 if from_data is None:
173 raises.NotFound("{} could not be found in table [{}]"
174 .format(query, self.table))
176 data = self.table_cls.from_dict(from_data)
177 # check new data exist
178 equal, new_query = self._update_query(db_keys, data)
180 to_data = yield self._eval_db_find_one(new_query)
181 if to_data is not None:
182 raises.Forbidden("{} already exists in table [{}]"
183 .format(new_query, self.table))
185 # we merge the whole document """
186 edit_request = self._update_requests(data)
188 """ Updating the DB """
189 yield self._eval_db(self.table, 'update', query, edit_request,
191 edit_request['_id'] = str(data._id)
192 self.finish_request(edit_request)
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("Nothing to 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)
225 old = data.__getattribute__(key)
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)
243 class VersionHandler(GenericApiHandler):
244 @swagger.operation(nickname='listAllVersions')
247 @description: list all supported versions
250 versions = [{'version': 'v1.0', 'description': 'basics'}]
251 self.finish_request({'versions': versions})