summaryrefslogtreecommitdiffstats
path: root/utils/test/result_collection_api/result_collection_api.py
blob: 97aa58c77c112fa9ce6aebffb5d7ce1aece48fd6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
##############################################################################
# Copyright (c) 2015 Orange
# guyrodrigue.koffi@orange.com / koffirodrigue@gmail.com
# All rights reserved. This program and the accompanying materials
# are made available under the terms of the Apache License, Version 2.0
# which accompanies this distribution, and is available at
# http://www.apache.org/licenses/LICENSE-2.0
##############################################################################

"""
Pre-requisites:
    pip install motor
    pip install tornado

We can launch the API with this file

TODOs :
  - logging
  - json args validation with schemes
  - POST/PUT/DELETE for PODs
  - POST/PUT/GET/DELETE for installers, platforms (enrich results info)
  - count cases for GET on projects
  - count results for GET on cases
  - include objects
  - swagger documentation
  - setup file
  - results pagination
  - unit tests

"""

import tornado.ioloop
import motor
import argparse

from resources.handlers import VersionHandler, PodHandler, \
    ProjectHandler, TestcaseHandler, TestResultsHandler, DashboardHandler
from common.config import APIConfig


# optionally get config file from command line
parser = argparse.ArgumentParser()
parser.add_argument("-c", "--config-file", dest='config_file',
                    help="Config file location")
args = parser.parse_args()
CONF = APIConfig().parse(args.config_file)

# connecting to MongoDB server, and choosing database
client = motor.MotorClient(CONF.mongo_url)
db = client[CONF.mongo_dbname]


def make_app():
    return tornado.web.Application(
        [
            # GET /version => GET API version
            (r"/versions", VersionHandler),

            # few examples:
            # GET /pods => Get all pods
            # GET /pods/1 => Get details on POD 1
            (r"/api/v1/pods", PodHandler),
            (r"/api/v1/pods/([^/]+)", PodHandler),

            # few examples:
            # GET /projects
            # GET /projects/yardstick
            (r"/api/v1/projects", ProjectHandler),
            (r"/api/v1/projects/([^/]+)", ProjectHandler),

            # few examples
            # GET /projects/qtip/cases => Get cases for qtip
            #
            (r"/api/v1/projects/([^/]+)/cases", TestcaseHandler),
            (r"/api/v1/projects/([^/]+)/cases/([^/]+)", TestcaseHandler),
            # (r"/test_cases/([^/]+)", TestCasesHandler),

            # new path to avoid a long depth
            # GET /results?project=functest&case=keystone.catalog&pod=1
            #   => get results with optional filters
            # POST /results =>
            # Push results with mandatory request payload parameters
            # (project, case, and pod)
            (r"/api/v1/results", TestResultsHandler),
            (r"/api/v1/results([^/]*)", TestResultsHandler),
            (r"/api/v1/results/([^/]*)", TestResultsHandler),

            # Method to manage Dashboard ready results
            # GET /dashboard?project=functest&case=vPing&pod=opnfv-jump2
            #  => get results in dasboard ready format
            # get /dashboard
            #  => get the list of project with dashboard ready results
            (r"/dashboard/v1/results", DashboardHandler),
            (r"/dashboard/v1/results([^/]*)", DashboardHandler),
        ],
        db=db,
        debug=CONF.api_debug_on,
    )


def main():
    application = make_app()
    application.listen(CONF.api_port)
    tornado.ioloop.IOLoop.current().start()


if __name__ == "__main__":
    main()