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 ##############################################################################
15 We can launch the API with this file
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
25 - swagger documentation
37 from resources.handlers import VersionHandler, \
38 TestcaseHandler, TestResultsHandler, DashboardHandler
39 from resources.pod_handlers import PodCLHandler, PodGURHandler
40 from resources.project_handlers import ProjectCLHandler, ProjectGURHandler
41 from common.config import APIConfig
42 from tornado_swagger_ui.tornado_swagger import swagger
44 # optionally get config file from command line
45 parser = argparse.ArgumentParser()
46 parser.add_argument("-c", "--config-file", dest='config_file',
47 help="Config file location")
48 args = parser.parse_args()
49 CONF = APIConfig().parse(args.config_file)
51 # connecting to MongoDB server, and choosing database
52 client = motor.MotorClient(CONF.mongo_url)
53 db = client[CONF.mongo_dbname]
57 return swagger.Application(
59 # GET /version => GET API version
60 (r"/versions", VersionHandler),
63 # GET /api/v1/pods => Get all pods
64 # GET /api/v1/pods/1 => Get details on POD 1
65 (r"/api/v1/pods", PodCLHandler),
66 (r"/api/v1/pods/([^/]+)", PodGURHandler),
70 # GET /projects/yardstick
71 (r"/api/v1/projects", ProjectCLHandler),
72 (r"/api/v1/projects/([^/]+)", ProjectGURHandler),
75 # GET /projects/qtip/cases => Get cases for qtip
76 (r"/api/v1/projects/([^/]+)/cases", TestcaseHandler),
77 (r"/api/v1/projects/([^/]+)/cases/([^/]+)", TestcaseHandler),
79 # new path to avoid a long depth
80 # GET /results?project=functest&case=keystone.catalog&pod=1
81 # => get results with optional filters
83 # Push results with mandatory request payload parameters
84 # (project, case, and pod)
85 (r"/api/v1/results", TestResultsHandler),
86 (r"/api/v1/results([^/]*)", TestResultsHandler),
87 (r"/api/v1/results/([^/]*)", TestResultsHandler),
89 # Method to manage Dashboard ready results
90 # GET /dashboard?project=functest&case=vPing&pod=opnfv-jump2
91 # => get results in dasboard ready format
93 # => get the list of project with dashboard ready results
94 (r"/dashboard/v1/results", DashboardHandler),
95 (r"/dashboard/v1/results([^/]*)", DashboardHandler),
98 debug=CONF.api_debug_on,
103 application = make_app()
104 application.listen(CONF.api_port)
105 tornado.ioloop.IOLoop.current().start()
108 if __name__ == "__main__":