utils/test/testapi/opnfv_testapi/resources/result_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 ##############################################################################
   9 import logging
  10 from datetime import datetime
  11 from datetime import timedelta
  12 import json
  13
  14 from bson import objectid
  15
  16 from opnfv_testapi.common.config import CONF
  17 from opnfv_testapi.common import message
  18 from opnfv_testapi.common import raises
  19 from opnfv_testapi.resources import handlers
  20 from opnfv_testapi.resources import result_models
  21 from opnfv_testapi.tornado_swagger import swagger
  22 from opnfv_testapi.ui.auth import constants as auth_const
  23
  24
  25 class GenericResultHandler(handlers.GenericApiHandler):
  26     def __init__(self, application, request, **kwargs):
  27         super(GenericResultHandler, self).__init__(application,
  28                                                    request,
  29                                                    **kwargs)
  30         self.table = self.db_results
  31         self.table_cls = result_models.TestResult
  32
  33     def get_int(self, key, value):
  34         try:
  35             value = int(value)
  36         except:
  37             raises.BadRequest(message.must_int(key))
  38         return value
  39
  40     def set_query(self):
  41         query = dict()
  42         date_range = dict()
  43
  44         query['public'] = {'$not': {'$eq': 'false'}}
  45         for k in self.request.query_arguments.keys():
  46             v = self.get_query_argument(k)
  47             if k == 'project' or k == 'pod' or k == 'case':
  48                 query[k + '_name'] = v
  49             elif k == 'period':
  50                 v = self.get_int(k, v)
  51                 if v > 0:
  52                     period = datetime.now() - timedelta(days=v)
  53                     obj = {"$gte": str(period)}
  54                     query['start_date'] = obj
  55             elif k == 'trust_indicator':
  56                 query[k + '.current'] = float(v)
  57             elif k == 'from':
  58                 date_range.update({'$gte': str(v)})
  59             elif k == 'to':
  60                 date_range.update({'$lt': str(v)})
  61             elif k == 'signed':
  62                 openid = self.get_secure_cookie(auth_const.OPENID)
  63                 role = self.get_secure_cookie(auth_const.ROLE)
  64                 logging.info('role:%s', role)
  65                 if role:
  66                     del query['public']
  67                     if role != "reviewer":
  68                         query['user'] = openid
  69             elif k not in ['last', 'page', 'descend']:
  70                 query[k] = v
  71             if date_range:
  72                 query['start_date'] = date_range
  73
  74             # if $lt is not provided,
  75             # empty/None/null/'' start_date will also be returned
  76             if 'start_date' in query and '$lt' not in query['start_date']:
  77                 query['start_date'].update({'$lt': str(datetime.now())})
  78
  79         return query
  80
  81
  82 class ResultsCLHandler(GenericResultHandler):
  83     @swagger.operation(nickname="queryTestResults")
  84     def get(self):
  85         """
  86             @description: Retrieve result(s) for a test project
  87                           on a specific pod.
  88             @notes: Retrieve result(s) for a test project on a specific pod.
  89                 Available filters for this request are :
  90                  - project : project name
  91                  - case : case name
  92                  - pod : pod name
  93                  - version : platform version (Arno-R1, ...)
  94                  - installer : fuel/apex/compass/joid/daisy
  95                  - build_tag : Jenkins build tag name
  96                  - period : x last days, incompatible with from/to
  97                  - from : starting time in 2016-01-01 or 2016-01-01 00:01:23
  98                  - to : ending time in 2016-01-01 or 2016-01-01 00:01:23
  99                  - scenario : the test scenario (previously version)
 100                  - criteria : the global criteria status passed or failed
 101                  - trust_indicator : evaluate the stability of the test case
 102                    to avoid running systematically long and stable test case
 103                  - signed : get logined user result
 104
 105                 GET /results/project=functest&case=vPing&version=Arno-R1 \
 106                 &pod=pod_name&period=15&signed
 107             @return 200: all test results consist with query,
 108                          empty list if no result is found
 109             @rtype: L{TestResults}
 110             @param pod: pod name
 111             @type pod: L{string}
 112             @in pod: query
 113             @required pod: False
 114             @param project: project name
 115             @type project: L{string}
 116             @in project: query
 117             @required project: False
 118             @param case: case name
 119             @type case: L{string}
 120             @in case: query
 121             @required case: False
 122             @param version: i.e. Colorado
 123             @type version: L{string}
 124             @in version: query
 125             @required version: False
 126             @param installer: fuel/apex/joid/compass
 127             @type installer: L{string}
 128             @in installer: query
 129             @required installer: False
 130             @param build_tag: i.e. v3.0
 131             @type build_tag: L{string}
 132             @in build_tag: query
 133             @required build_tag: False
 134             @param scenario: i.e. odl
 135             @type scenario: L{string}
 136             @in scenario: query
 137             @required scenario: False
 138             @param criteria: i.e. passed
 139             @type criteria: L{string}
 140             @in criteria: query
 141             @required criteria: False
 142             @param period: last days
 143             @type period: L{string}
 144             @in period: query
 145             @required period: False
 146             @param from: i.e. 2016-01-01 or 2016-01-01 00:01:23
 147             @type from: L{string}
 148             @in from: query
 149             @required from: False
 150             @param to: i.e. 2016-01-01 or 2016-01-01 00:01:23
 151             @type to: L{string}
 152             @in to: query
 153             @required to: False
 154             @param last: last records stored until now
 155             @type last: L{string}
 156             @in last: query
 157             @required last: False
 158             @param page: which page to list, default to 1
 159             @type page: L{int}
 160             @in page: query
 161             @required page: False
 162             @param trust_indicator: must be float
 163             @type trust_indicator: L{float}
 164             @in trust_indicator: query
 165             @required trust_indicator: False
 166             @param signed: user results or all results
 167             @type signed: L{string}
 168             @in signed: query
 169             @required signed: False
 170             @param descend: true, newest2oldest; false, oldest2newest
 171             @type descend: L{string}
 172             @in descend: query
 173             @required descend: False
 174         """
 175         def descend_limit():
 176             descend = self.get_query_argument('descend', 'true')
 177             return -1 if descend.lower() == 'true' else 1
 178
 179         def last_limit():
 180             return self.get_int('last', self.get_query_argument('last', 0))
 181
 182         def page_limit():
 183             return self.get_int('page', self.get_query_argument('page', 1))
 184
 185         limitations = {
 186             'sort': {'_id': descend_limit()},
 187             'last': last_limit(),
 188             'page': page_limit(),
 189             'per_page': CONF.api_results_per_page
 190         }
 191
 192         self._list(query=self.set_query(), **limitations)
 193
 194     @swagger.operation(nickname="createTestResult")
 195     def post(self):
 196         """
 197             @description: create a test result
 198             @param body: result to be created
 199             @type body: L{ResultCreateRequest}
 200             @in body: body
 201             @rtype: L{CreateResponse}
 202             @return 200: result is created.
 203             @raise 404: pod/project/testcase not exist
 204             @raise 400: body/pod_name/project_name/case_name not provided
 205         """
 206         self._post()
 207
 208     def _post(self):
 209         def pod_query():
 210             return {'name': self.json_args.get('pod_name')}
 211
 212         def project_query():
 213             return {'name': self.json_args.get('project_name')}
 214
 215         def testcase_query():
 216             return {'project_name': self.json_args.get('project_name'),
 217                     'name': self.json_args.get('case_name')}
 218
 219         miss_fields = ['pod_name', 'project_name', 'case_name']
 220         carriers = [('pods', pod_query),
 221                     ('projects', project_query),
 222                     ('testcases', testcase_query)]
 223
 224         self._create(miss_fields=miss_fields, carriers=carriers)
 225
 226
 227 class ResultsUploadHandler(ResultsCLHandler):
 228     @swagger.operation(nickname="uploadTestResult")
 229     def post(self):
 230         """
 231             @description: upload and create a test result
 232             @param body: result to be created
 233             @type body: L{ResultCreateRequest}
 234             @in body: body
 235             @rtype: L{CreateResponse}
 236             @return 200: result is created.
 237             @raise 404: pod/project/testcase not exist
 238             @raise 400: body/pod_name/project_name/case_name not provided
 239         """
 240         logging.info('file upload')
 241         fileinfo = self.request.files['file'][0]
 242         is_public = self.get_body_argument('public')
 243         logging.warning('public:%s', is_public)
 244         logging.info('results is :%s', fileinfo['filename'])
 245         logging.info('results is :%s', fileinfo['body'])
 246         self.json_args = json.loads(fileinfo['body']).copy()
 247         self.json_args['public'] = is_public
 248
 249         openid = self.get_secure_cookie(auth_const.OPENID)
 250         if openid:
 251             self.json_args['user'] = openid
 252
 253         super(ResultsUploadHandler, self)._post()
 254
 255
 256 class ResultsGURHandler(GenericResultHandler):
 257     @swagger.operation(nickname='getTestResultById')
 258     def get(self, result_id):
 259         """
 260             @description: get a single result by result_id
 261             @rtype: L{TestResult}
 262             @return 200: test result exist
 263             @raise 404: test result not exist
 264         """
 265         query = dict()
 266         query["_id"] = objectid.ObjectId(result_id)
 267         self._get_one(query=query)
 268
 269     @swagger.operation(nickname="updateTestResultById")
 270     def put(self, result_id):
 271         """
 272             @description: update a single result by _id
 273             @param body: fields to be updated
 274             @type body: L{ResultUpdateRequest}
 275             @in body: body
 276             @rtype: L{Result}
 277             @return 200: update success
 278             @raise 404: result not exist
 279             @raise 403: nothing to update
 280         """
 281         query = {'_id': objectid.ObjectId(result_id)}
 282         db_keys = []
 283         self._update(query=query, db_keys=db_keys)