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