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 import models
  30 from opnfv_testapi.common import check
  31 from opnfv_testapi.common import message
  32 from opnfv_testapi.common import raises
  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             data.__setattr__(k, v)
  89
  90         if self.table != 'results':
  91             data.creation_date = datetime.now()
  92         _id = yield self._eval_db(self.table, 'insert', data.format(),
  93                                   check_keys=False)
  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         if query is None:
 104             query = {}
 105         data = []
 106         cursor = self._eval_db(self.table, 'find', query)
 107         if 'sort' in kwargs:
 108             cursor = cursor.sort(kwargs.get('sort'))
 109         if 'last' in kwargs:
 110             cursor = cursor.limit(kwargs.get('last'))
 111         while (yield cursor.fetch_next):
 112             data.append(self.format_data(cursor.next_object()))
 113         if res_op is None:
 114             res = {self.table: data}
 115         else:
 116             res = res_op(data, *args)
 117         self.finish_request(res)
 118
 119     @web.asynchronous
 120     @gen.coroutine
 121     @check.not_exist
 122     def _get_one(self, data, query=None):
 123         self.finish_request(self.format_data(data))
 124
 125     @check.authenticate
 126     @check.not_exist
 127     def _delete(self, data, query=None):
 128         yield self._eval_db(self.table, 'remove', query)
 129         self.finish_request()
 130
 131     @check.authenticate
 132     @check.no_body
 133     @check.not_exist
 134     @check.updated_one_not_exist
 135     def _update(self, data, query=None, **kwargs):
 136         data = self.table_cls.from_dict(data)
 137         update_req = self._update_requests(data)
 138         yield self._eval_db(self.table, 'update', query, update_req,
 139                             check_keys=False)
 140         update_req['_id'] = str(data._id)
 141         self.finish_request(update_req)
 142
 143     def _update_requests(self, data):
 144         request = dict()
 145         for k, v in self.json_args.iteritems():
 146             request = self._update_request(request, k, v,
 147                                            data.__getattribute__(k))
 148         if not request:
 149             raises.Forbidden(message.no_update())
 150
 151         edit_request = data.format()
 152         edit_request.update(request)
 153         return edit_request
 154
 155     @staticmethod
 156     def _update_request(edit_request, key, new_value, old_value):
 157         """
 158         This function serves to prepare the elements in the update request.
 159         We try to avoid replace the exact values in the db
 160         edit_request should be a dict in which we add an entry (key) after
 161         comparing values
 162         """
 163         if not (new_value is None):
 164             if new_value != old_value:
 165                 edit_request[key] = new_value
 166
 167         return edit_request
 168
 169     def _update_query(self, keys, data):
 170         query = dict()
 171         equal = True
 172         for key in keys:
 173             new = self.json_args.get(key)
 174             old = data.get(key)
 175             if new is None:
 176                 new = old
 177             elif new != old:
 178                 equal = False
 179             query[key] = new
 180         return query if not equal else dict()
 181
 182     def _eval_db(self, table, method, *args, **kwargs):
 183         exec_collection = self.db.__getattr__(table)
 184         return exec_collection.__getattribute__(method)(*args, **kwargs)
 185
 186     def _eval_db_find_one(self, query, table=None):
 187         if table is None:
 188             table = self.table
 189         return self._eval_db(table, 'find_one', query)
 190
 191
 192 class VersionHandler(GenericApiHandler):
 193     @swagger.operation(nickname='listAllVersions')
 194     def get(self):
 195         """
 196             @description: list all supported versions
 197             @rtype: L{Versions}
 198         """
 199         versions = [{'version': 'v1.0', 'description': 'basics'}]
 200         self.finish_request({'versions': versions})