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 raises
  32 from opnfv_testapi.tornado_swagger import swagger
  33
  34 DEFAULT_REPRESENTATION = "application/json"
  35
  36
  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"]
  41         self.json_args = None
  42         self.table = None
  43         self.table_cls = None
  44         self.db_projects = 'projects'
  45         self.db_pods = 'pods'
  46         self.db_testcases = 'testcases'
  47         self.db_results = 'results'
  48         self.db_scenarios = 'scenarios'
  49         self.auth = self.settings["auth"]
  50
  51     def prepare(self):
  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):
  56                     try:
  57                         self.json_args = json.loads(self.request.body)
  58                     except (ValueError, KeyError, TypeError) as error:
  59                         raises.BadRequest("Bad Json format [{}]".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", 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                     raises.Unauthorized("No Authentication Header.")
  85                 query = {'access_token': token}
  86                 check = yield self._eval_db_find_one(query, 'tokens')
  87                 if not check:
  88                     raises.Forbidden("Invalid Token.")
  89             ret = yield gen.coroutine(method)(self, *args, **kwargs)
  90             raise gen.Return(ret)
  91         return wrapper
  92
  93     @authenticate
  94     def _create(self, miss_checks, db_checks, **kwargs):
  95         """
  96         :param miss_checks: [miss1, miss2]
  97         :param db_checks: [(table, exist, query, error)]
  98         """
  99         if self.json_args is None:
 100             raises.BadRequest('no body')
 101
 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))
 107
 108         for k, v in kwargs.iteritems():
 109             data.__setattr__(k, v)
 110
 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)
 116
 117         if self.table != 'results':
 118             data.creation_date = datetime.now()
 119         _id = yield self._eval_db(self.table, 'insert', data.format(),
 120                                   check_keys=False)
 121         if 'name' in self.json_args:
 122             resource = data.name
 123         else:
 124             resource = _id
 125         self.finish_request(self._create_response(resource))
 126
 127     @web.asynchronous
 128     @gen.coroutine
 129     def _list(self, query=None, res_op=None, *args, **kwargs):
 130         if query is None:
 131             query = {}
 132         data = []
 133         cursor = self._eval_db(self.table, 'find', query)
 134         if 'sort' in kwargs:
 135             cursor = cursor.sort(kwargs.get('sort'))
 136         if 'last' in kwargs:
 137             cursor = cursor.limit(kwargs.get('last'))
 138         while (yield cursor.fetch_next):
 139             data.append(self.format_data(cursor.next_object()))
 140         if res_op is None:
 141             res = {self.table: data}
 142         else:
 143             res = res_op(data, *args)
 144         self.finish_request(res)
 145
 146     @web.asynchronous
 147     @gen.coroutine
 148     def _get_one(self, query):
 149         data = yield self._eval_db_find_one(query)
 150         if data is None:
 151             raises.NotFound("[{}] not exist in table [{}]"
 152                             .format(query, self.table))
 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("[{}] not exit in table [{}]"
 160                             .format(query, self.table))
 161
 162         yield self._eval_db(self.table, 'remove', query)
 163         self.finish_request()
 164
 165     @authenticate
 166     def _update(self, query, db_keys):
 167         if self.json_args is None:
 168             raises.BadRequest("No payload")
 169
 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))
 175
 176         data = self.table_cls.from_dict(from_data)
 177         # check new data exist
 178         equal, new_query = self._update_query(db_keys, data)
 179         if not equal:
 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))
 184
 185         # we merge the whole document """
 186         edit_request = self._update_requests(data)
 187
 188         """ Updating the DB """
 189         yield self._eval_db(self.table, 'update', query, edit_request,
 190                             check_keys=False)
 191         edit_request['_id'] = str(data._id)
 192         self.finish_request(edit_request)
 193
 194     def _update_requests(self, data):
 195         request = dict()
 196         for k, v in self.json_args.iteritems():
 197             request = self._update_request(request, k, v,
 198                                            data.__getattribute__(k))
 199         if not request:
 200             raises.Forbidden("Nothing to update")
 201
 202         edit_request = data.format()
 203         edit_request.update(request)
 204         return edit_request
 205
 206     @staticmethod
 207     def _update_request(edit_request, key, new_value, old_value):
 208         """
 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
 212         comparing values
 213         """
 214         if not (new_value is None):
 215             if new_value != old_value:
 216                 edit_request[key] = new_value
 217
 218         return edit_request
 219
 220     def _update_query(self, keys, data):
 221         query = dict()
 222         equal = True
 223         for key in keys:
 224             new = self.json_args.get(key)
 225             old = data.__getattribute__(key)
 226             if new is None:
 227                 new = old
 228             elif new != old:
 229                 equal = False
 230             query[key] = new
 231         return equal, query
 232
 233     def _eval_db(self, table, method, *args, **kwargs):
 234         exec_collection = self.db.__getattr__(table)
 235         return exec_collection.__getattribute__(method)(*args, **kwargs)
 236
 237     def _eval_db_find_one(self, query, table=None):
 238         if table is None:
 239             table = self.table
 240         return self._eval_db(table, 'find_one', query)
 241
 242
 243 class VersionHandler(GenericApiHandler):
 244     @swagger.operation(nickname='listAllVersions')
 245     def get(self):
 246         """
 247             @description: list all supported versions
 248             @rtype: L{Versions}
 249         """
 250         versions = [{'version': 'v1.0', 'description': 'basics'}]
 251         self.finish_request({'versions': versions})