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