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 json
  25
  26 from tornado import gen
  27 from tornado import web
  28
  29 from opnfv_testapi.common import check
  30 from opnfv_testapi.common import message
  31 from opnfv_testapi.common import raises
  32 from opnfv_testapi.resources import models
  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     @check.authenticate
  77     @check.no_body
  78     @check.miss_fields
  79     @check.carriers_exist
  80     @check.new_not_exists
  81     def _create(self, **kwargs):
  82         """
  83         :param miss_checks: [miss1, miss2]
  84         :param db_checks: [(table, exist, query, error)]
  85         """
  86         data = self.table_cls.from_dict(self.json_args)
  87         for k, v in kwargs.iteritems():
  88             if k != 'query':
  89                 data.__setattr__(k, v)
  90
  91         if self.table != 'results':
  92             data.creation_date = datetime.now()
  93         _id = yield self._eval_db(self.table, 'insert', data.format(),
  94                                   check_keys=False)
  95         if 'name' in self.json_args:
  96             resource = data.name
  97         else:
  98             resource = _id
  99         self.finish_request(self._create_response(resource))
 100
 101     @web.asynchronous
 102     @gen.coroutine
 103     def _list(self, query=None, res_op=None, *args, **kwargs):
 104         if query is None:
 105             query = {}
 106         data = []
 107         sort = kwargs.get('sort')
 108         page = kwargs.get('page', 0)
 109         last = kwargs.get('last', 0)
 110         per_page = kwargs.get('per_page', 0)
 111
 112         cursor = self._eval_db(self.table, 'find', query)
 113         records_count = yield cursor.count()
 114         records_nr = records_count
 115         if (records_count > last) and (last > 0):
 116             records_nr = last
 117
 118         pipelines = list()
 119         if query:
 120             pipelines.append({'$match': query})
 121         if sort:
 122             pipelines.append({'$sort': sort})
 123
 124         if page > 0:
 125             total_pages, remainder = divmod(records_nr, per_page)
 126             if remainder > 0:
 127                 total_pages += 1
 128             pipelines.append({'$skip': (page - 1) * per_page})
 129             pipelines.append({'$limit': per_page})
 130         elif last > 0:
 131             pipelines.append({'$limit': last})
 132
 133         cursor = self._eval_db(self.table,
 134                                'aggregate',
 135                                pipelines,
 136                                allowDiskUse=True)
 137
 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         if page:
 145             res.update({
 146                 'pagination': {
 147                     'current_page': page,
 148                     'total_pages': total_pages
 149                 }
 150             })
 151         self.finish_request(res)
 152
 153     @web.asynchronous
 154     @gen.coroutine
 155     @check.not_exist
 156     def _get_one(self, data, query=None):
 157         self.finish_request(self.format_data(data))
 158
 159     @check.authenticate
 160     @check.not_exist
 161     def _delete(self, data, query=None):
 162         yield self._eval_db(self.table, 'remove', query)
 163         self.finish_request()
 164
 165     @check.authenticate
 166     @check.no_body
 167     @check.not_exist
 168     @check.updated_one_not_exist
 169     def _update(self, data, query=None, **kwargs):
 170         data = self.table_cls.from_dict(data)
 171         update_req = self._update_requests(data)
 172         yield self._eval_db(self.table, 'update', query, update_req,
 173                             check_keys=False)
 174         update_req['_id'] = str(data._id)
 175         self.finish_request(update_req)
 176
 177     def _update_requests(self, data):
 178         request = dict()
 179         for k, v in self.json_args.iteritems():
 180             request = self._update_request(request, k, v,
 181                                            data.__getattribute__(k))
 182         if not request:
 183             raises.Forbidden(message.no_update())
 184
 185         edit_request = data.format()
 186         edit_request.update(request)
 187         return edit_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 new_value != old_value:
 199                 edit_request[key] = new_value
 200
 201         return edit_request
 202
 203     def _update_query(self, keys, data):
 204         query = dict()
 205         equal = True
 206         for key in keys:
 207             new = self.json_args.get(key)
 208             old = data.get(key)
 209             if new is None:
 210                 new = old
 211             elif new != old:
 212                 equal = False
 213             query[key] = new
 214         return query if not equal else dict()
 215
 216     def _eval_db(self, table, method, *args, **kwargs):
 217         exec_collection = self.db.__getattr__(table)
 218         return exec_collection.__getattribute__(method)(*args, **kwargs)
 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     def db_save(self, collection, data):
 226         self._eval_db(collection, 'insert', data, check_keys=False)
 227
 228     def db_find_one(self, query, collection=None):
 229         if not collection:
 230             collection = self.table
 231         return self._eval_db(collection, 'find_one', query)
 232
 233
 234 class VersionHandler(GenericApiHandler):
 235     @swagger.operation(nickname='listAllVersions')
 236     def get(self):
 237         """
 238             @description: list all supported versions
 239             @rtype: L{Versions}
 240         """
 241         versions = [{'version': 'v1.0', 'description': 'basics'}]
 242         self.finish_request({'versions': versions})