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