utils/test/result_collection_api/opnfv_testapi/cmd/result_collection_api.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
  10 """
  11 Pre-requisites:
  12     pip install motor
  13     pip install tornado
  14
  15 We can launch the API with this file
  16
  17 TODOs :
  18   - logging
  19   - json args validation with schemes
  20   - POST/PUT/DELETE for PODs
  21   - POST/PUT/GET/DELETE for installers, platforms (enrich results info)
  22   - count cases for GET on projects
  23   - count results for GET on cases
  24   - include objects
  25   - swagger documentation
  26   - setup file
  27   - results pagination
  28   - unit tests
  29
  30 """
  31
  32 import argparse
  33
  34 import tornado.ioloop
  35 import motor
  36
  37 from opnfv_testapi.resources.handlers import VersionHandler
  38 from opnfv_testapi.resources.testcase_handlers import TestcaseCLHandler, \
  39     TestcaseGURHandler
  40 from opnfv_testapi.resources.pod_handlers import PodCLHandler, PodGURHandler
  41 from opnfv_testapi.resources.project_handlers import ProjectCLHandler, \
  42     ProjectGURHandler
  43 from opnfv_testapi.resources.result_handlers import ResultsCLHandler, \
  44     ResultsGURHandler
  45 from opnfv_testapi.resources.dashboard_handlers import DashboardHandler
  46 from opnfv_testapi.common.config import APIConfig
  47 from opnfv_testapi.tornado_swagger_ui.tornado_swagger import swagger
  48
  49 # optionally get config file from command line
  50 parser = argparse.ArgumentParser()
  51 parser.add_argument("-c", "--config-file", dest='config_file',
  52                     help="Config file location")
  53 args = parser.parse_args()
  54 CONF = APIConfig().parse(args.config_file)
  55
  56 # connecting to MongoDB server, and choosing database
  57 client = motor.MotorClient(CONF.mongo_url)
  58 db = client[CONF.mongo_dbname]
  59
  60
  61 def make_app():
  62     return swagger.Application(
  63         [
  64             # GET /version => GET API version
  65             (r"/versions", VersionHandler),
  66
  67             # few examples:
  68             # GET /api/v1/pods => Get all pods
  69             # GET /api/v1/pods/1 => Get details on POD 1
  70             (r"/api/v1/pods", PodCLHandler),
  71             (r"/api/v1/pods/([^/]+)", PodGURHandler),
  72
  73             # few examples:
  74             # GET /projects
  75             # GET /projects/yardstick
  76             (r"/api/v1/projects", ProjectCLHandler),
  77             (r"/api/v1/projects/([^/]+)", ProjectGURHandler),
  78
  79             # few examples
  80             # GET /projects/qtip/cases => Get cases for qtip
  81             (r"/api/v1/projects/([^/]+)/cases", TestcaseCLHandler),
  82             (r"/api/v1/projects/([^/]+)/cases/([^/]+)", TestcaseGURHandler),
  83
  84             # new path to avoid a long depth
  85             # GET /results?project=functest&case=keystone.catalog&pod=1
  86             #   => get results with optional filters
  87             # POST /results =>
  88             # Push results with mandatory request payload parameters
  89             # (project, case, and pod)
  90             (r"/api/v1/results", ResultsCLHandler),
  91             (r"/api/v1/results/([^/]+)", ResultsGURHandler),
  92
  93             # Method to manage Dashboard ready results
  94             # GET /dashboard?project=functest&case=vPing&pod=opnfv-jump2
  95             #  => get results in dasboard ready format
  96             # get /dashboard
  97             #  => get the list of project with dashboard ready results
  98             (r"/dashboard/v1/results", DashboardHandler),
  99         ],
 100         db=db,
 101         debug=CONF.api_debug_on,
 102     )
 103
 104
 105 def main():
 106     application = make_app()
 107     application.listen(CONF.api_port)
 108     tornado.ioloop.IOLoop.current().start()
 109
 110
 111 if __name__ == "__main__":
 112     main()