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