Merge "move resources unit tests to tests/unit/resources"
[releng.git] / utils / test / testapi / opnfv_testapi / tests / unit / resources / test_base.py
1 ##############################################################################
2 # Copyright (c) 2016 ZTE Corporation
3 # feng.xiaowei@zte.com.cn
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 import json
10 from os import path
11
12 import mock
13 from tornado import testing
14
15 from opnfv_testapi.common import config
16 from opnfv_testapi.resources import models
17 from opnfv_testapi.tests.unit import fake_pymongo
18
19 config.Config.CONFIG = path.join(path.dirname(__file__),
20                                  '../../../../etc/config.ini')
21
22
23 class TestBase(testing.AsyncHTTPTestCase):
24     headers = {'Content-Type': 'application/json; charset=UTF-8'}
25
26     def setUp(self):
27         self._patch_server()
28         self.basePath = ''
29         self.create_res = models.CreateResponse
30         self.get_res = None
31         self.list_res = None
32         self.update_res = None
33         self.req_d = None
34         self.req_e = None
35         self.addCleanup(self._clear)
36         super(TestBase, self).setUp()
37
38     def tearDown(self):
39         self.db_patcher.stop()
40
41     def _patch_server(self):
42         from opnfv_testapi.cmd import server
43         server.parse_config([
44             '--config-file',
45             path.join(path.dirname(__file__), path.pardir, 'common/normal.ini')
46         ])
47         self.db_patcher = mock.patch('opnfv_testapi.cmd.server.get_db',
48                                      self._fake_pymongo)
49         self.db_patcher.start()
50
51     @staticmethod
52     def _fake_pymongo():
53         return fake_pymongo
54
55     def get_app(self):
56         from opnfv_testapi.cmd import server
57         return server.make_app()
58
59     def create_d(self, *args):
60         return self.create(self.req_d, *args)
61
62     def create_e(self, *args):
63         return self.create(self.req_e, *args)
64
65     def create(self, req=None, *args):
66         return self.create_help(self.basePath, req, *args)
67
68     def create_help(self, uri, req, *args):
69         if req and not isinstance(req, str) and hasattr(req, 'format'):
70             req = req.format()
71         res = self.fetch(self._update_uri(uri, *args),
72                          method='POST',
73                          body=json.dumps(req),
74                          headers=self.headers)
75
76         return self._get_return(res, self.create_res)
77
78     def get(self, *args):
79         res = self.fetch(self._get_uri(*args),
80                          method='GET',
81                          headers=self.headers)
82
83         def inner():
84             new_args, num = self._get_valid_args(*args)
85             return self.get_res \
86                 if num != self._need_arg_num(self.basePath) else self.list_res
87         return self._get_return(res, inner())
88
89     def query(self, query):
90         res = self.fetch(self._get_query_uri(query),
91                          method='GET',
92                          headers=self.headers)
93         return self._get_return(res, self.list_res)
94
95     def update(self, new=None, *args):
96         if new:
97             new = new.format()
98         res = self.fetch(self._get_uri(*args),
99                          method='PUT',
100                          body=json.dumps(new),
101                          headers=self.headers)
102         return self._get_return(res, self.update_res)
103
104     def delete(self, *args):
105         res = self.fetch(self._get_uri(*args),
106                          method='DELETE',
107                          headers=self.headers)
108         return res.code, res.body
109
110     @staticmethod
111     def _get_valid_args(*args):
112         new_args = tuple(['%s' % arg for arg in args if arg is not None])
113         return new_args, len(new_args)
114
115     def _need_arg_num(self, uri):
116         return uri.count('%s')
117
118     def _get_query_uri(self, query):
119         return self.basePath + '?' + query if query else self.basePath
120
121     def _get_uri(self, *args):
122         return self._update_uri(self.basePath, *args)
123
124     def _update_uri(self, uri, *args):
125         r_uri = uri
126         new_args, num = self._get_valid_args(*args)
127         if num != self._need_arg_num(uri):
128             r_uri += '/%s'
129
130         return r_uri % tuple(['%s' % arg for arg in new_args])
131
132     def _get_return(self, res, cls):
133         code = res.code
134         body = res.body
135         return code, self._get_return_body(code, body, cls)
136
137     @staticmethod
138     def _get_return_body(code, body, cls):
139         return cls.from_dict(json.loads(body)) if code < 300 and cls else body
140
141     def assert_href(self, body):
142         self.assertIn(self.basePath, body.href)
143
144     def assert_create_body(self, body, req=None, *args):
145         import inspect
146         if not req:
147             req = self.req_d
148         resource_name = ''
149         if inspect.isclass(req):
150             resource_name = req.name
151         elif isinstance(req, dict):
152             resource_name = req['name']
153         elif isinstance(req, str):
154             resource_name = json.loads(req)['name']
155         new_args = args + tuple([resource_name])
156         self.assertIn(self._get_uri(*new_args), body.href)
157
158     @staticmethod
159     def _clear():
160         fake_pymongo.pods.clear()
161         fake_pymongo.projects.clear()
162         fake_pymongo.testcases.clear()
163         fake_pymongo.results.clear()
164         fake_pymongo.scenarios.clear()