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 from datetime import datetime
  10 from datetime import timedelta
  11
  12 from bson import objectid
  13
  14 from opnfv_testapi.common import config
  15 from opnfv_testapi.common import message
  16 from opnfv_testapi.common import raises
  17 from opnfv_testapi.resources import handlers
  18 from opnfv_testapi.resources import result_models
  19 from opnfv_testapi.tornado_swagger import swagger
  20
  21 CONF = config.Config()
  22
  23
  24 class GenericResultHandler(handlers.GenericApiHandler):
  25     def __init__(self, application, request, **kwargs):
  26         super(GenericResultHandler, self).__init__(application,
  27                                                    request,
  28                                                    **kwargs)
  29         self.table = self.db_results
  30         self.table_cls = result_models.TestResult
  31
  32     def get_int(self, key, value):
  33         try:
  34             value = int(value)
  35         except:
  36             raises.BadRequest(message.must_int(key))
  37         return value
  38
  39     def set_query(self):
  40         query = dict()
  41         date_range = dict()
  42
  43         for k in self.request.query_arguments.keys():
  44             v = self.get_query_argument(k)
  45             if k == 'project' or k == 'pod' or k == 'case':
  46                 query[k + '_name'] = v
  47             elif k == 'period':
  48                 v = self.get_int(k, v)
  49                 if v > 0:
  50                     period = datetime.now() - timedelta(days=v)
  51                     obj = {"$gte": str(period)}
  52                     query['start_date'] = obj
  53             elif k == 'trust_indicator':
  54                 query[k + '.current'] = float(v)
  55             elif k == 'from':
  56                 date_range.update({'$gte': str(v)})
  57             elif k == 'to':
  58                 date_range.update({'$lt': str(v)})
  59             elif k != 'last' and k != 'page':
  60                 query[k] = v
  61             if date_range:
  62                 query['start_date'] = date_range
  63         return query
  64
  65
  66 class ResultsCLHandler(GenericResultHandler):
  67     @swagger.operation(nickname="queryTestResults")
  68     def get(self):
  69         """
  70             @description: Retrieve result(s) for a test project
  71                           on a specific pod.
  72             @notes: Retrieve result(s) for a test project on a specific pod.
  73                 Available filters for this request are :
  74                  - project : project name
  75                  - case : case name
  76                  - pod : pod name
  77                  - version : platform version (Arno-R1, ...)
  78                  - installer : fuel/apex/compass/joid/daisy
  79                  - build_tag : Jenkins build tag name
  80                  - period : x last days, incompatible with from/to
  81                  - from : starting time in 2016-01-01 or 2016-01-01 00:01:23
  82                  - to : ending time in 2016-01-01 or 2016-01-01 00:01:23
  83                  - scenario : the test scenario (previously version)
  84                  - criteria : the global criteria status passed or failed
  85                  - trust_indicator : evaluate the stability of the test case
  86                    to avoid running systematically long and stable test case
  87
  88                 GET /results/project=functest&case=vPing&version=Arno-R1 \
  89                 &pod=pod_name&period=15
  90             @return 200: all test results consist with query,
  91                          empty list if no result is found
  92             @rtype: L{TestResults}
  93             @param pod: pod name
  94             @type pod: L{string}
  95             @in pod: query
  96             @required pod: False
  97             @param project: project name
  98             @type project: L{string}
  99             @in project: query
 100             @required project: False
 101             @param case: case name
 102             @type case: L{string}
 103             @in case: query
 104             @required case: False
 105             @param version: i.e. Colorado
 106             @type version: L{string}
 107             @in version: query
 108             @required version: False
 109             @param installer: fuel/apex/joid/compass
 110             @type installer: L{string}
 111             @in installer: query
 112             @required installer: False
 113             @param build_tag: i.e. v3.0
 114             @type build_tag: L{string}
 115             @in build_tag: query
 116             @required build_tag: False
 117             @param scenario: i.e. odl
 118             @type scenario: L{string}
 119             @in scenario: query
 120             @required scenario: False
 121             @param criteria: i.e. passed
 122             @type criteria: L{string}
 123             @in criteria: query
 124             @required criteria: False
 125             @param period: last days
 126             @type period: L{string}
 127             @in period: query
 128             @required period: False
 129             @param from: i.e. 2016-01-01 or 2016-01-01 00:01:23
 130             @type from: L{string}
 131             @in from: query
 132             @required from: False
 133             @param to: i.e. 2016-01-01 or 2016-01-01 00:01:23
 134             @type to: L{string}
 135             @in to: query
 136             @required to: False
 137             @param last: last records stored until now
 138             @type last: L{string}
 139             @in last: query
 140             @required last: False
 141             @param page: which page to list
 142             @type page: L{int}
 143             @in page: query
 144             @required page: False
 145             @param trust_indicator: must be float
 146             @type trust_indicator: L{float}
 147             @in trust_indicator: query
 148             @required trust_indicator: False
 149         """
 150         limitations = {'sort': [('start_date', -1)]}
 151         last = self.get_query_argument('last', 0)
 152         if last is not None:
 153             last = self.get_int('last', last)
 154             limitations.update({'last': last})
 155
 156         page = self.get_query_argument('page', 1)
 157         if page is not None:
 158             page = self.get_int('page', page)
 159             limitations.update({'page': page,
 160                                 'per_page': CONF.api_results_per_page})
 161
 162         self._list(query=self.set_query(), **limitations)
 163
 164     @swagger.operation(nickname="createTestResult")
 165     def post(self):
 166         """
 167             @description: create a test result
 168             @param body: result to be created
 169             @type body: L{ResultCreateRequest}
 170             @in body: body
 171             @rtype: L{CreateResponse}
 172             @return 200: result is created.
 173             @raise 404: pod/project/testcase not exist
 174             @raise 400: body/pod_name/project_name/case_name not provided
 175         """
 176         def pod_query():
 177             return {'name': self.json_args.get('pod_name')}
 178
 179         def project_query():
 180             return {'name': self.json_args.get('project_name')}
 181
 182         def testcase_query():
 183             return {'project_name': self.json_args.get('project_name'),
 184                     'name': self.json_args.get('case_name')}
 185
 186         miss_fields = ['pod_name', 'project_name', 'case_name']
 187         carriers = [('pods', pod_query),
 188                     ('projects', project_query),
 189                     ('testcases', testcase_query)]
 190         self._create(miss_fields=miss_fields, carriers=carriers)
 191
 192
 193 class ResultsGURHandler(GenericResultHandler):
 194     @swagger.operation(nickname='getTestResultById')
 195     def get(self, result_id):
 196         """
 197             @description: get a single result by result_id
 198             @rtype: L{TestResult}
 199             @return 200: test result exist
 200             @raise 404: test result not exist
 201         """
 202         query = dict()
 203         query["_id"] = objectid.ObjectId(result_id)
 204         self._get_one(query=query)
 205
 206     @swagger.operation(nickname="updateTestResultById")
 207     def put(self, result_id):
 208         """
 209             @description: update a single result by _id
 210             @param body: fields to be updated
 211             @type body: L{ResultUpdateRequest}
 212             @in body: body
 213             @rtype: L{Result}
 214             @return 200: update success
 215             @raise 404: result not exist
 216             @raise 403: nothing to update
 217         """
 218         query = {'_id': objectid.ObjectId(result_id)}
 219         db_keys = []
 220         self._update(query=query, db_keys=db_keys)