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 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.db import api as dbapi
  33 from opnfv_testapi.resources import models
  34 from opnfv_testapi.tornado_swagger import swagger
  35
  36 DEFAULT_REPRESENTATION = "application/json"
  37
  38
  39 class GenericApiHandler(web.RequestHandler):
  40     def __init__(self, application, request, **kwargs):
  41         super(GenericApiHandler, self).__init__(application, request, **kwargs)
  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.body:
  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 dbapi.db_save(self.table, data.format())
  94         if 'name' in self.json_args:
  95             resource = data.name
  96         else:
  97             resource = _id
  98         self.finish_request(self._create_response(resource))
  99
 100     @web.asynchronous
 101     @gen.coroutine
 102     def _list(self, query=None, res_op=None, *args, **kwargs):
 103         sort = kwargs.get('sort')
 104         page = kwargs.get('page', 0)
 105         last = kwargs.get('last', 0)
 106         per_page = kwargs.get('per_page', 0)
 107         if query is None:
 108             query = {}
 109         pipelines = list()
 110         pipelines.append({'$match': query})
 111
 112         total_pages = 0
 113         data = list()
 114         cursor = dbapi.db_list(self.table, query)
 115         records_count = yield cursor.count()
 116         if records_count > 0:
 117             if page > 0:
 118                 total_pages, return_nr = self._calc_total_pages(records_count,
 119                                                                 last,
 120                                                                 page,
 121                                                                 per_page)
 122                 pipelines = self._set_pipelines(pipelines,
 123                                                 sort,
 124                                                 return_nr,
 125                                                 page,
 126                                                 per_page)
 127             cursor = dbapi.db_aggregate(self.table, pipelines)
 128             while (yield cursor.fetch_next):
 129                 data.append(self.format_data(cursor.next_object()))
 130         if res_op is None:
 131             res = {self.table: data}
 132         else:
 133             res = res_op(data, *args)
 134         if page > 0:
 135             res.update({
 136                 'pagination': {
 137                     'current_page': kwargs.get('page'),
 138                     'total_pages': total_pages
 139                 }
 140             })
 141         self.finish_request(res)
 142
 143     @staticmethod
 144     def _calc_total_pages(records_count, last, page, per_page):
 145         records_nr = records_count
 146         if (records_count > last) and (last > 0):
 147             records_nr = last
 148
 149         total_pages, remainder = divmod(records_nr, per_page)
 150         if remainder > 0:
 151             total_pages += 1
 152         if page > 1 and page > total_pages:
 153             raises.BadRequest(
 154                 'Request page > total_pages [{}]'.format(total_pages))
 155         return total_pages, records_nr
 156
 157     @staticmethod
 158     def _set_pipelines(pipelines, sort, return_nr, page, per_page):
 159         if sort:
 160             pipelines.append({'$sort': sort})
 161
 162         over = (page - 1) * per_page
 163         left = return_nr - over
 164         pipelines.append({'$skip': over})
 165         pipelines.append({'$limit': per_page if per_page < left else left})
 166
 167         return pipelines
 168
 169     @web.asynchronous
 170     @gen.coroutine
 171     @check.not_exist
 172     def _get_one(self, data, query=None):
 173         self.finish_request(self.format_data(data))
 174
 175     @check.authenticate
 176     @check.not_exist
 177     def _delete(self, data, query=None):
 178         yield dbapi.db_delete(self.table, query)
 179         self.finish_request()
 180
 181     @check.authenticate
 182     @check.no_body
 183     @check.not_exist
 184     @check.updated_one_not_exist
 185     def _update(self, data, query=None, **kwargs):
 186         data = self.table_cls.from_dict(data)
 187         update_req = self._update_requests(data)
 188         yield dbapi.db_update(self.table, query, update_req)
 189         update_req['_id'] = str(data._id)
 190         self.finish_request(update_req)
 191
 192     @check.authenticate
 193     @check.no_body
 194     @check.not_exist
 195     @check.updated_one_not_exist
 196     def pure_update(self, data, query=None, **kwargs):
 197         data = self.table_cls.from_dict(data)
 198         update_req = self._update_requests(data)
 199         yield dbapi.db_update(self.table, query, update_req)
 200         self.finish_request()
 201
 202     def _update_requests(self, data):
 203         request = dict()
 204         for k, v in self.json_args.iteritems():
 205             request = self._update_request(request, k, v,
 206                                            data.__getattribute__(k))
 207         if not request:
 208             raises.Forbidden(message.no_update())
 209
 210         edit_request = data.format()
 211         edit_request.update(request)
 212         return edit_request
 213
 214     @staticmethod
 215     def _update_request(edit_request, key, new_value, old_value):
 216         """
 217         This function serves to prepare the elements in the update request.
 218         We try to avoid replace the exact values in the db
 219         edit_request should be a dict in which we add an entry (key) after
 220         comparing values
 221         """
 222         if not (new_value is None):
 223             if new_value != old_value:
 224                 edit_request[key] = new_value
 225
 226         return edit_request
 227
 228     def _update_query(self, keys, data):
 229         query = dict()
 230         equal = True
 231         for key in keys:
 232             new = self.json_args.get(key)
 233             old = data.get(key)
 234             if new is None:
 235                 new = old
 236             elif new != old:
 237                 equal = False
 238             query[key] = new
 239         return query if not equal else dict()
 240
 241
 242 class VersionHandler(GenericApiHandler):
 243     @swagger.operation(nickname='listAllVersions')
 244     def get(self):
 245         """
 246             @description: list all supported versions
 247             @rtype: L{Versions}
 248         """
 249         versions = [{'version': 'v1.0', 'description': 'basics'}]
 250         self.finish_request({'versions': versions})