swagger-ize result-apis of testAPI
[releng.git] / utils / test / result_collection_api / tests / unit / test_base.py
1 import json
2 from tornado.web import Application
3 from tornado.testing import AsyncHTTPTestCase
4
5 from resources.pod_handlers import PodCLHandler, PodGURHandler
6 from resources.project_handlers import ProjectCLHandler, ProjectGURHandler
7 from resources.handlers import VersionHandler, DashboardHandler
8 from resources.testcase_handlers import TestcaseCLHandler, TestcaseGURHandler
9 from resources.result_handlers import ResultsCLHandler, ResultsGURHandler
10 from resources.models import CreateResponse
11 import fake_pymongo
12
13
14 class TestBase(AsyncHTTPTestCase):
15     headers = {'Content-Type': 'application/json; charset=UTF-8'}
16
17     def setUp(self):
18         self.basePath = ''
19         self.create_res = CreateResponse
20         self.get_res = None
21         self.list_res = None
22         self.update_res = None
23         self.req_d = None
24         self.req_e = None
25         self.addCleanup(self._clear)
26         super(TestBase, self).setUp()
27
28     def get_app(self):
29         return Application(
30             [
31                 (r"/versions", VersionHandler),
32                 (r"/api/v1/pods", PodCLHandler),
33                 (r"/api/v1/pods/([^/]+)", PodGURHandler),
34                 (r"/api/v1/projects", ProjectCLHandler),
35                 (r"/api/v1/projects/([^/]+)", ProjectGURHandler),
36                 (r"/api/v1/projects/([^/]+)/cases", TestcaseCLHandler),
37                 (r"/api/v1/projects/([^/]+)/cases/([^/]+)",
38                  TestcaseGURHandler),
39                 (r"/api/v1/results", ResultsCLHandler),
40                 (r"/api/v1/results/([^/]+)", ResultsGURHandler),
41                 (r"/dashboard/v1/results", DashboardHandler),
42                 (r"/dashboard/v1/results([^/]*)", DashboardHandler),
43             ],
44             db=fake_pymongo,
45             debug=True,
46         )
47
48     def create_d(self, *args):
49         return self.create(self.req_d, *args)
50
51     def create_e(self, *args):
52         return self.create(self.req_e, *args)
53
54     def create(self, req=None, *args):
55         return self.create_help(self.basePath, req, *args)
56
57     def create_help(self, uri, req, *args):
58         if req:
59             req = req.format()
60         res = self.fetch(self._update_uri(uri, *args),
61                          method='POST',
62                          body=json.dumps(req),
63                          headers=self.headers)
64
65         return self._get_return(res, self.create_res)
66
67     def get(self, *args):
68         res = self.fetch(self._get_uri(*args),
69                          method='GET',
70                          headers=self.headers)
71
72         def inner():
73             new_args, num = self._get_valid_args(*args)
74             return self.get_res \
75                 if num != self._need_arg_num(self.basePath) else self.list_res
76         return self._get_return(res, inner())
77
78     def query(self, query):
79         res = self.fetch(self._get_query_uri(query),
80                          method='GET',
81                          headers=self.headers)
82         return self._get_return(res, self.list_res)
83
84     def update(self, new=None, *args):
85         if new:
86             new = new.format()
87         res = self.fetch(self._get_uri(*args),
88                          method='PUT',
89                          body=json.dumps(new),
90                          headers=self.headers)
91         return self._get_return(res, self.update_res)
92
93     def delete(self, *args):
94         res = self.fetch(self._get_uri(*args),
95                          method='DELETE',
96                          headers=self.headers)
97         return res.code, res.body
98
99     @staticmethod
100     def _get_valid_args(*args):
101         new_args = tuple(['%s' % arg for arg in args if arg is not None])
102         return new_args, len(new_args)
103
104     def _need_arg_num(self, uri):
105         return uri.count('%s')
106
107     def _get_query_uri(self, query):
108         return self.basePath + '?' + query
109
110     def _get_uri(self, *args):
111         return self._update_uri(self.basePath, *args)
112
113     def _update_uri(self, uri, *args):
114         r_uri = uri
115         new_args, num = self._get_valid_args(*args)
116         if num != self._need_arg_num(uri):
117             r_uri += '/%s'
118
119         return r_uri % tuple(['%s' % arg for arg in new_args])
120
121     def _get_return(self, res, cls):
122         code = res.code
123         body = res.body
124         return code, self._get_return_body(code, body, cls)
125
126     @staticmethod
127     def _get_return_body(code, body, cls):
128         return cls.from_dict(json.loads(body)) if code < 300 and cls else body
129
130     def assert_href(self, body):
131         self.assertIn(self.basePath, body.href)
132
133     def assert_create_body(self, body, req=None, *args):
134         if not req:
135             req = self.req_d
136         new_args = args + tuple([req.name])
137         self.assertIn(self._get_uri(*new_args), body.href)
138
139     @staticmethod
140     def _clear():
141         fake_pymongo.pods.clear()
142         fake_pymongo.projects.clear()
143         fake_pymongo.testcases.clear()
144         fake_pymongo.results.clear()