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