utils/test/testapi/opnfv_testapi/resources/handlers.py

   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 ##############################################################################
  22
  23 from datetime import datetime
  24 import functools
  25 import json
  26
  27 from tornado import gen
  28 from tornado import web
  29
  30 import models
  31 from opnfv_testapi.common import constants
  32 from opnfv_testapi.tornado_swagger import swagger
  33
  34
  35 class GenericApiHandler(web.RequestHandler):
  36     def __init__(self, application, request, **kwargs):
  37         super(GenericApiHandler, self).__init__(application, request, **kwargs)
  38         self.db = self.settings["db"]
  39         self.json_args = None
  40         self.table = None
  41         self.table_cls = None
  42         self.db_projects = 'projects'
  43         self.db_pods = 'pods'
  44         self.db_testcases = 'testcases'
  45         self.db_results = 'results'
  46         self.db_scenarios = 'scenarios'
  47         self.auth = self.settings["auth"]
  48
  49     def prepare(self):
  50         if self.request.method != "GET" and self.request.method != "DELETE":
  51             if self.request.headers.get("Content-Type") is not None:
  52                 if self.request.headers["Content-Type"].startswith(
  53                         constants.DEFAULT_REPRESENTATION):
  54                     try:
  55                         self.json_args = json.loads(self.request.body)
  56                     except (ValueError, KeyError, TypeError) as error:
  57                         raise web.HTTPError(constants.HTTP_BAD_REQUEST,
  58                                             "Bad Json format [{}]".
  59                                             format(error))
  60
  61     def finish_request(self, json_object=None):
  62         if json_object:
  63             self.write(json.dumps(json_object))
  64         self.set_header("Content-Type", constants.DEFAULT_REPRESENTATION)
  65         self.finish()
  66
  67     def _create_response(self, resource):
  68         href = self.request.full_url() + '/' + str(resource)
  69         return models.CreateResponse(href=href).format()
  70
  71     def format_data(self, data):
  72         cls_data = self.table_cls.from_dict(data)
  73         return cls_data.format_http()
  74
  75     def authenticate(method):
  76         @web.asynchronous
  77         @gen.coroutine
  78         @functools.wraps(method)
  79         def wrapper(self, *args, **kwargs):
  80             if self.auth:
  81                 try:
  82                     token = self.request.headers['X-Auth-Token']
  83                 except KeyError:
  84                     raise web.HTTPError(constants.HTTP_UNAUTHORIZED,
  85                                         "No Authentication Header.")
  86                 query = {'access_token': token}
  87                 check = yield self._eval_db_find_one(query, 'tokens')
  88                 if not check:
  89                     raise web.HTTPError(constants.HTTP_FORBIDDEN,
  90                                         "Invalid Token.")
  91             ret = yield gen.coroutine(method)(self, *args, **kwargs)
  92             raise gen.Return(ret)
  93         return wrapper
  94
  95     @authenticate
  96     def _create(self, miss_checks, db_checks, **kwargs):
  97         """
  98         :param miss_checks: [miss1, miss2]
  99         :param db_checks: [(table, exist, query, error)]
 100         """
 101         if self.json_args is None:
 102             raise web.HTTPError(constants.HTTP_BAD_REQUEST, "no body")
 103
 104         data = self.table_cls.from_dict(self.json_args)
 105         for miss in miss_checks:
 106             miss_data = data.__getattribute__(miss)
 107             if miss_data is None or miss_data == '':
 108                 raise web.HTTPError(constants.HTTP_BAD_REQUEST,
 109                                     '{} missing'.format(miss))
 110
 111         for k, v in kwargs.iteritems():
 112             data.__setattr__(k, v)
 113
 114         for table, exist, query, error in db_checks:
 115             check = yield self._eval_db_find_one(query(data), table)
 116             if (exist and not check) or (not exist and check):
 117                 code, message = error(data)
 118                 raise web.HTTPError(code, message)
 119
 120         if self.table != 'results':
 121             data.creation_date = datetime.now()
 122         _id = yield self._eval_db(self.table, 'insert', data.format(),
 123                                   check_keys=False)
 124         if 'name' in self.json_args:
 125             resource = data.name
 126         else:
 127             resource = _id
 128         self.finish_request(self._create_response(resource))
 129
 130     @web.asynchronous
 131     @gen.coroutine
 132     def _list(self, query=None, res_op=None, *args, **kwargs):
 133         if query is None:
 134             query = {}
 135         data = []
 136         cursor = self._eval_db(self.table, 'find', query)
 137         if 'sort' in kwargs:
 138             cursor = cursor.sort(kwargs.get('sort'))
 139         if 'last' in kwargs:
 140             cursor = cursor.limit(kwargs.get('last'))
 141         while (yield cursor.fetch_next):
 142             data.append(self.format_data(cursor.next_object()))
 143         if res_op is None:
 144             res = {self.table: data}
 145         else:
 146             res = res_op(data, *args)
 147         self.finish_request(res)
 148
 149     @web.asynchronous
 150     @gen.coroutine
 151     def _get_one(self, query):
 152         data = yield self._eval_db_find_one(query)
 153         if data is None:
 154             raise web.HTTPError(constants.HTTP_NOT_FOUND,
 155                                 "[{}] not exist in table [{}]"
 156                                 .format(query, self.table))
 157         self.finish_request(self.format_data(data))
 158
 159     @authenticate
 160     def _delete(self, query):
 161         data = yield self._eval_db_find_one(query)
 162         if data is None:
 163             raise web.HTTPError(constants.HTTP_NOT_FOUND,
 164                                 "[{}] not exit in table [{}]"
 165                                 .format(query, self.table))
 166
 167         yield self._eval_db(self.table, 'remove', query)
 168         self.finish_request()
 169
 170     @authenticate
 171     def _update(self, query, db_keys):
 172         if self.json_args is None:
 173             raise web.HTTPError(constants.HTTP_BAD_REQUEST, "No payload")
 174
 175         # check old data exist
 176         from_data = yield self._eval_db_find_one(query)
 177         if from_data is None:
 178             raise web.HTTPError(constants.HTTP_NOT_FOUND,
 179                                 "{} could not be found in table [{}]"
 180                                 .format(query, self.table))
 181
 182         data = self.table_cls.from_dict(from_data)
 183         # check new data exist
 184         equal, new_query = self._update_query(db_keys, data)
 185         if not equal:
 186             to_data = yield self._eval_db_find_one(new_query)
 187             if to_data is not None:
 188                 raise web.HTTPError(constants.HTTP_FORBIDDEN,
 189                                     "{} already exists in table [{}]"
 190                                     .format(new_query, self.table))
 191
 192         # we merge the whole document """
 193         edit_request = self._update_requests(data)
 194
 195         """ Updating the DB """
 196         yield self._eval_db(self.table, 'update', query, edit_request,
 197                             check_keys=False)
 198         edit_request['_id'] = str(data._id)
 199         self.finish_request(edit_request)
 200
 201     def _update_requests(self, data):
 202         request = dict()
 203         for k, v in self.json_args.iteritems():
 204             request = self._update_request(request, k, v,
 205                                            data.__getattribute__(k))
 206         if not request:
 207             raise web.HTTPError(constants.HTTP_FORBIDDEN, "Nothing to update")
 208
 209         edit_request = data.format()
 210         edit_request.update(request)
 211         return edit_request
 212
 213     @staticmethod
 214     def _update_request(edit_request, key, new_value, old_value):
 215         """
 216         This function serves to prepare the elements in the update request.
 217         We try to avoid replace the exact values in the db
 218         edit_request should be a dict in which we add an entry (key) after
 219         comparing values
 220         """
 221         if not (new_value is None):
 222             if new_value != old_value:
 223                 edit_request[key] = new_value
 224
 225         return edit_request
 226
 227     def _update_query(self, keys, data):
 228         query = dict()
 229         equal = True
 230         for key in keys:
 231             new = self.json_args.get(key)
 232             old = data.__getattribute__(key)
 233             if new is None:
 234                 new = old
 235             elif new != old:
 236                 equal = False
 237             query[key] = new
 238         return equal, query
 239
 240     def _eval_db(self, table, method, *args, **kwargs):
 241         exec_collection = self.db.__getattr__(table)
 242         return exec_collection.__getattribute__(method)(*args, **kwargs)
 243
 244     def _eval_db_find_one(self, query, table=None):
 245         if table is None:
 246             table = self.table
 247         return self._eval_db(table, 'find_one', query)
 248
 249
 250 class VersionHandler(GenericApiHandler):
 251     @swagger.operation(nickname='listAllVersions')
 252     def get(self):
 253         """
 254             @description: list all supported versions
 255             @rtype: L{Versions}
 256         """
 257         versions = [{'version': 'v1.0', 'description': 'basics'}]
 258         self.finish_request({'versions': versions})