summaryrefslogtreecommitdiffstats
path: root/utils/test/result_collection_api/resources/handlers.py
blob: 3f9d8422cc3df59a2121fa2e1b00ded3272bf66c (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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
##############################################################################
# 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
# feng.xiaowei@zte.com.cn refactor db.pod to db.pods         5-19-2016
# feng.xiaowei@zte.com.cn refactor test_project to project   5-19-2016
# feng.xiaowei@zte.com.cn refactor response body             5-19-2016
# feng.xiaowei@zte.com.cn refactor pod/project response info 5-19-2016
# feng.xiaowei@zte.com.cn refactor testcase related handler  5-20-2016
# feng.xiaowei@zte.com.cn refactor result related handler    5-23-2016
# feng.xiaowei@zte.com.cn refactor dashboard related handler 5-24-2016
# feng.xiaowei@zte.com.cn add methods to GenericApiHandler   5-26-2016
# feng.xiaowei@zte.com.cn remove PodHandler                  5-26-2016
##############################################################################

import json
from datetime import datetime, timedelta

from tornado.web import RequestHandler, asynchronous, HTTPError
from tornado import gen

from models import CreateResponse
from resources.result_models import TestResult
from resources.testcase_models import Testcase
from common.constants import DEFAULT_REPRESENTATION, HTTP_BAD_REQUEST, \
    HTTP_NOT_FOUND, HTTP_FORBIDDEN
from common.config import prepare_put_request
from dashboard.dashboard_utils import check_dashboard_ready_project, \
    check_dashboard_ready_case, get_dashboard_result


def format_data(data, cls):
    cls_data = cls.from_dict(data)
    return cls_data.format_http()


class GenericApiHandler(RequestHandler):
    def __init__(self, application, request, **kwargs):
        super(GenericApiHandler, self).__init__(application, request, **kwargs)
        self.db = self.settings["db"]
        self.json_args = None
        self.table = None
        self.table_cls = None

    def prepare(self):
        if self.request.method != "GET" and self.request.method != "DELETE":
            if self.request.headers.get("Content-Type") is not None:
                if self.request.headers["Content-Type"].startswith(
                        DEFAULT_REPRESENTATION):
                    try:
                        self.json_args = json.loads(self.request.body)
                    except (ValueError, KeyError, TypeError) as error:
                        raise HTTPError(HTTP_BAD_REQUEST,
                                        "Bad Json format [{}]".
                                        format(error))

    def finish_request(self, json_object=None):
        if json_object:
            self.write(json.dumps(json_object))
        self.set_header("Content-Type", DEFAULT_REPRESENTATION)
        self.finish()

    def _create_response(self, resource):
        href = self.request.full_url() + '/' + resource
        return CreateResponse(href=href).format()

    @asynchronous
    @gen.coroutine
    def _create(self, error):
        if self.json_args is None:
            raise HTTPError(HTTP_BAD_REQUEST, 'no body')

        data = self.table_cls.from_dict(self.json_args)
        name = data.name
        if name is None or name == '':
            raise HTTPError(HTTP_BAD_REQUEST,
                            '{} name missing'.format(self.table[:-1]))

        exist_data = yield self._eval_db(self.table, 'find_one',
                                         {"name": name})
        if exist_data is not None:
            raise HTTPError(HTTP_FORBIDDEN,
                            error.format(name, self.table[:-1]))
        data.creation_date = datetime.now()
        yield self._eval_db(self.table, 'insert', data.format())
        self.finish_request(self._create_response(name))

    @asynchronous
    @gen.coroutine
    def _list(self, query=None):
        if query is None:
            query = {}
        res = []
        cursor = self._eval_db(self.table, 'find', query)
        while (yield cursor.fetch_next):
            res.append(format_data(cursor.next_object(), self.table_cls))
        self.finish_request({self.table: res})

    @asynchronous
    @gen.coroutine
    def _get_one(self, query):
        data = yield self._eval_db(self.table, 'find_one', query)
        if data is None:
            raise HTTPError(HTTP_NOT_FOUND,
                            "[{}] not exist in table [{}]"
                            .format(query, self.table))
        self.finish_request(format_data(data, self.table_cls))

    @asynchronous
    @gen.coroutine
    def _delete(self, query):
        data = yield self._eval_db(self.table, 'find_one', query)
        if data is None:
            raise HTTPError(HTTP_NOT_FOUND,
                            "[{}] not exit in table [{}]"
                            .format(query, self.table))

        yield self._eval_db(self.table, 'remove', query)
        self.finish_request()

    def _eval_db(self, table, method, param):
        return eval('self.db.%s.%s(param)' % (table, method))


class VersionHandler(GenericApiHandler):
    """ Display a message for the API version """
    def get(self):
        self.finish_request([{'v1': 'basics'}])


class TestcaseHandler(GenericApiHandler):
    """
    TestCasesHandler Class
    Handle the requests about the Test cases for test projects
    HTTP Methdods :
        - GET : Get all test cases and details about a specific one
        - POST : Add a test project
        - PUT : Edit test projects information (name and/or description)
    """

    def initialize(self):
        """ Prepares the database for the entire class """
        super(TestcaseHandler, self).initialize()

    @asynchronous
    @gen.coroutine
    def get(self, project_name, case_name=None):
        """
        Get testcases(s) info
        :param project_name:
        :param case_name:
        """

        query = {'project_name': project_name}

        if case_name is not None:
            query["name"] = case_name
            answer = yield self.db.testcases.find_one(query)
            if answer is None:
                raise HTTPError(HTTP_NOT_FOUND,
                                "{} Not Exist".format(case_name))
            else:
                answer = format_data(answer, Testcase)
        else:
            res = []
            cursor = self.db.testcases.find(query)
            while (yield cursor.fetch_next):
                res.append(format_data(cursor.next_object(), Testcase))
            answer = {'testcases': res}

        self.finish_request(answer)

    @asynchronous
    @gen.coroutine
    def post(self, project_name):
        """ Create a test case"""

        if self.json_args is None:
            raise HTTPError(HTTP_BAD_REQUEST,
                            "Check your request payload")

        # retrieve test project
        project = yield self.db.projects.find_one(
            {"name": project_name})
        if project is None:
            raise HTTPError(HTTP_FORBIDDEN,
                            "Could not find project {}"
                            .format(project_name))

        case_name = self.json_args.get('name')
        the_testcase = yield self.db.testcases.find_one(
            {"project_name": project_name, 'name': case_name})
        if the_testcase:
            raise HTTPError(HTTP_FORBIDDEN,
                            "{} already exists as a case in project {}"
                            .format(case_name, project_name))

        testcase = Testcase.from_dict(self.json_args)
        testcase.project_name = project_name
        testcase.creation_date = datetime.now()

        yield self.db.testcases.insert(testcase.format())
        self.finish_request(self._create_response(testcase.name))

    @asynchronous
    @gen.coroutine
    def put(self, project_name, case_name):
        """
        Updates the name and description of a test case
        :raises HTTPError (HTTP_NOT_FOUND, HTTP_FORBIDDEN)
        """

        query = {'project_name': project_name, 'name': case_name}

        if self.json_args is None:
            raise HTTPError(HTTP_BAD_REQUEST, "No payload")

        # check if there is a case for the project in url parameters
        from_testcase = yield self.db.testcases.find_one(query)
        if from_testcase is None:
            raise HTTPError(HTTP_NOT_FOUND,
                            "{} could not be found as a {} case to be updated"
                            .format(case_name, project_name))

        testcase = Testcase.from_dict(from_testcase)
        new_name = self.json_args.get("name")
        new_project_name = self.json_args.get("project_name")
        if not new_project_name:
            new_project_name = project_name
        new_description = self.json_args.get("description")

        # check if there is not an existing test case
        # with the name provided in the json payload
        if new_name != case_name or new_project_name != project_name:
            to_testcase = yield self.db.testcases.find_one(
                {'project_name': new_project_name, 'name': new_name})
            if to_testcase is not None:
                raise HTTPError(HTTP_FORBIDDEN,
                                "{} already exists as a case in project"
                                .format(new_name, new_project_name))

        # new dict for changes
        request = dict()
        request = prepare_put_request(request,
                                      "name",
                                      new_name,
                                      testcase.name)
        request = prepare_put_request(request,
                                      "project_name",
                                      new_project_name,
                                      testcase.project_name)
        request = prepare_put_request(request,
                                      "description",
                                      new_description,
                                      testcase.description)

        # we raise an exception if there isn't a change
        if not request:
            raise HTTPError(HTTP_FORBIDDEN,
                            "Nothing to update")

        # we merge the whole document """
        edit_request = testcase.format()
        edit_request.update(request)

        """ Updating the DB """
        yield self.db.testcases.update(query, edit_request)
        new_case = yield self.db.testcases.find_one({"_id": testcase._id})
        self.finish_request(format_data(new_case, Testcase))

    @asynchronous
    @gen.coroutine
    def delete(self, project_name, case_name):
        """ Remove a test case"""

        query = {'project_name': project_name, 'name': case_name}

        # check for an existing case to be deleted
        testcase = yield self.db.testcases.find_one(query)
        if testcase is None:
            raise HTTPError(HTTP_NOT_FOUND,
                            "{}/{} could not be found as a case to be deleted"
                            .format(project_name, case_name))

        # just delete it, or maybe save it elsewhere in a future
        yield self.db.testcases.remove(query)
        self.finish_request()


class TestResultsHandler(GenericApiHandler):
    """
    TestResultsHandler Class
    Handle the requests about the Test project's results
    HTTP Methdods :
        - GET : Get all test results and details about a specific one
        - POST : Add a test results
        - DELETE : Remove a test result
    """

    def initialize(self):
        """ Prepares the database for the entire class """
        super(TestResultsHandler, self).initialize()
        self.name = "test_result"

    @asynchronous
    @gen.coroutine
    def get(self, result_id=None):
        """
        Retrieve result(s) for a test project on a specific POD.
        Available filters for this request are :
         - project : project name
         - case : case name
         - pod : pod name
         - version : platform version (Arno-R1, ...)
         - installer (fuel, ...)
         - build_tag : Jenkins build tag name
         - period : x (x last days)
         - scenario : the test scenario (previously version)
         - criteria : the global criteria status passed or failed
         - trust_indicator : evaluate the stability of the test case to avoid
         running systematically long and stable test case


        :param result_id: Get a result by ID
        :raise HTTPError

        GET /results/project=functest&case=vPing&version=Arno-R1 \
        &pod=pod_name&period=15
        => get results with optional filters
        """

        # prepare request
        query = dict()
        if result_id is not None:
            query["_id"] = result_id
            answer = yield self.db.results.find_one(query)
            if answer is None:
                raise HTTPError(HTTP_NOT_FOUND,
                                "test result {} Not Exist".format(result_id))
            else:
                answer = format_data(answer, TestResult)
        else:
            pod_arg = self.get_query_argument("pod", None)
            project_arg = self.get_query_argument("project", None)
            case_arg = self.get_query_argument("case", None)
            version_arg = self.get_query_argument("version", None)
            installer_arg = self.get_query_argument("installer", None)
            build_tag_arg = self.get_query_argument("build_tag", None)
            scenario_arg = self.get_query_argument("scenario", None)
            criteria_arg = self.get_query_argument("criteria", None)
            period_arg = self.get_query_argument("period", None)
            trust_indicator_arg = self.get_query_argument("trust_indicator",
                                                          None)

            if project_arg is not None:
                query["project_name"] = project_arg

            if case_arg is not None:
                query["case_name"] = case_arg

            if pod_arg is not None:
                query["pod_name"] = pod_arg

            if version_arg is not None:
                query["version"] = version_arg

            if installer_arg is not None:
                query["installer"] = installer_arg

            if build_tag_arg is not None:
                query["build_tag"] = build_tag_arg

            if scenario_arg is not None:
                query["scenario"] = scenario_arg

            if criteria_arg is not None:
                query["criteria_tag"] = criteria_arg

            if trust_indicator_arg is not None:
                query["trust_indicator_arg"] = trust_indicator_arg

            if period_arg is not None:
                try:
                    period_arg = int(period_arg)
                except:
                    raise HTTPError(HTTP_BAD_REQUEST)

                if period_arg > 0:
                    period = datetime.now() - timedelta(days=period_arg)
                    obj = {"$gte": str(period)}
                    query["creation_date"] = obj

            res = []
            cursor = self.db.results.find(query)
            while (yield cursor.fetch_next):
                res.append(format_data(cursor.next_object(), TestResult))
            answer = {'results': res}

        self.finish_request(answer)

    @asynchronous
    @gen.coroutine
    def post(self):
        """
        Create a new test result
        :return: status of the request
        :raise HTTPError
        """

        # check for request payload
        if self.json_args is None:
            raise HTTPError(HTTP_BAD_REQUEST, 'no payload')

        result = TestResult.from_dict(self.json_args)

        # check for pod_name instead of id,
        # keeping id for current implementations
        if result.pod_name is None:
            raise HTTPError(HTTP_BAD_REQUEST, 'pod is not provided')

        # check for missing parameters in the request payload
        if result.project_name is None:
            raise HTTPError(HTTP_BAD_REQUEST, 'project is not provided')

        if result.case_name is None:
            raise HTTPError(HTTP_BAD_REQUEST, 'testcase is not provided')

        # TODO : replace checks with jsonschema
        # check for pod
        the_pod = yield self.db.pods.find_one({"name": result.pod_name})
        if the_pod is None:
            raise HTTPError(HTTP_NOT_FOUND,
                            "Could not find POD [{}] "
                            .format(self.json_args.get("pod_name")))

        # check for project
        the_project = yield self.db.projects.find_one(
            {"name": result.project_name})
        if the_project is None:
            raise HTTPError(HTTP_NOT_FOUND, "Could not find project [{}] "
                            .format(result.project_name))

        # check for testcase
        the_testcase = yield self.db.testcases.find_one(
            {"name": result.case_name})
        if the_testcase is None:
            raise HTTPError(HTTP_NOT_FOUND,
                            "Could not find testcase [{}] "
                            .format(result.case_name))

        _id = yield self.db.results.insert(result.format(), check_keys=False)

        self.finish_request(self._create_response(_id))


class DashboardHandler(GenericApiHandler):
    """
    DashboardHandler Class
    Handle the requests about the Test project's results
    in a dahboard ready format
    HTTP Methdods :
        - GET : Get all test results and details about a specific one
    """
    def initialize(self):
        """ Prepares the database for the entire class """
        super(DashboardHandler, self).initialize()
        self.name = "dashboard"

    @asynchronous
    @gen.coroutine
    def get(self):
        """
        Retrieve dashboard ready result(s) for a test project
        Available filters for this request are :
         - project : project name
         - case : case name
         - pod : pod name
         - version : platform version (Arno-R1, ...)
         - installer (fuel, ...)
         - period : x (x last days)


        :param result_id: Get a result by ID
        :raise HTTPError

        GET /dashboard?project=functest&case=vPing&version=Arno-R1 \
        &pod=pod_name&period=15
        => get results with optional filters
        """

        project_arg = self.get_query_argument("project", None)
        case_arg = self.get_query_argument("case", None)
        pod_arg = self.get_query_argument("pod", None)
        version_arg = self.get_query_argument("version", None)
        installer_arg = self.get_query_argument("installer", None)
        period_arg = self.get_query_argument("period", None)

        # prepare request
        query = dict()

        if project_arg is not None:
            query["project_name"] = project_arg

        if case_arg is not None:
            query["case_name"] = case_arg

        if pod_arg is not None:
            query["pod_name"] = pod_arg

        if version_arg is not None:
            query["version"] = version_arg

        if installer_arg is not None:
            query["installer"] = installer_arg

        if period_arg is not None:
            try:
                period_arg = int(period_arg)
            except:
                raise HTTPError(HTTP_BAD_REQUEST)
            if period_arg > 0:
                period = datetime.now() - timedelta(days=period_arg)
                obj = {"$gte": str(period)}
                query["creation_date"] = obj

        # on /dashboard retrieve the list of projects and testcases
        # ready for dashboard
        if project_arg is None:
            raise HTTPError(HTTP_NOT_FOUND, "Project name missing")

        if not check_dashboard_ready_project(project_arg):
            raise HTTPError(HTTP_NOT_FOUND,
                            'Project [{}] not dashboard ready'
                            .format(project_arg))

        if case_arg is None:
            raise HTTPError(
                HTTP_NOT_FOUND,
                'Test case missing for project [{}]'.format(project_arg))

        if not check_dashboard_ready_case(project_arg, case_arg):
            raise HTTPError(
                HTTP_NOT_FOUND,
                'Test case [{}] not dashboard ready for project [{}]'
                .format(case_arg, project_arg))

        # special case of status for project
        res = []
        if case_arg != "status":
            cursor = self.db.results.find(query)
            while (yield cursor.fetch_next):
                result = TestResult.from_dict(cursor.next_object())
                res.append(result.format_http())

        # final response object
        self.finish_request(get_dashboard_result(project_arg, case_arg, res))