utils/test/result_collection_api/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 resources.handlers import VersionHandler
  38 from resources.testcase_handlers import TestcaseCLHandler, TestcaseGURHandler
  39 from resources.pod_handlers import PodCLHandler, PodGURHandler
  40 from resources.project_handlers import ProjectCLHandler, ProjectGURHandler
  41 from resources.result_handlers import ResultsCLHandler, ResultsGURHandler
  42 from resources.dashboard_handlers import DashboardHandler
  43 from common.config import APIConfig
  44 from tornado_swagger_ui.tornado_swagger import swagger
  45
  46 # optionally get config file from command line
  47 parser = argparse.ArgumentParser()
  48 parser.add_argument("-c", "--config-file", dest='config_file',
  49                     help="Config file location")
  50 args = parser.parse_args()
  51 CONF = APIConfig().parse(args.config_file)
  52
  53 # connecting to MongoDB server, and choosing database
  54 client = motor.MotorClient(CONF.mongo_url)
  55 db = client[CONF.mongo_dbname]
  56
  57
  58 def make_app():
  59     return swagger.Application(
  60         [
  61             # GET /version => GET API version
  62             (r"/versions", VersionHandler),
  63
  64             # few examples:
  65             # GET /api/v1/pods => Get all pods
  66             # GET /api/v1/pods/1 => Get details on POD 1
  67             (r"/api/v1/pods", PodCLHandler),
  68             (r"/api/v1/pods/([^/]+)", PodGURHandler),
  69
  70             # few examples:
  71             # GET /projects
  72             # GET /projects/yardstick
  73             (r"/api/v1/projects", ProjectCLHandler),
  74             (r"/api/v1/projects/([^/]+)", ProjectGURHandler),
  75
  76             # few examples
  77             # GET /projects/qtip/cases => Get cases for qtip
  78             (r"/api/v1/projects/([^/]+)/cases", TestcaseCLHandler),
  79             (r"/api/v1/projects/([^/]+)/cases/([^/]+)", TestcaseGURHandler),
  80
  81             # new path to avoid a long depth
  82             # GET /results?project=functest&case=keystone.catalog&pod=1
  83             #   => get results with optional filters
  84             # POST /results =>
  85             # Push results with mandatory request payload parameters
  86             # (project, case, and pod)
  87             (r"/api/v1/results", ResultsCLHandler),
  88             (r"/api/v1/results/([^/]+)", ResultsGURHandler),
  89
  90             # Method to manage Dashboard ready results
  91             # GET /dashboard?project=functest&case=vPing&pod=opnfv-jump2
  92             #  => get results in dasboard ready format
  93             # get /dashboard
  94             #  => get the list of project with dashboard ready results
  95             (r"/dashboard/v1/results", DashboardHandler),
  96         ],
  97         db=db,
  98         debug=CONF.api_debug_on,
  99     )
 100
 101
 102 def main():
 103     application = make_app()
 104     application.listen(CONF.api_port)
 105     tornado.ioloop.IOLoop.current().start()
 106
 107
 108 if __name__ == "__main__":
 109     main()