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